Python风格指南

  • Python是一种对代码风格很讲究的语言,从缩进就能看到这或多或少,Python强调易于了解。近日在担负代码重构的工作,为了统一大家的代码风格,制订规范,学习了刹那间网上这份Google的Python风格指南。

  • 原稿地址:
    http://google-styleguide.googlecode.com/svn/trunk/pyguide.html

背景

Python 是
Google紧要的脚本语言。这本风格指南紧要包含的是对准python的编程准则。
为协理读者可以将代码准确格式化,我们提供了针对 Vim的配备文件
。对于Emacs用户,保持默认设置即可。

Python语言专业

pylint

Tip
对您的代码运行pylint

定义:
pylint是一个在Python源代码中查找bug的工具.
对于C和C++这样的不那么动态的(译者注: 原文是less dynamic)语言,
这一个bug平时由编译器来捕获. 由于Python的动态特性, 有些警告或者不对.
可是伪告警应该很少.
优点:
可以捕获容易忽视的不当, 例如输入错误, 使用未赋值的变量等.
缺点:
pylint不完美. 要拔取其优势, 我们偶尔侯需要: a) 围绕着它来写代码 b)
抑制其报警 c) 改进它, 或者d) 忽略它.
结论:
管教对您的代码运行pylint.抑制不标准的警示,以便可以将其他警告表表露来。
你能够透过安装一个行注释来遏制告警. 例如:

dict = 'something awful'  # Bad Idea... pylint: disable=redefined-builtin

pylint警告是以一个数字编号(如 C0112 )和一个标志名(如 empty-docstring
)来标识的. 在编辑新代码或更新已有代码时对报警举办诊治,
推荐使用标志名来标识.

如果警告的标志名不够见名知意,那么请对其扩张一个详细解释。

选用这种抑制情势的便宜是大家可以轻松查找抑制并记念它们.

您可以利用命令 pylint --list-msgs 来获取pylint告警列表. 你可以拔取命令
pylint --help-msg=C6409 , 以赢得有关特定信息的更多信息.

相比于事先运用的 pylint: disable-msg , 本文推荐使用
pylint: disable .

要制止”参数未利用”告警, 你可以用””作为参数标识符,
或者在参数名前加”unused
”. 碰到无法更改参数名的情状,
你可以通过在函数先导”提到”它们来撤消告警. 例如:

    def foo(a, unused_b, unused_c, d=None, e=None):
        _ = d, e
        return a

导入

Tip
仅对包和模块使用导入

定义:
模块间共享代码的录用机制.
优点:
取名空间管理约定非常简单. 每个标识符的源都用一种同等的不二法门指示.
x.Obj表示Obj对象定义在模块x中.
缺点:
模块名仍可能争辩. 有些模块名太长, 不太方便.
结论:
使用 import x 来导入包和模块.

使用 from x import y , 其中x是包前缀, y是不带前缀的模块名.

使用 from x import y as z, 要是五个要导入的模块都叫做z或者y太长了.

例如, 模块 sound.effects.echo 可以用如下情势导入:

    from sound.effects import echo
    ...
    echo.EchoFilter(input, output, delay=0.7, atten=4)

导入时不要采纳相对名称. 尽管模块在同一个包中, 也要使用完整包名.
这能匡助您避免无意间导入一个包五次.

Tip
采纳模块的整套径名来导入每个模块

优点:
避免模块名争持. 查找包更容易.
缺点:
布局代码变难, 因为您不可以不复制包层次.
结论:
不无的新代码都应该用全部包名来导入每个模块.

有道是像下边这样导入:

# Reference in code with complete name.
import sound.effects.echo

# Reference in code with just module name (preferred).
from sound.effects import echo

异常

Tip
允许利用特别, 但必须小心

定义:
可怜是一种跳出代码块的常规控制流来处理错误或者其他异常条件的格局.
优点:
健康操作代码的控制流不会和错误处理代码混在一起. 当某种条件暴发时,
它也允许控制流跳过两个框架. 例如, 一步跳出N个嵌套的函数,
而不必继续执行错误的代码.
缺点:
或是会导致令人疑惑的控制流. 调用库时便于失去错误情形.
结论:
相当必须坚守特定条件:

  1. 像这么触发卓殊: raise MyException("Error message") 或者
    raise MyException . 不要采取几个参数的款式(
    raise MyException, "Error message" )或者过时的字符串分外(
    raise "Error message" ).

  2. 模块或包应该定义自己的特定域的百般基类,
    这一个基类应该从内建的Exception类继承. 模块的充裕基类应该称为”Error”.

    class Error(Exception):
        pass
  1. 永远不要拔取 except: 语句来捕获所有特别, 也毫不捕获 Exception
    或者 StandardError , 除非你打算重新触发该特别,
    或者你早已在现阶段线程的最外层(记得仍旧要打印一条错误音信).
    在特别这方面, Python很是宽容, except:
    真的会捕获包括Python语法错误在内的任何错误. 使用 except:
    很容易隐藏真正的bug.

  2. 尽量裁减try/except块中的代码量. try块的体积越大,
    期望之外的要命就越容易被触发. 这种境况下,
    try/except块将藏匿真正的错误.

  3. 拔取finally子句来进行这么些无论try块中有没有相当都应有被执行的代码.
    这对于清理资源平日很有用, 例如关闭文件.
    当捕获异常时, 使用 as 而不要用逗号. 例如

try:
    raise Error
except Error as error:
    pass

全局变量

Tip
避免全局变量

定义:
概念在模块级的变量.
优点:
有时候有用.
缺点:
导入时可能变动模块行为, 因为导入模块时会对模块级变量赋值.
结论:
防止采取全局变量, 用类变量来代替. 但也有一对例外:

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

嵌套 局部 内部类或函数

Tip
鞭策接纳嵌套/本地/内部类或函数

定义:
类可以定义在措施, 函数或者类中. 函数可以定义在艺术或函数中.
封闭区间中定义的变量对嵌套函数是只读的.
优点:
同意定义仅用于有效限制的工具类和函数.
缺点:
嵌套类或局项目标实例不可能体系化(pickled).
结论:
推荐使用.

列表推导 List Comprehensions

Tip
可以在简短情状下利用

定义:
列表推导(list comprehensions)与生成器表达式(generator
expression)提供了一种简单高效的不二法门来创立列表和迭代器, 而不必借助map(),
filter(), 或者lambda.
优点:
概括的列表推导可以比其他的列表制造方法尤其清晰简单.
生成器表明式可以非凡飞速, 因为它们防止了创办整个列表.
缺点:
复杂的列表推导或者生成器表明式可能难以阅读.
结论:
适用于简单境况. 每个部分应该单独置于一行: 映射表明式, for语句,
过滤器表明式. 禁止多重for语句或过滤器表明式. 复杂意况下或者采纳循环.

Yes:
  result = []
  for x in range(10):
      for y in range(5):
          if x * y > 10:
              result.append((x, y))

  for x in xrange(5):
      for y in xrange(5):
          if x != y:
              for z in xrange(5):
                  if y != z:
                      yield (x, y, z)

  return ((x, complicated_transform(x))
          for x in long_generator_function(parameter)
          if x is not None)

  squares = [x * x for x in range(10)]

  eat(jelly_bean for jelly_bean in jelly_beans
      if jelly_bean.color == 'black')

No:
  result = [(x, y) for x in range(10) for y in range(5) if x * y > 10]

  return ((x, y, z)
          for x in xrange(5)
          for y in xrange(5)
          if x != y
          for z in xrange(5)
          if y != z)

默认迭代器和操作符

Tip
如果类型辅助, 就使用默认迭代器和操作符. 比如列表, 字典及文件等.

定义:
容器类型, 像字典和列表, 定义了默认的迭代器和关系测试操作符(in和not in)
优点:
默认操作符和迭代器简单便捷, 它们一向发挥了操作, 没有额外的法子调用.
使用默认操作符的函数是通用的. 它可以用来援助该操作的此外类型.
缺点:
你没法通过阅读模式名来区别对象的体系(例如, has_找个正规网赌平台,key()意味着字典).
不过这也是优点.
结论:
设若类型扶助, 就使用默认迭代器和操作符, 例如列表, 字典和文件.
内建品种也定义了迭代器方法. 优先考虑那么些点子, 而不是这么些重返列表的方法.
当然,这样遍历容器时,你将无法修改容器.

Yes:  for key in adict: ...
      if key not in adict: ...
      if obj in alist: ...
      for line in afile: ...
      for k, v in dict.iteritems(): ...

No:   for key in adict.keys(): ...
      if not adict.has_key(key): ...
      for line in afile.readlines(): ...

生成器

Tip
按需使用生成器.

定义:
所谓生成器函数, 就是每当它实施三回生成(yield)语句, 它就回来一个迭代器,
这多少个迭代器生成一个值. 生成值后, 生成器函数的周转状态将被挂起,
直到下四回生成.
优点:
简化代码, 因为每便调用时, 局部变量和控制流的情况都会被保存.
比起五回创设一名目繁多值的函数, 生成器使用的内存更少.
缺点:
没有.
结论:
勉励使用. 注目的在于生成器函数的文档字符串中运用”Yields:”而不是”Returns:”.
(译者注: 参看
注释
)

Lambda函数

Tip
适用于单行函数

定义:
与话语相反, lambda在一个表明式中定义匿名函数. 常用于为 map()
filter() 之类的高阶函数定义回调函数或者操作符.
优点:
方便.
缺点:
比当地函数更难阅读和调试. 没有函数名代表堆栈跟踪更难明白.
由于lambda函数平时只包含一个表明式, 因而其表明能力有限.
结论:
适用于单行函数. 假设代码超越60-80个字符, 最好仍旧定义成常规(嵌套)函数.

对此大规模的操作符,例如乘法操作符,使用 operator
模块中的函数以代表lambda函数. 例如, 推荐使用 operator.mul , 而不是
lambda x, y: x * y .

规格表明式

Tip
适用于单行函数

定义:
基准表达式是对于if语句的一种更加简单的句法规则. 例如:
x = 1 if cond else 2 .
优点:
比if语句更加简便易行和方便.
缺点:
比if语句难于阅读. 假若表明式很长, 难于固定条件.
结论:
适用于单行函数. 在任何情况下,推荐应用完全的if语句.

默认参数值

Tip
适用于大部分情况.

定义:
你可以在函数参数列表的最后指定变量的值, 例如, def foo(a, b = 0): .
假若调用foo时只带一个参数, 则b被设为0. 倘若带六个参数,
则b的值等于第二个参数.
优点:
您时常会遇见一些施用大量默认值的函数,
但偶尔(相比较少见)你想要覆盖这些默认值.
默认参数值提供了一种简易的不二法门来成功这件事,
你不需要为那些难得的两样定义大量函数. 同时,
Python也不补助重载方法和函数, 默认参数是一种”仿造”重载行为的简易模式.
缺点:
默认参数只在模块加载时求值两次. 假若参数是列表或字典之类的可变类型,
这也许会招致问题. 假如函数修改了目的(例如向列表追加项),
默认值就被涂改了.
结论:
勉励选用, 但是有如下注意事项:

并非在函数或艺术定义中动用可变对象作为默认值.

Yes: def foo(a, b=None):
         if b is None:
             b = []

No:  def foo(a, b=[]):
         ...
No:  def foo(a, b=time.time()):  # The time the module was loaded???
         ...
No:  def foo(a, b=FLAGS.my_thing):  # sys.argv has not yet been parsed...
         ...

属性 properties

Tip
做客和安装数据成员时, 你平时会选择简易, 轻量级的造访和设置函数.
指出用属性(properties)来取代它们.

定义:
一种用于包装模式调用的模式. 当运算量不大,
它是得到和设置属性(attribute)的业内格局.
优点:
因此解除简单的特性(attribute)访问时显式的get和set方法调用, 可读性提升了.
允许懒惰的统计. 用Pythonic的法门来维护类的接口. 就性能而言,
当直接访问变量是合理的, 添加访问方法就显示琐碎而无意识义.
使用性能(properties)可以绕过这么些题材.
未来也可以在不破坏接口的情状下将拜访方法加上.
缺点:
属性(properties)是在get和set方法阐明后指定,
这亟需使用者在接下去的代码中注意:
set和get是用来属性(properties)的(除了用 @property
装饰器成立的只读属性). 必须连续自object类.
可能潜藏比如操作符重载之类的副效能. 继承时或者会令人困惑.
结论:
你平常习惯于选择访问或安装方法来访问或设置数据, 它们简单而轻量.
然而大家指出你在新的代码中应用属性. 只读属性应该用 @property 装饰器
来创建.

假诺子类没有覆盖属性, 那么属性的后续可能看起来不显著.
因而使用者必须确保走访方法直接被调用,
以保证子类中的重载方法被属性调用(使用模板方法设计形式).

Yes: import math

     class Square(object):
         """A square with two properties: a writable area and a read-only perimeter.

         To use:
         >>> sq = Square(3)
         >>> sq.area
         9
         >>> sq.perimeter
         12
         >>> sq.area = 16
         >>> sq.side
         4
         >>> sq.perimeter
         16
         """

         def __init__(self, side):
             self.side = side

         def __get_area(self):
             """Calculates the 'area' property."""
             return self.side ** 2

         def ___get_area(self):
             """Indirect accessor for 'area' property."""
             return self.__get_area()

         def __set_area(self, area):
             """Sets the 'area' property."""
             self.side = math.sqrt(area)

         def ___set_area(self, area):
             """Indirect setter for 'area' property."""
             self._SetArea(area)

         area = property(___get_area, ___set_area,
                         doc="""Gets or sets the area of the square.""")

         @property
         def perimeter(self):
             return self.side * 4

(译者注: 老实说, 我觉得这段示例代码很不适当, 有必不可少这样蛋疼吗?)

True or False的求值

Tip
尽量使用隐式false

定义:
Python在布尔上下文中会将某些值求值为false. 按简单的直觉来讲,
就是独具的”空”值都被认为是false. 因而0, None, [], {}, “”
都被认为是false.
优点:
应用Python布尔值的规则语句更易读也更不易犯错. 大部分景观下, 也更快.
缺点:
对C/C++开发人士来说, 可能看起来有点怪.
结论:
尽量使用隐式的false, 例如: 使用 if foo: 而不是 if foo != []: .
可是还是有一部分注意事项需要您一遍遍地思念:

  1. 永恒不要用==或者!=来相比较单件, 比如None. 使用is或者is not.

  2. 只顾: 当你写下 if x: 时, 你实在表示的是 if x is not None . 例如:
    当你要测试一个默认值是None的变量或参数是否被设为此外值.
    那么些值在布尔语义下可能是false!

  3. 永远不要用==将一个布尔量与false相比. 使用 if not x: 代替.
    假诺您需要区分false和None, 你应该用像 if not x and x is not None:
    那样的语句.

  4. 对此系列(字符串, 列表, 元组), 要注意空体系是false. 由此
    if not seq: 或者 if seq:if len(seq):if not len(seq):
    要更好.

  5. 拍卖整数时, 使用隐式false可能会得不偿失(即不小心将None当做0来处理).
    你可以将一个已知是整型(且不是len()的回到结果)的值与0相比较.

Yes: if not users:
         print 'no users'

     if foo == 0:
         self.handle_zero()

     if i % 10 == 0:
         self.handle_multiple_of_ten()


No:  if len(users) == 0:
         print 'no users'

     if foo is not None and not foo:
         self.handle_zero()

     if not i % 10:
         self.handle_multiple_of_ten()
  1. 留神‘0’(字符串)会被看做true.

老式的言语特色

Tip
尽心尽力接纳字符串方法取代字符串模块. 使用函数调用语法取代apply().
使用列表推导, for循环取代filter(),map()以及reduce().

定义:
时下版本的Python提供了大家通常更欣赏的替代品.
结论:
咱俩不接纳不援助那多少个特点的Python版本, 所以没理由不用新的模式.

Yes: words = foo.split(':')

     [x[1] for x in my_list if x[2] == 5]

     map(math.sqrt, data)    # Ok. No inlined lambda expression.

     fn(*args, **kwargs)

No:  words = string.split(foo, ':')

     map(lambda x: x[1], filter(lambda x: x[2] == 5, my_list))

     apply(fn, args, kwargs)

词法功能域 Lexical Scoping

Tip

推荐使用

定义:
嵌套的Python函数可以引用外层函数中定义的变量, 可是不可知对它们赋值.
变量绑定的分析是利用词法效能域, 也就是遵照静态的先后文本.
对一个块中的某个名称的其他赋值都会导致Python将对该名称的上上下下引用当做局部变量,
甚至是赋值前的处理. 假使遭受global表明, 该名称就会被当作全局变量.

一个行使这些特性的例子:

def get_adder(summand1):
    """Returns a function that adds numbers to a given number."""
    def adder(summand2):
        return summand1 + summand2

    return adder

(译者注: 这一个事例有点古怪, 你应该这样使用这一个函数:
sum = get_adder(summand1)(summand2) )
优点:
屡见不鲜可以拉动更加清楚, 优雅的代码.
尤其会让有经验的Lisp和Scheme(还有Haskell, ML等)程序员感到欣慰.
缺点:
恐怕导致令人迷惑的bug. 例如下面这么些遵照
PEP-0227
的例子:

i = 4
def foo(x):
    def bar():
        print i,
    # ...
    # A bunch of code here
    # ...
    for i in x:  # Ah, i *is* local to Foo, so this is what Bar sees
        print i,
    bar()

因此 foo([1, 2, 3]) 会打印 1 2 3 3 , 不是 1 2 3 4 .

(译者注: x是一个列表,
for循环其实是将x中的值依次赋给i.这样对i的赋值就隐式的爆发了,
整个foo函数体中的i都会被视作局部变量, 包括bar()中的那些.
这点与C++之类的静态语言依然有很大区其它.)
结论:
勉励使用.

函数与模式装饰器

Tip
假若好处很分明, 就明智而严厉的接纳装饰器

定义:
用以函数及艺术的装饰器
(也就是@标记). 最广泛的装饰器是@classmethod 和@staticmethod,
用于将常规函数转换成类方法或静态方法. 然而,
装饰器语法也允许用户自定义装饰器. 特别地, 对于某个函数 my_decorator ,
下面的两段代码是一致的:

class C(object):
   @my_decorator
   def method(self):
       # method body ...
class C(object):
    def method(self):
        # method body ...
    method = my_decorator(method)

优点:
大雅的在函数上点名一些转换. 该转换可能缩减一些再一次代码,
保持已有函数不变(enforce invariants), 等.
缺点:
装饰器可以在函数的参数或再次回到值上推行另外操作,
这或者造成令人惊愕的隐藏行为. 而且, 装饰器在导入时执行.
从装饰器代码的挫败中平复更加不可以.
结论:
只要好处很引人注目, 就明智而严格的使用装饰器.
装饰器应该服从和函数一样的导入和命名规则.
装饰器的python文档应该清楚的验证该函数是一个装修器.
请为装饰器编写单元测试.

避免装饰器自身对外围的借助(即决不借助于文件, socket, 数据库连接等),
因为装饰器运行时这多少个资源可能不可用(由 pydoc 或任何工具导入).
应该保证一个用有效参数调用的装饰器在富有意况下都是水到渠成的.

装饰器是一种新鲜情势的”一流代码”. 参考前面关于 Main 的话题.

线程

Tip
不用借助内建类型的原子性.

尽管如此Python的内建档次例如字典看上去拥有原子操作,
可是在少数状况下它们依旧不是原子的(即:
假如__hash____eq__被实现为Python方法)且它们的原子性是靠不住的.
你也无法仰望原子变量赋值(因为这些反过来倚重字典).

事先选择Queue模块的 Queue 数据类型作为线程间的数据通信模式. 此外,
使用threading模块及其锁原语(locking primitives).
了然条件变量的贴切使用办法, 这样你就可以使用 threading.Condition
来取代低级另外锁了.

威力过大的风味

Tip
制止使用这么些特征

定义:
Python是一种非凡灵活的言语, 它为您提供了广大鲜艳的风味,
诸如元类(metaclasses), 字节码访问, 任意编译(on-the-fly compilation),
动态继承, 对象父类重定义(object reparenting), 导入黑客(import hacks),
反射, 系统内修改(modification of system internals), 等等.
优点:
强硬的言语特征, 能让你的代码更紧凑.
缺点:
采用这么些很”酷”的特征非常诱人, 但不是相对必要.
使用奇技淫巧的代码将进而难以阅读和调试. 开端容许还好(对原作者而言),
但当你想起代码, 它们可能会比那多少个稍长一点可是很直接的代码更加不便精晓.
结论:
在你的代码中制止这一个特性.

Python风格规范

分号

Tip
不用在行尾加分号, 也无须用分号将两条命令放在同样行.

行长度

Tip
每行不超过80个字符

例外:

  1. 长的导入模块语句
  2. 诠释里的URL

不要采纳反斜杠连接行.

Python会将 圆括号,
中括号和花括号中的行隐式的连接起来

, 你可以应用那么些特点. 即使需要, 你可以在表明式外围扩张一对额外的圆括号.

Yes: foo_bar(self, width, height, color='black', design=None, x='foo',
             emphasis=None, highlight=0)

     if (width == 0 and height == 0 and
         color == 'red' and emphasis == 'strong'):

假设一个文本字符串在一行放不下, 可以动用圆括号来促成隐式行连接:

x = ('This will build a very long long '
     'long long long long long long string')

在诠释中,假使必要,将长的URL放在一行上。

Yes:  # See details at
      # http://www.example.com/us/developer/documentation/api/content/v2.0/csv_file_name_extension_full_specification.html

No:  # See details at
     # http://www.example.com/us/developer/documentation/api/content/\
     # v2.0/csv_file_name_extension_full_specification.html

在意下边例子中的元素缩进; 你能够在本文的 缩进 部分找到解释.

括号

Tip
宁缺毋滥的行使括号

除非是用于落举行连接, 否则毫不在回来语句或规范语句中使用括号.
可是在元组两边使用括号是足以的.

Yes: if foo:
         bar()
     while x:
         x = bar()
     if x and y:
         bar()
     if not x:
         bar()
     return foo
     for (x, y) in dict.items(): ...

No:  if (x):
         bar()
     if not(x):
         bar()
     return (foo)

缩进

Tip
用4个空格来缩进代码

相对不用用tab, 也休想tab和空格混用. 对于行连接的意况,
你应有依旧垂直对齐换行的因素(见 行长度 部分的演示),
或者使用4空格的悬挂式缩进(这时第一行不应该有参数):

Yes:   # Aligned with opening delimiter
       foo = long_function_name(var_one, var_two,
                                var_three, var_four)

       # Aligned with opening delimiter in a dictionary
       foo = {
           long_dictionary_key: value1 +
                                value2,
           ...
       }

       # 4-space hanging indent; nothing on first line
       foo = long_function_name(
           var_one, var_two, var_three,
           var_four)

       # 4-space hanging indent in a dictionary
       foo = {
           long_dictionary_key:
               long_dictionary_value,
           ...
       }

No:    # Stuff on first line forbidden
      foo = long_function_name(var_one, var_two,
          var_three, var_four)

      # 2-space hanging indent forbidden
      foo = long_function_name(
        var_one, var_two, var_three,
        var_four)

      # No hanging indent in a dictionary
      foo = {
          long_dictionary_key:
              long_dictionary_value,
              ...
      }

空行

Tip
一品定义之间空两行, 方法定义之间空一行

五星级定义之间空两行, 比如函数或者类定义. 方法定义,
类定义与第一个法子之间, 都应该空一行. 函数或方法中,
某些地点要是你觉得适当, 就空一行.

空格

Tip
遵照专业的排版规范来拔取标点两边的空格

括号内不要有空格.

Yes: spam(ham[1], {eggs: 2}, [])

No:  spam( ham[ 1 ], { eggs: 2 }, [ ] )

不要在逗号, 分号, 冒号前边加空格, 但应该在它们前面加(除了在行尾).

Yes: if x == 4:
         print x, y
     x, y = y, x

No:  if x == 4 :
         print x , y
     x , y = y , x

参数列表, 索引或切片的左括号前不应加空格.

Yes: spam(1)

no: spam (1)

Yes: dict['key'] = list[index]

No:  dict ['key'] = list [index]

在二元操作符两边都助长一个空格, 比如赋值(=), 相比(==, <, >, !=,
<>, <=, >=, in, not in, is, is not), 布尔(and, or, not).
至于算术操作符两边的空格该咋样行使, 需要您协调理想判断.
但是两侧务必要保持一致.

Yes: x == 1

No:  x<1

当’=’用于提示关键字参数或默认参数值时, 不要在其两侧使用空格.

Yes: def complex(real, imag=0.0): return magic(r=real, i=imag)

No:  def complex(real, imag = 0.0): return magic(r = real, i = imag)

无须用空格来垂直对齐多行间的符号, 因为这会化为维护的担当(适用于:, #,
=等):

Yes:
     foo = 1000  # comment
     long_name = 2  # comment that should not be aligned

     dictionary = {
         "foo": 1,
         "long_name": 2,
         }

No:
     foo       = 1000  # comment
     long_name = 2     # comment that should not be aligned

     dictionary = {
         "foo"      : 1,
         "long_name": 2,
         }

Python 解析器

Tip
绝大多数分.py文件不必以#!作为文件的初步. 依照
PEP-394
, 程序的main文件应该以#!/usr/bin/python2或者 #!/usr/bin/python3开始.

(译者注: 在微机科学中,
Shebang
(也叫做Hashbang)是一个由井号和叹号构成的字符串行(#!),
其现出在文书文件的率先行的前多少个字符. 在文件中设有Shebang的情状下,
类Unix操作系统的顺序载入器会分析Shebang后的内容,
将那些内容作为解释器指令, 并调用该指令,
并将载有Shebang的文书路径作为该解释器的参数. 例如,
以指令#!/bin/sh开首的文件在履行时会实际调用/bin/sh程序.)
#!先用于扶持内核找到Python解释器, 但是在导入模块时, 将会被忽略.
由此只有被直接实施的文书中才有必不可少参预#!.

注释

Tip
担保对模块, 函数, 方法和行内注释使用正确的风格 文档字符串

Python有一种独一无二的的笺注模式: 使用文档字符串. 文档字符串是包, 模块,
类或函数里的第一个语句. 这些字符串可以经过对象的doc成员被自动提取,
并且被pydoc所用. (你可以在您的模块上运行pydoc试一把, 看看它长什么样).
咱们对文档字符串的常规是运用三重双引号”“”(
PEP-257
). 一个文档字符串应该如此社团: 首先是单排以句号,
问号或惊讶号结尾的概述(或者该文档字符串单纯只有一行). 接着是一个空行.
接着是文档字符串剩下的一些, 它应该与文档字符串的首先行的首先个引号对齐.
底下有更多文档字符串的格式化规范.
模块

各类文件应该包含一个许可样板. 依据项目利用的批准(例如, Apache 2.0, BSD,
LGPL, GPL), 选用合适的样板.
函数和章程

下文所指的函数,包括函数, 方法, 以及生成器.

一个函数必须要有文档字符串, 除非它满意以下标准:

  1. 外表不可见
  2. 相当短小
  3. 简单明了

文档字符串应该包含函数做怎么着, 以及输入和出口的详细描述. 平日,
不应该描述”咋办”, 除非是一对错综复杂的算法. 文档字符串应该提供丰硕的信息,
当别人编写代码调用该函数时, 他不需要看一行代码,
只要看文档字符串就可以了. 对于复杂的代码,
在代码旁边加注释会比选用文档字符串更有意义.

关于函数的多少个方面应当在特定的小节中展开描述记录, 这些方面如下文所述.
每节应该以一个标题行开始. 标题行以冒号结尾. 除标题行外,
节的另外内容应被缩进2个空格.

Args:
列出每个参数的名字, 并在名字后使用一个冒号和一个空格,
分隔对该参数的描述.假设描述太长超越了单行80字符,使用2依旧4个空格的悬挂缩进(与公事其他一些保持一致).
描述应该包括所需的连串和含义.
假使一个函数接受foo(可变长度参数列表)或者bar (任意关键字参数),
应该详细列出
foo和**bar.

Returns: (或者 Yields: 用于生成器)
叙述重临值的系列和语义. 假若函数重返None, 这一局部可以省略.

Raises:
列出与接口有关的拥有很是.

def fetch_bigtable_rows(big_table, keys, other_silly_variable=None):
    """Fetches rows from a Bigtable.

    Retrieves rows pertaining to the given keys from the Table instance
    represented by big_table.  Silly things may happen if
    other_silly_variable is not None.

    Args:
        big_table: An open Bigtable Table instance.
        keys: A sequence of strings representing the key of each table row
            to fetch.
        other_silly_variable: Another optional variable, that has a much
            longer name than the other args, and which does nothing.

    Returns:
        A dict mapping keys to the corresponding table row data
        fetched. Each row is represented as a tuple of strings. For
        example:

        {'Serak': ('Rigel VII', 'Preparer'),
         'Zim': ('Irk', 'Invader'),
         'Lrrr': ('Omicron Persei 8', 'Emperor')}

        If a key from the keys argument is missing from the dictionary,
        then that row was not found in the table.

    Raises:
        IOError: An error occurred accessing the bigtable.Table object.
    """
    pass

类应该在其定义下有一个用于描述该类的文档字符串.
假设你的类有集体性质(Attributes),
那么文档中应有有一个特性(Attributes)段.
并且应该按照和函数参数相同的格式.

class SampleClass(object):
    """Summary of class here.

    Longer class information....
    Longer class information....

    Attributes:
        likes_spam: A boolean indicating if we like SPAM or not.
        eggs: An integer count of the eggs we have laid.
    """

    def __init__(self, likes_spam=False):
        """Inits SampleClass with blah."""
        self.likes_spam = likes_spam
        self.eggs = 0

    def public_method(self):
        """Performs operation blah."""

块注释和行注释

最需要写注释的是代码中这个技巧性的一对. 假诺您在下次
代码审查
的时候必须解释一下, 那么您应该现在就给它写注释. 对于复杂的操作,
应该在其操作起来前写上多少行注释. 对于不是吃透的代码,
应在其行尾添加注释.

# We use a weighted dictionary search to find out where i is in
# the array.  We extrapolate position based on the largest num
# in the array and the array size and then do binary search to
# get the exact number.

if i & (i-1) == 0:        # true iff i is a power of 2

为了增强可读性, 注释应该至少离开代码2个空格.

另一方面, 不要要讲述代码. 假使阅读代码的人比你更懂Python,
他只是不理解您的代码要做什么.

# BAD COMMENT: Now go through the b array and make sure whenever i occurs
# the next element is i+1

Tip
倘若一个类不连续自此外类, 就显式的从object继承. 嵌套类也一样.

Yes: class SampleClass(object):
         pass


     class OuterClass(object):

         class InnerClass(object):
             pass


     class ChildClass(ParentClass):
         """Explicitly inherits from another class already."""

No: class SampleClass:
        pass


    class OuterClass:

        class InnerClass:
            pass

继承自 object 是为着使属性(properties)正常干活,
并且这样可以维护你的代码, 使其不受Python
3000的一个非凡的机密不兼容性影响. 这样做也定义了一部分特此外艺术,
这个情势实现了目的的默认语义, 包括
__new__, __init__, __delattr__, __getattribute__, __setattr__, __hash__, __repr__, and __str__
.

字符串

Tip
虽然参数都是字符串, 使用%操作符或者格式化方法格式化字符串.
不过也无法不分轩轾, 你需要在+和%期间可以判定.

Yes: x = a + b
     x = '%s, %s!' % (imperative, expletive)
     x = '{}, {}!'.format(imperative, expletive)
     x = 'name: %s; score: %d' % (name, n)
     x = 'name: {}; score: {}'.format(name, n)

No: x = '%s%s' % (a, b)  # use + in this case
    x = '{}{}'.format(a, b)  # use + in this case
    x = imperative + ', ' + expletive + '!'
    x = 'name: ' + name + '; score: ' + str(n)

避免在循环中用+和+=操作符来累加字符串. 由于字符串是不可变的,
这样做会制造不必要的暂时对象, 并且导致二次方而不是线性的运转时间.
作为代表方案, 你可以将每个子串参预列表, 然后在循环为止后用 .join
连接列表. (也足以将各种子串写入一个 cStringIO.StringIO 缓存中.)

Yes: items = ['<table>']
     for last_name, first_name in employee_list:
         items.append('<tr><td>%s, %s</td></tr>' % (last_name, first_name))
     items.append('</table>')
     employee_table = ''.join(items)

No: employee_table = '<table>'
    for last_name, first_name in employee_list:
        employee_table += '<tr><td>%s, %s</td></tr>' % (last_name, first_name)
    employee_table += '</table>'

在同一个文件中, 保持利用字符串引号的相同性.
使用单引号’或者双引号”之一用以引用字符串, 并在同一文件中沿用.
在字符串内足以采取此外一种引号, 以避免在字符串中运用.
GPyLint已经参预了这一检查.

(译者注:GPyLint疑为笔误, 应为PyLint.)

Yes:
     Python('Why are you hiding your eyes?')
     Gollum("I'm scared of lint errors.")
     Narrator('"Good!" thought a happy Python reviewer.')

No:
     Python("Why are you hiding your eyes?")
     Gollum('The lint. It burns. It burns us.')
     Gollum("Always the great lint. Watching. Watching.")

为多行字符串使用三重双引号”“”而非三重单引号’‘’.
当且仅当项目中行使单引号’来引用字符串时,
才可能会采用三重’‘’为非文档字符串的多行字符串来标识引用.
文档字符串必须使用三重双引号”“”. 但是要留意, 平常用隐式行连接更显著,
因为多行字符串与程序其他一些的缩进形式不一致.

Yes:
    print ("This is much nicer.\n"
           "Do it this way.\n")

No:
      print """This is pretty ugly.
  Don't do this.
  """

文件和sockets

Tip
在文书和sockets截止时, 显式的关门它.

除文件外, sockets或任何类似文件的对象在尚未必要的情形下开拓,
会有诸多副成效, 例如:

  1. 它们或者会消耗一定量的系统资源,如文件讲述符.假使这一个资源在行使后不曾霎时归还系统,那么用于拍卖这么些目标的代码会将资源消耗殆尽.
  2. 有着文件将会阻拦对于文本的此外诸如移动、删除之类的操作.
  3. 偏偏是从逻辑上关闭文件和sockets,那么它们依旧可能会被其共享的主次在无形中中举行读或者写操作.唯有当它们确实被关闭后,对于它们尝试举行读或者写操作将会跑出特别,并使得问题很快显现出来.

并且,幻想当文件对象析构时,文件和sockets会自动关闭,试图将文件对象的生命周期和文书的气象绑定在同步的想法,都是不现实的.
因为有如下原因:

  1. 从不此外方法可以保证运行条件会真的的执行文书的析构.不同的Python实现采取不同的内存管理技术,比如延时垃圾处理机制.
    延时垃圾处理机制可能会导致对象生命周期被随机无界定的延长.
  2. 对此文本意外的引用,会造成对于文本的有所时间大于预想(比如对于特其余跟踪,
    包含有全局变量等).

推介应用“with”语句
以管理文件:

with open("hello.txt") as hello_file:
    for line in hello_file:
        print line

对此不补助选取”with”语句的近乎文件的靶子,使用 contextlib.closing():

import contextlib

with contextlib.closing(urllib.urlopen("http://www.python.org/")) as front_page:
    for line in front_page:
        print line

Legacy AppEngine 中Python 2.5的代码如接纳”with”语句, 需要添加
“from __future__ import with_statement”.

TODO注释

Tip
为临时代码应用TODO注释, 它是一种短时间解决方案. 不算圆满, 但够好了.

TODO注释应该在具有起初处带有”TODO”字符串,
紧跟着是用括号括起来的你的名字, email地址或另外标识符.
然后是一个可选的冒号. 接着必须有一行注释, 解释要做咋样.
首要目标是为了有一个合并的TODO格式,
这样添加注释的人就可以找寻到(并得以按需提供更多细节).
写了TODO注释并不保险写的人会亲自解决问题. 当您写了一个TODO,
请注上你的名字.

# TODO(kl@gmail.com): Use a "*" here for string repetition.
# TODO(Zeke) Change this to use relations.

要是您的TODO是”将来做某事”的款型,
那么请确保您包含了一个指定的日子(“二〇〇九年8月解决”)或者一个特定的事件(“等到具备的客户都可以拍卖XML请求就移除那些代码”).

导入格式

Tip
各样导入应该占据一行

Yes: import os
     import sys

No:  import os, sys

导入总应该置身文件顶部, 位于模块注释和文档字符串之后,
模块全局变量和常量在此以前. 导入应该遵循从最通用到最不通用的各种分组:

  1. 标准库导入
  2. 其三方库导入
  3. 应用程序指定导入

每种分组中, 应该按照各样模块的完整包路径按字典序排序, 忽略大小写.

import foo
from foo import bar
from foo.bar import baz
from foo.bar import Quux
from Foob import ar

语句

Tip
万般每个语句应该占据一行

可是, 假诺测试结果与测试语句在一行放得下, 你也可以将它们放在同等行.
要是是if语句, 唯有在没有else时才能如此做. 特别地, 绝不要对 try/except
这样做, 因为try和except不可以放在同等行.

Yes:

  if foo: bar(foo)

No:

  if foo: bar(foo)
  else:   baz(foo)

  try:               bar(foo)
  except ValueError: baz(foo)

  try:
      bar(foo)
  except ValueError: baz(foo)

访问控制

Tip
在Python中,
对于琐碎又不太首要的造访函数,你应当直接行使国有变量来取代它们,那样可以避免额外的函数调用开销.当添加更多职能时,
你可以用属性(property)来保障语法的平等性.

(译者注: 重视封装的面向对象程序员看到那多少个可能会很反感,
因为他们间接被辅导: 所有成员变量都不可以不是个人的! 其实,
这实在是有点麻烦啊.试着去领受Pythonic医学吧)

一方面, 即使访问更复杂, 或者变量的走访开销很彰着, 那么您应当利用像
get_foo()set_foo() 这样的函数调用.
如若以前的代码行为容许通过性能(property)访问 ,
那么就不用将新的拜访函数与性能绑定. 这样,
任何准备通过老方法访问变量的代码就无奈运行,
使用者也就会发现到复杂暴发了变化.

命名

Tip
module_name, package_name, ClassName, method_name,
ExceptionName,function_name, GLOBAL_VAR_NAME, instance_var_name,
function_parameter_name, local_var_name.

应该制止的名称

  1. 单字符名称, 除了计数器和迭代器.
  2. 包/模块名中的连字符(-)
  3. 双下划线起先并最后的称谓(Python保留, 例如init)

取名约定

  1. 所谓”内部(Internal)”表示仅模块内可用, 或者, 在类内是保障或个人的.
  2. 用单下划线(_)初阶表示模块变量或函数是protected的(使用import *
    from时不会包含).
  3. 用双下划线(__)开端的实例变量或艺术表示类内私有.
  4. 将有关的类和一级函数放在同一个模块里. 不像Java,
    没必要限制一个类一个模块.
  5. 对类名使用大写字母先导的单词(如CapWords,即Pascal风格),可是模块名应当用小写加下划线的不二法门(如lower_with_under.py).
    即使已经有这多少个现存的模块使用类似于CapWords.py这样的命名,但现在早就不鼓励这样做,因为若是模块名正要和类一致,
    那会令人烦扰.
Type Public Internal
Modules lower_with_under _lower_with_under
Packages lower_with_under
Classes CapWords _CapWords
Exceptions CapWords
Functions lower_with_under() lower_with_under()
Global/Class Constants CAPS_WITH_UNDER CAPS_WITH_UNDER
Global/Class Variables lower_with_under lower_with_under
Instance Variables lower_with_under _lower_with_under (protected) or __lower_with_under (private)
Method Names lower_with_under() _lower_with_under() (protected) or __lower_with_under() (private)
Function/Method Parameters lower_with_under
Local Variables lower_with_under

Python之父Guido推荐的科班

Type Public Internal
Modules lower_with_under _lower_with_under
Packages lower_with_under
Classes CapWords _CapWords
Exceptions CapWords
Functions lower_with_under() lower_with_under()
Global/Class Constants CAPS_WITH_UNDER CAPS_WITH_UNDER
Global/Class Variables lower_with_under lower_with_under
Instance Variables lower_with_under _lower_with_under (protected) or __lower_with_under (private)
Method Names lower_with_under() _lower_with_under() (protected) or __lower_with_under() (private)
Function/Method Parameters lower_with_under
Local Variables lower_with_under

Main

Tip
哪怕是一个打算被视作脚本的文件,也应当是可导入的.并且简单的导入不应有导致这多少个本子的主功效(mainfunctionality)被执行,
这是一种副效能. 主功效应该放在一个main()函数中.

在Python中, pydoc以及单元测试要求模块必须是可导入的.
你的代码应该在执行主程序前总是检查 if __name__ == '__main__' ,
这样当模块被导入时主程序就不会被执行.

def main():
      ...

if __name__ == '__main__':
    main()

拥有的顶尖代码在模块导入时都会被执行. 要小心不要去调用函数,
创设对象或者举行这一个不应当在拔取pydoc时实施的操作.

临别赠言

请务必保持代码的一致性

设若您正在编纂代码,
花几分钟看一下大规模代码,然后决定风格.如果它们在拥有的算术操作符两边都施用空格,那么你也应该这么做.
假使它们的诠释都用标记包围起来, 那么你的声明也要这样.

制定风格指南的意在让代码有规可循,这样人们就可以小心于”你在说咋样”,而不是”你在怎么说”.我们在这里给出的是大局的正经,
可是本土的正经同样重要.倘诺你加到一个文书里的代码和原始代码暗淡无光,它会让读者不知所可.防止这种情形.

参考:

Leave a Comment.