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 Black Python code formatter (https://black.readthedocs.io/).

Config section: [black]

Basic options

skip

--[no-]black-skip
PANTS_BLACK_SKIP
default: False

Don't use Black when running `./pants fmt` and `./pants lint`


args

--black-args="[<shell_str>, <shell_str>, ...]"
PANTS_BLACK_ARGS
default: []

Arguments to pass directly to Black, e.g. `--black-args="--target-version=py37 --quiet"`


Advanced options

version

--black-version=<str>
PANTS_BLACK_VERSION
default: black==20.8b1

Requirement string for the tool.


extra_requirements

--black-extra-requirements="['<str>', '<str>', ...]"
PANTS_BLACK_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.


interpreter_constraints

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

Python interpreter constraints for this tool.


console_script

--black-console-script=<str>
PANTS_BLACK_CONSOLE_SCRIPT
default: black

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

--black-entry-point=<str>
PANTS_BLACK_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

--black-config=<file_option>
PANTS_BLACK_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.