PEP8代码规范中文版 .pdf

Introduction介绍

本文提供的Python代码编码规范基于Python主要发行版本的标准库。Pyt

hon的C语言实现的C代码规范请查看相应的PEP指南。

这篇文档以及PEP257（文档字符串的规范）改编自Guido原始的《Pyth

onStyleGuide》一文，同时添加了一些来自Barry的风格指南。

这篇规范指南随着时间的推移而逐渐演变，随着语言本身的变化，过去的约

定也被淘汰了。

许多项目有自己的编码规范，在出现规范冲突时，项目自身的规范优先。

AFoolishConsistencyistheHobgobli

nofLittleMinds尽信书,则不如无书

Guido的一条重要的见解是代码阅读比写更加频繁。这里提供的指导原则主

要用于提升代码的可读性，使得在大量的Python代码中保持一致。就像PEP

20提到的，“Readabilitycounts”。

这是一份关于一致性的风格指南。这份风格指南的风格一致性是非常重要的。

更重要的是项目的风格一致性。在一个模块或函数的风格一致性是最重要的。

然而，应该知道什么时候应该不一致，有时候编码规范的建议并不适用。当

存在模棱两可的情况时，使用自己的判断。看看其他的示例再决定哪一种是最好

的，不要羞于发问。

特别是不要为了遵守PEP约定而破坏兼容性！

几个很好的理由去忽略特定的规则：

1.当遵循这份指南之后代码的可读性变差，甚至是遵循PEP规范的人也觉得可读性差。

2.与周围的代码保持一致（也可能出于历史原因），尽管这也是清理他人混乱（真正的

XtremeProgramming风格）的一个机会。

3.有问题的代码出现在发现编码规范之前，而且也没有充足的理由去修改他们。

4.当代码需要兼容不支持编码规范建议的老版本Python。

Codelay-out代码布局

Indentation缩进

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

续行应该与其包裹元素对齐，要么使用圆括号、方括号和花括号内的隐式行

连接来垂直对齐，要么使用挂行缩进对齐。当使用挂行缩进时，应该考虑到第一

行不应该有参数，以及使用缩进以区分自己是续行。

推荐：

#与左括号对齐

foo=long_function_name(var_one,var_two,

var_three,var_four)

#用更多的缩进来与其他行区分

deflong_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)

#当缩进没有与其他行区分时，要增加缩进

deflong_function_name(

var_one,var_two,var_three,

var_four):

print(var_one)

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

可选：

#挂行缩进不一定要用4个空格

foo=long_function_name(

var_one,var_two,

var_three,var_four)

当if语句的条件部分长到需要换行写的时候，注意可以在两个字符关键字的

连接处（比如if），增加一个空格，再增加一个左括号来创造一个4空格缩进的

多行条件。这会与if语句内同样使用4空格缩进的代码产生视觉冲突。PEP没

有明确指明要如何区分i发的条件代码和内嵌代码。可使用的选项包括但不限于

下面几种情况：

#没有额外的缩进

if(this_is_one_thingand

that_is_another_thing):

do_something()

#增加一个注释，在能提