flake8
The Flake8 Python linter (https://flake8.pycqa.org/).
Config section: [flake8]
Basic options
False
Don't use Flake8 when running ./pants lint
[]
Arguments to pass directly to Flake8, e.g. --flake8-args="--ignore E123,W456 --enable-extensions H111"
Advanced options
flake8>=3.9.2,<4.0
Requirement string for the tool.
extra_requirements
extra_requirements
--flake8-extra-requirements="['<str>', '<str>', ...]"
PANTS_FLAKE8_EXTRA_REQUIREMENTS
[]
Any additional requirement strings to use with the tool. This is useful if the tool allows you to install plugins or if you need to constrain a dependency to a certain version.
<default>
Path to a lockfile used for installing the tool.
Set to the string <default>
to use a lockfile provided by Pants, so long as you have not changed the --version
and --extra-requirements
options, and the tool's interpreter constraints are compatible with the default. Pants will error or warn if the lockfile is not compatible (controlled by [python].invalid_lockfile_behavior
). See https://github.com/pantsbuild/pants/blob/release_2.8.1rc2/src/python/pants/backend/python/lint/flake8/lockfile.txt for the default lockfile contents.
Set to the string <none>
to opt out of using a lockfile. We do not recommend this, though, as lockfiles are essential for reproducible builds.
To use a custom lockfile, set this option to a file path relative to the build root, then run ./pants generate-lockfiles --resolve=flake8
.
Lockfile generation currently does not wire up the [python-repos]
options. If lockfile generation fails, you can manually generate a lockfile, such as by using pip-compile or pip freeze
. Set this option to the path to your manually generated lockfile. When manually maintaining lockfiles, set [python].invalid_lockfile_behavior = 'ignore'
.
flake8
The console script for the tool. Using this option is generally preferable to (and mutually exclusive with) specifying an --entry-point since console script names have a higher expectation of staying stable across releases of the tool. Usually, you will not want to change this from the default.
None
The entry point for the tool. Generally you only want to use this option if the tool does not offer a --console-script (which this option is mutually exclusive with). Usually, you will not want to change this from the default.
None
Path to an INI config file understood by Flake8 (https://flake8.pycqa.org/en/latest/user/configuration.html).
Setting this option will disable [flake8].config_discovery
. Use this option if the config is located in a non-standard location.
True
If true, Pants will include any relevant config files during runs (.flake8
, flake8
, setup.cfg
, and tox.ini
).
Use [flake8].config
instead if your config is in a non-standard location.
Deprecated options
None
Updated over 1 year ago