asyncio-future.md

1> **Источник:** https://python-all.ru/3.7/library/asyncio-future.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# Future89*Future*-объекты используются для связи **низкоуровневого кода на основе колбэков** с высокоуровневым кодом async/await.1011## Функции Future1213#### `asyncio.isfuture(obj)`1415Возвращает `True`, если *obj* – это:1617- экземпляр [`asyncio.Future`](https://python-all.ru/3.7/library/asyncio-future.html#asyncio.Future),18- экземпляр [`asyncio.Task`](https://python-all.ru/3.7/library/asyncio-task.html#asyncio.Task),19- Future-подобный объект с атрибутом `_asyncio_future_blocking`.2021Новое в версии 3.5.2223#### `asyncio.ensure_future(obj, *, loop=None)`2425Возвращает:2627- *obj* как есть, если *obj* – [`Future`](https://python-all.ru/3.7/library/asyncio-future.html#asyncio.Future), [`Task`](https://python-all.ru/3.7/library/asyncio-task.html#asyncio.Task) или Future-подобный объект (проверка выполняется с помощью [`isfuture()`](https://python-all.ru/3.7/library/asyncio-future.html#asyncio.isfuture)).28- объект [`Task`](https://python-all.ru/3.7/library/asyncio-task.html#asyncio.Task), оборачивающий *obj*, если *obj* – корутина (проверка выполняется с помощью [`iscoroutine()`](https://python-all.ru/3.7/library/asyncio-task.html#asyncio.iscoroutine)); в этом случае корутина будет запланирована через `ensure_future()`.29- объект [`Task`](https://python-all.ru/3.7/library/asyncio-task.html#asyncio.Task), который будет ожидать *obj*, если *obj* является ожидаемым объектом (проверка выполняется с помощью [`inspect.isawaitable()`](https://python-all.ru/3.7/library/inspect.html#inspect.isawaitable)).3031Если *obj* не является ни одним из вышеперечисленных, возбуждается [`TypeError`](https://python-all.ru/3.7/library/exceptions.html#TypeError).3233> **Важно**34>35> См. также функцию [`create_task()`](https://python-all.ru/3.7/library/asyncio-task.html#asyncio.create_task), которая является предпочтительным способом создания новых задач.3637Изменено в версии 3.5.1: Функция принимает любой [ожидаемый](https://python-all.ru/3.7/glossary.html#term-awaitable) объект.3839#### `asyncio.wrap_future(future, *, loop=None)`4041Оборачивает объект [`concurrent.futures.Future`](https://python-all.ru/3.7/library/concurrent.futures.html#concurrent.futures.Future) в объект [`asyncio.Future`](https://python-all.ru/3.7/library/asyncio-future.html#asyncio.Future).4243## Объект Future4445#### `class asyncio.Future(*, loop=None)`4647Future представляет собой окончательный результат асинхронной операции. Не потокобезопасен.4849Future – это [ожидаемый объект](https://python-all.ru/3.7/glossary.html#term-awaitable). Корутины могут ожидать объекты Future, пока у них не будет установлен результат или исключение или пока они не будут отменены.5051Обычно Futures используются для того, чтобы низкоуровневый код на основе колбэков (например, в протоколах, реализованных с помощью asyncio [транспорты](https://python-all.ru/3.7/library/asyncio-protocol.html#asyncio-transports-protocols)) мог взаимодействовать с высокоуровневым кодом async/await.5253Эмпирическое правило: никогда не предоставлять объекты Future в пользовательских API, а рекомендуемый способ создания объекта Future – вызвать [`loop.create_future()`](https://python-all.ru/3.7/library/asyncio-eventloop.html#asyncio.loop.create_future). Таким образом, альтернативные реализации цикла событий могут внедрять свои собственные оптимизированные реализации объекта Future.5455Изменено в версии 3.7: Добавлена поддержка модуля [`contextvars`](https://python-all.ru/3.7/library/contextvars.html#module-contextvars).5657#### `result()`5859Возвращает результат объекта Future.6061Если Future находится в состоянии *done* и имеет результат, установленный методом [`set_result()`](https://python-all.ru/3.7/library/asyncio-future.html#asyncio.Future.set_result), возвращается значение результата.6263Если Future находится в состоянии *done* и имеет исключение, установленное методом [`set_exception()`](https://python-all.ru/3.7/library/asyncio-future.html#asyncio.Future.set_exception), этот метод возбуждает это исключение.6465Если Future был *отменён*, этот метод возбуждает исключение [`CancelledError`](https://python-all.ru/3.7/library/asyncio-exceptions.html#asyncio.CancelledError).6667Если результат Future ещё недоступен, этот метод вызывает исключение [`InvalidStateError`](https://python-all.ru/3.7/library/asyncio-exceptions.html#asyncio.InvalidStateError).6869#### `set_result(result)`7071Помечает Future как *done* и устанавливает его результат.7273Вызывает ошибку [`InvalidStateError`](https://python-all.ru/3.7/library/asyncio-exceptions.html#asyncio.InvalidStateError), если Future уже *завершён*.7475#### `set_exception(exception)`7677Помечает Future как *done* и устанавливает исключение.7879Вызывает ошибку [`InvalidStateError`](https://python-all.ru/3.7/library/asyncio-exceptions.html#asyncio.InvalidStateError), если Future уже *завершён*.8081#### `done()`8283Возвращает `True`, если Future находится в состоянии *done*.8485Future находится в состоянии *done*, если оно было *отменено* или если у него есть результат или исключение, установленные вызовами [`set_result()`](https://python-all.ru/3.7/library/asyncio-future.html#asyncio.Future.set_result) или [`set_exception()`](https://python-all.ru/3.7/library/asyncio-future.html#asyncio.Future.set_exception).8687#### `cancelled()`8889Возвращает `True`, если Future был *отменён*.9091Этот метод обычно используется для проверки того, не был ли Future *отменён*, перед установкой результата или исключения:9293```python94if not fut.cancelled():95    fut.set_result(42)96```9798#### `add_done_callback(callback, *, context=None)`99100Добавляет колбэк, который будет выполнен, когда Future перейдёт в состояние *done*.101102*Колбэк* вызывается с объектом Future в качестве единственного аргумента.103104Если Future уже находится в состоянии *done* на момент вызова этого метода, колбэк планируется с помощью [`loop.call_soon()`](https://python-all.ru/3.7/library/asyncio-eventloop.html#asyncio.loop.call_soon).105106Необязательный аргумент *context* (только ключевой) позволяет указать пользовательский [`contextvars.Context`](https://python-all.ru/3.7/library/contextvars.html#contextvars.Context) для выполнения *колбэка*. Если *context* не указан, используется текущий контекст.107108[`functools.partial()`](https://python-all.ru/3.7/library/functools.html#functools.partial) можно использовать для передачи параметров колбэку, например:109110```python111# Вызвать 'print("Future:", fut)', когда "fut" будет завершён.112fut.add_done_callback(113    functools.partial(print, "Future:"))114```115116Изменено в версии 3.7: Добавлен параметр *context* (только ключевой). Подробнее см. [**PEP 567**](https://python-all.ru/3.7/library/asyncio-future.html).117118#### `remove_done_callback(callback)`119120Удаляет *колбэк* из списка колбэков.121122Возвращает количество удалённых колбэков – обычно 1, если только колбэк не был добавлен более одного раза.123124#### `cancel()`125126Отменяет Future и планирует выполнение колбэков.127128Если Future уже *завершён* или *отменён*, вернуть `False`. Иначе перевести Future в состояние *отменён*, запланировать колбэки и вернуть `True`.129130#### `exception()`131132Возвращает исключение, которое было установлено для этого Future.133134Исключение (или `None`, если исключение не было установлено) возвращается только если Future *завершён*.135136Если Future был *отменён*, этот метод возбуждает исключение [`CancelledError`](https://python-all.ru/3.7/library/asyncio-exceptions.html#asyncio.CancelledError).137138Если Future ещё не *завершён*, этот метод возбуждает исключение [`InvalidStateError`](https://python-all.ru/3.7/library/asyncio-exceptions.html#asyncio.InvalidStateError).139140#### `get_loop()`141142Возвращает цикл событий, к которому привязан объект Future.143144Добавлено в версии 3.7.145146В этом примере создаётся объект Future, создаётся и планируется асинхронная задача для установки результата Future, и выполняется ожидание, пока Future не получит результат:147148```python149async def set_after(fut, delay, value):150    # Приостановиться на *delay* секунд.151    await asyncio.sleep(delay)152153    # Установить *value* в качестве результата Future *fut*.154    fut.set_result(value)155156async def main():157    # Получить текущий цикл событий.158    loop = asyncio.get_running_loop()159160    # Создать новый объект Future.161    fut = loop.create_future()162163    # Запустить корутину "set_after()" в параллельной задаче.164    # Мы используем низкоуровневый API "loop.create_task()", поскольку165    # у нас уже есть ссылка на цикл событий.166    # В противном случае можно было бы просто использовать "asyncio.create_task()".167    loop.create_task(168        set_after(fut, 1, '... world'))169170    print('hello ...')171172    # Ожидать, пока у *fut* не появится результат (1 секунда), и вывести его.173    print(await fut)174175asyncio.run(main())176```177178> **Важно**179>180> Объект Future был спроектирован так, чтобы имитировать [`concurrent.futures.Future`](https://python-all.ru/3.7/library/concurrent.futures.html#concurrent.futures.Future). Ключевые отличия включают:181>182> - в отличие от asyncio Future, экземпляры [`concurrent.futures.Future`](https://python-all.ru/3.7/library/concurrent.futures.html#concurrent.futures.Future) нельзя ожидать.183> - [`asyncio.Future.result()`](https://python-all.ru/3.7/library/asyncio-future.html#asyncio.Future.result) и [`asyncio.Future.exception()`](https://python-all.ru/3.7/library/asyncio-future.html#asyncio.Future.exception) не принимают аргумент *timeout*.184> - [`asyncio.Future.result()`](https://python-all.ru/3.7/library/asyncio-future.html#asyncio.Future.result) и [`asyncio.Future.exception()`](https://python-all.ru/3.7/library/asyncio-future.html#asyncio.Future.exception) возбуждают исключение [`InvalidStateError`](https://python-all.ru/3.7/library/asyncio-exceptions.html#asyncio.InvalidStateError), когда Future не *завершён*.185> - Колбэки, зарегистрированные с помощью [`asyncio.Future.add_done_callback()`](https://python-all.ru/3.7/library/asyncio-future.html#asyncio.Future.add_done_callback), вызываются не сразу. Вместо этого они планируются с помощью [`loop.call_soon()`](https://python-all.ru/3.7/library/asyncio-eventloop.html#asyncio.loop.call_soon).186> - asyncio Future несовместим с функциями [`concurrent.futures.wait()`](https://python-all.ru/3.7/library/concurrent.futures.html#concurrent.futures.wait) и [`concurrent.futures.as_completed()`](https://python-all.ru/3.7/library/concurrent.futures.html#concurrent.futures.as_completed).187