美食之抓住(下)

  • Python是一模一样栽对代码风格十分讲究的语言,从缩进就可知看到这一点,Python强调易于理解。最近于承担代码重构的行事,为了统一大家之代码风格,制订规范,学习了转网上顿时卖Google的Python风格指南。

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

3

背景

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

欧亚微家,贺鎏阳及欧亚微又细致入微的羁押了羁押那封邮件,意思和欧亚微说的几近,并无剩余的废话。贺鎏阳为技艺部门去查看IP地址,但是连没有翻动下,看来疑犯的相反侦察能力很强。贺鎏阳皱了皱眉头,看来事情有些吃力。贺鎏阳看正在欧亚微说道:“不明了会无会见重复闹命案发生,所以我们会派人保护你的,欧小姐并非顾虑。如果案件发生了新开展我们会与汝联系的,还有复接受类似邮件请您当时联系我们。谢谢欧小姐的支援。”贺鎏阳交代完毕工作过后就转身去了。很快便当欧亚微家附近布了口。

导入

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
可以简短情况下用

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

4

生成器

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
来取代低级别之缉了.

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

在意点例子中的要素缩进; 你得当本文的 缩进 部分找到解释.

括号

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是”将来举行某事”的花样,
那么请确保您包含了一个指定的日期(“2009年11月缓解”)或者一个一定的轩然大波(“等交所有的客户还得以处理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时实施之操作.

临别赠言

告务必保持代码的一致性

假使你正编纂代码,
花几分钟看一下大面积代码,然后决定风格.如果它们当备的算术操作符两限都动空格,那么您也应该这样做.
如果其的注解都因此标记包围起来, 那么您的诠释也使及时样.

制定风格指南的目的在让代码有规可循,这样人们便可小心于”你在说啊”,而未是”你在怎么说”.我们当此地为来之凡大局的正儿八经,
但是当地的业内同样重要.如果您加到一个文本里之代码和初代码大相径庭,它见面给读者不知所措.避免这种情况.

参考:

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

发表评论

电子邮件地址不会被公开。 必填项已用*标注

网站地图xml地图