Skip to main content
Version: 2.2 (deprecated)

flake8

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

Backend: ``

Config section: [flake8]

Basic options​

args​

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

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

skip​

--[no-]flake8-skip
PANTS_FLAKE8_SKIP
pants.toml
[flake8]
skip = <bool>
default: False

Don't use Flake8 when running /home/josh/work/scie-pants/dist/pants lint

Advanced options​

config​

--flake8-config=<file_option>
PANTS_FLAKE8_CONFIG
pants.toml
[flake8]
config = <file_option>
default: None

Path to .flake8 or alternative Flake8 config file

entry_point​

--flake8-entry-point=<str>
PANTS_FLAKE8_ENTRY_POINT
pants.toml
[flake8]
entry_point = <str>
default: flake8

The main module for the tool. Usually, you will not want to change this from the default.

extra_requirements​

--flake8-extra-requirements="['<str>', '<str>', ...]"
PANTS_FLAKE8_EXTRA_REQUIREMENTS
pants.toml
[flake8]
extra_requirements = [
    '<str>',
    '<str>',
    ...,
]
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.

version​

--flake8-version=<str>
PANTS_FLAKE8_VERSION
pants.toml
[flake8]
version = <str>
default: flake8>=3.7.9,<3.9

Requirement string for the tool.

Deprecated options​

None

None