4. 其他流程控制工具

除了上一章介绍的 while 语句，Python 还支持其他语言中常见的流程控制语句，只是稍有不同。

4.1. if 语句

最让人耳熟能详的应该是 if 语句。例如：

  1. >>> x = int(input("Please enter an integer: "))
  2. Please enter an integer: 42
  3. >>> if x < 0:
  4. ...     x = 0
  5. ...     print('Negative changed to zero')
  6. ... elif x == 0:
  7. ...     print('Zero')
  8. ... elif x == 1:
  9. ...     print('Single')
  10. ... else:
  11. ...     print('More')
  12. ...
  13. More

if 语句包含零个或多个 elif 子句，及可选的 else 子句。关键字 ‘elif‘ 是 ‘else if’ 的缩写，适用于避免过多的缩进。可以把 if … elif … elif … 序列看作是其他语言中 switch 或 case 语句的替代品。

4.2. for 语句

Python 的 for 语句与 C 或 Pascal 中的不同。Python 的 for 语句不迭代算术递增数值（如 Pascal），或是给予用户定义迭代步骤和暂停条件的能力（如 C），而是迭代列表或字符串等任意序列，元素的迭代顺序与在序列中出现的顺序一致。 例如：

  1. >>> # Measure some strings:
  2. ... words = ['cat', 'window', 'defenestrate']
  3. >>> for w in words:
  4. ...     print(w, len(w))
  5. ...
  6. cat 3
  7. window 6
  8. defenestrate 12

遍历某个集合的同时修改该集合的内容，很难获取想要的结果。要在遍历时修改集合的内容，应该遍历该集合的副本或创建新的集合：

  1. # Strategy:  Iterate over a copy
  2. for user, status in users.copy().items():
  3.     if status == 'inactive':
  4.         del users[user]
  6. # Strategy:  Create a new collection
  7. active_users = {}
  8. for user, status in users.items():
  9.     if status == 'active':
  10.         active_users[user] = status

4.3. range() 函数

内置函数 range() 常用于遍历数字序列，该函数可以生成算术级数：

  1. >>> for i in range(5):
  2. ...     print(i)
  3. ...
  4. 0
  5. 1
  6. 2
  7. 3
  8. 4

生成的序列不包含给定的终止数值；range(10) 生成 10 个值，这是一个长度为 10 的序列，其中的元素索引都是合法的。range 可以不从 0 开始，还可以按指定幅度递增（递增幅度称为 ‘步进’，支持负数）：

  1. >>> list(range(5, 10))
  2. [5, 6, 7, 8, 9]
  4. >>> list(range(0, 10, 3))
  5. [0, 3, 6, 9]
  7. >>> list(range(-10, -100, -30))
  8. [-10, -40, -70]

range() 和 len() 组合在一起，可以按索引迭代序列：

  1. >>> a = ['Mary', 'had', 'a', 'little', 'lamb']
  2. >>> for i in range(len(a)):
  3. ...     print(i, a[i])
  4. ...
  5. 0 Mary
  6. 1 had
  7. 2 a
  8. 3 little
  9. 4 lamb

不过，大多数情况下，enumerate() 函数更便捷，详见 循环的技巧 。

如果只输出 range，会出现意想不到的结果：

  1. >>> range(10)
  2. range(0, 10)

range() 返回对象的操作和列表很像，但其实这两种对象不是一回事。迭代时，该对象基于所需序列返回连续项，并没有生成真正的列表，从而节省了空间。

这种对象称为可迭代对象 iterable，函数或程序结构可通过该对象获取连续项，直到所有元素全部迭代完毕。for 语句就是这样的架构，sum() 是一种把可迭代对象作为参数的函数：

  1. >>> sum(range(4))  # 0 + 1 + 2 + 3
  2. 6

下文将介绍更多返回可迭代对象或把可迭代对象当作参数的函数。 在 数据结构 这一章节中，我们将讨论有关 list() 的更多细节。

4.4. 循环中的 break、continue 语句及 else 子句

break 语句和 C 中的类似，用于跳出最近的 for 或 while 循环。

循环语句支持 else 子句；for 循环中，可迭代对象中的元素全部循环完毕时，或 while 循环的条件为假时，执行该子句；break 语句终止循环时，不执行该子句。 请看下面这个查找素数的循环示例：

  1. >>> for n in range(2, 10):
  2. ...     for x in range(2, n):
  3. ...         if n % x == 0:
  4. ...             print(n, 'equals', x, '*', n//x)
  5. ...             break
  6. ...     else:
  7. ...         # loop fell through without finding a factor
  8. ...         print(n, 'is a prime number')
  9. ...
  10. 2 is a prime number
  11. 3 is a prime number
  12. 4 equals 2 * 2
  13. 5 is a prime number
  14. 6 equals 2 * 3
  15. 7 is a prime number
  16. 8 equals 2 * 4
  17. 9 equals 3 * 3

（没错，这段代码就是这么写。仔细看：else 子句属于 for 循环，不属于 if 语句。）

与 if 语句相比，循环的 else 子句更像 try 的 else 子句： try 的 else 子句在未触发异常时执行，循环的 else 子句则在未运行 break 时执行。try 语句和异常详见 处理异常。

continue 语句也借鉴自 C 语言，表示继续执行循环的下一次迭代：

  1. >>> for num in range(2, 10):
  2. ...     if num % 2 == 0:
  3. ...         print("Found an even number", num)
  4. ...         continue
  5. ...     print("Found an odd number", num)
  6. ...
  7. Found an even number 2
  8. Found an odd number 3
  9. Found an even number 4
  10. Found an odd number 5
  11. Found an even number 6
  12. Found an odd number 7
  13. Found an even number 8
  14. Found an odd number 9

4.5. pass 语句

pass 语句不执行任何操作。语法上需要一个语句，但程序不实际执行任何动作时，可以使用该语句。例如：

  1. >>> while True:
  2. ...     pass  # Busy-wait for keyboard interrupt (Ctrl+C)
  3. ...

下面这段代码创建了一个最小的类：

  1. >>> class MyEmptyClass:
  2. ...     pass
  3. ...

pass 还可以用作函数或条件子句的占位符，让开发者聚焦更抽象的层次。此时，程序直接忽略 pass：

  1. >>> def initlog(*args):
  2. ...     pass   # Remember to implement this!
  3. ...

4.6. 定义函数

下列代码创建一个可以输出限定数值内的斐波那契数列函数：

  1. >>> def fib(n):    # write Fibonacci series up to n
  2. ...     """Print a Fibonacci series up to n."""
  3. ...     a, b = 0, 1
  4. ...     while a < n:
  5. ...         print(a, end=' ')
  6. ...         a, b = b, a+b
  7. ...     print()
  8. ...
  9. >>> # Now call the function we just defined:
  10. ... fib(2000)
  11. 0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987 1597

定义 函数使用关键字 def，后跟函数名与括号内的形参列表。函数语句从下一行开始，并且必须缩进。

函数内的第一条语句是字符串时，该字符串就是文档字符串，也称为 docstring，详见 文档字符串。利用文档字符串可以自动生成在线文档或打印版文档，还可以让开发者在浏览代码时直接查阅文档；Python 开发者最好养成在代码中加入文档字符串的好习惯。

函数在 执行 时使用函数局部变量符号表，所有函数变量赋值都存在局部符号表中；引用变量时，首先，在局部符号表里查找变量，然后，是外层函数局部符号表，再是全局符号表，最后是内置名称符号表。因此，尽管可以引用全局变量和外层函数的变量，但最好不要在函数内直接赋值（除非是 global 语句定义的全局变量，或 nonlocal 语句定义的外层函数变量）。

在调用函数时会将实际参数（实参）引入到被调用函数的局部符号表中；因此，实参是使用 按值调用 来传递的（其中的 值 始终是对象的 引用 而不是对象的值）。 1 当一个函数调用另外一个函数时，会为该调用创建一个新的局部符号表。

函数定义在当前符号表中把函数名与函数对象关联在一起。解释器把函数名指向的对象作为用户自定义函数。还可以使用其他名称指向同一个函数对象，并访问访该函数：

  1. >>> fib
  2. <function fib at 10042ed0>
  3. >>> f = fib
  4. >>> f(100)
  5. 0 1 1 2 3 5 8 13 21 34 55 89

fib 不返回值，因此，其他语言不把它当作函数，而是当作过程。事实上，没有 return 语句的函数也返回值，只不过这个值比较是 None （是一个内置名称）。一般来说，解释器不会输出单独的返回值 None ，如需查看该值，可以使用 print()：

  1. >>> fib(0)
  2. >>> print(fib(0))
  3. None

编写不直接输出斐波那契数列运算结果，而是返回运算结果列表的函数也非常简单：

  1. >>> def fib2(n):  # return Fibonacci series up to n
  2. ...     """Return a list containing the Fibonacci series up to n."""
  3. ...     result = []
  4. ...     a, b = 0, 1
  5. ...     while a < n:
  6. ...         result.append(a)    # see below
  7. ...         a, b = b, a+b
  8. ...     return result
  9. ...
  10. >>> f100 = fib2(100)    # call it
  11. >>> f100                # write the result
  12. [0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]

本例也新引入了一些 Python 功能：

  • return 语句返回函数的值。return 语句不带表达式参数时，返回 None。函数执行完毕退出也返回 None。

  • result.append(a) 语句调用了列表对象 result 的 方法 。方法是“从属于”对象的函数，命名为 obj.methodname，obj 是对象（也可以是表达式），methodname 是对象类型定义的方法名。不同类型定义不同的方法，不同类型的方法名可以相同，且不会引起歧义。（用 类 可以自定义对象类型和方法，详见 类 ）示例中的方法 append() 是为列表对象定义的，用于在列表末尾添加新元素。本例中，该方法相当于 result = result + [a] ，但更有效。

4.7. 函数定义详解

函数定义支持可变数量的参数。这里列出三种可以组合使用的形式。

4.7.1. 默认值参数

为参数指定默认值是非常有用的方式。调用函数时，可以使用比定义时更少的参数，例如：

  1. def ask_ok(prompt, retries=4, reminder='Please try again!'):
  2.     while True:
  3.         ok = input(prompt)
  4.         if ok in ('y', 'ye', 'yes'):
  5.             return True
  6.         if ok in ('n', 'no', 'nop', 'nope'):
  7.             return False
  8.         retries = retries - 1
  9.         if retries < 0:
  10.             raise ValueError('invalid user response')
  11.         print(reminder)

该函数可以用以下方式调用：

  • 只给出必选实参：ask_ok('Do you really want to quit?')

  • 给出一个可选实参：ask_ok('OK to overwrite the file?', 2)

  • 给出所有实参：ask_ok('OK to overwrite the file?', 2, 'Come on, only yes or no!')

本例还使用了关键字 in ，用于确认序列中是否包含某个值。

默认值在 定义 作用域里的函数定义中求值，所以：

  1. i = 5
  3. def f(arg=i):
  4.     print(arg)
  6. i = 6
  7. f()

上例输出的是 5。

重要警告： 默认值只计算一次。默认值为列表、字典或类实例等可变对象时，会产生与该规则不同的结果。例如，下面的函数会累积后续调用时传递的参数：

  1. def f(a, L=[]):
  2.     L.append(a)
  3.     return L
  5. print(f(1))
  6. print(f(2))
  7. print(f(3))

输出结果如下：

  1. [1]
  2. [1, 2]
  3. [1, 2, 3]

不想在后续调用之间共享默认值时，应以如下方式编写函数：

  1. def f(a, L=None):
  2.     if L is None:
  3.         L = []
  4.     L.append(a)
  5.     return L

4.7.2. 关键字参数

kwarg=value 形式的 关键字参数 也可以用于调用函数。函数示例如下：

  1. def parrot(voltage, state='a stiff', action='voom', type='Norwegian Blue'):
  2.     print("-- This parrot wouldn't", action, end=' ')
  3.     print("if you put", voltage, "volts through it.")
  4.     print("-- Lovely plumage, the", type)
  5.     print("-- It's", state, "!")

该函数接受一个必选参数（voltage）和三个可选参数（state, action 和 type）。该函数可用下列方式调用：

  1. parrot(1000)                                          # 1 positional argument
  2. parrot(voltage=1000)                                  # 1 keyword argument
  3. parrot(voltage=1000000, action='VOOOOOM')             # 2 keyword arguments
  4. parrot(action='VOOOOOM', voltage=1000000)             # 2 keyword arguments
  5. parrot('a million', 'bereft of life', 'jump')         # 3 positional arguments
  6. parrot('a thousand', state='pushing up the daisies')  # 1 positional, 1 keyword

以下调用函数的方式都无效：

  1. parrot()                     # required argument missing
  2. parrot(voltage=5.0, 'dead')  # non-keyword argument after a keyword argument
  3. parrot(110, voltage=220)     # duplicate value for the same argument
  4. parrot(actor='John Cleese')  # unknown keyword argument

函数调用时，关键字参数必须跟在位置参数后面。所有传递的关键字参数都必须匹配一个函数接受的参数（比如，actor 不是函数 parrot 的有效参数），关键字参数的顺序并不重要。这也包括必选参数，（比如，parrot(voltage=1000) 也有效）。不能对同一个参数多次赋值，下面就是一个因此限制而失败的例子：

  1. >>> def function(a):
  2. ...     pass
  3. ...
  4. >>> function(0, a=0)
  5. Traceback (most recent call last):
  6.   File "<stdin>", line 1, in <module>
  7. TypeError: function() got multiple values for keyword argument 'a'

最后一个形参为 **name 形式时，接收一个字典（详见 映射类型 —- dict），该字典包含与函数中已定义形参对应之外的所有关键字参数。**name 形参可以与 *name 形参（下一小节介绍）组合使用（*name 必须在 **name 前面）， *name 形参接收一个 元组，该元组包含形参列表之外的位置参数。例如，可以定义下面这样的函数：

  1. def cheeseshop(kind, *arguments, **keywords):
  2.     print("-- Do you have any", kind, "?")
  3.     print("-- I'm sorry, we're all out of", kind)
  4.     for arg in arguments:
  5.         print(arg)
  6.     print("-" * 40)
  7.     for kw in keywords:
  8.         print(kw, ":", keywords[kw])

该函数可以用如下方式调用：

  1. cheeseshop("Limburger", "It's very runny, sir.",
  2.            "It's really very, VERY runny, sir.",
  3.            shopkeeper="Michael Palin",
  4.            client="John Cleese",
  5.            sketch="Cheese Shop Sketch")

输出结果如下：

  1. -- Do you have any Limburger ?
  2. -- I'm sorry, we're all out of Limburger
  3. It's very runny, sir.
  4. It's really very, VERY runny, sir.
  5. ----------------------------------------
  6. shopkeeper : Michael Palin
  7. client : John Cleese
  8. sketch : Cheese Shop Sketch

注意，关键字参数在输出结果中的顺序与调用函数时的顺序一致。

4.7.3. 特殊参数

默认情况下，参数可以按位置或显式关键字传递给 Python 函数。为了让代码易读、高效，最好限制参数的传递方式，这样，开发者只需查看函数定义，即可确定参数项是仅按位置、按位置或关键字，还是仅按关键字传递。

函数定义如下：

  1. def f(pos1, pos2, /, pos_or_kwd, *, kwd1, kwd2):
  2.       -----------    ----------     ----------
  3.         |             |                  |
  4.         |        Positional or keyword   |
  5.         |                                - Keyword only
  6.          -- Positional only

/ 和 * 是可选的。这些符号表明形参如何把参数值传递给函数：位置、位置或关键字、关键字。关键字形参也叫作命名形参。

4.7.3.1. 位置或关键字参数

函数定义中未使用 / 和 * 时，参数可以按位置或关键字传递给函数。

4.7.3.2. 仅位置参数

此处再介绍一些细节，特定形参可以标记为 仅限位置。仅限位置 时，形参的顺序很重要，且这些形参不能用关键字传递。仅限位置形参应放在 / （正斜杠）前。/ 用于在逻辑上分割仅限位置形参与其它形参。如果函数定义中没有 /，则表示没有仅限位置形参。

/ 后可以是 位置或关键字 或 仅限关键字 形参。

4.7.3.3. 仅限关键字参数

把形参标记为 仅限关键字，表明必须以关键字参数形式传递该形参，应在参数列表中第一个 仅限关键字 形参前添加 *。

4.7.3.4. 函数示例

请看下面的函数定义示例，注意 / 和 * 标记：

  1. >>> def standard_arg(arg):
  2. ...     print(arg)
  3. ...
  4. >>> def pos_only_arg(arg, /):
  5. ...     print(arg)
  6. ...
  7. >>> def kwd_only_arg(*, arg):
  8. ...     print(arg)
  9. ...
  10. >>> def combined_example(pos_only, /, standard, *, kwd_only):
  11. ...     print(pos_only, standard, kwd_only)

第一个函数定义 standard_arg 是最常见的形式，对调用方式没有任何限制，可以按位置也可以按关键字传递参数：

  1. >>> standard_arg(2)
  2. 2
  4. >>> standard_arg(arg=2)
  5. 2

第二个函数 pos_only_arg 的函数定义中有 /，仅限使用位置形参：

  1. >>> pos_only_arg(1)
  2. 1
  4. >>> pos_only_arg(arg=1)
  5. Traceback (most recent call last):
  6.   File "<stdin>", line 1, in <module>
  7. TypeError: pos_only_arg() got an unexpected keyword argument 'arg'

第三个函数 kwd_only_args 的函数定义通过 * 表明仅限关键字参数：

  1. >>> kwd_only_arg(3)
  2. Traceback (most recent call last):
  3.   File "<stdin>", line 1, in <module>
  4. TypeError: kwd_only_arg() takes 0 positional arguments but 1 was given
  6. >>> kwd_only_arg(arg=3)
  7. 3

最后一个函数在同一个函数定义中，使用了全部三种调用惯例：

  1. >>> combined_example(1, 2, 3)
  2. Traceback (most recent call last):
  3.   File "<stdin>", line 1, in <module>
  4. TypeError: combined_example() takes 2 positional arguments but 3 were given
  6. >>> combined_example(1, 2, kwd_only=3)
  7. 1 2 3
  9. >>> combined_example(1, standard=2, kwd_only=3)
  10. 1 2 3
  12. >>> combined_example(pos_only=1, standard=2, kwd_only=3)
  13. Traceback (most recent call last):
  14.   File "<stdin>", line 1, in <module>
  15. TypeError: combined_example() got an unexpected keyword argument 'pos_only'

下面的函数定义中，kwds 把 name 当作键，因此，可能与位置参数 name 产生潜在冲突：

  1. def foo(name, **kwds):
  2.     return 'name' in kwds

调用该函数不可能返回 True，因为关键字 'name' 总与第一个形参绑定。例如：

  1. >>> foo(1, **{'name': 2})
  2. Traceback (most recent call last):
  3.   File "<stdin>", line 1, in <module>
  4. TypeError: foo() got multiple values for argument 'name'
  5. >>>

加上 / （仅限位置参数）后，就可以了。此时，函数定义把 name 当作位置参数，'name' 也可以作为关键字参数的键：

  1. def foo(name, /, **kwds):
  2.     return 'name' in kwds
  3. >>> foo(1, **{'name': 2})
  4. True

换句话说，仅限位置形参的名称可以在 **kwds 中使用，而不产生歧义。

4.7.3.5. 小结

以下用例决定哪些形参可以用于函数定义：

  1. def f(pos1, pos2, /, pos_or_kwd, *, kwd1, kwd2):

说明：

  • 使用仅限位置形参，可以让用户无法使用形参名。形参名没有实际意义时，强制调用函数的实参顺序时，或同时接收位置形参和关键字时，这种方式很有用。

  • 当形参名有实际意义，且显式名称可以让函数定义更易理解时，阻止用户依赖传递实参的位置时，才使用关键字。

  • 对于 API，使用仅限位置形参，可以防止未来修改形参名时造成破坏性的 API 变动。

4.7.4. 任意实参列表

调用函数时，使用任意数量的实参是最少见的选项。这些实参包含在元组中（详见 元组和序列 ）。在可变数量的实参之前，可能有若干个普通参数：

  1. def write_multiple_items(file, separator, *args):
  2.     file.write(separator.join(args))

variadic 实参用于采集传递给函数的所有剩余实参，因此，它们通常在形参列表的末尾。*args 形参后的任何形式参数只能是仅限关键字参数，即只能用作关键字参数，不能用作位置参数：

  1. >>> def concat(*args, sep="/"):
  2. ...     return sep.join(args)
  3. ...
  4. >>> concat("earth", "mars", "venus")
  5. 'earth/mars/venus'
  6. >>> concat("earth", "mars", "venus", sep=".")
  7. 'earth.mars.venus'

4.7.5. 解包实参列表

函数调用要求独立的位置参数，但实参在列表或元组里时，要执行相反的操作。例如，内置的 range() 函数要求独立的 start 和 stop 实参。如果这些参数不是独立的，则要在调用函数时，用 * 操作符把实参从列表或元组解包出来：

  1. >>> list(range(3, 6))            # normal call with separate arguments
  2. [3, 4, 5]
  3. >>> args = [3, 6]
  4. >>> list(range(*args))            # call with arguments unpacked from a list
  5. [3, 4, 5]

同样，字典可以用 ** 操作符传递关键字参数：

  1. >>> def parrot(voltage, state='a stiff', action='voom'):
  2. ...     print("-- This parrot wouldn't", action, end=' ')
  3. ...     print("if you put", voltage, "volts through it.", end=' ')
  4. ...     print("E's", state, "!")
  5. ...
  6. >>> d = {"voltage": "four million", "state": "bleedin' demised", "action": "VOOM"}
  7. >>> parrot(**d)
  8. -- This parrot wouldn't VOOM if you put four million volts through it. E's bleedin' demised !

4.7.6. Lambda 表达式

lambda 关键字用于创建小巧的匿名函数。lambda a, b: a+b 函数返回两个参数的和。Lambda 函数可用于任何需要函数对象的地方。在语法上，匿名函数只能是单个表达式。在语义上，它只是常规函数定义的语法糖。与嵌套函数定义一样，lambda 函数可以引用包含作用域中的变量：

  1. >>> def make_incrementor(n):
  2. ...     return lambda x: x + n
  3. ...
  4. >>> f = make_incrementor(42)
  5. >>> f(0)
  6. 42
  7. >>> f(1)
  8. 43

上例用 lambda 表达式返回函数。还可以把匿名函数用作传递的实参：

  1. >>> pairs = [(1, 'one'), (2, 'two'), (3, 'three'), (4, 'four')]
  2. >>> pairs.sort(key=lambda pair: pair[1])
  3. >>> pairs
  4. [(4, 'four'), (1, 'one'), (3, 'three'), (2, 'two')]

4.7.7. 文档字符串

以下是文档字符串内容和格式的约定。

第一行应为对象用途的简短摘要。为保持简洁，不要在这里显式说明对象名或类型，因为可通过其他方式获取这些信息（除非该名称碰巧是描述函数操作的动词）。这一行应以大写字母开头，以句点结尾。

文档字符串为多行时，第二行应为空白行，在视觉上将摘要与其余描述分开。后面的行可包含若干段落，描述对象的调用约定、副作用等。

Python 解析器不会删除 Python 中多行字符串字面值的缩进，因此，文档处理工具应在必要时删除缩进。这项操作遵循以下约定：文档字符串第一行 之后 的第一个非空行决定了整个文档字符串的缩进量（第一行通常与字符串开头的引号相邻，其缩进在字符串中并不明显，因此，不能用第一行的缩进），然后，删除字符串中所有行开头处与此缩进“等价”的空白符。不能有比此缩进更少的行，但如果出现了缩进更少的行，应删除这些行的所有前导空白符。转化制表符后（通常为 8 个空格），应测试空白符的等效性。

下面是多行文档字符串的一个例子：

  1. >>> def my_function():
  2. ...     """Do nothing, but document it.
  3. ...
  4. ...     No, really, it doesn't do anything.
  5. ...     """
  6. ...     pass
  7. ...
  8. >>> print(my_function.__doc__)
  9. Do nothing, but document it.
  11.     No, really, it doesn't do anything.

4.7.8. 函数注解

函数注解 是可选的用户自定义函数类型的元数据完整信息（详见 PEP 3107 和 PEP 484 ）。

标注 以字典的形式存放在函数的 __annotations__ 属性中，并且不会影响函数的任何其他部分。 形参标注的定义方式是在形参名后加冒号，后面跟一个表达式，该表达式会被求值为标注的值。 返回值标注的定义方式是加组合符号 ->，后面跟一个表达式，该标注位于形参列表和表示 def 语句结束的冒号之间。 下面的示例有一个必须的参数，一个可选的关键字参数以及返回值都带有相应的标注:

  1. >>> def f(ham: str, eggs: str = 'eggs') -> str:
  2. ...     print("Annotations:", f.__annotations__)
  3. ...     print("Arguments:", ham, eggs)
  4. ...     return ham + ' and ' + eggs
  5. ...
  6. >>> f('spam')
  7. Annotations: {'ham': <class 'str'>, 'return': <class 'str'>, 'eggs': <class 'str'>}
  8. Arguments: spam eggs
  9. 'spam and eggs'

4.8. 小插曲：编码风格

现在你将要写更长，更复杂的 Python 代码，是时候讨论一下 代码风格 了。 大多数语言都能以不同的风格被编写（或更准确地说，被格式化）；有些比其他的更具有可读性。 能让其他人轻松阅读你的代码总是一个好主意，采用一种好的编码风格对此有很大帮助。

Python 项目大多都遵循 PEP 8 的风格指南；它推行的编码风格易于阅读、赏心悦目。Python 开发者均应抽时间悉心研读；以下是该提案中的核心要点：

  • 缩进，用 4 个空格，不要用制表符。

    4 个空格是小缩进（更深嵌套）和大缩进（更易阅读）之间的折中方案。制表符会引起混乱，最好别用。

  • 换行，一行不超过 79 个字符。

    这样换行的小屏阅读体验更好，还便于在大屏显示器上并排阅读多个代码文件。

  • 用空行分隔函数和类，及函数内较大的代码块。

  • 最好把注释放到单独一行。

  • 使用文档字符串。

  • 运算符前后、逗号后要用空格，但不要直接在括号内使用： a = f(1, 2) + g(3, 4)。

  • 类和函数的命名要一致；按惯例，命名类用 UpperCamelCase，命名函数与方法用 lowercase_with_underscores。命名方法中第一个参数总是用 self (类和方法详见 初探类)。

  • 编写用于国际多语环境的代码时，不要用生僻的编码。Python 默认的 UTF-8 或纯 ASCII 可以胜任各种情况。

  • 同理，就算多语阅读、维护代码的可能再小，也不要在标识符中使用非 ASCII 字符。

脚注

1

实际上，对象引用调用 这种说法更好，因为，传递的是可变对象时，调用者能发现被调者做出的任何更改（插入列表的元素）。