PEP 8 Python 编码规范整理
PEP 8 是 Python 官方编码规范，旨在统一 Python 代码风格和格式，提高代码的可读性和维护性。本文将详细介绍 PEP 8 的主要内容，包括缩进、代码组织、空格使用、注释、文档描述和命名规范等。
一、缩进
PEP 8 规定使用 4 个空格的缩进，不使用 Tab，编辑器都可以完成此功能。
二、代码组织
PEP 8 规定模块内容的顺序为：
1. 模块说明和 docstring
2. import
3. 全局变量和常量
4. 类和函数定义
其中，import 部分按照标准、三方和自己编写的顺序依次排放，之间空一行。
三、空格使用
PEP 8 规定：
1. 各种右括号前不要加空格。
2. 逗号、冒号、分号前不要加空格。
3. 函数的左括号前不要加空格。
4. 序列的左括号前不要加空格。
5. 操作符左右各加一个空格，不要为了对齐增加空格。
6. 函数默认参数使用的赋值符左右省略空格。
四、注释
PEP 8 规定：
1. 注释必须使用英文，最好是完整的句子，首字母大写，句后要有结束符，结束符后跟两个空格，开始下一句。如果是短语，可以省略结束符。
2. 块注释，在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。
3. 行注释，在一句代码后加注释。
五、文档描述
PEP 8 规定：
1. 为所有的共有模块、函数、类、方法写 docstrings。
2. 如果 docstring 要换行，参考 PEP 257。
六、命名规范
PEP 8 规定：
1. 尽量单独使用小写字母‘l’，大写字母‘O’等容易混淆的字母。
2. 模块命名尽量短小，使用全部小写的方式，可以使用下划线。
3. 包命名尽量短小，使用全部小写的方式，不可以使用下划线。
4. 类的命名使用 CapWords 的方式，模块内部使用的类采用_CapWords 的方式。
5. 异常命名使用 CapWords+Error 后缀的方式。
6. 全局变量尽量只在模块内有效，类似 C 语言中的 static。
7. 函数命名使用全部小写的方式，可以使用下划线。
8. 常量命名使用全部大写的方式，可以使用下划线。
9. 类的属性（方法和变量）命名使用全部小写的方式，可以使用下划线。
七、编码建议
PEP 8 规定：
1. 编码中考虑到其他 Python 实现的效率等问题。
2. 尽可能使用‘is’‘is not’取代‘==’。
3. 使用基于类的异常，每个模块或包都有自己的异常类，此异常类继承自 Exception。
4. 异常中不要使用裸露的 e。
遵循 PEP 8 规范可以帮助 Python 开发者编写更加高质量、可维护的代码，从而提高开发效率和代码质量。
