ruff
The Ruff Python formatter (https://github.com/charliermarsh/ruff).
Backend: pants.backend.experimental.python.lint.ruff
Config section: [ruff]
Basic options
args
--ruff-args="[<shell_str>, <shell_str>, ...]"
PANTS_RUFF_ARGS
[ruff]
args = [
<shell_str>,
<shell_str>,
...,
]
[]
Arguments to pass directly to Ruff, e.g. --ruff-args='--exclude=foo --ignore=E501'
.
skip
--[no-]ruff-skip
PANTS_RUFF_SKIP
[ruff]
skip = <bool>
False
If true, don't use Ruff when running pants fmt
and pants lint
.
Advanced options
config
--ruff-config=<file_option>
PANTS_RUFF_CONFIG
[ruff]
config = <file_option>
None
Path 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-discovery
PANTS_RUFF_CONFIG_DISCOVERY
[ruff]
config_discovery = <bool>
True
If 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.
console_script
--ruff-console-script=<str>
PANTS_RUFF_CONSOLE_SCRIPT
[ruff]
console_script = <str>
ruff
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
--ruff-entry-point=<str>
PANTS_RUFF_ENTRY_POINT
[ruff]
entry_point = <str>
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.
install_from_resolve
--ruff-install-from-resolve=<str>
PANTS_RUFF_INSTALL_FROM_RESOLVE
[ruff]
install_from_resolve = <str>
None
If 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.18/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.
interpreter_constraints
--ruff-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_RUFF_INTERPRETER_CONSTRAINTS
[ruff]
interpreter_constraints = [
'<str>',
'<str>',
...,
]
[ "CPython>=3.7,<4" ]
Python interpreter constraints for this tool.
requirements
--ruff-requirements="['<str>', '<str>', ...]"
PANTS_RUFF_REQUIREMENTS
[ruff]
requirements = [
'<str>',
'<str>',
...,
]
[]
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.
Deprecated options
None
Related subsystems
None