Skip to main content
Version: 2.19 (deprecated)

pylint

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

Backend: pants.backend.python.lint.pylint

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

If true, don't use Pylint when running pants lint.

Advanced options​

config​

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

Path to a config file understood by Pylint (http://pylint.pycqa.org/en/latest/user_guide/run.html#command-line-options).

Setting this option will disable [pylint].config_discovery. Use this option if the config is located in a non-standard location.

config_discovery​

--[no-]pylint-config-discovery
PANTS_PYLINT_CONFIG_DISCOVERY
pants.toml
[pylint]
config_discovery = <bool>
default: True

If true, Pants will include any relevant config files during runs (.pylintrc, pylintrc, pyproject.toml, and setup.cfg).

Use [pylint].config instead if your config is in a non-standard location.

console_script​

--pylint-console-script=<str>
PANTS_PYLINT_CONSOLE_SCRIPT
pants.toml
[pylint]
console_script = <str>
default: pylint

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​

--pylint-entry-point=<str>
PANTS_PYLINT_ENTRY_POINT
pants.toml
[pylint]
entry_point = <str>
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.

install_from_resolve​

--pylint-install-from-resolve=<str>
PANTS_PYLINT_INSTALL_FROM_RESOLVE
pants.toml
[pylint]
install_from_resolve = <str>
default: None

If specified, install the tool using the lockfile for this named resolve.

This resolve must be defined in [python].resolves, as described in https://www.pantsbuild.org/v2.19/docs/python-third-party-dependencies#user-lockfiles.

The resolve's entire lockfile will be installed, unless specific requirements are listed via the requirements option, in which case only those requirements will be installed. This is useful if you don't want to invalidate the tool's outputs when the resolve incurs changes to unrelated requirements.

If unspecified, and the lockfile option is unset, the tool will be installed using the default lockfile shipped with Pants.

If unspecified, and the lockfile option is set, the tool will use the custom pylint "tool lockfile" generated from the version and extra_requirements options. But note that this mechanism is deprecated.

requirements​

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

If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile.

Values can be pip-style requirements (e.g., tool or tool==1.2.3 or tool>=1.2.3), or addresses of python_requirement targets (or targets that generate or depend on python_requirement targets).

The lockfile will be validated against the requirements - if a lockfile doesn't provide the requirement (at a suitable version, if the requirement specifies version constraints) Pants will error.

If unspecified, install the entire lockfile.

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 python_sources 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.19/docs/source-roots

You must also set load-plugins=$module_name in your Pylint config file.

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, add them to a custom resolve alongside pylint itself, as described in https://www.pantsbuild.org/v2.19/docs/python-lockfiles#lockfiles-for-tools.

Deprecated options​

None

None