Skip to main content
Version: 2.3.x (deprecated)

pylint

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

Backend: pants.core

Config section: [pylint]

Basic options​

skip​

--[no-]pylint-skip
PANTS_PYLINT_SKIP
default: False

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

args​

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

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

Advanced options​

version​

--pylint-version=<str>
PANTS_PYLINT_VERSION
default: pylint>=2.4.4,<2.5

Requirement string for the tool.

extra_requirements​

--pylint-extra-requirements="['<str>', '<str>', ...]"
PANTS_PYLINT_EXTRA_REQUIREMENTS
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.

entry_point​

--pylint-entry-point=<str>
PANTS_PYLINT_ENTRY_POINT
default: pylint

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

config​

--pylint-config=<file_option>
PANTS_PYLINT_CONFIG
default: None

Path to pylintrc or alternative Pylint config file

source_plugins​

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

An optional list of python_library target addresses to load first-party plugins.

You must set the plugin's parent directory as a source root. For example, if your plugin is at build-support/pylint/custom_plugin.py, add 'build-support/pylint' to [source].root_patterns in pants.toml. This is necessary for Pants to know how to tell Pylint to discover your plugin. See https://www.pantsbuild.org/v2.3/docs/source-roots

You must also set load-plugins=$module_name in your Pylint config file, and set the [pylint].config option in pants.toml.

While your plugin's code can depend on other first-party code and third-party requirements, all first-party dependencies of the plugin must live in the same directory or a subdirectory.

To instead load third-party plugins, set the option [pylint].extra_requirements and set the load-plugins option in your Pylint config.

Deprecated options​

None