Skip to main content

Patch asyncio to allow nested event loops

Project description

Build PyPi Number of 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_asyncio

Python 3.5 or higher is required.

Usage

import nest_asyncio
nest_asyncio.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.

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_asyncio-1.6.0.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

nest_asyncio-1.6.0-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file nest_asyncio-1.6.0.tar.gz.

File metadata

  • Download URL: nest_asyncio-1.6.0.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.1

File hashes

Hashes for nest_asyncio-1.6.0.tar.gz
Algorithm Hash digest
SHA256 6f172d5449aca15afd6c646851f4e31e02c598d553a667e38cafa997cfec55fe
MD5 4a15c56d692367a24ea12072e2e475f3
BLAKE2b-256 83f851569ac65d696c8ecbee95938f89d4abf00f47d58d48f6fbabfe8f0baefe

See more details on using hashes here.

File details

Details for the file nest_asyncio-1.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for nest_asyncio-1.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 87af6efd6b5e897c81050477ef65c62e2b2f35d51703cae01aff2905b1852e1c
MD5 dbe512b8ff01d1e68e61dfa0f91f37e5
BLAKE2b-256 a0c4c2971a3ba4c6103a3d10c4b0f24f461ddc027f0f09763220cf35ca1401b3

See more details on using hashes here.

Supported by

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