pylint是一个在Python源代码中查找bug的工具.,从前写代码感觉从来不够一定的正式

线程

Tip
毫无借助内建项目的原子性.

就算Python的内建项目例如字典看上去拥有原子操作,
不过在好几情状下它们照旧不是原子的(即:
假诺__hash____eq__被落成为Python方法)且它们的原子性是靠不住的.
你也不可能指望原子变量赋值(因为那些反过来依赖字典).

优先接纳Queue模块的 Queue 数据类型作为线程间的数码通讯格局. 其它,
使用threading模块及其锁原语(locking primitives).
了然条件变量的适合使用办法, 那样你就足以选用 threading.Condition
来取代低级其他锁了.

优点:

运用Python布尔值的尺度语句更易读也更不易犯错. 大多数场所下, 也更快.

属性 properties

Tip
做客和安装数据成员时, 你常常会采纳简易, 轻量级的走访和设置函数.
提出用属性(properties)来代替它们.

定义:
一种用于包装措施调用的格局. 当运算量不大,
它是赢得和安装属性(attribute)的正规化方式.
优点:
经过消除不难的习性(attribute)访问时显式的get和set方法调用, 可读性进步了.
允许懒惰的总括. 用Pythonic的章程来维护类的接口. 就品质而言,
当直接访问变量是合情的, 添加访问方法就突显琐碎而无意识义.
使用品质(properties)可以绕过这几个标题.
以后也得以在不损坏接口的情状下将拜访方法加上.
缺点:
特性(properties)是在get和set方法表明后指定,
那亟需使用者在接下去的代码中注意:
set和get是用于属性(properties)的(除了用 @property
装饰器成立的只读属性). 必须三番五次自object类.
可能藏身比如操作符重载之类的副功用. 继承时或许会让人怀疑.
结论:
您平凡习惯于选取访问或设置格局来拜访或安装数据, 它们不难而轻量.
不过大家指出您在新的代码中利用属性. 只读属性应该用 @property 装饰器
来创建.

万一子类没有覆盖属性, 那么属性的一连可能看起来不显著.
因而使用者必须确保走访方法直接被调用,
以保险子类中的重载方法被属性调用(使用模板方法设计格局).

Yes: import math

     class Square(object):
         """A square with two properties: a writable area and a read-only perimeter.

         To use:
         >>> sq = Square(3)
         >>> sq.area
         9
         >>> sq.perimeter
         12
         >>> sq.area = 16
         >>> sq.side
         4
         >>> sq.perimeter
         16
         """

         def __init__(self, side):
             self.side = side

         def __get_area(self):
             """Calculates the 'area' property."""
             return self.side ** 2

         def ___get_area(self):
             """Indirect accessor for 'area' property."""
             return self.__get_area()

         def __set_area(self, area):
             """Sets the 'area' property."""
             self.side = math.sqrt(area)

         def ___set_area(self, area):
             """Indirect setter for 'area' property."""
             self._SetArea(area)

         area = property(___get_area, ___set_area,
                         doc="""Gets or sets the area of the square.""")

         @property
         def perimeter(self):
             return self.side * 4

(译者注: 老实说, 我觉着那段示例代码很不恰当, 有须求这么蛋疼吗?)

结论:

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

老式的言语特色

Tip
尽心尽力选取字符串方法取代字符串模块. 使用函数调用语法取代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)

4、允许使用相当, 但必须小心

威力过大的特点

Tip
幸免选用那几个特点

定义:
Python是一种极度灵活的语言, 它为您提供了过多花里胡哨的特点,
诸如元类(metaclasses), 字节码访问, 任意编译(on-the-fly compilation),
动态继承, 对象父类重定义(object reparenting), 导入黑客(import hacks),
反射, 系统内修改(modification of system internals), 等等.
优点:
无敌的语言特征, 能让你的代码更紧凑.
缺点:
使用这么些很”酷”的性状至极诱人, 但不是纯属须求.
使用奇技淫巧的代码将越发不便阅读和调试. 起首容许还好(对原小编而言),
但当您回想代码, 它们或者会比这几个稍长一点不过很直白的代码尤其难以领会.
结论:
在你的代码中幸免那一个特性.

5、幸免全局变量

命名

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

定义:

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

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

Tip

适用于单行函数

pylint

Tip
对您的代码运行pylint

定义:
pylint是一个在Python源代码中查找bug的工具.
对于C和C++那样的不那么动态的(译者注: 原文是less dynamic)语言,
那些bug常常由编译器来捕获. 由于Python的动态特性, 有些警告或者不对.
不过伪告警应该很少.
优点:
可以捕获简单忽略的谬误, 例如输入错误, 使用未赋值的变量等.
缺点:
pylint不完美. 要使用其优势, 我们偶尔侯需求: a) 围绕着它来写代码 b)
抑制其报警 c) 创新它, 或者d) 忽略它.
结论:
有限帮助对您的代码运行pylint.抑制不准确的警告,以便能够将其余警告揭露出来。
您可以由此安装一个行注释来防止告警. 例如:

dict = 'something awful'  # Bad Idea... pylint: disable=redefined-builtin

pylint警告是以一个数字编号(如 C0112 )和一个符号名(如 empty-docstring
)来标识的. 在编排新代码或更新已有代码时对报警进行医疗,
推荐应用标志名来标识.

若是警告的标志名不够见名知意,那么请对其伸张一个详实表明。

拔取那种抑制格局的便宜是我们可以轻松查找抑制并回想它们.

你能够利用命令 pylint --list-msgs 来获取pylint告警列表. 你可以运用命令
pylint --help-msg=C6409 , 以获取有关特定新闻的更加多音讯.

相比较于事先运用的 pylint: disable-msg , 本文推荐使用
pylint: disable .

要遏制”参数未选拔”告警, 你可以用””作为参数标识符,
或者在参数名前加”unused
”. 蒙受不可能改变参数名的气象,
你可以因而在函数开首”提到”它们来清除告警. 例如:

    def foo(a, unused_b, unused_c, d=None, e=None):
        _ = d, e
        return a

18、线程

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是”将来做某事”的款式,
那么请保管您包蕴了一个点名的日子(“二零零六年12月缓解”)或者一个一定的轩然大波(“等到具有的客户都足以拍卖XML请求就移除那些代码”).

结论:

可怜必须遵循特定条件:

像这么触发格外: 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
按需使用生成器.

定义:
所谓生成器函数, 就是每当它实施一次生成(yield)语句, 它就回来一个迭代器,
那些迭代器生成一个值. 生成值后, 生成器函数的周转状态将被挂起,
直到下五回生成.
优点:
简化代码, 因为每一回调用时, 局部变量和控制流的图景都会被保存.
比起四回制造一文山会海值的函数, 生成器使用的内存更少.
缺点:
没有.
结论:
鼓励拔取. 注目的在于生成器函数的文档字符串中动用”Yields:”而不是”Returns:”.
(译者注: 参看
注释
)

定义:

类可以定义在措施, 函数或者类中. 函数可以定义在艺术或函数中.
封闭区间中定义的变量对嵌套函数是只读的.

默许迭代器和操作符

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

优点:

平凡能够带来越来越分明, 优雅的代码.
尤其会让有经历的Lisp和Scheme(还有Haskell, ML等)程序员感到欣慰.

导入

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)

导入时决不使用相对名称. 就算模块在同一个包中, 也要动用完整包名.
那能帮忙您防止无意间导入一个包几次.

结论:

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

Main

Tip
不怕是一个打算被看作脚本的文书,也理应是可导入的.并且简单的导入不该导致这么些剧本的主成效(mainfunctionality)被实施,
那是一种副作用. 主作用应该置身一个main()函数中.

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

def main():
      ...

if __name__ == '__main__':
    main()

具备的一级代码在模块导入时都会被执行. 要小心不要去调用函数,
成立对象或者进行那一个不该在动用pydoc时举办的操作.

缺点:

pylint不完美. 要拔取其优势, 大家偶尔侯需求: a) 围绕着它来写代码 b)
抑制其报警 c) 创新它, 或者d) 忽略它.

缩进

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

结论:

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

字符串

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

10、Lambda函数

临别赠言

请务必保持代码的一致性

如若您正在编辑代码,
花几分钟看一下大面积代码,然后决定风格.若是它们在具有的算术操作符两边都利用空格,那么您也应当那样做.
如若它们的笺注都用标记包围起来, 那么你的注释也要那样.

制定风格指南的意在让代码有规可循,那样人们就可以小心于”你在说怎么着”,而不是”你在怎么说”.我们在此间给出的是大局的专业,
不过地点的科班同样首要.如果你加到一个文本里的代码和原始代码黯淡无光,它会让读者无所适从.幸免那种意况.

定义:

眼下版本的Python提供了大家经常更欣赏的替代品.

文件和sockets

Tip
在文书和sockets为止时, 显式的关门它.

除文件外, sockets或任何类似文件的对象在并未需要的情景下开拓,
会有不少副功用, 例如:

  1. 它们可能会损耗一定量的系统资源,如文件讲述符.即使那个资源在运用后不曾即时归还系统,那么用于拍卖那些目标的代码会将资源消耗殆尽.
  2. 持有文件将会阻止对于文本的其他诸如移动、删除之类的操作.
  3. 单单是从逻辑上关闭文件和sockets,那么它们如故可能会被其共享的次第在不知不觉中开展读或者写操作.唯有当它们确实被关闭后,对于它们尝试进行读或者写操作将会跑出相当,并使得难题急迅显现出来.

并且,幻想当文件对象析构时,文件和sockets会自动关闭,试图将文件对象的生命周期和文书的场馆绑定在同步的想法,都是不现实的.
因为有如下原因:

  1. 没有其他措施可以确保运行条件会真的的履行文书的析构.差距的Python达成利用分裂的内存管理技术,比如延时垃圾处理机制.
    延时垃圾处理机制可能会招致对象生命周期被擅自无界定的延长.
  2. 对此文本意外的引用,会促成对于文本的所有时间大于预期(比如对于特其余跟踪,
    包涵有全局变量等).

推荐使用“with”语句
以管理文件:

with open("hello.txt") as hello_file:
    for line in hello_file:
        print line

对此不辅助拔取”with”语句的切近文件的目的,使用 contextlib.closing():

import contextlib

with contextlib.closing(urllib.urlopen("http://www.python.org/")) as front_page:
    for line in front_page:
        print line

Legacy AppEngine 中Python 2.5的代码如应用”with”语句, 须要添加
“from __future__ import with_statement”.

缺点:

默许参数只在模块加载时求值三遍. 假如参数是列表或字典之类的可变类型,
那或许会导致难题. 借使函数修改了对象(例如向列表追加项),
默许值就被改动了.

语句

Tip
一般性每个语句应该占据一行

只是, 假设测试结果与测试语句在一行放得下, 你也可以将它们位于同样行.
若是是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
宁缺毋滥的应用括号

唯有是用以落进行连接, 否则不用在回去语句或规范语句中使用括号.
不过在元组两边使用括号是足以的.

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)

优点:

比if语句越发简便易行和方便.

全局变量

Tip
幸免全局变量

定义:
概念在模块级的变量.
优点:
有时候有用.
缺点:
导入时或许改动模块行为, 因为导入模块时会对模块级变量赋值.
结论:
幸免使用全局变量, 用类变量来代替. 但也有局地不一:

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

15、过时的言语特色

空格

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

定义:

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

分号

Tip
永不在行尾加分号, 也休想用分号将两条命令放在同样行.

Tip

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

背景

Python 是
谷歌首要的脚本语言。那本风格指南主要含有的是本着python的编程准则。
为协助读者可以将代码准确格式化,大家提供了针对 Vim的配置文件
。对于Emacs用户,保持默许设置即可。

缺点:

也许导致令人迷惑的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

做客和设置数据成员时, 你常常会动用简单, 轻量级的走访和设置函数.
提议用属性(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 的话题.

优点:

简单的列表推导可以比其余的列表创制方法越发清晰不难.
生成器表明式可以丰盛快速, 因为它们防止了创制整个列表.

Lambda函数

Tip
适用于单行函数

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

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

缺点:

接纳这一个很”酷”的特色至极诱人, 但不是绝对必要.
使用奇技淫巧的代码将越是难以阅读和调试. 起首容许还好(对原小编而言),
但当你回看代码, 它们可能会比那么些稍长一点不过很直白的代码尤其不便精晓.

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是一种对代码风格很器重的语言,从缩进就能看到这或多或少,Python强调易于领会。近期在负责代码重构的工作,为了统一大家的代码风格,制订规范,学习了刹那间网上那份谷歌(Google)的Python风格指南。

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

优点:

偶然有用.

空行

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

五星级定义之间空两行, 比如函数或者类定义. 方法定义,
类定义与首个主意之间, 都应该空一行. 函数或艺术中,
某些地方如果你认为适当, 就空一行.

缺点:

想必会促成令人困惑的决定流. 调用库时简单失去错误景况.

异常

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

结论:

动用 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
在Python中,
对于琐碎又不太首要的拜访函数,你应有直接采纳国有变量来替代它们,那样可以幸免额外的函数调用用度.当添加愈来愈多效益时,
你能够用属性(property)来维系语法的等同性.

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

一头, 倘使访问更复杂, 或者变量的造访费用很引人侧目, 那么您应当接纳像
get_foo()set_foo() 那样的函数调用.
就算在此之前的代码行为容许通过质量(property)访问 ,
那么就不要将新的走访函数与特性绑定. 那样,
任何准备通过老艺术访问变量的代码就无奈运行,
使用者也就会发现到复杂爆发了变化.

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

Python语言专业

Tip

适用于多数情形.

Python风格规范

定义:

您可以在函数参数列表的终极指定变量的值, 例如:

def foo(a, b = 0)

要是调用foo时只带一个参数, 则b被设为0. 假诺带多少个参数,
则b的值等于第四个参数.

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.

优点:

因而解除简单的特性(attribute)访问时显式的get和set方法调用, 可读性提升了.
允许懒惰的总结. 用Pythonic的办法来维护类的接口. 就质量而言,
当直接访问变量是合理的, 添加访问方法就浮现琐碎而无意识义.
使用质量(properties)可以绕过这么些题材.
未来也得以在不破坏接口的气象下将拜访方法加上.

标准表达式

Tip
适用于单行函数

定义:
规范表明式是对于if语句的一种越发不难的句法规则. 例如:
x = 1 if cond else 2 .
优点:
比if语句尤其简明和方便.
缺点:
比if语句难于阅读. 如若表达式很长, 难于固定条件.
结论:
适用于单行函数. 在其他情状下,推荐使用完整的if语句.

结论:

尽量使用隐式的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
每个导入应该占据一行

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

结论:

鞭策施用. 注意在生成器函数的文档字符串中运用”Yields:”而不是”Returns:”.

默许参数值

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

优点:

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

行长度

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

小心上边例子中的元素缩进; 你可以在本文的 缩进 部分找到解释.

缺点:

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

注释

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

定义:

概念在模块级的变量.

词法成效域 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

绝不借助内建类型的原子性.
即使如此Python的内建档次例如字典看上去拥有原子操作,
可是在一些意况下它们仍然不是原子的(即:
借使hasheq被完毕为Python方法)且它们的原子性是靠不住的.
你也不可能指望原子变量赋值(因为这么些反过来信赖字典).

先期使用Queue模块的 Queue 数据类型作为线程间的数量通讯格局. 此外,
使用threading模块及其锁原语(locking primitives).
精通条件变量的格外使用方法, 那样您就足以选取 threading.Condition
来代替低级其余锁了.

Tip
动用模块的全套径名来导入每个模块

优点:
避免模块名争论. 查找包更简单.
缺点:
安顿代码变难, 因为您不可能不复制包层次.
结论:
不无的新代码都应该用全部包名来导入每个模块.

应该像上边那样导入:

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

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

结论:

假定好处很明白, 就明智而谨慎的施用装饰器.
装饰器应该遵守和函数一样的导入和命名规则.
装饰器的python文档应该明晰的求证该函数是一个装饰器.
请为装饰器编写单元测试.

防止装饰器自身对外面的依靠(即决不借助于文件, socket, 数据库连接等),
因为装饰器运行时那些资源可能不可用(由 pydoc 或任何工具导入).
应该保障一个用有效参数调用的装饰器在所有情况下都是打响的.

装饰器是一种奇特情势的”顶尖代码”. 参考前面关于 Main 的话题.

嵌套 局部 内部类或函数

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)

12、默许参数值

缺点:

复杂的列表推导或者生成器表达式可能麻烦阅读.

缺点:

装饰器可以在函数的参数或重回值上推行其它操作,
那或者造成令人惊异的隐藏行为. 而且, 装饰器在导入时执行.
从装饰器代码的挫折中回复越发不能够.

定义:

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

结论:

推介使用.

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

定义:

一种用于包装形式调用的方式. 当运算量不大,
它是获得和装置属性(attribute)的正统格局.

缺点:

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

优点:

方便.

16、推荐应用词法功用域(Lexical Scoping)

优点:

无敌的言语特色, 能让你的代码更紧凑.

优点:

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

1、对您的代码运行pylint

定义:

所谓生成器函数, 就是每当它执行四次变动(yield)语句, 它就回来一个迭代器,
这些迭代器生成一个值. 生成值后, 生成器函数的运转处境将被挂起,
直到下四回生成.

缺点:

你没办法通过翻阅形式名来分歧对象的档次(例如, 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

假若类型援救, 就动用默许迭代器和操作符. 比如列表, 字典及文件等.

9、按需使用生成器

优点:

可以捕获不难忽视的错误, 例如输入错误, 使用未赋值的变量等.

结论:

防止选拔全局变量, 用类变量来代替. 但也有局地不等:

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

缺点:

比当地函数更难阅读和调试. 没有函数名代表堆栈跟踪更难明白.
由于lambda函数平时只包涵一个表明式, 因而其表明能力有限.

13、属性(properties)

优点:

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

优点:

防止模块名冲突. 查找包更不难.

结论:

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

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

定义:

更加是一种跳出代码块的正常控制流来处理错误或者别的极度条件的格局.

定义:

用以函数及措施的装裱器 (也就是@标记). 最普遍的装饰器是@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)

19、幸免选取威力过大的特性

11、条件说明式

结论:

鼓励使用, 可是有如下注意事项:

绝不在函数或措施定义中利用可变对象作为默许值.

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

结论:

适用于单行函数. 倘使代码当先60-80个字符, 最好如故定义成常规(嵌套)函数.

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

结论:

俺们不行使不帮助那些特点的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)

定义:

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

缺点:

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

定义:

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

结论:

具有的新代码都应当用全部包名来导入每个模块.

相应像下边那样导入:

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

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

8、默许迭代器和操作符

缺点:

布局代码变难, 因为你必须复制包层次.

以前写代码感觉一贯不够一定的正规,所以整理了一部分Python的言语专业地方的东东,这些源于google宣布的开源项目风格指南-Python语言专业。

缺点:

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

7、可以在简练意况下接纳列表推导

结论:

管教对你的代码运行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

优点:

您时常会遇上一些选取大批量默许值的函数,
但偶尔(对比少见)你想要覆盖那一个默许值.
默许参数值提供了一种简单的艺术来完毕那件事,
你不需求为这么些罕见的不比定义多量函数. 同时,
Python也不协助重载方法和函数, 默许参数是一种”仿造”重载行为的粗略方式.

缺点:

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

缺点:

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

17、函数与格局装饰器

缺点:

没有.

14、尽可能采纳隐式false

定义:

原则表明式是对于if语句的一种尤其不难的句法规则. 例如:

x = 1 if cond else 2 .

结论:

勉励使用.

定义:

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

定义:

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