• Python是一种对代码风格很看重的言语,从缩进就能见到这一点,Python强调易于精晓。最近在担负代码重构的办事,为了统一我们的代码风格,制订规范,学习了一下网上这份Google的Python风格指南。

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

背景

Python 是
Google紧要的脚本语言。这本风格指南紧要含有的是本着python的编程准则。
为援助读者能够将代码准确格式化,我们提供了针对 Vim的布置文件
。对于Emacs用户,保持默认设置即可。

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)

导入时决不拔取相对名称. 尽管模块在同一个包中, 也要选拔完整包名.
这能支援你制止无意间导入一个包一遍.

Tip
行使模块的全套径名来导入每个模块

优点:
避免模块名争论. 查找包更容易.
缺点:
配置代码变难, 因为你必须复制包层次.
结论:
有着的新代码都应当用一体化包名来导入每个模块.

应当像上边那样导入:

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

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

异常

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
制止全局变量

定义:
概念在模块级的变量.
优点:
奇迹有用.
缺点:
导入时可能改变模块行为, 因为导入模块时会对模块级变量赋值.
结论:
制止采取全局变量, 用类变量来代替. 但也有一对例外:

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

嵌套 局部 内部类或函数

Tip
鞭策拔取嵌套/本地/内部类或函数

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

列表推导 List Comprehensions

Tip
XML,能够在简练情形下利用

定义:
列表推导(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(): ...

生成器

Tip
按需使用生成器.

定义:
所谓生成器函数, 就是每当它执行三回变动(yield)语句, 它就重返一个迭代器,
那多少个迭代器生成一个值. 生成值后, 生成器函数的运转情状将被挂起,
直到下四回生成.
优点:
简化代码, 因为老是调用时, 局部变量和控制流的境况都会被保存.
比起四遍成立一名目繁多值的函数, 生成器使用的内存更少.
缺点:
没有.
结论:
勉励利用. 注目的在于生成器函数的文档字符串中拔取”Yields:”而不是”Returns:”.
(译者注: 参看
注释
)

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

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

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

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)

词法功能域 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 的话题.

线程

Tip
绝不借助内建项目标原子性.

尽管Python的内建类型例如字典看上去拥有原子操作,
不过在一些情状下它们仍旧不是原子的(即:
要是__hash____eq__被实现为Python方法)且它们的原子性是靠不住的.
你也无法仰望原子变量赋值(因为那个反过来倚重字典).

先期利用Queue模块的 Queue 数据类型作为线程间的数目通信模式. 此外,
使用threading模块及其锁原语(locking primitives).
精通条件变量的适宜使用办法, 这样你就足以行使 threading.Condition
来取代低级另外锁了.

威力过大的特点

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

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

括号

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

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

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
不畏参数都是字符串, 使用%操作符或者格式化方法格式化字符串.
不过也无法相提并论, 你需要在+和%里头可以判定.

Yes: x = a + b
     x = '%s, %s!' % (imperative, expletive)
     x = '{}, {}!'.format(imperative, expletive)
     x = 'name: %s; score: %d' % (name, n)
     x = 'name: {}; score: {}'.format(name, n)

No: x = '%s%s' % (a, b)  # use + in this case
    x = '{}{}'.format(a, b)  # use + in this case
    x = imperative + ', ' + expletive + '!'
    x = 'name: ' + name + '; score: ' + str(n)

避免在循环中用+和+=操作符来累加字符串. 由于字符串是不可变的,
这样做会成立不必要的临时对象, 并且导致二次方而不是线性的周转时间.
作为代表方案, 你可以将每个子串插手列表, 然后在循环截止后用 .join
连接列表. (也得以将各类子串写入一个 cStringIO.StringIO 缓存中.)

Yes: items = ['<table>']
     for last_name, first_name in employee_list:
         items.append('<tr><td>%s, %s</td></tr>' % (last_name, first_name))
     items.append('</table>')
     employee_table = ''.join(items)

No: employee_table = '<table>'
    for last_name, first_name in employee_list:
        employee_table += '<tr><td>%s, %s</td></tr>' % (last_name, first_name)
    employee_table += '</table>'

在同一个文书中, 保持利用字符串引号的等同性.
使用单引号’或者双引号”之一用以引用字符串, 并在同一文件中沿用.
在字符串内可以利用另外一种引号, 以避免在字符串中选择.
GPyLint已经参与了这一检查.

(译者注:GPyLint疑为笔误, 应为PyLint.)

Yes:
     Python('Why are you hiding your eyes?')
     Gollum("I'm scared of lint errors.")
     Narrator('"Good!" thought a happy Python reviewer.')

No:
     Python("Why are you hiding your eyes?")
     Gollum('The lint. It burns. It burns us.')
     Gollum("Always the great lint. Watching. Watching.")

为多行字符串使用三重双引号”“”而非三重单引号’‘’.
当且仅当项目中拔取单引号’来引用字符串时,
才可能会使用三重’‘’为非文档字符串的多行字符串来标识引用.
文档字符串必须采纳三重双引号”“”. 然而要专注, 平常用隐式行连接更清晰,
因为多行字符串与程序其他一些的缩进形式不一致.

Yes:
    print ("This is much nicer.\n"
           "Do it this way.\n")

No:
      print """This is pretty ugly.
  Don't do this.
  """

文件和sockets

Tip
在文书和sockets停止时, 显式的倒闭它.

除文件外, sockets或任何类似文件的靶子在尚未必要的场馆下开拓,
会有为数不少副功效, 例如:

  1. 它们可能会消耗一定量的系统资源,如文件讲述符.假诺那么些资源在动用后尚未当即归还系统,那么用于拍卖这个目的的代码会将资源消耗殆尽.
  2. 拥有文件将会阻止对于文本的另外诸如移动、删除之类的操作.
  3. 只是是从逻辑上关闭文件和sockets,那么它们如故可能会被其共享的主次在潜意识中展开读或者写操作.只有当它们确实被关门后,对于它们尝试举办读或者写操作将会跑出非常,并使得问题急速显现出来.

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

  1. 尚无其他方法可以确保运行环境会真正的执行文书的析构.不同的Python实现应用不同的内存管理技术,比如延时垃圾处理机制.
    延时垃圾处理机制可能会造成对象生命周期被任意无界定的延长.
  2. 对此文本意外的引用,会导致对于文本的有着时间超过预期(比如对于充足的跟踪,
    包含有全局变量等).

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

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

对于不援助使用”with”语句的类似文件的对象,使用 contextlib.closing():

import contextlib

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

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

TODO注释

Tip
为临时代码应用TODO注释, 它是一种长期解决方案. 不算圆满, 但够好了.

TODO注释应该在有着先导处带有”TODO”字符串,
紧跟着是用括号括起来的你的名字, email地址或任何标识符.
然后是一个可选的冒号. 接着必须有一行注释, 解释要做哪些.
紧要目标是为了有一个联结的TODO格式,
这样添加注释的人就可以寻找到(并得以按需提供更多细节).
写了TODO注释并不保险写的人会亲自解决问题. 当您写了一个TODO,
请注上你的名字.

# TODO(kl@gmail.com): Use a "*" here for string repetition.
# TODO(Zeke) Change this to use relations.

比方你的TODO是”将来做某事”的款式,
那么请确保您包含了一个点名的日期(“二零零六年十二月解决”)或者一个一定的风波(“等到所有的客户都足以拍卖XML请求就移除这几个代码”).

导入格式

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)

访问控制

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

(译者注: 重视封装的面向对象程序员看到这多少个可能会很反感,
因为她俩直白被教育: 所有成员变量都必须是个体的! 其实,
这实在是有点麻烦啊.试着去接受Pythonic法学吧)

一头, 假若访问更扑朔迷离, 或者变量的走访开销很强烈, 那么你应有使用像
get_foo()set_foo() 这样的函数调用.
假诺在此之前的代码行为容许通过性能(property)访问 ,
那么就绝不将新的走访函数与性能绑定. 那样,
任何准备通过老艺术访问变量的代码就无可奈何运行,
使用者也就会发觉到复杂暴发了变化.

命名

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时进行的操作.

临别赠言

请务必保持代码的一致性

万一你正在编写代码,
花几分钟看一下广大代码,然后决定风格.如果它们在富有的算术操作符两边都施用空格,那么您也应该如此做.
假使它们的诠释都用标记包围起来, 那么你的注明也要这样.

创设风格指南的目的在于让代码有规可循,那样人们就可以小心于”你在说怎么样”,而不是”你在怎么说”.我们在这边给出的是全局的正式,
不过当地的正式同样紧要.假诺你加到一个文书里的代码和原有代码大相径庭,它会让读者罔知所措.防止这种处境.

参考:

相关文章

网站地图xml地图