Skip to main content
Version: 2.1 (deprecated)

pylint

The PyLint linter for Python code (https://www.pylint.org/).

Backend: ``

Config section: [pylint]

Basic options​

args​

--pylint-args="[<shell_str>, <shell_str>, ...]"
PANTS_PYLINT_ARGS
pants.toml
[pylint]
args = [
    <shell_str>,
    <shell_str>,
    ...,
]
default: []

Arguments to pass directly to Pylint, e.g. --pylint-args="--ignore=foo.py,bar.py --disable=C0330,W0311"

skip​

--[no-]pylint-skip
PANTS_PYLINT_SKIP
pants.toml
[pylint]
skip = <bool>
default: False

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

Advanced options​

config​

--pylint-config=<file_option>
PANTS_PYLINT_CONFIG
pants.toml
[pylint]
config = <file_option>
default: None

Path to pylintrc or alternative Pylint config file

entry_point​

--pylint-entry-point=<str>
PANTS_PYLINT_ENTRY_POINT
pants.toml
[pylint]
entry_point = <str>
default: pylint

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

extra_requirements​

--pylint-extra-requirements="['<str>', '<str>', ...]"
PANTS_PYLINT_EXTRA_REQUIREMENTS
pants.toml
[pylint]
extra_requirements = [
    '<str>',
    '<str>',
    ...,
]
default: []

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.

source_plugins​

--pylint-source-plugins="[<target_option>, <target_option>, ...]"
PANTS_PYLINT_SOURCE_PLUGINS
pants.toml
[pylint]
source_plugins = [
    <target_option>,
    <target_option>,
    ...,
]
default: []

An optional list of pylint_source_plugin target addresses. This allows you to load custom plugins defined in source code. Run ./pants help pylint_source_plugin for instructions, including how to load third-party plugins.

version​

--pylint-version=<str>
PANTS_PYLINT_VERSION
pants.toml
[pylint]
version = <str>
default: pylint>=2.4.4,<2.5

Requirement string for the tool.

Deprecated options​

None

None