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
skip
--[no-]add-trailing-comma-skipPANTS_ADD_TRAILING_COMMA_SKIPFalseIf true, don't use add-trailing-comma when running scie-pants-linux-x86_64 fmt and scie-pants-linux-x86_64 lint.
args
--add-trailing-comma-args="[<shell_str>, <shell_str>, ...]"PANTS_ADD_TRAILING_COMMA_ARGS[]Arguments to pass directly to add-trailing-comma, e.g. --add-trailing-comma-args='--py36-plus'.
Advanced options
install_from_resolve
--add-trailing-comma-install-from-resolve=<str>PANTS_ADD_TRAILING_COMMA_INSTALL_FROM_RESOLVENoneIf specified, install the tool using the lockfile for this named resolve.
This resolve must be defined in [python].resolves, as described in https://www.pantsbuild.org/v2.17/docs/python-third-party-dependencies#user-lockfiles.
The resolve's entire lockfile will be installed, unless specific requirements are listed via the requirements option, in which case only those requirements will be installed. This is useful if you don't want to invalidate the tool's outputs when the resolve incurs changes to unrelated requirements.
If unspecified, and the lockfile option is unset, the tool will be installed using the default lockfile shipped with Pants.
If unspecified, and the lockfile option is set, the tool will use the custom add-trailing-comma "tool lockfile" generated from the version and extra_requirements options. But note that this mechanism is deprecated.
requirements
--add-trailing-comma-requirements="['<str>', '<str>', ...]"PANTS_ADD_TRAILING_COMMA_REQUIREMENTS[]If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile.
Values can be pip-style requirements (e.g., tool or tool==1.2.3 or tool>=1.2.3), or addresses of python_requirement targets (or targets that generate or depend on python_requirement targets).
The lockfile will be validated against the requirements - if a lockfile doesn't provide the requirement (at a suitable version, if the requirement specifies version constraints) Pants will error.
If unspecified, install the entire lockfile.
interpreter_constraints
--add-trailing-comma-interpreter-constraints="['<str>', '<str>', ...]"PANTS_ADD_TRAILING_COMMA_INTERPRETER_CONSTRAINTS["CPython>=3.7,<4"]Python interpreter constraints for this tool.
console_script
--add-trailing-comma-console-script=<str>PANTS_ADD_TRAILING_COMMA_CONSOLE_SCRIPTadd-trailing-commaThe 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_POINTNoneThe 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
version
--add-trailing-comma-version=<str>PANTS_ADD_TRAILING_COMMA_VERSIONadd-trailing-comma>=2.2.3,<3Requirement string for the tool.
extra_requirements
--add-trailing-comma-extra-requirements="['<str>', '<str>', ...]"PANTS_ADD_TRAILING_COMMA_EXTRA_REQUIREMENTS[]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.
lockfile
--add-trailing-comma-lockfile=<str>PANTS_ADD_TRAILING_COMMA_LOCKFILE<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.17.1rc3/src/python/pants/backend/python/lint/add_trailing_comma/add_trailing_comma.lock for the default lockfile contents.
To use a custom lockfile, set this option to a file path relative to the build root, then run scie-pants-linux-x86_64 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.
export
--[no-]add-trailing-comma-exportPANTS_ADD_TRAILING_COMMA_EXPORTTrueIf true, export a virtual environment with add-trailing-comma when running scie-pants-linux-x86_64 export.
This can be useful, for example, with IDE integrations to point your editor to the tool's binary.