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 a TOML config file understood by Black (https://github.com/psf/black#configuration-format).

Setting this option will disable [black].config_discovery. Use this option if the config is located in a non-standard location.


config_discovery

--[no-]black-config-discovery
PANTS_BLACK_CONFIG_DISCOVERY
default: True

If true, Pants will include any relevant pyproject.toml config files during runs.

Use [black].config instead if your config is in a non-standard location.


Deprecated options

None


Did this page help you?