代码编排
1、缩进。4个空格的缩进,避免使用tab,更不能回合使用tab 和 空格
2、每行最大长度为79 ,换行可以使用反斜杠,最好使用圆括号。换行点要在操作符的后边敲回车
3、类和top_level函数定义之间空两行;
类中的方法定义之间空一行;
函数内逻辑无关段落之间空一行;
其他地方尽量不要空行
文档编排
1、模块内容的顺序:
模块说明和doc string ----> import ----->global & constants -----其他定义
其中import 部分又按 标准、三方、自己编写 依次排放,之间空一行
2、不要在一句import中 导入多个库,比如 import os,sys
3、如果采用from XX import XX 应用库,可以省略module, 如果可能出现命名冲突,这时就要采用 import XX
空格的使用
总体原则,避免不必要的空格
1、各种右括号前不要加空格
2、逗号、冒号、分号前不要加空格
3、函数的左括号前不要加空格 如:fun(1)
4、序列的左括号前不要加空格。如:list[2]
5、函数默认参数使用的赋值符左右省略空格
6、不要将多条语句写在同一行,尽管允许使用“;”
7、操作符左右各加一个空格,不要为了对齐增加空格
8、if /for /while 语句中,即使执行语句只有一条,也必须另起一行
注释
1、块注释,在一段代码前增加的注释。在 # 后加一个空格。段落之间以只有 # 的行间隔
2、行注释,在一行代码后加注释(尽量少使用)
文档描述
1、为所有共有模块、函数、类、方法写docstrings;非共有没有必要,但可以写注释
2、如果docstring 要换行,可以使用三引号
"""
"""
命名规范
1、尽量单独使用小写字母 i 、大写字母 O 等容易混淆的字母
2、模块命名尽量短小,使用全部小写的方式,可以使用下划线
3、包命名尽量短小,使用全部小写的方式,不可以使用下划线
4、类的命名使用CapWords的方式,模块内部使用的类采用_CapWords的方式,异常命名采用CapWords+Error后缀形式
5、全局变量尽量只在模块内有效。类似C语言中的static。实现方法有两种,一种是all机制,二是前缀一个下划线
6、函数命名使用全部小写形式,可以使用下划线
7、常量命名全部使用大写的方式,可以使用下划线
8、类的属性(方法和变量)命名全部采用小写的方式,可以使用下划线
9、类的属性有三种作用域public、non-public、subclassAPI,可以理解成C++中的public 、private 、protected 。 non-public属性前,前缀一条下划线
10、类的属性若与关键字命名冲突,后缀一下划线,尽量不要使用缩略等其他方式
11、为避免与子类属性命名冲突,在类的一些属性前,前缀两条下划线。
12、类的第一个参数必须是self,而静态方法的第一个参数必须是 cls