Pants v2: Fast, consistent builds for Python and more

Welcome to the Pants v2 documentation hub!

Pants v2 is a fast, scalable 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 Black Python code formatter (https://black.readthedocs.io/).

Config section: [black]

Basic options

--[no-]black-skip
PANTS_BLACK_SKIP
skip
default: False
Don't use Black when running `./pants fmt` and `./pants lint`

--black-args="[<shell_str>, <shell_str>, ...]"
PANTS_BLACK_ARGS
args
default: []
Arguments to pass directly to Black, e.g. `--black-args="--target-version=py37 --quiet"`

Advanced options

--black-version=<str>
PANTS_BLACK_VERSION
version
default: black==20.8b1
Requirement string for the tool.

--black-extra-requirements="['<str>', '<str>', ...]"
PANTS_BLACK_EXTRA_REQUIREMENTS
extra_requirements
default:
[
  "setuptools"
]

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.

--black-entry-point=<str>
PANTS_BLACK_ENTRY_POINT
entry_point
default: black:patched_main
The main module for the tool. If unspecified, the code using this tool must provide it explicitly on invocation, or it can use the tool as a library, invoked by a wrapper script.

--black-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_BLACK_INTERPRETER_CONSTRAINTS
interpreter_constraints
default:
[
  "CPython>=3.6"
]

Python interpreter constraints for this tool. An empty list uses the default interpreter constraints for the repo.

--black-config=<file_option>
PANTS_BLACK_CONFIG
config
default: None
Path to Black's pyproject.toml config file

Deprecated options

None

Updated about a month ago


black


Suggested Edits are limited on API Reference Pages

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