那些bug经常由编译器来捕获. 伟德国际1946由于Python的动态特性,所以整理了有的Python的语言专业地点的东东

参考:

定义:

概念在模块级的变量.

行长度

Tip
每行不当先七十九个字符

例外:

  1. 长的导入模块语句
  2. 注明里的UGL450L

决不接纳反斜杠连接行.

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'):

设若3个文本字符串在一行放不下, 可以采纳圆括号来兑现隐式行连接:

x = ('This will build a very long long '
     'long long long long long long string')

在诠释中,若是须要,将长的U科雷傲L放在一行上。

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

瞩目上面例子中的元素缩进; 你可以在本文的 缩进 部分找到解释.

定义:

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

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

定义:

所谓生成器函数, 就是每当它执行几次变动(yield)语句, 它就回去三个迭代器,
这一个迭代器生成五个值. 生成值后, 生成器函数的运行情状将被挂起,
直到下一回生成.

条件表明式

Tip
适用于单行函数

定义:
规格表达式是对此if语句的一种更加不难的句法规则. 例如:
x = 1 if cond else 2 .
优点:
比if语句越发简明和方便.
缺点:
比if语句难于阅读. 倘诺表明式十分长, 难于固定条件.
结论:
适用于单行函数. 在任何意况下,推荐应用完全的if语句.

优点:

司空见惯可以牵动更为清晰, 优雅的代码.
特别会让有经验的Lisp和Scheme(还有Haskell, ML等)程序员感到欣慰.

文件和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
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,
    没需要限制3个类多个模块.
  5. 对类名使用大写字母初阶的单词(如CapWords,即帕斯Carl风格),可是模块名应当用小写加下划线的措施(如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之父吉多推荐的专业

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

优点:

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

老式的言语特色

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)

优点:

经过免去不难的习性(attribute)访问时显式的get和set方法调用, 可读性进步了.
允许懒惰的总结. 用Pythonic的章程来维护类的接口. 就品质而言,
当直接访问变量是言之有理的, 添加访问方法就呈现琐碎而无意义.
使用性质(properties)可以绕过这些难题.
现在也足以在不损坏接口的意况下将访问方法加上.

背景

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

结论:

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

Python语言专业

结论:

勉励使用.

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月缓解”)或许1个一定的风浪(“等到具有的客户都足以拍卖XML请求就移除那一个代码”).

优点:

方便.

导入

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)

导入时决不使用相对名称. 即便模块在同1个包中, 也要动用完整包名.
那能支援您幸免无意间导入三个包四回.

陆 、鼓励接纳嵌套/本地/内部类或函数

导入格式

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

叁 、使用模块的全部径名来导入每一种模块

语句

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)

缺点:

比本地函数更难阅读和调试. 没有函数名代表堆栈跟踪更难领悟.
由于lambda函数平日只包蕴贰个表明式, 由此其表明能力有限.

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

1贰 、暗许参数值

字符串

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

在同2个文本中, 保持利用字符串引号的一样性.
使用单引号’或许双引号”之一用以引用字符串, 并在平等文件中沿用.
在字符串内足以行使其余一种引号, 以幸免在字符串中动用.
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.
  """

优点:

偶尔有用.

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.

优点:

您时不时会遇见一些用到大量暗许值的函数,
但偶尔(相比少见)你想要覆盖这个暗中同意值.
默许参数值提供了一种简单的方法来形成那件事,
你不须要为这几个鲜有的两样定义多量函数. 同时,
Python也不襄助重载方法和函数, 暗许参数是一种”仿造”重载行为的简便格局.

访问控制

Tip
在Python中,
对于琐碎又不太紧要的访问函数,你应当平昔利用国有变量来替代它们,那样可以防止额外的函数调用成本.当添加更加多效益时,
你可以用属性(property)来保持语法的一致性.

(译者注: 敬服封装的面向对象程序员看到那些大概会很反感,
因为他俩向来被辅导: 全数成员变量都无法不是私有的! 其实,
那真的是有点麻烦啊.试着去领受Pythonic工学吧)

一派, 假如访问更复杂, 大概变量的造访开销很显明, 那么您应当选择像
get_foo()set_foo() 那样的函数调用.
若是从前的代码行为容许通过品质(property)访问 ,
那么就不用将新的访问函数与天性绑定. 那样,
任何准备透过老艺术访问变量的代码就无奈运转,
使用者也就会发现到复杂发生了变化.

定义:

非常是一种跳出代码块的正规控制流来处理错误可能其他非常条件的方式.

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

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

缺点:

嵌套类或局项目标实例不或者体系化(pickled).

词法功效域 Lexical Scoping

Tip

推荐应用

定义:
嵌套的Python函数可以引用外层函数中定义的变量, 不过不可知对它们赋值.
变量绑定的解析是运用词法功效域, 也等于依据静态的主次文本.
对多个块中的某些名称的任何赋值都会促成Python将对该名称的一切引用当做局地变量,
甚至是赋值前的处理. 即使碰到global注解, 该名称就会被当做全局变量.

3个利用这一个特点的事例:

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是1个列表,
for循环其实是将x中的值依次赋给i.这样对i的赋值就隐式的发生了,
整个foo函数体中的i都会被用作局部变量, 包涵bar()中的那贰个.
那点与C++之类的静态语言依旧有很大距离的.)
结论:
鞭策使用.

定义:

用以函数及方法的点缀器 (也就是@标记). 最广泛的装饰器是@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)

缩进

Tip
用四个空格来缩进代码

相对不用用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,
              ...
      }

18、线程

  • Python是一种对代码风格很推崇的语言,从缩进就能见到这点,Python强调易于精通。方今在背负代码重构的劳作,为了统一我们的代码风格,制订规范,学习了弹指间网上那份谷歌的Python风格指南。

  • 原文地址:
    http://google-styleguide.googlecode.com/svn/trunk/pyguide.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)

缺点:

装饰器可以在函数的参数或重回值上推行其余操作,
那大概引致令人惊异的隐藏行为. 而且, 装饰器在导入时执行.
从装饰器代码的破产中复苏特别不或者.

函数与方式装饰器

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

缺点:

没有.

生成器

Tip
按需使用生成器.

定义:
所谓生成器函数, 就是每当它实施几遍变动(yield)语句, 它就赶回一个迭代器,
这些迭代器生成1个值. 生成值后, 生成器函数的运作处境将被挂起,
直到下两遍生成.
优点:
简化代码, 因为每趟调用时, 局地变量和控制流的意况都会被保存.
比起一次创设一多级值的函数, 生成器使用的内存更少.
缺点:
没有.
结论:
勉励采用. 注目的在于生成器函数的文档字符串中运用”Yields:”而不是”Returns:”.
(译者注: 参看
注释
)

结论:

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

定义:
你可以在函数参数列表的末梢内定变量的值, 例如, def foo(a, b = 0): .
假设调用foo时只带1个参数, 则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...
         ...

结论:

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

导入时不要接纳相对名称. 尽管模块在同二个包中, 也要使用完整包名.
那能帮助您防止无意间导入3个包两遍.

空格

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

五 、防止全局变量

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 )和1个符号名(如 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

优点:

取名空间管理约定拾分简单. 每一种标识符的源都用一种同等的办法提示.
x.Obj表示Obj对象定义在模块x中.

Python风格规范

结论:

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

嵌套 局地 内部类或函数

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

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

优点:

简化代码, 因为每趟调用时, 局地变量和控制流的意况都会被保存.
比起三回创建一各类值的函数, 生成器使用的内存更少.

异常

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

缺点:

暗许参数只在模块加载时求值三次. 即使参数是列表或字典之类的可变类型,
那可能会促成难题. 若是函数修改了目的(例如向列表追加项),
默许值就被修改了.

注释

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

Python有一种独一无二的的笺注格局: 使用文档字符串. 文档字符串是包, 模块,
类或函数里的第2个语句. 那几个字符串可以经过对象的doc成员被电动提取,
并且被pydoc所用. (你可以在你的模块上运转pydoc试一把, 看看它长什么样).
大家对文档字符串的规矩是利用三重双引号”“”(
PEP-257
). 三个文档字符串应该那样社团: 首先是单排以句号,
问号或惊讶号结尾的概述(只怕该文档字符串单纯唯有一行). 接着是贰个空行.
接着是文档字符串剩下的一部分, 它应当与文档字符串的率先行的第一个引号对齐.
上边有越来越多文档字符串的格式化规范.
模块

各样文件应该包括多少个许可样板. 按照项目采纳的认同(例如, Apache 2.0, BSD,
LGPL, GPL), 拔取合适的样板.
函数和方式

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

1个函数必需要有文档字符串, 除非它满意以下标准:

  1. 表面不可知
  2. 不短小
  3. 简单明了

文档字符串应该包罗函数做什么样, 以及输入和输出的详细描述. 寻常,
不应当描述”如何是好”, 除非是一对扑朔迷离的算法. 文档字符串应该提供丰裕的音讯,
当旁人编写代码调用该函数时, 他不要求看一行代码,
只要看文档字符串就可以了. 对于复杂的代码,
在代码旁边加注释会比选择文档字符串更有意义.

关于函数的多少个方面应当在一定的小节中展开描述记录, 那个地点如下文所述.
每节应该以一个题名行开始. 标题行以冒号结尾. 除标题行外,
节的此外内容应被缩进三个空格.

Args:
列出每一个参数的名字, 并在名字后拔取两个冒号和一个空格,
分隔对该参数的描述.若是描述太长领先了单行80字符,使用2依旧四个空格的悬挂缩进(与公事其余一些保持一致).
描述应该包罗所需的档次和含义.
如若2个函数接受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

为了增长可读性, 注释应该至少离开代码三个空格.

另一方面, 毫不要描述代码. 假如阅读代码的人比你更懂Python,
他只是不精通您的代码要做什么.

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

1⑥ 、推荐应用词法效率域(Lexical Scoping)

威力过大的性状

Tip
幸免采取那一个特点

定义:
Python是一种非常灵活的言语, 它为你提供了不少鲜艳的特征,
诸如元类(metaclasses), 字节码访问, 任意编译(on-the-fly compilation),
动态继承, 对象父类重定义(object reparenting), 导入黑客(import hacks),
反射, 系统内修改(modification of system internals), 等等.
优点:
强硬的言语特色, 能让你的代码更紧密.
缺点:
行使那些很”酷”的风味拾贰分诱人, 但不是纯属要求.
使用奇技淫巧的代码将特别难以阅读和调试. 起始容许好在(对原笔者而言),
但当您想起代码, 它们或者会比那多少个稍长一点不过很直接的代码特别难以掌握.
结论:
在您的代码中幸免这几个天性.

定义:

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

def foo(a, b = 0)

比方调用foo时只带三个参数, 则b被设为0. 比方带五个参数,
则b的值等于第二个参数.

Python 解析器

Tip
绝半数以上分.py文件不必以#!作为文件的初阶. 依照
PEP-394
, 程序的main文件应当以#!/usr/bin/python2或者 #!/usr/bin/python3开始.

(译者注: 在电脑科学中,
Shebang
(也称之为Hashbang)是3个由井号和叹号构成的字符串行(#!),
其出现在文件文件的率先行的前多少个字符. 在文书中设有Shebang的情景下,
类Unix操作系统的程序载入器会分析Shebang后的内容,
将那些故事情节作为解释器指令, 并调用该指令,
并将载有Shebang的文书路径作为该解释器的参数. 例如,
以指令#!/bin/sh开首的文书在执行时会实际调用/bin/sh程序.)
#!先用于帮忙内核找到Python解释器, 不过在导入模块时, 将会被忽略.
因此唯有被直接执行的文本中才有必不可少参预#!.

结论:

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

防止装饰器本身对外面的依靠(即不用借助于文件, socket, 数据库连接等),
因为装饰器运营时这几个能源只怕不可用(由 pydoc 或其他工具导入).
应该有限支撑壹个用卓有成效参数调用的装饰器在具有情状下都是打响的.

装饰器是一种相当方式的”超级代码”. 参考前边关于 Main 的话题.

空行

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

头号定义之间空两行, 比如函数或者类定义. 方法定义,
类定义与第四个措施之间, 都应该空一行. 函数或艺术中,
某个地方就算你觉得合适, 就空一行.

Tip

适用于单行函数

Lambda函数

Tip
适用于单行函数

定义:
与话语相反, lambda在3个表明式中定义匿名函数. 常用于为 map()
filter() 之类的高阶函数定义回调函数只怕操作符.
优点:
方便.
缺点:
比位置函数更难阅读和调试. 没有函数名代表堆栈跟踪更难掌握.
由于lambda函数常常只含有1个表明式, 因而其表达能力有限.
结论:
适用于单行函数. 假设代码当先60-78个字符, 最好依然定义成常规(嵌套)函数.

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

优点:

幸免模块名争辩. 查找包更简单.

Tip
拔取模块的整套径名来导入各个模块

优点:
防止模块名冲突. 查找包更简单.
缺点:
布局代码变难, 因为你必须复制包层次.
结论:
负有的新代码都应当用一体化包名来导入每一种模块.

应该像上边那样导入:

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

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

结论:

尽量拔取隐式的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.

Main

Tip
即便是七个打算被作为脚本的公文,也应有是可导入的.并且简单的导入不应有导致那些剧本的主效用(mainfunctionality)被执行,
那是一种副功用. 主功用应该置身二个main()函数中.

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

def main():
      ...

if __name__ == '__main__':
    main()

不无的头号代码在模块导入时都会被执行. 要小心不要去调用函数,
成立对象或许实施那一个不应有在采纳pydoc时举行的操作.

缺点:

模块名仍或然争执. 有个别模块名太长, 不太方便.

分号

Tip
并非在行尾加分号, 也毫不用分号将两条命令放在同样行.

结论:

您日常习惯于采纳访问或安装方法来拜访或设置数据, 它们简单而轻量.
可是大家提出你在新的代码中应用属性. 只读属性应该用 @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
幸免全局变量

定义:
概念在模块级的变量.
优点:
奇迹有用.
缺点:
导入时只怕更改模块行为, 因为导入模块时会对模块级变量赋值.
结论:
避免采用全局变量, 用类变量来代替. 但也有一些不比:

  1. 本子的默许选项.
  2. 模块级常量. 例如: PI = 3.14159. 常量应该全大写, 用下划线连接.
  3. 有时候用全局变量来缓存值大概当作函数重临值很有用.
  4. 假定急需, 全局变量应该仅在模块内部可用,
    并通过模块级的公家函数来访问.

1① 、条件表明式

暗中同意迭代器和操作符

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

Tip

如若类型支持, 就利用暗中同意迭代器和操作符. 比如列表, 字典及文件等.

线程

Tip
无须借助内建项目标原子性.

就算如此Python的内建类型例如字典看上去拥有原子操作,
可是在一些处境下它们还是还是不是原子的(即:
如若__hash____eq__被已毕为Python方法)且它们的原子性是靠不住的.
你也无法指望原子变量赋值(因为那个反过来依赖字典).

先期采用Queue模块的 Queue 数据类型作为线程间的多寡通讯格局. 其余,
使用threading模块及其锁原语(locking primitives).
明白条件变量的恰当使用格局, 这样您就足以采纳 threading.Condition
来取代低级其他锁了.

优点:

比if语句越发简约和方便.

优点:

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

定义:

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

1⑦ 、函数与格局装饰器

定义:

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

1④ 、尽只怕采纳隐式false

优点:

暗中认同操作符和迭代器不难迅速, 它们一向发挥了操作, 没有额外的方式调用.
使用默许操作符的函数是通用的. 它可以用来辅助该操作的别样类型.

九 、按需采纳生成器

结论:

分外必须听从特定条件:

像那样触发十分: 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

事先写代码感觉平素缺失一定的科班,所以整理了一些Python的言语专业地点的东东,那么些来自google公布的开源项目风格指南-Python语言专业。

缺点:

质量(properties)是在get和set方法评释后钦定,
那亟需使用者在接下去的代码中注意:
set和get是用以属性(properties)的(除了用 @property 装饰器创建的只读属性).
必须继承自object类. 大概潜藏比如操作符重载之类的副成效.
继承时或然会令人可疑.

结论:

管教对您的代码运营pylint.抑制不可相信的警示,以便可以将其余警告揭表露来。

你可以经过设置七个行注释来压制告警. 例如:

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

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

倘诺警告的记号名不够见名知意,那么请对其增添2个详实表明。

应用这种抑制格局的好处是大家可以轻松查找抑制并想起它们.

你可以动用命令 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

优点:

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

定义:

规格表明式是对此if语句的一种更加简单的句法规则. 例如:

x = 1 if cond else 2 .

缺点:

pylint不完美. 要采纳其优势, 大家偶尔侯必要: a) 围绕着它来写代码 b)
抑制其报警 c) 立异它, 大概d) 忽略它.

结论:

在你的代码中避免这么些天性.

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

Tip

如若好处很强烈, 就明智而谨慎的行使装饰器

定义:

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

1⑤ 、过时的言语特色

定义:

类能够定义在艺术, 函数只怕类中. 函数可以定义在形式或函数中.
封闭区间中定义的变量对嵌套函数是只读的.

10、Lambda函数

定义:

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

并非借助内建类型的原子性.
即便如此Python的内建档次例如字典看上去拥有原子操作,
不过在一些处境下它们依旧不是原子的(即:
倘诺hasheq被落成为Python方法)且它们的原子性是靠不住的.
你也无法指望原子变量赋值(因为那么些反过来依赖字典).

先行选取Queue模块的 Queue 数据类型作为线程间的多少通讯格局. 其余,
使用threading模块及其锁原语(locking primitives).
通晓条件变量的确切使用方式, 这样你就足以采纳 threading.Condition
来代表低级其余锁了.

Tip

走访和装置数据成员时, 你日常会利用简便, 轻量级的拜访和设置函数.
提议用属性(properties)来替代它们.

缺点:

复杂的列表推导可能生成器表明式只怕麻烦阅读.

缺点:

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

结论:

全数的新代码都应该用全部包名来导入各个模块.

应该像上面那样导入:

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

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

缺点:

恐怕造成令人迷惑的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++之类的静态语言如故有很大区其他.)

缺点:

行使那一个很”酷”的特征十二分诱人, 但不是纯属要求.
使用奇技淫巧的代码将尤为难以阅读和调试. 起头容许幸而(对原笔者而言),
但当您想起代码, 它们或许会比那三个稍长一点只是很直接的代码尤其难以精晓.

壹 、对您的代码运营pylint

缺点:

对C/C++开发人士来说, 大概看起来有点怪.

定义:

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

缺点:

布局代码变难, 因为您不可以不复制包层次.

定义:

目前版本的Python提供了大家平时更欣赏的替代品.

1九 、幸免接纳威力过大的特性

Tip

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

Tip

适用于多数景况.

优点:

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

定义:

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

缺点:

您没办法通过阅读方式名来分别对象的类型(例如, 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(): ...

结论:

笔者们不行使不匡助这一个特色的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)

结论:

引进使用.

13、属性(properties)

定义:

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

优点:

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

结论:

适用于单行函数. 要是代码当先60-柒拾七个字符, 最好还是定义成常规(嵌套)函数.

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

四 、允许行使尤其, 但必须小心

缺点:

或许会导致令人可疑的决定流. 调用库时便于失去错误情状.

缺点:

比if语句难于阅读. 尽管表明式非常长, 难于固定条件.

Tip

适用于单行函数

相关文章