这些bug通常由编译器来捕获. 由于Python的动态特性。所以整了部分Python的言语专业地方的东东。

  • Python是千篇一律种对代码风格非常注重的语言,从缩进就能来看这或多或少,Python强调易于理解。最近当荷代码重构的干活,为了统一大家的代码风格,制订规范,学习了瞬间网上立即卖Google的Python风格指南。

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

前面写代码感觉一直缺乏一定之标准,所以整了有些Python的言语专业方的东东,这个来google发布的开源项目风格指南-Python语言专业。

背景

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

1、对而的代码运行pylint

Python语言专业

定义:

pylint是一个当Python源代码中查找bug的工具.
对于C和C++这样的未那么动态的(译者注: 原文是less dynamic)语言,
这些bug通常由编译器来捕获. 由于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)

导入时毫不采取相对名称. 即使模块于与一个包中, 也要是运用完整包名.
这能够协助你避免无意间导入一个担保半糟糕.

缺点:

pylint不收美. 要以该优势, 我们有时候侯需要: a) 围绕在它来描写代码 b)
抑制其报警 c) 改进其, 或者d) 忽略它.

Tip
以模块的方方面面径名来导入每个模块

优点:
避模块名冲突. 查找包又容易.
缺点:
布代码变难, 因为你必复制包层次.
结论:
具的新代码都应有为此整包名来导入每个模块.

该像下这样导入:

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

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

结论:

担保对你的代码运行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
同意行使特别, 但必须小心

定义:
好是千篇一律种跳出代码块的正规控制流来处理错误或者其它异常条件的方式.
优点:
例行操作代码的控制流动不见面和错误处理代码乱在一起. 当某种条件有时,
它吗允许控制流跳过多个框架. 例如, 一步跳出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

2、仅对管及模块使用导入

全局变量

Tip
避全局变量

定义:
概念在模块级的变量.
优点:
偶尔有用.
缺点:
导入时或者变动模块行为, 因为导入模块时会指向模块级变量赋值.
结论:
避下全局变量, 用类变量来代替. 但也发生一些异:

  1. 剧本的默认选项项.
  2. 模块级常量. 例如: PI = 3.14159. 常量应该全大写, 用下划线连接.
  3. 奇迹用全局变量来缓存值或者作为函数返回值大有用.
  4. 比方急需, 全局变量应该就于模块内部可用,
    并通过模块级的官函数来访问.

定义:

模块间共享代码的选用机制.

嵌套 局部 内部类还是函数

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

定义:
接近可以定义在方, 函数或者类中. 函数可以定义在术还是函数中.
封闭区间中定义之变量对嵌套函数是就读的.
优点:
同意定义仅用于中限制的工具类和函数.
缺点:
镶套类或小卖部项目的实例不能够序列化(pickled).
结论:
引进使用.

优点:

取名空间管理约定很简单. 每个标识符的源都用同样种同等的法指示.
x.Obj表示Obj对象定义在模块x中.

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

结论:

采取 import x 来导入包及模块.

使用 from x import y , 其中x是保证前缀, y是无带来前缀的模块名.

采用 from x import y as z, 如果两只假设导入的模块都叫做y或者y太长了.

诸如, 模块 sound.effects.echo 可以用如下方式导入:

from sound.effects import echo

echo.EchoFilter(input, output, delay=0.7, atten=4)

导入时毫无采用相对名称. 即使模块于跟一个包中, 也如动用完全包名.
这会支援而免无意间导入一个保证半不良.

生成器

Tip
按需使用生成器.

定义:
所谓生成器函数, 就是于她执行同样蹩脚变动(yield)语句, 它便归一个迭代器,
这个迭代器生成一个值. 生成值后, 生成器函数的运行状态将给挂于,
直到下一致次于生成.
优点:
简化代码, 因为每次调用时, 局部变量和控制流的状态还见面给保存.
比从一浅创同雨后春笋值的函数, 生成器使用的内存更少.
缺点:
没有.
结论:
勉励使用. 注意在生成器函数的文档字符串中行使”Yields:”而非是”Returns:”.
(译者注: 参看
注释
)

3、使用模块的整套径名来导入每个模块

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

结论:

有的新代码都应当据此整包名来导入每个模块.

当像下这样导入:

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

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

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

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

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)

优点:

正规操作代码的决定流动不见面及错误处理代码乱在一起. 当某种条件发出常,
它也允许控制流跳过多独框架. 例如, 一步跳出N个嵌套的函数,
而不必继续执行错误的代码.

词法作用域 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 的话题.

结论:

杀要遵特定条件:

如这么触发异常: raise MyException(“Error message”) 或者 raise
MyException . 不要动有限独参数的花样( raise MyException, “Error message”
)或者过时的字符串异常( raise “Error message” ).

模块或担保应该定义自己之特定域的挺基类,
这个基类应该从内建的Exception类继承. 模块的老基类应该叫做”Error”.

class Error(Exception):
    pass

世世代代不要采取 except: 语词来捕获所有特别, 也不用捕获 Exception 或者
StandardError , 除非你打算再触发该老,
或者您早已于当前线程的最为外层(记得要要打印一条错误信息). 在异常这地方,
Python非常宽容, except: 真的会捕获连Python语法错误在内的外错误. 使用
except: 很轻隐藏真正的bug.

尽量减少try/except块被的代码量. try块的体积越充分,
期望之外的万分就逾容易给触发. 这种情况下, try/except块用藏真正的错误.

采取finally子句来实行那些无try块中出无发生很且应于执行之代码.
这对于清理资源时十分有因此, 例如关闭文件.

当捕获异常时, 使用 as 而并非为此逗号. 例如

try:
    raise Error
except Error as error:
    pass

线程

Tip
并非借助内建造项目的原子性.

虽说Python的内建类型例如字典看上去有原子操作,
但是在一些情形下她还是未是原子的(即:
如果__hash____eq__给实现吗Python方法)且她的原子性是因不歇的.
你吧无可知想原子变量赋值(因为是反过来依赖字典).

事先利用Queue模块的 Queue 数据类型作为线程间的数码通信方式. 另外,
使用threading模块及其锁原语(locking primitives).
了解条件变量的宜使用方法, 这样您就得下 threading.Condition
来取代低级别之锁了.

5、避免全局变量

威力过好之特点

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

只顾点例子中的元素缩进; 你得以本文的 缩进 部分找到解释.

结论:

避用全局变量, 用类变量来代替. 但也闹一些差:

剧本的默认选项项.
模块级常量. 例如: PI = 3.14159. 常量应该全大写, 用下划线连接.
偶然用全局变量来缓存值或者当做函数返回值老有用.
若需要, 全局变量应该仅仅于模块内部可用, 并通过模块级的公家函数来访问.

括号

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)

6、鼓励下嵌套/本地/内部类还是函数

缩进

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

缺点:

镶套类或商店项目的实例不能够序列化(pickled).

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

7、可以在简短情况下行使列表推导

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

定义:

列表推导(list comprehensions)与生成器表达式(generator
expression)提供了一如既往种植精简高效的计来创造列表和迭代器, 而不必借助map(),
filter(), 或者lambda.

字符串

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请求虽移除这些代码”).

结论:

适用于简单情况. 每个有该单独置于一行: 映射表达式, 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
每个导入应该把一行

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

8、默认迭代器和操作符

语句

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

假若类型支持, 就采用默认迭代器和操作符. 比如列表, 字典及文件等.

访问控制

Tip
每当Python中,
对于琐碎又不顶重要的访函数,你应当一直使用国有变量来取代她,这样好免额外的函数调用开销.当添加更多职能时,
你可以用性(property)来维持语法的一律性.

(译者注: 重视封装的面向对象程序员看到这个或许会见坏反感,
因为她们径直给感化: 所有成员变量都必须是私有的! 其实,
那实在是生接触麻烦啊.试着去受Pythonic哲学吧)

一头, 如果访问更复杂, 或者变量的走访开销很显, 那么您该使像
get_foo()set_foo() 这样的函数调用.
如果前的代码行为容许通过性能(property)访问 ,
那么即使不用将新的造访函数和性绑定. 这样,
任何准备通过一直艺术访问变量的代码就无可奈何运行,
使用者也就会见意识及复杂发生了变化.

定义:

容器类, 像字典和列表, 定义了默认的迭代器和关系测试操作符(in和not in)

命名

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时实施之操作.

缺点:

乃没法通过翻阅方式名来区别对象的档次(例如, 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(): ...

临别赠言

请求务必保持代码的一致性

设您在编写代码,
花几分钟看一下广代码,然后决定风格.如果它们在颇具的算术操作符两度都运空格,那么您吗理应这样做.
如果其的笺注都用标记包围起来, 那么你的注释也要是立即样.

制订风格指南的目的在为代码来规可循,这样人们便足以小心让”你以说啊”,而无是”你在怎么说”.我们于此给出底是全局的正经,
但是本地的正统同样重要.如果您加至一个文本里的代码和原始代码大相径庭,它会叫读者不知所措.避免这种情况.

9、按需要用生成器

参考:

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

定义:

所谓生成器函数, 就是以她实施同一浅变动(yield)语句, 它就回来一个迭代器,
这个迭代器生成一个值. 生成值后, 生成器函数的运作状态将吃吊起于,
直到下一致潮生成.

优点:

简化代码, 因为每次调用时, 局部变量和控制流的状态且见面被保存.
比从一不善创同多元值的函数, 生成器使用的内存更少.

缺点:

没有.

结论:

鼓励用. 注意在生成器函数的文档字符串中采用”Yields:”而未是”Returns:”.

10、Lambda函数

Tip

适用于单行函数

定义:

与话语相反, lambda以一个表达式中定义匿名函数. 常用来为 map() 和 filter()
之类的高阶函数定义回调函数或者操作符.

优点:

方便.

缺点:

比较当地函数更难以阅读与调试. 没有函数叫作代表堆栈跟踪更难理解.
由于lambda函数通常只有包含一个表达式, 因此其表达能力有限.

结论:

适用于单行函数. 如果代码超过60-80独字符, 最好要定义成常规(嵌套)函数.

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

11、条件表达式

Tip

适用于单行函数

定义:

法表达式是对此if语句的等同种更加简易的句法规则. 例如:

x = 1 if cond else 2 .

优点:

于if语句更加简约和方便.

缺点:

正如if语句难于阅读. 如果表达式很丰富, 难于固定条件.

结论:

适用于单行函数. 在其余情况下,推荐用完全的if语句.

12、默认参数值

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

13、属性(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

14、尽可能采取隐式false

定义:

Python在布尔上下文中会将或多或少值求值为false. 按简单的直觉来讲,
就是所有的”空”值都为认为是false. 因此0, None, [], {}, “”
都被当是false.

优点:

采用Python布尔值的法语句再度爱读吧再也科学犯错. 大部分情下, 也又快.

缺点:

对C/C++开发人员来说, 可能看起有些怪.

结论:

尽量使用隐式的false, 例如: 使用 if foo: 而非是 if foo != []: .
不过要来一部分注意事项需要你难以忘怀:

永不要为此==或者!=来比单件, 比如None. 使用is或者is not.

在意: 当你勾勒下 if x: 时, 你其实表示的凡 if x is not None . 例如:
当你如果测试一个默认值是None的变量或参数是否让如为其它值.
这个价当布尔语义下可能是false!

永久不要用==将一个布尔量与false相比较. 使用 if not x: 代替.
如果你要区分false和None, 你应当用像 if not x and x is not None:
这样的语句.

于序列(字符串, 列表, 元组), 要留心空序列是false. 因此 if not seq: 或者
if seq: 比 if len(seq): 或 if not len(seq): 要双重好.

处理整数时, 使用隐式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()

顾‘0’(字符串)会给当true.

15、过时的言语特色

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)

16、推荐以词法作用域(Lexical Scoping)

定义:

嵌套的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

优点:

通常可以拉动更为鲜明, 优雅的代码.
尤其会吃来更的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++之类的静态语言或发生死十分区别之.)

结论:

鞭策使用.

17、函数和方装饰器

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

18、线程

Tip

不用因内建造类的原子性.
虽Python的内建类型例如字典看上去拥有原子操作,
但是在少数情形下它们仍然未是原子的(即:
如果hasheq叫实现吗Python方法)且其的原子性是因不停歇的.
你为无克指望原子变量赋值(因为是反过来依赖字典).

先期采取Queue模块的 Queue 数据类型作为线程间的数码通信方式. 另外,
使用threading模块及其锁原语(locking primitives).
了解条件变量的恰到好处使用方式, 这样你便好动用 threading.Condition
来代替低级别之锁了.

19、避免使用威力过特别之特点

定义:

Python是一样种植非常灵活的言语, 它吗您提供了不少鲜艳的性状,
诸如元类(metaclasses), 字节码访问, 任意编译(on-the-fly compilation),
动态继承, 对象父类重定义(object reparenting), 导入黑客(import hacks),
反射, 系统外修改(modification of system internals), 等等.

优点:

有力的言语特色, 能于你的代码更困难凑.

缺点:

应用这些特别”酷”的特性十分诱人, 但不是绝必要.
使用奇技淫巧的代码用越发难阅读和调试. 开始容许还好(对原作者而言),
但当你回顾代码, 它们或会见比较那些稍长一点但充分直接的代码更加不便理解.

结论:

以您的代码中避免这些特性.

相关文章