見る：。

.github/workflows/release.yaml

ベンチマーク

まず、CPythonのクローンを作成します。これは大規模で多様なPythonコードベースです。 これは、ベンチマークに適したターゲットになります。

git clone --branch 3.10 https://github.com/python/cpython.git resources/test/cpython

リリースビルドをベンチマークするには:

cargo build --release && hyperfine --ignore-failure --warmup 10 \
  "./target/release/ruff ./resources/test/cpython/ --no-cache" \
  "./target/release/ruff ./resources/test/cpython/"

Benchmark 1: ./target/release/ruff ./resources/test/cpython/ --no-cache
  Time (mean ± σ):     293.8 ms ±   3.2 ms    [User: 2384.6 ms, System: 90.3 ms]
  Range (min … max):   289.9 ms … 301.6 ms    10 runs

  Warning: Ignoring non-zero exit code.

Benchmark 2: ./target/release/ruff ./resources/test/cpython/
  Time (mean ± σ):      48.0 ms ±   3.1 ms    [User: 65.2 ms, System: 124.7 ms]
  Range (min … max):    45.0 ms …  66.7 ms    62 runs

  Warning: Ignoring non-zero exit code.

Summary
  './target/release/ruff ./resources/test/cpython/' ran
    6.12 ± 0.41 times faster than './target/release/ruff ./resources/test/cpython/ --no-cache'

エコシステムの既存のツールに対してベンチマークを行うには:

hyperfine --ignore-failure --warmup 5 \
  "./target/release/ruff ./resources/test/cpython/ --no-cache" \
  "pyflakes resources/test/cpython" \
  "autoflake --recursive --expand-star-imports --remove-all-unused-imports --remove-unused-variables --remove-duplicate-keys resources/test/cpython" \
  "pycodestyle resources/test/cpython" \
  "flake8 resources/test/cpython"

Benchmark 1: ./target/release/ruff ./resources/test/cpython/ --no-cache
  Time (mean ± σ):     294.3 ms ±   3.3 ms    [User: 2467.5 ms, System: 89.6 ms]
  Range (min … max):   291.1 ms … 302.8 ms    10 runs

  Warning: Ignoring non-zero exit code.

Benchmark 2: pyflakes resources/test/cpython
  Time (mean ± σ):     15.786 s ±  0.143 s    [User: 15.560 s, System: 0.214 s]
  Range (min … max):   15.640 s … 16.157 s    10 runs

  Warning: Ignoring non-zero exit code.

Benchmark 3: autoflake --recursive --expand-star-imports --remove-all-unused-imports --remove-unused-variables --remove-duplicate-keys resources/test/cpython
  Time (mean ± σ):      6.175 s ±  0.169 s    [User: 54.102 s, System: 1.057 s]
  Range (min … max):    5.950 s …  6.391 s    10 runs

Benchmark 4: pycodestyle resources/test/cpython
  Time (mean ± σ):     46.921 s ±  0.508 s    [User: 46.699 s, System: 0.202 s]
  Range (min … max):   46.171 s … 47.863 s    10 runs

  Warning: Ignoring non-zero exit code.

Benchmark 5: flake8 resources/test/cpython
  Time (mean ± σ):     12.260 s ±  0.321 s    [User: 102.934 s, System: 1.230 s]
  Range (min … max):   11.848 s … 12.933 s    10 runs

  Warning: Ignoring non-zero exit code.

Summary
  './target/release/ruff ./resources/test/cpython/ --no-cache' ran
   20.98 ± 0.62 times faster than 'autoflake --recursive --expand-star-imports --remove-all-unused-imports --remove-unused-variables --remove-duplicate-keys resources/test/cpython'
   41.66 ± 1.18 times faster than 'flake8 resources/test/cpython'
   53.64 ± 0.77 times faster than 'pyflakes resources/test/cpython'
  159.43 ± 2.48 times faster than 'pycodestyle resources/test/cpython'

上記から作業環境を作成するように実行することができます。すべての 報告されたベンチマークは、Python 3.11で指定されたバージョンを使用して計算されました。

poetry install

./scripts

./scripts/pyproject.toml

Pylint のベンチマークを行うには、CPython リポジトリから以下のファイルを削除します。

rm Lib/test/bad_coding.py \
  Lib/test/bad_coding2.py \
  Lib/test/bad_getattr.py \
  Lib/test/bad_getattr2.py \
  Lib/test/bad_getattr3.py \
  Lib/test/badcert.pem \
  Lib/test/badkey.pem \
  Lib/test/badsyntax_3131.py \
  Lib/test/badsyntax_future10.py \
  Lib/test/badsyntax_future3.py \
  Lib/test/badsyntax_future4.py \
  Lib/test/badsyntax_future5.py \
  Lib/test/badsyntax_future6.py \
  Lib/test/badsyntax_future7.py \
  Lib/test/badsyntax_future8.py \
  Lib/test/badsyntax_future9.py \
  Lib/test/badsyntax_pep3120.py \
  Lib/test/test_asyncio/test_runners.py \
  Lib/test/test_copy.py \
  Lib/test/test_inspect.py \
  Lib/test/test_typing.py

次に、から、次のコマンドを実行します。これ Pylintを最大の並列処理で実行し、エラーのみを報告します。

resources/test/cpython

time pylint -j 0 -E $(git ls-files '*.py')

Pyupgrade のベンチマークを行うには、以下を次から実行します。

resources/test/cpython

hyperfine --ignore-failure --warmup 5 --prepare "git reset --hard HEAD" \
  "find . -type f -name \"*.py\" | xargs -P 0 pyupgrade --py311-plus"

Benchmark 1: find . -type f -name "*.py" | xargs -P 0 pyupgrade --py311-plus
  Time (mean ± σ):     30.119 s ±  0.195 s    [User: 28.638 s, System: 0.390 s]
  Range (min … max):   29.813 s … 30.356 s    10 runs

参考

トップレベル

allowed-confusables

次の場合に無視できる「紛らわしい」Unicode文字のリスト 、、および を強制します。

RUF001

RUF002

RUF003

デフォルト値:

[]

タイプ:

Vec<char>

使用例:

[tool.ruff]
# Allow minus-sign (U+2212), greek-small-letter-rho (U+03C1), and the asterisk-operator (U+2217),
# which could be confused for "-", "p", and "*", respectively.
allowed-confusables = ["−", "ρ", "∗"]

builtins

定義された参照として扱う組み込みのリストに加えて、 システムビルトイン。

デフォルト値:

[]

タイプ:

Vec<String>

使用例:

[tool.ruff]
builtins = ["_"]

cache-dir

A path to the cache directory.

By default, Ruff stores cache results in a directory in the current project root.

.ruff_cache

However, Ruff will also respect the environment variable, which takes precedence over that default.

RUFF_CACHE_DIR

This setting will override even the environment variable, if set.

RUFF_CACHE_DIR

Default value:

.ruff_cache

Type:

PathBuf

Example usage:

[tool.ruff]
cache-dir = "~/.cache/ruff"

dummy-variable-rgx

A regular expression used to identify "dummy" variables, or those which should be ignored when enforcing (e.g.) unused-variable rules. The default expression matches , , and , but not .

_

__

_var

_var_

Default value:

"^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"

Type:

Regex

Example usage:

[tool.ruff]
# Only ignore variables named "_".
dummy-variable-rgx = "^_$"

exclude

A list of file patterns to exclude from linting.

Exclusions are based on globs, and can be either:

• Single-path patterns, like (to exclude any directory named in the tree), (to exclude any file named ), or (to exclude any file matching ).

  .mypy_cache

  .mypy_cache

  foo.py

  foo.py

  foo_*.py

  foo_*.py

• Relative patterns, like (to exclude that specific file) or (to exclude any Python files in ). Note that these paths are relative to the project root (e.g., the directory containing your ).

  directory/foo.py

  directory/*.py

  directory

  pyproject.toml

For more information on the glob syntax, refer to the

globset

Note that you'll typically want to use

extend-exclude

Default value:

[".bzr", ".direnv", ".eggs", ".git", ".hg", ".mypy_cache", ".nox", ".pants.d", ".ruff_cache", ".svn", ".tox", ".venv", "__pypackages__", "_build", "buck-out", "build", "dist", "node_modules", "venv"]

Type:

Vec<FilePattern>

Example usage:

[tool.ruff]
exclude = [".venv"]

extend

A path to a local file to merge into this configuration. User home directory and environment variables will be expanded.

pyproject.toml

To resolve the current file, Ruff will first resolve this base configuration file, then merge in any properties defined in the current configuration file.

pyproject.toml

Default value:

None

Type:

Path

Example usage:

[tool.ruff]
# Extend the `pyproject.toml` file in the parent directory.
extend = "../pyproject.toml"
# But use a different line length.
line-length = 100

extend-exclude

A list of file patterns to omit from linting, in addition to those specified by .

exclude

Exclusions are based on globs, and can be either:

• Single-path patterns, like (to exclude any directory named in the tree), (to exclude any file named ), or (to exclude any file matching ).

  .mypy_cache

  .mypy_cache

  foo.py

  foo.py

  foo_*.py

  foo_*.py

• Relative patterns, like (to exclude that specific file) or (to exclude any Python files in ). Note that these paths are relative to the project root (e.g., the directory containing your ).

  directory/foo.py

  directory/*.py

  directory

  pyproject.toml

For more information on the glob syntax, refer to the

globset

Default value:

[]

Type:

Vec<FilePattern>

Example usage:

[tool.ruff]
# In addition to the standard set of exclusions, omit all tests, plus a specific file.
extend-exclude = ["tests", "src/bad.py"]

extend-ignore

A list of rule codes or prefixes to ignore, in addition to those specified by .

ignore

Note that is applied after resolving rules from / and a less specific rule in would overwrite a more specific rule in . It is recommended to only use when extending a file via .

extend-ignore

ignore

select

extend-ignore

select

extend-ignore

pyproject.toml

extend

Default value:

[]

Type:

Vec<RuleSelector>

Example usage:

[tool.ruff]
# Skip unused variable rules (`F841`).
extend-ignore = ["F841"]

extend-select

A list of rule codes or prefixes to enable, in addition to those specified by .

select

Note that is applied after resolving rules from / and a less specific rule in would overwrite a more specific rule in . It is recommended to only use when extending a file via .

extend-select

ignore

select

extend-select

ignore

extend-select

pyproject.toml

extend

Default value:

[]

Type:

Vec<RuleSelector>

Example usage:

[tool.ruff]
# On top of the default `select` (`E`, `F`), enable flake8-bugbear (`B`) and flake8-quotes (`Q`).
extend-select = ["B", "Q"]

external

A list of rule codes that are unsupported by Ruff, but should be preserved when (e.g.) validating directives. Useful for retaining directives that cover plugins not yet implemented by Ruff.

# noqa

# noqa

Default value:

[]

Type:

Vec<String>

Example usage:

[tool.ruff]
# Avoiding flagging (and removing) `V101` from any `# noqa`
# directives, despite Ruff's lack of support for `vulture`.
external = ["V101"]

fix

Enable autofix behavior by-default when running (overridden by the and command-line flags).

ruff

--fix

--no-fix

Default value:

false

Type:

bool

Example usage:

[tool.ruff]
fix = true

fix-only

Like , but disables reporting on leftover violation. Implies .

fix

fix

Default value:

false

Type:

bool

Example usage:

[tool.ruff]
fix-only = true

fixable

A list of rule codes or prefixes to consider autofixable. By default, all rules are considered autofixable.

Default value:

["A", "ANN", "ARG", "B", "BLE", "C", "COM", "D", "DTZ", "E", "EM", "ERA", "EXE", "F", "FBT", "G", "I", "ICN", "INP", "ISC", "N", "PD", "PGH", "PIE", "PL", "PT", "PTH", "Q", "RET", "RUF", "S", "SIM", "T", "TCH", "TID", "TRY", "UP", "W", "YTT"]

Type:

Vec<RuleSelector>

Example usage:

[tool.ruff]
# Only allow autofix behavior for `E` and `F` rules.
fixable = ["E", "F"]

force-exclude

Whether to enforce and patterns, even for paths that are passed to Ruff explicitly. Typically, Ruff will lint any paths passed in directly, even if they would typically be excluded. Setting will cause Ruff to respect these exclusions unequivocally.

exclude

extend-exclude

force-exclude = true

This is useful for

pre-commit

ruff-pre-commit

Default value:

false

Type:

bool

Example usage:

[tool.ruff]
force-exclude = true

format

The style in which violation messages should be formatted: (default), (group messages by file), (machine-readable), (machine-readable XML), (GitHub Actions annotations), (GitLab CI code quality report), or (Pylint text format).

"text"

"grouped"

"json"

"junit"

"github"

"gitlab"

"pylint"

Default value:

"text"

Type:

SerializationType

Example usage:

[tool.ruff]
# Group violations by containing file.
format = "grouped"

ignore

A list of rule codes or prefixes to ignore. Prefixes can specify exact rules (like ), entire categories (like ), or anything in between.

F841

F

When breaking ties between enabled and disabled rules (via and , respectively), more specific prefixes override less specific prefixes.

select

ignore

Default value:

[]

Type:

Vec<RuleSelector>

Example usage:

[tool.ruff]
# Skip unused variable rules (`F841`).
ignore = ["F841"]

ignore-init-module-imports

Avoid automatically removing unused imports in files. Such imports will still be flagged, but with a dedicated message suggesting that the import is either added to the module's symbol, or re-exported with a redundant alias (e.g., ).

__init__.py

__all__

import os as os

Default value:

false

Type:

bool

Example usage:

[tool.ruff]
ignore-init-module-imports = true

line-length

The line length to use when enforcing long-lines violations (like ).

E501

Default value:

88

Type:

usize

Example usage:

[tool.ruff]
# Allow lines to be as long as 120 characters.
line-length = 120

namespace-packages

Mark the specified directories as namespace packages. For the purpose of module resolution, Ruff will treat those directories as if they contained an file.

__init__.py

Default value:

[]

Type:

Vec<PathBuf>

Example usage:

[tool.ruff]
namespace-packages = ["airflow/providers"]

per-file-ignores

A list of mappings from file pattern to rule codes or prefixes to exclude, when considering any matching files.

Default value:

{}

Type:

HashMap<String, Vec<RuleSelector>>

Example usage:

[tool.ruff]
# Ignore `E402` (import violations) in all `__init__.py` files, and in `path/to/file.py`.
[tool.ruff.per-file-ignores]
"__init__.py" = ["E402"]
"path/to/file.py" = ["E402"]

required-version

Require a specific version of Ruff to be running (useful for unifying results across many environments, e.g., with a file).

pyproject.toml

Default value:

None

Type:

String

Example usage:

[tool.ruff]
required-version = "0.0.193"

respect-gitignore

Whether to automatically exclude files that are ignored by , , , and global files. Enabled by default.

.ignore

.gitignore

.git/info/exclude

gitignore

Default value:

true

Type:

bool

Example usage:

[tool.ruff]
respect-gitignore = false

select

A list of rule codes or prefixes to enable. Prefixes can specify exact rules (like ), entire categories (like ), or anything in between.

F841

F

When breaking ties between enabled and disabled rules (via and , respectively), more specific prefixes override less specific prefixes.

select

ignore

Default value:

["E", "F"]

Type:

Vec<RuleSelector>

Example usage:

[tool.ruff]
# On top of the defaults (`E`, `F`), enable flake8-bugbear (`B`) and flake8-quotes (`Q`).
select = ["E", "F", "B", "Q"]

show-source

Whether to show source code snippets when reporting lint violations (overridden by the command-line flag).

--show-source

Default value:

false

Type:

bool

Example usage:

[tool.ruff]
# By default, always show source code snippets.
show-source = true

src

The source code paths to consider, e.g., when resolving first- vs. third-party imports.

As an example: given a Python package structure like:

my_package/
  pyproject.toml
  src/
    my_package/
      __init__.py
      foo.py
      bar.py

The 
src
 directory should be included in the 
src
 option (e.g., 
src = ["src"]
), such that when resolving imports, 
my_package.foo
 is
considered a first-party import.

This field supports globs. For example, if you have a series of Python
packages in a 
python_modules
 directory, 
src = ["python_modules/*"]
 would expand to incorporate all of the
packages in that directory. User home directory and environment
variables will also be expanded.

Default value: 
["."]

Type: 
Vec<PathBuf>

Example usage:
[tool.ruff]
# Allow imports relative to the "src" and "test" directories.
src = ["src", "test"]

target-version
The Python version to target, e.g., when considering automatic code
upgrades, like rewriting type annotations. Note that the target
version will not be inferred from the current Python version,
and instead must be specified explicitly (as seen below).
Default value: 
"py310"

Type: 
PythonVersion

Example usage:
[tool.ruff]
# Always generate Python 3.7-compatible code.
target-version = "py37"

task-tags
A list of task tags to recognize (e.g., "TODO", "FIXME", "XXX").
Comments starting with these tags will be ignored by commented-out code
detection (
ERA
), and skipped by line-length rules (
E501
) if
ignore-overlong-task-comments
 is set to 
true
.

Default value: 
["TODO", "FIXME", "XXX"]

Type: 
Vec<String>

Example usage:
[tool.ruff]
task-tags = ["HACK"]

typing-modules
A list of modules whose imports should be treated equivalently to
members of the 
typing
 module.

This is useful for ensuring proper type annotation inference for
projects that re-export 
typing
 and 
typing_extensions
 members
from a compatibility module. If omitted, any members imported from
modules apart from 
typing
 and 
typing_extensions
 will be treated
as ordinary Python objects.

Default value: 
[]

Type: 
Vec<String>

Example usage:
[tool.ruff]
typing-modules = ["airflow.typing_compat"]

unfixable
A list of rule codes or prefixes to consider non-autofix-able.
Default value: 
[]

Type: 
Vec<RuleSelector>

Example usage:
[tool.ruff]
# Disable autofix for unused imports (`F401`).
unfixable = ["F401"]

update-check
Enable or disable automatic update checks (overridden by the
--update-check
 and 
--no-update-check
 command-line flags).

Default value: 
false

Type: 
bool

Example usage:
[tool.ruff]
update-check = true

flake8-annotations
allow-star-arg-any
Whether to suppress 
ANN401
 for dynamically typed 
*args
 and
**kwargs
 arguments.

Default value: 
false

Type: 
bool

Example usage:
[tool.ruff.flake8-annotations]
allow-star-arg-any = true

mypy-init-return
Whether to allow the omission of a return type hint for 
__init__
 if at
least one argument is annotated.

Default value: 
false

Type: 
bool

Example usage:
[tool.ruff.flake8-annotations]
mypy-init-return = true

suppress-dummy-args
Whether to suppress 
ANN000
-level violations for arguments matching the
"dummy" variable regex (like 
_
).

Default value: 
false

Type: 
bool

Example usage:
[tool.ruff.flake8-annotations]
suppress-dummy-args = true

suppress-none-returning
Whether to suppress 
ANN200
-level violations for functions that meet
either of the following criteria:

• Contain no

  return

  statement.
• Explicit

  return

  statement(s) all return

  None

  (explicitly or implicitly).

Default value:

false

Type:

bool

Example usage:

[tool.ruff.flake8-annotations]
suppress-none-returning = true

flake8-bandit

check-typed-exception

Whether to disallow

try

except

pass

S110

try

except

pass

Exception

BaseException

Default value:

false

Type:

bool

Example usage:

[tool.ruff.flake8-bandit]
check-typed-exception = true

hardcoded-tmp-directory

A list of directories to consider temporary.

Default value:

["/tmp", "/var/tmp", "/dev/shm"]

Type:

Vec<String>

Example usage:

[tool.ruff.flake8-bandit]
hardcoded-tmp-directory = ["/foo/bar"]

hardcoded-tmp-directory-extend

A list of directories to consider temporary, in addition to those specified by

hardcoded-tmp-directory

Default value:

[]

Type:

Vec<String>

Example usage:

[tool.ruff.flake8-bandit]
extend-hardcoded-tmp-directory = ["/foo/bar"]

flake8-bugbear

extend-immutable-calls

Additional callable functions to consider "immutable" when evaluating, e.g., the

no-mutable-default-argument

B006

Default value:

[]

Type:

Vec<String>

Example usage:

[tool.ruff.flake8-bugbear]
# Allow default arguments like, e.g., `data: List[str] = fastapi.Query(None)`.
extend-immutable-calls = ["fastapi.Depends", "fastapi.Query"]

flake8-builtins

builtins-ignorelist

Ignore list of builtins.

Default value:

[]

Type:

Vec<String>

Example usage:

[tool.ruff.flake8-builtins]
builtins-ignorelist = ["id"]

flake8-errmsg

max-string-length

Maximum string length for string literals in exception messages.

Default value:

0

Type:

usize

Example usage:

[tool.ruff.flake8-errmsg]
max-string-length = 20

flake8-implicit-str-concat

allow-multiline

Whether to allow implicit string concatenations for multiline strings. By default, implicit concatenations of multiline strings are allowed (but continuation lines, delimited with a backslash, are prohibited).

Default value:

true

Type:

bool

Example usage:

[tool.ruff.flake8-implicit-str-concat]
allow-multiline = false

flake8-import-conventions

aliases

The conventional aliases for imports. These aliases can be extended by the

extend_aliases

Default value:

{"altair": "alt", "matplotlib.pyplot": "plt", "numpy": "np", "pandas": "pd", "seaborn": "sns"}

Type:

FxHashMap<String, String>

Example usage:

[tool.ruff.flake8-import-conventions]
[tool.ruff.flake8-import-conventions.aliases]
# Declare the default aliases.
altair = "alt"
"matplotlib.pyplot" = "plt"
numpy = "np"
pandas = "pd"
seaborn = "sns"

extend-aliases

A mapping of modules to their conventional import aliases. These aliases will be added to the

aliases

Default value:

{}

Type:

FxHashMap<String, String>

Example usage:

[tool.ruff.flake8-import-conventions]
[tool.ruff.flake8-import-conventions.extend-aliases]
# Declare a custom alias for the `matplotlib` module.
"dask.dataframe" = "dd"

flake8-pytest-style

fixture-parentheses

Boolean flag specifying whether

@pytest.fixture()

true

@pytest.fixture()

@pytest.fixture

false

@pytest.fixture

@pytest.fixture()

Default value:

true

Type:

bool

Example usage:

[tool.ruff.flake8-pytest-style]
fixture-parentheses = true

mark-parentheses

Boolean flag specifying whether

@pytest.mark.foo()

true

@pytest.mark.foo()

@pytest.mark.foo

false

@pytest.fixture

@pytest.mark.foo()

Default value:

true

Type:

bool

Example usage:

[tool.ruff.flake8-pytest-style]
mark-parentheses = true

parametrize-names-type

Expected type for multiple argument names in

@pytest.mark.parametrize

• csv

  — a comma-separated list, e.g.

  @pytest.mark.parametrize('name1,name2', ...)

• tuple

  (default) — e.g.

  @pytest.mark.parametrize(('name1', 'name2'), ...)

• list

  — e.g.

  @pytest.mark.parametrize(['name1', 'name2'], ...)

Default value:

tuple

Type:

ParametrizeNameType

Example usage:

[tool.ruff.flake8-pytest-style]
parametrize-names-type = "list"

parametrize-values-row-type

Expected type for each row of values in

@pytest.mark.parametrize

• tuple

  (default) — e.g.

  @pytest.mark.parametrize(('name1', 'name2'), [(1, 2), (3, 4)])

• list

  — e.g.

  @pytest.mark.parametrize(('name1', 'name2'), [[1, 2], [3, 4]])

Default value:

tuple

Type:

ParametrizeValuesRowType

Example usage:

[tool.ruff.flake8-pytest-style]
parametrize-values-row-type = "list"

parametrize-values-type

Expected type for the list of values rows in

@pytest.mark.parametrize

• tuple

  — e.g.

  @pytest.mark.parametrize('name', (1, 2, 3))

• list

  (default) — e.g.

  @pytest.mark.parametrize('name', [1, 2, 3])

Default value:

list

Type:

ParametrizeValuesType

Example usage:

[tool.ruff.flake8-pytest-style]
parametrize-values-type = "tuple"

raises-extend-require-match-for

List of additional exception names that require a match= parameter in a

pytest.raises()

Default value:

[]

Type:

Vec<String>

Example usage:

[tool.ruff.flake8-pytest-style]
raises-extend-require-match-for = ["requests.RequestException"]

raises-require-match-for

List of exception names that require a match= parameter in a

pytest.raises()

Default value:

["BaseException", "Exception", "ValueError", "OSError", "IOError", "EnvironmentError", "socket.error"]

Type:

Vec<String>

Example usage:

[tool.ruff.flake8-pytest-style]
raises-require-match-for = ["requests.RequestException"]

flake8-quotes

avoid-escape

Whether to avoid using single quotes if a string contains single quotes, or vice-versa with double quotes, as per PEP8. This minimizes the need to escape quotation marks within strings.

Default value:

true

Type:

bool

Example usage:

[tool.ruff.flake8-quotes]
# Don't bother trying to avoid escapes.
avoid-escape = false

docstring-quotes

Quote style to prefer for docstrings (either "single" (

'

"

Default value:

"double"

Type:

Quote

Example usage:

[tool.ruff.flake8-quotes]
docstring-quotes = "single"

inline-quotes

Quote style to prefer for inline strings (either "single" (

'

"

Default value:

"double"

Type:

Quote

Example usage:

[tool.ruff.flake8-quotes]
inline-quotes = "single"

multiline-quotes

Quote style to prefer for multiline strings (either "single" (

'

"

Default value:

"double"

Type:

Quote

Example usage:

[tool.ruff.flake8-quotes]
multiline-quotes = "single"

flake8-tidy-imports

ban-relative-imports

Whether to ban all relative imports (

"all"

"parents"

Default value:

"parents"

Type:

Strictness

Example usage:

[tool.ruff.flake8-tidy-imports]
# Disallow all relative imports.
ban-relative-imports = "all"

banned-api

Specific modules or module members that may not be imported or accessed. Note that this rule is only meant to flag accidental uses, and can be circumvented via

eval

importlib

Default value:

{}

Type:

HashMap<String, BannedApi>

Example usage:

[tool.ruff.flake8-tidy-imports]
[tool.ruff.flake8-tidy-imports.banned-api]
"cgi".msg = "The cgi module is deprecated, see https://peps.python.org/pep-0594/#cgi."
"typing.TypedDict".msg = "Use typing_extensions.TypedDict instead."

flake8-type-checking

exempt-modules

Exempt certain modules from needing to be moved into type-checking blocks.

Default value:

["typing"]

Type:

Vec<String>

Example usage:

[tool.ruff.flake8-type-checking]
exempt-modules = ["typing", "typing_extensions"]

strict

Enforce TC001, TC002, and TC003 rules even when valid runtime imports are present for the same module. See: https://github.com/snok/flake8-type-checking#strict.

Default value:

false

Type:

bool

Example usage:

[tool.ruff.flake8-type-checking]
strict = true

flake8-unused-arguments

ignore-variadic-names

Whether to allow unused variadic arguments, like

*args

**kwargs

Default value:

false

Type:

bool

Example usage:

[tool.ruff.flake8-unused-arguments]
ignore-variadic-names = true

isort

classes

An override list of tokens to always recognize as a Class for

order-by-type

Default value:

[]

Type:

Vec<String>

Example usage:

[tool.ruff.isort]
classes = ["SVC"]

combine-as-imports

Combines as imports on the same line. See isort's

combine-as-imports

Default value:

false

Type:

bool

Example usage:

[tool.ruff.isort]
combine-as-imports = true

constants

An override list of tokens to always recognize as a CONSTANT for

order-by-type

Default value:

[]

Type:

Vec<String>

Example usage:

[tool.ruff.isort]
constants = ["constant"]

extra-standard-library

A list of modules to consider standard-library, in addition to those known to Ruff in advance.

Default value:

[]

Type:

Vec<String>

Example usage:

[tool.ruff.isort]
extra-standard-library = ["path"]

force-single-line

Forces all from imports to appear on their own line.

Default value:

false

Type:

bool

Example usage:

[tool.ruff.isort]
force-single-line = true

force-sort-within-sections

Don't sort straight-style imports (like

import sys

from itertools import groupby

Default value:

false

Type:

bool

Example usage:

[tool.ruff.isort]
force-sort-within-sections = true

force-wrap-aliases

Force

import from

import A as B

from .utils import (
    test_directory as test_directory,
    test_id as test_id
)

Note that this setting is only effective when combined with

combine-as-imports = true

combine-as-imports

import from

Default value:

false

Type:

bool

Example usage:

[tool.ruff.isort]
force-wrap-aliases = true
combine-as-imports = true

known-first-party

A list of modules to consider first-party, regardless of whether they can be identified as such via introspection of the local filesystem.

Default value:

[]

Type:

Vec<String>

Example usage:

[tool.ruff.isort]
known-first-party = ["src"]

known-third-party

A list of modules to consider third-party, regardless of whether they can be identified as such via introspection of the local filesystem.

Default value:

[]

Type:

Vec<String>

Example usage:

[tool.ruff.isort]
known-third-party = ["src"]

no-lines-before

A list of sections that should not be delineated from the previous section via empty lines.

Default value:

[]

Type:

Option<Vec<ImportType>>

Example usage:

[tool.ruff.isort]
no-lines-before = ["future", "standard-library"]

order-by-type

Order imports by type, which is determined by case, in addition to alphabetically.

Default value:

true

Type:

bool

Example usage:

[tool.ruff.isort]
order-by-type = true

relative-imports-order

Whether to place "closer" imports (fewer

.

.

The default ("furthest-to-closest") is equivalent to isort's

reverse-relative

reverse-relative = false

reverse-relative = true

Default value:

furthest-to-closest

Type:

RelatveImportsOrder

Example usage:

[tool.ruff.isort]
relative-imports-order = "closest-to-furthest"

required-imports

Add the specified import line to all files.

Default value:

[]

Type:

Vec<String>

Example usage:

[tool.ruff.isort]
required-imports = ["from __future__ import annotations"]

single-line-exclusions

One or more modules to exclude from the single line rule.

Default value:

[]

Type:

Vec<String>

Example usage:

[tool.ruff.isort]
single-line-exclusions = ["os", "json"]

split-on-trailing-comma

If a comma is placed after the last member in a multi-line import, then the imports will never be folded into one line.

See isort's

split-on-trailing-comma

Default value:

true

Type:

bool

Example usage:

[tool.ruff.isort]
split-on-trailing-comma = false

variables

An override list of tokens to always recognize as a var for

order-by-type

Default value:

[]

Type:

Vec<String>

Example usage:

[tool.ruff.isort]
variables = ["VAR"]

mccabe

max-complexity

The maximum McCabe complexity to allow before triggering

C901

Default value:

10

Type:

usize

Example usage:

[tool.ruff.mccabe]
# Flag errors (`C901`) whenever the complexity level exceeds 5.
max-complexity = 5