PEP 8 Python代码规范

介绍

该文档为Python代码编写了代码约定，其中包含了主Python发行版中的标准库。在Python的C实现中，请参阅关于C代码的参考信息PEP描述样式指南[1]。

本文档和PEP 257(Docstring约定)是根据圭多最初的Python风格指导文章改编的[2]。

随着时间的推移，这种风格指南随着时间的推移而不断演变，而过去的约定已经被语言本身的变化所淘汰

许多项目都有自己的编码风格指南。在任何冲突的情况下，此类项目特定的指南优先于该项目。

愚蠢的一致性是小思想的妖怪

吉多的一个关键的见解是，代码读起来比写得多。这里提供的指导方针旨在提高代码的可读性，并使其在Python代码的广泛范围内保持一致。正如PEP 20所说，“可读性很重要”

风格指南是关于一致性的。与此风格指南的一致性很重要。项目中的一致性更重要。一个模块或函数的一致性是最重要的。

然而，要知道什么时候不一致——有时候，风格指南的建议是不适用的。当有疑问时，运用你最好的判断力。看看其他的例子并决定什么是最好的。别犹豫，尽管问!

特别地:不要破坏向后兼容性只是为了遵守这个PEP !

忽略某个特定指导方针的其他一些好的理由:

当应用该指南时，代码的可读性就会降低，甚至对于那些习惯于阅读此PEP的代码的人来说也是如此。

与周围的代码保持一致(可能是出于历史原因)——尽管这也是一个清理他人混乱的机会(在真正的XP风格中)。

因为问题的代码提前了指导方针的介绍，所以没有其他理由修改该代码。

当代码需要与较老版本的Python兼容时，不支持样式指南推荐的特性。

代码布局

缩进

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

延拓行应该用Python的隐式行连接在括号、括号和括号内，或者使用悬挂的缩进[7]来对齐包装元素。当使用悬挂式缩进时，应考虑以下事项;在第一行中不应该有任何参数，并且应该使用进一步的缩进来清楚地将自己区分为一条延线。

是的:

# 与开放分隔符对齐。
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)

No:

# 当不使用垂直对齐时，第一行的参数是禁止的。
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)

4空间规则是可选的延续行。

可选:

# 悬挂的缩进*可以缩进4个空格内。
foo = long_function_name(
  var_one, var_two,
  var_three, var_four)