Python风格规范

本文代码规范来自Python风格规范 - Google 开源项目风格指南

1、行长度

每一行一般不超过80个字符
注意 url【必要时，可单独一行】，长的导入模块 一般不换行
可使用圆括号，中括号，花括号来完成换行，比如用圆括号完成字符串的换行
with表达式，使用三个及以上上下文管理器时，可以使用反斜杠换行，否则使用嵌套的形式

2、括号

宁缺毋滥
除非是需要实现行连接，否则不要在返回语句或者条件语句中使用括号
元组可以使用括号

3、缩进

使用4个空格进行缩进，不要使用tab 也不要 tab和缩进混用
在换行情况下只有两种使用方式：
第一行有参数，则后续参数跟第一行垂直对齐
第一行无参数，则后续参数使用4个空格的悬挂缩进

4、序列元素尾部逗号

在圆括号，中括号，花括号中的与最后一个元素不在同一行时，推荐在最后一个元素最后使用逗号（yape可将序列中的每一项元素都格式化为单独一行）

5、空行

顶级定义（函数，类）之间空两行
方法定义之间空一行
在函数或者方法内部，如果合适也可以空一行

6、空格

不要在括号内侧使用空格
标点符号：不要在逗号，冒号，分号左侧加空格，应该在右侧加，行尾除外
索引，切片，参数列表 左括号前不需要加空格
二元操作符左右两侧都加一个空格
等号有两种情况需要注意：
用于指示关键字参数或者默认参数列表 不需要在两侧加空格
但若存在类型注释的时候，需要在左右两侧加空格
不需要使用空格来对其多行之间的标记

7、注释

对模块，函数，方法，增加文档字符串
如果函数是外部不可见，非常短小清晰，可以不加注释
函数注释包括，作用，参数[名称，描述]，返回值[类型，语义]，异常
类注释，类描述文档字符串，公有属性描述段
块注释，行注释，注释应该离开代码两个空格
文档字符串
使用三个引号，后面跟一句描述，后面跟一个空格，最后增加注释的其他部分（与三个引号的第一个对齐）

8、类

如果类没有继承的父类，就显示的继承object类

9、字符串

+，%，格式化字符串 思量之后选择
尽量不要在循环中，使用+，+=来累加字符串，会创建不必要的临时变量。可以将每个字串加入列表中，最后使用join连接列表
在同一个文件中，引用字符串中尽量风格统一，只使用双引号，或者只使用单引号
多行字符串使用三重双引号

10、TODO注释

格式：TODO（名字/email）：待做
可以加日期

11、导入

文件顶部，模块注释，文档字符串之后
从常见到不常见顺序
future
标准库
第三方库
本地代码包
每个分组中，导入应该按照字典序排序