python开发规范

风格规范

1、编码

如无特殊情况, 文件一律使用 UTF-8 编码
如无特殊情况, 文件头部必须加入`#-*-coding:utf-8-*-`或者# coding=utf-8标识

2、代码格式

• 缩进

 统一使用 4 个空格进行缩进

• 行宽

                每行代码尽量不超过 80 个字符

• 引号

1. 自然语言使用双引号`"..."`，例如错误信息；很多情况还是 unicode，使用`u"你好世界"`
2. 机器标识 使用单引号 '...' 例如 dict 里的 key
3. 正则表达式 使用原生的双引号 r"..."
4. 文档字符串 (docstring) 使用三个双引号 """......"""

• 空行

模块级函数和类定义之间空两行；

类成员函数之间空一行；

可以使用多个空行分隔多组相关的函数

函数中可以使用空行分隔出逻辑相关的代码

• 分号

*不要在行尾加分号, 也不要用分号将两条命令放在同一行.

• 括号

       * 宁缺毋滥的使用括号

3、import 语句

import 语句应该分行书写

 import语句应该使用绝对导入

 
import语句应该放在文件头部，置于模块说明及docstring之后，于全局变量之前；
import语句应该按照顺序排列，每组之间用一个空行分隔

导入其他模块的类定义时，可以使用相对导入

 

4、空格

在二元运算符两边各空一格`[=,-,+=,==,>,in,is not, and]`:

函数的参数列表中，`,`之后要有空格

函数的参数列表中，默认值等号两边不要添加空格

左括号之后，右括号之前不要加多余的空格 

 字典对象的左括号之前不要多余的空格

不要为对齐赋值语句而使用的额外空格

5、换行

Python 支持括号内的换行。这时有两种情况

使用反斜杠\换行，二元运算符+ .等应出现在行末；长字符串也可以用此法换行

禁止复合语句，即一行中包含多个语句：

if/for/while一定要换行：

6、docstring

docstring 的规范中最基本的两点：

所有的公共模块、函数、类、方法，都应该写 docstring 。私有方法不一定需要，但应该在 def后提供一个块注释来说明。
docstring 的结束"""应该独占一行，除非此 docstring 只有一行

注释规范

1、块注释

“#”号后空一格，段落间用空行分开

2、行注释

至少使用两个空格和语句分开，注意不要使用无意义的注释

3、建议

在代码的关键部分(或比较复杂的地方), 能写注释的要尽量写注释

比较重要的注释段, 使用多个等号隔开, 可以更加醒目, 突出重要性

命名规范

1.模块

模块尽量使用小写命名，首字母保持小写，尽量不要用下划线(除非多个单词，且数量不多的情况)

2.类名

类名使用驼峰(CamelCase)命名风格，首字母大写，私有类可用一个下划线开头

3.函数

函数名一律小写，如有多个单词，用下划线隔开

私有函数在函数前加一个下划线_

4.变量

变量名称尽量小写,如有多个单词，用下划线隔开

5.常量

常量采用全大写，如有多个单词，使用下划线隔开