PEP8 Python 编码规范

 

代码编排

缩进

4个空格的缩进（编辑器都可以完成此功能），尽量不要使用Tab键，更不能混合使用Tab键和空格。

行宽

每行最大长度79，换行可以使用反斜杠，最好使用小括号“()”。换行点要在操作符的后边。

空行

类和顶级函数定义之间空两行；类中的方法定义之间空一行；函数内逻辑无关段落之间空一行；其他地方尽量不要再空行。

文档编排

1．模块内容的顺序

模块内容的顺序为：文档字符串—>导入（import）—>全局变量或者常量—>其他定义。

其中导入（import）部分，又按“标准模块、第三方和自己编写的模块”的顺序依次排放，模块之间空一行。

2．不要在一句import 中多个库，如import os, sys就不推荐使用。

3．采用from XX import XX 引用库

如果采用from XX import XX 引用库，那么可以不用指定具体的模块名，也就是可以省略“module.”，但是如果可能出现命名冲突，那就就不能采用from XX import XX的方式引用库了，而需要采用import XX的形式引用库。

空格的使用

　　总体原则，避免不必要的空格。

　　þ 各种右括号前不要加空格。

　　þ 逗号、冒号、分号前不要加空格。

　　þ 函数的左括号前不要加空格。如Func(1)。

　　þ 序列的左括号前不要加空格。如list[2]。

　　þ 操作符左右各加一个空格，不要为了对齐增加空格。

　　þ 函数默认参数使用的赋值符左右省略空格。

　　þ 不要将多句语句写在同一行，尽管允许使用分号“;”。

þ if/for/while 语句中，即使执行语句只有一句，也必须另起一行。

注释

错误的注释不如没有注释。所以当一段代码发生变化时，第一件事就是要修改注释。注释最好是完整的句子，首字母大写，句后要有结束符，结束符后跟两个空格，开始下一句。如果是短语，可以省略结束符。

1．块注释

在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。比如：

　　# Description : Module config.

　　#

　　# Input : None

　　#

　　# Output : None

2．行注释

在一句代码后加注释。比如：x = x + 1 # Increment x，但是尽量少使用这种方式。

3．避免无谓的注释。

文档描述

1．为所有的共有模块、函数、类、方法写文档字符串；非共有的没有必要，但是可以写注释（在def的下一行）。

2．如果文档字符串要换行，参考如下例子，详见PEP 257。

　　"""Return a foobang

　　Optional plotz says to frobnicate the bizbaz first.

　　"""

命名规范

　　总体原则，新编代码必须按下面命名风格进行，现有库的编码尽量保持风格。

　　þ 尽量单独使用小写字母‘l’，大写字母‘O’等容易混淆的字母。

　　þ 模块命名尽量短小，使用全部小写的方式，可以使用下划线。

　　þ 包命名尽量短小，使用全部小写的方式，不可以使用下划线。

　　þ 类的命名使用CapWords的方式，模块内部使用的类采用_CapWords的方式。

　　þ 异常命名使用CapWords+Error后缀的方式。

　　þ 全局变量尽量只在模块内有效，类似C语言中的static。实现方法有两种，一是采用__all__机制；二是使用一个下划线前缀。

　　þ 函数命名使用全部小写的方式，可以使用下划线。

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

　　þ 类的属性（方法和变量）命名使用全部小写的方式，可以使用下划线。

　　þ 类的属性若与关键字名字冲突，后缀一下划线，尽量不要使用缩略等其他方式。

　　þ 为避免与子类属性命名冲突，在类的一些属性前，前缀两条下划线。如：Foo类中声明__a,访问时，只能通过Foo._Foo__a，避免歧义。如果子类也叫Foo，那就无能为力了。

　　þ 类的方法第一个参数必须是self，而静态方法第一个参数必须是cls。

编码建议

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

2．尽可能使用“is”“is not”取代“==”，如if x is not None 要优于if x。

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

4．异常中不要使用裸露的except，并且except后面是具体的exceptions。

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

6．使用startswith() and endswith()代替切片进行序列前缀或后缀的检查。如：

if foo.startswith('bar'):

优于

if foo[:3] == 'bar':

7．使用isinstance()比较对象的类型。比如

if isinstance(obj, int):

优于

if type(obj) is type(1):

8．判断序列空或不空，有如下规则：

if not seq:
if seq:

优于

if len(seq)
if not len(seq)

9．字符串不要以空格收尾。

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