bpo-38260: Add Docs on asyncio.run (GH-16337)
Add docs about return and raise exception on asyncio.run
https://bugs.python.org/issue38260
Automerge-Triggered-By: @asvetlov
(cherry picked from commit 17deb16883
)
Co-authored-by: Emmanuel Arias <emmanuelarias30@gmail.com>
This commit is contained in:
parent
ce62dcc460
commit
4633355a06
|
@ -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
|
||||
|
||||
|
||||
|
|
|
@ -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():
|
||||
|
|
Loading…
Reference in New Issue