A formatter for Python files (https://github.com/google/yapf).
Don't use yapf when running
./pants fmt and
Arguments to pass directly to yapf, e.g.
Certain arguments, specifically
--parallel, will be ignored because Pants takes care of finding all the relevant files and running the formatting in parallel.
If true, export a virtual environment with yapf when running
This can be useful, for example, with IDE integrations to point your editor to the tool's binary.
Requirement string for the tool.
--yapf-extra-requirements="['<str>', '<str>', ...]"
[ "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.
--yapf-interpreter-constraints="['<str>', '<str>', ...]"
[ "CPython>=3.7,<4" ]
Python interpreter constraints for this tool.
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
--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.1rc1/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
./pants generate-lockfiles --resolve=yapf.
As explained at 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.
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.
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.
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.
If true, Pants will include any relevant config files during runs (
[yapf].config instead if your config is in a non-standard location.
Updated 12 months ago