Низкоуровневый индекс API¶

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

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

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

Примеры

Using asyncio.get_running_loop().

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

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

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

`loop.run_until_complete()`	Запускайте будущую/доступную задачу/ до тех пор, пока она не будет завершена.
`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()`.

Задачи и будущее

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

Розетки

`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()`	Реализация обработчика исключений по умолчанию.

Примеры

Using asyncio.new_event_loop() and loop.run_forever().
Using loop.call_later().
Используя loop.create_connection() для реализации an echo-client.
Используя loop.create_connection() для connect a socket.
Using add_reader() to watch an FD for read events.
Using loop.add_signal_handler().
Using 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`, если транспорт поддерживает отправку.
`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(). Смотрите также главную policies section для получения более подробной информации.

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

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

Высокоуровневый индекс API

Разработка с помощью asyncio

Вернуться на верх

Низкоуровневый индекс API¶

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

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

Транспортирует¶

Протоколы¶

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

Python 3.11

Содержание

Дополнительно

Вы здесь: