Содержание страницы

Указатель API высокого уровня¶High-level API Index

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

Задачи¶Tasks

Утилиты для запуска программ 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`.

Примеры

Очереди¶Queues

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

`Queue`	Очередь FIFO.
`PriorityQueue`	Очередь с приоритетом.
`LifoQueue`	Очередь LIFO.

Примеры

Подпроцессы¶Subprocesses

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

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

Примеры

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

Потоки данных¶Streams

Высокоуровневые 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 потоков данных .

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

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

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

Примеры

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

Исключения¶Exceptions

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

Примеры

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