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

Асинхронное программирование отличается от классического «последовательного» программирования.

На этой странице перечислены распространенные ошибки и ловушки, а также способы их предотвращения.

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

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

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

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

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

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

  logging.basicConfig(level=logging.DEBUG)
  

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

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

• asyncio проверяет наличие задач, которые не были ожидаемыми и регистрирует их; это минимизирует ошибку «забытого ожидания».
• Многие не потокобезопасные 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 для выполнения блокирующего кода в другом потоке ОС без блокировки потока ОС, в котором выполняется цикл событий.

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

Блокирующий (занимающий процессор) код не следует вызывать напрямую. Например, если функция выполняет трудоёмкий расчёт на процессоре в течение 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