python 代码规范和命名规范
Python代码规范
一、简明概述
1、编码
如无特殊情况, 文件一律使用 UTF-8 编码
如无特殊情况, 文件头部必须加入#—coding:utf-8—标识
2、代码格式
2.1、缩进
统一使用 4 个空格进行缩进
2.2、行宽
每行代码尽量不超过 80 个字符(在特殊情况下可以略微超过 80 ,但最长不得超过 120)
理由:
这在查看 side-by-side 的 diff 时很有帮助
方便在控制台下查看代码
太长可能是设计有缺陷
2.3、引号
简单说,自然语言使用双引号,机器标示使用单引号,因此 代码里 多数应该使用 单引号
自然语言 使用双引号 “…”
例如错误信息;很多情况还是 unicode,使用u”你好世界”
机器标识 使用单引号 ‘…’
例如 dict 里的 key
正则表达式 使用原生的双引号 r”…”
文档字符串 (docstring) 使用三个双引号 “””……”””
2.4、空行
模块级函数和类定义之间空两行;
类成员函数之间空一行;
1 | class A: |
可以使用多个空行分隔多组相关的函数
函数中可以使用空行分隔出逻辑相关的代码
2.5、编码
文件使用 UTF-8 编码
文件头部加入#--conding:utf-8--标识
3、import 语句
正确的写法
1 | import os |
不推荐的写法
1 | import sys,os |
正确的写法
1 | from subprocess import Popen, PIPE |
import语句应该使用 absolute import
正确的写法
1 | from foo.bar import Bar |
不推荐的写法
1 | from ..bar import Bar |
import语句应该放在文件头部,置于模块说明及docstring之后,于全局变量之前;
import语句应该按照顺序排列,每组之间用一个空行分隔
1 | import os |
导入其他模块的类定义时,可以使用相对导入
1 | from myclass import MyClass |
如果发生命名冲突,则可使用命名空间
1 | import bar |
4、空格
在二元运算符两边各空一格[=,-,+=,==,>,in,is not, and]:
正确的写法
1 | i = i + 1 |
不推荐的写法
1 | i=i+1 |
函数的参数列表中,,之后要有空格
正确的写法
1 | def complex(real, imag): |
不推荐的写法
1 | def complex(real,imag): |
函数的参数列表中,默认值等号两边不要添加空格
正确的写法
1 | def complex(real, imag=0.0): |
不推荐的写法
1 | def complex(real, imag = 0.0): |
左括号之后,右括号之前不要加多余的空格
正确的写法
1 | spam(ham[1], {eggs: 2}) |
不推荐的写法
1 | spam( ham[1], { eggs : 2 } ) |
字典对象的左括号之前不要多余的空格
正确的写法
1 | dict['key'] = list[index] |
不推荐的写法
1 | dict ['key'] = list [index] |
不要为对齐赋值语句而使用的额外空格
正确的写法
1 | x = 1 |
不推荐的写法
1 | x = 1 |
5、换行
Python 支持括号内的换行。这时有两种情况。
1) 第二行缩进到括号的起始处
1 | foo = long_function_name(var_one, var_two, |
2) 第二行缩进 4 个空格,适用于起始括号就换行的情形
1 | def long_function_name( |
使用反斜杠\换行,二元运算符+ .等应出现在行末;长字符串也可以用此法换行
1 | session.query(MyTable).\ |
禁止复合语句,即一行中包含多个语句:
正确的写法
1 | do_first() |
不推荐的写法
1 | do_first();do_second();do_third(); |
if/for/while一定要换行:
正确的写法
1 | if foo == 'blah': |
不推荐的写法
1 | if foo == 'blah': do_blash_thing() |
6、docstring
docstring 的规范中最其本的两点:
所有的公共模块、函数、类、方法,都应该写 docstring 。私有方法不一定需要,但应该在 def 后提供一个块注释来说明。
docstring 的结束”””应该独占一行,除非此 docstring 只有一行。
1 | """Return a foobar |
二、注释
1、注释
1.1、块注释
“#”号后空一格,段落件用空行分开(同样需要“#”号)
1 | # 块注释 |
1.2、行注释
至少使用两个空格和语句分开,注意不要使用无意义的注释
1 | # 正确的写法 |
1.3、建议
在代码的关键部分(或比较复杂的地方), 能写注释的要尽量写注释
比较重要的注释段, 使用多个等号隔开, 可以更加醒目, 突出重要性
1 | app = create_app(name, options) |
2、文档注释(Docstring)
作为文档的Docstring一般出现在模块头部、函数和类的头部,这样在python中可以通过对象的doc对象获取文档.
编辑器和IDE也可以根据Docstring给出自动提示.
文档注释以 “”” 开头和结尾, 首行不换行, 如有多行, 末行必需换行, 以下是Google的docstring风格示例
1 | # -*- coding: utf-8 -*- |
不要在文档注释复制函数定义原型, 而是具体描述其具体内容, 解释具体参数和返回值等
- 不推荐的写法(不要写函数原型等废话)
1
2
3def function(a, b):
"""function(a, b) -> list"""
... ... - 正确的写法对函数参数、返回值等的说明采用numpy标准, 如下所示
1
2
3def function(a, b):
"""计算并返回a到b范围内数据的平均值"""
... ...1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29def func(arg1, arg2):
"""在这里写函数的一句话总结(如: 计算平均值).
这里是具体描述.
参数
----------
arg1 : int
arg1的具体描述
arg2 : int
arg2的具体描述
返回值
-------
int
返回值的具体描述
参看
--------
otherfunc : 其它关联函数等...
示例
--------
示例使用doctest格式, 在`>>>`后的代码可以被文档测试工具作为测试用例自动运行
>>> a=[1,2,3]
>>> print [x + 3 for x in a]
[4, 5, 6]
"""
文档注释不限于中英文, 但不要中英文混用
文档注释不是越长越好, 通常一两句话能把情况说清楚即可
模块、公有类、公有方法, 能写文档注释的, 应该尽量写文档注释
三、命名规范
1、模块
模块尽量使用小写命名,首字母保持小写,尽量不要用下划线(除非多个单词,且数量不多的情况)
- 正确的模块名
1
2import decoder
import html_parser - 不推荐的模块名
1
import Decoder
2、类名
类名使用驼峰(CamelCase)命名风格,首字母大写,私有类可用一个下划线开头
1 | class Farm(): |
将相关的类和顶级函数放在同一个模块里. 不像Java, 没必要限制一个类一个模块.
3、函数
函数名一律小写,如有多个单词,用下划线隔开
1 | def run(): |
私有函数在函数前加一个下划线_
1 | class Person(): |
4、变量名
变量名尽量小写, 如有多个单词,用下划线隔开
1 | if __name__ == '__main__': |
常量采用全大写,如有多个单词,使用下划线隔开
1 | MAX_CLIENT = 100 |
5、常量
常量使用以下划线分隔的大写命名
1 | MAX_OVERFLOW = 100 |