Python的PEP8(Python Enhancement Proposal 8)是官方推荐的代码风格指南,旨在提升代码的可读性和一致性。以下是其主要规范要点:
一、代码布局
-
缩进
- 每级缩进使用4个空格,禁止混合使用Tab和空格。
- 悬挂缩进时需与包裹元素对齐或额外缩进一级。
- 示例:
# 正确:垂直隐式缩进 foo = long_function_name(var_one, var_two, var_three, var_four)
-
行长度
- 每行不超过79字符(注释/文档字符串不超过72字符)。
- 长行可通过括号隐式换行,避免使用反斜杠。
-
空行
- 顶层函数或类之间空两行,类内方法之间空一行。
- 函数内逻辑段落可空一行分隔。
二、命名规范
- 变量/函数名:小写字母加下划线(
snake_case)。 - 类名:首字母大写的驼峰式(
ClassName)。 - 常量:全大写加下划线(
MAX_LENGTH)。 - 私有属性:双下划线开头(
__private_var)。
三、空格使用
- 运算符两侧、逗号后加空格,但括号内不加。
示例:x = (1 + 2) * 3 # 正确 dict = {'a': 1, 'b': 2} # 冒号后空格
四、导入规范
- 每个导入独占一行,按标准库→第三方库→本地库分组。
- 避免
-
示例:from module import * -
import os import sys from flask import Flask
五、注释与文档
- 块注释:以
#开头,与代码缩进一致。 - 文档字符串:使用三重引号,描述模块/函数功能。
示例: -
def calculate_sum(a, b): """返回两个数的和。""" return a + b
六、其他规则
- 字符串引号:统一使用单引号或双引号,优先双引号。
- 异常处理:避免捕获过于宽泛的异常(如
except Exception)。
工具支持
推荐使用flake8检查代码风格,或autopep8自动格式化。
PEP8并非强制规则,但遵循其规范能显著提升代码可维护性,尤其在团队协作中。

1269

被折叠的 条评论
为什么被折叠?



