谷歌(Google) Python风格指南

线程

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

即使如此Python的内建档次例如字典看上去拥有原子操作,
不过在少数情状下它们依然不是原子的(即:
假使__hash____eq__被已毕为Python方法)且它们的原子性是靠不住的.
你也不可以仰望原子变量赋值(因为这么些反过来爱戴字典).

先行利用Queue模块的 Queue 数据类型作为线程间的数目通讯方式. 别的,
使用threading模块及其锁原语(locking primitives).
明白条件变量的适度使用办法, 这样你就足以应用 threading.Condition
来取代低级其余锁了.

访问控制

Tip
在Python中,
对于琐碎又不太主要的拜会函数,你应当从来利用国有变量来顶替它们,那样能够防止额外的函数调用开支.当添加越来越多效益时,
你可以用属性(property)来保持语法的一致性.

(译者注: 珍爱封装的面向对象程序员看到那个也许会很反感,
因为他俩一贯被引导: 所有成员变量都无法不是个体的! 其实,
那真的是有点麻烦啊.试着去领受Pythonic医学吧)

一方面, 要是访问更复杂, 或者变量的访问开销很显眼, 那么您应有使用像
get_foo()set_foo() 那样的函数调用.
如若在此以前的代码行为容许通过性能(property)访问 ,
那么就毫无将新的拜会函数与特性绑定. 那样,
任何试图透过老艺术访问变量的代码就抓耳挠腮运行,
使用者也就会意识到复杂暴发了变化.

Python语言专业

Tip
应用模块的上上下下径名来导入每个模块

优点:
防止模块名顶牛. 查找包更简单.
缺点:
安顿代码变难, 因为您不可能不复制包层次.
结论:
享有的新代码都应有用一体化包名来导入每个模块.

有道是像上面那样导入:

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

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

Lambda函数

Tip
适用于单行函数

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

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

背景

Python 是
谷歌(Google)首要的脚本语言。那本风格指南主要涵盖的是指向python的编程准则。
为帮扶读者可以将代码准确格式化,大家提供了针对 Vim的安插文件
。对于Emacs用户,保持默许设置即可。

导入

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)

导入时毫无选拔相对名称. 即便模块在同一个包中, 也要运用完整包名.
那能帮衬你防止无意间导入一个包四遍.

Python风格规范

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

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
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

文件和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”.

全局变量

Tip
幸免全局变量

定义:
概念在模块级的变量.
优点:
偶尔有用.
缺点:
导入时或许更改模块行为, 因为导入模块时会对模块级变量赋值.
结论:
防止选取全局变量, 用类变量来代替. 但也有一些不等:

  1. 本子的默许选项.
  2. 模块级常量. 例如: PI = 3.14159. 常量应该全大写, 用下划线连接.
  3. 奇迹用全局变量来缓存值或者当作函数重回值很有用.
  4. 假设必要, 全局变量应该仅在模块内部可用,
    并通过模块级的公家函数来访问.

括号

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
按需使用生成器.

定义:
所谓生成器函数, 就是每当它实施一遍变动(yield)语句, 它就再次来到一个迭代器,
这一个迭代器生成一个值. 生成值后, 生成器函数的运转景况将被挂起,
直到下几次生成.
优点:
简化代码, 因为老是调用时, 局地变量和控制流的动静都会被保存.
比起一遍创造一多样值的函数, 生成器使用的内存更少.
缺点:
没有.
结论:
勉励接纳. 注意在生成器函数的文档字符串中拔取”Yields:”而不是”Returns:”.
(译者注: 参看
注释
)

  • Python是一种对代码风格很强调的言语,从缩进就能观看那点,Python强调易于了解。目前在承担代码重构的做事,为了统一我们的代码风格,制订规范,学习了弹指间网上那份谷歌(Google)的Python风格指南。

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

异常

Tip
允许行使极度, 但必须小心

定义:
分外是一种跳出代码块的例行控制流来处理错误或者其余分外条件的情势.
优点:
常规操作代码的控制流不会和错误处理代码混在一起. 当某种条件暴发时,
它也同意控制流跳过七个框架. 例如, 一步跳出N个嵌套的函数,
而不必继续执行错误的代码.
缺点:
或许会造成令人纳闷的主宰流. 调用库时简单失去错误情形.
结论:
极度必须遵从特定条件:

  1. 像那样触发卓殊: raise MyException("Error message") 或者
    raise MyException . 不要采纳多个参数的款型(
    raise MyException, "Error message" )或者过时的字符串万分(
    raise "Error message" ).

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

    class Error(Exception):
        pass
  1. C++,永久不要选取 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
五星级定义之间空两行, 方法定义之间空一行

一级定义之间空两行, 比如函数或者类定义. 方法定义,
类定义与首个章程之间, 都应该空一行. 函数或方法中,
某些地点倘使你以为非凡, 就空一行.

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
每行不超过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
假诺一个类不一而再自其余类, 就显式的从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__
.

Python 解析器

Tip
大多数分.py文件不必以#!作为文件的开首. 根据
PEP-394
, 程序的main文件应当以#!/usr/bin/python2或者 #!/usr/bin/python3开始.

(译者注: 在电脑科学中,
Shebang
(也称之为Hashbang)是一个由井号和叹号构成的字符串行(#!),
其冒出在文件文件的第一行的前八个字符. 在文书中存在Shebang的意况下,
类Unix操作系统的先后载入器会分析Shebang后的情节,
将那一个情节作为解释器指令, 并调用该指令,
并将载有Shebang的文件路径作为该解释器的参数. 例如,
以指令#!/bin/sh初叶的文件在实施时会实际调用/bin/sh程序.)
#!先用于扶持内核找到Python解释器, 不过在导入模块时, 将会被忽略.
由此唯有被一向实施的文书中才有必不可少加入#!.

函数与方法装饰器

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 的话题.

Main

Tip
纵然是一个打算被视作脚本的公文,也应当是可导入的.并且简单的导入不该导致那么些本子的主效用(mainfunctionality)被实践,
那是一种副成效. 主作用应该置身一个main()函数中.

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

def main():
      ...

if __name__ == '__main__':
    main()

负有的一级代码在模块导入时都会被执行. 要小心不要去调用函数,
创设对象或者进行那个不该在选用pydoc时实施的操作.

缩进

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,
              ...
      }

词法成效域 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
万般每个语句应该占据一行

可是, 如若测试结果与测试语句在一行放得下, 你也得以将它们位于同样行.
借使是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是一种格外灵活的言语, 它为您提供了许多花里胡哨的性状,
诸如元类(metaclasses), 字节码访问, 任意编译(on-the-fly compilation),
动态继承, 对象父类重定义(object reparenting), 导入黑客(import hacks),
反射, 系统内修改(modification of system internals), 等等.
优点:
强大的语言特征, 能让您的代码更紧凑.
缺点:
应用这个很”酷”的特色格外诱人, 但不是相对须求.
使用奇技淫巧的代码将越加难以阅读和调试. 开端容许还好(对原小编而言),
但当你回看代码, 它们可能会比那几个稍长一点只是很直白的代码越发不便精晓.
结论:
在您的代码中防止那些特性.

空格

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,
         }

嵌套 局地 内部类或函数

Tip
鞭策利用嵌套/本地/内部类或函数

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

老式的言语特色

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)

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是”以后做某事”的格局,
那么请保管您包涵了一个点名的日期(“二〇〇九年二月缓解”)或者一个一定的事件(“等到持有的客户都得以拍卖XML请求就移除这一个代码”).

注释

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

属性 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

(译者注: 老实说, 我以为这段示例代码很不得当, 有要求那样蛋疼吗?)

导入格式

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语句的一种尤其不难的句法规则. 例如:
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...
         ...

字符串

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.
  """

临别赠言

请务必保持代码的一致性

若果你正在编制代码,
花几分钟看一下科普代码,然后决定风格.如若它们在拥有的算术操作符两边都应用空格,那么您也应有这么做.
如若它们的注明都用标记包围起来, 那么您的笺注也要那样.

创设风格指南的意在让代码有规可循,这样人们就可以小心于”你在说哪些”,而不是”你在怎么说”.我们在此处给出的是全局的正规,
然而本地的正式同样紧要.假诺您加到一个文书里的代码和原始代码黯淡无光,它会让读者无所适从.避免那种情况.

默许迭代器和操作符

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
毫不在行尾加分号, 也毫无用分号将两条命令放在同等行.