gh-102560 Add docstrings to asyncio.TaskGroup (GH-102565)

(cherry picked from commit e94edab727)

Co-authored-by: JosephSBoyle <48555120+JosephSBoyle@users.noreply.github.com>
This commit is contained in:
Miss Islington (bot) 2023-03-15 00:27:33 -07:00 committed by GitHub
parent 6b6c2f53ec
commit 7e5ba351e0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -10,7 +10,21 @@ from . import tasks
class TaskGroup:
"""Asynchronous context manager for managing groups of tasks.
Example use:
async with asyncio.TaskGroup() as group:
task1 = group.create_task(some_coroutine(...))
task2 = group.create_task(other_coroutine(...))
print("Both tasks have completed now.")
All tasks are awaited when the context manager exits.
Any exceptions other than `asyncio.CancelledError` raised within
a task will cancel all remaining tasks and wait for them to exit.
The exceptions are then combined and raised as an `ExceptionGroup`.
"""
def __init__(self):
self._entered = False
self._exiting = False
@ -135,6 +149,10 @@ class TaskGroup:
self._errors = None
def create_task(self, coro, *, name=None, context=None):
"""Create a new task in this group and return it.
Similar to `asyncio.create_task`.
"""
if not self._entered:
raise RuntimeError(f"TaskGroup {self!r} has not been entered")
if self._exiting and not self._tasks: