python命名规则 PEP8编码规则(约定俗成)

python命名规则 PEP8编码规则(约定俗成)

20150408 Chenxin
20181030 update
文件名 myfile.py
全小写,可使用下划线

包 mypackage 模块 mymodule
应该是简短的、小写的名字。如果下划线可以改善可读性可以加入。

类 class MyClass
总是使用首字母大写单词串。内部类可以使用额外的前导下划线。比如类似 类使用ClassWords的方式，模块内部使用的类采用_ClassWords的方式。
类的属性（方法和变量）命名使用全部小写的方式，可以使用下划线。
类的属性有3种作用域public、non-public和subclass API
类的属性若与关键字名字冲突，后缀一下划线，尽量不要使用缩略等其他方式。
为避免与子类属性命名冲突，在类的一些属性前，前缀两条下划线。比如：类Foo中声明__a,访问时，只能通过Foo._Foo__a，避免歧义。

函数与方法 my_function
函数名应该为小写，可以用下划线风格单词以增加可读性。如：myfunction，my_example_function。

函数和方法的参数 self cls test_
使用“self”作为实例方法的第一个参数。
使用“cls”作为类方法的第一个参数(也就是静态方法第一个参数必须是cls)
如果一个函数的参数名称和保留的关键字冲突，通常使用一个后缀下划线好于使用缩写或奇怪的拼写。如 args_ ,test_

全局变量
对于from M import X 导入语句.
全局变量尽量只在模块内有效，类似C语言中的static。实现方法有两种，一是__all__机制;二是前缀一个下划线。

变量 color
变量名全部小写，由下划线连接各个单词。如color = WHITE，this_is_a_variable = 1
注意：
1.不论是类成员变量还是全局变量，均不使用 m 或 g 前缀。
2.私有类成员使用单一下划线前缀标识，多定义公开成员，少定义私有成员。
3.变量名不应带有类型信息，因为Python是动态类型语言.如 iValue、names_list、dict_obj 等都是不好的命名。

常量 TOTAL
常量命名使用全部大写的方式，可以使用下划线如MAX_OVERFLOW，TOTAL。

异常
以“Error”作为后缀。即CapWords+Error后缀的方式。

缩写 ExampleFunc
命名应当尽量使用全拼写的单词，缩写的情况有如下两种：
1.常用的缩写，如XML、ID等，在命名时也应只大写首字母，如XmlParser。
2.命名中含有长单词，对某个单词进行缩写。这时应使用约定成俗的缩写方式。例如：function 缩写为 fn object 缩写为 obj

文档描述
1 为所有的共有模块、函数、类、方法写docstrings；非共有的没有必要，但是可以写注释（在def的下一行）。
2 如果docstring要换行，参考如下例子
"""Return a foobang
Optional plotz says to frobnicate the bizbaz first.
"""

注释
总体原则，错误的注释不如没有注释。所以当一段代码发生变化时，第一件事就是要修改注释！
1.块注释，在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。块注释还可以用文档描述的方式 ''' xxx(xxx可以多行) '''
2.行注释，在一句代码后加注释。比如：x = x + 1 # Increment x 但是这种方式尽量少使用。
3.避免无谓的注释。

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

代码编排
1 缩进。4个空格的缩进。
2 每行最大长度79，换行可以使用反斜杠""，最好使用圆括号。换行点要在操作符的后边敲回车。
3 类和top-level函数定义之间空两行；类中的方法定义之间空一行；函数内逻辑无关段落之间空一行；其他地方尽量不要再空行。

文档编排
不要在一句import中多个库，比如import os, sys不推荐。
如果采用from XX import XX引用库，可以省略‘module.’，都是可能出现命名冲突，这时就要采用import XX。

其他建议(优化)
1 避免单独使用小写字母‘l’，大写字母‘O’容易混淆的字母。

2 编码中考虑到其他类型python实现的效率问题，比如运算符‘+’在CPython（Python）中效率很高，Jython中却非常低，所以应该采用.join()的方式。

3 尽可能使用‘is’‘is not’取代‘==’，比如if x is not None 要优于if x。

4 使用基于类的异常，每个模块或包都有自己的异常类，此异常类继承自Exception。

5 异常中不要使用裸露的except，except后跟具体的exceptions。

6 异常中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)

7 使用startswith() and endswith()代替切片进行序列前缀或后缀的检查。比如：
Yes: if foo.startswith('bar'):优于
No: if foo[:3] == 'bar':

8 使用isinstance()比较对象的类型。比如
Yes: if isinstance(obj, int): 优于
No: if type(obj) is type(1):

9 判断序列空或不空，有如下规则
Yes: if not seq:
if seq:
优于
No: if len(seq)
if not len(seq)

10 字符串不要以空格收尾。

11 二进制数据判断使用 if boolvalue的方式。