python编程规范 _原创文档.pdfVIP

python编程规范

PEP8是Python官网指导推荐的编程规范，OpenStack等项目都

遵循它。上元也要求严格遵循该规范。本文中附着了PEP8原文，同时

附带一篇中文翻译稿。推荐使用PyChram编辑python代码，它可自

动提示那些不满足编程规范的代码,PyChram已经默认导入PEP8规

范。如果已经习惯用Eclipse的PyDev，可以用文中附件--pep8检测

工具检测自己的代码是否符合PEP8规范。

目录

1.代码编排3

1.1.缩进3

1.2.每行最大长度794

1.3.空行规则5

1.4.编码方式5

1.5.Import5

2.空格的使用6

2.1.各种右括号前不要加空格6

2.2.逗号、冒号、分号前不要加空格，在他们后面加7

2.3.参数列表,索引或切片的左括号前不应加空格7

2.4.在二元操作符两边都加上一个空格7

2.5.在算术运算符前后加空格7

2.6.不要在一个关键字参数或者一个缺省参数值的=符号前后加

一个空格8

2.7.通常不推荐使用复合语句（一行代码中有多条语句）8

2.8.通常情况下，一行代码包括一个小的if/for/while块，是可以

的。但是多子句绝不可以。同样，需要避免折叠类似的长代码行！8

3.注释9

3.1.块注释9

3.2.行注释9

3.3.文档描述9

4.命名规范10

4.1.命名风格10

4.2.避免使用的名字11

4.3.包和模块名称11

4.4.类名12

4.5.Exception名12

4.6.全局变量名12

4.7.函数(Function)名12

4.8.函数(Function)和方法(Method)参数12

4.9.方法(Method)名和实例变量13

4.10.常量13

4.11.继承设计13

5.编码建议14

6.上元特殊规定17

7.Python代码总体结构18

8.原文（英文版）19

9.检测工具20

9.1.PyCharm中自带PEP8的检测，点击右边匡的黄色字体即可

看到提示20

9.2.用pep8工具检测20

9.3.用pylint工具检测20

1.代码编排

1.1.缩进

4个空格的缩进（编辑器都可以完成此功能），不使用Tap，更不

能混合使用Tap和空格。

以下是带括号的一些缩进原则。

Yes:

#和括号开始的部分对齐

foo=long_function_name(var_one,var_two,

var_three,var_four)

No:

#禁止对齐下一层的代码

foo=long_function_name(var_one,var_two,

var_three,var_four)

No:

#需要进一层的缩进，区分下一层的代码

deflong_function_name(

var_one,var_two,var_three,

var_four):

print(var_one)

如果if语句占用多行，推荐不需要特殊的缩进

#不需要特殊的缩进

if(this

andthat):

do_something()

在闭合的括号中，后面的括号对齐变量名：

my_list=[

1,2,3,

4,5,6,

]

result=some_function_that_takes_arguments(