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

Индекс низкоуровневого API¶Low-level API Index

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

Получение цикла событий¶Obtaining the Event Loop

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

Примеры

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

Методы цикла событий¶Event Loop Methods

See also the main documentation section about the Event loop methods.

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

`loop.run_until_complete()`	Запускает Future, задачу или ожидаемый объект до завершения.
`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()`	Запускает CPU-интенсивную или другую блокирующую функцию в `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)`.

Сокеты

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

Транспорты¶Transports

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

`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()`	Завершить подпроцесс и закрыть все каналы.

Протоколы¶Protocols

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

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

Политики цикла событий¶Event Loop Policies

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

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

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