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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: nest_asyncio-1.5.6.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.0rc2

File hashes

Hashes for nest_asyncio-1.5.6.tar.gz
Algorithm Hash digest
SHA256 d267cc1ff794403f7df692964d1d2a3fa9418ffea2a3f6859a439ff482fef290
MD5 7c7108921a64e7abbb6993803343819b
BLAKE2b-256 357664c51c1cbe704ad79ef6ec82f232d1893b9365f2ff194111787dc91b004f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nest_asyncio-1.5.6-py3-none-any.whl
  • Upload date:
  • Size: 5.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.0rc2

File hashes

Hashes for nest_asyncio-1.5.6-py3-none-any.whl
Algorithm Hash digest
SHA256 b9a953fb40dceaa587d109609098db21900182b16440652454a146cffb06e8b8
MD5 c99039cf2eb17198c99e840f2328cdf7
BLAKE2b-256 e91a6dd9ec31cfdb34cef8fea0055b593ee779a6f63c8e8038ad90d71b7f53c0

See more details on using hashes here.

Supported by

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