文章列表
1 分钟阅读

Ruff 安装与使用指南


系列:开发环境管理

第 9 / 10 篇

  1. nvm 安装和使用教程
  2. uv 安装和使用教程
  3. pip 源的设置和使用
  4. uv 进阶:脚本、工作区与工具链实战
  5. pyenv 安装与使用指南
  6. pnpm 安装与使用指南
  7. Poetry 与 uv 对比:Python 项目管理怎么选
  8. direnv 使用指南:按目录自动加载环境变量
  9. Ruff 安装与使用指南
  10. GitHub CLI 使用指南:从 issue 到 PR 的命令行工作流

Ruff 是现在 Python 生态里很值得默认安装的工具。它把很多 lint 规则和格式化能力放到一个二进制里,速度快,配置也不复杂。

安装

已有 uv 的项目:

Terminal window
uv add --dev ruff
uv run ruff check .

不使用 uv,也可以直接:

Terminal window
pip install ruff
ruff check .

uv 的工具模式也很适合偶尔运行:

Terminal window
uvx ruff check .

常用命令

Terminal window
ruff check .
ruff check . --fix
ruff format .
ruff check src tests

check 负责 lint,format 负责格式化。不要把它们混成一个概念。

配置

pyproject.toml

[tool.ruff]
line-length = 100
target-version = "py312"
[tool.ruff.lint]
select = ["E", "F", "I", "B"]
ignore = []

I 会处理 import 排序,B 来自 flake8-bugbear,能抓一些常见坑。

放进 CI

Terminal window
uv run ruff check .
uv run ruff format --check .

如果项目还没有完整测试,先把 lint 和格式检查加上也很划算。

常见问题

一上来不要开启所有规则。老项目会被刷屏,最后没人愿意修。建议先开基础规则,新代码保持干净,再慢慢收紧。

如果你还没统一 Python 环境,先看 uv 安装和使用教程pyenv 安装与使用指南

总结

Ruff 适合作为 Python 项目的默认质量工具。它不替代测试,但能快速挡住未使用变量、导入顺序、明显错误和格式漂移。更多规则参考 Ruff 官方文档