PEP: | 8 |
---|---|
标题: | Python 代码风格指南 |
作者: | Guido van Rossum |
状态: | 活动 |
类型: | 处理中 |
创建者: | 05 - 2001 年 7 月 |
之后的历史: | 2001年7月5日、2013年8月1日 |
内容
本文档提供了 Python 代码组合的编码约定,包括主要 Python 发行版中的标准库。请参阅随附的信息 PEP [1],描述 Python C 实现中 C 代码的样式指南。
本文档和 PEP 257(文档字符串约定)改编自 Guido 的原始 Python 风格指南文章,并添加了Barry风格指南 [2] 的一些内容。
随着时间的推移,这种风格指南会随着其他约定的建立而发生变化,而过去的约定也会随着语言本身的变化而变得过时。
许多项目都有自己的编码风格指南。如果发生任何冲突,此类特定于项目的指南应优先于该项目。
Guido 的一个重要见解是,代码的读取次数远多于编写次数。此处提供的指南旨在提高代码可读性并使其在各种 Python 代码中保持一致。如 PEP 20“可读性计数”中所述。
风格指南注重一致性。与本风格指南保持一致非常重要。项目的一致性更为重要。模块或功能内的一致性是最重要的。
但是,知道何时要不一致 - 有时风格指南的建议并不适用。如有疑问,请运用您的最佳判断。查看其他示例并决定哪个看起来最好。不要犹豫,快来询问吧!
特别是:不要为了遵守此 PEP 而破坏向后兼容性!
忽略具体准则的其他一些充分理由: