pyproject-fmt-pants-plugin

A Pantsbuild plugin for formatting pyproject.toml files with pyproject-fmt.

Installation

Add the plugin to pants.toml:

[GLOBAL]
plugins = ["pyproject-fmt-pants-plugin==<version>"]

Then run pyproject-fmt through the fmt and lint goals:

pants fmt ::    # rewrite every pyproject.toml in place
pants lint ::   # fail when a pyproject.toml is not formatted

How it works

pyproject-fmt is installed into its own Pants resolve from the bundled lockfile, independent of your project's resolves. The plugin registers one fmt integration, which Pants also runs in check-only mode for lint.

For each run Pants:

1. Selects the pyproject.toml files among the goal's inputs.
2. Includes the shared config file, if any (see below).
3. Runs pyproject-fmt once per file. pyproject-fmt stops after the first file it changes, so one process per file keeps every file in the batch formatted.

Configuration

pyproject-fmt layers its settings in this order, later entries winning:

1. [pyproject-fmt].args, passed on the command line.
2. A shared pyproject-fmt.toml file. Pants includes the one in the build root automatically; point [pyproject-fmt].config at a file elsewhere instead.
3. The [tool.pyproject-fmt] table of each pyproject.toml file, which pyproject-fmt reads itself.

So a pyproject-fmt.toml file is optional: repo-wide settings can live in pants.toml alone.

[pyproject-fmt]
# https://pyproject-fmt.readthedocs.io/en/latest/configuration.html#command-line-interface
args = ["--column-width=120", "--indent=2", "--keep-full-version"]

--config accepts only a standalone pyproject-fmt.toml: a pyproject.toml fails on its [project] table.

Supported versions

Pants loads plugins into its own interpreter, so the plugin requires the Python version Pants runs on.

Releases

Wheels are published to PyPI. Release notes live in the changelog and on the GitHub releases page.

Contributing, Bug Reports and Feature Requests

This plugin lives in the pants-plugin-depot repo. See its CONTRIBUTING.md, or open an issue.