A PyLint plugin to add coding CNES specific checks
Project description
cnes-pylint-extension
cnes-pylint-extension is a python checker, which adds CNES specific checks to pylint.
cnes-pylint-extension checks the following rules :
- R5101 - multiple-exit-statements
- R5102 - too-many-decorators
- R5103 - bad-exit-condition
- R5104 - builtin-name-used
- R5105 - recursive-call
- R5106 - use-context-manager
- R5401 - sys-exit-used
- R5402 - os-environ-used
- R5403 - sys-argv-used
- W9095 - missing-docstring-field
- W9096 - malformed-docstring-field
- W9097 - missing-docstring-description
cnes-pylint-extension checks the following metrics :
- R5301 - too-high-complexity (default < 25)
- R5302 - too-high-complexity-simplified (default < 20)
- R5201 - too-few-comments (default > 20%)
Available versions :
- Version 1.0 - compatible pylint 1.5
- Version 2.0 - compatible pylint 1.6
- Version 3.0 - compatible pylint 1.7.4 and 1.9.1
- Version 4.0 - compatible pylint 2.1.1
- Version 5.0 - compatible pylint 2.5.0
To use these checkers:
Install from PIP
pip install cnes-pylint-extension
Install from sources
Install Pylint
pip install pylint==2.5.0
Install CNES Pylint extension checkers
Download the project's code source then add the checkers subdirectory to your PYTHONPATH :
unzip cnes-pylint-extension.zip
cd cnes-pylint-extension
echo export PYTHONPATH=$PYTHONPATH:$PWD/checkers >> ~/.bashrc
source ~/.bashrc
To enable Pylint to use the extension, you need to edit your pylintrc file, and add "cnes_checker" to the plugins list.
[MASTER]
load-plugins=cnes_checker
...
Usage
Pylint is now able to use the extension.
Otherwise, add --load-plugins=cnes_checker
to your pylint command line in order to activate it.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cnes-pylint-extension-5.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c4451cb72348dbcfcc3e7422961a696adfb2fad4b9a32b26428a092a1ddbf7ca |
|
MD5 | 960e61dad879e15dce0d5552a9e04e73 |
|
BLAKE2b-256 | 78515eac18cb635a24da74020e374d0a7ddeb73d750c4d647648eacafac82051 |
Hashes for cnes_pylint_extension-5.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 051dec7594b87b8f975417f5d8c569b02543db377591219080479d9e4fd5d6ff |
|
MD5 | a9246cef409474929fafb93d64c7d6e4 |
|
BLAKE2b-256 | cb60419acc49ffa289b16c273fa71290701a26caf767d6bdb3117631c36c3205 |