python语言规范

python

Lint

对你的代码运行pylint

• 优点: 可以捕获容易忽视的错误, 例如输入错误, 使用未赋值的变量等.
• 缺点: pylint不完美. 要利用其优势, 我们有时侯需要: a) 围绕着它来写代码 b) 抑制其告警 c) 改进它, 或者d) 忽略它.

导入

仅对包和模块使用导入。

• 结论：

  • 使用 import x 来导入包和模块.
  • 使用 from x import y , 其中x是包前缀, y是不带前缀的模块名.
  • 使用 from x import y as z, 如果两个要导入的模块都叫做y或者y太长了.

导入时不要使用相对名称. 即使模块在同一个包中, 也要使用完整包名. 这能帮助你避免无意间导入一个包两次.

包

使用模块的全路径名来导入每个模块

• 结论：

  所有的新代码都应该用完整包名来导入每个模块.

from sound.effects import echo

异常

允许使用异常, 但必须小心

• 结论：异常必须遵循以下条件：

  1. 像这样触发异常: raise MyException("Error message") 或者 raise MyException . 不要使用两个参数的形式( raise MyException, "Error message" )或者过时的字符串异常( raise "Error message" ).

  2. 模块或包应该定义自己的特定域的异常基类, 这个基类应该从内建的Exception类继承. 模块的异常基类应该叫做”Error”.

     class Error(Exception):

  3. 永远不要使用 except: 语句来捕获所有异常, 也不要捕获 Exception 或者 StandardError , 除非你打算重新触发该异常, 或者你已经在当前线程的最外层(记得还是要打印一条错误消息). 在异常这方面, Python非常宽容, except: 真的会捕获包括Python语法错误在内的任何错误. 使用 except: 很容易隐藏真正的bug.

  4. 尽量减少try/except块中的代码量. try块的体积越大, 期望之外的异常就越容易被触发. 这种情况下, try/except块将隐藏真正的错误

  5. 使用finally子句来执行那些无论try块中有没有异常都应该被执行的代码. 这对于清理资源常常很有用

  6. 当捕获异常时, 使用 as 而不要用逗号

全局变量

避免使用全局变量

• 结论：

  避免使用全局变量, 用类变量来代替. 但也有一些例外:

  1. 脚本的默认选项.
  2. 模块级常量. 例如:　PI = 3.14159. 常量应该全大写, 用下划线连接.
  3. 有时候用全局变量来缓存值或者作为函数返回值很有用.
  4. 如果需要, 全局变量应该仅在模块内部可用, 并通过模块级的公共函数来访问.

嵌套/局部/内部类或函数

鼓励使用嵌套/本地/内部类或函数

类可以定义在方法, 函数或者类中. 函数可以定义在方法或函数中. 封闭区间中定义的变量对嵌套函数是只读的.