Python代码规范

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

前言：

Python社区有一套广泛接受的风格指南，称为PEP 8（Python Enhancement Proposal 8）。主要依据PEP 8结合自己遇到的问题不断修改完善Python代码规范。

PEP 8中文版

Pycharm代码规范工具：

flake8静态代码规范工具

black动态自动修改代码规范工具

使用方式

一旦安装完成，使用Black非常简单。你可以在命令行中输入 black 加上要格式化的文件或目录。例如，要格式化一个叫做 example.py 的文件，你可以运行：

black example.py 

一、命名规范

1. 变量和函数名：应使用小写字母，单词之间使用下划线分隔，例如my_variable、my_function()。
2. 类名：应使用驼峰命名法（大驼峰，即每个单词首字母大写），例如MyClass。
3. 常量：应全部使用大写字母，单词之间使用下划线分隔，例如MY_CONSTANT。
4. 私有成员：以单下划线_开头表示模块内或类内私有，双下划线__开头的实例变量或方法表示类内私有。
5. 变量首次使用：多个变量首次使用以及调用函数时放到一起方便阅读

二、缩进和空格

1. 缩进：使用4个空格进行缩进，不要使用制表符（Tab）。Python 3不允许混合使用制表符和空格来缩进。
2. 空格：在运算符和逗号后面加一个空格，例如x = y + z；在逗号和冒号前面不加空格，例如x, y = 1, 2。
3. 行长度：每行代码不应超过79个字符。如果一行代码过长，可以使用括号或者反斜杠进行换行。

三、空行

1. 顶级定义之间：应空两行以提高代码的可读性。
2. 方法定义之间：应空一行。

四、导入规范

1. 导入位置：导入应放在文件开头，每个导入语句应独占一行。
2. 导入顺序：应按照标准库、第三方库和本地库的顺序排列。
3. 不推荐使用通配符导入：应明确导入需要的模块。

五、注释规范

1. 单行注释：使用井号#来标记，注释内容应简洁明了。
2. 多行注释：使用三引号'''或"""来标记，常用于模块、类或函数的文档字符串（docstring）。
3. 注释风格：注释应以英文句点结尾，清晰地解释代码的功能和用途。

六、函数规范

1. 函数长度：函数应尽量短小，每个函数只完成一个具体的任务。
2. 参数数量：函数的参数应尽量少，避免使用过多的全局变量。
3. 返回值：函数应有明确的返回值。
4. 函数注释：写明参数类型以及返回值类型

七、异常处理

1. 异常处理：在代码中应适当添加异常处理语句，以防止程序出现错误时崩溃。
2. 具体异常：异常处理语句应尽量具体，避免使用通用的Exception类。

八、代码格式化工具

1. 使用工具：可以使用代码格式化工具（如autopep8、falke8）自动对代码进行格式化，以符合PEP 8规范。

九、目录结构

1. 做到脚本分类明确
2. 使用目录标记

十、代码审查和团队合作

1. 代码审查：编写代码后应进行代码审查，以确保代码符合规范并且没有潜在的问题。
2. 团队合作：团队成员之间应保持良好的沟通和合作，遵守相同的代码规范，以确保代码的一致性和可维护性。
3. 版本控制：README.md规范，导出requirements.txt文件。

十一、其他规范

1. 字符串引号：优先使用单引号'，除非字符串中包含单引号，此时使用双引号"。
2. 多行字符串：使用三引号'''或"""来定义。