python编码一致性规范

《python编码一致性规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、Python编码一致性规范Python编码一致性规范1什么是PEP1PEP81简介1愚蠢的一致性就像没有脑子的妖怪2代码布局2缩进3制表符还是空格4单行最大长度4空白行6源文件编码6导入6表达式与语句中的空白符8小问题8其他建议10注释11块注释11行内注释12文档字符串12版本注记12本文仅代表个人认知、观点、经验，MaybeStupid!什么是PEPPEP是 PythonEnhancementProposal 的缩写，翻译过来就是 Python增强建议书 。PEP8译者：本文基于2013-0

2、8-02最后修改的PEP8版本翻译，若要查看英文原文，请参考PEP8简介本文档给出的编码约定，来源于Python主发行版标准库中的代码。Python的C语言实现所使用的C语言风格指南，请参考PEP7。本文档与PEP257（文档字符串规范）都来自于Guido1) 的 PythonStyleGuido 论文原文，另外有来自 Barry'sstyleguide 的补充。随着Python语言自身的改变，本指南也在持续演进，新的编码约定被认同，而旧的矣被废弃。许多项目都有一套专有的编码风格指南，当冲突发生

3、时，应以项目编码规范为优先。愚蠢的一致性就像没有脑子的妖怪Guido的一个核心观点认为，相比于被编写，代码更多的是被阅读。这篇指南意在提高代码的可读性并使之在广袤的Python编码中保持风格一致。就像PEP20所表述的，“可读性当被重视2)”.风格指南即一致性指南。本文档中描述的一致性是重要的，一个项目内代码的一致性则更重要一些，而一个模块或方法中代码的一致性则是最重要的。但最终要的是：知道什么时候去打破一致性—风格指南并不总是适用。当存在不确定性时，做出你最好的抉择。你可以看看别人的代码是怎么

4、写的，选择一种看起来最好的，并及时发问！特别注意：不要为了遵守本PEP而破坏代码的向后兼容性!当以下情况发生时，也是忽略某个风格指南的好理由：§当遵守指南会降低代码可读性，甚至对于那些依循PEP去阅读代码的人也是这样时。§§当遵守指南会与其他部分的代码风格背离时—当然也许这是一个修正某些混乱代码的机会。§§当那些并没有遵循指南的旧代码已无法修改时。§§当你的代码需要与旧版本的Python保持兼容，而旧版本的Python不支持指南中提到的特性时。§代码布局缩进每次缩进使用4个空格。续行3)应该与被

5、圆括号、方括号、花括号包裹起来的其他元素对齐，或者使用悬挂式缩进。当使用悬挂式缩进时，应该遵循这些注意事项：第一行不能有参数，应该使用进一步的缩进来将续行与其他行区分开。符合本约定的代码：#Alignedwithopeningdelimiter foo=long_function_name(var_one,var_two, var_three,var_four)  #Moreindentationincludedtodistinguishthisfromtherest.deflong_funct

6、ion_name( var_one,var_two,var_three, var_four): print(var_one)不符合本约定的代码：#Argumentsonfirstlineforbiddenwhennotusingverticalalignment foo=long_function_name(var_one,var_two, var_three,var_four)  #Furtherindentationrequiredasindentationisnotdistinguisha

7、bledeflong_function_name( var_one,var_two,var_three, var_four): print(var_one)可选的符合约定的代码：#Extraindentationisnotnecessary. foo=long_function_name( var_one,var_two, var_three,var_four)结尾的方括号/圆括号/花括号应该被放置在多行内容的最后一行的第一个非空字符的正下方4)，如下所示：my_list=[ 1,2,3, 4,

8、5,6, ] result=some_function_that_takes_arguments( 'a','b','c', 'd','e','f', )或者被放置在多行内容的起始行的第一个字符的正下方5)，如下所示：my_list=[ 1,2,3, 4,5,6,] result=some_function_that_takes_arguments( 'a','b','c', 'd','e','f',)制表符还是空格空格是首选的缩进方式。为了保持一致性，在使用了制表符作为缩进的代码中，应该保持使