作为自豪的程序员,碰到键盘不免就high了起来。不过呢编程语言不仅是个人的技术发挥,也是团队艺术,所以在项目中共同遵循一套编码规范是十分必要的。这里整理了我在工作中会尽量去遵循的原则,也希望合作者也能共同遵循。

PEP8 Python 编码规范
这篇文档以及PEP 257(文档字符串的规范)改编自Guido原始的《Python Style Guide》一文。

Code lay-out 代码布局
Indentation 缩进

每一级缩进使用4个空格。

续行应该与其包裹元素对齐,要么使用圆括号、方括号和花括号内的隐式行连接来垂直对齐,要么使用挂行缩进对齐3。当使用挂行缩进时,应该考虑到第一行不应该有参数,以及使用缩进以区分自己是续行。

推荐:

推荐:

# 与左括号对齐
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)

# 挂行缩进应该再换一行
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)

四空格的规则对于续行是可选的。