编程语言不是艺术,而是工作或者说是工具,所以整理并遵循一套编码规范是十分必要的。
PEP 的全称是 Python Enhancement Proposal,这里囊括了所有 Python 改进的所有提案,由社区核心成员包括作者本人在维护。PEP 8 是提案里的第 8 条,主要描述了 Python 官方建议的编码规范。
Python Enhancement Proposal 8 or PEP 8 is a comprehensive styling guide for your Python code.
本文是 PEP8 的速读版,完整版请访问: https://www.python.org/dev/peps/pep-0008/
代码排版
- 使用 4 个空格的缩进(编辑器都可以完成此功能),不使用
Tab
,更不能混合使用Tab
和空格。 - 每行最大长度为 79,换行可以使用反斜杠,最好使用圆括号。换行点要在操作符的后边敲回车。
- 类和 top-level 函数定义之间空两行;类中的方法定义之间空一行;函数内逻辑无关段落之间空一行;其他地方尽量不要再空行。
文档排版
- 模块内容的顺序:
docstring
—import
—globals&constants
—function&class
。其中import
部分,又按标准、三方和自己编写顺序依次排放,之间空一行。 - 不要在一句
import
中多个库,比如import os, sys
不推荐。 - 如果采用
from XX import XX
引用库,可以省略module.
,都是可能出现命名冲突,这时就要采用import XX
。
空格的使用
总体原则,避免不必要的空格。
- 各种右括号前不要加空格。
- 逗号、冒号、分号前不要加空格。
- 函数的左括号前不要加空格。如
Func(1)
。 - 序列的左括号前不要加空格。如
list[2]
。 - 操作符左右各加一个空格,不要为了对齐增加空格。
- 函数默认参数使用的赋值符左右省略空格。
- 不要将多句语句写在同一行,尽管允许使用
;
分隔。 if/for/while
语句中,即使执行语句只有一句,也必须另起一行。
注释
总体原则,错误的注释不如没有注释。所以当一段代码发生变化时,第一件事就是要修改注释!注释必须使用英文,最好是完整的句子,首字母大写,句后要有结束符,结束符后跟两个空格,开始下一句。如果是短语,可以省略结束符。
块注释,在一段代码前增加的注释。在
#
后加一空格。段落之间以只有#
的行间隔。比如:1 2 3 4 5 6 7 8 9
# Description : Module config. # # Input : None # # Output : None
行注释,在一句代码后加注释。比如:
1
x = x + 1 # Increment x
但是这种方式尽量少使用。
- 避免无谓的注释。
文档描述
- 为所有的共有模块、函数、类、方法写
docstrings
;非共有的没有必要,但是可以写注释(在def
的下一行)。 如果
docstring
要换行,参考如下例子,详见 PEP 2571 2 3 4 5 6
""" Return a foobang Optional plotz says to frobnicate the bizbaz first. """
命名规范
总体原则,新编代码必须按下面命名风格进行,现有库的编码尽量保持风格。
- 尽量单独使用小写字母
l
,大写字母O
等容易混淆的字母。 - 模块命名尽量短小,使用全部小写的方式,可以使用下划线。
- 包命名尽量短小,使用全部小写的方式,不可以使用下划线。
- 类的命名使用
CapWords
的方式,模块内部使用的类采用_CapWords
的方式。 - 异常命名使用
CapWordsError
后缀的方式。 - 全局变量尽量只在模块内有效,类似 C 语言中的
static
。实现方法有两种,一是all
机制,二是前缀一个下划线。 - 函数命名使用全部小写的方式,可以使用下划线。
- 常量命名使用全部大写的方式,可以使用下划线。
- 类的属性(方法和变量)命名使用全部小写的方式,可以使用下划线。
- 类的属性有 3 种作用域
public
、non-public
和subclass
API,可以理解成 C++中的public
、private
、protected
,non-public
属性前,前缀一条下划线。 - 类的属性若与关键字名字冲突,后缀一下划线,尽量不要使用缩略等其他方式。
- 为避免与子类属性命名冲突,在类的一些属性前,前缀两条下划线。比如:类
Foo
中声明a
,访问时,只能通过Foo.a
,避免歧义。如果子类也叫Foo
,那就无能为力了。 - 类的方法第一个参数必须是
self
,而静态方法第一个参数必须是cls
。
编码建议
- 编码中考虑到其他 Python 实现的效率等问题,比如运算符
+
在 CPython(Python)中效率很高,但是在 Jython 中却非常低,所以应该采用.join()
的方式。 - 尽可能使用
is
is not
取代==
,比如if x is not None
要优于if x
。 - 使用基于类的异常,每个模块或包都有自己的异常类,此异常类继承自
Exception
。 - 异常中不要使用裸露的
except
,except
后跟具体的exceptions
。 异常中
try
的代码尽可能少。比如:1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
# Yes: try: value = collection[key] except KeyError: return key_not_found(key) else: return handle_value(value) # No: try: # Too broad! return handle_value(collection[key]) except KeyError: # Will also catch KeyError raised by handle_value() return key_not_found(key)
使用
startswith()
和endswith()
代替切片进行序列前缀或后缀的检查。比如1 2 3 4 5
# Yes: if foo.startswith('bar'): # No: if foo[:3] == 'bar':
使用 isinstance()比较对象的类型。比如
1 2 3 4 5
# Yes: if isinstance(obj, int): # No: if type(obj) is type(1):
判断序列空或不空,有如下规则
1 2 3 4 5 6 7
# Yes: if not seq: if seq: # No: if len(seq) if not len(seq)
- 字符串不要以空格收尾。
- 二进制数据判断使用
if bool_value
的方式。