`asyncio-future.md`

202 строк · 15.8 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.12/library/asyncio-future.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# Future89**Исходный код:** [Lib/asyncio/futures.py](https://python-all.ru/src/3.12/Lib/asyncio/futures.py), [Lib/asyncio/base\_futures.py](https://python-all.ru/src/3.12/Lib/asyncio/base_futures.py)1011---1213*Future*-объекты используются для связи **низкоуровневого кода на основе колбэков** с высокоуровневым кодом async/await.1415## Функции Future1617#### `asyncio.isfuture(obj)`1819Возвращает `True`, если *obj* – это:2021- экземпляр [`asyncio.Future`](https://python-all.ru/3.12/library/asyncio-future.html#asyncio.Future),22- экземпляр [`asyncio.Task`](https://python-all.ru/3.12/library/asyncio-task.html#asyncio.Task),23- Future-подобный объект с атрибутом `_asyncio_future_blocking`.2425Добавлено в версии 3.5.2627#### `asyncio.ensure_future(obj, *, loop=None)`2829Возвращает:3031- *obj* как есть, если *obj* – [`Future`](https://python-all.ru/3.12/library/asyncio-future.html#asyncio.Future), [`Task`](https://python-all.ru/3.12/library/asyncio-task.html#asyncio.Task) или Future-подобный объект (проверка выполняется с помощью [`isfuture()`](https://python-all.ru/3.12/library/asyncio-future.html#asyncio.isfuture)).32- объект [`Task`](https://python-all.ru/3.12/library/asyncio-task.html#asyncio.Task), оборачивающий *obj*, если *obj* – корутина (проверка выполняется с помощью [`iscoroutine()`](https://python-all.ru/3.12/library/asyncio-task.html#asyncio.iscoroutine)); в этом случае корутина будет запланирована через `ensure_future()`.33- объект [`Task`](https://python-all.ru/3.12/library/asyncio-task.html#asyncio.Task), который будет ожидать *obj*, если *obj* является ожидаемым объектом (проверка выполняется с помощью [`inspect.isawaitable()`](https://python-all.ru/3.12/library/inspect.html#inspect.isawaitable)).3435Если *obj* не является ни одним из вышеперечисленных, возбуждается [`TypeError`](https://python-all.ru/3.12/library/exceptions.html#TypeError).3637> **Важно**38>39> См. также функцию [`create_task()`](https://python-all.ru/3.12/library/asyncio-task.html#asyncio.create_task), которая является предпочтительным способом создания новых задач.40>41> Сохраняйте ссылку на результат этой функции, чтобы избежать исчезновения задачи во время выполнения.4243Изменено в версии 3.5.1: Функция принимает любой [ожидаемый](https://python-all.ru/3.12/glossary.html#term-awaitable) объект.4445Устарело с версии 3.10: Предупреждение об устаревании выводится, если *obj* не является Future-подобным объектом и *loop* не указан, и нет работающего цикла событий.4647#### `asyncio.wrap_future(future, *, loop=None)`4849Оборачивает объект [`concurrent.futures.Future`](https://python-all.ru/3.12/library/concurrent.futures.html#concurrent.futures.Future) в объект [`asyncio.Future`](https://python-all.ru/3.12/library/asyncio-future.html#asyncio.Future).5051Устарело с версии 3.10: Предупреждение об устаревании выводится, если *future* не является Future-подобным объектом и *loop* не указан, и нет работающего цикла событий.5253## Объект Future5455#### `class asyncio.Future(*, loop=None)`5657Future представляет собой окончательный результат асинхронной операции. Не потокобезопасен.5859Future – это [ожидаемый](https://python-all.ru/3.12/glossary.html#term-awaitable) объект. Корутины могут ожидать объекты Future, пока у них не будет установлен результат или исключение, или пока они не будут отменены. Future можно ожидать несколько раз, и результат будет одинаковым.6061Обычно Futures используются для того, чтобы низкоуровневый код на основе колбэков (например, в протоколах, реализованных с помощью asyncio [транспорты](https://python-all.ru/3.12/library/asyncio-protocol.html#asyncio-transports-protocols)) мог взаимодействовать с высокоуровневым кодом async/await.6263Эмпирическое правило: никогда не предоставлять объекты Future в пользовательских API, а рекомендуемый способ создания объекта Future – вызвать [`loop.create_future()`](https://python-all.ru/3.12/library/asyncio-eventloop.html#asyncio.loop.create_future). Таким образом, альтернативные реализации цикла событий могут внедрять свои собственные оптимизированные реализации объекта Future.6465Изменено в версии 3.7: Добавлена поддержка модуля [`contextvars`](https://python-all.ru/3.12/library/contextvars.html#module-contextvars).6667Устарело с версии 3.10: Предупреждение об устаревании выводится, если *loop* не указан и нет работающего цикла событий.6869#### `result()`7071Возвращает результат объекта Future.7273Если Future находится в состоянии *done* и имеет результат, установленный методом [`set_result()`](https://python-all.ru/3.12/library/asyncio-future.html#asyncio.Future.set_result), возвращается значение результата.7475Если Future находится в состоянии *done* и имеет исключение, установленное методом [`set_exception()`](https://python-all.ru/3.12/library/asyncio-future.html#asyncio.Future.set_exception), этот метод возбуждает это исключение.7677Если Future был *отменён*, этот метод возбуждает исключение [`CancelledError`](https://python-all.ru/3.12/library/asyncio-exceptions.html#asyncio.CancelledError).7879Если результат Future ещё недоступен, этот метод возбуждает исключение [`InvalidStateError`](https://python-all.ru/3.12/library/asyncio-exceptions.html#asyncio.InvalidStateError).8081#### `set_result(result)`8283Помечает Future как *done* и устанавливает его результат.8485Возбуждает ошибку [`InvalidStateError`](https://python-all.ru/3.12/library/asyncio-exceptions.html#asyncio.InvalidStateError), если Future уже находится в состоянии *done*.8687#### `set_exception(exception)`8889Помечает Future как *done* и устанавливает исключение.9091Возбуждает ошибку [`InvalidStateError`](https://python-all.ru/3.12/library/asyncio-exceptions.html#asyncio.InvalidStateError), если Future уже находится в состоянии *done*.9293#### `done()`9495Возвращает `True`, если Future находится в состоянии *done*.9697Future находится в состоянии *done*, если оно было *отменено* или если у него есть результат или исключение, установленные вызовами [`set_result()`](https://python-all.ru/3.12/library/asyncio-future.html#asyncio.Future.set_result) или [`set_exception()`](https://python-all.ru/3.12/library/asyncio-future.html#asyncio.Future.set_exception).9899#### `cancelled()`100101Возвращает `True`, если Future был *отменён*.102103Этот метод обычно используется для проверки того, не был ли Future *отменён*, перед установкой результата или исключения:104105```python106if not fut.cancelled():107    fut.set_result(42)108```109110#### `add_done_callback(callback, *, context=None)`111112Добавляет колбэк, который будет выполнен, когда Future перейдёт в состояние *done*.113114*Колбэк* вызывается с объектом Future в качестве единственного аргумента.115116Если Future уже находится в состоянии *done* на момент вызова этого метода, колбэк планируется с помощью [`loop.call_soon()`](https://python-all.ru/3.12/library/asyncio-eventloop.html#asyncio.loop.call_soon).117118Необязательный аргумент *context* (только ключевой) позволяет указать пользовательский [`contextvars.Context`](https://python-all.ru/3.12/library/contextvars.html#contextvars.Context) для выполнения *колбэка*. Если *context* не указан, используется текущий контекст.119120[`functools.partial()`](https://python-all.ru/3.12/library/functools.html#functools.partial) можно использовать для передачи параметров колбэку, например:121122```python123# Вызвать 'print("Future:", fut)', когда "fut" будет завершён.124fut.add_done_callback(125    functools.partial(print, "Future:"))126```127128Изменено в версии 3.7: Добавлен параметр *context* (только ключевой). Подробнее см. [**PEP 567**](https://python-all.ru/3.12/library/asyncio-future.html).129130#### `remove_done_callback(callback)`131132Удаляет *колбэк* из списка колбэков.133134Возвращает количество удалённых колбэков – обычно 1, если только колбэк не был добавлен более одного раза.135136#### `cancel(msg=None)`137138Отменяет Future и планирует выполнение колбэков.139140Если Future уже *завершён* или *отменён*, вернуть `False`. Иначе перевести Future в состояние *отменён*, запланировать колбэки и вернуть `True`.141142Изменено в версии 3.9: Добавлен параметр *msg*.143144#### `exception()`145146Возвращает исключение, которое было установлено для этого Future.147148Исключение (или `None`, если исключение не было установлено) возвращается только если Future *завершён*.149150Если Future был *отменён*, этот метод возбуждает исключение [`CancelledError`](https://python-all.ru/3.12/library/asyncio-exceptions.html#asyncio.CancelledError).151152Если Future ещё не *завершён*, этот метод возбуждает исключение [`InvalidStateError`](https://python-all.ru/3.12/library/asyncio-exceptions.html#asyncio.InvalidStateError).153154#### `get_loop()`155156Возвращает цикл событий, к которому привязан объект Future.157158Добавлено в версии 3.7.159160В этом примере создаётся объект Future, создаётся и планируется асинхронная задача для установки результата Future, и выполняется ожидание, пока Future не получит результат:161162```python163async def set_after(fut, delay, value):164    # Приостановиться на *delay* секунд.165    await asyncio.sleep(delay)166167    # Установить *value* в качестве результата Future *fut*.168    fut.set_result(value)169170async def main():171    # Получить текущий цикл событий.172    loop = asyncio.get_running_loop()173174    # Создать новый объект Future.175    fut = loop.create_future()176177    # Запустить корутину "set_after()" в параллельной задаче.178    # Мы используем низкоуровневый API "loop.create_task()", поскольку179    # у нас уже есть ссылка на цикл событий.180    # В противном случае можно было бы просто использовать "asyncio.create_task()".181    loop.create_task(182        set_after(fut, 1, '... world'))183184    print('hello ...')185186    # Ожидать, пока у *fut* не появится результат (1 секунда), и вывести его.187    print(await fut)188189asyncio.run(main())190```191192> **Важно**193>194> Объект Future был спроектирован так, чтобы имитировать [`concurrent.futures.Future`](https://python-all.ru/3.12/library/concurrent.futures.html#concurrent.futures.Future). Ключевые отличия включают:195>196> - в отличие от asyncio Future, экземпляры [`concurrent.futures.Future`](https://python-all.ru/3.12/library/concurrent.futures.html#concurrent.futures.Future) нельзя ожидать.197> - [`asyncio.Future.result()`](https://python-all.ru/3.12/library/asyncio-future.html#asyncio.Future.result) и [`asyncio.Future.exception()`](https://python-all.ru/3.12/library/asyncio-future.html#asyncio.Future.exception) не принимают аргумент *timeout*.198> - [`asyncio.Future.result()`](https://python-all.ru/3.12/library/asyncio-future.html#asyncio.Future.result) и [`asyncio.Future.exception()`](https://python-all.ru/3.12/library/asyncio-future.html#asyncio.Future.exception) возбуждают исключение [`InvalidStateError`](https://python-all.ru/3.12/library/asyncio-exceptions.html#asyncio.InvalidStateError), когда Future не *завершён*.199> - Колбэки, зарегистрированные с помощью [`asyncio.Future.add_done_callback()`](https://python-all.ru/3.12/library/asyncio-future.html#asyncio.Future.add_done_callback), вызываются не сразу. Вместо этого они планируются с помощью [`loop.call_soon()`](https://python-all.ru/3.12/library/asyncio-eventloop.html#asyncio.loop.call_soon).200> - asyncio Future несовместим с функциями [`concurrent.futures.wait()`](https://python-all.ru/3.12/library/concurrent.futures.html#concurrent.futures.wait) и [`concurrent.futures.as_completed()`](https://python-all.ru/3.12/library/concurrent.futures.html#concurrent.futures.as_completed).201> - [`asyncio.Future.cancel()`](https://python-all.ru/3.12/library/asyncio-future.html#asyncio.Future.cancel) принимает необязательный аргумент `msg`, а [`concurrent.futures.Future.cancel()`](https://python-all.ru/3.12/library/concurrent.futures.html#concurrent.futures.Future.cancel) – нет.202