HomeDocs
DocsCommunityTestimonialsUsersGitHubTwitterBlogJobsTermsPrivacyCookies
TermsPrivacyCookies
Hey! These docs are for version 2.11, which is no longer officially supported. Click here for the latest version, 2.18!

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

skip

--[no-]pyupgrade-skip
PANTS_PYUPGRADE_SKIP
default: False

Don't use pyupgrade when running ./pants fmt and ./pants lint.


args

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

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


Advanced options

version

--pyupgrade-version=<str>
PANTS_PYUPGRADE_VERSION
default: pyupgrade>=2.31.0,<2.32

Requirement string for the tool.


extra_requirements

--pyupgrade-extra-requirements="['<str>', '<str>', ...]"
PANTS_PYUPGRADE_EXTRA_REQUIREMENTS
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
default:
[
  "CPython>=3.7,<4"
]

Python interpreter constraints for this tool.


lockfile

--pyupgrade-lockfile=<str>
PANTS_PYUPGRADE_LOCKFILE
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.11.1/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.

To use a custom lockfile, set this option to a file path relative to the build root, then run ./pants generate-lockfiles --resolve=pyupgrade.

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.


console_script

--pyupgrade-console-script=<str>
PANTS_PYUPGRADE_CONSOLE_SCRIPT
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
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.


Deprecated options

None