意淫系列-Python 编码规范(Google)

意淫系列-Python 编码规范(Google)

Python 风格规范，是编写Python时高效性能的一个体现。写几点比较常用，且会常常犯的错误

空行

顶级定义之间空两行，方法定义之间空一行

注释

确保对模块，函数，方法和行内注释使用正确的风格

文档字符串

Python有一种独一无二的注释方式：使用文档字符串。文档字符串是包，模块，类或者函数里的第一个语句。这些字符串可以通过对象的__doc__成员被自动提取，并且被pydoc使用。

模块

每个文件应该包含一个许可样本。根据项目使用的许可选择合适的样版

函数和方法

一个函数必须要有稳定字符串，除非它满足一下条件：

1，外部不可见

2，非常小

3，简单明了

每个注释需要包含如下资料：

Args:

列出每个参数的名字, 并在名字后使用一个冒号和一个空格, 分隔对该参数的描述.如果描述太长超过了单行80字符,使用2或者4个空格的悬挂缩进(与文件其他部分保持一致). 描述应该包括所需的类型和含义. 如果一个函数接受*foo(可变长度参数列表)或者**bar (任意关键字参数), 应该详细列出*foo和**bar.

Returns: (或者 Yields: 用于生成器)

描述返回值的类型和语义. 如果函数返回None, 这一部分可以省略.

Raises:

列出与接口有关的所有异常.

例子

def fetch_bigtab