Skip to main content
Version: 2.12 (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'.

export​

--[no-]pylint-export
PANTS_PYLINT_EXPORT
pants.toml
[pylint]
export = <bool>
default: True

If true, export a virtual environment with Pylint when running /home/josh/work/scie-pants/dist/pants export.

This can be useful, for example, with IDE integrations to point your editor to the tool's binary.

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 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.

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.

lockfile​

--pylint-lockfile=<str>
PANTS_PYLINT_LOCKFILE
pants.toml
[pylint]
lockfile = <str>
default: <default>

Path to a lockfile used for installing the tool.

Set to the string <default> to use a lockfile provided by Pants, so long as you have not changed the --version and --extra-requirements options, and the tool's interpreter constraints are compatible with the default. Pants will error or warn if the lockfile is not compatible (controlled by [python].invalid_lockfile_behavior). See https://github.com/pantsbuild/pants/blob/release_2.12.1/src/python/pants/backend/python/lint/pylint/pylint.lock for the default lockfile contents.

Set to the string <none> to opt out of using a lockfile. We do not recommend this, though, as lockfiles are essential for reproducible builds.

To use a custom lockfile, set this option to a file path relative to the build root, then run /home/josh/work/scie-pants/dist/pants generate-lockfiles --resolve=pylint.

As explained at https://www.pantsbuild.org/v2.12/docs/python-third-party-dependencies, lockfile generation via generate-lockfiles does not always work and you may want to manually generate the lockfile. You will want to set [python].invalid_lockfile_behavior = 'ignore' so that Pants does not complain about missing lockfile headers.

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.12/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, set the option [pylint].extra_requirements and set the load-plugins option in your Pylint config.

Tip: it's often helpful to define a dedicated 'resolve' via [python].resolves for your Pylint plugins such as 'pylint-plugins' so that the third-party requirements used by your plugin, like pylint, do not mix with the rest of your project. Read that option's help message for more info on resolves.

version​

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

Requirement string for the tool.

Deprecated options​

None

None