那么些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

适用于单行函数

语句

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

做客和设置数据成员时, 你无独有偶会拔取简易, 轻量级的造访和设置函数.
指出用属性(properties)来取代它们.

函数与方法装饰器

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

缺点:

你没法通过阅读形式名来区分对象的连串(例如, 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
尽可能拔取字符串方法取代字符串模块. 使用函数调用语法取代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)

定义:

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

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

定义:

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

Main

Tip
就是是一个打算被看成脚本的文件,也应有是可导入的.并且简单的导入不应该导致那多少个本子的主效率(mainfunctionality)被实施,
这是一种副效率. 主效率应该放在一个main()函数中.

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

def main():
      ...

if __name__ == '__main__':
    main()

抱有的头等代码在模块导入时都会被执行. 要小心不要去调用函数,
创制对象或者执行那一个不应当在利用pydoc时举办的操作.

结论:

运用 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)

导入时绝不拔取相对名称. 固然模块在同一个包中, 也要拔取完整包名.
这能匡助您防止无意间导入一个包三回.

背景

Python 是
Google重要的脚本语言。这本风格指南重要包含的是针对python的编程准则。
为扶持读者可以将代码准确格式化,大家提供了针对性 Vim的布局文件
。对于Emacs用户,保持默认设置即可。

缺点:

嵌套类或局项目标实例不可能系列化(pickled).

默认参数值

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

定义:

列表推导(list comprehensions)与生成器表明式(generator
expression)提供了一种简单高效的艺术来创立列表和迭代器, 而不必借助map(),
filter(), 或者lambda.

规格表达式

Tip
适用于单行函数

定义:
规则表明式是对于if语句的一种更加简易的句法规则. 例如:
x = 1 if cond else 2 .
优点:
比if语句更加简明和方便.
缺点:
比if语句难于阅读. 假如表明式很长, 难于固定条件.
结论:
适用于单行函数. 在此外情状下,推荐应用完全的if语句.

Tip

假如好处很扎眼, 就明智而严峻的采取装饰器

Python 解析器

Tip
绝大多数分.py文件不必以#!作为文件的起始. 依照
PEP-394
, 程序的main文件应该以#!/usr/bin/python2或者 #!/usr/bin/python3开始.

(译者注: 在电脑科学中,
Shebang
(也称之为Hashbang)是一个由井号和叹号构成的字符串行(#!),
其现身在文件文件的首先行的前多少个字符. 在文书中留存Shebang的场地下,
类Unix操作系统的程序载入器会分析Shebang后的始末,
将这一个情节作为解释器指令, 并调用该指令,
并将载有Shebang的文件路径作为该解释器的参数. 例如,
以指令#!/bin/sh开首的公文在推行时会实际调用/bin/sh程序.)
#!先用于支援内核找到Python解释器, 可是在导入模块时, 将会被忽略.
由此只有被直接执行的文件中才有必要参预#!.

缺点:

比本地函数更难阅读和调试. 没有函数名代表堆栈跟踪更难了然.
由于lambda函数平常只含有一个表明式, 因而其表达能力有限.

临别赠言

请务必保持代码的一致性

假诺您正在编制代码,
花几分钟看一下大规模代码,然后决定风格.假设它们在装有的算术操作符两边都应用空格,那么您也应该如此做.
如若它们的注明都用标记包围起来, 那么您的笺注也要这样.

成立风格指南的意在让代码有规可循,这样人们就足以小心于”你在说哪些”,而不是”你在怎么说”.我们在此处给出的是大局的标准,
不过本地的标准同样首要.假设您加到一个文书里的代码和原有代码暗淡无光,它会让读者罔知所措.避免那种情形.

优点:

大概的列表推导可以比其他的列表创立方法更加清晰简单.
生成器表明式可以相当高速, 因为它们制止了创办整个列表.

空行

Tip
顶尖定义之间空两行, 方法定义之间空一行

头号定义之间空两行, 比如函数或者类定义. 方法定义,
类定义与首个措施之间, 都应该空一行. 函数或模式中,
某些地点倘诺你以为非常, 就空一行.

4、允许拔取特别, 但必须小心

嵌套 局部 内部类或函数

Tip
勉励采纳嵌套/本地/内部类或函数

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

优点:

简化代码, 因为每一次调用时, 局部变量和控制流的场合都会被保存.
比起四遍创设一多级值的函数, 生成器使用的内存更少.

参考:

缺点:

模块名仍可能争辩. 有些模块名太长, 不太方便.

括号

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)

结论:

要是好处很明朗, 就明智而严刻的使用装饰器.
装饰器应该听从和函数一样的导入和命名规则.
装饰器的python文档应该清楚的验证该函数是一个装饰器.
请为装饰器编写单元测试.

避免装饰器自身对外围的倚重性(即决不借助于文件, socket, 数据库连接等),
因为装饰器运行时那一个资源可能不可用(由 pydoc 或此外工具导入).
应该保证一个用有效参数调用的装饰器在拥有情况下都是水到渠成的.

装饰器是一种新鲜形式的”一级代码”. 参考前边关于 Main 的话题.

Python风格规范

定义:

Python是一种很是灵活的语言, 它为您提供了许多花里胡哨的表征,
诸如元类(metaclasses), 字节码访问, 任意编译(on-the-fly compilation),
动态继承, 对象父类重定义(object reparenting), 导入黑客(import hacks),
反射, 系统内修改(modification of system internals), 等等.

全局变量

Tip
制止全局变量

定义:
概念在模块级的变量.
优点:
奇迹有用.
缺点:
导入时或者改动模块行为, 因为导入模块时会对模块级变量赋值.
结论:
防止接纳全局变量, 用类变量来代替. 但也有局部不等:

  1. 本子的默认选项.
  2. 模块级常量. 例如: PI = 3.14159. 常量应该全大写, 用下划线连接.
  3. 偶尔用全局变量来缓存值或者当作函数再次来到值很有用.
  4. 一旦需要, 全局变量应该仅在模块内部可用,
    并通过模块级的共用函数来访问.

9、按需使用生成器

导入格式

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

缺点:

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

结论:

您司空眼惯习惯于拔取访问或安装方法来走访或设置数据, 它们简单而轻量.
但是大家提出你在新的代码中动用属性. 只读属性应该用 @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
用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,
              ...
      }

结论:

勉励使用.

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.

结论:

担保对你的代码运行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
防止使用这个特征

定义:
Python是一种特别灵活的言语, 它为您提供了重重鲜艳的特征,
诸如元类(metaclasses), 字节码访问, 任意编译(on-the-fly compilation),
动态继承, 对象父类重定义(object reparenting), 导入黑客(import hacks),
反射, 系统内修改(modification of system internals), 等等.
优点:
强硬的言语特色, 能让你的代码更紧凑.
缺点:
应用这一个很”酷”的特色相当诱人, 但不是绝对必要.
使用奇技淫巧的代码将尤为难以阅读和调试. 开首容许还好(对原作者而言),
但当你想起代码, 它们可能会比这么些稍长一点不过很直接的代码更加不便精晓.
结论:
在你的代码中制止这么些特性.

定义:

当前版本的Python提供了我们常见更欣赏的替代品.

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

结论:

勉励施用, 不过有如下注意事项:

不用在函数或艺术定义中接纳可变对象作为默认值.

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

19、避免采用威力过大的特点

Python语言专业

优点:

常规操作代码的控制流不会和错误处理代码混在一起. 当某种条件发出时,
它也同意控制流跳过多少个框架. 例如, 一步跳出N个嵌套的函数,
而不必继续执行错误的代码.

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是”未来做某事”的样式,
那么请保管您包含了一个指定的日子(“二〇〇九年2月缓解”)或者一个特定的轩然大波(“等到具有的客户都可以处理XML请求就移除这么些代码”).

定义:

你能够在函数参数列表的最终指定变量的值, 例如:

def foo(a, b = 0)

如若调用foo时只带一个参数, 则b被设为0. 假如带两个参数,
则b的值等于第二个参数.

  • Python是一种对代码风格很看重的言语,从缩进就能来看这或多或少,Python强调易于了解。目前在承担代码重构的干活,为了统一大家的代码风格,制订规范,学习了一晃网上这份Google的Python风格指南。

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

优点:

方便.

注释

Tip
保证对模块, 函数, 方法和行内注释使用科学的风骨 文档字符串

Python有一种独一无二的的注释形式: 使用文档字符串. 文档字符串是包, 模块,
类或函数里的首先个语句. 这么些字符串可以透过对象的doc分子被电动提取,
并且被pydoc所用. (你可以在你的模块上运行pydoc试一把, 看看它长什么样).
大家对文档字符串的老规矩是利用三重双引号”“”(
PEP-257
). 一个文档字符串应该这样社团: 首先是单排以句号,
问号或感叹号结尾的概述(或者该文档字符串单纯只有一行). 接着是一个空行.
接着是文档字符串剩下的部分, 它应当与文档字符串的率先行的率先个引号对齐.
上边有更多文档字符串的格式化规范.
模块

每个文件应当包含一个许可样板. 依据项目采纳的认同(例如, Apache 2.0, BSD,
LGPL, GPL), 选取适宜的样板.
函数和措施

下文所指的函数,包括函数, 方法, 以及生成器.

一个函数必须要有文档字符串, 除非它满足以下规则:

  1. 外部不可见
  2. 这一个短小
  3. 简单明了

文档字符串应该包含函数做什么, 以及输入和出口的详细描述. 平日,
不应当描述”如何是好”, 除非是一对复杂的算法. 文档字符串应该提供充裕的音信,
当别人编写代码调用该函数时, 他不需要看一行代码,
只要看文档字符串就可以了. 对于复杂的代码,
在代码旁边加注释会比采纳文档字符串更有意义.

有关函数的多少个地点应当在特定的小节中展开描述记录, 这一个地方如下文所述.
每节应该以一个标题行起初. 标题行以冒号结尾. 除标题行外,
节的此外情节应被缩进2个空格.

Args:
列出每个参数的名字, 并在名字后使用一个冒号和一个空格,
分隔对该参数的描述.假使描述太长超越了单行80字符,使用2或者4个空格的悬挂缩进(与公事其他一些保持一致).
描述应该包括所需的品类和含义.
假使一个函数接受foo(可变长度参数列表)或者bar (任意关键字参数),
应该详细列出
foo和**bar.

Returns: (或者 Yields: 用于生成器)
讲述重返值的序列和语义. 若是函数重返None, 这一部分可以省略.

Raises:
列出与接口有关的持有非常.

def fetch_bigtable_rows(big_table, keys, other_silly_variable=None):
    """Fetches rows from a Bigtable.

    Retrieves rows pertaining to the given keys from the Table instance
    represented by big_table.  Silly things may happen if
    other_silly_variable is not None.

    Args:
        big_table: An open Bigtable Table instance.
        keys: A sequence of strings representing the key of each table row
            to fetch.
        other_silly_variable: Another optional variable, that has a much
            longer name than the other args, and which does nothing.

    Returns:
        A dict mapping keys to the corresponding table row data
        fetched. Each row is represented as a tuple of strings. For
        example:

        {'Serak': ('Rigel VII', 'Preparer'),
         'Zim': ('Irk', 'Invader'),
         'Lrrr': ('Omicron Persei 8', 'Emperor')}

        If a key from the keys argument is missing from the dictionary,
        then that row was not found in the table.

    Raises:
        IOError: An error occurred accessing the bigtable.Table object.
    """
    pass

类应该在其定义下有一个用来描述该类的文档字符串.
假设你的类有国有属性(Attributes),
那么文档中应该有一个性质(Attributes)段.
并且应该遵从和函数参数相同的格式.

class SampleClass(object):
    """Summary of class here.

    Longer class information....
    Longer class information....

    Attributes:
        likes_spam: A boolean indicating if we like SPAM or not.
        eggs: An integer count of the eggs we have laid.
    """

    def __init__(self, likes_spam=False):
        """Inits SampleClass with blah."""
        self.likes_spam = likes_spam
        self.eggs = 0

    def public_method(self):
        """Performs operation blah."""

块注释和行注释

最亟需写注释的是代码中这个技巧性的有些. 假诺您在下次
代码审查
的时候必须解释一下, 那么您应当现在就给它写注释. 对于复杂的操作,
应该在其操作起来前写上多少行注释. 对于不是洞察的代码,
应在其行尾添加注释.

# We use a weighted dictionary search to find out where i is in
# the array.  We extrapolate position based on the largest num
# in the array and the array size and then do binary search to
# get the exact number.

if i & (i-1) == 0:        # true iff i is a power of 2

为了进步可读性, 注释应该至少离开代码2个空格.

一面, 不要要讲述代码. 假若阅读代码的人比你更懂Python,
他只是不知道您的代码要做什么.

# BAD COMMENT: Now go through the b array and make sure whenever i occurs
# the next element is i+1

优点:

可以捕获容易忽略的不当, 例如输入错误, 使用未赋值的变量等.

分号

Tip
不要在行尾加分号, 也无须用分号将两条命令放在同等行.

Tip

适用于单行函数

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

定义:

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

生成器

Tip
按需使用生成器.

定义:
所谓生成器函数, 就是每当它实施一遍生成(yield)语句, 它就回去一个迭代器,
这多少个迭代器生成一个值. 生成值后, 生成器函数的运行情形将被挂起,
直到下一次生成.
优点:
简化代码, 因为老是调用时, 局部变量和控制流的情事都会被保存.
比起五遍创造一文山会海值的函数, 生成器使用的内存更少.
缺点:
没有.
结论:
鼓励使用. 注目的在于生成器函数的文档字符串中利用”Yields:”而不是”Returns:”.
(译者注: 参看
注释
)

Tip

适用于大部分意况.

词法功能域 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++之类的静态语言仍旧有很大差其余.)
结论:
勉励使用.

结论:

我们不利用不扶助这多少个特征的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)

访问控制

Tip
在Python中,
对于琐碎又不太重要的走访函数,你应该从来运用国有变量来代表它们,这样可以制止额外的函数调用开销.当添加更多效益时,
你可以用属性(property)来维系语法的等同性.

(译者注: 重视封装的面向对象程序员看到那一个或许会很反感,
因为她俩直白被感化: 所有成员变量都必须是私家的! 其实,
这真的是有点麻烦啊.试着去领受Pythonic经济学吧)

一边, 倘使访问更扑朔迷离, 或者变量的访问开销很强烈, 那么您应当采用像
get_foo()set_foo() 那样的函数调用.
假使从前的代码行为容许通过性能(property)访问 ,
那么就无须将新的拜访函数与性能绑定. 这样,
任何试图透过老方法访问变量的代码就没法运行,
使用者也就会发觉到复杂发生了变化.

优点:

一般而言可以带动更加显著, 优雅的代码.
尤其会让有经验的Lisp和Scheme(还有Haskell, ML等)程序员感到欣慰.

默认迭代器和操作符

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(): ...

优点:

同意定义仅用于有效限制的工具类和函数.

Lambda函数

Tip
适用于单行函数

定义:
与话语相反, lambda在一个表达式中定义匿名函数. 常用来为 map()
filter() 之类的高阶函数定义回调函数或者操作符.
优点:
方便.
缺点:
比本地函数更难阅读和调试. 没有函数名代表堆栈跟踪更难通晓.
由于lambda函数日常只含有一个表明式, 由此其表明能力有限.
结论:
适用于单行函数. 假如代码超过60-80个字符, 最好或者定义成常规(嵌套)函数.

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

15、过时的语言特色

命名

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

结论:

勉励使用. 注目的在于生成器函数的文档字符串中拔取”Yields:”而不是”Returns:”.

导入

Tip
仅对包和模块使用导入

定义:
模块间共享代码的录用机制.
优点:
命名空间管理约定异常简单. 每个标识符的源都用一种同等的章程指示.
x.Obj表示Obj对象定义在模块x中.
缺点:
模块名仍可能顶牛. 有些模块名太长, 不太方便.
结论:
使用 import x 来导入包和模块.

使用 from x import y , 其中x是包前缀, y是不带前缀的模块名.

使用 from x import y as z, 如若五个要导入的模块都叫做z或者y太长了.

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

    from sound.effects import echo
    ...
    echo.EchoFilter(input, output, delay=0.7, atten=4)

导入时不用使用相对名称. 尽管模块在同一个包中, 也要利用完整包名.
这能扶助你避免无意间导入一个包五次.

缺点:

使用这多少个很”酷”的特性相当诱人, 但不是纯属必要.
使用奇技淫巧的代码将越是不便阅读和调试. 开首容许还好(对原作者而言),
但当您想起代码, 它们或者会比那一个稍长一点但是很直接的代码更加难以了解.

线程

Tip
绝不借助内建档次的原子性.

虽说Python的内建项目例如字典看上去拥有原子操作,
不过在好几意况下它们依旧不是原子的(即:
如若__hash____eq__被实现为Python方法)且它们的原子性是靠不住的.
你也无法仰望原子变量赋值(因为那么些反过来看重字典).

事先拔取Queue模块的 Queue 数据类型作为线程间的数目通信形式. 其余,
使用threading模块及其锁原语(locking primitives).
掌握条件变量的方便使用办法, 这样你就可以动用 threading.Condition
来取代低级另外锁了.

优点:

通过解除简单的性质(attribute)访问时显式的get和set方法调用, 可读性提高了.
允许懒惰的统计. 用Pythonic的形式来维护类的接口. 就性能而言,
当直接访问变量是合理合法的, 添加访问方法就展示琐碎而无心义.
使用性能(properties)可以绕过这么些题目.
未来也得以在不损坏接口的场地下将做客方法加上.

异常

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

优点:

使用Python布尔值的规范语句更易读也更不易犯错. 大部分景色下, 也更快.

字符串

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

结论:

尽心尽力使用隐式的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.

行长度

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

留意下边例子中的元素缩进; 你可以在本文的 缩进 部分找到解释.

优点:

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

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

(译者注: 老实说, 我以为这段示例代码很不相宜, 有必要这么蛋疼吗?)

16、推荐使用词法效率域(Lexical Scoping)

结论:

享有的新代码都应有用一体化包名来导入每个模块.

应该像下边这样导入:

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

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

缺点:

比if语句难于阅读. 虽然表明式很长, 难于固定条件.

定义:

特别是一种跳出代码块的常规控制流来处理错误或者其它十分条件的形式.

定义:

pylint是一个在Python源代码中查找bug的工具.
对于C和C++这样的不那么动态的(译者注: 原文是less dynamic)语言,
这一个bug通常由编译器来捕获. 由于Python的动态特性, 有些警告或者不对.
然则伪告警应该很少.

事先写代码感觉一贯紧缺一定的正规化,所以整理了部分Python的言语专业地方的东东,这几个来自google公布的开源项目风格指南-Python语言专业。

优点:

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

6、鼓励施用嵌套/本地/内部类或函数

缺点:

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

14、尽可能采纳隐式false

5、避免全局变量

结论:

可怜必须听从特定条件:

像这样触发非凡: 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

缺点:

部署代码变难, 因为你无法不复制包层次.

结论:

在你的代码中避免那多少个特性.

定义:

概念在模块级的变量.

10、Lambda函数

7、可以在简练情状下行使列表推导

缺点:

默认参数只在模块加载时求值三回. 假若参数是列表或字典之类的可变类型,
这恐怕会促成问题. 假设函数修改了目的(例如向列表追加项),
默认值就被修改了.

定义:

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

x = 1 if cond else 2 .

定义:

类可以定义在格局, 函数或者类中. 函数可以定义在点子或函数中.
封闭区间中定义的变量对嵌套函数是只读的.

优点:

避免模块名争辩. 查找包更容易.

优点:

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

定义:

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

缺点:

恐怕会促成令人疑惑的支配流. 调用库时便于失去错误情状.

缺点:

或是造成令人迷惑的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++之类的静态语言仍然有很大区其它.)

11、条件表明式

1、对您的代码运行pylint

缺点:

装饰器能够在函数的参数或再次回到值上举办另外操作,
这可能导致令人愕然的隐藏行为. 而且, 装饰器在导入时执行.
从装饰器代码的败北中平复更加无法.

定义:

所谓生成器函数, 就是每当它实施一遍生成(yield)语句, 它就重回一个迭代器,
这一个迭代器生成一个值. 生成值后, 生成器函数的运行状态将被挂起,
直到下三回生成.

8、默认迭代器和操作符

结论:

推荐使用.

定义:

用以函数及艺术的装饰器 (也就是@标记). 最广大的装饰器是@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)

18、线程

13、属性(properties)

12、默认参数值

Tip

假诺类型帮忙, 就选拔默认迭代器和操作符. 比如列表, 字典及文件等.

缺点:

没有.

结论:

适用于单行函数. 假如代码超越60-80个字符, 最好依然定义成常规(嵌套)函数.

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

缺点:

属性(properties)是在get和set方法表明后指定,
这亟需使用者在接下去的代码中注意:
set和get是用于属性(properties)的(除了用 @property 装饰器创制的只读属性).
必须继承自object类. 可能潜藏比如操作符重载之类的副效率.
继承时或许会令人困惑.

定义:

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

3、使用模块的方方面面径名来导入每个模块

优点:

有时有用.

结论:

避免使用全局变量, 用类变量来代替. 但也有一部分不一:

本子的默认选项.
模块级常量. 例如: PI = 3.14159. 常量应该全大写, 用下划线连接.
奇迹用全局变量来缓存值或者当作函数重临值很有用.
假如需要, 全局变量应该仅在模块内部可用, 并通过模块级的集体函数来访问.

Tip

并非借助内建项目标原子性.
尽管如此Python的内建档次例如字典看上去拥有原子操作,
可是在少数情状下它们如故不是原子的(即:
假诺hasheq被实现为Python方法)且它们的原子性是靠不住的.
你也不可以仰望原子变量赋值(因为这多少个反过来看重字典).

预先使用Queue模块的 Queue 数据类型作为线程间的多寡通信格局. 其余,
使用threading模块及其锁原语(locking primitives).
了然条件变量的适用使用方法, 这样你就可以应用 threading.Condition
来取代低级另外锁了.

结论:

适用于简单情形. 每个部分应该单独置于一行: 映射表明式, 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)

优点:

默认操作符和迭代器简单高效, 它们从来表述了操作, 没有额外的法门调用.
使用默认操作符的函数是通用的. 它可以用来襄助该操作的其余类型.

结论:

适用于单行函数. 在另外情状下,推荐使用完整的if语句.

优点:

你平时会遇上一些采纳大量默认值的函数,
但偶尔(相比较少见)你想要覆盖这些默认值.
默认参数值提供了一种简易的章程来形成这件事,
你不需要为这一个鲜有的不比定义大量函数. 同时,
Python也不帮忙重载方法和函数, 默认参数是一种”仿造”重载行为的粗略格局.

Tip

尽心尽力使用字符串方法取代字符串模块. 使用函数调用语法取代apply().
使用列表推导, for循环取代filter(), map()以及reduce().

优点:

大雅的在函数上点名一些转换. 该转换可能回落一些重复代码,
保持已有函数不变(enforce invariants), 等.

缺点:

导入时可能改动模块行为, 因为导入模块时会对模块级变量赋值.

17、函数与形式装饰器

缺点:

复杂的列表推导或者生成器表明式可能难以阅读.

2、仅对包和模块使用导入

定义:

一种用于包装形式调用的形式. 当运算量不大,
它是取得和安装属性(attribute)的正规化情势.

相关文章