Python 风格标准(Google)

本项目并非 Google 官方项目, 而是由国内程序员凭热心创立和维护。

假如你注重的是 Google 官方英文版, 请移步

以下代码中 Yes 表明引荐,No 表明不引荐。


分号

不要在行尾加分号, 也不要用分号将两条指令放在同一行。


行长度

每行不超越80个字符

以下情况在外:

  1. 长的导入模块句子
  2. 注释里的URL

不要运用反斜杠衔接行。

Python会将 , 你能够运用这个特色. 假如需求, 你能够在表达式外围增加一对额定的圆括号。

引荐: 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 = ('这是一个十分长十分长十分长十分长 '
     '十分长十分长十分长十分长十分长十分长的字符串')

在注释中,假如必要,将长的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

留意上面比方中的元素缩进; 你能够在本文的 :ref:`缩进 <indentation>`部分找到解说.


括号

宁缺毋滥的运用括号

除非是用于完成行衔接, 不然不要在回来句子或条件句子中运用括号. 不过在元组两头运用括号是能够的.

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)

缩进

用4个空格来缩进代码

绝对不要用tab, 也不要tab和空格混用. 关于行衔接的情况, 你应该要么笔直对齐换行的元素(见 :ref:`行长度 <line_length>` 部分的示例), 或许运用4空格的悬挂式缩进(这时榜首行不该该有参数):

Yes:   # 与开端变量对齐
       foo = long_function_name(var_one, var_two,
                                var_three, var_four)

       # 字典中与开端值对齐
       foo = {
           long_dictionary_key: value1 +
                                value2,
           ...
       }

       # 4 个空格缩进,榜首行不需求
       foo = long_function_name(
           var_one, var_two, var_three,
           var_four)

       # 字典中 4 个空格缩进
       foo = {
           long_dictionary_key:
               long_dictionary_value,
           ...
       }
No:    # 榜首行有空格是制止的
      foo = long_function_name(var_one, var_two,
          var_three, var_four)

      # 2 个空格是制止的
      foo = long_function_name(
        var_one, var_two, var_three,
        var_four)

      # 字典中没有处理缩进
      foo = {
          long_dictionary_key:
              long_dictionary_value,
              ...
      }

空行

尖端界说之间空两行, 办法界说之间空一行

尖端界说之间空两行, 比方函数或许类界说. 办法界说, 类界说与榜首个办法之间, 都应该空一行. 函数或办法中, 某些当地要是你觉得适宜, 就空一行.


空格

依照标准的排版标准来运用标点两头的空格

括号内不要有空格.

依照标准的排版标准来运用标点两头的空格

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  # 注释
     long_name = 2  # 注释不需求对齐

     dictionary = {
         "foo": 1,
         "long_name": 2,
         }
No:
     foo       = 1000  # 注释
     long_name = 2     # 注释不需求对齐

     dictionary = {
         "foo"      : 1,
         "long_name": 2,
         }

Shebang

大部分.py文件不用以#!作为文件的开端. 依据 , 程序的main文件应该以 #!/usr/bin/python2或许 #!/usr/bin/python3开端.

(译者注: 在计算机科学中, (也称为Hashbang)是一个由井号和叹号构成的字符串行(#!), 其出现在文本文件的榜首行的前两个字符. 在文件中存在Shebang的情况下, 类Unix操作体系的程序载入器会剖析Shebang后的内容, 将这些内容作为解说器指令, 并调用该指令, 并将载有Shebang的文件途径作为该解说器的参数. 例如, 以指令#!/bin/sh最初的文件在履行时会实践调用/bin/sh程序.)

#!先用于协助内核找到Python解说器, 可是在导入模块时, 将会被疏忽. 因而只要被直接履行的文件中才有必要参加#!.


注释

确保对模块, 函数, 办法和行内注释运用正确的风格

文档字符串

Python有一种绝无仅有的的注释办法: 运用文档字符串. 文档字符串是包, 模块, 类或函数里的榜首个句子. 这些字符串能够通过目标的__doc__成员被主动提取, 而且被pydoc所用. (你能够在你的模块上运转pydoc试一把, 看看它长什么样). 咱们对文档字符串的惯例是运用三重双引号"""( ). 一个文档字符串应该这样安排: 首先是一行以句号, 问号或惊叹号完毕的概述(或许该文档字符串单纯只要一行). 接着是一个空行. 接着是文档字符串剩余的部分, 它应该与文档字符串的榜首行的榜首个引号对齐. 下面有更多文档字符串的格局化标准.

模块

每个文件应该包含一个答应样板. 依据项目运用的答应(例如, 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

假如一个类不承继自其它类, 就显式的从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__ .


字符串

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

在同一个文件中, 坚持运用字符串引号的一起性. 运用单引号'或许双引号"之一用以引证字符串, 并在同一文件中沿袭. 在字符串内能够运用别的一种引号, 以防止在字符串中运用. 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

在文件和sockets完毕时, 显式的封闭它.

除文件外, sockets或其他相似文件的目标在没有必要的情况下翻开, 会有许多副效果, 例如:

  1. 它们或许会耗费有限的体系资源, 如文件描绘符. 假如这些资源在运用后没有及时偿还体系, 那么用于处理这些目标的代码会将资源耗费殆尽.
  2. 持有文件将会阻挠关于文件的其他比方移动、删去之类的操作.
  3. 仅仅是从逻辑上封闭文件和sockets, 那么它们依然或许会被其同享的程序在无意中进行读或许写操作. 只要当它们真实被封闭后, 关于它们检验进行读或许写操作将会跑出反常, 并使得问题快速显现出来.

而且, 幻想当文件目标析构时, 文件和sockets会主动封闭, 企图将文件目标的生命周期和文件的情况绑定在一起的主意, 都是不现实的. 由于有如下原因:

  1. 没有任何办法能够确保运转环境会真实的履行文件的析构. 不同的Python完成选用不同的内存办理技能, 比方延时垃圾处理机制. 延时垃圾处理机制或许会导致目标生命周期被恣意无约束的延伸.
  2. 关于文件意外的引证,会导致关于文件的持有时刻超出预期(比方关于反常的盯梢, 包含有全局变量等).

引荐运用 以办理文件:

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注释

为暂时代码运用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恳求就移除这些代码").


导入格局

每个导入应该独占一行

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

句子

一般每个句子应该独占一行

不过, 假如检验结果与检验句子在一行放得下, 你也能够将它们放在同一行. 假如是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)

拜访操控

在Python中, 关于琐碎又不太重要的拜访函数, 你应该直接运用公有变量来代替它们, 这样能够防止额定的函数调用开支. 当增加更多功用时, 你能够用特色(property)来坚持语法的一起性.

(译者注: 注重封装的面向目标程序员看到这个或许会很恶感, 由于他们一向被教育: 全部成员变量都有必要是私有的! 其实, 那真的是有点费事啊. 试着去承受Pythonic哲学吧)

另一方面, 假如拜访更杂乱, 或许变量的拜访开支很明显, 那么你应该运用像 get_foo()set_foo() 这样的函数调用. 假如之前的代码行为答应通过特色(property)拜访 , 那么就不要将新的拜访函数与特色绑定. 这样, 任何企图通过老办法拜访变量的代码就无法运转, 运用者也就会意识到杂乱性发生了改变.


命名

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这样的命名, 但现在现已不鼓舞这样做, 由于假如模块名可巧和类名一起, 这会让人困扰.

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

即使是一个计划被用作脚本的文件, 也应该是可导入的. 而且简略的导入不该该导致这个脚本的主功用(main functionality)被履行, 这是一种副效果. 主功用应该放在一个main()函数中.

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

def main():
      ...

if __name__ == '__main__':
    main()

全部的尖端代码在模块导入时都会被履行. 要当心不要去调用函数, 创立目标, 或许履行那些不该该在运用pydoc时履行的操作.