Python 编码规范

通过编码规范指导 Python 代码的编写，提高代码的可读性[1]。

代码编码

• 文件编码使用 UTF-8

  # -*- coding:utf-8 -*-

---

PEP 8 规范

参考：

• PEP 8

代码编排

• 缩进（indentation）
  4个 空格 缩进，不使用 Tab
• 最大长度（maximum line length）
  代码的每行最大长度为 79，注释文本的最大长度为 72。换行可以使用反斜杠，但最好使用圆括号代替。
• 空行
  • 类和顶级函数 使用两行间隔
  • 类中的方法 使用一行间隔
  • 函数内部逻辑无关段落之间空一行
  • 其他地方尽量不要使用空行

文档编排

• 示例

• 导入库

  • 不要在一句 import 中导入多个库
  • 导入库放于模块注释和文档之后，模块全局变量之前。导入的顺序如下：
    • 标准库
    • 第三方依赖库
    • 本地库
  • 采用 from module import func 引用库，

空格的使用

总体原则：避免不必要的空格。

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

注释

总体原则：错误的注释不如没有注释。

• 当一段代码发生变化时，第一件事就是要修改注释！
• 注释必须使用英文，最好是完整的句子，首字母大写，句后要有结束符，结束符后跟两个空格，开始下一句。如果是短语，可以省略结束符。
• 块注释
  在一段代码前增加的注释。在 # 后加一空格。段落之间以只有 # 的行间隔。比如:

  # Description : Module Config
  #
  # Input: None
  # 
  # Output: None

• 行注释
  在一句代码后加注释。比如：

  x = x + 1  # Increment x 

  但是这种方式尽量少使用
• 避免无谓的注释

文档描述

• 为所有的公有模块、函数、类、方法写 docstrings ；非公有的没有必要，但是可以写注释（在def的下一行）
• 如果 docstring 要换行，参考如下例子，详见 PEP 257

  """ Return a foobang
  Optional plotz says to frobnicate the bizbaz first.
  """

命名规范

总体原则：新编代码必须按下面命名风格进行，现有库的编码尽量保持风格。

• 尽量避免单独使用小写字母 i，大写字母 O等容易混淆
• 模块命名尽量短小，使用全部小写的方式，可以使用下划线
• 包命名尽量短小，使用全部小写的方式，不可以使用下划线
• 类的命名使用 CapWords（驼峰命名） 的方式，模块内部使用的类采用 _CapWords 的方式
• 异常命名使用 CapWords + Error 后缀的方式
• 全局变量尽量只在模块内有效，类似 C 语言中的 static。实现方法有两种：
  • 使用 __all__机制
  • 前缀加一条下划线
• 函数命名使用全部小写的方式，可以使用下划线
• 常量命名使用全部大写的方式，可以使用下划线
• 类的属相（方法和变量）命名使用全部小写的方式，可以使用下划线
• 类的属性有 3 种作用域 public、non­public和subclass API，可以理解成 C++ 中的 pubilc、private、protected， non­pubic 属性前，前缀加一条下划线
• 类的属性若与关键字名字冲突，后缀一下划线，尽量不要使用缩略等其他方式
• 为避免与子类属性命名冲突，在类的一些属性前，前缀两条下划线。比如： 类 Foo 中声明 __a，访问时，只能通过 Foo._Foo__a，避免歧义。如果子类也叫 Foo，那就只有更换命名
• 类的方法第一个参数必须是 self，而静态方法第一个参数必须是 cls

编码建议

• 编码中考虑到其他 python 实现的效率等问题，比如运算符 + 在 Cpython（python）中效率很高，但是 Jpython 中非常低， 所以应该采用 .join() 的方式

• 尽可能使用 is is not 取代 ==，比如: if x is not None: 要优于 if x:

• 使用基于类的异常，每个模块或包都有自己的异常类，此异常类继承自 Exception

• 异常中不要使用裸露的 except，except 后跟具体的 exceptions

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

  try:
      value = collection[key]
  except KeyError:
      return key_not_found(key)
  else:
      return handle_value(value)

• 使用 startswith() 和 endswith() 代替切片进行序列前缀或后缀的检查。比如：

  if foo.startswith('bar'):

  优于

  if foo[:3] == 'bar':

• 使用 isinstatce() 比较对象的类型。比如：

  if isinstance(obj, int):

  优于

  if type(obj) is type(1):

• 判断序列空或不空，有如下规则

  if not seq:
  
  if seq:

  优于

  if len(seq):
  
  if not len(seq):

• 字符串不要以空格收尾

• 布尔值不要使用 == True 或 == False 比较，比如：

  if greeting:

  优于

  if greeting == True:

目录约定规范

• utils 存放通用工具类模块

---