PEP8编码规范
2022-03-09 17:01:21
PEP8编码规范的核心目的是提高代码的可读性，其规范条例涵盖代码排版、文档排版、空格使用、注释、命名风格、命名规范及编码建议等方面。以下是具体内容：
代码排版
缩进：使用4个空格作为标准缩进，禁止使用制表符（Tab），以保持不同编辑器下的显示一致性。
行长度：单行代码长度建议不超过79个字符，长表达式可通过括号或反斜杠换行，换行后缩进需与上一行对齐或增加一级缩进。
空行：函数与类定义之间、类内方法之间用两个空行分隔；函数内逻辑段落间用一个空行分隔，避免连续多行空行。
导入规范：导入语句应分组并按标准库、第三方库、本地库顺序排列，每组间空一行；禁止使用通配符导入（如from module import *）。
文档排版
模块注释：模块文件开头需包含模块功能、作者、版本等信息的文档字符串（docstring），格式为三引号包裹的多行字符串。
函数/类注释：函数和类定义后需添加docstring，说明功能、参数、返回值及异常，推荐使用Google风格或NumPy风格。
行内注释：仅对复杂逻辑或非直观代码添加注释，注释与代码需保持至少两个空格间隔，避免冗余注释。
避免多余的空格
运算符周围：二元运算符（如+、=）两侧需保留一个空格，但逗号后需加空格（如func(a, b)）。
括号内：括号内首尾禁止加空格（如func(a)，非func( a )），但括号内多行内容需按缩进对齐。
切片操作：切片操作符（:）两侧空格可省略（如list[1:5]），但显式表达时建议保留（如list[1 : 5]）。
注释
注释内容：注释需解释“为什么”而非“做什么”，例如说明算法选择原因或边界条件处理逻辑。
注释更新：代码修改时需同步更新注释，避免注释与代码不一致导致误解。
TODO注释：临时性待办事项需标注# TODO:并说明预期修改内容及负责人。
命名风格
变量/函数：使闹腊用小写字母与下划线组合的蛇形命名法（如user_name），避免使用单字符命名（除临时变量如i、x）。
常量：全大写字母与下划线组合（如MAX_CONNECTIONS），通常定义在模块顶部。
类名：采用大驼峰命名法（如ClassName），避免使用下划线或缩写（除非是广泛认可的缩写如HTTP）。
私有成员：类内私有变量或方法需以下划线开头（如_private_var），双下划线（__var）会触发名称修饰，慎用。
命名规范
避免冲突：禁止使用Python内置关键字（如list、class）或标准库模块名卜颤作为变量名。
缩写处理：缩写需统一大小写（如HTTPResponse非HttpResponse），避免混合使用（如xmlHTTPRequest）。
模块名液弊滑：短小且全小写（如utils.py），避免下划线（除非是多个单词组合如data_processor.py）。
编码建议
类型提示：Python 3.5+推荐使用类型注解（如def func(x: int) -> str:），提升代码可维护性。
异常处理：捕获异常时需指定具体异常类型（如except ValueError as e），避免裸except:语句。
代码复用：优先通过函数或类封装重复逻辑，避免大段代码复制粘贴。
工具辅助：使用autopep8、flake8等工具自动检查并格式化代码，确保符合PEP8规范。
参考链接：
热门标签
