python编程规范

python编程规范

在python 编码过程中遵循PEP8编程规范

以下规范必须遵守

一、代码编排

1. 缩进。4个空格的缩进，不使用 tab，更不能tab和空格混用
2. 每行不能超过79个字符
3. 类和top-level函数定义之间空两行；类中的方法定义之间空一行
   函数内逻辑无关段落之间空一行；其他地方尽量不要再空行

二、文档编排

1. 模块内容的顺序：模块说明和docstring—import—globals&constants—其他定义。其中
   import部分，又按标准、三方和自己编写顺序依次排放，之间空一行。
2. 不要在一句import中多个库，比如import os, sys不推荐

三、空格的使用

1. 各种右括号前不要加空格。
2. 逗号、冒号、分号前不要加空格
3. 函数的左括号前不要加空格。如Func(1)
4. 序列的左括号前不要加空格。如list[2]
5. 操作符左右各加一个空格，不要为了对齐增加空格
6. 函数默认参数使用的赋值符左右省略空格。
7. 不要将多句语句写在同一行，尽管使用‘；’允许
8. if/for/while语句中，即使执行语句只有一句，也必须另起一行

四、注释

1. 总体原则，错误的注释不如没有注释。所以当一段代码发生变化时，第一件事就是要修改注释
2. 注释尽量使用英文，最好是完整的句子，首字母大写，句后要有结束符，结束符后跟两个空格，开始下一句,
   如果是短语，可以省略结束符
3. 块注释，在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔
4. 行注释，在一句代码后加注释。比如：x = x + 1 # Increment x,这种注释尽量少用
5. 避免无谓的注释

五、命名规范

1. 模块名和包名采用小写字母并且以下划线分隔单词的形式
2. 类名采用以大写字母开头，并且以大写字母分隔单词的形式命名
3. 全局或者类常量，全部使用大写字母，并且以下划线分隔单词
4. 其余变量命名则是采用全部小写字母，并且以大写字母分隔单词的形式命名
5. 尽量单独使用小写母‘l’，大写字母‘O’等容易混淆的字母
6. 类的属性若与关键字名字冲突，后缀一下划线，尽量不要使用缩略等其他方