Python 程序的编码标准(样式指南)?
Python 的编码标准，即样式指南，由名为 PEP8 的文档提供。PEP8 是 Python 增强提案 8。它是一份提供 Python 代码编码约定的文档。
这是样式指南 −
命名约定
以下是当前推荐的命名标准。
避免使用这些名称
切勿使用字符"l"(小写字母 el)、"O"(大写字母 oh)或"I"(大写字母 eye)作为单字符变量名。
包和模块名称
模块应使用简短的全小写名称。如果可以提高可读性，可以在模块名称中使用下划线。 Python 包也应该使用简短的全小写名称，但不鼓励使用下划线。
类名
类名通常应使用 CapWords 约定。在接口已记录并主要用作可调用函数的情况下，可以使用函数的命名约定。
异常名称
类命名约定适用于此处。但是，您应该在异常名称上使用后缀"Error"。
函数和变量名称
函数名称应小写，单词之间用下划线分隔以提高可读性。
变量名称遵循与函数名称相同的约定。
函数和方法参数
始终使用 self 作为实例方法的第一个参数。
始终使用 cls 作为类方法的第一个参数。
方法名称和实例变量
使用函数命名规则:小写，单词之间用下划线分隔以提高可读性。
仅对非公共方法和实例变量使用一个前导下划线。
为避免与子类的名称冲突，请使用两个前导下划线来调用 Python 的名称修改规则。
常量
常量通常在模块级别定义，全部大写，用下划线分隔单词。
缩进
指南建议每个缩进级别使用 4 个空格。
制表符或空格
制表符应仅用于与已使用制表符缩进的代码保持一致。
Python 不允许混合使用制表符和空格进行缩进。
最大行长
将所有行限制为最多 79 个字符。
导入
import 语句与 Python 中的任何其他语句或关键字一样，应按照最佳实践正确使用和添加到代码中。让我们逐一查看 -
多个导入
多个导入通常应放在单独的行上。例如 −
import numpy import pandas import matplotlib
始终位于顶部
导入始终位于文件顶部，即
- 位于任何模块注释和文档字符串之后。
- 位于模块全局变量和常量之前。
例如 −
# import the numpy module import numpy
按顺序导入模块
按以下顺序导入模块是一种好的做法 -
- 标准库模块 - 例如 sys、os、getopt、re。
- 第三方库模块 - 例如 ZODB、PIL.Image 等。
- 本地开发的模块。
绝对导入
建议使用绝对导入，因为它们通常更易读，并且如果导入系统配置不正确，则执行效果会更好。例如 −
import mypkg.sibling from mypkg import sibling from mypkg.sibling import example
应避免使用通配符导入(从 import *)
避免使用通配符导入，因为它们会使命名空间中存在哪些名称变得不清楚，从而使读者和许多自动化工具感到困惑。
表达式和语句中的空格
避免在以下情况下出现不必要的空格 -
在尾随逗号之间
# Correct: a = (0,)
# Wrong: b = (0, )
紧接在逗号、分号或冒号之前 -
# Correct: if a == 5: print(a, b); a, b = b, a
# Wrong: if a == 5 : print(a , b) ; a , b = b , a
紧接着函数调用的参数列表的左括号之前
# Correct: demo()
# Wrong: demo ()
紧接着开始索引或切片的左括号之前
# Correct: dct['key'] = lst[index]
# Wrong: dct ['key'] = lst [index]
注释
注释应为完整的句子。
第一个单词应大写，除非它是以小写字母开头的标识符。
块注释通常由一个或多个由完整句子构成的段落组成，每个句子以句号结尾。
在多句注释中，应在句末句号后使用两个空格，但最后一句之后除外。
