代码编排
-
缩进。4个空格的缩进(编辑器都可以完成此功能),不能使用Tap,更不能混合使用Tap喝空格。
-
每行最大长度为79,换行可以使用反斜杠,最好使用圆括号。换行点要在操作符的后边敲回车。
-
类和top-level(顶级窗口)函数定义之间空两行;类中的方法定义之间空一行;函数逻辑无关段落之间空一行;其他地方尽量不要在空行。
2、文档编排 -
模块内容的顺序:模块说明和docstring—import—globals&constants—其他定义。其中import部分,又按标准、三方和自己编写顺序依次排放,之间空一行。
-
不要在一句import中多个库,比如import os、sys不推荐。
-
如果采用from XX import XX引用库,可以省略‘module’,都是可能出现命名冲突,这是就要采用import XX。
3、空格的使用
总体原则,避免不必要的空格 -
各种右括号前不要空格。
-
逗号、冒号、分号前不要加空格。
-
函数在左括号前不要加空格。如Func(1)。
-
序列的左括号前不要加空格。如List[1].
-
操作符左右各加一个空格,不要为了对齐增加空格。
-
函数默认参数使用的赋值符左右省略空格。
-
不要将多句语句写在同一行,尽管使用‘;’允许。
-
if/for/while语句中,即便执行语句只有一句,也必须另起一行。
4、注释
总体原则,错误的注释不如没有注释。所以当一段代码发生变化时,第一件事就是哟啊修改注释!
注释必须使用英文,最好是完整的句子,首字母大,句后要有结束符,结束符后跟两个空格,开始下一句。如果是短句,可以省略结束符。 -
块注释,在一段代码前增加注释。在‘#’后加一空格。段落之间以只有‘#“的行间隔。比如:
# Description : Module config.
#
# Input : None
#
# Output : None
- 行注释,在一句代码后面加注释。比如:x = x + 1 # increment x
- 但是之中方式尽量少使用。
- 避免无谓的注释
5、文档注释 - 为所有的共有模块、函数、类、方法写docstrings;非共有的没有必要,但是可以写注释(在def的下一行)。
在def的下一行,填写文档注释,多人开发,需要添加以下项
@ author: 开发人员名字
@ date: 开发日期
6、命名规范
总体原则,新编代码必须按下面命名风格进行,现有库的编码尽量保持风格。
-
尽量单独使用小写字母‘l’,大写字母‘O’等容易混淆的字母。
-
模块命名尽量短小,使用全部小写的方式,可以使用下划线。
-
包命名尽量短小,使用全部小写的方式,不可以使用下划线。
-
类的命名使用CapWords的方式,模块内部使用的类采用_CapWords的方式。_
-
_异常命名使用CapWords+Error后缀的方式。
-
全局变量尽量只在模块内有效,类似C语言中的static。实现方法有两种,一是__all__机制;二是前缀一个下划线。
-
函数命名使用全部小写的方式,可以使用下划线。
-
常量命名使用全部大写的方式,可以使用下划线。
-
类的属性(方法和变量)命名使用全部小写的方式,可以使用下划线。
-
类的属性若与关键字名字冲突,后缀一下划线,尽量不要使用缩略等其他方式。
-
为避免与子类属性命名冲突,在类的一些属性前,前缀两条下划线。比如:类Foo中声明__a,访问时,只能通过Foo._Foo__a,避免歧义。如果子类也叫Foo,那就无能为力了。
-
类的方法第一个参数必须是self,而静态方法第一个参数必须是cls。
7、编码建议
- 编码中考虑到其他python实现的效率等问题,比如运算符‘+’在CPython(Python)中效率很高,都是Jython中却非常低,所以应该采用.join()的方式。
- 尽可能使用‘is’‘is not’取代‘==’,比如if x is not None 要优于if x。
- 使用基于类的异常,每个模块或包都有自己的异常类,此异常类继承自Exception。
- 异常中不要使用裸露的except,except后跟具体的exceptions。
- 异常中try的代码尽可能少。比如:
try:
value = collection[key]
except KeyError:
return key_not_found(key)
else:
return handle_value(value)
要优于
try:
# Too broad!
return handle_value(collection[key])
except KeyError:
# Will also catch KeyError raised by handle_value()
return key_not_found(key)
-
使用startswith() and endswith()代替切片进行序列前缀或后缀的检查。比如
Yes: if foo.startswith(‘bar’):优于
No: if foo[:3] == ‘bar’: -
使用isinstance()比较对象的类型。比如
Yes: if isinstance(obj, int): 优于
No: if type(obj) is type(1): -
判断序列空或不空,有如下规则
Yes: if not seq:
if seq:
优于
No: if len(seq)
if not len(seq) -
字符串不要以空格收尾。
-
二进制数据判断使用 if boolvalue的方式