Merge remote-tracking branch 'upstream/main' into asyncio_taskgroup_d…

…ont_abort_on_exception
python · DontPanicO · Feb 7, 2023 · Feb 7, 2023 · Feb 7, 2023 · Mar 17, 2023
commit bb09126bc8c10f9b87e6453bee4ddb8ea88c4903
@@ -12,6 +12,19 @@
 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, defer_errors=False):
        self._entered = False
        self._exiting = False