关于Python编程规范的一些个人建议

主要是个人在编程规范中的一些见解建议，欢迎指正

1. 代码书写要便于阅读。

例如：每行仅书写一条语句（尤其注意 if/for/while 语句）

2. 编码一致性

a. 在同一个项目中的代码要保持一致
b. 在同一个模块中的代码要保持一致

3. 关于缩进：

建议为 4 个空格。若使用 Tab 键，建议将其定义为 4 个空格。

缩进在 python 中是语法相关的，python 解释器通过缩进来判断代码块的从属关系，请谨慎使用

4. 建议代码行最大长度限定为 80 个字符。

当前行未输入完毕，如果继续输入将超过限定长度，此时在当前行尾输入‘\’后再回
车换行（这样 python 解释器认为另起的新行与当前行是同一逻辑行）

5. 代码中输入‘^L’,表示此处分页

6. 编码尽量用 ASCII 码，有特殊需要时可使用 UTF-8 码

7. “import”语句使用规范：

• 多条“import “语句要分行书写，不建议使用“import A, B”形式。
• 特殊地，可以使用”from X import A, B” 形式
• 导入各模块的书写顺序(自上而下):
  a. “import 标准内建模块”
  b. “import 第三方模块”
  c. “import 自建模块”

8. 工程文件目录建在 python 安装目录下

使用”import”语句导入模块时建议使用绝对路径

9. 空行的使用：

• 类外函数之间： 空 2 行
• 类内 methods 之间： 空 1 行
• 各类之间： 空 2 行

10. 空格的使用：

• 避免在[], (), {}内与括号相接触的位置使用空格，类似[ ‘a’], (‘b’ ), { ‘c’ }等形
  式都要避免
• 双目操作符前后各加一个空格（建议有且仅有一个空格，不建议使用多个或无空格）
• 特殊地，function 或 method 参数初始化时，‘=’前后都不加空格

11. 关于注释：

• 注释语言统一为英语
• 注释用‘# ’开头。（提醒：‘#’后要跟一个空格）
• 同一注释行中，句子间用两个空格
• 各注释行间若有空白行，同样以‘#’作行首
• 若代码本身简单易懂，或命名本身实现了自注释，勿加多余注释
• 代码修改的同时要修改对应注释，否则危害很大
• 注释是完整句子时，首单词的首字母大写; 注释较短时可省去末尾的句号

12. 命名规则

• 保持一致性，至少保持自建代码的一致性
• 避免使用单个字母做变量，尤其避免’l’, ’o’用作变量
• 命名字符串不要太长。注:本次会议中，该指标没有量化
• 类名采用首字母大写的各单词直接相连方式命名。例： “StudentBoy”
• 非类名采用字母均小写的各单词以下划线相连的方式命名。例：”student_boy”
• 属内部的 function, class, method 命名要以下划线开。：”_local_time”,“_LocalTime”
• 异常相关的命名用”Error”或”error”开头
• 全局变量与 function 命名规则一样
• 类内默认参数定义为’self’
• 当对参数命名可能发生重名时，在原名后加下划线作新名。例：”print_”
• 常量命名采用大写的各单词以下划线相连方式命名。例：”MAX_NAME_LENGTH”