pep8 python 编码规范_PEP8 Python 编码规范

PEP8 Python

编码规范

1

代码编排

1.1

缩进。

4

个空格的缩进（编辑器都可以完成此功能）

，不使用

Tap

，更不能混合使

用

Tap

和空格。

1.2

每行最大长度

79

，

换行可以使用反斜杠，

最好使用圆括号。

换行点要在操作符的

后边敲回车。

1.3

类和

top-level

函数定义之间空两行；

类中的方法定义之间空一行；

函数内逻辑无

关段落之间空一行；其他地方尽量不要再空行。

2

文档编排

2.1

模块内容的顺序：模块说明和

docstring

—

import

—

globals&constants

—其他定义。

其中

import

部分，又按标准、三方和自己编写顺序依次排放，之间空一行。

2.2

不要在一句

import

中多个库，比如

import os, sys

不推荐。

2.3

如果采用

from XX import XX

引用库，可以省略‘

module.

’

，都是可能出现命名冲

突，这时就要采用

import XX

。

3

空格的使用

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

3.1

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

3.2

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

3.3

函数的左括号前不要加空格。如

Func(1)

。

3.4

序列的左括号前不要加空格。如

list[2]

。

3.5

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

3.6

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

3.7

不要将多句语句写在同一行，尽管使用‘；

’允许。

3.8

if/for/while

语句中，即使执行语句只有一句，也必须另起一行。

4

注释

总体原则，

错误的注释不如没有注释。

所以当一段代码发生变化时，

第一件事就

是要修改注释！注释必须使用英文，最好是完整的句子，首字母大写，句后要有

结束符，结束符后跟两个空格，开始下一句。如果是短语，可以省略结束符。

4.1

块注释，在一段代码前增加的注释。在‘

#

’后加一空格。段落之间以只有‘

#

’

的行间隔。比如：

# Description : Module config.

#

# Input : None

#

# Output : None

4.2

行注释，在一句代码后加注释。比如：

x = x + 1

# Increment x

但是这种方式尽量少使用。

4.3

避免无谓的注释。