]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.12] gh-119287: clarify doc on BaseExceptionGroup.derive and link to it from contex...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Wed, 5 Jun 2024 12:02:52 +0000 (14:02 +0200)
committerGitHub <noreply@github.com>
Wed, 5 Jun 2024 12:02:52 +0000 (12:02 +0000)
gh-119287: clarify doc on BaseExceptionGroup.derive and link to it from contextlib.suppress (GH-119657)
(cherry picked from commit 5c02ea8bae2287a828840f5734966da23dc573dc)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
Doc/library/contextlib.rst
Doc/library/exceptions.rst

index bad9da52d6a6ca9fdff0013a44a46f03a5d11da4..27cf99446e5980471561d6235b251ca5c9e2ef30 100644 (file)
@@ -314,7 +314,9 @@ Functions and classes provided:
 
    If the code within the :keyword:`!with` block raises a
    :exc:`BaseExceptionGroup`, suppressed exceptions are removed from the
-   group.  If any exceptions in the group are not suppressed, a group containing them is re-raised.
+   group.  Any exceptions of the group which are not suppressed are re-raised in
+   a new group which is created using the original group's :meth:`~BaseExceptionGroup.derive`
+   method.
 
    .. versionadded:: 3.4
 
index 60600b2436b734ae4dfe9f46ca2dddcb3c02799d..de46518e673763c1553fd926e8250e275b4168c6 100644 (file)
@@ -967,7 +967,8 @@ their subgroups based on the types of the contained exceptions.
       Returns an exception group with the same :attr:`message`, but which
       wraps the exceptions in ``excs``.
 
-      This method is used by :meth:`subgroup` and :meth:`split`. A
+      This method is used by :meth:`subgroup` and :meth:`split`, which
+      are used in various contexts to break up an exception group. A
       subclass needs to override it in order to make :meth:`subgroup`
       and :meth:`split` return instances of the subclass rather
       than :exc:`ExceptionGroup`.