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