PEP 8是Python官方推荐的代码风格指南,全称为"Python Enhancement Proposal 8"。遵循PEP 8规范可以让代码更易读、更一致,便于团队协作和维护。本文将全面解析PEP 8的核心内容,并提供实用的最佳实践建议。
一、代码布局与缩进
1.1 缩进规则
- 每级缩进:4个空格(绝对不要用Tab键)
- 续行:与包裹元素对齐或使用悬挂缩进(额外缩进一级)
推荐:
# 与包裹元素对齐
foo = long_function_name(var_one, var_two,
var_three, var_four)
# 悬挂缩进(额外一级)
foo = long_function_name(
var_one, var_two,
var_three, var_four)
不推荐:
# 没有垂直对齐
foo = long_function_name(var_one, var_two,
var_three, var_four)
# 缩进不足
foo = long_function_name(
var_one, var_two,
var_three, var_four)
1.2 最大行长度
- 推荐:每行不超过79字符(文档字符串/注释不超过72字符)
- 例外:长导入语句、URL、路径等可以超限
处理长行的方法:
# 使用括号包裹
with open('/path/to/some/file/you/want/to/read') as file_1, \
open('/path/to/some/file/being/written'