summaryrefslogtreecommitdiffstats
path: root/python/nest_asyncio/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/nest_asyncio/README')
-rw-r--r--python/nest_asyncio/README10
1 files changed, 10 insertions, 0 deletions
diff --git a/python/nest_asyncio/README b/python/nest_asyncio/README
new file mode 100644
index 0000000000..212658bb31
--- /dev/null
+++ b/python/nest_asyncio/README
@@ -0,0 +1,10 @@
+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.