Skip to main content
Version: 2.15 (deprecated)

pyupgrade

Upgrade syntax for newer versions of the language (https://github.com/asottile/pyupgrade).

Backend: pants.backend.experimental.python.lint.pyupgrade

Config section: [pyupgrade]

Basic options​

args​

--pyupgrade-args="[<shell_str>, <shell_str>, ...]"
PANTS_PYUPGRADE_ARGS
pants.toml
[pyupgrade]
args = [
  <shell_str>,
  <shell_str>,
  ...,
]
default: []

Arguments to pass directly to pyupgrade, e.g. --pyupgrade-args='--py39-plus --keep-runtime-typing'.

skip​

--[no-]pyupgrade-skip
PANTS_PYUPGRADE_SKIP
pants.toml
[pyupgrade]
skip = <bool>
default: False

If true, don't use pyupgrade when running /home/josh/work/scie-pants/dist/pants fmt and /home/josh/work/scie-pants/dist/pants lint.

Advanced options​

console_script​

--pyupgrade-console-script=<str>
PANTS_PYUPGRADE_CONSOLE_SCRIPT
pants.toml
[pyupgrade]
console_script = <str>
default: pyupgrade

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​

--pyupgrade-entry-point=<str>
PANTS_PYUPGRADE_ENTRY_POINT
pants.toml
[pyupgrade]
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​

--pyupgrade-extra-requirements="['<str>', '<str>', ...]"
PANTS_PYUPGRADE_EXTRA_REQUIREMENTS
pants.toml
[pyupgrade]
extra_requirements = [
  '<str>',
  '<str>',
  ...,
]
default: []

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​

--pyupgrade-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_PYUPGRADE_INTERPRETER_CONSTRAINTS
pants.toml
[pyupgrade]
interpreter_constraints = [
  '<str>',
  '<str>',
  ...,
]
default: 
[
  "CPython>=3.7,<4"
]

Python interpreter constraints for this tool.

lockfile​

--pyupgrade-lockfile=<str>
PANTS_PYUPGRADE_LOCKFILE
pants.toml
[pyupgrade]
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.15.2/src/python/pants/backend/python/lint/pyupgrade/pyupgrade.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 and supply-chain security.

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

Alternatively, you can set this option to the path to a custom lockfile using pip's requirements.txt-style, ideally with --hash. Set [python].invalid_lockfile_behavior = 'ignore' so that Pants does not complain about missing lockfile headers.

version​

--pyupgrade-version=<str>
PANTS_PYUPGRADE_VERSION
pants.toml
[pyupgrade]
version = <str>
default: pyupgrade>=2.33.0,<2.35

Requirement string for the tool.

Deprecated options​

export​

--[no-]pyupgrade-export
PANTS_PYUPGRADE_EXPORT
pants.toml
[pyupgrade]
export = <bool>
default: True
Deprecated, will be removed in version: 2.23.0.dev0.
Use the export goal's --resolve option to select tools to export, instead of using this option to exempt a tool from export-by-default.

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

None