A formatter for Python files (https://github.com/google/yapf).

Config section: [yapf]

Basic options

skip

--[no-]yapf-skip
PANTS_YAPF_SKIP
default: False

Don't use yapf when running ./pants fmt and ./pants lint.


args

--yapf-args="[<shell_str>, <shell_str>, ...]"
PANTS_YAPF_ARGS
default: []

Arguments to pass directly to yapf, e.g. --yapf-args="--no-local-style".

Certain arguments, specifically --recursive, --in-place, and --parallel, will be ignored because Pants takes care of finding all the relevant files and running the formatting in parallel.


Advanced options

version

--yapf-version=<str>
PANTS_YAPF_VERSION
default: yapf==0.31.0

Requirement string for the tool.


extra_requirements

--yapf-extra-requirements="['<str>', '<str>', ...]"
PANTS_YAPF_EXTRA_REQUIREMENTS
default:
[
  "toml"
]

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

--yapf-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_YAPF_INTERPRETER_CONSTRAINTS
default:
[
  "CPython>=3.6"
]

Python interpreter constraints for this tool.


lockfile

--yapf-lockfile=<str>
PANTS_YAPF_LOCKFILE
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-setup].invalid_lockfile_behavior). See https://github.com/pantsbuild/pants/blob/release_2.8.0.dev2/src/python/pants/backend/python/lint/yapf/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=yapf.

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-setup].invalid_lockfile_behavior = 'ignore'.


console_script

--yapf-console-script=<str>
PANTS_YAPF_CONSOLE_SCRIPT
default: yapf

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

--yapf-entry-point=<str>
PANTS_YAPF_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

--yapf-config=<file_option>
PANTS_YAPF_CONFIG
default: None

Path to style file understood by yapf (https://github.com/google/yapf#formatting-style/).

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


config_discovery

--[no-]yapf-config-discovery
PANTS_YAPF_CONFIG_DISCOVERY
default: True

If true, Pants will include any relevant config files during runs (.style.yapf, pyproject.toml, and setup.cfg).

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


Deprecated options

None


Did this page help you?