Skip to main content

Patch asyncio to allow nested event loops

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nest_asyncio2-1.6.1.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nest_asyncio2-1.6.1-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file nest_asyncio2-1.6.1.tar.gz.

File metadata

  • Download URL: nest_asyncio2-1.6.1.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for nest_asyncio2-1.6.1.tar.gz
Algorithm Hash digest
SHA256 809296f49d362f77b55020d94bdb61987f7c0ae198bd628c9fec4042860336ac
MD5 c9d121cf63e2fce66bf1d1f530b47963
BLAKE2b-256 f2e5483e900c34a8a6144b544578b53483973ad34ca3e5d49f7e78367b9ca837

See more details on using hashes here.

File details

Details for the file nest_asyncio2-1.6.1-py3-none-any.whl.

File metadata

  • Download URL: nest_asyncio2-1.6.1-py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for nest_asyncio2-1.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c420e44030caada8e593b1b7a786eec7871742bb6d498a192317e7124a6e2102
MD5 502325e1fac2e024ab0eaf7b510b17f2
BLAKE2b-256 bb6f3abf81876809a7d9e0ae79655eef9634844b3053fdfba114fb1589e2119a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page