Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
cpython
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
cpython
Commits
e4070130
Commit
e4070130
authored
Sep 30, 2019
by
Kyle Stanley
Committed by
Yury Selivanov
Sep 30, 2019
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Fix and improve `asyncio.run()` docs (GH-16403)
parent
aca8c406
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
4 additions
and
10 deletions
+4
-10
Doc/glossary.rst
Doc/glossary.rst
+1
-1
Doc/library/asyncio-task.rst
Doc/library/asyncio-task.rst
+2
-4
Lib/asyncio/runners.py
Lib/asyncio/runners.py
+1
-5
No files found.
Doc/glossary.rst
View file @
e4070130
...
@@ -247,7 +247,7 @@ Glossary
...
@@ -247,7 +247,7 @@ Glossary
Fortran
contiguous
arrays
,
the
first
index
varies
the
fastest
.
Fortran
contiguous
arrays
,
the
first
index
varies
the
fastest
.
coroutine
coroutine
Coroutines
is
a
more
generalized
form
of
subroutines
.
Subroutines
are
Coroutines
are
a
more
generalized
form
of
subroutines
.
Subroutines
are
entered
at
one
point
and
exited
at
another
point
.
Coroutines
can
be
entered
at
one
point
and
exited
at
another
point
.
Coroutines
can
be
entered
,
exited
,
and
resumed
at
many
different
points
.
They
can
be
entered
,
exited
,
and
resumed
at
many
different
points
.
They
can
be
implemented
with
the
:
keyword
:`
async
def
`
statement
.
See
also
implemented
with
the
:
keyword
:`
async
def
`
statement
.
See
also
...
...
Doc/library/asyncio-task.rst
View file @
e4070130
...
@@ -212,6 +212,8 @@ Running an asyncio Program
...
@@ -212,6 +212,8 @@ Running an asyncio Program
.. function:: run(coro, \*, debug=False)
.. function:: run(coro, \*, debug=False)
Execute the :term:`coroutine` *coro* and return the result.
This function runs the passed coroutine, taking care of
This function runs the passed coroutine, taking care of
managing the asyncio event loop, *finalizing asynchronous
managing the asyncio event loop, *finalizing asynchronous
generators*, and closing the threadpool.
generators*, and closing the threadpool.
...
@@ -225,10 +227,6 @@ Running an asyncio Program
...
@@ -225,10 +227,6 @@ Running an asyncio Program
the end. It should be used as a main entry point for asyncio
the end. It should be used as a main entry point for asyncio
programs, and should ideally only be called once.
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::
Example::
async def main():
async def main():
...
...
Lib/asyncio/runners.py
View file @
e4070130
...
@@ -6,7 +6,7 @@ from . import tasks
...
@@ -6,7 +6,7 @@ from . import tasks
def
run
(
main
,
*
,
debug
=
False
):
def
run
(
main
,
*
,
debug
=
False
):
"""
Run a coroutine
.
"""
Execute the coroutine and return the result
.
This function runs the passed coroutine, taking care of
This function runs the passed coroutine, taking care of
managing the asyncio event loop and finalizing asynchronous
managing the asyncio event loop and finalizing asynchronous
...
@@ -21,10 +21,6 @@ def run(main, *, debug=False):
...
@@ -21,10 +21,6 @@ def run(main, *, debug=False):
It should be used as a main entry point for asyncio programs, and should
It should be used as a main entry point for asyncio programs, and should
ideally only be called once.
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:
Example:
async def main():
async def main():
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment