Указатель высокоуровневого API

На этой странице перечислены все высокоуровневые API asyncio с поддержкой async/await.

Задачи

Утилиты для запуска программ asyncio, создания задач и ожидания нескольких операций с ограничением по времени.

`run()`	Создать цикл событий, запустить сопрограмму и закрыть цикл.
`Runner`	Менеджер контекста, упрощающий вызов нескольких асинхронных функций.
`Task`	Объект задачи.
`TaskGroup`	Менеджер контекста, содержащий группу задач. Предоставляет удобный и надёжный способ дождаться завершения всех задач в группе.
`create_task()`	Запустить задачу asyncio и вернуть её.
`current_task()`	Вернуть текущую задачу.
`all_tasks()`	Вернуть все ещё не завершённые задачи для цикла событий.
`await` `sleep()`	Приостановить выполнение на заданное количество секунд.
`await` `gather()`	Запланировать параллельное выполнение нескольких операций и дождаться их завершения.
`await` `wait_for()`	Выполнить с ограничением по времени.
`await` `shield()`	Защитить от отмены.
`await` `wait()`	Ожидать завершения.
`timeout()`	Выполнить с ограничением по времени. Полезно в случаях, когда `wait_for` не подходит.
`to_thread()`	Асинхронно выполнить функцию в отдельном потоке ОС.
`run_coroutine_threadsafe()`	Запланировать сопрограмму из другого потока ОС.
`for in` `as_completed()`	Ожидать завершения в цикле `for`.

Примеры

Очереди

Очереди следует использовать для распределения работы между несколькими задачами asyncio, реализации пулов соединений и шаблонов pub/sub.

`Queue`	Очередь FIFO.
`PriorityQueue`	Приоритетная очередь.
`LifoQueue`	Очередь LIFO.

Примеры

Подпроцессы

Утилиты для запуска подпроцессов и выполнения команд оболочки.

`await` `create_subprocess_exec()`	Создать подпроцесс.
`await` `create_subprocess_shell()`	Выполнить команду оболочки.

Примеры

Выполнение команды оболочки.
См. также документацию по API подпроцессов.

Потоки

Высокоуровневые API для работы с сетевым вводом-выводом.

`await` `open_connection()`	Установить TCP-соединение.
`await` `open_unix_connection()`	Установить соединение через сокет Unix.
`await` `start_server()`	Запустить TCP-сервер.
`await` `start_unix_server()`	Запустить сервер сокетов Unix.
`StreamReader`	Высокоуровневый объект async/await для получения сетевых данных.
`StreamWriter`	Высокоуровневый объект async/await для отправки сетевых данных.

Примеры

Пример TCP-клиента.
См. также документацию по API потоков.

Синхронизация

Примитивы синхронизации, аналогичные средствам потоков, которые можно использовать в задачах.

`Lock`	Блокировка-мьютекс.
`Event`	Объект события.
`Condition`	Объект условия.
`Semaphore`	Семафор.
`BoundedSemaphore`	Ограниченный семафор.
`Barrier`	Объект барьера.

Примеры

Использование asyncio.Event.
Использование asyncio.Barrier.
См. также документацию по примитивам синхронизации asyncio.

Исключения

`asyncio.CancelledError`	Вызывается при отмене задачи. См. также `Task.cancel()`.
`asyncio.BrokenBarrierError`	Вызывается при нарушении работы барьера. См. также `Barrier.wait()`.

Примеры

Обработка CancelledError для выполнения кода при запросе отмены.
См. также полный список исключений, специфичных для asyncio.

© 2001–2024 Python Software Foundation
Licensed under the PSF License.
https://docs.python.org/3.12/library/asyncio-api-index.html