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

На этой странице перечислены все низкоуровневые API asyncio.

Получение цикла событий

`asyncio.get_running_loop()`	Предпочтительная функция для получения работающего цикла событий.
`asyncio.get_event_loop()`	Получить экземпляр цикла событий (работающий или текущий, согласно текущей политике).
`asyncio.set_event_loop()`	Установить цикл событий как текущий согласно текущей политике.
`asyncio.new_event_loop()`	Создать новый цикл событий.

Примеры

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

Методы цикла событий

См. также основной раздел документации о методах цикла событий.

Жизненный цикл

`loop.run_until_complete()`	Выполнять Future/Task/объект, ожидаемый через await, до завершения.
`loop.run_forever()`	Выполнять цикл событий бесконечно.
`loop.stop()`	Остановить цикл событий.
`loop.close()`	Закрыть цикл событий.
`loop.is_running()`	Возвращает `True`, если цикл событий выполняется.
`loop.is_closed()`	Возвращает `True`, если цикл событий закрыт.
`await` `loop.shutdown_asyncgens()`	Закрыть асинхронные генераторы.

Отладка

`loop.set_debug()`	Включить или отключить режим отладки.
`loop.get_debug()`	Получить текущий режим отладки.

Планирование обратных вызовов

`loop.call_soon()`	Вызвать обратный вызов в ближайшее время.
`loop.call_soon_threadsafe()`	Потокобезопасный вариант `loop.call_soon()`.
`loop.call_later()`	Вызвать обратный вызов после указанного времени.
`loop.call_at()`	Вызвать обратный вызов в указанное время.

Пул потоков/процессов

`await` `loop.run_in_executor()`	Выполнить ресурсоёмкую задачу, ограниченную производительностью процессора, или другую блокирующую функцию в исполнителе `concurrent.futures`.
`loop.set_default_executor()`	Установить исполнитель по умолчанию для `loop.run_in_executor()`.

Задачи и Future

`loop.create_future()`	Создать объект `Future`.
`loop.create_task()`	Запланировать корутину как `Task`.
`loop.set_task_factory()`	Установить фабрику, используемую `loop.create_task()` для создания `Tasks`.
`loop.get_task_factory()`	Получить фабрику, которую `loop.create_task()` использует для создания `Tasks`.

DNS

`await` `loop.getaddrinfo()`	Асинхронная версия `socket.getaddrinfo()`.
`await` `loop.getnameinfo()`	Асинхронная версия `socket.getnameinfo()`.

Сетевое взаимодействие и межпроцессное взаимодействие

`await` `loop.create_connection()`	Открыть TCP-соединение.
`await` `loop.create_server()`	Создать TCP-сервер.
`await` `loop.create_unix_connection()`	Открыть соединение через сокет Unix.
`await` `loop.create_unix_server()`	Создать сервер на сокете Unix.
`await` `loop.connect_accepted_socket()`	Обернуть `socket` в пару `(transport, protocol)`.
`await` `loop.create_datagram_endpoint()`	Открыть соединение для дейтаграмм (UDP).
`await` `loop.sendfile()`	Отправить файл через транспорт.
`await` `loop.start_tls()`	Перевести существующее соединение на TLS.
`await` `loop.connect_read_pipe()`	Обернуть конец канала для чтения в пару `(transport, protocol)`.
`await` `loop.connect_write_pipe()`	Обернуть конец канала для записи в пару `(transport, protocol)`.

Сокеты

`await` `loop.sock_recv()`	Получить данные из `socket`.
`await` `loop.sock_recv_into()`	Получить данные из `socket` в буфер.
`await` `loop.sock_recvfrom()`	Получить дейтаграмму из `socket`.
`await` `loop.sock_recvfrom_into()`	Получить дейтаграмму из `socket` в буфер.
`await` `loop.sock_sendall()`	Отправить данные в `socket`.
`await` `loop.sock_sendto()`	Отправить дейтаграмму через `socket` по указанному адресу.
`await` `loop.sock_connect()`	Подключить `socket`.
`await` `loop.sock_accept()`	Принять соединение через `socket`.
`await` `loop.sock_sendfile()`	Отправить файл через `socket`.
`loop.add_reader()`	Начать отслеживать готовность файлового дескриптора к чтению.
`loop.remove_reader()`	Прекратить отслеживать готовность файлового дескриптора к чтению.
`loop.add_writer()`	Начать отслеживать готовность файлового дескриптора к записи.
`loop.remove_writer()`	Прекратить отслеживать готовность файлового дескриптора к записи.

Сигналы Unix

`loop.add_signal_handler()`	Добавить обработчик для `signal`.
`loop.remove_signal_handler()`	Удалить обработчик для `signal`.

Подпроцессы

`loop.subprocess_exec()`	Запустить подпроцесс.
`loop.subprocess_shell()`	Запустить подпроцесс с помощью команды оболочки.

Обработка ошибок

`loop.call_exception_handler()`	Вызвать обработчик исключений.
`loop.set_exception_handler()`	Установить новый обработчик исключений.
`loop.get_exception_handler()`	Получить текущий обработчик исключений.
`loop.default_exception_handler()`	Реализация обработчика исключений по умолчанию.

Примеры

Использование asyncio.new_event_loop() и loop.run_forever().
Использование loop.call_later().
Использование loop.create_connection() для реализации эхо-клиента.
Использование loop.create_connection() для подключения сокета.
Использование add_reader() для отслеживания событий чтения файлового дескриптора.
Использование loop.add_signal_handler().
Использование loop.subprocess_exec().

Транспорты

Все транспорты реализуют следующие методы:

`transport.close()`	Закрыть транспорт.
`transport.is_closing()`	Возвращает `True`, если транспорт закрывается или уже закрыт.
`transport.get_extra_info()`	Запросить информацию о транспорте.
`transport.set_protocol()`	Установить новый протокол.
`transport.get_protocol()`	Вернуть текущий протокол.

Транспорты, способные принимать данные (TCP- и Unix-соединения, каналы и т. д.). Возвращаются такими методами, как loop.create_connection(), loop.create_unix_connection(), loop.connect_read_pipe() и т. д.:

Транспорты для чтения

`transport.is_reading()`	Возвращает `True`, если транспорт принимает данные.
`transport.pause_reading()`	Приостановить приём данных.
`transport.resume_reading()`	Возобновить приём данных.

Транспорты, способные отправлять данные (TCP- и Unix-соединения, каналы и т. д.). Возвращаются такими методами, как loop.create_connection(), loop.create_unix_connection(), loop.connect_write_pipe() и т. д.:

Транспорты для записи

`transport.write()`	Записать данные в транспорт.
`transport.writelines()`	Записать буферы в транспорт.
`transport.can_write_eof()`	Возвращает `True`, если транспорт поддерживает отправку EOF.
`transport.write_eof()`	Закрыть транспорт и отправить EOF после сброса буферизованных данных.
`transport.abort()`	Немедленно закрыть транспорт.
`transport.get_write_buffer_size()`	Вернуть текущий размер выходного буфера.
`transport.get_write_buffer_limits()`	Вернуть верхний и нижний пороги управления потоком записи.
`transport.set_write_buffer_limits()`	Установить новые верхний и нижний пороги управления потоком записи.

Транспорты, возвращаемые методом loop.create_datagram_endpoint():

Транспорты дейтаграмм

`transport.sendto()`	Отправить данные удалённому узлу.
`transport.abort()`	Немедленно закрыть транспорт.

Низкоуровневая абстракция транспорта для подпроцессов. Возвращается методами loop.subprocess_exec() и loop.subprocess_shell():

Транспорты подпроцессов

`transport.get_pid()`	Вернуть идентификатор процесса подпроцесса.
`transport.get_pipe_transport()`	Вернуть транспорт для запрошенного канала связи (stdin, stdout или stderr).
`transport.get_returncode()`	Вернуть код завершения подпроцесса.
`transport.kill()`	Принудительно завершить подпроцесс.
`transport.send_signal()`	Отправить сигнал подпроцессу.
`transport.terminate()`	Остановить подпроцесс.
`transport.close()`	Принудительно завершить подпроцесс и закрыть все каналы.

Протоколы

Классы протоколов могут реализовывать следующие методы обратного вызова:

`callback` `connection_made()`	Вызывается при установлении соединения.
`callback` `connection_lost()`	Вызывается при потере или закрытии соединения.
`callback` `pause_writing()`	Вызывается, когда буфер транспорта превышает верхний порог.
`callback` `resume_writing()`	Вызывается, когда буфер транспорта опускается ниже нижнего порога.

Потоковые протоколы (TCP, сокеты Unix, каналы)

`callback` `data_received()`	Вызывается при получении данных.
`callback` `eof_received()`	Вызывается при получении EOF.

Буферизованные потоковые протоколы

`callback` `get_buffer()`	Вызывается для выделения нового буфера приёма.
`callback` `buffer_updated()`	Вызывается, когда буфер обновлён полученными данными.
`callback` `eof_received()`	Вызывается при получении EOF.

Протоколы датаграмм

`callback` `datagram_received()`	Вызывается при получении датаграммы.
`callback` `error_received()`	Вызывается, когда предыдущая операция отправки или получения вызывает исключение `OSError`.

Протоколы подпроцессов

`callback` `pipe_data_received()`	Вызывается, когда дочерний процесс записывает данные в канал stdout или stderr.
`callback` `pipe_connection_lost()`	Вызывается, когда закрывается один из каналов связи с дочерним процессом.
`callback` `process_exited()`	Вызывается, когда дочерний процесс завершает работу. Может быть вызван до методов `pipe_data_received()` и `pipe_connection_lost()`.

Политики цикла событий

Политики — это низкоуровневый механизм изменения поведения таких функций, как asyncio.get_event_loop(). Дополнительные сведения см. также в основном разделе о политиках.

Доступ к политикам

`asyncio.get_event_loop_policy()`	Возвращает текущую политику для всего процесса.
`asyncio.set_event_loop_policy()`	Задаёт новую политику для всего процесса.
`AbstractEventLoopPolicy`	Базовый класс объектов политик.

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