跳至内容
python开发规范

python开发规范

1. 编码

无特殊情况,文件统一用UTF-8编码

无特殊情况,文件头部必须加入# -*- coding: UTF-8 -*-

2. 导入格式

  • 先import Python 内置模块,再import 第三方模块,最后 import 自己开发的项目中的其它模块用空行分隔
  • 每个import独占一行
  • 不要使用 from module import *,除非是 import 常量定义模块或其它你确保不会出现命名空间冲突的模块

2. 注释

错误的注释,不如没有注释,在改动代码时候,一定要注意检查周围注释是否需要更新

  • 对于大的逻辑块,在最开始相同的缩进处以 # 开始写注释,段落间用空行分开。且应该把注释当成完整的文章来书写,同时注意精简表达
  • 对于行注释,在一行的后面跟两个空格,然后以 # 开头加入注释
  • 对于docstring,所有的公共模块、函数、类、方法,都应该编写,docstring 的结束"““应该独占一行,除非此 docstring 只有一行

3. 缩进规范

  • Python代码缩进分为tab和空格,严禁两者混合,使用四个空格缩进(使用pycharmIDE设置tab为4个空格)

  • 每行代码最大79个字符,注释最大为72个字符

4. 空行规范

  • 模块级函数和类定义之间空两行
  • 类成员函数之间空一行
  • 在import不同种类的模块间加空行

5. 空格规范

  • 对于操作符,例如+,-,*,/,&,|,=,==,!=,请在两边都保留空格。不过与此对应,括号内的两端并不需要空格
  • 函数的参数列表中,,之后要有空格
  • 左括号之后,右括号之前不要加多余的空格
  • 函数的参数列表中,默认值等号两边不要添加空格
  • 字典对象的左括号之前不要多余的空格
  • 不要为对齐赋值语句而使用的额外空格

6. 命名规范

6.1 模块

  • 模块名全部小写
  • 尽量不要用下划线(除非多个单词,且数量不多的情况下)

6.2 包

  • 包名全部小写

  • 尽量不要用下划线(除非多个单词,且数量不多的情况下)

6.2 类名

类名使用驼峰(CamelCase)命名风格,首字母大写不使用下划线连接单词

6.3 函数名

变量名全部小写,由下划线连接各个单词

6.4 变量

变量名请拒绝使用 a b c d 这样毫无意义的单字符,应该使用能够代表其意思的变量名

变量名全部小写,通过下划线串联起来

6.5 常量

常量名所有字母大写,由下划线连接各个单词

6.6 提交要求

  1. 确保每次提交只包含一个明确的变更。
  2. 在提交前自测代码,确保其功能完整且无误。
  3. 参考提交历史,确保提交信息的一致性。
  4. 提交信息的开头应包含提交类型,这有助于快速理解提交的目的

6.7 常见的提交类型

  • feat: 新功能

  • fix: 修复问题

  • docs: 文档更新

  • style: 代码格式(不影响代码运行的变动)

  • refactor: 代码重构(既不是修复bug也不是添加新功能的代码更改)

  • perf: 性能优化

  • test: 添加测试或更新测试

  • build: 构建系统或外部依赖项的更改(如webpack,npm)

  • ci: 持续集成相关的变动

  • chore: 其他不修改 src 或测试文件的更改

  • revert: 回滚某次提交