Hey! These docs are for version 2.0, which is no longer officially supported. Click here for the latest version, 2.7!

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. Usually, you will not want to change this from the default.

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

Python interpreter constraints for this tool.

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

Deprecated options

None


Did this page help you?