The Pylint linter for Python code (https://www.pylint.org/).
Config section: [pylint]
Basic options
--[no-]pylint-skip
PANTS_PYLINT_SKIP
skip
False
Don't use Pylint when running `./pants lint`
--pylint-args="[<shell_str>, <shell_str>, ...]"
PANTS_PYLINT_ARGS
args
[]
Arguments to pass directly to Pylint, e.g. `--pylint-args="--ignore=foo.py,bar.py --disable=C0330,W0311"`
Advanced options
--pylint-version=<str>
PANTS_PYLINT_VERSION
version
pylint>=2.4.4,<2.5
Requirement string for the tool.
--pylint-extra-requirements="['<str>', '<str>', ...]"
PANTS_PYLINT_EXTRA_REQUIREMENTS
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.
--pylint-entry-point=<str>
PANTS_PYLINT_ENTRY_POINT
entry_point
pylint
The main module for the tool. Usually, you will not want to change this from the default.
--pylint-config=<file_option>
PANTS_PYLINT_CONFIG
config
None
Path to `pylintrc` or alternative Pylint config file
--pylint-source-plugins="[<target_option>, <target_option>, ...]"
PANTS_PYLINT_SOURCE_PLUGINS
source_plugins
[]
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.2/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
Updated 2 months ago