PEP8Python 编码规范整理
PEP8 编码规范整理
⼀ 代码编排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 但是这种⽅式尽量少使⽤。
3 避免⽆谓的注释。
五 ⽂档描述# Description : Module config.# # Input : None ## Output : None
1
2
3
4
5
1 为所有的共有模块、、类、⽅法写docstrings；⾮共有的没有必要，但是可以写注释（在def的下⼀⾏）。
2 如果docstring要换⾏，参考如下例⼦，详见PEP 257
六 命名规范总体原则，新编代码必须按下⾯命名风格进⾏，现有库的编码尽量保持风格。1 尽量单独使⽤⼩写字母‘l’，⼤写字母‘O’等容易混淆的字母。2 模块命名尽量短⼩，使⽤全部⼩写的⽅式，可以使⽤下划线。3 包命名尽量短⼩，使⽤全部⼩写的⽅式，不可以使⽤下划线。4 类的命名使⽤CapWords的⽅式，模块内部使⽤的类采⽤_CapWords的⽅式。5 异常命名使⽤CapWords+Error后缀的⽅式。6 全局变量尽量只在模块内有效，类似C语⾔中的static。实现⽅法有两种，⼀是__all__机制;⼆是前缀⼀个下划线。7 函数命名使⽤全部⼩写的⽅式，可以使⽤下划线。8 常量命名使⽤全部⼤写的⽅式，可以使⽤下划线。9 类的属性（⽅法和变量）命名使⽤全部⼩写的⽅式，可以使⽤下划线。
10 类的属性有3种作⽤域public、non-public和subclass API，可以理解成C++中的public、private、pr
otected，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的代码尽可能少。⽐如：
要优于"""Return a foobang Optional plotz says to frobnicate the bizbaz first."""
1
2
3
4
5    try:    value = collection[key]    except KeyError:    return key_not_found(key)    else:    return handle_value(value)
1
2
3
4
5
6
6 使⽤startswith() and endswith()代替切⽚进⾏序列前缀或后缀的检查。⽐如：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 判断序列空或不空，有如下规则9 字符串不要以空格收尾。python的try和except用法
10 ⼆进制数据判断使⽤ if boolvalue的⽅式。    try:    # Too broad!    return handle_value(collection[key])    except KeyError:    # Will also catch KeyError raised by handle_value()    return key_not_found(key)
1
2
3
4
56    Yes:  if not seq:    if seq: 优于    No:  if len(seq)    if not len(seq)
1
2
3
4
5

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。