后边写代码感觉一贯缺乏一定的标准,这多少个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是”未来做某事”的款型,
那么请保管您包含了一个点名的日子(“二〇〇九年一月缓解”)或者一个一定的事件(“等到拥有的客户都得以处理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), 等等.

优点:

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

缺点:

应用那多少个很”酷”的风味异常诱人, 但不是纯属必要.
使用奇技淫巧的代码将尤其难以阅读和调试. 起首容许还好(对原作者而言),
但当您想起代码, 它们可能会比这么些稍长一点可是很间接的代码更加不便领会.

结论:

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

相关文章