Skip to main content
Version: 2.4 (deprecated)

black

The Black Python code formatter (https://black.readthedocs.io/).

Backend: ``

Config section: [black]

Basic options​

args​

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

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

skip​

--[no-]black-skip
PANTS_BLACK_SKIP
pants.toml
[black]
skip = <bool>
default: False

Don't use Black when running /home/josh/work/scie-pants/dist/pants fmt and /home/josh/work/scie-pants/dist/pants lint

Advanced options​

config​

--black-config=<file_option>
PANTS_BLACK_CONFIG
pants.toml
[black]
config = <file_option>
default: None

Path to Black's pyproject.toml config file

console_script​

--black-console-script=<str>
PANTS_BLACK_CONSOLE_SCRIPT
pants.toml
[black]
console_script = <str>
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
pants.toml
[black]
entry_point = <str>
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.

extra_requirements​

--black-extra-requirements="['<str>', '<str>', ...]"
PANTS_BLACK_EXTRA_REQUIREMENTS
pants.toml
[black]
extra_requirements = [
    '<str>',
    '<str>',
    ...,
]
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
pants.toml
[black]
interpreter_constraints = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "CPython>=3.6"
]

Python interpreter constraints for this tool.

version​

--black-version=<str>
PANTS_BLACK_VERSION
pants.toml
[black]
version = <str>
default: black==20.8b1

Requirement string for the tool.

Deprecated options​

None

None