Skip to content

Commit

Permalink
bpo-37651: Document CancelledError is now a subclass of BaseException (
Browse files Browse the repository at this point in the history
  • Loading branch information
tirkarthi authored and miss-islington committed Sep 11, 2019
1 parent 97b817e commit 7b69069
Showing 1 changed file with 2 additions and 19 deletions.
21 changes: 2 additions & 19 deletions Doc/library/asyncio-exceptions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 7b69069

Please sign in to comment.