Skip to main content
Version: 2.15 (deprecated)

add-trailing-comma

The add-trailing-comma Python code formatter (https://github.com/asottile/add-trailing-comma).

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

Config section: [add-trailing-comma]

Basic options​

args​

--add-trailing-comma-args="[<shell_str>, <shell_str>, ...]"
PANTS_ADD_TRAILING_COMMA_ARGS
pants.toml
[add-trailing-comma]
args = [
  <shell_str>,
  <shell_str>,
  ...,
]
default: []

Arguments to pass directly to add-trailing-comma, e.g. --add-trailing-comma-args='--py36-plus'.

skip​

--[no-]add-trailing-comma-skip
PANTS_ADD_TRAILING_COMMA_SKIP
pants.toml
[add-trailing-comma]
skip = <bool>
default: False

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

Advanced options​

console_script​

--add-trailing-comma-console-script=<str>
PANTS_ADD_TRAILING_COMMA_CONSOLE_SCRIPT
pants.toml
[add-trailing-comma]
console_script = <str>
default: add-trailing-comma

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​

--add-trailing-comma-entry-point=<str>
PANTS_ADD_TRAILING_COMMA_ENTRY_POINT
pants.toml
[add-trailing-comma]
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​

--add-trailing-comma-extra-requirements="['<str>', '<str>', ...]"
PANTS_ADD_TRAILING_COMMA_EXTRA_REQUIREMENTS
pants.toml
[add-trailing-comma]
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​

--add-trailing-comma-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_ADD_TRAILING_COMMA_INTERPRETER_CONSTRAINTS
pants.toml
[add-trailing-comma]
interpreter_constraints = [
  '<str>',
  '<str>',
  ...,
]
default: 
[
  "CPython>=3.7,<4"
]

Python interpreter constraints for this tool.

lockfile​

--add-trailing-comma-lockfile=<str>
PANTS_ADD_TRAILING_COMMA_LOCKFILE
pants.toml
[add-trailing-comma]
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/add_trailing_comma/add_trailing_comma.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=add-trailing-comma.

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​

--add-trailing-comma-version=<str>
PANTS_ADD_TRAILING_COMMA_VERSION
pants.toml
[add-trailing-comma]
version = <str>
default: add-trailing-comma==2.2.3

Requirement string for the tool.

Deprecated options​

export​

--[no-]add-trailing-comma-export
PANTS_ADD_TRAILING_COMMA_EXPORT
pants.toml
[add-trailing-comma]
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 add-trailing-comma 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