PyDocs

Nav

Networking and Interprocess Communication

Task.cancel

asyncio

method of Tasknot WASI
  • Task.cancel(msg=None)
Request that this task cancel itself.

This arranges for a CancelledError to be thrown into the
wrapped coroutine on the next cycle through the event loop.
The coroutine then has a chance to clean up or even deny
the request using try/except/finally.

Unlike Future.cancel, this does not guarantee that the
task will be cancelled: the exception might be caught and
acted upon, delaying cancellation of the task or preventing
cancellation completely.  The task may also return a value or
raise a different exception.

Immediately after this method is called, Task.cancelled() will
not return True (unless the task was already cancelled).  A
task will be marked as cancelled when the wrapped coroutine
terminates with a CancelledError exception (even if cancel()
was not called).

This also increases the task's count of cancellation requests.
Changed in 3.9, 3.11
  • 3.9: Added the msg parameter.
  • 3.11: The msg parameter is propagated from cancelled task to its awaiter.
0 Examples
No examples for asyncio/Task.cancel.
See Also
No see-alsos for asyncio/Task.cancel
0 Notes
No notes for Task.cancel