代码风格

Python代码风格指南(三)命名约定(PEP8中文翻译)

命名约定(Naming Conventions)

Python标准库的命名约定有一些混乱,因此我们永远都无法保持一致。但如今仍然存在一些推荐的命名标准。新的模块和包(包括第三方框架)应该采用这些标准,但若是已经存在的包有另一套风格的话,还是应当与原有的风格保持内部一致。

重写原则(Overriding Principle)

对于用户可见的公共部分API,其命名应当表达出功能用途而不是其具体的实现细节。

描述性:命名风格(Descriptive: Naming Styles)

存在很多不同的命名风格,最好能够独立地从命名对象的用途认出采用了哪种命名风格。

以下是常用于区分的命名风格:

Python代码风格指南(二)字符串引用、空格、注释和版本注记(PEP8中文翻译)

字符串引用(String Quotes)

在Python中表示字符串时,不管用单引号还是双引号都是一样的。但是不推荐将这两种方式看作一样并且混用。最好选择一种规则并坚持使用。当字符串中包含单引号时,采用双引号来表示字符串,反之也是一样,这样可以避免使用反斜杠,代码也更易读。

对于三引号表示的字符串,使用双引号字符来表示(译注:即用"""而不是'''),这样可以和PEP 257的文档字符串(docstring)规则保持一致。

表达式和语句中的空格(Whitespace in Expressions and Statements)

Python代码风格指南(一)代码设计(PEP8中文翻译)

翻译自:PEP 8 - Style Guide for Python Code

介绍(Introduction)

这篇文档说明了Python主要发行版中标准库代码所遵守的规范。请参考实现Python的C代码风格指南信息PEP。

这篇文档和PEP 257(Docstring Conventions)都改编自Guido(译注:Python之父)最早的Python风格指南文章,并加入了Barry风格指南里的内容。

语言自身在发生着改变,随着新的规范的出现和旧规范的过时,代码风格也会随着时间演变。

很多项目都有自己的一套风格指南。若和本指南有任何冲突,应该优先考虑其项目相关的那套指南。