python 编码规范整理
一代码编排
1缩进4个空格的缩进(编辑器都可以完成此功能),不要使用Tap,更不能混合使用Tap和空格。
2每行最大长度79,换行可以使用反斜杠,最好使用圆括号。换行点要在操作符的后边敲回车。
3类和top-level函数定义之间空两行;类中的方法定义之间空一行;函数内逻辑无关段落之间空一行;其他地方尽量不要再空行。
二文档编排
1模块内容的顺序:模块说明和docstring—import—globals&constants—其他定义。其中import部分,又按标准、三方和自己编写顺序依次排放,之间空一行。
2不要在一句import中多个库,比如importos,sys不推荐。
3如果采用fromXXimportXX引用库,可以省略‘module.',都是可能出现命名冲突,这时就要采用importXX。
三空格的使用
总体原则,避免不必要的空格。
1各种右括号前不要加空格。
2逗号、冒号、分号前不要加空格。
3函数的左括号前不要加空格。如Func(1)。
4序列的左括号前不要加空格。如list[2]。
5操作符左右各加一个空格,不要为了对齐增加空格。
6函数默认参数使用的赋值符左右省略空格。
7不要将多句语句写在同一行,尽管使用‘;'允许。
8if/for/while语句中,即使执行语句只有一句,也必须另起一行。
四注释
总体原则,错误的注释不如没有注释。所以当一段代码发生变化时,第一件事就是要修改注释!
注释必须使用英文,最好是完整的句子,首字母大写,句后要有结束符,结束符后跟两个空格,开始下一句。如果是短语,可以省略结束符。
1块注释,在一段代码前增加的注释。在‘#'后加一空格。段落之间以只有‘#'的行间隔。
2行注释,在一句代码后加注释。比如:x=x+1#Incrementx
但是这种方式尽量少使用。
3避免无谓的注释。
五文档描述
1为所有的共有模块、函数、类、方法写docstrings;非共有的没有必要,但是可以写注释(在def的下一行)。
2如果docstring要换行,参考如下例子,详见PEP257
"""Returnafoobang
Optionalplotzsaystofrobnicatethebizbazfirst.
"""
六命名规范总体原则,新编代码必须按下面命名风格进行,现有库的编码尽量保持风格。
总体原则,新编代码必须按下面命名风格进行,现有库的编码尽量保持风格。
1尽量单独使用小写字母‘l',大写字母‘O'等容易混淆的字母。
2模块命名尽量短小,使用全部小写的方式,可以使用下划线。
3包命名尽量短小,使用全部小写的方式,不可以使用下划线。
4类的命名使用CapWords的方式,模块内部使用的类采用_CapWords的方式。
5异常命名使用CapWords+Error后缀的方式。
6全局变量尽量只在模块内有效,类似C语言中的static。实现方法有两种,一是__all__机制;二是前缀一个下划线。
7函数命名使用全部小写的方式,可以使用下划线。
8常量命名使用全部大写的方式,可以使用下划线。
9类的属性(方法和变量)命名使用全部小写的方式,可以使用下划线。
9类的属性有3种作用域public、non-public和subclassAPI,可以理解成C++中的public、private、protected,non-public属性前,前缀一条下划线。
11类的属性若与关键字名字冲突,后缀一下划线,尽量不要使用缩略等其他方式。
12为避免与子类属性命名冲突,在类的一些属性前,前缀两条下划线。比如:类Foo中声明__a,访问时,只能通过Foo._Foo__a,避免歧义。如果子类也叫Foo,那就无能为力了。
13类的方法第一个参数必须是self,而静态方法第一个参数必须是cls。
七编码建议
1编码中考虑到其他python实现的效率等问题,比如运算符‘+'在CPython(Python)中效率很高,都是Jython中却非常低,所以应该采用.join()的方式。
2尽可能使用‘is'‘isnot'取代‘==',比如ifxisnotNone要优于ifx。
3使用基于类的异常,每个模块或包都有自己的异常类,此异常类继承自Exception。
4异常中不要使用裸露的except,except后跟具体的exceptions。
5异常中try的代码尽可能少。比如:
try:
value=collection[key] exceptKeyError: returnkey_not_found(key) else: returnhandle_value(value)
要优于
try:
#Toobroad! returnhandle_value(collection[key]) exceptKeyError: #WillalsocatchKeyErrorraisedbyhandle_value() returnkey_not_found(key)
6使用startswith()andendswith()代替切片进行序列前缀或后缀的检查。比如
Yes:iffoo.startswith(‘bar'):优于
No:iffoo[:3]==‘bar':
7使用isinstance()比较对象的类型。比如
Yes:ifisinstance(obj,int):优于
No:iftype(obj)istype(1):
8判断序列空或不空,有如下规则
Yes:ifnotseq:
ifseq:
优于
No:iflen(seq)
ifnotlen(seq)
9字符串不要以空格收尾。
10二进制数据判断使用ifboolvalue的方式。
以上就是在pytho开发过程中的一些注意的点!