Python编码规范(PEP8)
Introduction 介绍 本文提供的Python代码编码规范基于Python主要发行版本的标准库。Python的C语言实现的C代码规范请查看相应的PEP指南 1 。 这篇文档以及 PEP 257 (文档字符串的规范)改编自Guido原始的《Python Style Guide》一文,同时添加了一些来自Barry的风格指南 2 。 这篇规范指南随着时间的推移而逐渐演变,随着语言本身的变化,过去的约定也被淘汰了。 许多项目有自己的编码规范,在出现规范冲突时,项目自身的规范优先。 A Foolish Consistency is the Hobgoblin of Little Minds 尽信书,则不如无书 Guido的一条重要的见解是代码阅读比写更加频繁。这里提供的指导原则主要用于提升代码的可读性,使得在大量的Python代码中保持一致。就像 PEP 20 提到的,“Readability counts”。 这是一份关于一致性的风格指南。这份风格指南的风格一致性是非常重要的。更重要的是项目的风格一致性。在一个模块或函数的风格一致性是最重要的。 然而,应该知道什么时候应该不一致,有时候编码规范的建议并不适用。当存在 模棱两可 的情况时,使用自己的判断。看看其他的示例再决定哪一种是最好的,不要羞于发问。 特别是不要为了遵守PEP约定而破坏兼容性! 几个很好的理由去忽略特定的规则: