谷歌 Python风格指南

  • Python是一种对代码风格很重视的语言,从缩进就能观察这或多或少,Python强调易于明白。如今在承担代码重构的行事,为了统一我们的代码风格,制订规范,学习了弹指间网上那份谷歌的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是”往后做某事”的花样,
那么请确保您包含了一个点名的日期(“二零零六年10月解决”)或者一个一定的轩然大波(“等到独具的客户都可以拍卖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时实施的操作.

临别赠言

请务必保持代码的一致性

尽管你正在编制代码,
花几分钟看一下常见代码,然后决定风格.即使它们在具备的算术操作符两边都接纳空格,那么您也理应这么做.
假使它们的阐明都用标记包围起来, 那么您的笺注也要那样.

制订风格指南的意在让代码有规可循,这样人们就足以小心于”你在说咋样”,而不是”你在怎么说”.我们在此地给出的是大局的规范,
不过地点的标准同样重要.如果你加到一个文件里的代码和原来代码方枘圆凿,它会让读者不知道该肿么办.避免这种情形.

参考:

相关文章