Pants v2: The ergonomic build system

Welcome to the Pants v2 documentation hub!

Pants v2 is a fast, scalable, user-friendly build system for growing codebases. It's currently focused on Python, with support for other languages coming soon.

Here you'll find guides to help you get started with Pants v2, comprehensive documentation on how to configure, run and customize Pants v2, and information on how to get help from the Pants community.

Get Started

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

Config section: [pylint]

Basic options

skip

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

Don't use Pylint when running `./pants 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.


console_script

--pylint-console-script=<str>
PANTS_PYLINT_CONSOLE_SCRIPT
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
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.


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.4/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 about a month ago


pylint


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.