Skip to content

Chaoses-Ib/nest-asyncio2

Repository files navigation

nest-asyncio2

Build status PyPi License Downloads

Introduction

By design asyncio does not allow its event loop to be nested. This presents a practical problem: When in an environment where the event loop is already running it's impossible to run tasks and wait for the result. Trying to do so will give the error "RuntimeError: This event loop is already running".

The issue pops up in various environments, such as web servers, GUI applications and in Jupyter notebooks.

This module patches asyncio to allow nested use of asyncio.run and loop.run_until_complete.

Installation

pip3 install nest-asyncio2

Python 3.5 or higher is required.

Usage

import nest_asyncio2
nest_asyncio2.apply()

Optionally the specific loop that needs patching can be given as argument to apply, otherwise the current event loop is used. An event loop can be patched whether it is already running or not. Only event loops from asyncio can be patched; Loops from other projects, such as uvloop or quamash, generally can't be patched.

Comparison with nest_asyncio

nest-asyncio2 is a fork of the unmaintained nest_asyncio, with the following changes:

  • Python 3.12 loop_factory parameter support
  • Python 3.14 support (asyncio.current_task() and others are broken in nest_asyncio)

All interfaces are kept as they are. To migrate, you just need to change the package and module name to nest_asyncio2.