High-level API IndexИндекс высокоуровневого API

На этой странице перечислены все высокоуровневые 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.

Примеры

• Использование asyncio.gather() для параллельного выполнения задач.

• Использование asyncio.wait_for() для установки тайм-аута.

• Отмена.

• Использование asyncio.sleep().

• См. также основную страницу документации по задачам.

QueuesОчереди

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

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

Примеры

• Использование asyncio.Queue для распределения нагрузки между несколькими задачами.

• См. также страницу документации Queues.

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\nпримитивов синхронизации.

ExceptionsИсключения

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

Примеры

• Обработка CancelledError для выполнения кода при запросе отмены.

• См. также полный список\nисключений, специфичных для asyncio.