PEP 8 -- Python编码风格指南 中文版
英文原文:
https://www.python.org/dev/peps/pep-0008/
PEP: | 8 |
---|---|
Title: | Style Guide for Python Code |
Author: | Guido van Rossum, Barry Warsaw, Nick Coghlan |
Status: | Active |
Type: | Process |
Created: | 05-Jul-2001 |
Post-History: | 05-Jul-2001, 01-Aug-2013 |
自己尝试翻译成中文,速度缓慢…
介绍(Introduction)
本文档给出了Python主要发行版中标准库代码所遵守的编码规范。Python的C语言实现中的编码规范,请参考PEP编码风格指南。
本文档和PEP 257(Docstring约定)都是改编自Guido最初的Python风格指南文章,并补充了一些Barry的风格指南。
由于开发语言在不断的进化,所以本文当也会随着时间的变化添加新的约定或者修改过时的约定。
很多项目会有自己的风格指南。如果有一些和本指南冲突的地方,使用项目特定的指南优先于本指南。
墨守成规的做法是愚蠢的(A Foolish Consistency is the Hobgoblin of Little Minds)
Guido的主要观点之一就是:一段代码读的次数总是比编写的要多。本指南旨在提高代码的可读性,并且在各种Python代码中保持一致。和PEP 20所说的“可读性至关重要”有异曲同工之妙。
本指南是关于一致性的。 保持本指南的一致性很重要,保持项目的一致性更为重要, 保持一个模块或功能内的一致性则是最重要的。
然而,要知道什么时候可以不一致 —— 有的时候本指南是不适用的。当你有疑问的时候,请给出自己的最佳判断,查看其他例子确定最合适的方法。不要犹豫的去提出问题!
特别提示的是:不要仅仅为了遵守本PEP指南而破坏向后兼容性!
如果有以下原因,可以忽略本指南:
- 当应用指南时代码的可读性降低,即使对于那些习惯阅读遵循此PEP的代码的人来说也很难读的时候。
- 需要与其他代码保持一致,但是这些代码不符合本指南的时候(可能是出于历史原因)。虽然这也是收拾别人烂摊子的好机会(在真正的XP风格中)。
- 这段代码在引入指南之前编写的时候,可以不修改。
- 当代码需要与不支持风格指南建议功能的旧版Python保持兼容时。
代码布局(Code Lay-out)
缩进(Indentation)
每个缩进级别使用4个空格。
连续行所包装的元素应该要么采用Python隐式续行,即垂直对齐于圆括号、方括号和花括号,要么采用悬挂缩进(hanging indent)。采用悬挂缩进时需考虑以下两点:第一行不应该包括参数,并且在续行中需要再缩进一级以便清楚表示。
正确的例子:
# Aligned with opening delimiter.
foo = long_function_name(var_one, var_two,
var_three, var_four)
# Add 4 spaces (an extra level of indentation) to distinguish arguments from the rest.
def long_function_name(
var_one, var_two, var_three,
var_four):
print(var_one)
# Hanging indents should add a level.
foo = long_function_name(
var_one, var_two,
var_three, var_four)
错误的例子:
# Arguments on first line forbidden when not using vertical alignment.
foo = long_function_name(var_one, var_two,
var_three, var_four)
# Further indentation required as indentation is not distinguishable.
def long_function_name(
var_one, var_two, var_three,
var_four):
print(var_one)
对于连续行,4空格规则不是必须遵守的。
可选的例子:
# Hanging indents *may* be indented to other than 4 spaces.
foo = long_function_name(
var_one, var_two,
var_three, var_four)
上一篇: 关于&&和or的问题、希望有实例
下一篇: C#中泛型在Class上的实现