本文给出主Python版本标准库的编码约定。CPython的C代码风格参见PEP7。
本文和PEP 257 文档字符串标准改编自Guido最初的《Python Style Guide》, 并增加了Barry的GNU Mailman Coding Style Guide的部分内容。
本文会随着语言改变等而改变。
许多项目都有自己的编码风格指南,冲突时自己的指南为准。
一致性考虑
Guido的关键点之一是:代码更多是用来读而不是写。本指南旨在改善Python代码的可读性,即PEP 20所说的“可读性计数"(Readability counts)。
风格指南强调一致性。项目、模块或函数保持一致都很重要。
最重要的是知道何时不一致, 有时风格指南并不适用。当有疑惑时运用你的最佳判断,参考其他例子并多问!
特别注意:不要因为遵守本PEP而破坏向后兼容性!
部分可以违背指南情况:
-
遵循指南会降低可读性。
-
与周围其他代码不一致。
-
代码在引入指南完成,暂时没有理由修改。
-
旧版本兼容。
代码布局
缩进
每级缩进用4个空格 …
read more