Индекс низкоуровневого API

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

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

`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/awaitable до завершения.
`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()`.

Сеть и IPC

`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)`.

Сокеты

END_OF_DOCUMENT_MARKER

`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() для отслеживания FD на события чтения.
Использование 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.13/library/asyncio-llapi-index.html