Разработка с asyncio

Режим отладки

По умолчанию asyncio работает в режиме производства. Для облегчения разработки asyncio имеет режим отладки.

Существует несколько способов включить режим отладки asyncio:

• Установка переменной окружения PYTHONASYNCIODEBUG на 1.
• Использование командной строки Python -X dev.
• Передача debug=True в asyncio.run().
• Вызов loop.set_debug().

Помимо включения режима отладки, также следует:

• установить уровень ведения журнала журнала asyncio на logging.DEBUG, например, следующий фрагмент кода может быть запущен при запуске приложения:

  logging.basicConfig(level=logging.DEBUG)
  

• настроить модуль warnings для отображения предупреждений ResourceWarning. Один из способов сделать это — использовать командную строку Python -W default.

Когда режим отладки включен:

• asyncio проверяет наличие необработанных корутин и регистрирует их; это смягчает ловушку «забытого await».
• Многие небезопасные для потоков API asyncio (такие как loop.call_soon() и loop.call_at()) генерируют исключение, если они вызываются из неправильного потока.
• Время выполнения селектора ввода-вывода регистрируется, если для выполнения операции ввода-вывода требуется слишком много времени.
• Обработчики, занимающие более 100 мс, регистрируются. Атрибут loop.slow_callback_duration можно использовать для установки минимального времени выполнения в секундах, которое считается «медленным».

Конкурентность и многопоточность

Цикл событий выполняется в потоке (обычно в главном потоке) и выполняет все обработчики и задачи в этом потоке. Пока задача выполняется в цикле событий, никакие другие задачи не могут выполняться в этом же потоке. Когда задача выполняет выражение await, выполняемая задача приостанавливается, и цикл событий выполняет следующую задачу.

Для планирования обработчика из другого потока ОС необходимо использовать метод loop.call_soon_threadsafe(). Пример:

loop.call_soon_threadsafe(callback, *args)

Практически все объекты asyncio не потокобезопасны, что обычно не проблема, если нет кода, который работает с ними извне задачи или обработчика. Если такой код должен вызывать низкоуровневый API asyncio, необходимо использовать метод loop.call_soon_threadsafe(), например:

loop.call_soon_threadsafe(fut.cancel)

Для планирования объекта корутины из другого потока ОС необходимо использовать функцию run_coroutine_threadsafe(). Она возвращает concurrent.futures.Future для доступа к результату:

async def coro_func():
     return await asyncio.sleep(1, 42)

# Later in another OS thread:

future = asyncio.run_coroutine_threadsafe(coro_func(), loop)
# Wait for the result:
result = future.result()

Для обработки сигналов и выполнения подпроцессов цикл событий должен выполняться в главном потоке.

Метод loop.run_in_executor() может использоваться с concurrent.futures.ThreadPoolExecutor для выполнения блокирующего кода в другом потоке ОС, не блокируя поток ОС, в котором выполняется цикл событий.

В настоящее время нет способа планировать корутины или обработчики напрямую из другого процесса (например, запущенного с помощью multiprocessing). В разделе «Методы цикла событий asyncio» перечислены API, которые могут читать из каналов и наблюдать за дескрипторами файлов без блокирования цикла событий. Кроме того, API подпроцессов asyncio предоставляют способ запуска процесса и взаимодействия с ним из цикла событий. Наконец, упомянутый метод loop.run_in_executor() также может использоваться с concurrent.futures.ProcessPoolExecutor для выполнения кода в другом процессе.

Выполнение блокирующего кода

Блокирующий (занимающий ЦП) код не следует вызывать напрямую. Например, если функция выполняет интенсивное вычисление в ЦП в течение 1 секунды, все конкурентные задачи asyncio и операции ввода-вывода будут задерживаться на 1 секунду.

Для выполнения задачи в другом потоке или даже в другом процессе, чтобы избежать блокирования потока ОС с циклом событий, можно использовать планировщик. Подробнее см. метод loop.run_in_executor().

Ведение журнала

asyncio использует модуль logging, и все ведение журнала выполняется через логгер "asyncio".

Уровень журнала по умолчанию — logging.INFO, который можно легко настроить:

logging.getLogger("asyncio").setLevel(logging.WARNING)

Обнаружение необработанных корутин

Когда функция корутины вызывается, но не обрабатывается (например, coro() вместо await coro()) или корутина не планируется с помощью asyncio.create_task(), asyncio генерирует предупреждение RuntimeWarning:

import asyncio

async def test():
    print("never scheduled")

async def main():
    test()

asyncio.run(main())

Вывод:

test.py:7: RuntimeWarning: coroutine 'test' was never awaited
  test()

Вывод в режиме отладки:

test.py:7: RuntimeWarning: coroutine 'test' was never awaited
Coroutine created at (most recent call last)
  File "../t.py", line 9, in <module>
    asyncio.run(main(), debug=True)

  < .. >

  File "../t.py", line 7, in main
    test()
  test()

Обычно решение состоит в том, чтобы либо обработать корутину, либо вызвать функцию asyncio.create_task():

async def main():
    await test()

Обнаружение необработанных исключений

Если вызывается Future.set_exception(), но объект Future никогда не обрабатывается, исключение никогда не будет передано в код пользователя. В этом случае asyncio выведет сообщение в журнал при сборе мусора объекта Future.

Пример исключения, которое не было обработано:

import asyncio

async def bug():
    raise Exception("not consumed")

async def main():
    asyncio.create_task(bug())

asyncio.run(main())

Вывод:

Task exception was never retrieved
future: <Task finished coro=<bug() done, defined at test.py:3>
  exception=Exception('not consumed')>

Traceback (most recent call last):
  File "test.py", line 4, in bug
    raise Exception("not consumed")
Exception: not consumed

Включить режим отладки для получения трассировки, где была создана задача:

asyncio.run(main(), debug=True)

Вывод в режиме отладки:

Task exception was never retrieved
future: <Task finished coro=<bug() done, defined at test.py:3>
    exception=Exception('not consumed') created at asyncio/tasks.py:321>

source_traceback: Object created at (most recent call last):
  File "../t.py", line 9, in <module>
    asyncio.run(main(), debug=True)

< .. >

Traceback (most recent call last):
  File "../t.py", line 4, in bug
    raise Exception("not consumed")
Exception: not consumed