为此整理了有的Python的言语专业地方的东东,这几个bug日常由编译器来捕获. 由于Python的动态特性

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

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

事先写代码感觉平素缺失一定的正规化,所以整理了一些Python的言语专业地点的东东,那么些源于google揭橥的开源项目风格指南-Python语言专业。

背景

Python 是
谷歌首要的脚本语言。那本风格指南主要涵盖的是对准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是”以后做某事”的样式,
那么请保管您包括了一个点名的日子(“二零零六年7月缓解”)或者一个特定的风浪(“等到持有的客户都足以处理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、按需利用生成器

参考:

定义:

所谓生成器函数, 就是每当它执行三次变动(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), 等等.

优点:

有力的语言特征, 能让你的代码更紧凑.

缺点:

行使那么些很”酷”的特色万分诱人, 但不是相对需要.
使用奇技淫巧的代码将进一步难以阅读和调试. 开首容许还好(对原小编而言),
但当您想起代码, 它们可能会比那么些稍长一点可是很直接的代码越发难以通晓.

结论:

在你的代码中防止那一个特性.

相关文章