Python `ruff` / `flake8`：代码风格检查与 Linting 规则定制

Python 代码的“颜值担当”：Ruff 和 Flake8 代码风格检查与 Linting 规则定制

各位亲爱的程序员朋友们，大家好！我是今天的主讲人，江湖人称“代码美容师”（大家也可以叫我老码，显亲切）。今天咱们不聊高深的算法，也不谈复杂的架构，就来聊聊咱们代码的“颜值”——代码风格和 Linting。

为什么要关注代码“颜值”呢？你想啊，你辛辛苦苦写的代码，不仅要机器能读懂，更要让人能读懂。想象一下，如果你的代码像一堆乱麻，变量命名像外星语，缩进忽长忽短，注释惜字如金，即使功能再强大，别人（包括未来的你自己）看了也得崩溃！

所以，保持代码的整洁、一致和易读，不仅能提升团队协作效率，还能减少维护成本，甚至能避免一些潜在的 Bug。而要做到这一点，我们就需要借助代码风格检查和 Linting 工具。

在 Python 的世界里，Flake8 和 Ruff 就是两位非常受欢迎的“颜值担当”。它们就像是专业的代码美容师，能帮我们自动检查代码风格，找出潜在问题，让我们的代码焕然一新。

Flake8：老牌代码风格卫士

Flake8 是一位经验丰富的代码风格卫士，它其实是一个“包工头”，把多个工具组合在一起使用，包括：

PyFlakes: 检查代码中的错误，如未使用的变量、导入错误等。
Pycodestyle (原 PEP8): 检查代码是否符合 PEP 8 规范，这是 Python 官方推荐的代码风格指南。
McCabe: 检查代码的复杂度，避免代码过于复杂难以维护。

安装 Flake8:

pip install flake8

使用 Flake8:

flake8 your_code.py

Flake8 会输出代码中不符合规范的地方，以及错误信息。例如：

your_code.py:1:1: E265 block comment should start with '# '
your_code.py:3:5: F401 'os' imported but unused
your_code.py:5:1: E302 expected 2 blank lines, found 1

这些信息分别表示：

E265: 块注释应该以 # 开头 (PEP 8 规范)。
F401: 导入了 os 模块，但没有使用。
E302: 应该有 2 个空行，但只找到 1 个 (PEP 8 规范)。

配置 Flake8:

Flake8 可以通过配置文件进行定制，常见的配置文件包括：

.flake8
setup.cfg
tox.ini

例如，在 .flake8 文件中，我们可以设置忽略某些错误码：

[flake8]
ignore = E265, F401, E302
max-line-length = 120

ignore: 忽略指定的错误码。
max-line-length: 设置最大行长度为 120 个字符。

Flake8 的优点：

历史悠久，社区活跃，插件丰富。
配置灵活，可以根据项目需求进行定制。
支持多种编辑器和 IDE 的集成。

Flake8 的缺点：

速度相对较慢，因为它需要调用多个工具。
一些规则可能过于严格，需要根据实际情况进行调整。

Ruff：后起之秀，速度之王

Ruff 是一款用 Rust 编写的 Python 代码检查器，它旨在替代 Flake8，并且拥有更快的速度。Ruff 不仅仅是一个代码风格检查器，它还是一个完整的 Linter，可以检查代码中的错误、潜在问题和不规范的代码风格。

安装 Ruff:

pip install ruff

使用 Ruff:

ruff your_code.py

Ruff 的输出信息和 Flake8 类似，但速度要快得多。

配置 Ruff:

Ruff 使用 pyproject.toml 文件进行配置。例如：

[tool.ruff]
line-length = 120
select = ["E", "W", "F", "I"]  # 启用的规则
ignore = ["E501"] # 忽略的规则

[tool.ruff.per-file-ignores]
"__init__.py" = ["F401"]  # 在 __init__.py 文件中忽略 F401 错误

line-length: 设置最大行长度为 120 个字符。
select: 启用的规则集合，例如 E 表示 PEP 8 错误，F 表示 Pyflakes 错误。
ignore: 忽略的规则。
per-file-ignores: 针对特定文件忽略的规则。

Ruff 的优点：

速度极快，比 Flake8 快 10-100 倍。
内置了大量的规则，涵盖了代码风格、错误检查和潜在问题。
支持自动修复 (Autofix) 一些错误，例如自动格式化代码、删除未使用的导入等。
使用 pyproject.toml 文件进行配置，更加现代化。

Ruff 的缺点：

生态系统相对较新，插件数量不如 Flake8 丰富。
一些规则可能过于激进，需要根据实际情况进行调整。

Ruff vs Flake8：一场速度与激情的较量

特性	Flake8	Ruff
速度	慢	快
规则数量	较少 (依赖插件)	多 (内置大量规则)
自动修复	不支持 (依赖插件)	支持
配置方式	`.flake8`, `setup.cfg`, `tox.ini`	`pyproject.toml`
语言	Python	Rust
生态系统	成熟，插件丰富	新，插件较少
默认开启规则	少	多

结论：

如果你的项目对速度要求不高，并且需要大量的自定义规则，那么 Flake8 仍然是一个不错的选择。
如果你的项目对速度要求很高，并且希望使用现代化的配置方式，那么 Ruff 是一个更好的选择。
如果你想体验一下飞一般的感觉，那就试试 Ruff 吧！

定制你的代码风格规则：让代码更符合你的口味

无论是 Flake8 还是 Ruff，都提供了丰富的配置选项，让我们可以根据项目需求定制代码风格规则。

1. 忽略特定的错误码：

有时候，一些规则可能不适用于你的项目，或者你暂时不想修复这些问题，你可以通过 ignore 选项来忽略特定的错误码。

例如，在 Flake8 中：

[flake8]
ignore = E501, W503

在 Ruff 中：

[tool.ruff]
ignore = ["E501", "W503"]

E501: 行长度超过限制。
W503: 在二元运算符之前换行。

2. 设置最大行长度：

PEP 8 建议的最大行长度为 79 个字符，但很多团队都认为这个限制过于严格。你可以根据自己的喜好设置最大行长度。

例如，在 Flake8 中：

[flake8]
max-line-length = 120

在 Ruff 中：

[tool.ruff]
line-length = 120

3. 针对特定文件忽略规则：

有时候，你可能需要在某些文件中忽略某些规则。例如，在 __init__.py 文件中，通常会导入一些模块，但这些模块可能不会直接使用。你可以通过 per-file-ignores 选项来忽略这些文件中的未使用的导入错误。

例如，在 Ruff 中：

[tool.ruff.per-file-ignores]
"__init__.py" = ["F401"]

4. 使用插件扩展功能：

Flake8 和 Ruff 都支持插件，你可以使用插件来扩展它们的功能。例如，你可以使用 flake8-docstrings 插件来检查代码中的文档字符串是否符合规范。

5. 自定义规则：

如果你对现有的规则不满意，或者你需要一些特定的规则，你可以编写自定义的规则。这需要一定的 Python 编程基础，但可以让你完全掌控代码风格。

代码风格即正义：让你的代码更专业

代码风格不仅仅是美观，更是一种专业精神的体现。好的代码风格可以提高代码的可读性、可维护性和可扩展性，减少 Bug 的产生，提升团队协作效率。

一些建议：

保持一致性： 在整个项目中保持一致的代码风格，这比追求完美的风格更重要。
遵循 PEP 8 规范： PEP 8 是 Python 官方推荐的代码风格指南，遵循它可以让你的代码更符合 Python 社区的习惯。
使用自动格式化工具： 使用 black 或 autopep8 等自动格式化工具可以自动调整代码风格，减少手动调整的工作量。
Code Review： 通过 Code Review 可以发现代码风格问题，并促进团队成员之间的交流和学习。
持续集成： 将代码风格检查集成到持续集成流程中，可以确保代码风格的一致性。

总结：

Flake8 和 Ruff 都是非常优秀的 Python 代码检查工具，它们可以帮助我们提高代码质量，提升团队协作效率。选择哪个工具取决于你的项目需求和个人喜好。

记住，代码风格不是目的，而是手段。我们的目标是编写出高质量、易读、易维护的代码。希望今天的分享能对大家有所帮助，让我们的代码更加“靓丽”，更加“专业”！

感谢大家的聆听！祝大家编码愉快，Bug 远离！