Google Python风格指南

史铁生说,“死是无须急于的事”,而我辈大部分人思维死亡的意义时,大多伴随着激情低落的心境。不过,帕洛玛就是这般酷。

  • Python是一种对代码风格很器重的言语,从缩进就能看出这点,Python强调易于精通。近期在承受代码重构的干活,为了统一我们的代码风格,制订规范,学习了一下网上这份Google的Python风格指南。

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

图片 1

背景

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

图片 2

导入

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)

导入时绝不采用绝对名称. 尽管模块在同一个包中, 也要采取完整包名.
这能协理你防止无意间导入一个包五次.

饭店女门房荷妮是个肥胖丑陋的54岁寡妇。她兢兢业业的维持着门房粗俗的形象,为祥和在密室内筑起一个加上的饱满世界。

Tip
应用模块的百分之百径名来导入每个模块

优点:
制止模块名龃龉. 查找包更容易.
缺点:
布局代码变难, 因为你必须复制包层次.
结论:
所有的新代码都应当用一体化包名来导入每个模块.

相应像上边那样导入:

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

图片 3

异常

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 Errorexcept Error as error: pass

只是芭洛玛隐约发现了那些地下,新搬来的扶桑绅士小津先生亦发现到了荷妮不为人知的一面。在小津彬彬有礼的引领下,不仅荷妮逐步卸下卑微的伪装,芭洛玛亦起初再一次审视生活与死去

全局变量

Tip
避免全局变量

定义:
概念在模块级的变量.
优点:
突发性有用.
缺点:
导入时可能改变模块行为, 因为导入模块时会对模块级变量赋值.
结论:
制止采纳全局变量, 用类变量来代替. 但也有一些不等:

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

图片 4

嵌套 局部 内部类或函数

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

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

电影中多少人身上温润的气概,历史学与艺术的两全融合,加上影片不急不缓的韵律,给人一种卓越的舒适感。

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

图片 5

默认迭代器和操作符

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:”.
(译者注: 参看
注释
)

图片 6

Lambda函数

Tip
适用于单行函数

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

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

图片 7

标准化表达式

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

引进评分:93

属性 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 = 4def 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.htmlNo: # 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, xNo: 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 == 1No: 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 contextlibwith 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 sysNo: import os, sys

导入总应该置身文件顶部, 位于模块注释和文档字符串之后,
模块全局变量和常量从前. 导入应该遵守从最通用到最不通用的逐一分组:

  1. 标准库导入
  2. 其三方库导入
  3. 应用程序指定导入

每种分组中, 应该遵照各种模块的完整包路径按字典序排序, 忽略大小写.

import foofrom foo import barfrom foo.bar import bazfrom foo.bar import Quuxfrom 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这样的命名,但现行已经不鼓励这样做,因为假设模块名刚刚和类一致,
    这会令人困扰.
TypePublicInternal
Moduleslower_with_under_lower_with_under
Packageslower_with_under
ClassesCapWords_CapWords
ExceptionsCapWords
Functionslower_with_under()lower_with_under()
Global/Class ConstantsCAPS_WITH_UNDERCAPS_WITH_UNDER
Global/Class Variableslower_with_underlower_with_under
Instance Variableslower_with_under_lower_with_under (protected) or __lower_with_under (private)
Method Nameslower_with_under()_lower_with_under() (protected) or __lower_with_under() (private)
Function/Method Parameterslower_with_under
Local Variableslower_with_under

Python之父Guido推荐的正儿八经

TypePublicInternal
Moduleslower_with_under_lower_with_under
Packageslower_with_under
ClassesCapWords_CapWords
ExceptionsCapWords
Functionslower_with_under()lower_with_under()
Global/Class ConstantsCAPS_WITH_UNDERCAPS_WITH_UNDER
Global/Class Variableslower_with_underlower_with_under
Instance Variableslower_with_under_lower_with_under (protected) or __lower_with_under (private)
Method Nameslower_with_under()_lower_with_under() (protected) or __lower_with_under() (private)
Function/Method Parameterslower_with_under
Local Variableslower_with_under

Main

Tip
虽然是一个打算被用作脚本的文本,也相应是可导入的.并且简单的导入不应该导致这一个剧本的主功用(mainfunctionality)被实施,
这是一种副功用. 主效用应该置身一个main()函数中.

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

def main(): ...if __name__ == '__main__': main()

怀有的一等代码在模块导入时都会被执行. 要小心不要去调用函数,
成立对象或者执行那一个不应当在行使pydoc时进行的操作.

临别赠言

请务必保持代码的一致性

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

创设风格指南的意在让代码有规可循,这样人们就足以小心于”你在说什么样”,而不是”你在怎么说”.我们在此地给出的是大局的正经,
可是地方的正统同样首要.若是你加到一个文本里的代码和原始代码方枘圆凿,它会让读者不知所措.制止这种意况.

参考:

相关文章

Comment ()
评论是一种美德,说点什么吧,否则我会恨你的。。。