Skip to main content
Version: 2.21 (deprecated)

fix

pants fix [args]

Autofix source code.

Backend: pants.core

Config section: [fix]

Basic options​

only​

--fix-only="['<str>', '<str>', ...]"
PANTS_FIX_ONLY
pants.toml
[fix]
only = [
    '<str>',
    '<str>',
    ...,
]
default: []

Only run these fixers and skip all others.

The fixer names are outputted at the final summary of running this goal, e.g. autoflake and pyupgrade. You can also run fix --only=fake to get a list of all activated fixers.

You can repeat this option, e.g. fix --only=autoflake --only=pyupgrade or fix --only=['autoflake', 'pyupgrade'].

skip_formatters​

--[no-]fix-skip-formatters
PANTS_FIX_SKIP_FORMATTERS
pants.toml
[fix]
skip_formatters = <bool>
default: False

If true, skip running all formatters.

FYI: when running pants fix fmt ::, there should be diminishing performance benefit to using this flag. Pants attempts to reuse the results from fmt when running fix where possible.

Advanced options​

batch_size​

--fix-batch-size=<int>
PANTS_FIX_BATCH_SIZE
pants.toml
[fix]
batch_size = <int>
default: 128

The target number of files to be included in each fixer batch.

Fixer processes are batched for a few reasons:

  1. to avoid OS argument length limits (in processes which don't support argument files)
  2. to support more stable cache keys than would be possible if all files were operated on in a single batch.
  3. to allow for parallelism in fixer processes which don't have internal parallelism, or -- if they do support internal parallelism -- to improve scheduling behavior when multiple processes are competing for cores and so internal parallelism cannot be used perfectly.

In order to improve cache hit rates (see 2.), batches are created at stable boundaries, and so this value is only a "target" batch size (rather than an exact value).

Deprecated options​

None