The Flake8 Python linter (https://flake8.pycqa.org/).

Config section: [flake8]

Basic options

skip

--[no-]flake8-skip
PANTS_FLAKE8_SKIP
default: False

Don't use Flake8 when running `./pants lint`


args

--flake8-args="[<shell_str>, <shell_str>, ...]"
PANTS_FLAKE8_ARGS
default: []

Arguments to pass directly to Flake8, e.g. `--flake8-args="--ignore E123,W456 --enable-extensions H111"`


Advanced options

version

--flake8-version=<str>
PANTS_FLAKE8_VERSION
default: flake8>=3.7.9,<3.9

Requirement string for the tool.


extra_requirements

--flake8-extra-requirements="['<str>', '<str>', ...]"
PANTS_FLAKE8_EXTRA_REQUIREMENTS
default:
[
  "setuptools<45; python\_full\_version == '2.7.\*'",
  "setuptools; python\_version > '2.7'"
]

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.


console_script

--flake8-console-script=<str>
PANTS_FLAKE8_CONSOLE_SCRIPT
default: 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.


entry_point

--flake8-entry-point=<str>
PANTS_FLAKE8_ENTRY_POINT
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.


config

--flake8-config=<file_option>
PANTS_FLAKE8_CONFIG
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.


config_discovery

--[no-]flake8-config-discovery
PANTS_FLAKE8_CONFIG_DISCOVERY
default: 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


Did this page help you?