Skip to main content
Version: 2.13 (deprecated)

yapf

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

Backend: pants.core

Config section: [yapf]

Basic options​

args​

--yapf-args="[<shell_str>, <shell_str>, ...]"
PANTS_YAPF_ARGS
pants.toml
[yapf]
args = [
    <shell_str>,
    <shell_str>,
    ...,
]
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.

export​

--[no-]yapf-export
PANTS_YAPF_EXPORT
pants.toml
[yapf]
export = <bool>
default: True

If true, export a virtual environment with yapf 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.

skip​

--[no-]yapf-skip
PANTS_YAPF_SKIP
pants.toml
[yapf]
skip = <bool>
default: False

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

Advanced options​

config​

--yapf-config=<file_option>
PANTS_YAPF_CONFIG
pants.toml
[yapf]
config = <file_option>
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
pants.toml
[yapf]
config_discovery = <bool>
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.

console_script​

--yapf-console-script=<str>
PANTS_YAPF_CONSOLE_SCRIPT
pants.toml
[yapf]
console_script = <str>
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
pants.toml
[yapf]
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​

--yapf-extra-requirements="['<str>', '<str>', ...]"
PANTS_YAPF_EXTRA_REQUIREMENTS
pants.toml
[yapf]
extra_requirements = [
    '<str>',
    '<str>',
    ...,
]
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
pants.toml
[yapf]
interpreter_constraints = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "CPython>=3.7,<4"
]

Python interpreter constraints for this tool.

lockfile​

--yapf-lockfile=<str>
PANTS_YAPF_LOCKFILE
pants.toml
[yapf]
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.13.1/src/python/pants/backend/python/lint/yapf/yapf.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.

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=yapf.

As explained at https://www.pantsbuild.org/v2.13/docs/python-third-party-dependencies, lockfile generation via generate-lockfiles does not always work and you may want to manually generate the lockfile. You will want to set [python].invalid_lockfile_behavior = 'ignore' so that Pants does not complain about missing lockfile headers.

version​

--yapf-version=<str>
PANTS_YAPF_VERSION
pants.toml
[yapf]
version = <str>
default: yapf==0.32.0

Requirement string for the tool.

Deprecated options​

None

None