black

---

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

Backend: pants.core

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

If true, 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 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

pants.toml

[black]
config_discovery = <bool>

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.

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:

[
  "typing-extensions>=3.10.0.0; python_version < "3.10""
]

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.7,<4"
]

Python interpreter constraints for this tool.

lockfile

--black-lockfile=<str>
PANTS_BLACK_LOCKFILE

pants.toml

[black]
lockfile = <str>

default: <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.15.2/src/python/pants/backend/python/lint/black/black.lock 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 and supply-chain security.

To use a custom lockfile, set this option to a file path relative to the build root, then run /home/josh/work/scie-pants/dist/pants generate-lockfiles --resolve=black.

Alternatively, you can set this option to the path to a custom lockfile using pip's requirements.txt-style, ideally with --hash. Set [python].invalid_lockfile_behavior = 'ignore' so that Pants does not complain about missing lockfile headers.

version

--black-version=<str>
PANTS_BLACK_VERSION

pants.toml

[black]
version = <str>

default: black==22.6.0

Requirement string for the tool.

Deprecated options

export

--[no-]black-export
PANTS_BLACK_EXPORT

pants.toml

[black]
export = <bool>

default: True
Deprecated, will be removed in version: 2.23.0.dev0.
Use the export goal's --resolve option to select tools to export, instead of using this option to exempt a tool from export-by-default.

If true, export a virtual environment with Black when running /home/josh/work/scie-pants/dist/pants export.

This can be useful, for example, with IDE integrations to point your editor to the tool's binary.

Related subsystems

None