重要的事情说三遍:可读性很重要;
PEP8规范要点笔记:
一、代码布局问题
1.缩进
每一级缩进四个空格。
参数缩进案例如下:
# Aligned with opening delimiter.
foo = long_function_name(var_one, var_two,
var_three, var_four)
# More indentation included to distinguish this from the rest.
def long_function_name(
var_one, var_two, var_three,
var_four):
print(var_one)
# Hanging indents should add a level.
foo = long_function_name(
var_one, var_two,
var_three, var_four)
2.空格和制表符
绝对不要混合使用制表符和空格,可以用python -t来检查是否存在混合使用的情况,混合使用容易造成问题。
3.行的最大长度
限制所有行的最大长度为79个字符,
4.空行
顶层函数和类之间两个空行
类的方法之间一个空行
谨慎的使用空行,将相关函数一组组的分割开来,谨慎意味着尽量少用
函数或者方法体内,谨慎的使用空行,表示不同的逻辑段落,谨慎意味着尽量少用
5.编码
python2.x的核心编码为ascII或者latin-1(iso-8859-1)编码,而python3的编码方式为utf-8,
6.导入
导入模块module使用单独的行
import os,sys应该改为如下方式
import os
import sys
导入同一个包或者模块的类
from subprocess import Popen,PIPE
导入顺序:分三组导入,组与组之间用一个空行分割
standard library imports 标准库导入
related third party imports 相关第三方导入
local application/library specific imports 本地应用程序/库的特定导入
绝对路径:不推荐使用.相对路径,推荐绝对路径导入
防止命名冲突的方法:
import myclass
import foo.bar.yourclass
二、表达式和语句中的空格问题
1. 表达式中尽量避免空格:
2. 紧贴在三种括号前
3. 紧贴在逗号,分号,冒号前,但是之后留一空格以便阅读
4. 二元运算符,以及算数运算符前后一个空格即可,不要多余空格
5. 关键字参数不要前后增加一个空格。
三、注释
1. 首字母大写,句号结尾,结尾后两个空格。英语注释。(国内还是习惯中文,虽然官方建议英文注释。)
2. 块注释,以#开头,其后紧跟一个空格
3. 行内注释,与执行语句相隔至少两个空格,以#开头,其后紧根一个空格。
4. 编写良好的文档字符串,这很有意义。
"""Return a foobang
Optional plotz says to frobnicate the bizbaz first.
"""
四、命名风格
1. 不用l(L的小写),I(大写的i),O(大写的o),做变量名
2. 从大到小,项目名称,包名,模块名,类名,函数名,变量名,参数名
项目名称随意
包名,模块名,小写,可用下划线分割,便于阅读
类名,首字母大写,内部类建议加上前导下划线
异常,异常也是类,首字母大写,而且添加Error作为自定义异常的名称后缀,方便后续引用。
函数名,小写,可用下划线分割
变量名,小写,可用下划线。如果是常量的话,全部大写。
参数名,参数名如果与保留字冲突,建议结尾下划线。
3. 下划线规则
私有方法和实例变量,使用单下划线开头
使用前导双下划线调用Python的名字变化规则来避免与子类中的名字冲突
4. 用户代码不应定义以Py或_Py开头的名称,此类型名称python内部使用来确定函数是Python/C API函数。如果用户自用,会危及用户代码对未来Python版本的可移植性。
五、程序设计建议
建议1. 例如,不要依赖于CPython的高效内置字符连接语句a += bora = a + b.这些语句在Jython中运行较慢。在性能敏感的库中,应该用''.join()来取代。这样可以保证在不同的实现中,字符链接花费的时间都呈线性。
建议2. 与诸如None这样的字符比较时,要使用is or is not,永远不要用等于操作。
# 以下语句执行成功,None
str =""
ifstris not None:
print("空字符串不等于None")
建议3. 为了实现复杂的排序操作,最好通过实现6个操作六个操作(__eq__,__ne__,__lt__,__le__,__gt__,__ge__)完成,而非自定义一些特别的代码
建议4. 使用Based-object Exception,自定义类应该继承Exception,并且Error后缀名,非错误类异常可以不用Error后缀。
class MessageError(Exception):
"""Base class for errors in the email package."""
使用具体的异常声明代替光秃秃的的exception:。例如:(ps:若想捕捉所有异常,至少使用except Exception:)
try:
import platform_specific_module
except ImportError:
platform_specific_module = None
建议5. 关于字符串操作
使用String方法而非String模块
使用''.startswith()和''.endswith()而非字符切片去检测前缀或后缀。
建议6. 对象类型比较使用isinstance()方法
检查一个变量是否字符串类型的方法:if isinstance(obj, basestring):
建议7.对于序列,(strings, lists, tuples),利用空序列为false这一点,作为判断条件
if not seq:
if seq:
建议8. 别用‘==’进行布尔值和 True 或者 False 的比较
六、引用
七、docString,代码字符串和pydoc的使用
单行文档字符串,建议首字母大写,尾部句号,感叹号结尾。例如:
defreverse_sort(items):
"""Sort items in reverse order."""
多行注释要求:第一行概述,首字母大写,句号结尾
第二行空行
第三行细节描述,同时注意与第一行的第一个引号对齐,最后"""结尾
"""OS routines for NT or Posix depending on what system we're on.
This exports:
......
"""
更多细节,请参考Github开源项目python编码风格指南