4. 更多控制流工具 — Python 文档

4. 更多控制流工具

除了刚刚介绍的 while 语句之外，Python 还使用了其他语言中已知的常用流控制语句，但有一些曲折。

4.1. if声明

也许最著名的语句类型是 if 语句。 例如：

>>> x = int(input("Please enter an integer: "))
Please enter an integer: 42
>>> if x < 0:
...     x = 0
...     print('Negative changed to zero')
... elif x == 0:
...     print('Zero')
... elif x == 1:
...     print('Single')
... else:
...     print('More')
...
More

可以有零个或多个 elif 部分，else 部分是可选的。 关键字“elif”是“else if”的缩写，可用于避免过度缩进。 if ... elif ... elif ... 序列可替代其他语言中的 switch 或 case 语句。

4.2. for声明

Python 中的 for 语句与您可能在 C 或 Pascal 中使用的语句略有不同。 Python 的 for 语句不是总是迭代数字的等差数列（如在 Pascal 中），也不是让用户能够定义迭代步骤和停止条件（如 C），而是迭代任何序列（列表或字符串），按照它们在序列中出现的顺序。 例如（没有双关语意）：

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

如果您需要在循环内修改您正在迭代的序列（例如复制所选项目），建议您先制作一个副本。 迭代序列不会隐式地复制。 切片符号使这特别方便：

>>> for w in words[:]:  # Loop over a slice copy of the entire list.
...     if len(w) > 6:
...         words.insert(0, w)
...
>>> words
['defenestrate', 'cat', 'window', 'defenestrate']

使用 for w in words:，该示例将尝试创建一个无限列表，一遍又一遍地插入 defenestrate。

4.3. 这范围（） 功能

如果您确实需要迭代一系列数字，内置函数 range() 会派上用场。 它生成算术级数：

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

给定的终点永远不是生成序列的一部分； range(10) 生成 10 个值，即长度为 10 的序列的项目的合法索引。 可以让范围从另一个数字开始，或者指定不同的增量（甚至是负数；有时这称为“步长”）：

range(5, 10)
   5, 6, 7, 8, 9

range(0, 10, 3)
   0, 3, 6, 9

range(-10, -100, -30)
  -10, -40, -70

要迭代序列的索引，您可以组合 range() 和 len() 如下：

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

但是，在大多数此类情况下，使用 enumerate() 函数会很方便，请参阅 循环技术 。

如果你只是打印一个范围，会发生一件奇怪的事情：

>>> print(range(10))
range(0, 10)

在许多方面，range() 返回的对象表现得好像它是一个列表，但实际上它不是。 它是一个对象，当您对其进行迭代时，它会返回所需序列的连续项目，但它并没有真正生成列表，从而节省了空间。

我们说这样的对象是 iterable，也就是说，适合作为函数和构造的目标，这些函数和构造期望从中获得连续的项目，直到供应耗尽。 我们已经看到 for 语句就是这样一个 iterator。 函数 list() 是另一个； 它从可迭代对象创建列表：

>>> list(range(5))
[0, 1, 2, 3, 4]

稍后我们将看到更多返回可迭代对象并将可迭代对象作为参数的函数。

4.4. break和continue声明，以及else关于循环的条款

break 语句，就像在 C 中一样，从最内层的 for 或 while 循环中跳出。

循环语句可能有一个 else 子句； 当循环因列表耗尽（使用 for）或条件变为假（使用 while）而终止时执行，但不会在循环由 终止时执行]break 语句。 下面的循环就是一个例子，它搜索素数：

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

（是的，这是正确的代码。 仔细观察：else 子句属于 for 循环，not if 语句。）

当与循环一起使用时，else 子句与 try 语句的 else 子句的共同点多于 if 语句的共同点: try 语句的 else 子句在没有异常发生时运行，循环的 else 子句在没有 break 发生时运行。 有关 try 语句和异常的更多信息，请参阅 处理异常 。

continue 语句也是从 C 中借来的，继续循环的下一次迭代：

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

4.5. pass声明

pass 语句什么也不做。 它可以在语法上需要语句但程序不需要操作时使用。 例如：

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

这通常用于创建最小类：

>>> class MyEmptyClass:
...     pass
...

另一个可以使用 pass 的地方是在您处理新代码时作为函数或条件体的占位符，让您可以在更抽象的层次上继续思考。 pass 被默默忽略：

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

4.6. 定义函数

我们可以创建一个函数，将斐波那契数列写入任意边界：

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

关键字 def 引入了函数 definition。 它后面必须是函数名和带括号的形式参数列表。 构成函数体的语句从下一行开始，并且必须缩进。

函数体的第一条语句可以选择是字符串文字； 此字符串文字是函数的文档字符串，或 docstring。 （有关文档字符串的更多信息可以在 文档字符串 部分找到。）有一些工具可以使用文档字符串自动生成在线或打印文档，或者让用户以交互方式浏览代码； 在您编写的代码中包含文档字符串是一种很好的做法，因此请养成习惯。

函数的 execution 引入了一个用于函数局部变量的新符号表。 更准确地说，函数中的所有变量赋值都将值存储在本地符号表中； 而变量引用首先查看局部符号表，然后是封闭函数的局部符号表，然后是全局符号表，最后是内置名称表。 因此，全局变量和封闭函数的变量不能在函数内直接赋值（除非对于全局变量，在 global 语句中命名，或者对于封闭函数的变量，在 语句中命名） ]nonlocal 语句），尽管它们可能会被引用。

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

函数定义在当前符号表中引入函数名。 函数名的值具有被解释器识别为用户定义函数的类型。 该值可以分配给另一个名称，然后该名称也可以用作函数。 这是一个通用的重命名机制：

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

来自其他语言，您可能反对 fib 不是函数而是过程，因为它不返回值。 事实上，即使没有 return 语句的函数也会返回一个值，尽管它相当无聊。 该值称为 None（它是一个内置名称）。 如果写入值 None 是唯一写入的值，则它通常会被解释器抑制。 如果你真的想使用 print()，你可以看到它：

>>> fib(0)
>>> print(fib(0))
None

编写一个返回斐波那契数列数字列表的函数很简单，而不是打印它：

>>> def fib2(n):  # return Fibonacci series up to n
...     """Return a list containing the Fibonacci series up to n."""
...     result = []
...     a, b = 0, 1
...     while a < n:
...         result.append(a)    # see below
...         a, b = b, a+b
...     return result
...
>>> f100 = fib2(100)    # call it
>>> f100                # write the result
[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 是名称由对象的类型定义的方法。 不同的类型定义不同的方法。 不同类型的方法可以具有相同的名称而不会引起歧义。 （可以定义自己的对象类型和方法，使用 classes，参见 Classes）示例中的方法 append() 是为列表对象定义的； 它在列表的末尾添加一个新元素。 在本例中，它等效于 result = result + [a]，但效率更高。

4.7. 有关定义函数的更多信息

也可以定义具有可变数量参数的函数。 共有三种形式，可以组合使用。

4.7.1. 默认参数值

最有用的形式是为一个或多个参数指定默认值。 这将创建一个可以使用比定义允许的更少的参数调用的函数。 例如：

def ask_ok(prompt, retries=4, reminder='Please try again!'):
    while True:
        ok = input(prompt)
        if ok in ('y', 'ye', 'yes'):
            return True
        if ok in ('n', 'no', 'nop', 'nope'):
            return False
        retries = retries - 1
        if retries < 0:
            raise ValueError('invalid user response')
        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 关键字。 这将测试序列是否包含某个值。

默认值在 defining 作用域中的函数定义点计算，因此

i = 5

def f(arg=i):
    print(arg)

i = 6
f()

将打印 5。

重要警告： 默认值仅评估一次。 当默认值是可变对象（例如列表、字典或大多数类的实例）时，这会有所不同。 例如，以下函数在后续调用中累积传递给它的参数：

def f(a, L=[]):
    L.append(a)
    return L

print(f(1))
print(f(2))
print(f(3))

这将打印

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

如果您不希望在后续调用之间共享默认值，则可以编写如下函数：

def f(a, L=None):
    if L is None:
        L = []
    L.append(a)
    return L

4.7.2. 关键字参数

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

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

接受一个必需参数 (voltage) 和三个可选参数（state、action 和 type）。 可以通过以下任何一种方式调用此函数：

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

但以下所有调用都是无效的：

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

在函数调用中，关键字参数必须跟在位置参数之后。 传递的所有关键字参数必须与函数接受的参数之一匹配（例如 actor 不是 parrot 函数的有效参数），它们的顺序并不重要。 这也包括非可选参数（例如 parrot(voltage=1000) 也有效）。 任何参数都不能多次接收一个值。 这是一个由于此限制而失败的示例：

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

当存在形式为 **name 的最终形参时，它会收到一个字典（参见 映射类型 — dict），其中包含除与形参对应的那些关键字参数之外的所有关键字参数。 这可以与形式参数 *name（在下一小节中描述）结合，该形式参数接收包含超出形式参数列表的位置参数的 元组 。 （*name 必须出现在 **name 之前。）例如，如果我们定义这样的函数：

def cheeseshop(kind, *arguments, **keywords):
    print("-- Do you have any", kind, "?")
    print("-- I'm sorry, we're all out of", kind)
    for arg in arguments:
        print(arg)
    print("-" * 40)
    for kw in keywords:
        print(kw, ":", keywords[kw])

可以这样调用：

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

当然它会打印：

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

请注意，打印关键字参数的顺序保证与它们在函数调用中提供的顺序相匹配。

4.7.3. 任意参数列表

最后，最不常用的选项是指定可以使用任意数量的参数调用函数。 这些参数将包含在一个元组中（参见 元组和序列 ）。 在可变数量的参数之前，可能会出现零个或多个正常参数。

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

通常，这些 variadic 参数将位于形式参数列表的最后，因为它们会收集传递给函数的所有剩余输入参数。 出现在 *args 参数之后的任何形式参数都是“仅关键字”参数，这意味着它们只能用作关键字而不是位置参数。

>>> def concat(*args, sep="/"):
...     return sep.join(args)
...
>>> concat("earth", "mars", "venus")
'earth/mars/venus'
>>> concat("earth", "mars", "venus", sep=".")
'earth.mars.venus'

4.7.4. 解包参数列表

当参数已经在列表或元组中但需要为需要单独位置参数的函数调用解包时，会发生相反的情况。 例如，内置的 range() 函数需要单独的 start 和 stop 参数。 如果它们不能单独使用，请使用 * 运算符编写函数调用以从列表或元组中解压缩参数：

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

以同样的方式，字典可以使用 ** 运算符传递关键字参数：

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

4.7.5. Lambda 表达式

可以使用 lambda 关键字创建小型匿名函数。 此函数返回其两个参数的总和：lambda a, b: a+b。 Lambda 函数可用于需要函数对象的任何地方。 它们在语法上仅限于单个表达式。 从语义上讲，它们只是普通函数定义的语法糖。 与嵌套函数定义一样，lambda 函数可以从包含范围引用变量：

>>> def make_incrementor(n):
...     return lambda x: x + n
...
>>> f = make_incrementor(42)
>>> f(0)
42
>>> f(1)
43

上面的例子使用一个 lambda 表达式来返回一个函数。 另一个用途是传递一个小函数作为参数：

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

4.7.6. 文档字符串

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

第一行应始终是对象用途的简短摘要。 为简洁起见，它不应明确说明对象的名称或类型，因为它们可以通过其他方式获得（除非名称恰好是描述函数操作的动词）。 此行应以大写字母开头并以句点结尾。

如果文档字符串中有更多行，则第二行应该是空白的，从视觉上将摘要与描述的其余部分分开。 以下几行应该是描述对象的调用约定、副作用等的一个或多个段落。

Python 解析器不会从 Python 中的多行字符串文字中去除缩进，因此处理文档的工具必须根据需要去除缩进。 这是使用以下约定完成的。 字符串的第一行 之后的第一个非空行 决定了整个文档字符串的缩进量。 （我们不能使用第一行，因为它通常与字符串的开始引号相邻，因此它的缩进在字符串文字中不明显。）然后从字符串的所有行的开头去除与此缩进“等效”的空白. 缩进较少的行不应出现，但如果出现，则应去除所有前导空格。 扩展选项卡后应测试空格的等效性（通常为 8 个空格）。

这是多行文档字符串的示例：

>>> def my_function():
...     """Do nothing, but document it.
...
...     No, really, it doesn't do anything.
...     """
...     pass
...
>>> print(my_function.__doc__)
Do nothing, but document it.

    No, really, it doesn't do anything.

4.7.7. 函数注解

函数注释是关于用户定义函数使用的类型的完全可选的元数据信息（参见PEP 3107和PEP 484 了解更多信息）。

Annotations 作为字典存储在函数的 __annotations__ 属性中，对函数的任何其他部分没有影响。 参数注释由参数名称后的冒号定义，后跟计算注释值的表达式。 返回注释由文字 -> 定义，后跟表达式，位于参数列表和表示 def 语句结尾的冒号之间。 以下示例具有位置参数、关键字参数和带注释的返回值：

>>> def f(ham: str, eggs: str = 'eggs') -> str:
...     print("Annotations:", f.__annotations__)
...     print("Arguments:", ham, eggs)
...     return ham + ' and ' + eggs
...
>>> f('spam')
Annotations: {'ham': <class 'str'>, 'return': <class 'str'>, 'eggs': <class 'str'>}
Arguments: spam eggs
'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

实际上，通过对象引用调用 会是一个更好的描述，因为如果传递了一个可变对象，调用者将看到被调用者对其所做的任何更改（插入到列表中的项目）。