Linting
The PEP 8 document makes a number of style recommendations for writing
Python code. valjean tries to be PEP 8-compliant; you can check many
of the PEP 8 recommendations with linters such as flake8 or
pylint, which are automatically pulled and installed when
valjean is installed with the [dev] extra feature. Just run one of
the following from the source folder:
$ flake8
$ pylint valjean tests
As a rule, try hard to keep valjean lint-free by running these commands
often. If the linter emits a warning, you can do one of the following:
Fix the warning;
No, really, fix the warning;
If there’s a warning you really can’t fix, you can shut up the linter about that particular code line by adding special annotations (see below). But really, you should fix the warning instead.
Suppressing linter warnings
Sometimes, linters emit warning, but you know that the warning is actually benign. You can tell flake8 or pylint to shut up about a specific warning by adding a comment with a special annotation in the source code. For flake8, suppression annotations look like this:
<code raising a warning> # noqa: E402
Note the E402 error code, which must matches flake8’s output
message. For pylint, annotations look like this:
<code raising a warning> # pylint: disable=trailing-whitespace
Again, the string after disable= must match the name of the warning in the
pylint output.
See the flake8 and pylint documentation for more details.
tox integration
There is a specific tox test environment to run the linters. Check the
page about using tox for continuous integration.