Python▲Python 代码规范（命名、注释等）( 二 ) Python

模块级函数和类定义之间空两行；

类成员函数之间空一行；

可以使用多个空行分隔多组相关的函数
函数中可以使用空行分隔出逻辑相关的代码

3、import 语句

import 语句应该分行书写

# 正确的写法
import os
import sys
# 不推荐的写法
import sysos
# 正确的写法
from subprocess import Popen PIPE

import语句应该使用absoluteimport

# 正确的写法
from foo.bar import Bar
# 不推荐的写法
from ..bar import Bar

import语句应该放在文件头部，置于模块说明及docstring之后，于全局变量之前；
import语句应该按照顺序排列，每组之间用一个空行分隔

导入其他模块的类定义时，可以使用相对导入

from myclass import MyClass

如果发生命名冲突，则可使用命名空间

4、空格

在二元运算符两边各空一格[=-+===>inis not and:

函数的参数列表中，之后要有空格

函数的参数列表中，默认值等号两边不要添加空格

左括号之后，右括号之前不要加多余的空格

5、换行
Python 支持括号内的换行。这时有两种情况。
禁止复合语句，即一行中包含多个语句：
6、docstring
二、注释1、注释
1.1、块注释“#”号后空一格，段落件用空行分开（同样需要“#”号）
# 块注释
# 块注释
#
# 块注释
# 块注释

1.2、行注释至少使用两个空格和语句分开，注意不要使用无意义的注释
# 正确的写法
x = x + 1 # 边框加粗一个像素

# 不推荐的写法(无意义的注释)
x = x + 1 # x加1

1.3、建议

在代码的关键部分(或比较复杂的地方) 能写注释的要尽量写注释
比较重要的注释段使用多个等号隔开可以更加醒目突出重要性

2、文档注释（Docstring）
作为文档的Docstring一般出现在模块头部、函数和类的头部，这样在python中可以通过对象的__doc__对象获取文档. 编辑器和IDE也可以根据Docstring给出自动提示.

文档注释以 \"\"\" 开头和结尾首行不换行如有多行末行必需换行以下是Google的docstring风格示例

不要在文档注释复制函数定义原型而是具体描述其具体内容解释具体参数和返回值等

# 不推荐的写法(不要写函数原型等废话)