pylint-errors


plerr

A list of pylint-errors with reasoning and examples of erroneous and correct code.

Example

Table of contents

CLI usage

It’s not required to install CLI util as long as you can navigate list of errors here or on this web-site but you may want to do so.

Stable release

You can install a stable release simply by such commands:

$ python3 -m pip install plerr
$ plerr r1710

For pipx:

$ python3 -m pip install pipx # if not yet installed pipx
$ python3 -m pipx ensurepath # ensure directory where pipx stores apps is on PATH
$ pipx install plerr
$ plerr r1710

Dev builds

In order to use development plerr builds you need to invoke the following commands:

$ git clone https://github.com/vald-phoenix/pylint-errors.git
$ sudo apt update && sudo apt install -y python3-pip # if not yet installed
$ cd pylint-errors
$ python3 setup.py test
$ python3 setup.py install --user
$ python3 -m plerr r1710

pipx users may install the library by such commands:

$ git clone https://github.com/vald-phoenix/pylint-errors.git
$ sudo apt install -y make python3-pip python3-venv # if not yet installed
$ cd pylint-errors
$ python3 -m pip install pipx wheel # install a package to build a wheel and pipx
$ python3 -m pipx ensurepath # ensure directory where pipx stores apps is on PATH
$ python3 setup.py test # run tests
$ make clean
$ python3 setup.py bdist_wheel # build a binary wheel
$ pipx install dist/* # install a binary wheel by pipx
$ plerr r1710

In order to get the latest updates just git pull origin master and invoke a command in the root of the project (sudo apt install make if not yet installed) make rai to install to Python 3 user space site packages or make raip for pipx.

List of errors

Error codes with [+] mean they’ve got examples of bad and good code. Rationalisation provided for all entries.

Async Checker Messages

Basic Checker Messages

Broad Try Clause Checker Messages

Classes Checker Messages

Compare-To-Empty-String Checker Messages

Compare-To-Zero Checker Messages

Deprecated Builtins Checker Messages

Design Checker Messages

Docstyle Checker Messages

Else If Used Checker Messages

Exceptions Checker Messages

Format Checker Messages

Imports Checker Messages

Logging Checker Messages

Miscellaneous Checker Messages

Multiple Types Checker Messages

Newstyle Checker Messages

Overlap-Except Checker Messages

Parameter Documentation Checker Messages

Refactoring Checker Messages

Similarities Checker Messages

Spelling Checker Messages

Stdlib Checker Messages

String Checker Messages

Typecheck Checker Messages

Variables Checker Messages