SECTION · 01

关键指标一览

Stars 数

48,920

Forks 数

2,292

Watchers 数

48,920

Issue 数

2,083

主要语言

Rust

许可证

MIT

仓库所有者

astral-sh

创建时间

2022.08.09

更新时间

2026.07.29

主题标签

代码检查工具 pep8 python python3 ruff rust rustpython 静态分析静态代码分析代码风格指南代码风格指南

SECTION · 03

README 详细介绍

README 原文为英文,如需阅读完整中文内容,建议使用 浏览器翻译插件(如 Edge 浏览器自带翻译、Google 翻译扩展)进行整页翻译。

Ruff

![Ruff](https://github.com/astral-sh/ruff)
![image](https://pypi.python.org/pypi/ruff)
![image](https://github.com/astral-sh/ruff/blob/main/LICENSE)
![image](https://pypi.python.org/pypi/ruff)
![Actions status](https://github.com/astral-sh/ruff/actions)
![Discord](https://discord.com/invite/astral-sh)

Docs | Playground

An extremely fast Python linter and code formatter, written in Rust.

Shows a bar chart with benchmark results.

Linting the CPython codebase from scratch.

⚡️ 10-100x faster than existing linters (like Flake8) and formatters (like Black)
🐍 Installable via pip
🛠️ pyproject.toml support
🤝 Python 3.14 compatibility
⚖️ Drop-in parity with Flake8, isort, and Black
📦 Built-in caching, to avoid re-analyzing unchanged files
🔧 Fix support, for automatic error correction (e.g., automatically remove unused imports)
📏 Over 900 built-in rules, with native re-implementations

of popular Flake8 plugins, like flake8-bugbear

⌨️ First-party editor integrations for VS Code and more
🌎 Monorepo-friendly, with hierarchical and cascading configuration

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:

...and many more.

Ruff is backed by Astral, the creators of
uv and ty.

Read the [launch
post](https://astral.sh/blog/announcing-astral-the-company-behind-ruff), or the
original [project
announcement](https://notes.crmarsh.com/python-tooling-could-be-much-much-faster).

Testimonials

Sebastián Ramírez, creator
of FastAPI:

> Ruff is so fast that sometimes I add an intentional bug in the code just to confirm it's actually
> running and checking the code.

Nick Schrock, founder of Elementl,
co-creator of GraphQL:

> 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.

Bryan Van de Ven, co-creator
of Bokeh, original author
of Conda:

> 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.

Timothy Crosley,
creator of isort:

> 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.

Tim Abbott, lead developer of Zulip (also here):

> This is just ridiculously fast... ruff is amazing.

Getting Started

For more, see the documentation.

Installation

Ruff is available as <code class="ra0-md-code">ruff</code> on PyPI.

Invoke Ruff directly with <code class="ra0-md-code">uvx</code>:

uvx ruff check   # Lint all files in the current directory.
uvx ruff 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.0/install.sh | sh
powershell -c "irm https://astral.sh/ruff/0.16.0/install.ps1 | iex"

You can also install Ruff via Homebrew, Conda,
and with a variety of other package managers.

Usage

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 also be used as a pre-commit hook via <code class="ra0-md-code">ruff-pre-commit</code>:

- repo: https://github.com/astral-sh/ruff-pre-commit
  # Ruff version.
  rev: v0.16.0
  hooks:
    # Run the linter.
    - id: ruff-check
      args: [ --fix ]
    # Run the formatter.
    - id: ruff-format

Ruff can also be used as a VS Code extension or with various other editors.

Ruff can also be used as a GitHub Action via
<code class="ra0-md-code">ruff-action</code>:

name: Ruff
on: [ push, pull_request ]
jobs:
  ruff:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: astral-sh/ruff-action@v3

Configuration

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:

ruff check --config "lint.per-file-ignores = {'some_file.py' = ['F841']}"

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:

For a complete enumeration of the supported rules, see _Rules_.

Contributing

Contributions are welcome and highly appreciated. To get started, check out the
contributing guidelines.

You can also join us on Discord.

Support

Having trouble? Check out the existing issues on GitHub,
or feel free to open a new one.

You can also ask for help on Discord.

Acknowledgements

Ruff's linter draws on both the APIs and implementation details of many other
tools in the Python ecosystem, especially Flake8, Pyflakes,
pycodestyle, pydocstyle,
pyupgrade, and isort.

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 <code class="ra0-md-code">rome_formatter</code>,
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:

Albumentations
Amazon (AWS SAM)
Anki
Anthropic (Python SDK)
Apache Airflow
AstraZeneca (Magnus)
Babel
Benchling (Refac)
Bokeh
Capital One (datacompy)
CrowdCent (NumerBlox)
Cryptography (PyCA)
CERN (Indico)
DVC
Dagger
Dagster
Databricks (MLflow)
Dify
FastAPI
Godot
Gradio
Great Expectations
HTTPX
Hatch
Home Assistant
Hugging Face (Transformers,

Datasets,
Diffusers)

ONNX Runtime,
LightGBM)

Show Your Support

If you're using Ruff, consider adding the Ruff badge to your project's README.md:

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

...or README.rst:

.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
    :target: https://github.com/astral-sh/ruff
    :alt: Ruff

...or, as HTML:

<a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff" style="max-width:100%;"></a>

License

This repository is licensed under the MIT License

ruff – astral-sh

关键指标一览

主题标签

README 详细介绍

Ruff

Testimonials

Table of Contents

Getting Started

Installation

Usage

Configuration

Rules

Contributing

Support

Acknowledgements

Who's Using Ruff?

Show Your Support

License

返回GitHub项目列表

ruff – astral-sh

关键指标一览

主题标签

README 详细介绍

Ruff

Testimonials

Table of Contents

Getting Started

Installation

Usage

Configuration

Rules

Contributing

Support

Acknowledgements

Who's Using Ruff?

Show Your Support

License

其他开源项目推荐

返回GitHub项目列表