形容给十年晚的隗默小姐

by admin on 2018年8月31日
  • Python是同种对代码风格非常推崇的言语,从缩进就会观看这一点,Python强调易于掌握。最近当荷代码重构的行事,为了统一大家之代码风格,制订规范,学习了一下网上即时卖Google的Python风格指南。

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

隗默:

背景

Python 是
Google主要的脚本语言。这本风格指南主要含有的凡对python的编程准则。
呢帮扶读者会将代码准确格式化,我们提供了针对性 Vim的布文件
。对于Emacs用户,保持默认设置即可。

你好!

Python语言专业

自己是十年前之而,现在凡是2015年12月,距离考研还有20天。我因在考研教室里,前面是倩倩。手边是10年之英语真题和早急洗好的葡萄及冬枣。阳光刚刚,偏偏无心学习。

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

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

坚持身体力行做公益,不论是app还是凑巧到了之人数申关怀申请基金项目开,抑或是被拒绝的Ted志愿者。都相信这世界有不那么好之光棍,势必有好心人。能够施予钱财愿意施予钱财,能够予以关心也别放弃关怀。

生成器

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.

2015、12、6

老式的言语特色

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是”将来举行某事”的花样,
那么要确保您包含了一个指定的日期(“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地图