]> granicus.if.org Git - python/commitdiff
bpo-37651: Document CancelledError is now a subclass of BaseException (GH-15950)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Wed, 11 Sep 2019 15:08:47 +0000 (08:08 -0700)
committerGitHub <noreply@github.com>
Wed, 11 Sep 2019 15:08:47 +0000 (08:08 -0700)
https://bugs.python.org/issue37651

Automerge-Triggered-By: @1st1
(cherry picked from commit 7b69069e9aa0047a0dbe8af1a67aa2b355dc68d8)

Co-authored-by: Xtreak <tir.karthi@gmail.com>
Doc/library/asyncio-exceptions.rst

index e49577a203e8fb360952b9694b35010aec11f2ff..b1e6ecfda15ead2638ed953bcee224e443a6267a 100644 (file)
@@ -25,26 +25,9 @@ Exceptions
    when asyncio Tasks are cancelled.  In almost all situations the
    exception must be re-raised.
 
-   .. important::
-
-      This exception is a subclass of :exc:`Exception`, so it can be
-      accidentally suppressed by an overly broad ``try..except`` block::
-
-        try:
-            await operation
-        except Exception:
-            # The cancellation is broken because the *except* block
-            # suppresses the CancelledError exception.
-            log.log('an error has occurred')
-
-      Instead, the following pattern should be used::
+   .. versionchanged:: 3.8
 
-        try:
-            await operation
-        except asyncio.CancelledError:
-            raise
-        except Exception:
-            log.log('an error has occurred')
+      :exc:`CancelledError` is now a subclass of :class:`BaseException`.
 
 
 .. exception:: InvalidStateError