`asyncio-future.md`

196 строк · 14.7 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.9/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.9/Lib/asyncio/futures.py), [Lib/asyncio/base\_futures.py](https://python-all.ru/src/3.9/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.9/library/asyncio-future.html#asyncio.Future),22- экземпляр [`asyncio.Task`](https://python-all.ru/3.9/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.9/library/asyncio-future.html#asyncio.Future), [`Task`](https://python-all.ru/3.9/library/asyncio-task.html#asyncio.Task) или Future-подобный объект (проверка выполняется с помощью [`isfuture()`](https://python-all.ru/3.9/library/asyncio-future.html#asyncio.isfuture)).32- объект [`Task`](https://python-all.ru/3.9/library/asyncio-task.html#asyncio.Task), оборачивающий *obj*, если *obj* – корутина (проверка выполняется с помощью [`iscoroutine()`](https://python-all.ru/3.9/library/asyncio-task.html#asyncio.iscoroutine)); в этом случае корутина будет запланирована через `ensure_future()`.33- объект [`Task`](https://python-all.ru/3.9/library/asyncio-task.html#asyncio.Task), который будет ожидать *obj*, если *obj* является ожидаемым объектом (проверка выполняется с помощью [`inspect.isawaitable()`](https://python-all.ru/3.9/library/inspect.html#inspect.isawaitable)).3435Если *obj* не является ни одним из вышеперечисленных, возбуждается [`TypeError`](https://python-all.ru/3.9/library/exceptions.html#TypeError).3637> **Важно**38>39> См. также функцию [`create_task()`](https://python-all.ru/3.9/library/asyncio-task.html#asyncio.create_task), которая является предпочтительным способом создания новых задач.40>41> Сохраните ссылку на результат этой функции, чтобы избежать исчезновения задачи во время выполнения.4243Изменено в версии 3.5.1: Функция принимает любой [ожидаемый](https://python-all.ru/3.9/glossary.html#term-awaitable) объект.4445#### `asyncio.wrap_future(future, *, loop=None)`4647Оборачивает объект [`concurrent.futures.Future`](https://python-all.ru/3.9/library/concurrent.futures.html#concurrent.futures.Future) в объект [`asyncio.Future`](https://python-all.ru/3.9/library/asyncio-future.html#asyncio.Future).4849## Объект Future5051#### `class asyncio.Future(*, loop=None)`5253Future представляет собой окончательный результат асинхронной операции. Не потокобезопасен.5455Future – это [ожидаемый объект](https://python-all.ru/3.9/glossary.html#term-awaitable). Корутины могут ожидать объекты Future, пока у них не будет установлен результат или исключение или пока они не будут отменены.5657Обычно Futures используются для того, чтобы низкоуровневый код на основе колбэков (например, в протоколах, реализованных с помощью asyncio [транспорты](https://python-all.ru/3.9/library/asyncio-protocol.html#asyncio-transports-protocols)) мог взаимодействовать с высокоуровневым кодом async/await.5859Эмпирическое правило: никогда не предоставлять объекты Future в пользовательских API, а рекомендуемый способ создания объекта Future – вызвать [`loop.create_future()`](https://python-all.ru/3.9/library/asyncio-eventloop.html#asyncio.loop.create_future). Таким образом, альтернативные реализации цикла событий могут внедрять свои собственные оптимизированные реализации объекта Future.6061Изменено в версии 3.7: Добавлена поддержка модуля [`contextvars`](https://python-all.ru/3.9/library/contextvars.html#module-contextvars).6263#### `result()`6465Возвращает результат объекта Future.6667Если Future находится в состоянии *done* и имеет результат, установленный методом [`set_result()`](https://python-all.ru/3.9/library/asyncio-future.html#asyncio.Future.set_result), возвращается значение результата.6869Если Future находится в состоянии *done* и имеет исключение, установленное методом [`set_exception()`](https://python-all.ru/3.9/library/asyncio-future.html#asyncio.Future.set_exception), этот метод возбуждает это исключение.7071Если Future был *отменён*, этот метод возбуждает исключение [`CancelledError`](https://python-all.ru/3.9/library/asyncio-exceptions.html#asyncio.CancelledError).7273Если результат Future ещё недоступен, этот метод вызывает исключение [`InvalidStateError`](https://python-all.ru/3.9/library/asyncio-exceptions.html#asyncio.InvalidStateError).7475#### `set_result(result)`7677Помечает Future как *done* и устанавливает его результат.7879Вызывает ошибку [`InvalidStateError`](https://python-all.ru/3.9/library/asyncio-exceptions.html#asyncio.InvalidStateError), если Future уже *завершён*.8081#### `set_exception(exception)`8283Помечает Future как *done* и устанавливает исключение.8485Вызывает ошибку [`InvalidStateError`](https://python-all.ru/3.9/library/asyncio-exceptions.html#asyncio.InvalidStateError), если Future уже *завершён*.8687#### `done()`8889Возвращает `True`, если Future находится в состоянии *done*.9091Future находится в состоянии *done*, если оно было *отменено* или если у него есть результат или исключение, установленные вызовами [`set_result()`](https://python-all.ru/3.9/library/asyncio-future.html#asyncio.Future.set_result) или [`set_exception()`](https://python-all.ru/3.9/library/asyncio-future.html#asyncio.Future.set_exception).9293#### `cancelled()`9495Возвращает `True`, если Future был *отменён*.9697Этот метод обычно используется для проверки того, не был ли Future *отменён*, перед установкой результата или исключения:9899```python100if not fut.cancelled():101    fut.set_result(42)102```103104#### `add_done_callback(callback, *, context=None)`105106Добавляет колбэк, который будет выполнен, когда Future перейдёт в состояние *done*.107108*Колбэк* вызывается с объектом Future в качестве единственного аргумента.109110Если Future уже находится в состоянии *done* на момент вызова этого метода, колбэк планируется с помощью [`loop.call_soon()`](https://python-all.ru/3.9/library/asyncio-eventloop.html#asyncio.loop.call_soon).111112Необязательный аргумент *context* (только ключевой) позволяет указать пользовательский [`contextvars.Context`](https://python-all.ru/3.9/library/contextvars.html#contextvars.Context) для выполнения *колбэка*. Если *context* не указан, используется текущий контекст.113114[`functools.partial()`](https://python-all.ru/3.9/library/functools.html#functools.partial) можно использовать для передачи параметров колбэку, например:115116```python117# Вызвать 'print("Future:", fut)', когда "fut" будет завершён.118fut.add_done_callback(119    functools.partial(print, "Future:"))120```121122Изменено в версии 3.7: Добавлен параметр *context* (только ключевой). Подробнее см. [**PEP 567**](https://python-all.ru/3.9/library/asyncio-future.html).123124#### `remove_done_callback(callback)`125126Удаляет *колбэк* из списка колбэков.127128Возвращает количество удалённых колбэков – обычно 1, если только колбэк не был добавлен более одного раза.129130#### `cancel(msg=None)`131132Отменяет Future и планирует выполнение колбэков.133134Если Future уже *завершён* или *отменён*, вернуть `False`. Иначе перевести Future в состояние *отменён*, запланировать колбэки и вернуть `True`.135136Изменено в версии 3.9: Добавлен параметр `msg`.137138#### `exception()`139140Возвращает исключение, которое было установлено для этого Future.141142Исключение (или `None`, если исключение не было установлено) возвращается только если Future *завершён*.143144Если Future был *отменён*, этот метод возбуждает исключение [`CancelledError`](https://python-all.ru/3.9/library/asyncio-exceptions.html#asyncio.CancelledError).145146Если Future ещё не *завершён*, этот метод возбуждает исключение [`InvalidStateError`](https://python-all.ru/3.9/library/asyncio-exceptions.html#asyncio.InvalidStateError).147148#### `get_loop()`149150Возвращает цикл событий, к которому привязан объект Future.151152Добавлено в версии 3.7.153154В этом примере создаётся объект Future, создаётся и планируется асинхронная задача для установки результата Future, и выполняется ожидание, пока Future не получит результат:155156```python157async def set_after(fut, delay, value):158    # Приостановиться на *delay* секунд.159    await asyncio.sleep(delay)160161    # Установить *value* в качестве результата Future *fut*.162    fut.set_result(value)163164async def main():165    # Получить текущий цикл событий.166    loop = asyncio.get_running_loop()167168    # Создать новый объект Future.169    fut = loop.create_future()170171    # Запустить корутину "set_after()" в параллельной задаче.172    # Мы используем низкоуровневый API "loop.create_task()", поскольку173    # у нас уже есть ссылка на цикл событий.174    # В противном случае можно было бы просто использовать "asyncio.create_task()".175    loop.create_task(176        set_after(fut, 1, '... world'))177178    print('hello ...')179180    # Ожидать, пока у *fut* не появится результат (1 секунда), и вывести его.181    print(await fut)182183asyncio.run(main())184```185186> **Важно**187>188> Объект Future был спроектирован так, чтобы имитировать [`concurrent.futures.Future`](https://python-all.ru/3.9/library/concurrent.futures.html#concurrent.futures.Future). Ключевые отличия включают:189>190> - в отличие от asyncio Future, экземпляры [`concurrent.futures.Future`](https://python-all.ru/3.9/library/concurrent.futures.html#concurrent.futures.Future) нельзя ожидать.191> - [`asyncio.Future.result()`](https://python-all.ru/3.9/library/asyncio-future.html#asyncio.Future.result) и [`asyncio.Future.exception()`](https://python-all.ru/3.9/library/asyncio-future.html#asyncio.Future.exception) не принимают аргумент *timeout*.192> - [`asyncio.Future.result()`](https://python-all.ru/3.9/library/asyncio-future.html#asyncio.Future.result) и [`asyncio.Future.exception()`](https://python-all.ru/3.9/library/asyncio-future.html#asyncio.Future.exception) возбуждают исключение [`InvalidStateError`](https://python-all.ru/3.9/library/asyncio-exceptions.html#asyncio.InvalidStateError), когда Future не *завершён*.193> - Колбэки, зарегистрированные с помощью [`asyncio.Future.add_done_callback()`](https://python-all.ru/3.9/library/asyncio-future.html#asyncio.Future.add_done_callback), вызываются не сразу. Вместо этого они планируются с помощью [`loop.call_soon()`](https://python-all.ru/3.9/library/asyncio-eventloop.html#asyncio.loop.call_soon).194> - asyncio Future несовместим с функциями [`concurrent.futures.wait()`](https://python-all.ru/3.9/library/concurrent.futures.html#concurrent.futures.wait) и [`concurrent.futures.as_completed()`](https://python-all.ru/3.9/library/concurrent.futures.html#concurrent.futures.as_completed).195> - [`asyncio.Future.cancel()`](https://python-all.ru/3.9/library/asyncio-future.html#asyncio.Future.cancel) принимает необязательный аргумент `msg`, а `concurrent.futures.cancel()` – нет.196