Python编码规范

一定要使用flake8或者pylint检查代码

遵循pep8和 Google Python Style Guide (中文版)

摘录其中一些注意点：

语言规范：

  • 强烈不推荐使用from x import *的写法
  • 强烈不推荐使用except: 语句来捕获所有异常, 也不要捕获 Exception 或者 StandardError , 除非你打算重新触发该异常, 或者你已经在当前线程的最外层(记得还是要打印一条错误消息). 在异常这方面, Python非常宽容, except: 真的会捕获包括Python语法错误在内的任何错误. 使用 except: 很容易隐藏真正的bug.
  • 合理地使用列表推导可以比其它的列表创建方法更加清晰简单
  • 尽可能地使用隐性的True, False, 例如：0, None, [], {}都为False

风格规范：

  • 每行不超过80个字符
  • 用4个空格来缩进代码
  • 顶级定义之间空两行, 方法定义之间空一行
  • 尽量为类或者方法添加doc string, 遵循google风格
  • 为代码中有技巧或者有业务逻辑的部分添加必要的注释
  • 使用TODO注释：如# TODO(Zeke) Change this to use relations.
  • 命名规范：module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_VAR_NAME, instance_var_name, function_parameter_name, local_var_name.