ruff
The Ruff Python formatter (https://github.com/charliermarsh/ruff).
Backend: pants.backend.experimental.python.lint.ruff
Config section: [ruff]
Basic options
skip
--[no-]ruff-skipPANTS_RUFF_SKIPFalseIf true, don't use Ruff when running scie-pants-linux-x86_64 fmt and scie-pants-linux-x86_64 lint.
args
--ruff-args="[<shell_str>, <shell_str>, ...]"PANTS_RUFF_ARGS[]Arguments to pass directly to Ruff, e.g. --ruff-args='--exclude=foo --ignore=E501'.
Advanced options
install_from_resolve
--ruff-install-from-resolve=<str>PANTS_RUFF_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 ruff "tool lockfile" generated from the version and extra_requirements options. But note that this mechanism is deprecated.
requirements
--ruff-requirements="['<str>', '<str>', ...]"PANTS_RUFF_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
--ruff-interpreter-constraints="['<str>', '<str>', ...]"PANTS_RUFF_INTERPRETER_CONSTRAINTS["CPython>=3.7,<4"]Python interpreter constraints for this tool.
console_script
--ruff-console-script=<str>PANTS_RUFF_CONSOLE_SCRIPTruffThe 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
--ruff-entry-point=<str>PANTS_RUFF_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.
config
--ruff-config=<file_option>PANTS_RUFF_CONFIGNonePath to the pyproject.toml or ruff.toml file to use for configuration (https://github.com/charliermarsh/ruff#configuration).
Setting this option will disable [ruff].config_discovery. Use this option if the config is located in a non-standard location.
config_discovery
--[no-]ruff-config-discoveryPANTS_RUFF_CONFIG_DISCOVERYTrueIf true, Pants will include any relevant config files during runs (pyproject.toml, and ruff.toml).
Use [ruff].config instead if your config is in a non-standard location.
Deprecated options
version
--ruff-version=<str>PANTS_RUFF_VERSIONruff>=0.0.213,<1Requirement string for the tool.
extra_requirements
--ruff-extra-requirements="['<str>', '<str>', ...]"PANTS_RUFF_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
--ruff-lockfile=<str>PANTS_RUFF_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/ruff/ruff.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=ruff.
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-]ruff-exportPANTS_RUFF_EXPORTTrueIf true, export a virtual environment with Ruff 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.