black
The Black Python code formatter (https://black.readthedocs.io/).
Config section: [black]
Basic options
False
Don't use Black when running ./pants fmt
and ./pants lint
[]
Arguments to pass directly to Black, e.g. --black-args="--target-version=py37 --quiet"
Advanced options
black==21.9b0
Requirement string for the tool.
extra_requirements
extra_requirements
--black-extra-requirements="['<str>', '<str>', ...]"
PANTS_BLACK_EXTRA_REQUIREMENTS
[]
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
interpreter_constraints
--black-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_BLACK_INTERPRETER_CONSTRAINTS
[ "CPython>=3.6.2" ]
Python interpreter constraints for this tool.
<default>
Path to a lockfile used for installing the tool.
Set to the string <default>
to use a lockfile provided by Pants, so long as you have not changed the --version
and --extra-requirements
options, and the tool's interpreter constraints are compatible with the default. Pants will error or warn if the lockfile is not compatible (controlled by [python].invalid_lockfile_behavior
). See https://github.com/pantsbuild/pants/blob/release_2.8.1rc2/src/python/pants/backend/python/lint/black/lockfile.txt for the default lockfile contents.
Set to the string <none>
to opt out of using a lockfile. We do not recommend this, though, as lockfiles are essential for reproducible builds.
To use a custom lockfile, set this option to a file path relative to the build root, then run ./pants generate-lockfiles --resolve=black
.
Lockfile generation currently does not wire up the [python-repos]
options. If lockfile generation fails, you can manually generate a lockfile, such as by using pip-compile or pip freeze
. Set this option to the path to your manually generated lockfile. When manually maintaining lockfiles, set [python].invalid_lockfile_behavior = 'ignore'
.
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.
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.
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.
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
Updated over 1 year ago