PEP8规范

目录

• 一 代码编排
• 二 文档编排
• 三 空格使用
• 四 注释
• 五 文档描述
• 六 命名规范
• 七 编码建议

---

代码编排

1缩进，4个空格，不用tab键（因为可能不同系统tab的空格数不一定）

2每行最大长度79，换行使用反斜杠，最好用圆括号

3类和top_level函数定义之间空两行；类中的方法之间空一行；函数内逻辑无关的段落之间空一行

二、文档编排

1.模块内容顺序：模块说明和docstring-import-globals&constants-其它定义。其中，import部分按照标准、三方、和自己编写顺序依次排放，之间空一行

2.不要在一句import中多个库

3.采用from xx import xx引用库

三、空格使用

1.右括号前不要空格

2.逗号、冒号、分号前不要空格

3.函数左括号前不要空格

4.序列的左括号前不要空格

5.操作符左右各加一个空格

6.函数默认参数使用赋值符左右省略空格

7.不要将多语句写在一行，尽管“；”允许

8.流程控制语句中，即使执行语句只有一句也必须另起一行

四、注释

1.代码发生变化时，第一件事就是修改注释

2.注释必须是英文，最好是完整的句子，首字母大写，句后要有结束符，结束符后跟两个空格，开始下一行。如果是短语可以省略结束符

3.块注释，在一段代码前增加注释。在#后加一个空格。段落之间只有#的行间隔

4.行注释，少用在一句代码后加注释的方式

5.避免无谓的注释

五、文档描述

为所有的共有模块、函数、类、方法写文档描述；不是共有的则没有必要，但是要写注释

六、命名规范

1尽量单独使用小写字母’i’，大写字母’I’等容易混淆的字母

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

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

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

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

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

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

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

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

9 类的属性有3种作用域public、non-public和subclass API，可以理解成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’‘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()代替切片进行序列前缀或后缀的检查。比如：

Yes:  if foo.startswith('bar'):优于

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

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

Yes:  if isinstance(obj, int): 优于

No:  if type(obj) is type(1):

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

Yes:  if not seq:

if seq:

优于

No:  if len(seq)

if not len(seq)

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

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