Skip to content

[3.11] gh-95180: Add TaskGroup and Runner to AsyncIO API Index (GH-95189) #96511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 2, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 20 additions & 9 deletions Doc/library/asyncio-api-index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,25 @@ await on multiple things with timeouts.
* - :func:`run`
- Create event loop, run a coroutine, close the loop.

* - :class:`Runner`
- A context manager that simplifies multiple async function calls.

* - :class:`Task`
- Task object.

* - :class:`TaskGroup`
- A context manager that holds a group of tasks. Provides
a convenient and reliable way to wait for all tasks in the group to
finish.

* - :func:`create_task`
- Start an asyncio Task.
- Start an asyncio Task, then returns it.

* - :func:`current_task`
- Return the current Task.

* - :func:`all_tasks`
- Return all tasks that are not yet finished for an event loop.

* - ``await`` :func:`sleep`
- Sleep for a number of seconds.
Expand All @@ -39,14 +56,8 @@ await on multiple things with timeouts.
* - ``await`` :func:`wait`
- Monitor for completion.

* - :func:`current_task`
- Return the current Task.

* - :func:`all_tasks`
- Return all tasks for an event loop.

* - :class:`Task`
- Task object.
* - :func:`timeout`
- Run with a timeout. Useful in cases when `wait_for` is not suitable.

* - :func:`to_thread`
- Asynchronously run a function in a separate OS thread.
Expand Down