Политики

Получение и установка политики

Следующие функции могут использоваться для получения и установки политики для текущего процесса:

asyncio.get_event_loop_policy()

Возвращает политику текущего процесса.

asyncio.set_event_loop_policy(policy)

Устанавливает текущую политику процесса на policy.

Если policy установлено на None, восстанавливается политика по умолчанию.

Объекты политики

Абстрактный базовый класс политики цикла событий определяется следующим образом:

class asyncio.AbstractEventLoopPolicy

Абстрактный базовый класс для политик asyncio.

get_event_loop()

Получить цикл событий для текущего контекста.

Возвращает объект цикла событий, реализующий интерфейс AbstractEventLoop.

Этот метод никогда не должен возвращать None.

Изменено в версии 3.6.

set_event_loop(loop)

Установить цикл событий для текущего контекста на loop.

new_event_loop()

Создает и возвращает новый объект цикла событий.

Этот метод никогда не должен возвращать None.

get_child_watcher()

Получить объект наблюдателя дочернего процесса.

Возвращает объект наблюдателя, реализующий интерфейс AbstractChildWatcher.

Функция специфична для Unix.

Устарело начиная с версии 3.12.

set_child_watcher(watcher)

Устанавливает текущий наблюдатель дочернего процесса на watcher.

Функция специфична для Unix.

Устарело начиная с версии 3.12.

В asyncio поставляются следующие встроенные политики:

class asyncio.DefaultEventLoopPolicy

Политика asyncio по умолчанию. Использует SelectorEventLoop на Unix и ProactorEventLoop на Windows.

Нет необходимости устанавливать политику по умолчанию вручную. asyncio настроен на автоматическое использование политики по умолчанию.

Изменено в версии 3.8: На Windows теперь используется ProactorEventLoop по умолчанию.

Устарело начиная с версии 3.12: Метод get_event_loop() политики asyncio по умолчанию теперь выводит DeprecationWarning, если текущий цикл событий не установлен, и он решает создать его. В будущем выпуске Python это станет ошибкой.

class asyncio.WindowsSelectorEventLoopPolicy

Альтернативная политика цикла событий, использующая реализацию цикла событий SelectorEventLoop.

Доступность: Windows.

class asyncio.WindowsProactorEventLoopPolicy

Альтернативная политика цикла событий, использующая реализацию цикла событий ProactorEventLoop.

Доступность: Windows.

Наблюдатели за процессами

Наблюдатель за процессами позволяет настроить, как цикл событий отслеживает дочерние процессы в Unix. В частности, циклу событий необходимо знать, когда дочерний процесс завершился.

В asyncio дочерние процессы создаются с помощью функций create_subprocess_exec() и loop.subprocess_exec().

asyncio определяет абстрактный базовый класс AbstractChildWatcher, который должны реализовывать наблюдатели за дочерними процессами, и имеет четыре различных реализации: ThreadedChildWatcher (настроен для использования по умолчанию), MultiLoopChildWatcher, SafeChildWatcher и FastChildWatcher.

См. также раздел Подпроцессы и потоки.

Для настройки реализации наблюдателя за дочерними процессами, используемой циклом событий asyncio, можно использовать следующие две функции:

asyncio.get_child_watcher()

Возвращает текущего наблюдателя за дочерними процессами для текущей политики.

Устарело начиная с версии 3.12.

asyncio.set_child_watcher(watcher)

Устанавливает текущего наблюдателя за дочерними процессами на watcher для текущей политики. watcher должен реализовывать методы, определённые в базовом классе AbstractChildWatcher.

Устарело начиная с версии 3.12.

class asyncio.AbstractChildWatcher

add_child_handler(pid, callback, *args)

Регистрирует новый обработчик дочерних процессов.

Организует вызов callback(pid, returncode, *args) при завершении процесса с PID, равным pid. Указание другого обработчика для того же процесса заменяет предыдущий обработчик.

Вызываемый объект callback должен быть потокобезопасным.

remove_child_handler(pid)

Удаляет обработчик для процесса с PID, равным pid.

Функция возвращает True если обработчик был успешно удалён, False если удалять нечего.

attach_loop(loop)

Прикрепляет наблюдатель к циклу событий.

Если наблюдатель был ранее прикреплён к циклу событий, он сначала открепляется перед прикреплением к новому циклу.

Примечание: цикл событий может быть None.

is_active()

Возвращает True если наблюдатель готов к использованию.

Запуск подпроцесса с неактивным текущим наблюдателем за дочерними процессами вызывает RuntimeError.

Добавлен в версии 3.8.

close()

Закрывает наблюдателя.

Этот метод должен вызываться, чтобы гарантировать очистку базовых ресурсов.

Устарело начиная с версии 3.12.

class asyncio.ThreadedChildWatcher

Эта реализация запускает новый ожидающий поток для каждого запуска подпроцесса.

Она работает надёжно даже когда цикл событий asyncio запущен в неглавном потоке ОС.

Нет заметной накладной при обработке большого числа дочерних процессов (O(1) каждый раз, когда дочерний процесс завершается), но запуск потока на процесс требует дополнительной памяти.

Этот наблюдатель используется по умолчанию.

Добавлен в версии 3.8.

class asyncio.MultiLoopChildWatcher

Эта реализация регистрирует обработчик сигнала SIGCHLD при создании. Это может нарушить код сторонних разработчиков, который устанавливает пользовательский обработчик для сигнала SIGCHLD.

Наблюдатель избегает нарушения работы другого кода, запускающего процессы, явно опросом каждого процесса при получении сигнала SIGCHLD.

Нет ограничений для запуска подпроцессов из разных потоков после установки наблюдателя.

Решение безопасно, но имеет значительную накладную при обработке большого количества процессов (O(n) каждый раз, когда принимается сигнал SIGCHLD).

Добавлен в версии 3.8.

Устарело начиная с версии 3.12.

class asyncio.SafeChildWatcher

Эта реализация использует активный цикл событий из главного потока для обработки сигнала SIGCHLD. Если в главном потоке нет работающего цикла событий, другой поток не может запустить подпроцесс (RuntimeError генерируется).

Наблюдатель избегает нарушения работы другого кода, запускающего процессы, явно опросом каждого процесса при получении сигнала SIGCHLD.

Это решение столь же безопасно, как и MultiLoopChildWatcher, и имеет ту же сложность O(n), но требует работающего цикла событий в главном потоке для работы.

Устарело начиная с версии 3.12.

class asyncio.FastChildWatcher

Эта реализация собирает каждый завершенный процесс, вызывая os.waitpid(-1) напрямую, что может нарушить работу другого кода, запускающего процессы и ожидающего их завершения.

Нет заметной накладной при обработке большого числа дочерних процессов (O(1) каждый раз, когда дочерний процесс завершается).

Это решение требует работающего цикла событий в главном потоке, так же, как и SafeChildWatcher.

Устарело начиная с версии 3.12.

class asyncio.PidfdChildWatcher

Эта реализация опрашивает дескрипторы файлов процессов (pidfds), чтобы дождаться завершения дочернего процесса. В некоторых отношениях, PidfdChildWatcher — это «золотая середина» реализации наблюдателя за дочерними процессами. Она не требует сигналов или потоков, не мешает процессу, запущенному вне цикла событий, и масштабируется линейно с количеством подпроцессов, запущенных циклом событий. Основной недостаток заключается в том, что pidfds специфичны для Linux и работают только на последних (5.3+) ядрах.

Добавлен в версии 3.9.

Пользовательские политики

Для реализации новой политики цикла событий рекомендуется унаследовать от DefaultEventLoopPolicy и переопределить методы, для которых требуется пользовательское поведение, например:

class MyEventLoopPolicy(asyncio.DefaultEventLoopPolicy):

    def get_event_loop(self):
        """Get the event loop.

        This may be None or an instance of EventLoop.
        """
        loop = super().get_event_loop()
        # Do something with loop ...
        return loop

asyncio.set_event_loop_policy(MyEventLoopPolicy())