Python常用PEP8编码规范和建议经验分享

缩进

每级缩进用4个空格。

括号中使用垂直隐式缩进或使用悬挂缩进。

EXAMPLE:
# (垂直隐式缩进)对准左括号
foo = long_function_name(var_one, var_two,
var_three, var_four)

# (悬挂缩进) 一般情况只需多一层缩进
foo = long_function_name(
var_one, var_two,
var_three, var_four)

# (悬挂缩进) 但下面情况, 需再加多一层缩进， 和后续的语句块区分开来
def long_function_name(
var_one, var_two, var_three,
var_four):
print(var_one)

# 右括号回退
my_list = [
1, 2, 3,
4, 5, 6,
]
result = some_function_that_takes_arguments(
'a', 'b', 'c',
'd', 'e', 'f',
)

错误示范:
# 不使用垂直对齐时，第一行不能有参数。
foo = long_function_name(var_one, var_two,
var_three, var_four)

# 参数的悬挂缩进和后续代码块缩进不能区别。
def long_function_name(
var_one, var_two, var_three,
var_four):
print(var_one)

# 右括号不回退，不推荐
my_list = [
1, 2, 3,
4, 5, 6,
]

result = some_function_that_takes_arguments(
'a', 'b', 'c',
'd', 'e', 'f',
)

最大行宽

每行最大行宽不超过 79 个字符

一般续行可使用反斜杠

括号内续行不需要使用反斜杠

EXAMPLE:
# 无括号续行， 利用反斜杠
with open('/path/to/some/file/you/want/to/read') as file_1, \
open('/path/to/some/file/being/written', 'w') as file_2:
file_2.write(file_1.read())

# 括号内续行， 尽量在运算符后再续行
class Rectangle(Blob):

def __init__(self, width, height,
color='black', emphasis=None, highlight=0):
if (width == 0 and height == 0 and
color == 'red' and emphasis == 'strong' or
highlight > 100):
raise ValueError("sorry, you lose")
if width == 0 and height == 0 and (color == 'red' or
emphasis is None):
raise ValueError("I don't think so -- values are %s, %s" %
(width, height))

空行

两行空行用于分割顶层函数和类的定义

单个空行用于分割类定义中的方法

EXAMPLE:
# 类的方法定义用单个空行分割，两行空行分割顶层函数和类的定义。
class A(object):
def method1():
pass

def method2():
pass

def method3():
pass

模块导入

导入的每个模块应该单独成行

导入顺序如下: (各模块类型导入之间要有空行分割，各组里面的模块的顺序按模块首字母自上而下升序排列)

标准库
相关的第三方库
本地库

EXAMPLE:
# 按模块首字母排序导入, 依此递推
import active
import adidas
import create

错误示例:
# 一行导入多模块
import sys, os, knife

# 不按首字母导入
import create
import active
import beyond

字符串

单引号和双引号作用是一样的，但必须保证成对存在，不能夹杂使用.
(建议句子使用双引号, 单词使用单引号, 但不强制.)

EXAMPLE:
# 单引号和双引号效果一样
name = 'JmilkFan'
name = "Hey Guys!"

表达式和语句中的空格
括号里边避免空格

EXAMPLE:
spam(ham[1], {eggs: 2})

错误示例:
spam( ham[ 1 ], { eggs: 2 } )

逗号，冒号，分号之前避免空格

EXAMPLE:
if x == 4: print x, y; x, y = y, x

错误示例:
if x == 4 : print x , y ; x , y = y , x

函数调用的左括号之前不能有空格

EXAMPLE:
spam(1)
dct['key'] = lst[index]

错误示例:
spam (1)
dct ['key'] = lst [index]

赋值等操作符前后不能因为对齐而添加多个空格

EXAMPLE:
x = 1
y = 2
long_variable = 3

错误示例:
x = 1
y = 2
long_variable = 3

二元运算符两边放置一个空格
涉及 = 的复合操作符 ( += , -=等)
比较操作符 ( == , < , > , != , <> , <= , >= , in , not in , is , is not )
逻辑操作符( and , or , not )

EXAMPLE:
a = b
a or b

# 括号内的操作符不需要空格
name = get_name(age, sex=None, city=Beijing)

注释

注释块
注释块通常应用在代码前，并和代码有同样的缩进。每行以 ‘# ’ 开头, 而且#后面有单个空格。

EXAMPLE:
# Have to define the param `args(List)`,
# otherwise will be capture the CLI option when execute `python manage.py server`.
# oslo_config: (args if args is not None else sys.argv[1:])
CONF(args=[], default_config_files=[CONFIG_FILE])

单行注释(应避免无谓的注释)

EXAMPLE:
x = x + 1 # Compensate for border

文档字符串