diff options
| -rw-r--r-- | Doc/library/asyncio-task.rst | 12 | ||||
| -rw-r--r-- | Lib/asyncio/runners.py | 4 |
2 files changed, 16 insertions, 0 deletions
diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst index 1fb8829..9f55a35 100644 --- a/Doc/library/asyncio-task.rst +++ b/Doc/library/asyncio-task.rst @@ -225,6 +225,18 @@ Running an asyncio Program the end. It should be used as a main entry point for asyncio programs, and should ideally only be called once. + Return a result of *coro* execution, or raise a :exc:`RuntimeError` + if ``asyncio.run()`` is called from a running event loop, or a + :exc:`ValueError` if *coro* is not a courutine. + + Example:: + + async def main(): + await asyncio.sleep(1) + print('hello') + + asyncio.run(main()) + .. versionadded:: 3.7 .. versionchanged:: 3.9 diff --git a/Lib/asyncio/runners.py b/Lib/asyncio/runners.py index 6c87747..904102b 100644 --- a/Lib/asyncio/runners.py +++ b/Lib/asyncio/runners.py @@ -21,6 +21,10 @@ def run(main, *, debug=False): It should be used as a main entry point for asyncio programs, and should ideally only be called once. + Return a result of *coro* execution, or raise a RuntimeError + if `asyncio.run()`is called from a running event loop, or a ValueError + if `main` is not a courutine. + Example: async def main(): |