Ruff aims to be orders of magnitude faster than alternative tools while integrating more
functionality behind a single, common interface.
Ruff can be used to replace Flake8 (plus dozens of plugins),
Black, isort,
pydocstyle, pyupgrade,
autoflake, and more, all while executing tens or hundreds of
times faster than any individual tool.
Ruff is extremely actively developed and used in major open-source projects like:
Why is Ruff a gamechanger? Primarily because it is nearly 1000x faster. Literally. Not a typo. On
our largest module (dagster itself, 250k LOC) pylint takes about 2.5 minutes, parallelized across 4
cores on my M1. Running ruff against our entire codebase takes .4 seconds.
Ruff is ~150-200x faster than flake8 on my machine, scanning the whole repo takes ~0.2s instead of
~20s. This is an enormous quality of life improvement for local dev. It's fast enough that I added
it as an actual commit hook, which is terrific.
Just switched my first project to Ruff. Only one downside so far: it's so fast I couldn't believe
it was working till I intentionally introduced some errors.
uvx [email protected] check # Lint all files in the current directory.
uvx [email protected] format # Format all files in the current directory.
Or install Ruff with uv (recommended), pip, or pipx:
# With uv.
uv tool install ruff@latest # Install Ruff globally.
uv add --dev ruff # Or add Ruff to your project.
# With pip.
pip install ruff
# With pipx.
pipx install ruff
Starting with version 0.5.0, Ruff can be installed with our standalone installers:
# On macOS and Linux.
curl -LsSf https://astral.sh/ruff/install.sh | sh
# On Windows.
powershell -c "irm https://astral.sh/ruff/install.ps1 | iex"
# For a specific version.
curl -LsSf https://astral.sh/ruff/0.16.6/install.sh | sh
powershell -c "irm https://astral.sh/ruff/0.16.6/install.ps1 | iex"
To run Ruff as a linter, try any of the following:
ruff check # Lint all files in the current directory (and any subdirectories).
ruff check path/to/code/ # Lint all files in `/path/to/code` (and any subdirectories).
ruff check path/to/code/*.py # Lint all `.py` files in `/path/to/code`.
ruff check path/to/code/to/file.py # Lint `file.py`.
ruff check @arguments.txt # Lint using an input file, treating its contents as newline-delimited command-line arguments.
Or, to run Ruff as a formatter:
ruff format # Format all files in the current directory (and any subdirectories).
ruff format path/to/code/ # Format all files in `/path/to/code` (and any subdirectories).
ruff format path/to/code/*.py # Format all `.py` files in `/path/to/code`.
ruff format path/to/code/to/file.py # Format `file.py`.
ruff format @arguments.txt # Format using an input file, treating its contents as newline-delimited command-line arguments.
Ruff can be configured through a pyproject.toml, ruff.toml, or .ruff.toml file (see:
Configuration, or Settings
for a complete list of all configuration options).
For the complete list of enabled rules, see Default Rules.
If left unspecified, Ruff's default configuration is equivalent to the following ruff.toml file:
# Exclude a variety of commonly ignored directories.
exclude = [
".bzr",
".direnv",
".eggs",
".git",
".git-rewrite",
".hg",
".ipynb_checkpoints",
".mypy_cache",
".nox",
".pants.d",
".pyenv",
".pytest_cache",
".pytype",
".ruff_cache",
".svn",
".tox",
".venv",
".vscode",
"__pypackages__",
"_build",
"buck-out",
"build",
"dist",
"node_modules",
"site-packages",
"venv",
]
# Same as Black.
line-length = 88
indent-width = 4
# Assume Python 3.10
target-version = "py310"
[lint]
# select = [...] # See the Default Rules page for the full listing.
ignore = []
# Allow fix for all enabled rules (when `--fix`) is provided.
fixable = ["ALL"]
unfixable = []
# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
[format]
# Like Black, use double quotes for strings.
quote-style = "double"
# Like Black, indent with spaces, rather than tabs.
indent-style = "space"
# Like Black, respect magic trailing commas.
skip-magic-trailing-comma = false
# Like Black, automatically detect the appropriate line ending.
line-ending = "auto"
Note that, in a pyproject.toml, each section header should be prefixed with tool.ruff. For
example, [lint] should be replaced with [tool.ruff.lint].
Some configuration options can be provided via dedicated command-line arguments, such as those
related to rule enablement and disablement, file discovery, and logging level:
ruff check --select F401 --select F403 --quiet
The remaining configuration options can be provided through a catch-all --config argument:
To opt in to the latest lint rules, formatter style changes, interface updates, and more, enable
preview mode by setting preview = true in your configuration
file or passing --preview on the command line. Preview mode enables a collection of unstable
features that may change prior to stabilization.
See ruff help for more on Ruff's top-level commands, or ruff help check and ruff help format
for more on the linting and formatting commands, respectively.
Rules
Ruff supports over 900 lint rules, many of which are inspired by popular tools like Flake8,
isort, pyupgrade, and others. Regardless of the rule's origin, Ruff re-implements every rule in
Rust as a first-party feature.
By default, Ruff enables rules from the F, E, B, UP, and RUF categories,
as well as many more, omitting any stylistic rules that overlap with the use of a formatter, like
ruff format or Black.
If you're just getting started with Ruff, the default rule set is a great place to start: it
catches a wide variety of common errors (like unused imports) with zero configuration. See
Default Rules for the complete list.
Beyond the defaults, Ruff re-implements some of the most popular Flake8 plugins and related code
quality tools, including:
In some cases, Ruff includes a "direct" Rust port of the corresponding tool.
We're grateful to the maintainers of these tools for their work, and for all
the value they've provided to the Python community.
Ruff's formatter is built on a fork of Rome's rome_formatter,
and again draws on both API and implementation details from Rome,
Prettier, and Black.
Ruff's import resolver is based on the import resolution algorithm from Pyright.
Ruff is also influenced by a number of tools outside the Python ecosystem, like
Clippy and ESLint.
Ruff is the beneficiary of a large number of contributors.
Ruff is released under the MIT license.
Who's Using Ruff?
Ruff is used by a number of major open-source projects and companies, including:
Что это такое?Ruff — чрезвычайно быстрый линтер и форматировщик кода для Python, написанный на Rust. Он призван заменить такие инструменты, как Flake8, Black, isort, pydocstyle, pyupgrade и autoflake, одной утилитой командной строки.
Это линтер, форматировщик или и то, и другое?И то, и другое в одном исполняемом файле: он проверяет код с помощью более чем 900 встроенных правил и также форматирует его, поэтому может сразу заменить Flake8 (вместе с его плагинами), Black и isort.
Как его установить и запустить на моём коде?Установите его через `uvx ruff`, `pip install ruff`, `pipx`, `uv`, Homebrew, Conda или автономный установщик, затем запустите `ruff check` для проверки кода или `ruff format` для форматирования ваших файлов.
Нужно ли отдельно настраивать Python, чтобы его запустить?Отдельная среда выполнения не нужна: Ruff поставляется как один скомпилированный бинарный файл на Rust, а pip, pipx и uv — это просто удобные способы его распространять и установить.
Всё ли стабильно или некоторые функции экспериментальные?Набор правил по умолчанию стабилен, но режим предварительной версии (`preview = true` или `--preview`) включает новые правила линтера и изменения форматировщика, которые могут ещё измениться до окончательного выпуска.
Кто на самом деле использует Ruff в продакшене?Его используют крупные open-source проекты и компании, включая Apache Airflow, FastAPI, Hugging Face, Pandas, SciPy, Dagster и Python SDK от Anthropic.
Есть ли какие-то подводные камни с лицензией?Никаких подводных камней нет — Ruff распространяется по разрешительной лицензии MIT.
Почему Ruff работает намного быстрее других линтеров для Python?Он написан на Rust и заново реализует каждое правило нативно, а не оборачивает существующие инструменты на Python. Поэтому пользователи сообщают, что он работает в 10–100 раз (иногда на порядки) быстрее Flake8 или Black.
Сколько правил линтинга он реально поддерживает?Ruff содержит более 900 встроенных правил, включая нативные реализации популярных плагинов Flake8, таких как flake8-bugbear, isort, pyupgrade и pydocstyle.
Как настроить, какие правила применять?Настройки хранятся в pyproject.toml (в разделе [tool.ruff]), ruff.toml или .ruff.toml. Включение правил, поиск файлов и другие параметры также доступны как флаги командной строки.
Ruff — чрезвычайно быстрый линтер и форматировщик кода для Python, написанный на Rust. Он призван заменить такие инструменты, как Flake8, Black, isort, pydocstyle, pyupgrade и autoflake, одной утилитой командной строки.