Google Python风格指南。Python语言专业。

  • Python是一律种植对代码风格非常强调的言语,从缩进就会看到这一点,Python强调易于掌握。最近以担负代码重构的劳作,为了统一大家之代码风格,制订规范,学习了转网上就卖Google的Python风格指南。

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

之前写代码感觉一直缺失一定之正规化,所以整了片Python的言语专业方的东东,这个来自google发布的开源项目风格指南-Python语言专业。

背景

Python 是
Google主要的脚本语言。这按照风格指南主要包含的是对准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是”将来做某事”的形式,
那么请确保您包含了一个点名的日子(“2009年11月缓解”)或者一个特定的波(“等交具备的客户都得以拍卖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、按需利用生成器

参考:

  • Google Python 风格指南 –
    中文版
  • zh-google-styleguide
  • Google
    Python风格指南

定义:

所谓生成器函数, 就是当她实施同一不良生成(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), 等等.

优点:

强有力的言语特征, 能给你的代码更艰难凑.

缺点:

以这些好”酷”的特色十分诱人, 但不是纯属必要.
使用奇技淫巧的代码用更不便阅读和调试. 开始或还好(对原作者而言),
但当你回顾代码, 它们或者会见比较那些稍长一点可挺直接的代码更加难以理解.

结论:

在公的代码中避免这些特性.

相关文章

admin

网站地图xml地图