8. 复合语句

复合语句包含 (分组) 其它语句;它们以某种方式影响 (或控制) 其它语句的执行。一般而言,复合语句跨多行,尽管简单化身可以将整个复合语句包含在一行中。

The if , while and for statements implement traditional control flow constructs. try specifies exception handlers and/or cleanup code for a group of statements, while the with statement allows the execution of initialization and finalization code around a block of code. Function and class definitions are also syntactically compound statements.

A compound statement consists of one or more ‘clauses.’ A clause consists of a header and a ‘suite.’ The clause headers of a particular compound statement are all at the same indentation level. Each clause header begins with a uniquely identifying keyword and ends with a colon. A suite is a group of statements controlled by a clause. A suite can be one or more semicolon-separated simple statements on the same line as the header, following the header’s colon, or it can be one or more indented statements on subsequent lines. Only the latter form of a suite can contain nested compound statements; the following is illegal, mostly because it wouldn’t be clear to which if clause a following else clause would belong:

if test1: if test2: print(x)
					

Also note that the semicolon binds tighter than the colon in this context, so that in the following example, either all or none of the print() calls are executed:

if x < y < z: print(x); print(y); print(z)
					

汇总:

compound_stmt ::=  if_stmt
                   | while_stmt
                   | for_stmt
                   | try_stmt
                   | with_stmt
                   | funcdef
                   | classdef
                   | async_with_stmt
                   | async_for_stmt
                   | async_funcdef
suite         ::=  stmt_list NEWLINE | NEWLINE INDENT statement+ DEDENT
statement     ::=  stmt_list NEWLINE | compound_stmt
stmt_list     ::=  simple_stmt (";" simple_stmt)* [";"]
					

Note that statements always end in a NEWLINE possibly followed by a DEDENT . Also note that optional continuation clauses always begin with a keyword that cannot start a statement, thus there are no ambiguities (the ‘dangling else ’ problem is solved in Python by requiring nested if statements to be indented).

The formatting of the grammar rules in the following sections places each clause on a separate line for clarity.

8.1. The if 语句

The if 语句用于条件执行:

if_stmt ::=  "if" assignment_expression ":" suite
             ("elif" assignment_expression ":" suite)*
             ["else" ":" suite]
					

It selects exactly one of the suites by evaluating the expressions one by one until one is found to be true (see section 布尔运算 for the definition of true and false); then that suite is executed (and no other part of the if statement is executed or evaluated). If all expressions are false, the suite of the else clause, if present, is executed.

8.2. The while 语句

The while 语句用于重复执行只要表达式为 True:

while_stmt ::=  "while" assignment_expression ":" suite
                ["else" ":" suite]
					

这将反复测试表达式,若为 True,执行第一套件;若表达式为 False (可能是首次测试),执行套件 else 子句,若它存在,执行并循环终止。

A break 语句在第一套件中执行将终止循环而不执行 else 子句套件。 continue 语句在第一套件中执行将跳过套件的其余部分并回到测试表达式。

8.3. The for 语句

The for statement is used to iterate over the elements of a sequence (such as a string, tuple or list) or other iterable object:

for_stmt ::=  "for" target_list "in" expression_list ":" suite
              ["else" ":" suite]
					

The expression list is evaluated once; it should yield an iterable object. An iterator is created for the result of the expression_list . The suite is then executed once for each item provided by the iterator, in the order returned by the iterator. Each item in turn is assigned to the target list using the standard rules for assignments (see 赋值语句 ), and then the suite is executed. When the items are exhausted (which is immediately when the sequence is empty or an iterator raises a StopIteration exception), the suite in the else clause, if present, is executed, and the loop terminates.

A break 语句在第一套件中执行将终止循环而不执行 else 子句套件。 continue statement executed in the first suite skips the rest of the suite and continues with the next item, or with the else clause if there is no next item.

The for-loop makes assignments to the variables in the target list. This overwrites all previous assignments to those variables including those made in the suite of the for-loop:

for i in range(10):
    print(i)
    i = 5             # this will not affect the for-loop
                      # because i will be overwritten with the next
                      # index in the range
					

Names in the target list are not deleted when the loop is finished, but if the sequence is empty, they will not have been assigned to at all by the loop. Hint: the built-in function range() returns an iterator of integers suitable to emulate the effect of Pascal’s for i := a to b do ; e.g., list(range(3)) returns the list [0, 1, 2] .

注意

There is a subtlety when the sequence is being modified by the loop (this can only occur for mutable sequences, e.g. lists). An internal counter is used to keep track of which item is used next, and this is incremented on each iteration. When this counter has reached the length of the sequence the loop terminates. This means that if the suite deletes the current (or a previous) item from the sequence, the next item will be skipped (since it gets the index of the current item which has already been treated). Likewise, if the suite inserts an item in the sequence before the current item, the current item will be treated again the next time through the loop. This can lead to nasty bugs that can be avoided by making a temporary copy using a slice of the whole sequence, e.g.,

for x in a[:]:
    if x < 0: a.remove(x)
			
			
					

8.4. The try 语句

The try 语句为一组语句指定异常处理程序和/或清理代码:

try_stmt  ::=  try1_stmt | try2_stmt
try1_stmt ::=  "try" ":" suite
               ("except" [expression ["as" identifier]] ":" suite)+
               ["else" ":" suite]
               ["finally" ":" suite]
try2_stmt ::=  "try" ":" suite
               "finally" ":" suite
					

The except clause(s) specify one or more exception handlers. When no exception occurs in the try clause, no exception handler is executed. When an exception occurs in the try suite, a search for an exception handler is started. This search inspects the except clauses in turn until one is found that matches the exception. An expression-less except clause, if present, must be last; it matches any exception. For an except clause with an expression, that expression is evaluated, and the clause matches the exception if the resulting object is “compatible” with the exception. An object is compatible with an exception if it is the class or a base class of the exception object, or a tuple containing an item that is the class or a base class of the exception object.

If no except clause matches the exception, the search for an exception handler continues in the surrounding code and on the invocation stack. 1

If the evaluation of an expression in the header of an except clause raises an exception, the original search for a handler is canceled and a search starts for the new exception in the surrounding code and on the call stack (it is treated as if the entire try statement raised the exception).

When a matching except clause is found, the exception is assigned to the target specified after the as keyword in that except clause, if present, and the except clause’s suite is executed. All except clauses must have an executable block. When the end of this block is reached, execution continues normally after the entire try statement. (This means that if two nested handlers exist for the same exception, and the exception occurs in the try clause of the inner handler, the outer handler will not handle the exception.)

When an exception has been assigned using as target , it is cleared at the end of the except clause. This is as if

except E as N:
    foo
					

was translated to

except E as N:
    try:
        foo
    finally:
        del N
					

This means the exception must be assigned to a different name to be able to refer to it after the except clause. Exceptions are cleared because with the traceback attached to them, they form a reference cycle with the stack frame, keeping all locals in that frame alive until the next garbage collection occurs.

Before an except clause’s suite is executed, details about the exception are stored in the sys module and can be accessed via sys.exc_info() . sys.exc_info() returns a 3-tuple consisting of the exception class, the exception instance and a traceback object (see section 标准类型层次结构 ) identifying the point in the program where the exception occurred. sys.exc_info() values are restored to their previous values (before the call) when returning from a function that handled an exception.

可选 else 子句会被执行,若控制流离开 try suite, no exception was raised, and no return , continue ,或 break statement was executed. Exceptions in the else clause are not handled by the preceding except clauses.

finally is present, it specifies a ‘cleanup’ handler. The try clause is executed, including any except and else clauses. If an exception occurs in any of the clauses and is not handled, the exception is temporarily saved. The finally clause is executed. If there is a saved exception it is re-raised at the end of the finally clause. If the finally clause raises another exception, the saved exception is set as the context of the new exception. If the finally 子句执行 return , break or continue statement, the saved exception is discarded:

>>> def f():
...     try:
...         1/0
...     finally:
...         return 42
...
>>> f()
42
					

The exception information is not available to the program during execution of the finally 子句。

return , break or continue statement is executed in the try suite of a try finally statement, the finally clause is also executed ‘on the way out.’

The return value of a function is determined by the last return statement executed. Since the finally clause always executes, a return statement executed in the finally clause will always be the last one executed:

>>> def foo():
...     try:
...         return 'try'
...     finally:
...         return 'finally'
...
>>> foo()
'finally'
					

可以找到有关异常的额外信息在章节 异常 , and information on using the raise statement to generate exceptions may be found in section raise 语句 .

3.8 版改变: Prior to Python 3.8, a continue statement was illegal in the finally clause due to a problem with the implementation.

8.5. The with 语句

The with statement is used to wrap the execution of a block with methods defined by a context manager (see section with 语句上下文管理器 )。这允许常见 try except finally usage patterns to be encapsulated for convenient reuse.

with_stmt ::=  "with" with_item ("," with_item)* ":" suite
with_item ::=  expression ["as" target]
					

The execution of the with statement with one “item” proceeds as follows:

  1. The context expression (the expression given in the with_item ) is evaluated to obtain a context manager.

  2. The context manager’s __enter__() is loaded for later use.

  3. The context manager’s __exit__() is loaded for later use.

  4. The context manager’s __enter__() method is invoked.

  5. If a target was included in the with statement, the return value from __enter__() is assigned to it.

    注意

    The with statement guarantees that if the __enter__() method returns without an error, then __exit__() will always be called. Thus, if an error occurs during the assignment to the target list, it will be treated the same as an error occurring within the suite would be. See step 6 below.

  6. The suite is executed.

  7. The context manager’s __exit__() method is invoked. If an exception caused the suite to be exited, its type, value, and traceback are passed as arguments to __exit__() . Otherwise, three None arguments are supplied.

    If the suite was exited due to an exception, and the return value from the __exit__() method was false, the exception is reraised. If the return value was true, the exception is suppressed, and execution continues with the statement following the with 语句。

    If the suite was exited for any reason other than an exception, the return value from __exit__() is ignored, and execution proceeds at the normal location for the kind of exit that was taken.

以下代码:

with EXPRESSION as TARGET:
    SUITE
					

语义上相当于:

manager = (EXPRESSION)
enter = type(manager).__enter__
exit = type(manager).__exit__
value = enter(manager)
hit_except = False
try:
    TARGET = value
    SUITE
except:
    hit_except = True
    if not exit(manager, *sys.exc_info()):
        raise
finally:
    if not hit_except:
        exit(manager, None, None, None)
					

With more than one item, the context managers are processed as if multiple with statements were nested:

with A() as a, B() as b:
    SUITE
					

语义上相当于:

with A() as a:
    with B() as b:
        SUITE
					

3.1 版改变: 支持多上下文表达式。

另请参阅

PEP 343 - with 语句

规范、背景及范例为 Python with 语句。

8.6. 函数定义

函数定义定义用户定义的函数对象 (见章节 标准类型层次结构 ):

funcdef                   ::=  [decorators] "def" funcname "(" [parameter_list] ")"
                               ["->" expression] ":" suite
decorators                ::=  decorator+
decorator                 ::=  "@" dotted_name ["(" [argument_list [","]] ")"] NEWLINE
dotted_name               ::=  identifier ("." identifier)*
parameter_list            ::=  defparameter ("," defparameter)* "," "/" ["," [parameter_list_no_posonly]]
                                 | parameter_list_no_posonly
parameter_list_no_posonly ::=  defparameter ("," defparameter)* ["," [parameter_list_starargs]]
                               | parameter_list_starargs
parameter_list_starargs   ::=  "*" [parameter] ("," defparameter)* ["," ["**" parameter [","]]]
                               | "**" parameter [","]
parameter                 ::=  identifier [":" expression]
defparameter              ::=  parameter ["=" expression]
funcname                  ::=  identifier
						

函数定义是可执行语句。它的执行是把当前本地名称空间中的函数名称绑定到函数对象 (围绕函数可执行代码的包裹器)。此函数对象包含当前全局名称空间 (作为要使用的全局名称空间) 的引用,当函数被调用时。

函数定义不执行函数本体;这才获得执行,当函数被调用时。 2

函数定义可以被包裹通过一个或多个 装饰器 表达式。评估装饰器表达式当定义函数时,在包含函数定义的作用域内。结果必须是可调用,它以函数对象作为唯一自变量被援引。返回值被绑定到函数名称,而不是函数对象。多个装饰器按嵌套方式应用。例如,以下代码

@f1(arg)
@f2
def func(): pass
						

大致相当于

def func(): pass
func = f1(arg)(f2(func))
						

除了原始函数不被临时绑定到名称 func .

当一个或多个 参数 拥有形式 参数 = 表达式 ,函数被称为拥有 "默认参数值"。对于具有默认值的参数,相应 argument 可以从调用省略,在这种情况下,参数的默认值被代入。若参数拥有默认值,所有之后参数直到 * 还必须拥有默认值 — 这是语法未表达的句法限定。

会从左到右评估默认参数值,当执行函数定义时。 这意味着表达式仅评估一次,当定义函数时,且每次调用都使用相同 "预计算" 值。这对理解当默认参数为可变对象 (譬如:列表或字典) 尤其重要:若函数修改对象 (如:把项追加到列表),则默认值被实际修改。一般来说,这不在计划内。解决这的办法是使用 None 作为默认值,并在函数本体中明确测试它,如:

def whats_on_the_telly(penguin=None):
    if penguin is None:
        penguin = []
    penguin.append("property of the zoo")
    return penguin
						

函数调用语义的更详细描述在章节 调用 。函数调用始终将值赋值给参数列表中提及的所有参数,从位置自变量、从关键词自变量或从默认值。若形式 *identifier 存在,它被初始化成接收任何多余位置参数的元组,默认为空元组。若形式 **identifier 存在,它被初始化成接收任何多余关键词自变量的新有序映射,默认为相同类型的新的空映射。参数后于 * *identifier 为仅关键词参数且只可以传递关键词自变量。参数前于 / 为仅位置参数且只可以传递位置自变量。

3.8 版改变: The / 函数参数句法可以用于指示仅位置参数。见 PEP 570 了解细节。

参数可以拥有 annotation 形式 : expression 紧跟参数名。任何参数都可以拥有注释,即使是这些形式 *identifier or **identifier 。函数可以拥有 return 注解形式 -> expression 在参数列表后。这些注解可以是任何有效 Python 表达式。存在的注解不会改变函数的语义。注解值可用作字典键值通过参数名称在 __annotations__ 属性对于函数对象。若 annotations 导入自 __future__ 的使用,注解在运行时被预留作为字符串启用延期评估。否则,当执行函数定义时会评估它们。在这种情况下,注解的评估可能异于它们在源代码中的出现次序。

创建立即用于表达式的匿名函数 (不绑定到名称的函数) 也是可能的。这使用 Lambda 表达式,描述在章节 Lambda 。注意,Lambda 表达式仅仅是简化函数定义的简写;函数的定义在 def 语句可以传递或赋值另一名称,就像通过 Lambda 表达式定义的函数。 def 形式实际上更强大,由于它允许执行多条语句和注解。

程序员注意: 函数是首类对象。 def 语句在可以返回或传递局部函数的函数定义中执行。在嵌套函数中使用的自由变量,可以访问包含 def 的函数的局部变量。见章节 命名和绑定 了解细节。

另请参阅

PEP 3107 - 函数注解

函数注解的原始规范。

PEP 484 - 类型提示

标准注解含义的定义:类型提示。

PEP 526 - 变量注解句法

类型提示变量声明的能力,包括类变量和实例变量

PEP 563 - 注解延期评估

支持在注解中向前引用,通过在运行时以字符串形式保留注解而不是渴望评估。

8.7. 类定义

类定义定义类对象 (见章节 标准类型层次结构 ):

classdef    ::=  [decorators] "class" classname [inheritance] ":" suite
inheritance ::=  "(" [argument_list] ")"
classname   ::=  identifier
						

A class definition is an executable statement. The inheritance list usually gives a list of base classes (see 元类 for more advanced uses), so each item in the list should evaluate to a class object which allows subclassing. Classes without an inheritance list inherit, by default, from the base class object ; hence,

class Foo:
    pass
						

相当于

class Foo(object):
    pass
						

The class’s suite is then executed in a new execution frame (see 命名和绑定 ), using a newly created local namespace and the original global namespace. (Usually, the suite contains mostly function definitions.) When the class’s suite finishes execution, its execution frame is discarded but its local namespace is saved. 3 A class object is then created using the inheritance list for the base classes and the saved local namespace for the attribute dictionary. The class name is bound to this class object in the original local namespace.

The order in which attributes are defined in the class body is preserved in the new class’s __dict__ . Note that this is reliable only right after the class is created and only for classes that were defined using the definition syntax.

Class creation can be customized heavily using metaclasses .

Classes can also be decorated: just like when decorating functions,

@f1(arg)
@f2
class Foo: pass
						

大致相当于

class Foo: pass
Foo = f1(arg)(f2(Foo))
						

The evaluation rules for the decorator expressions are the same as for function decorators. The result is then bound to the class name.

程序员注意: Variables defined in the class definition are class attributes; they are shared by instances. Instance attributes can be set in a method with self.name = value . Both class and instance attributes are accessible through the notation “ self.name ”, and an instance attribute hides a class attribute with the same name when accessed in this way. Class attributes can be used as defaults for instance attributes, but using mutable values there can lead to unexpected results. Descriptors can be used to create instance variables with different implementation details.

另请参阅

PEP 3115 - Python 3000 的元类

The proposal that changed the declaration of metaclasses to the current syntax, and the semantics for how classes with metaclasses are constructed.

PEP 3129 - 类装饰器

The proposal that added class decorators. Function and method decorators were introduced in PEP 318 .

8.8. 协程

3.5 版新增。

8.8.1. 协程函数定义

async_funcdef ::=  [decorators] "async" "def" funcname "(" [parameter_list] ")"
                   ["->" expression] ":" suite
						

可以在许多点挂起和再继续 Python 协程的执行 (见 协程 )。在协程函数本体内, await and async 标识符变为预留关键词; await 表达式, async for and async with 只可用于协程函数本体中。

函数定义采用 async def 句法始终是协程函数,即使它们不包含 await or async 关键词。

它是 SyntaxError 要使用 yield from 表达式在协程函数本体内。

协程函数范例:

async def func(param1, param2):
    do_stuff()
    await some_coroutine()
						

8.8.2. The async for 语句

async_for_stmt ::=  "async" for_stmt
						

An 异步可迭代 能够调用异步代码在其 iter 实现,和 异步迭代器 可以调用异步代码在其 next 方法。

The async for 语句允许方便迭代异步迭代器。

以下代码:

async for TARGET in ITER:
    SUITE
else:
    SUITE2
						

语义上相当于:

iter = (ITER)
iter = type(iter).__aiter__(iter)
running = True
while running:
    try:
        TARGET = await type(iter).__anext__(iter)
    except StopAsyncIteration:
        running = False
    else:
        SUITE
else:
    SUITE2
						

另请参阅 __aiter__() and __anext__() 了解细节。

它是 SyntaxError 要使用 async for 语句在协程函数本体外。

8.8.3. The async with 语句

async_with_stmt ::=  "async" with_stmt
						

An 异步上下文管理器 上下文管理器 能挂起执行在其 enter and exit 方法。

以下代码:

async with EXPRESSION as TARGET:
    SUITE
						

语义上相当于:

manager = (EXPRESSION)
aexit = type(manager).__aexit__
aenter = type(manager).__aenter__
value = await aenter(manager)
hit_except = False
try:
    TARGET = value
    SUITE
except:
    hit_except = True
    if not await aexit(manager, *sys.exc_info()):
        raise
finally:
    if not hit_except:
        await aexit(manager, None, None, None)
						

另请参阅 __aenter__() and __aexit__() 了解细节。

它是 SyntaxError 要使用 async with 语句在协程函数本体外。

另请参阅

PEP 492 具有 async 和 await 句法的协程

使协程成为 Python 中的适当独立概念,并添加了支持句法的提案。

脚注

1

The exception is propagated to the invocation stack unless there is a finally clause which happens to raise another exception. That new exception causes the old one to be lost.

2

A string literal appearing as the first statement in the function body is transformed into the function’s __doc__ attribute and therefore the function’s docstring .

3

A string literal appearing as the first statement in the class body is transformed into the namespace’s __doc__ item and therefore the class’s docstring .