Python 风格规范 — Google 开源项目风格指南

> 本文由 [简悦 SimpRead](http://ksria.com/simpread/) 转码， 原文地址 [zh-google-styleguide.readthedocs.io](https://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/)

[Google 开源项目风格指南](https://zh-google-styleguide.readthedocs.io/en/latest/contents/)

分号
--

Tip

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

行长度
---

例外:

1.  长的导入模块语句    
2.  注释里的 URL, 路径以及其他的一些长标记
3.  不便于换行，不包含空格的模块级字符串常量，比如 url 或者路径
    1.  Pylint 禁用注释.（例如：[``](#system-message-1)# pylint: disable=invalid-name）

除非是在 `with` 语句需要三个以上的上下文管理器的情况下，否则不要使用反斜杠连接行.

Python 会将 [圆括号, 中括号和花括号中的行隐式的连接起来](http://docs.python.org/2/reference/lexical_analysis.html#implicit-line-joining) , 你可以利用这个特点. 如果需要, 你可以在表达式外围增加一对额外的圆括号.

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

当 `with` 表达式需要使用三个及其以上的上下文管理器时，可以使用反斜杠换行. 若只需要两个，请使用嵌套的 with.

```
Yes:  with very_long_first_expression_function() as spam, \
           very_long_second_expression_function() as beans, \
           third_thing() as eggs:
          place_order(eggs, beans, spam, beans)
```

```
No:  with VeryLongFirstExpressionFunction() as spam, \
          VeryLongSecondExpressionFunction() as beans:
       PlaceOrder(eggs, beans, spam, beans)
```

```
Yes:  with very_long_first_expression_function() as spam:
          with very_long_second_expression_function() as beans:
              place_order(beans, spam)
```

注意上面例子中的元素缩进; 你可以在本文的 [缩进](#indentation) 部分找到解释.

另外在其他所有情况下，若一行超过 80 个字符，但 [yapf](https://github.com/google/yapf/) 却无法将该行字数降至 80 个字符以下时，则允许该行超过 80 个字符长度.

括号
--

除非是用于实现行连接, 否则不要在返回语句或条件语句中使用括号. 不过在元组两边使用括号是可以的.

```
Yes: if foo:
         bar()
       while x:
           x = bar()
       if x and y:
           bar()
       if not x:
           bar()
       # For a 1 item tuple the ()s are more visually obvious than the comma.
       onesie = (foo,)
       return foo
       return spam, beans
       return (spam, beans)
       for (x, y) in dict.items(): ...
```

```
No:  if (x):
         bar()
     if not(x):
         bar()
     return (foo)
```

缩进
--

绝对不要用 tab, 也不要 tab 和空格混用. 对于行连接的情况, 你应该要么垂直对齐换行的元素 (见 [行长度](#line-length) 部分的示例), 或者使用 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

仅当 `]`, `)`, `}` 和末位元素不在同一行时，推荐使用序列元素尾部逗号. 当末位元素尾部有逗号时，元素后的逗号可以指示 [YAPF](https://pypi.org/project/yapf/) 将序列格式化为每行一项.

```
Yes:   golomb3 = [0, 1, 3]
Yes:   golomb4 = [
           0,
           1,
           4,
           6,
       ]
```

```
No:    golomb4 = [
           0,
           1,
           4,
       ]
```

空行
--

顶级定义之间空两行, 比如函数或者类定义. 方法定义, 类定义与第一个方法之间, 都应该空一行. 函数或方法中, 某些地方要是你觉得合适, 就空一行.

空格
--

括号内不要有空格.

```
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: dict['key'] = list[index]
```

```
No:  dict ['key'] = list [index]
```

在二元操作符两边都加上一个空格, 比如赋值 (=), 比较 (==, <, >, !=, <>, <=, >=, in, not in, is, is not), 布尔 (and, or, not). 至于算术操作符两边的空格该如何使用, 需要你自己好好判断. 不过两侧务必要保持一致.

当 `=` 用于指示关键字参数或默认参数值时, 不要在其两侧使用空格. 但若存在类型注释的时候, 需要在 `=` 周围使用空格.

```
Yes: def complex(real, imag=0.0): return magic(r=real, i=imag)
Yes: def complex(real, imag: float = 0.0): return Magic(r=real, i=imag)
```

```
No:  def complex(real, imag = 0.0): return magic(r = real, i = imag)
No:  def complex(real, imag: float=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,
         }
```

Shebang
-------

Tip

大部分. py 文件不必以 #! 作为文件的开始. 根据 [PEP-394](http://www.python.org/dev/peps/pep-0394/) , 程序的 main 文件应该以 `#!/usr/bin/python2` 或者 `#!/usr/bin/python3` 开始.

(译者注: 在计算机科学中, [Shebang](http://en.wikipedia.org/wiki/Shebang_(Unix)) (也称为 Hashbang) 是一个由井号和叹号构成的字符串行 (#!), 其出现在文本文件的第一行的前两个字符. 在文件中存在 Shebang 的情况下, 类 Unix 操作系统的程序载入器会分析 Shebang 后的内容, 将这些内容作为解释器指令, 并调用该指令, 并将载有 Shebang 的文件路径作为该解释器的参数. 例如, 以指令 #!/bin/sh 开头的文件在执行时会实际调用 / bin/sh 程序.)

`#!` 先用于帮助内核找到 Python 解释器, 但是在导入模块时, 将会被忽略. 因此只有被直接执行的文件中才有必要加入 `#!` .

注释
--

Tip

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

**文档字符串**

Python 有一种独一无二的的注释方式: 使用文档字符串. 文档字符串是包, 模块, 类或函数里的第一个语句. 这些字符串可以通过对象的 `__doc__` 成员被自动提取, 并且被 pydoc 所用. (你可以在你的模块上运行 pydoc 试一把, 看看它长什么样). 我们对文档字符串的惯例是使用三重双引号”””( [PEP-257](http://www.python.org/dev/peps/pep-0257/) ). 一个文档字符串应该这样组织: 首先是一行以句号, 问号或惊叹号结尾的概述 (或者该文档字符串单纯只有一行). 接着是一个空行. 接着是文档字符串剩下的部分, 它应该与文档字符串的第一行的第一个引号对齐. 下面有更多文档字符串的格式化规范.

**模块**

每个文件应该包含一个许可样板. 根据项目使用的许可 (例如, Apache 2.0, BSD, LGPL, GPL), 选择合适的样板. 其开头应是对模块内容和用法的描述.

```
"""A one line summary of the module or program, terminated by a period.

Leave one blank line.  The rest of this docstring should contain an
overall description of the module or program.  Optionally, it may also
contain a brief description of exported classes and functions and/or usage
examples.

Typical usage example:

foo = ClassFoo()
bar = foo.FunctionBar()
"""
```

**函数和方法**

下文所指的函数, 包括函数, 方法, 以及生成器.

一个函数必须要有文档字符串, 除非它满足以下条件:

1.  外部不可见
2.  非常短小
3.  简单明了

文档字符串应该包含函数做什么, 以及输入和输出的详细描述. 通常, 不应该描述” 怎么做”, 除非是一些复杂的算法. 文档字符串应该提供足够的信息, 当别人编写代码调用该函数时, 他不需要看一行代码, 只要看文档字符串就可以了. 对于复杂的代码, 在代码旁边加注释会比使用文档字符串更有意义. 覆盖基类的子类方法应有一个类似 `See base class` 的简单注释来指引读者到基类方法的文档注释. 若重载的子类方法和基类方法有很大不同, 那么注释中应该指明这些信息.

关于函数的几个方面应该在特定的小节中进行描述记录， 这几个方面如下文所述. 每节应该以一个标题行开始. 标题行以冒号结尾. 除标题行外, 节的其他内容应被缩进 2 个空格.

Args:

列出每个参数的名字, 并在名字后使用一个冒号和一个空格, 分隔对该参数的描述. 如果描述太长超过了单行 80 字符, 使用 2 或者 4 个空格的悬挂缩进 (与文件其他部分保持一致). 描述应该包括所需的类型和含义. 如果一个函数接受 * foo(可变长度参数列表) 或者 **bar (任意关键字参数), 应该详细列出 * foo 和 **bar.

Returns: (或者 Yields: 用于生成器)

描述返回值的类型和语义. 如果函数返回 None, 这一部分可以省略.

Raises:

列出与接口有关的所有异常.

```
def fetch_smalltable_rows(table_handle: smalltable.Table,
                        keys: Sequence[Union[bytes, str]],
                        require_all_keys: bool = False, ) -> Mapping[bytes, Tuple[str]]:
    """Fetches rows from a Smalltable.

Retrieves rows pertaining to the given keys from the Table instance
    represented by table_handle.  String keys will be UTF-8 encoded.

Args:
        table_handle: An open smalltable.Table instance.
        keys: A sequence of strings representing the key of each table
        row to fetch.  String keys will be UTF-8 encoded.
        require_all_keys: Optional; If require_all_keys is True only
        rows with values set for all keys will be returned.

Returns:
        A dict mapping keys to the corresponding table row data
        fetched. Each row is represented as a tuple of strings. For
        example:

{b'Serak': ('Rigel VII', 'Preparer'),
        b'Zim': ('Irk', 'Invader'),
        b'Lrrr': ('Omicron Persei 8', 'Emperor')}

Returned keys are always bytes.  If a key from the keys argument is
        missing from the dictionary, then that row was not found in the
        table (and require_all_keys must have been False).

Raises:
        IOError: An error occurred accessing the smalltable.
    """
```

在 `Args:` 上进行换行也是可以的:

```
def fetch_smalltable_rows(table_handle: smalltable.Table,
                        keys: Sequence[Union[bytes, str]],
                        require_all_keys: bool = False, ) -> Mapping[bytes, Tuple[str]]:
    """Fetches rows from a Smalltable.

Retrieves rows pertaining to the given keys from the Table instance
    represented by table_handle.  String keys will be UTF-8 encoded.

Args:
    table_handle:
        An open smalltable.Table instance.
    keys:
        A sequence of strings representing the key of each table row to
        fetch.  String keys will be UTF-8 encoded.
    require_all_keys:
        Optional; If require_all_keys is True only rows with values set
        for all keys will be returned.

Returns:
    A dict mapping keys to the corresponding table row data
    fetched. Each row is represented as a tuple of strings. For
    example:

{b'Serak': ('Rigel VII', 'Preparer'),
    b'Zim': ('Irk', 'Invader'),
    b'Lrrr': ('Omicron Persei 8', 'Emperor')}

Returned keys are always bytes.  If a key from the keys argument is
    missing from the dictionary, then that row was not found in the
    table (and require_all_keys must have been False).

Raises:
    IOError: An error occurred accessing the smalltable.
    """
```

**类**

类应该在其定义下有一个用于描述该类的文档字符串. 如果你的类有公共属性 (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."""
```

**块注释和行注释**

最需要写注释的是代码中那些技巧性的部分. 如果你在下次 [代码审查](http://en.wikipedia.org/wiki/Code_review) 的时候必须解释一下, 那么你应该现在就给它写注释. 对于复杂的操作, 应该在其操作开始前写上若干行注释. 对于不是一目了然的代码, 应在其行尾添加注释.

```
# 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 if i is 0 or 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

注意标点符号, 拼写和语法

注释应有适当的大写和标点, 句子应该尽量完整. 对于诸如在行尾上的较短注释, 可以不那么正式, 但是也应该尽量保持风格一致.

类
-

Tip

如果一个类不继承自其它类, 就显式的从 object 继承. 嵌套类也一样.(除非是为了和 python2 兼容)

```
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) 正常工作, 并且这样可以保护你的代码, 使其不受 [PEP-3000](http://www.python.org/dev/peps/pep-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>'
```

在同一个文件中, 保持使用字符串引号的一致性. 使用单引号’或者双引号” 之一用以引用字符串, 并在同一文件中沿用. 在字符串内可以使用另外一种引号, 以避免在字符串中使用.

```
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.")
```

为多行字符串使用三重双引号””” 而非三重单引号’’’. 当且仅当项目中使用单引号’来引用字符串时, 才可能会使用三重’’’为非文档字符串的多行字符串来标识引用. 文档字符串必须使用三重双引号”””. 多行字符串不应随着代码其他部分缩进的调整而发生位置移动. 如果需要避免在字符串中嵌入额外的空间, 可以使用串联的单行字符串或者使用 [textwrap.dedent()](https://docs.python.org/zh-cn/3/library/textwrap.html#textwrap.dedent) 来删除每行多余的空间.

```
No:
long_string = """This is pretty ugly.
Don't do this.
"""
```

```
Yes:
long_string = """This is fine if your use case can accept
  extraneous leading spaces."""
```

```
Yes:
long_string = ("And this is fine if you cannot accept\n" +
       "extraneous leading spaces.")
```

```
Yes:
long_string = ("And this too is fine if you cannot accept\n"
       "extraneous leading spaces.")
```

```
Yes:
import textwrap

long_string = textwrap.dedent("""\
  This is also fine, because textwrap.dedent()
  will collapse common leading spaces in each line.""")
```

文件和 sockets
-----------

Tip

在文件和 sockets 结束时, 显式的关闭它.

除文件外, sockets 或其他类似文件的对象在没有必要的情况下打开, 会有许多副作用, 例如:

1.  它们可能会消耗有限的系统资源, 如文件描述符. 如果这些资源在使用后没有及时归还系统, 那么用于处理这些对象的代码会将资源消耗殆尽.
2.  持有文件将会阻止对于文件的其他诸如移动、删除之类的操作.
3.  仅仅是从逻辑上关闭文件和 sockets, 那么它们仍然可能会被其共享的程序在无意中进行读或者写操作. 只有当它们真正被关闭后, 对于它们尝试进行读或者写操作将会抛出异常, 并使得问题快速显现出来.

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

1.  没有任何方法可以确保运行环境会真正的执行文件的析构. 不同的 Python 实现采用不同的内存管理技术, 比如延时垃圾处理机制. 延时垃圾处理机制可能会导致对象生命周期被任意无限制的延长.
2.  对于文件意外的引用, 会导致对于文件的持有时间超出预期 (比如对于异常的跟踪, 包含有全局变量等).

推荐使用 [“with” 语句](http://docs.python.org/reference/compound_stmts.html#the-with-statement) 以管理文件:

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

每个导入应该独占一行, `typing` 的导入除外

```
Yes: import os
    import sys
    from typing import Mapping, Sequence
```

导入总应该放在文件顶部, 位于模块注释和文档字符串之后, 模块全局变量和常量之前. 导入应该按照从最通用到最不通用的顺序分组:

1.  `__future__` 导入

```
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
```

1.  标准库导入

1.  第三方库导入

1.  本地代码子包导入

```
from otherproject.ai import mind
```

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

```
import collections
import queue
import sys

from absl import app
from absl import flags
import bs4
import cryptography
import tensorflow as tf

from book.genres import scifi
from myproject.backend import huxley
from myproject.backend.hgwells import time_machine
from myproject.backend.state_machine import main_loop
from otherproject.ai import body
from otherproject.ai import mind
from otherproject.ai import soul

# Older style code may have these imports down here instead:
#from myproject.backend.hgwells import time_machine
#from myproject.backend.state_machine import main_loop
```

语句
--

不过, 如果测试结果与测试语句在一行放得下, 你也可以将它们放在同一行. 如果是 if 语句, 只有在没有 else 时才能这样做. 特别地, 绝不要对 `try/except` 这样做, 因为 try 和 except 不能放在同一行.

```
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_CONSTANT_NAME` ; 全局变量名: `global_var_name` ; 实例名: `instance_var_name` ; 函数参数名: `function_parameter_name` ; 局部变量名: `local_var_name` . 函数名, 变量名和文件名应该是描述性的, 尽量避免缩写, 特别要避免使用非项目人员不清楚难以理解的缩写, 不要通过删除单词中的字母来进行缩写. 始终使用 `.py` 作为文件后缀名, 不要用破折号.

**应该避免的名称**

1.  单字符名称, 除了计数器和迭代器, 作为 `try/except` 中异常声明的 `e`, 作为 `with` 语句中文件句柄的 `f`.
2.  包 / 模块名中的连字符 (-)
3.  双下划线开头并结尾的名称 (Python 保留, 例如__init__)

**命名约定**

1.  所谓”内部 (Internal)” 表示仅模块内可用, 或者, 在类内是保护或私有的.
2.  用单下划线 (_) 开头表示模块变量或函数是 protected 的(使用 from module import * 时不会包含).
3.  用双下划线 (__) 开头的实例变量或方法表示类内私有.
4.  将相关的类和顶级函数放在同一个模块里. 不像 Java, 没必要限制一个类一个模块.
5.  对类名使用大写字母开头的单词 (如 CapWords, 即 Pascal 风格), 但是模块名应该用小写加下划线的方式 (如 lower_with_under.py). 尽管已经有很多现存的模块使用类似于 CapWords.py 这样的命名, 但现在已经不鼓励这样做, 因为如果模块名碰巧和类名一致, 这会让人困扰.

**文件名**

所有 python 脚本文件都应该以 `.py` 为后缀名且不包含 `-`. 若是需要一个无后缀名的可执行文件, 可以使用软联接或者包含 `exec "$0.py" "$@"` 的 bash 脚本.

**Python 之父 Guido 推荐的规范**

<table><colgroup><col width="23%"> <col width="17%"> <col width="60%"> </colgroup><thead><tr><th>Type</th><th>Public</th><th>Internal</th></tr></thead><tbody><tr><td>Modules</td><td>lower_with_under</td><td>_lower_with_under</td></tr><tr><td>Packages</td><td>lower_with_under</td><td>&nbsp;</td></tr><tr><td>Classes</td><td>CapWords</td><td>_CapWords</td></tr><tr><td>Exceptions</td><td>CapWords</td><td>&nbsp;</td></tr><tr><td>Functions</td><td>lower_with_under()</td><td>_lower_with_under()</td></tr><tr><td>Global/Class Constants</td><td>CAPS_WITH_UNDER</td><td>_CAPS_WITH_UNDER</td></tr><tr><td>Global/Class Variables</td><td>lower_with_under</td><td>_lower_with_under</td></tr><tr><td>Instance Variables</td><td>lower_with_under</td><td>_lower_with_under (protected) or __lower_with_under (private)</td></tr><tr><td>Method Names</td><td>lower_with_under()</td><td>_lower_with_under() (protected) or __lower_with_under() (private)</td></tr><tr><td>Function/Method Parameters</td><td>lower_with_under</td><td>&nbsp;</td></tr><tr><td>Local Variables</td><td>lower_with_under</td><td>&nbsp;</td></tr></tbody></table>

Main
----

Tip

即使是一个打算被用作脚本的文件, 也应该是可导入的. 并且简单的导入不应该导致这个脚本的主功能 (main functionality) 被执行, 这是一种副作用. 主功能应该放在一个 main()函数中.

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

若使用 [absl](https://github.com/abseil/abseil-py), 请使用 `app.run` :

```
from absl import app
...

def main(argv):
    # process non-flag arguments
    ...

if __name__ == '__main__':
    app.run(main)
```

否则, 使用:

```
def main():
    ...

if __name__ == '__main__':
    main()
```

所有的顶级代码在模块导入时都会被执行. 要小心不要去调用函数, 创建对象, 或者执行那些不应该在使用 pydoc 时执行的操作.

函数长度
----

不对函数长度做硬性限制. 但是若一个函数超过来 40 行, 推荐考虑一下是否可以在不损害程序结构的情况下对其进行分解. 因为即使现在长函数运行良好, 但几个月后可能会有人修改它并添加一些新的行为, 这容易产生难以发现的 bug. 保持函数的简练, 使其更加容易阅读和修改. 当遇到一些很长的函数时, 若发现调试比较困难或是想在其他地方使用函数的一部分功能, 不妨考虑将这个场函数进行拆分.

类型注释
----

**通用规则**

1.  请先熟悉下 ‘PEP-484 <[https://www.python.org/dev/peps/pep-0484/](https://www.python.org/dev/peps/pep-0484/)>’_
2.  对于方法，仅在必要时才对 `self` 或 `cls` 注释
3.  若对类型没有任何显示，请使用 `Any`
4.  无需注释模块中的所有函数
    
    1.  公共的 API 需要注释
    2.  在代码的安全性，清晰性和灵活性上进行权衡是否注释
    3.  对于容易出现类型相关的错误的代码进行注释
    4.  难以理解的代码请进行注释
    5.  若代码中的类型已经稳定，可以进行注释. 对于一份成熟的代码，多数情况下，即使注释了所有的函数，也不会丧失太多的灵活性.

**换行**

尽量遵守既定的缩进规则. 注释后，很多函数签名将会变成每行一个参数.

```
def my_method(self,
              first_var: int,
              second_var: Foo,
              third_var: Optional[Bar]) -> int:
...
```

尽量在变量之间换行而不是在变量和类型注释之间. 当然, 若所有东西都在一行上, 也可以接受.

```
def my_method(self, first_var: int) -> int:
...
```

若是函数名, 末位形参和返回值的类型注释太长, 也可以进行换行, 并在新行进行 4 格缩进.

```
def my_method(
    self, first_var: int) -> Tuple[MyLongType1, MyLongType1]:
...
```

若是末位形参和返回值类型注释不适合在同一行上, 可以换行, 缩进为 4 空格, 并保持闭合的括号 `)` 和 `def` 对齐

```
Yes:
def my_method(
    self, other_arg: Optional[MyLongType]
) -> Dict[OtherLongType, MyLongType]:
...
```

`pylint` 允许闭合括号 `)` 换至新行并与 开启括号 `(` 对齐, 但这样的可读性不好.

```
No:
def my_method(self,
                other_arg: Optional[MyLongType]
             ) -> Dict[OtherLongType, MyLongType]:
...
```

如上所示, 尽量不要在一个类型注释中进行换行. 但是有时类型注释过长需要换行时, 请尽量保持子类型中不被换行.

```
def my_method(
    self,
    first_var: Tuple[List[MyLongType1],
                     List[MyLongType2]],
    second_var: List[Dict[
        MyLongType3, MyLongType4]]) -> None:
...
```

若一个类型注释确实太长, 则应优先考虑对过长的类型使用别名 [alias](https://google.github.io/styleguide/pyguide.html#typing-aliases). 其次是考虑在冒号后 [``](#system-message-2):[``](#system-message-3) 进行换行并添加 4 格空格缩进.

```
Yes:
def my_function(
    long_variable_name:
        long_module_name.LongTypeName,
) -> None:
...
```

```
No:
def my_function(
    long_variable_name: long_module_name.
        LongTypeName,
) -> None:
...
```

**预先声明**

若需要使用一个当前模块尚未定义的类名, 比如想在类声明中使用类名, 请使用类名的字符串

```
class MyClass:

def __init__(self,
               stack: List["MyClass"]) -> None:
```

**参数默认值**

依据 [PEP-008](https://www.python.org/dev/peps/pep-0008/#other-recommendations) , 仅对同时具有类型注释和默认值的参数的 `=` 周围加空格.

```
Yes:
def func(a: int = 0) -> int:
...
```

```
No:
def func(a:int=0) -> int:
...
```

**NoneType**

在 python 的类型系统中, `NoneType` 是 “一等对象”, 为了输入方便, `None` 是 `NoneType` 的别名. 一个变量若是 `None`, 则该变量必须被声明. 我们可以使用 `Union`, 但若类型仅仅只是对应另一个其他类型, 建议使用 `Optional`. 尽量显式而非隐式的使用 `Optional`. 在 PEP-484 的早期版本中允许使用 `a: Text = None` 来替代 `a: Optional[Text] = None`, 当然, 现在不推荐这么做了.

```
Yes:
def func(a: Optional[Text], b: Optional[Text] = None) -> Text:
    ...
def multiple_nullable_union(a: Union[None, Text, int]) -> Text
    ...
```

```
No:
def nullable_union(a: Union[None, Text]) -> Text:
    ...
def implicit_optional(a: Text = None) -> Text:
    ...
```

**类型别名**

复杂类型应使用别名, 别名的命名可参照帕斯卡命名. 若别名仅在当前模块使用, 应在名称前加 ``_`` 变为私有的. 如下例子中, 模块名和类型名连一起过长:

```
_ShortName = module_with_long_name.TypeWithLongName
ComplexMap = Mapping[Text, List[Tuple[int, int]]]
```

**忽略类型注释**

可以使用特殊的行尾注释 `# type: ignore` 来禁用该行的类型检查. `pytype` 针对特定错误有一个禁用选项 (类似 lint):

```
# pytype: disable=attribute-error
```

**变量类型注解**

当一个内部变量难以推断其类型时, 可以有以下方法来指示其类型:

**类型注释**

使用行尾注释 `# type:`:

```
a = SomeUndecoratedFunction()  # type: Foo
```

**带类型注解的复制** 如函数形参一样, 在变量名和等号间加入冒号和类型:

```
a: Foo = SomeUndecoratedFunction()
```

**Tuples vs Lists**

类型化的 Lists 只能包含单一类型的元素. 但类型化的 Tuples 可以包含单一类型的元素或者若干个不同类型的元素, 通常被用来注解返回值的类型. (译者注: 注意这里是指的类型注解中的写法, 实际 python 中, list 和 tuple 都是可以在一个序列中包含不同类型元素的, 当然, 本质其实 list 和 tuple 中放的是元素的引用)

```
a = [1, 2, 3]  # type: List[int]
b = (1, 2, 3)  # type: Tuple[int, ...]
c = (1, "2", 3.5)  # type: Tuple[int, Text, float]
```

**TypeVars**

python 的类型系统是支持泛型的. 一种常见的方式就是使用工厂函数 `TypeVars`.

```
from typing import List, TypeVar
T = TypeVar("T")
...
def next(l: List[T]) -> T:
    return l.pop()
```

TypeVar 也可以被限定成若干种类型

```
AddableType = TypeVar("AddableType", int, float, Text)
def add(a: AddableType, b: AddableType) -> AddableType:
    return a + b
```

`typing` 模块中一个常见的预定义类型变量是 `AnyStr`. 它可以用来注解类似 `bytes`, `unicode` 以及一些相似类型.

```
from typing import AnyStr
def check_length(x: AnyStr) -> AnyStr:
    if len(x) <= 42:
        return x
    raise ValueError()
```

**字符串类型**

如何正确的注释字符串的相关类型和要使用的 python 版本有关. 对于仅在 python3 下运行的代码, 首选使用 `str`. 使用 `Text` 也可以. 但是两个不要混用, 保持风格一致. 对于需要兼容 python2 的代码, 使用 `Text`. 在少数情况下, 使用 `str` 也许更加清晰. 不要使用 `unicode`, 因为 python3 里没有这个类型. 造成这种差异的原因是因为, 在不同的 python 版本中,``str`` 意义不同.

```
No:
def py2_code(x: str) -> unicode:
...
```

对于需要处理二进制数据的代码, 使用 `bytes`.

```
def deals_with_binary_data(x: bytes) -> bytes:
  ...
```

python2 中的文本类数据类型包括 ``str`` 和 ``unicode``, 而 python3 中仅有 `str`.

```
from typing import Text
...
def py2_compatible(x: Text) -> Text:
...
def py3_only(x: str) -> str:
...
```

若类型既可以是二进制也可以是文本, 那么就使用 `Union` 进行注解, 并按照之前规则使用合适的文本类型注释.

```
from typing import Text, Union
...
def py2_compatible(x: Union[bytes, Text]) -> Union[bytes, Text]:
...
def py3_only(x: Union[bytes, str]) -> Union[bytes, str]:
...
```

若一个函数中的字符串类型始终相同, 比如上述函数中返回值类型和形参类型都一样, 使用 [AnyStr](https://google.github.io/styleguide/pyguide.html#typing-type-var). 这样写可以方便将代码移植到 python3

**类型的导入**

对于 `typing` 模块中类的导入, 请直接导入类本身. 你可以显式的在一行中从 `typing` 模块导入多个特定的类, 例如:

```
from typing import Any, Dict, Optional
```

以此方式导入的类将被加入到本地的命名空间, 因此所有 `typing` 模块中的类都应被视为关键字, 不要在代码中定义并覆盖它们. 若这些类和现行代码中的变量或者方法发生命名冲突, 可以考虑使用 [``](#system-message-4)import x as y`` 的导入形式:

```
from typing import Any as AnyType
```

**条件导入**

在一些特殊情况下, 比如当在运行时需要避免类型检查所需的一些导入时, 可能会用到条件导入. 但这类方法并不推荐, 首选方法应是重构代码使类型检查所需的模块可以在顶层导入. 仅用于类型注解的导入可以放在 `if TYPE_CHECKING:` 语句块内.

1.  通过条件导入引入的类的注解须是字符串 string, 这样才能和 python3.6 之前的代码兼容. 因为 python3.6 之前, 类型注解是会进行求值的.
2.  条件导入引入的包应仅仅用于类型注解, 别名也是如此. 否则, 将引起运行错误, 条件导入的包在运行时是不会被实际导入的.
3.  条件导入的语句块应放在所有常规导入的语句块之后.
4.  在条件导入的语句块的导入语句之间不应有空行.
5.  和常规导入一样, 请对该导入语句进行排序.

```
import typing
if typing.TYPE_CHECKING:
    import sketch
def f(x: "sketch.Sketch"): ...
```

**循环依赖**

由类型注释引起的循环依赖可能会导致代码异味, 应对其进行重构. 虽然从技术上我们可以兼容循环依赖, 但是 [构建系统](https://google.github.io/styleguide/pyguide.html#typing-build-deps) 是不会容忍这样做的, 因为每个模块都需要依赖一个其他模块. 将引起循环依赖的导入模块使用 `Any` 导入. 使用 `alias` 来起一个有意义的别名, 推荐使用真正模块的类型名的字符串作为别名 (Any 的任何属性依然是 Any, 使用字符串只是帮助我们理解代码). 别名的定义应该和最后的导入语句之间空一行.

```
from typing import Any

some_mod = Any  # some_mod.py imports this module.
...

def my_method(self, var: "some_mod.SomeType") -> None:
...
```

**泛型**

在注释时, 尽量将泛型类型注释为类型参数. 否则, [泛型参数将被视为是 Any](https://www.python.org/dev/peps/pep-0484/#the-any-type) .

```
def get_names(employee_ids: List[int]) -> Dict[int, Any]:
...
```

```
# These are both interpreted as get_names(employee_ids: List[Any]) -> Dict[Any, Any]
def get_names(employee_ids: list) -> Dict:
...

def get_names(employee_ids: List) -> Dict:
...
```

若实在要用 Any 作为泛型类型, 请显式的使用它. 但在多数情况下, `TypeVar` 通常可能是更好的选择.

```
def get_names(employee_ids: List[Any]) -> Dict[Any, Text]:
    """Returns a mapping from employee ID to employee name for given IDs."""
```

```
T = TypeVar('T')
def get_names(employee_ids: List[T]) -> Dict[T, Text]:
    """Returns a mapping from employee ID to employee name for given IDs."""
```