Google Python风格指南

        2011年之非常秋天,我提到了一如既往桩大事。

  • Python是相同种对代码风格很倚重的言语,从缩进就能观看这一点,Python强调易于理解。最近于荷代码重构的办事,为了统一大家之代码风格,制订规范,学习了一晃网上即时卖Google的Python风格指南。

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

        骑自行车,一个口,从北京交青岛。

背景

Python 是
Google主要的脚本语言。这仍风格指南主要涵盖的凡对准python的编程准则。
啊协读者能以代码准确格式化,我们提供了针对 Vim的部署文件
。对于Emacs用户,保持默认设置即可。

       
算一算是在祥和曾度过三十年的人生更里,要说疯狂,要说冒险,这是条同一桩。用朋友等的语句来说,就是好以来吹一辈子牛。

Python语言专业

       
回头想,这个动机最早萌芽于2007年。那无异年,我大三,在一如既往潮学校社团的大团圆及,认识了一个山东同学,该君刚刚花四上时间得了平等不成打京暨济南的骑行。好多丁围在,听他绘声绘色地讲话旅途中的故事。

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).
结论:
推荐使用.

       
住宿,因为骑行的路径上多是环渤海一线人口稠密的大中城市,没有荒山野岭,就各国隔100公里左右的相距,挑选几寒快捷酒店。人身安全是首先号,还会见以及酒店承认能否将车促进到大堂或客房里。

列表推导 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.

       
最后三龙,体力开始免支付,原先规划之每日100公里无法到位。只能拖了扳平天。骑到最后,感觉温馨早已休会见履了。

老式的语言特色

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是”将来开某事”的款式,
那么请确保您包含了一个指定的日期(“2009年11月解决”)或者一个一定的事件(“等交持有的客户都可以拍卖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时实行的操作.

临别赠言

呼吁务必保持代码的一致性

倘您方编辑代码,
花几分钟看一下大面积代码,然后决定风格.如果它们于具有的算术操作符两边都使用空格,那么您呢理应如此做.
如果它的诠释都为此标记包围起来, 那么您的注释也要及时样.

制定风格指南的目的在于受代码来规可循,这样人们就可以小心让”你以游说啊”,而未是”你当怎么说”.我们在此处给有底凡全局的规范,
但是本地的专业同样重要.如果你加至一个文件里之代码和初代码大相径庭,它见面被读者不知所措.避免这种情况.

参考:

  • Google Python 风格指南 –
    中文版
  • zh-google-styleguide
  • Google
    Python风格指南