代码风格与检查
代码是写给人看的。统一的风格能显著降低阅读成本,Python 社区的风格规范是 PEP 8。
PEP 8 要点
- 缩进使用 4 个空格;
- 每行不超过 79~99 个字符;
- 变量和函数用
snake_case,类用PascalCase,常量用UPPER_CASE; - 顶层函数和类之间空两行,方法之间空一行;
import放在文件开头,按标准库、第三方库、本地模块分组。
自动化工具
手动检查格式费时费力,交给工具:
$ pip install ruff
$ ruff check . # 检查问题
$ ruff check --fix . # 自动修复
$ ruff format . # 格式化代码
ruff 速度很快,可以同时替代 flake8、isort、black 等多个工具。
编辑器集成
在 VS Code 中安装 Ruff 扩展,并开启"保存时格式化",写代码时就能实时看到问题。
示例
# 不推荐
def CalcTotal(Items,Rate = 0.1):
return sum(Items)*(1+Rate)
# 推荐
def calc_total(items, rate=0.1):
return sum(items) * (1 + rate)练习题
学完本节后,试着独立完成下面的练习,再展开参考答案对照。
练习 1 把下面的代码改写为符合 PEP 8 的风格:def GetArea(W,H):return W*H。
查看参考答案
def get_area(width, height):
return width * height
print(get_area(3, 4))参考输出:
12