PEP8中文翻译
什么是PEP
PEP是PythonEnhancementProposal的缩写,翻译过来就是Python增强建议书。
PEP8
译者:本文基于2013-08-02最后修改的PEP8版本翻译,若要查看英文原文,请参考>>>>PEP8
简介
本文档给出的编码约定,来源于Python主发行版标准库中的代码。Python的C语言实现所使用的C语言风格指南,请参考>>>>PEP7。
本文档与PEP257(文档字符串规范)都来自于Guido>>>>1的PythonStyleGuido论文原文,另外有来自>>>>Barry'sstyleguide的补充。
随着Python语言自身的改变,本指南也在持续演进,新的编码约定被认同,而旧的矣被废弃。
许多项目都有一套专有的编码风格指南,当冲突发生时,应以项目编码规范为优先。
愚蠢的一致性就像没有脑子的妖怪
Guido的一个核心观点认为,相比于被编写,代码更多的是被阅读。这篇指南意在提高代码的可读性并使之在广袤的Python编码中保持风格一致。就像PEP20所表述的,“可读性当被重视>>>>2”.
风格指南即一致性指南。本文档中描述的一致性是重要的,一个项目内代码的一致性则更重要一些,而一个模块或方法中代码的一致性则是最重要的。
但最终要的是:知道什么时候去打破一致性—风格指南并不总是适用。当存在不确定性时,做出你最好的抉择。你可以看看别人的代码是怎么写的,选择一种看起来最好的,并及时发问!
特别注意:不要为了遵守本PEP而破坏代码的向后兼容性!
当以下情况发生时,也是忽略某个风格指南的好理由:
当遵守指南会降低代码可读性,甚至对于那些依循PEP去阅读代码的人也是这样时。当遵守指南会与其他部分的代码风格背离时—当然也许这是一个修正某些混乱代码的机会。
当那些并没有遵循指南的旧代码已无法修改时。当你的代码需要与旧版本的Python保持兼容,而旧版本的Python不支持指南中提到的特性时。
代码布局
缩进
每次缩进使用4个空格。
续行>>>>3应该与被圆括号、方括号、花括号包裹起来的其他元素对齐,或者使用悬挂式缩进。当使用悬挂式缩进时,应该遵循这些注意事项:第一行不能有参数,应该使用进一步的缩进来将续行与其他行区分开。符合本约定的代码:
>>>>>#Alignedwithopeningdelimiter
foo=long_function_name(var_one,var_two>>>>>,var_three,var_four
#Moreindentationincludedtodistinguishthisfromtherest.deflong_function_name(
var_one,var_two,var_three,var_four:print(var_one