[CI] Migrate to github actions

This commit is contained in:
herklos
2020-11-12 20:53:12 +01:00
committed by Guillaume De Saint Martin
parent 26bf79c9f7
commit 7c567ca78e
7 changed files with 863 additions and 292 deletions

View File

@@ -1,8 +0,0 @@
workflow "Docker build & test" {
on = "push"
resolves = ["GitHub Action for Docker"]
}
action "GitHub Action for Docker" {
uses = "actions/docker/cli@76ff57a"
}

271
.github/workflows/main.yml vendored Normal file
View File

@@ -0,0 +1,271 @@
name: OctoBot-CI
on: push
jobs:
lint:
name: ubuntu-latest - Python 3.8 - lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: '3.8.x'
architecture: 'x64'
- name: Install dependencies
run: pip install --prefer-binary -r dev_requirements.txt -r requirements.txt
# - name: Black lint
# run: black ${{ secrets.PACKAGE_FOLDER }} --diff --check
- name: Pylint
run: |
pylint --rcfile=standard.rc ${{ secrets.PACKAGE_FOLDER }}
if [ $? -ne 1 ]; then exit 0; fi
docker_lint:
name: ubuntu-latest - Docker - lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Run hadolint
uses: reviewdog/action-hadolint@v1
with:
github_token: ${{ secrets.github_token }}
hadolint_ignore: DL3013 DL3008
tests:
needs: lint
name: ${{ matrix.os }}${{ matrix.arch }} - Python 3.8 - ${{ matrix.type }} - tests
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ macos-latest, windows-latest, ubuntu-latest ]
arch: [ x64, x86 ]
type: [sources, cython]
exclude:
- os: macos-latest # currently not supported
arch: x86
- os: ubuntu-latest # currently not supported
arch: x86
- os: windows-latest # don't test 'sources' twice on windows
arch: x86
type: sources
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: '3.8.x'
architecture: ${{ matrix.arch }}
- name: Install dependencies
run: pip install --prefer-binary -r dev_requirements.txt -r requirements.txt
- name: Install tentacles on Unix
if: matrix.os != 'windows-latest'
run: |
mkdir user
cp ./octobot/config/default_config.json ./user/config.json
TENTACLES_URL_SUBCATEGORY=dev/ TENTACLES_URL_TAG=${GITHUB_REF////_} python3 start.py tentacles -q --install --all || python3 start.py tentacles --install --all
- name: Install tentacles on Windows
if: matrix.os == 'windows-latest'
env:
BASE_BRANCH: ${GITHUB_REF##*/}
run: |
mkdir user
copy octobot\config\default_config.json user\config.json
$Env:TENTACLES_URL_SUBCATEGORY = "dev/"
$Env:TENTACLES_URL_TAG = $env:BASE_BRANCH -replace "/", "_"
python start.py tentacles -q --install --all
if ($LastExitCode -ne 0)
{
$Env:TENTACLES_URL_SUBCATEGORY = ""
If ($env:GITHUB_REF -like "*refs/tags/*") {
$Env:TENTACLES_URL_TAG = ""
} else {
$Env:TENTACLES_URL_TAG = "latest"
}
python start.py tentacles --install --all
}
shell: powershell
- name: Compile project
if: matrix.type == 'cython'
env:
CYTHON_IGNORE: true
run: |
python setup.py install
- name: Pytests
run: |
pytest --cov=. --cov-config=.coveragerc --durations=0 -rw tests
pytest --durations=0 -rw tentacles
- name: Publish coverage
if: matrix.type == 'sources'
run: coveralls
env:
COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
build_wheels:
needs: tests
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
name: ${{ matrix.os }}-${{ matrix.arch }} - Python 3.8 - deploy
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ ubuntu-latest, macos-latest, windows-latest ]
arch: [ x64, x86 ]
exclude:
- os: macos-latest # currently not supported
arch: x86
- os: ubuntu-latest # currently not supported
arch: x86
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: '3.8.x'
architecture: ${{ matrix.arch }}
- name: Install dependencies
if: matrix.os != 'ubuntu-latest'
run: pip install --prefer-binary -r dev_requirements.txt -r requirements.txt
- name: Build wheel
if: matrix.os != 'ubuntu-latest'
run: python setup.py bdist_wheel
- name: Install cibuildwheel
if: matrix.os == 'ubuntu-latest'
run: pip install cibuildwheel twine
- name: Build wheels
if: matrix.os == 'ubuntu-latest'
run: |
python -m cibuildwheel --output-dir wheelhouse
env:
# build for python 3.8
CIBW_BUILD: cp38-*
CIBW_BUILD_VERBOSITY_LINUX: 0
CIBW_MANYLINUX_X86_64_IMAGE: manylinux2014
CIBW_MANYLINUX_I686_IMAGE: manylinux2014
CIBW_BEFORE_BUILD_LINUX: >
python -m pip install --upgrade pip
pip install --extra-index-url ${{ secrets.OCTOBOT_PYPI_URL }} --prefer-binary auditwheel -r dev_requirements.txt -r requirements.txt
CIBW_BEFORE_ALL_LINUX: >
yum install -y libffi libffi-devel openssl-devel wget unzip blas-devel lapack-devel libxml2-devel libxslt-devel
- name: Publish package
if: matrix.os == 'ubuntu-latest'
run: |
python -m twine upload --repository-url ${{ secrets.PYPI_OFFICIAL_UPLOAD_URL }} -u ${{ secrets.PYPI_USERNAME }} -p ${{ secrets.PYPI_PASSWORD }} --skip-existing wheelhouse/*
- name: Publish package
if: matrix.os != 'ubuntu-latest'
run: |
python -m twine upload --repository-url ${{ secrets.PYPI_OFFICIAL_UPLOAD_URL }} -u ${{ secrets.PYPI_USERNAME }} -p ${{ secrets.PYPI_PASSWORD }} --skip-existing dist/*
build_sdist:
needs: tests
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
name: Source distribution - Python 3.8 - deploy
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: '3.8.x'
- name: Install dependencies
run: pip install --prefer-binary -r dev_requirements.txt -r requirements.txt
- name: Build sdist
run: python setup.py sdist
- name: Publish package
run: |
python -m twine upload --repository-url ${{ secrets.PYPI_OFFICIAL_UPLOAD_URL }} -u ${{ secrets.PYPI_USERNAME }} -p ${{ secrets.PYPI_PASSWORD }} --skip-existing dist/*
docker_build:
needs: docker_lint
name: ubuntu-latest - Docker - build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up QEMU
uses: docker/setup-qemu-action@v1
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1
- name: Login to DockerHub
uses: docker/login-action@v1
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Build
if: github.event_name == 'push' && !startsWith(github.ref, 'refs/tags') && github.ref != 'refs/heads/0.4.0'
uses: docker/build-push-action@v2
with:
context: .
file: ./Dockerfile
platforms: linux/386,linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64
push: false
tags: drakkarsoftware/octobot:latest
- name: Build and push latest
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags') && github.ref == 'refs/heads/0.4.0'
uses: docker/build-push-action@v2
with:
context: .
file: ./Dockerfile
platforms: linux/386,linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64
push: true
tags: drakkarsoftware/octobot:latest
- name: Build and push on tag
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
uses: docker/build-push-action@v2
with:
context: .
file: ./Dockerfile
platforms: linux/386,linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64
push: true
tags: |
drakkarsoftware/octobot:latest
drakkarsoftware/octobot:${GITHUB_REF////_}
- name: Image digest
run: echo ${{ steps.docker_build.outputs.digest }}
notify:
name: Notify
runs-on: ubuntu-latest
needs:
- lint
- docker_lint
- tests
- build_wheels
- build_sdist
- docker_build
if: ${{ failure() }}
steps:
- name: Notify discord
uses: sarisia/actions-status-discord@v1
with:
status: Failure
webhook: ${{ secrets.DISCORD_GITHUB_WEBHOOK }}

View File

@@ -1,144 +0,0 @@
notifications:
email: false
os: linux
dist: xenial
language: python
cache: pip
python: 3.8-dev
services:
- docker
env:
global:
- PYTHON_VERSION=3.8
- GH_REPO=Drakkar-Software/OctoBot
- DEPLOY_BRANCH=master
- PACKAGE_FOLDER=octobot
- TRAVIS_CLEANED_BRANCH=${TRAVIS_BRANCH////_}
before_install:
- python3 -m pip install --upgrade pip
- if [ -z $TRAVIS_TAG ]; then export TENTACLES_URL_TAG=latest; fi
install:
- python3 -m pip install --prefer-binary -r dev_requirements.txt -r requirements.txt
- mkdir user
- cp ./octobot/config/default_config.json ./user/config.json
- TENTACLES_URL_SUBCATEGORY=dev/ TENTACLES_URL_TAG=$TRAVIS_CLEANED_BRANCH python3 start.py tentacles -q --install --all || python3 start.py tentacles --install --all
before_deploy:
- git config --global user.email "builds@travis-ci.com"
- git config --global user.name "Travis CI"
jobs:
include:
- name: "Linux - Python 3.8 - Python sources"
stage: test
script:
- pytest --cov=. --cov-config=.coveragerc --durations=0 -rw tests
- pytest tentacles
after_success:
- if [ $TRAVIS_PULL_REQUEST == "false" ]; then coveralls; fi
- name: "Linux amd64 - Python 3.8 - Installed"
stage: test
script:
- python3 setup.py build_ext --inplace
- python3 setup.py install
- rm -rf $PACKAGE_FOLDER
- pytest tests
- pytest tentacles
- name: "Linux amd64 - Docker - Lint"
stage: test
before_install: skip
install: skip
script:
- docker run --rm -i hadolint/hadolint hadolint --ignore DL3008 --ignore DL3013 - < Dockerfile
- name: "Linux - Docker - Deploy"
stage: deploy
before_install: echo "$DOCKER_PASSWORD" | docker login --username "$DOCKER_USERNAME" --password-stdin
install: skip
script:
- docker build . -t drakkarsoftware/octobot:$TRAVIS_CLEANED_BRANCH -f Dockerfile
deploy:
- provider: script
script: docker push drakkarsoftware/octobot:$TRAVIS_CLEANED_BRANCH
cleanup: false
on:
repo: "$GH_REPO"
branch: "$DEPLOY_BRANCH"
tags: true
condition: "$TRAVIS_OS_NAME = 'linux'"
- name: "Linux - Docker - Deploy - Stable"
stage: deploy
before_install: skip
install: skip
script:
- wget https://raw.githubusercontent.com/plume-lib/trigger-travis/master/trigger-travis.sh -O /tmp/trigger-travis.sh
deploy:
- provider: script
script: bash /tmp/trigger-travis.sh --pro Drakkar-Software OctoBot-Builder $TRAVIS_TOKEN
cleanup: false
on:
repo: "$GH_REPO"
branch: "$DEPLOY_BRANCH"
tags: true
condition: "$TRAVIS_OS_NAME = 'linux'"
- name: "Linux - Docker - Deploy - Tag"
stage: deploy
before_install: skip
install: skip
script:
- git clone https://github.com/Drakkar-Software/OctoBot-Builder /tmp/OctoBot-Builder
- cd /tmp/OctoBot-Builder
- git tag $TRAVIS_TAG || true
deploy:
- provider: script
script: git push -q https://$GH_TOKEN@github.com/Drakkar-Software/OctoBot-Builder --tags
cleanup: false
on:
repo: "$GH_REPO"
branch: "$DEPLOY_BRANCH"
tags: true
condition: "$TRAVIS_OS_NAME = 'linux'"
- name: "Linux - Python 3 nightly - Deploy"
stage: deploy
script: skip
deploy:
- provider: pypi
username: __token__
password:
secure: Exh7oIsqs6neRU1BFhr0doLCn6EIkoBsoahP2SKl7tMdbhKaPCjPVQ56WI7FGW5nhK+x6IvIY5x9MUqr/b/LHzMrkQKbcgwzllvQYeIB4GUbxOrkZk1ju0oYZpDVaba9qSuBP2xo/bV5zm7DHgMZA44nXQQZKg6vPXEwtNBYUCo5uaRob5kwX5IqLhsl23D1Xcrq8CM9deeUQ87q/gNmKfjOtwGx5EvM8/Ckp3UK2G3rU7uDREVMYDttrXeCpIoK8DSFvxTJ5Nfqt9wh7N6lnleJELab1mKv7MxxEkbSZIuSCe0HU1WNUlUwSIeYKZu1QK0UvI1xPWVS2lsTDf1ePU+gUAnXLhKBRDRa8cNAGyAiDpHQJVXr5KH2dfXdLZHmyWFpmafM5Ew6WWrqj+KeGhzdPXuc2Igojua9v6/GF3Cdbls2KfIy51awOiIsqyKYAphhTiNkt3uUB1mSJKgH8Pm0QWB1NHup4zTzRtu3Z0fRGHl69XJDO2cEOERqe5XQ89o8OGrjvFWsFanV5XYPrDoC/WFHp0aODg2fCz+goPrlYV6ri/5Wp1QxD4xb6BSGfmH0ymz260KR78TiyIpThcWxsIFEbhNFTdkZ7Sh5I5nNeBHZztup3eW+ESCwEwlp/21q778P2l5kVnJMB9VYbZEEqQlAUT2ZM//rQMgBKQA=
skip_existing: true
cleanup: false
distributions: "sdist"
on:
repo: $GH_REPO
branch: $DEPLOY_BRANCH
tags: true
condition: $TRAVIS_OS_NAME = 'linux'
- provider: script
script: docker run -it -e PYPI_USERNAME=$PYPI_USERNAME -e PYPI_PASSWORD=$PYPI_PASSWORD -v $(pwd):/project drakkarsoftware/pypi-builder:python-$PYTHON_VERSION-manylinux-i686
cleanup: false
on:
repo: "$GH_REPO"
branch: "$DEPLOY_BRANCH"
tags: true
condition: "$TRAVIS_OS_NAME = 'linux'"
- provider: script
script: docker run -it -e PYPI_USERNAME=$PYPI_USERNAME -e PYPI_PASSWORD=$PYPI_PASSWORD -v $(pwd):/project drakkarsoftware/pypi-builder:python-$PYTHON_VERSION-manylinux-x86_64
cleanup: false
on:
repo: "$GH_REPO"
branch: "$DEPLOY_BRANCH"
tags: true
condition: "$TRAVIS_OS_NAME = 'linux'"
after_failure:
- wget https://raw.githubusercontent.com/DiscordHooks/travis-ci-discord-webhook/master/send.sh
- chmod +x send.sh
- ./send.sh failure https://discordapp.com/api/webhooks/$WEBHOOK_TOKEN

View File

@@ -3,8 +3,6 @@
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/e07fb190156d4efb8e7d07aaa5eff2e1)](https://app.codacy.com/gh/Drakkar-Software/OctoBot?utm_source=github.com&utm_medium=referral&utm_content=Drakkar-Software/OctoBot&utm_campaign=Badge_Grade_Dashboard)[![Downloads](https://pepy.tech/badge/octobot/month)](https://pepy.tech/project/octobot)
[![Dockerhub](https://img.shields.io/docker/pulls/drakkarsoftware/octobot.svg)](https://hub.docker.com/r/drakkarsoftware/octobot)
[![Coverage Status](https://img.shields.io/coveralls/github/Drakkar-Software/OctoBot.svg)](https://coveralls.io/github/Drakkar-Software/OctoBot?branch=dev)
[![Build Status](https://api.travis-ci.com/Drakkar-Software/OctoBot.svg?branch=dev)](https://travis-ci.com/Drakkar-Software/OctoBot)
[![Build Status](https://dev.azure.com/drakkarsoftware/OctoBot/_apis/build/status/Drakkar-Software.OctoBot?branchName=0.4.0)](https://dev.azure.com/drakkarsoftware/OctoBot/_build/latest?definitionId=1&branchName=0.4.0)
[![Build Status](https://cloud.drone.io/api/badges/Drakkar-Software/OctoBot/status.svg)](https://cloud.drone.io/Drakkar-Software/OctoBot)
#### Octobot Community

View File

@@ -1,138 +0,0 @@
trigger:
branches:
include:
- master
- dev
- 0.4.0
tags:
include:
- '*'
paths:
include:
- '*'
pr:
autoCancel: true
branches:
include:
- '*'
jobs:
- job: Windows
pool:
vmImage: 'windows-latest'
strategy:
maxParallel: 2
matrix:
Python38-32bit-full:
PYTHON_VERSION: '3.8'
PYTHON_ARCH: 'x86'
Python38-64bit-full:
PYTHON_VERSION: '3.8'
PYTHON_ARCH: 'x64'
steps:
- task: UsePythonVersion@0
inputs:
versionSpec: $(PYTHON_VERSION)
addToPath: true
architecture: $(PYTHON_ARCH)
- script: |
python -m pip install --upgrade pip setuptools wheel
python -m pip install --prefer-binary -r requirements.txt -r dev_requirements.txt
displayName: 'Install dependencies'
- powershell: |
$env:BranchName = switch ($env:Build_Reason) {
'PullRequest' { $env:System_PullRequest_SourceBranch.Replace('refs/pull/','').Replace('refs/heads/','') }
default { $env:Build_SourceBranchName }
}
mkdir user
copy octobot\config\default_config.json user\config.json
$Env:TENTACLES_URL_SUBCATEGORY = "dev/"
$Env:TENTACLES_URL_TAG = $env:BranchName -replace "/", "_"
python start.py tentacles -q --install --all
if ($LastExitCode -ne 0)
{
$Env:TENTACLES_URL_SUBCATEGORY = ""
If ($env:build_sourceBranch -like "*refs/tags/*") {
$Env:TENTACLES_URL_TAG = ""
} else {
$Env:TENTACLES_URL_TAG = "latest"
}
python start.py tentacles --install --all
}
displayName: 'Install OctoBot environment'
- script: |
python setup.py build_ext --inplace
python setup.py install
displayName: 'Install OctoBot'
- script: python -m pytest tests
displayName: 'Run OctoBot tests'
- script: python -m pytest tentacles
displayName: 'Run tentacles tests'
- script: python setup.py bdist_wheel
displayName: 'Building wheel'
- task: TwineAuthenticate@1
condition: startsWith(variables['build.sourceBranch'], 'refs/tags/')
displayName: 'Official Twine Authenticate'
inputs:
pythonUploadServiceConnection: pypi-official
- script: python -m twine upload -r "pypi-official" --config-file $(PYPIRC_PATH) --skip-existing dist/*
condition: startsWith(variables['build.sourceBranch'], 'refs/tags/')
displayName: 'Uploading wheel'
- job: macOS
pool:
vmImage: 'macOS-latest'
strategy:
maxParallel: 2
matrix:
Python38-64bit-full:
PYTHON_VERSION: '3.8'
PYTHON_ARCH: 'x64'
steps:
- task: UsePythonVersion@0
inputs:
versionSpec: $(PYTHON_VERSION)
addToPath: true
architecture: $(PYTHON_ARCH)
- script: |
python -m pip install --upgrade pip setuptools wheel
python -m pip install --prefer-binary -r requirements.txt -r dev_requirements.txt
displayName: 'Install dependencies'
- script: |
case "$BUILD_REASON" in
"PullRequest")
export HEAD_BRANCH_NAME=${SYSTEM_PULLREQUEST_SOURCEBRANCH//refs\/heads\//}
export BRANCH_NAME=${HEAD_BRANCH_NAME//refs\/pull\//}
;;
*) export BRANCH_NAME=$BUILD_SOURCEBRANCHNAME
;;
esac
case "$BUILD_SOURCEBRANCH" in
*refs/tags*)
;;
*) export TENTACLES_URL_TAG=latest
;;
esac
mkdir user
copy octobot\config\default_config.json user\config.json
TENTACLES_URL_SUBCATEGORY=dev/ TENTACLES_URL_TAG=${BRANCH_NAME////_} python3 start.py tentacles -q --install --all || python3 start.py tentacles --install --all
displayName: 'Install OctoBot environment'
- script: |
python setup.py build_ext --inplace
python setup.py install
displayName: 'Install OctoBot'
- script: python -m pytest tests
displayName: 'Run OctoBot tests'
- script: python -m pytest tentacles
displayName: 'Run tentacles tests'
- script: python setup.py bdist_wheel
displayName: 'Building wheel'
- task: TwineAuthenticate@1
condition: startsWith(variables['build.sourceBranch'], 'refs/tags/')
displayName: 'Official Twine Authenticate'
inputs:
pythonUploadServiceConnection: pypi-official
- script: python -m twine upload -r "pypi-official" --config-file $(PYPIRC_PATH) --skip-existing dist/*
condition: startsWith(variables['build.sourceBranch'], 'refs/tags/')
displayName: 'Uploading wheel'

View File

@@ -14,3 +14,5 @@ setuptools
wheel
pur
pylint

590
standard.rc Normal file
View File

@@ -0,0 +1,590 @@
[MASTER]
# A comma-separated list of package or module names from where C extensions may
# be loaded. Extensions are loading into the active Python interpreter and may
# run arbitrary code.
extension-pkg-whitelist=
# Specify a score threshold to be exceeded before program exits with error.
fail-under=10.0
# Add files or directories to the blacklist. They should be base names, not
# paths.
ignore=CVS
# Add files or directories matching the regex patterns to the blacklist. The
# regex matches against base names, not paths.
ignore-patterns=
# Python code to execute, usually for sys.path manipulation such as
# pygtk.require().
#init-hook=
# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
# number of processors available to use.
jobs=1
# Control the amount of potential inferred values when inferring a single
# object. This can help the performance when dealing with large functions or
# complex, nested conditions.
limit-inference-results=100
# List of plugins (as comma separated values of python module names) to load,
# usually to register additional checkers.
load-plugins=
# Pickle collected data for later comparisons.
persistent=yes
# When enabled, pylint would attempt to guess common misconfiguration and emit
# user-friendly hints instead of false-positive error messages.
suggestion-mode=yes
# Allow loading of arbitrary C extensions. Extensions are imported into the
# active Python interpreter and may run arbitrary code.
unsafe-load-any-extension=no
[MESSAGES CONTROL]
# Only show warnings with the listed confidence levels. Leave empty to show
# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED.
confidence=
# Disable the message, report, category or checker with the given id(s). You
# can either give multiple identifiers separated by comma (,) or put this
# option multiple times (only on the command line, not in the configuration
# file where it should appear only once). You can also use "--disable=all" to
# disable everything first and then reenable specific checks. For example, if
# you want to run only the similarities checker, you can use "--disable=all
# --enable=similarities". If you want to run only the classes checker, but have
# no Warning level messages displayed, use "--disable=all --enable=classes
# --disable=W".
disable=print-statement,
parameter-unpacking,
unpacking-in-except,
old-raise-syntax,
backtick,
long-suffix,
old-ne-operator,
old-octal-literal,
import-star-module-level,
non-ascii-bytes-literal,
raw-checker-failed,
bad-inline-option,
locally-disabled,
file-ignored,
suppressed-message,
useless-suppression,
deprecated-pragma,
use-symbolic-message-instead,
apply-builtin,
basestring-builtin,
buffer-builtin,
cmp-builtin,
coerce-builtin,
execfile-builtin,
file-builtin,
long-builtin,
raw_input-builtin,
reduce-builtin,
standarderror-builtin,
unicode-builtin,
xrange-builtin,
coerce-method,
delslice-method,
getslice-method,
setslice-method,
no-absolute-import,
old-division,
dict-iter-method,
dict-view-method,
next-method-called,
metaclass-assignment,
indexing-exception,
raising-string,
reload-builtin,
oct-method,
hex-method,
nonzero-method,
cmp-method,
input-builtin,
round-builtin,
intern-builtin,
unichr-builtin,
map-builtin-not-iterating,
zip-builtin-not-iterating,
range-builtin-not-iterating,
filter-builtin-not-iterating,
using-cmp-argument,
eq-without-hash,
div-method,
idiv-method,
rdiv-method,
exception-message-attribute,
invalid-str-codec,
sys-max-int,
bad-python3-import,
deprecated-string-function,
deprecated-str-translate-call,
deprecated-itertools-function,
deprecated-types-field,
next-method-defined,
dict-items-not-iterating,
dict-keys-not-iterating,
dict-values-not-iterating,
deprecated-operator-function,
deprecated-urllib-function,
xreadlines-attribute,
deprecated-sys-function,
exception-escape,
comprehension-escape,
import-error,
C, I, R, W # only errors TODO remove
# Enable the message, report, category or checker with the given id(s). You can
# either give multiple identifier separated by comma (,) or put this option
# multiple time (only on the command line, not in the configuration file where
# it should appear only once). See also the "--disable" option for examples.
enable=
[REPORTS]
# Python expression which should return a score less than or equal to 10. You
# have access to the variables 'error', 'warning', 'refactor', and 'convention'
# which contain the number of messages in each category, as well as 'statement'
# which is the total number of statements analyzed. This score is used by the
# global evaluation report (RP0004).
evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
# Template used to display messages. This is a python new-style format string
# used to format the message information. See doc for all details.
#msg-template=
# Set the output format. Available formats are text, parseable, colorized, json
# and msvs (visual studio). You can also give a reporter class, e.g.
# mypackage.mymodule.MyReporterClass.
output-format=text
# Tells whether to display a full report or only the messages.
reports=no
# Activate the evaluation score.
score=yes
[REFACTORING]
# Maximum number of nested blocks for function / method body
max-nested-blocks=5
# Complete name of functions that never returns. When checking for
# inconsistent-return-statements if a never returning function is called then
# it will be considered as an explicit return statement and no message will be
# printed.
never-returning-functions=sys.exit
[MISCELLANEOUS]
# List of note tags to take in consideration, separated by a comma.
notes=FIXME,
XXX,
TODO
# Regular expression of note tags to take in consideration.
#notes-rgx=
[STRING]
# This flag controls whether inconsistent-quotes generates a warning when the
# character used as a quote delimiter is used inconsistently within a module.
check-quote-consistency=no
# This flag controls whether the implicit-str-concat should generate a warning
# on implicit string concatenation in sequences defined over several lines.
check-str-concat-over-line-jumps=no
[BASIC]
# Naming style matching correct argument names.
argument-naming-style=snake_case
# Regular expression matching correct argument names. Overrides argument-
# naming-style.
#argument-rgx=
# Naming style matching correct attribute names.
attr-naming-style=snake_case
# Regular expression matching correct attribute names. Overrides attr-naming-
# style.
#attr-rgx=
# Bad variable names which should always be refused, separated by a comma.
bad-names=foo,
bar,
baz,
toto,
tutu,
tata
# Bad variable names regexes, separated by a comma. If names match any regex,
# they will always be refused
bad-names-rgxs=
# Naming style matching correct class attribute names.
class-attribute-naming-style=any
# Regular expression matching correct class attribute names. Overrides class-
# attribute-naming-style.
#class-attribute-rgx=
# Naming style matching correct class names.
class-naming-style=PascalCase
# Regular expression matching correct class names. Overrides class-naming-
# style.
#class-rgx=
# Naming style matching correct constant names.
const-naming-style=UPPER_CASE
# Regular expression matching correct constant names. Overrides const-naming-
# style.
#const-rgx=
# Minimum line length for functions/classes that require docstrings, shorter
# ones are exempt.
docstring-min-length=-1
# Naming style matching correct function names.
function-naming-style=snake_case
# Regular expression matching correct function names. Overrides function-
# naming-style.
#function-rgx=
# Good variable names which should always be accepted, separated by a comma.
good-names=i,
j,
k,
ex,
Run,
_
# Good variable names regexes, separated by a comma. If names match any regex,
# they will always be accepted
good-names-rgxs=
# Include a hint for the correct naming format with invalid-name.
include-naming-hint=no
# Naming style matching correct inline iteration names.
inlinevar-naming-style=any
# Regular expression matching correct inline iteration names. Overrides
# inlinevar-naming-style.
#inlinevar-rgx=
# Naming style matching correct method names.
method-naming-style=snake_case
# Regular expression matching correct method names. Overrides method-naming-
# style.
#method-rgx=
# Naming style matching correct module names.
module-naming-style=snake_case
# Regular expression matching correct module names. Overrides module-naming-
# style.
#module-rgx=
# Colon-delimited sets of names that determine each other's naming style when
# the name regexes allow several styles.
name-group=
# Regular expression which should only match function or class names that do
# not require a docstring.
no-docstring-rgx=^_
# List of decorators that produce properties, such as abc.abstractproperty. Add
# to this list to register other decorators that produce valid properties.
# These decorators are taken in consideration only for invalid-name.
property-classes=abc.abstractproperty
# Naming style matching correct variable names.
variable-naming-style=snake_case
# Regular expression matching correct variable names. Overrides variable-
# naming-style.
#variable-rgx=
[SPELLING]
# Limits count of emitted suggestions for spelling mistakes.
max-spelling-suggestions=4
# Spelling dictionary name. Available dictionaries: none. To make it work,
# install the python-enchant package.
spelling-dict=
# List of comma separated words that should not be checked.
spelling-ignore-words=
# A path to a file that contains the private dictionary; one word per line.
spelling-private-dict-file=
# Tells whether to store unknown words to the private dictionary (see the
# --spelling-private-dict-file option) instead of raising a message.
spelling-store-unknown-words=no
[LOGGING]
# The type of string formatting that logging methods do. `old` means using %
# formatting, `new` is for `{}` formatting.
logging-format-style=old
# Logging modules to check that the string format arguments are in logging
# function parameter format.
logging-modules=logging
[FORMAT]
# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
expected-line-ending-format=
# Regexp for a line that is allowed to be longer than the limit.
ignore-long-lines=^\s*(# )?<?https?://\S+>?$
# Number of spaces of indent required inside a hanging or continued line.
indent-after-paren=4
# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
# tab).
indent-string=' '
# Maximum number of characters on a single line.
max-line-length=100
# Maximum number of lines in a module.
max-module-lines=1000
# Allow the body of a class to be on the same line as the declaration if body
# contains single statement.
single-line-class-stmt=no
# Allow the body of an if to be on the same line as the test if there is no
# else.
single-line-if-stmt=no
[TYPECHECK]
# List of decorators that produce context managers, such as
# contextlib.contextmanager. Add to this list to register other decorators that
# produce valid context managers.
contextmanager-decorators=contextlib.contextmanager
# List of members which are set dynamically and missed by pylint inference
# system, and so shouldn't trigger E1101 when accessed. Python regular
# expressions are accepted.
generated-members=
# Tells whether missing members accessed in mixin class should be ignored. A
# mixin class is detected if its name ends with "mixin" (case insensitive).
ignore-mixin-members=yes
# Tells whether to warn about missing members when the owner of the attribute
# is inferred to be None.
ignore-none=yes
# This flag controls whether pylint should warn about no-member and similar
# checks whenever an opaque object is returned when inferring. The inference
# can return multiple potential results while evaluating a Python object, but
# some branches might not be evaluated, which results in partial inference. In
# that case, it might be useful to still emit no-member and other checks for
# the rest of the inferred objects.
ignore-on-opaque-inference=yes
# List of class names for which member attributes should not be checked (useful
# for classes with dynamically set attributes). This supports the use of
# qualified names.
ignored-classes=optparse.Values,thread._local,_thread._local
# List of module names for which member attributes should not be checked
# (useful for modules/projects where namespaces are manipulated during runtime
# and thus existing member attributes cannot be deduced by static analysis). It
# supports qualified module names, as well as Unix pattern matching.
ignored-modules=
# Show a hint with possible names when a member name was not found. The aspect
# of finding the hint is based on edit distance.
missing-member-hint=yes
# The minimum edit distance a name should have in order to be considered a
# similar match for a missing member name.
missing-member-hint-distance=1
# The total number of similar names that should be taken in consideration when
# showing a hint for a missing member.
missing-member-max-choices=1
# List of decorators that change the signature of a decorated function.
signature-mutators=
[SIMILARITIES]
# Ignore comments when computing similarities.
ignore-comments=yes
# Ignore docstrings when computing similarities.
ignore-docstrings=yes
# Ignore imports when computing similarities.
ignore-imports=no
# Minimum lines number of a similarity.
min-similarity-lines=4
[VARIABLES]
# List of additional names supposed to be defined in builtins. Remember that
# you should avoid defining new builtins when possible.
additional-builtins=
# Tells whether unused global variables should be treated as a violation.
allow-global-unused-variables=yes
# List of strings which can identify a callback function by name. A callback
# name must start or end with one of those strings.
callbacks=cb_,
_cb
# A regular expression matching the name of dummy variables (i.e. expected to
# not be used).
dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
# Argument names that match this expression will be ignored. Default to name
# with leading underscore.
ignored-argument-names=_.*|^ignored_|^unused_
# Tells whether we should check for unused import in __init__ files.
init-import=no
# List of qualified module names which can have objects that can redefine
# builtins.
redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
[DESIGN]
# Maximum number of arguments for function / method.
max-args=5
# Maximum number of attributes for a class (see R0902).
max-attributes=7
# Maximum number of boolean expressions in an if statement (see R0916).
max-bool-expr=5
# Maximum number of branch for function / method body.
max-branches=12
# Maximum number of locals for function / method body.
max-locals=15
# Maximum number of parents for a class (see R0901).
max-parents=7
# Maximum number of public methods for a class (see R0904).
max-public-methods=20
# Maximum number of return / yield for function / method body.
max-returns=6
# Maximum number of statements in function / method body.
max-statements=50
# Minimum number of public methods for a class (see R0903).
min-public-methods=2
[CLASSES]
# List of method names used to declare (i.e. assign) instance attributes.
defining-attr-methods=__init__,
__new__,
setUp,
__post_init__
# List of member names, which should be excluded from the protected access
# warning.
exclude-protected=_asdict,
_fields,
_replace,
_source,
_make
# List of valid names for the first argument in a class method.
valid-classmethod-first-arg=cls
# List of valid names for the first argument in a metaclass class method.
valid-metaclass-classmethod-first-arg=cls
[IMPORTS]
# List of modules that can be imported at any level, not just the top level
# one.
allow-any-import-level=
# Allow wildcard imports from modules that define __all__.
allow-wildcard-with-all=no
# Analyse import fallback blocks. This can be used to support both Python 2 and
# 3 compatible code, which means that the block might have code that exists
# only in one or another interpreter, leading to false positives when analysed.
analyse-fallback-blocks=no
# Deprecated modules which should not be used, separated by a comma.
deprecated-modules=optparse,tkinter.tix
# Create a graph of external dependencies in the given file (report RP0402 must
# not be disabled).
ext-import-graph=
# Create a graph of every (i.e. internal and external) dependencies in the
# given file (report RP0402 must not be disabled).
import-graph=
# Create a graph of internal dependencies in the given file (report RP0402 must
# not be disabled).
int-import-graph=
# Force import order to recognize a module as part of the standard
# compatibility libraries.
known-standard-library=
# Force import order to recognize a module as part of a third party library.
known-third-party=enchant
# Couples of modules and preferred modules, separated by a comma.
preferred-modules=
[EXCEPTIONS]
# Exceptions that will emit a warning when being caught. Defaults to
# "BaseException, Exception".
overgeneral-exceptions=BaseException,
Exception