17370845950

ruff 如何配置才能同时替代 black + isort + flake8
Ruff 可原生替代 Black、isort、Flake8:只需在 pyproject.toml 中配置 [tool.ruff.format] 和 select = ["E", "F", "I", "UP"],启用 line-length = 88 并设 profile = "black" 即可实现格式化、导入排序与代码检查三合一。

用 Ruff 一键替代 Black、isort、Flake8 的最小可行配置

直接上答案:Ruff 原生支持三合一,无需额外工具。只要在 pyproject.toml 中启用 format + lint 两套配置,并选对规则集,就能完全取代 blackisortflake8 —— 不是“模拟”,而是功能覆盖+行为对齐。

  • ruff format 替代 black:控制缩进、引号、换行、逗号等所有格式细节
  • ruff check 启用 "E"(pycodestyle)、"F"(pyflakes)、"I"(isort)规则组,就覆盖了 flake8 + isort --check 的全部检查能力
  • 不需要 isort 单独安装或运行;ruff check --fix 会自动重排导入、合并/删除未使用项

关键配置项怎么写才不翻车

常见错误是照抄旧 Flake8 配置却忽略 Ruff 的语义差异。比如把 ignore = ["E501"] 直接搬过去,但 Ruff 默认已用 line-length 控制长度,E501 已被自动禁用——多写反而干扰逻辑。

  • 格式化必须显式开启 [tool.ruff.format],否则 ruff format 命令无效(默认只做 lint)
  • 导入排序要启用 "I" 规则,不是靠 isort 插件: select = ["E", "F", "I", "UP"]
  • 行长度统一由 line-length = 88(推荐值)控制,不要再在 lint.ignore 里写 E501
  • 若项目用 black 风格,isort 必须设为 profile = "black" —— 但 Ruff 内置的 "I" 规则已自动适配该风格,无需额外配置

为什么 ruff check --fix 有时不重

排导入?

这是最常被卡住的点:你写了 "I",也加了 --fix,但 import 块纹丝不动。根本原因是 Ruff 默认只修复「安全」问题,而导入重排涉及语义顺序(如 from __future__ import 必须在最前),它需要明确知道哪些导入属于哪一组。

  • 确保 [tool.ruff.lint.isort] 下定义了 known-first-party(如 ["myproject"]),否则 Ruff 把所有包都当第三方处理,分组失效
  • 检查是否漏了 src = ["myproject"] —— Ruff 需靠它识别第一方模块路径
  • 避免在 per-file-ignores 中误关了 I 类规则,例如:"__init__.py" = ["I001"] 会跳过该文件所有导入检查

迁移到 Ruff 后,CI 和编辑器怎么改?

不用大动干戈。Ruff 兼容 Flake8 和 Black 的 CLI 接口,多数 CI 脚本只需改一个命令名;编辑器插件也基本无缝切换。

  • CI 中替换:把 flake8 .ruff check .black --check .ruff format --check .
  • VS Code 用户装官方 Ruff 插件后,在设置里关掉 Python: Formatting Provider(原 black)和 Python: Linting Enabled(原 flake8),Ruff 自动接管
  • 注意:Ruff 的 --fix 默认不修 W 类警告(如 W292 换行缺失),如需,得显式加 --unsafe-fixes(仅限确定安全时)

真正容易被忽略的是缓存行为:Ruff 会跳过未修改文件,这在本地开发很爽,但在 CI 中若用增量构建,可能漏检。建议 CI 固定加 --no-cache,避免因缓存导致规则更新后未生效。