Документация Python неофициальный перевод
Содержание страницы

8. Составные инструкцииCompound statements

Составные инструкции содержат (группы) других инструкций; они влияют на выполнение этих других инструкций или управляют им. В общем случае составные инструкции охватывают несколько строк, хотя в простых вариантах вся составная инструкция может помещаться в одну строку.

Инструкции if, while и for реализуют традиционные конструкции управления потоком. try задаёт обработчики исключений и/или код очистки для группы инструкций, а инструкция with позволяет выполнять код инициализации и финализации вокруг блока кода. Определения функций и классов также синтаксически являются составными инструкциями.

Составная инструкция состоит из одного или нескольких «предложений». Предложение состоит из заголовка и «набора инструкций». Заголовки предложений одной составной инструкции находятся на одном уровне отступа. Каждый заголовок предложения начинается с уникального ключевого слова и завершается двоеточием. Набор инструкций – это группа инструкций, управляемая предложением. Набор инструкций может состоять из одной или нескольких простых инструкций, разделённых точкой с запятой, на той же строке, что и заголовок, после его двоеточия, или из одной или нескольких инструкций с отступом на последующих строках. Только вторая форма набора инструкций может содержать вложенные составные инструкции; следующий пример недопустим, в основном потому, что было бы непонятно, к какому предложению if будет относиться последующее предложение else:

if test1: if test2: print(x)

Также обратите внимание, что точка с запятой связывает сильнее, чем двоеточие в этом контексте, так что в следующем примере выполняются либо все вызовы print(), либо ни один:

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)* [";"]

Обратите внимание, что инструкции всегда заканчиваются NEWLINE, за которым может следовать DEDENT. Также обратите внимание, что опциональные продолжения всегда начинаются с ключевого слова, которое не может начинать инструкцию, поэтому неоднозначностей нет (проблема «висячего else» решается в Python требованием, чтобы вложенные инструкции if имели отступ).

Форматирование грамматических правил в следующих разделах помещает каждое предложение на отдельную строку для ясности.

8.1. Инструкция ifThe if statement

Инструкция if используется для условного выполнения:

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

Он выбирает ровно один из наборов инструкций, вычисляя выражения одно за другим, пока одно из них не окажется истинным (см. раздел Булевы операции для определения истины и лжи); затем этот набор выполняется (и никакая другая часть инструкции if не выполняется и не вычисляется). Если все выражения ложны, выполняется набор инструкций предложения else, если оно присутствует.

8.2. Инструкция whileThe while statement

Инструкция while используется для повторного выполнения, пока выражение истинно:

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

Эта инструкция многократно проверяет выражение и, если оно истинно, выполняет первый набор инструкций; если выражение ложно (возможно, при первой проверке), то набор инструкций предложения else, если оно присутствует, выполняется, и цикл завершается.

Инструкция break, выполненная в первом наборе, завершает цикл, не выполняя набор инструкций предложения else. Инструкция continue, выполненная в первом наборе, пропускает оставшуюся часть набора и возвращается к проверке выражения.

8.3. Инструкция forThe for statement

Инструкция for используется для перебора элементов последовательности (например, строки, кортежа или списка) или другого итерируемого объекта:

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

Список выражений вычисляется один раз; он должен давать итерируемый объект. Итератор создаётся для результата expression_list. Затем блок инструкций выполняется один раз для каждого элемента, предоставленного итератором, в порядке, возвращаемом итератором. Каждый элемент последовательно присваивается целевому списку по стандартным правилам присваивания (см. Инструкции присваивания), после чего выполняется блок. Когда элементы исчерпаны (что происходит сразу, когда последовательность пуста или итератор возбуждает исключение StopIteration), выполняется блок в предложении else, если оно присутствует, и цикл завершается.

Инструкция break, выполненная в первом наборе, завершает цикл, не выполняя набор инструкций предложения else. Инструкция continue, выполненная в первом наборе, пропускает оставшуюся часть набора и продолжает со следующим элементом, или с предложением else, если следующего элемента нет.

Цикл for выполняет присваивания переменным в целевом списке. Это перезаписывает все предыдущие присваивания этим переменным, включая те, что были сделаны в наборе инструкций цикла for:

for i in range(10):
    print(i)
    i = 5             # это не повлияет на цикл for
                      # потому что i будет перезаписано следующим
                      # индексом в range

Имена в списке целей не удаляются по завершении цикла, но если последовательность пуста, они вообще не будут присвоены циклом. Подсказка: встроенная функция range() возвращает итератор целых чисел, подходящий для имитации эффекта for i := a to b do в Pascal; например, list(range(3)) возвращает список [0, 1, 2].

Примечание

Существует тонкость, когда последовательность изменяется циклом (это возможно только для изменяемых последовательностей, например списков). Внутренний счётчик используется для отслеживания того, какой элемент будет обработан следующим, и он увеличивается на каждой итерации. Когда этот счётчик достигает длины последовательности, цикл завершается. Это означает, что если блок удаляет текущий (или предыдущий) элемент из последовательности, следующий элемент будет пропущен (поскольку он получает индекс текущего элемента, который уже был обработан). Аналогично, если блок вставляет элемент в последовательность перед текущим, текущий элемент будет обработан снова при следующем проходе цикла. Это может привести к неприятным ошибкам, которых можно избежать, создав временную копию с помощью среза всей последовательности, например,

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

8.4. Инструкция tryThe try statement

Инструкция 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

Блок(и) except задают один или несколько обработчиков исключений. Если в блоке try не возникло исключения, обработчик исключения не выполняется. Когда в блоке try происходит исключение, начинается поиск обработчика исключения. Этот поиск последовательно проверяет блоки except, пока не будет найден подходящий для данного исключения. Блок except без выражения, если он присутствует, должен быть последним; он подходит для любого исключения. Для блока except с выражением это выражение вычисляется, и блок подходит для исключения, если полученный объект «совместим» с исключением. Объект совместим с исключением, если он является классом или базовым классом объекта исключения, или кортежем, содержащим элемент, который является классом или базовым классом объекта исключения.

Если ни одно предложение except не соответствует исключению, поиск обработчика исключений продолжается в окружающем коде и в стеке вызовов. 1

Если вычисление выражения в заголовке предложения except вызывает исключение, исходный поиск обработчика отменяется, и начинается поиск нового исключения в окружающем коде и в стеке вызовов (считается, что исключение вызвано всей инструкцией try).

Когда найдено подходящее предложение except, исключение присваивается цели, указанной после ключевого слова as в этом предложении except (если оно есть), и выполняется блок предложения except. Все предложения except должны иметь исполняемый блок. Когда конец этого блока достигнут, выполнение продолжается обычным образом после всей инструкции try. (Это означает, что если существуют два вложенных обработчика для одного и того же исключения, и исключение возникает в блоке try внутреннего обработчика, внешний обработчик не будет обрабатывать исключение.)

Когда исключение было присвоено с помощью as target, оно очищается в конце предложения except. Это равносильно тому, как если бы

except E as N:
    foo

было преобразовано в

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

Это означает, что исключение должно быть присвоено другому имени, чтобы на него можно было ссылаться после предложения except. Исключения очищаются, потому что с прикреплённой к ним трассировкой они образуют циклическую ссылку с кадром стека, удерживая все локальные переменные в этом кадре живыми до следующей сборки мусора.

Перед выполнением блока except-предложения подробности об исключении сохраняются в модуле sys и могут быть получены через sys.exc_info(). sys.exc_info() возвращает кортеж из трёх элементов: класс исключения, экземпляр исключения и объект трассировки (см. раздел Стандартная иерархия типов), указывающий точку программы, где произошло исключение. Значения sys.exc_info() восстанавливаются до предыдущих (до вызова) при возврате из функции, обработавшей исключение.

Необязательное предложение else выполняется, если поток управления покидает блок try, не было вызвано исключение и не выполнялся оператор return, continue или break. Исключения в предложении else не обрабатываются предшествующими предложениями except.

Если присутствует finally, он задаёт обработчик «очистки». Выполняется раздел try, включая любые разделы except и else. Если в каком-либо из разделов возникает исключение и оно не обработано, исключение временно сохраняется. Затем выполняется раздел finally. Если есть сохранённое исключение, оно повторно возбуждается в конце раздела finally. Если раздел finally возбуждает другое исключение, сохранённое исключение устанавливается как контекст нового исключения. Если раздел finally выполняет оператор return, break или continue, сохранённое исключение отбрасывается:

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

Информация об исключении недоступна программе во время выполнения предложения finally.

Когда оператор return, break или continue выполняется в блоке try оператора tryfinally, предложение finally также выполняется «на выходе».

Возвращаемое значение функции определяется последней выполненной инструкцией return. Поскольку предложение finally выполняется всегда, инструкция return, выполненная в предложении finally, всегда будет последней выполненной:

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

Дополнительную информацию об исключениях можно найти в разделе Исключения, а информация об использовании инструкции raise для генерации исключений приведена в разделе Инструкция raise.

Изменено в версии 3.8: До Python 3.8 оператор continue был недопустим в предложении finally из-за проблемы в реализации.

8.5. Инструкция withThe with statement

Оператор with используется для обёртывания выполнения блока методами, определёнными контекстным менеджером (см. раздел Контекстные менеджеры оператора with). Это позволяет инкапсулировать типичные шаблоны использования tryexceptfinally для удобного повторного использования.

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

Выполнение оператора with с одним «элементом» происходит следующим образом:

  1. Контекстное выражение (выражение, указанное в with_item) вычисляется для получения менеджера контекста.

  2. Метод __enter__() контекстного менеджера загружается для последующего использования.

  3. Метод __exit__() контекстного менеджера загружается для последующего использования.

  4. Метод __enter__() контекстного менеджера вызывается.

  5. Если в операторе with была указана цель, возвращаемое значение из __enter__() присваивается ей.

    Примечание

    Инструкция with гарантирует, что если метод __enter__() завершится без ошибки, то __exit__() будет вызван обязательно. Таким образом, если во время присваивания списку целей произойдет ошибка, она будет обработана так же, как ошибка, возникшая внутри блока. См. шаг 6 ниже.

  6. Выполняется блок.

  7. Вызывается метод __exit__() менеджера контекста. Если исключение вызвало выход из блока, его тип, значение и traceback передаются в качестве аргументов __exit__(). В противном случае передаются три аргумента None.

    Если блок был завершён из-за исключения и возвращаемое значение метода __exit__() было ложным, исключение возбуждается повторно. Если возвращаемое значение было истинным, исключение подавляется, и выполнение продолжается с оператора, следующего за оператором with.

    Если блок был завершён по любой причине, кроме исключения, возвращаемое значение __exit__() игнорируется, и выполнение продолжается в обычном месте для данного типа завершения.

Следующий код:

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 были вложены:

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

семантически эквивалентен следующему:

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

Изменено в версии 3.1: Поддержка нескольких выражений контекста.

См. также

PEP 343 – Оператор «with»

Спецификация, предыстория и примеры для инструкции with в Python.

8.6. Определения функцийFunction definitions

Определение функции создаёт объект пользовательской функции (см. раздел Стандартная иерархия типов):

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.

Когда один или несколько параметров имеют вид параметр = выражение, говорят, что функция имеет «значения параметров по умолчанию». Для параметра со значением по умолчанию соответствующий аргумент может быть опущен при вызове, и в этом случае подставляется значение параметра по умолчанию. Если параметр имеет значение по умолчанию, все последующие параметры до «*» также должны иметь значение по умолчанию – это синтаксическое ограничение, которое не отражено в грамматике.

Значения параметров по умолчанию вычисляются слева направо при выполнении определения функции. Это означает, что выражение вычисляется один раз, когда функция определяется, и одно и то же «предвычисленное» значение используется для каждого вызова. Это особенно важно понимать, когда параметр по умолчанию является изменяемым объектом, например списком или словарём: если функция изменяет объект (например, добавляет элемент в список), значение по умолчанию фактически изменяется. Обычно это не то, что предполагалось. Обойти это можно, используя None в качестве значения по умолчанию и явно проверяя его в теле функции, например:

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

Семантика вызова функций подробно описана в разделе Calls. Вызов функции всегда присваивает значения всем параметрам, указанным в списке параметров, либо из позиционных аргументов, либо из именованных аргументов, либо из значений по умолчанию. Если присутствует форма «*identifier», она инициализируется кортежем, принимающим все лишние позиционные параметры, по умолчанию пустой кортеж. Если присутствует форма «**identifier», она инициализируется новым упорядоченным отображением, принимающим все лишние именованные аргументы, по умолчанию новым пустым отображением того же типа. Параметры после «*» или «*identifier» являются параметрами только для ключевых слов и могут передаваться только именованными аргументами. Параметры до «/» являются параметрами только для позиции и могут передаваться только позиционными аргументами.

Изменено в версии 3.8: Синтаксис параметра функции / может использоваться для обозначения позиционных параметров. Подробнее см. PEP 570.

Параметры могут иметь аннотацию вида «: expression» после имени параметра. Любой параметр может иметь аннотацию, даже параметры вида *identifier или **identifier. Функции могут иметь аннотацию возврата вида «-> expression» после списка параметров. Эти аннотации могут быть любым допустимым выражением Python. Наличие аннотаций не меняет семантику функции. Значения аннотаций доступны как значения словаря, ключами которого являются имена параметров, в атрибуте __annotations__ объекта функции. Если используется импорт annotations из __future__, аннотации сохраняются в виде строк во время выполнения, что позволяет отложить их вычисление. В противном случае они вычисляются при выполнении определения функции. В этом случае аннотации могут вычисляться в порядке, отличном от порядка их появления в исходном коде.

Также можно создавать анонимные функции (функции, не привязанные к имени) для немедленного использования в выражениях. Для этого используются лямбда-выражения, описанные в разделе Lambdas. Обратите внимание, что лямбда-выражение – это всего лишь сокращение для упрощённого определения функции; функцию, определённую в инструкции «def», можно передавать или присваивать другому имени так же, как функцию, определённую лямбда-выражением. Форма «def» на самом деле более мощная, поскольку позволяет выполнять несколько инструкций и аннотаций.

Замечание программисту: Функции – объекты первого класса. Инструкция «def», выполненная внутри определения функции, определяет локальную функцию, которую можно вернуть или передать. Свободные переменные, используемые во вложенной функции, могут обращаться к локальным переменным функции, содержащей def. Подробнее см. раздел Naming and binding.

См. также

PEP 3107 – Аннотации функций

Оригинальная спецификация аннотаций функций.

PEP 484 – Аннотации типов

Определение стандартного значения аннотаций: подсказки типов.

PEP 526 - Синтаксис аннотаций переменных

Возможность аннотировать типы объявлений переменных, включая переменные класса и переменные экземпляра

PEP 563 – Отложенное вычисление аннотаций

Поддержка прямых ссылок в аннотациях путём сохранения аннотаций в строковом виде во время выполнения вместо немедленного вычисления.

8.7. Определения классовClass definitions

Определение класса создаёт объект класса (см. раздел Стандартная иерархия типов):

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

Определение класса – это исполняемая инструкция. Список наследования обычно содержит список базовых классов (см. Метаклассы для более продвинутого использования), поэтому каждый элемент списка должен вычисляться в объект класса, который допускает создание подклассов. Классы без списка наследования по умолчанию наследуют от базового класса object; следовательно,

class Foo:
    pass

эквивалентна

class Foo(object):
    pass

Затем тело класса выполняется в новом фрейме выполнения (см. Naming and binding), используя только что созданное локальное пространство имён и исходное глобальное пространство имён. (Обычно тело содержит в основном определения функций.) Когда выполнение тела класса завершается, его фрейм выполнения отбрасывается, но локальное пространство имён сохраняется. 3 Затем создаётся объект класса с использованием списка наследования для базовых классов и сохранённого локального пространства имён для словаря атрибутов. Имя класса привязывается к этому объекту класса в исходном локальном пространстве имён.

Порядок, в котором атрибуты определяются в теле класса, сохраняется в __dict__ нового класса. Обратите внимание, что это надёжно только сразу после создания класса и только для классов, определённых с использованием синтаксиса определения.

Создание класса можно сильно настраивать с помощью метаклассов.

Классы также могут быть декорированы: так же, как и при декорировании функций,

@f1(arg)
@f2
class Foo: pass

примерно эквивалентно

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

Правила вычисления выражений декораторов такие же, как и для декораторов функций. Затем результат привязывается к имени класса.

Замечание для программиста: Переменные, определённые в определении класса, являются атрибутами класса; они разделяются экземплярами. Атрибуты экземпляра можно задать в методе с помощью self.name = value. Как атрибуты класса, так и атрибуты экземпляра доступны через запись “self.name”, и при таком обращении атрибут экземпляра скрывает атрибут класса с тем же именем. Атрибуты класса могут использоваться как значения по умолчанию для атрибутов экземпляра, но использование изменяемых значений может привести к неожиданным результатам. Дескрипторы можно использовать для создания переменных экземпляра с другими деталями реализации.

См. также

PEP 3115 – Метаклассы в Python 3000

Предложение, изменившее объявление метаклассов на текущий синтаксис, и семантику того, как конструируются классы с метаклассами.

PEP 3129 - Декораторы классов

Предложение, добавившее декораторы классов. Декораторы функций и методов были введены в PEP 318.

8.8. КорутиныCoroutines

Новое в версии 3.5.

8.8.1. Определение корутинной функцииCoroutine function definition

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

Выполнение корутин Python может приостанавливаться и возобновляться во многих точках (см. корутина). Внутри тела корутинной функции идентификаторы await и async становятся зарезервированными ключевыми словами; выражения await, async for и async with могут использоваться только в телах корутинных функций.

Функции, определённые с синтаксисом async def, всегда являются корутинными функциями, даже если они не содержат ключевых слов await или async.

Использование выражения yield from в теле корутинной функции является SyntaxError.

Пример корутинной функции:

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

8.8.2. Инструкция async forThe async for statement

async_for_stmt ::=  "async" for_stmt

Асинхронный итерируемый объект способен вызывать асинхронный код в своей реализации iter, а асинхронный итератор может вызывать асинхронный код в своём методе next.

Оператор 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__() и __anext__() для подробностей.

Использование инструкции async for вне тела корутинной функции является SyntaxError.

8.8.3. Инструкция async withThe async with statement

async_with_stmt ::=  "async" with_stmt

Асинхронный менеджер контекста – это менеджер контекста, который может приостанавливать выполнение в своих методах входа и выхода.

Следующий код:

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__() и __aexit__() для подробностей.

Использование инструкции async with вне тела корутинной функции является SyntaxError.

См. также

PEP 492 - Корутины с синтаксисом async и await

Предложение, которое сделало корутины полноценной самостоятельной концепцией в Python и добавило поддерживающий синтаксис.

Сноски

1

Исключение распространяется по стеку вызовов, если только не встретится предложение finally, которое в свою очередь возбуждает другое исключение. Это новое исключение приводит к потере старого.

2

Строковый литерал, появляющийся как первая инструкция в теле функции, преобразуется в атрибут __doc__ функции и, следовательно, в докстринг функции.

3

Строковый литерал, появляющийся в качестве первого оператора в теле класса, преобразуется в элемент __doc__ пространства имён и, следовательно, в докстринг класса.