pylint

skip

--[no-]pylint-skip

PANTS_PYLINT_SKIP

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

args

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

PANTS_PYLINT_ARGS

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

If true, export a virtual environment with Pylint when running ./pants export.

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

version

--pylint-version=<str>

PANTS_PYLINT_VERSION

Requirement string for the tool.

extra_requirements

--pylint-extra-requirements="['<str>', '<str>', ...]"

PANTS_PYLINT_EXTRA_REQUIREMENTS

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

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.14.2rc2/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 and supply-chain security.

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

Alternatively, you can set this option to the path to a custom lockfile using pip's requirements.txt-style, ideally with --hash. Set [python].invalid_lockfile_behavior = 'ignore' so that Pants does not complain about missing lockfile headers.

console_script

--pylint-console-script=<str>

PANTS_PYLINT_CONSOLE_SCRIPT

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

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.

config

--pylint-config=<file_option>

PANTS_PYLINT_CONFIG

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

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.

source_plugins

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

PANTS_PYLINT_SOURCE_PLUGINS

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