Python编码规范(PEP8)及奇技淫巧(不断更新)

Python 2.7

---

前言

从很多地方搬运+总结，以后根据这个标准再将python的一些奇技淫巧结合起来，写出更pythonic的代码~

PEP8 编码规范

英文原版请点击这里

以下是@bobo的整理，原文请见PEP8 Python 编码规范整理

代码编排

缩进。4个空格的缩进（编辑器都可以完成此功能），不使用Tap，更不能混合使用Tap和空格。每行最大长度79，换行可以使用反斜杠，最好使用圆括号。换行点要在操作符的后边敲回车。类和top-level函数定义之间空两行；类中的方法定义之间空一行；函数内逻辑无关段落之间空一行；其他地方尽量不要再空行。

文档编排

模块内容的顺序：模块说明和docstring—import—globals&constants—其他定义。其中import部分，又按标准、三方和自己编写顺序依次排放，之间空一行不要在一句import中多个库，比如import os, sys不推荐如果采用from XX import XX引用库，可以省略‘module.’，都是可能出现命名冲突，这时就要采用import XX

空格的使用

各种右括号前不要加空格。逗号、冒号、分号前不要加空格。函数的左括号前不要加空格。如Func(1)序列的左括号前不要加空格。如list[2]操作符左右各加一个空格，不要为了对齐增加空格函数默认参数使用的赋值符左右省略空格不要将多句语句写在同一行，尽管使用‘；’允许if/for/while语句中，即使执行语句只有一句，也必须另起一行

注释

总体原则，错误的注释不如没有注释。所以当一段代码发生变化时，第一件事就是要修改注释！注释必须使用英文，最好是完整的句子，首字母大写，句后要有结束符，结束符后跟两个空格，开始下一句。如果是短语，可以省略结束符。

块注释，在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。比如： # Description : Module config. # # Input : None # # Output : None 行注释，在一句代码后加注释。比如：x = x + 1 # Increment x但是这种方式尽量少使用。避免无谓的注释。

文档描述

为所有的共有模块、函数、类、方法写docstrings；非共有的没有必要，但是可以写注释（在def的下一行）。单行注释请参考如下方式 def kos_root(): """Return the pathname of the KOS root directory.""" global _kos_root if _kos_root: return _kos_root ...

命名规则

* 总体原则，新编代码必须按下面命名风格进行，现有库的编码尽量保持风格。绝不要单独使用例如大写的’i’和大写的’o’*

模块命名尽量短小，使用全部小写的方式，可以使用下划线。包命名尽量短小，使用全部小写的方式，不可以使用下划线。类的命名使用CapWords的方式，模块内部使用的类采用_CapWords的方式。异常命名使用CapWords+Error后缀的方式。全局变量尽量只在模块内有效，类似C语言中的static。实现方法有两种，一是all机制;二是前缀一个下划线。函数命名使用全部小写的方式，可以使用下划线。常量命名使用全部大写的方式，可以使用下划线。类的属性（方法和变量）命名使用全部小写的方式，可以使用下划线。类的属性有3种作用域public、non-public和subclass API，可以理解成C++中的public、private、protected，non-public属性前，前缀一条下划线。类的属性若与关键字名字冲突，后缀一下划线，尽量不要使用缩略等其他方式。为避免与子类属性命名冲突，在类的一些属性前，前缀两条下划线。比如：类Foo中声明__a,访问时，只能通过Foo._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: ... except Exception as ex: print ex

异常中try的代码尽可能少。

使用startswith() and endswith()代替切片进行序列前缀或后缀的检查。

foo = 'abc000xyz' if foo.startswith('abc') and foo.endswith('xyz'): print 'yes' else: print 'no' #yes #而如下的方式不提倡 if foo[:3]=='abc' and foo[-3:]=='xyz': print 'yes' else: print 'no' 使用isinstance()比较对象的类型。比如: foo = 'abc000xyz' # 提倡 print isinstance(foo,int) # false # 不提倡 print type(foo) == type('1') #true 判断序列空或不空，有如下规则： foo = 'abc000xyz' if foo: print "not empty" else: print "empty" #不提倡使用如下 if len(foo): print "not empty" else: print "empty" 二进制数据判断使用 if boolvalue的方式。

给自己的代码打分

使用pylint进行代码检查，@permilk–Python代码分析工具：PyChecker、Pylint

# 安装 pip install pylint

写一段测试代码，命名为test.py

# -*- coding:utf-8 -*- # 原理:http://blog.csdn.net/morewindows/article/details/6684558 # 代码提供: http://www.cnblogs.com/yekwol/p/5778040.html def parttion(vec, left, right): key = vec[left] low = left high = right while low < high: while (low < high) and (vec[high] >= key): high -= 1 vec[low] = vec[high] while (low < high) and (vec[low] <= key): low += 1 vec[high] = vec[low] vec[low] = key return low # 采用递归的方式进行函数构建 def quicksort(vec, left, right): if left < right: p = parttion(vec, left, right) quicksort(vec, left, p-1) # 再同样处理分片问题 quicksort(vec, p+1, right) return vec #s = [6, 8, 1, 4, 3, 9, 5, 4, 11, 2, 2, 15, 6] before_list = [4, 6, 1, 3, 5, 9] print "before sort:", before_list after_list = quicksort(before_list, left=0, right=len(before_list)-1) print"after sort:", after_list

进行代码规范测试

# 使用 pylint test.py # 输出 Problem importing module variables.py: No module named functools_lru_cache Problem importing module variables.pyc: No module named functools_lru_cache No config file found, using default configuration ************* Module test C: 24, 0: Trailing whitespace (trailing-whitespace) C: 1, 0: Missing module docstring (missing-docstring) C: 5, 0: Missing function docstring (missing-docstring) C: 20, 0: Missing function docstring (missing-docstring) C: 22, 8: Invalid variable name "p" (invalid-name) C: 28, 0: Invalid constant name "before_list" (invalid-name) C: 30, 0: Invalid constant name "after_list" (invalid-name) Report ====== 23 statements analysed. Statistics by type ------------------ +---------+-------+-----------+-----------+------------+---------+ |type |number |old number |difference |%documented |