Skip to content

gh-90908: Document asyncio.Task.cancelling() and asyncio.Task.uncancel() #95253

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gvanrossum merged 12 commits into from
Oct 1, 2022
Merged

gh-90908: Document asyncio.Task.cancelling() and asyncio.Task.uncancel() #95253

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
708cb27
gh-90908: Document asyncio.Task.cancelling() and asyncio.Task.uncancel()
ambv Jul 25, 2022
0203e01
Reword `uncancel()` example, move cancellation methods down in docs
ambv Jul 26, 2022
4a6a2fe
Apply suggestions from Guido's code review
ambv Jul 27, 2022
ad49eb0
Re-fix typo from ce195cbd98b48370326d9e1bc5ff74e828571850
ambv Jul 27, 2022
4c56381
Move example to tests and expand on why it's doing what it's doing
ambv Jul 28, 2022
13515f3
Use a semicolon in comment to make text flow more obvious
ambv Jul 28, 2022
f0a215d
Expand the example test by showing cancelling() is 0
ambv Jul 29, 2022
f3bcc6f
Rewording nit
gvanrossum Sep 26, 2022
26cf287
attempt to -> call
gvanrossum Sep 26, 2022
9296af0
Be precise about cancelling()
gvanrossum Sep 26, 2022
4114a79
Merge branch 'main' into document-asyncio-task-uncancel
gvanrossum Sep 26, 2022
50850de
Merge branch 'main' into document-asyncio-task-uncancel
gvanrossum Sep 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Apply suggestions from Guido's code review 
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
  • Loading branch information
@ambv @gvanrossum
ambv and gvanrossum authored Jul 27, 2022
commit 4a6a2fe901b714c5ceba97242ae655d22b76fa76
8 changes: 3 additions & 5 deletions Doc/library/asyncio-task.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,12 +294,10 @@ perform clean-up logic. In case :exc:`asyncio.CancelledError`
is explicitly caught, it should generally be propagated when
clean-up is complete. Most code can safely ignore :exc:`asyncio.CancelledError`.

asyncio components that enable structured concurrency, like
The asyncio components that enable structured concurrency, like
:class:`asyncio.TaskGroup` and the :func:`asyncio.timeout` context manager,
Comment thread
gvanrossum marked this conversation as resolved.
Outdated
are implemented using cancellation internally and might misbehave if
a coroutine swallows :exc:`asyncio.CancelledError`. In particular,
they might :func:`uncancel <asyncio.Task.uncancel>` a task to properly
isolate cancelling only a given structured block within the task's body.
a coroutine swallows :exc:`asyncio.CancelledError`.

.. _taskgroups:

Expand Down Expand Up @@ -1188,7 +1186,7 @@ Task Object

Note that if this number is greater than zero but the Task is
still executing, :meth:`cancelled` will still return ``False``.
It's because this number can be lowered by calling :meth:`uncancel`,
This is because this number can be lowered by calling :meth:`uncancel`,
which can lead to the task not being cancelled after all if the
cancellation requests go down to zero.

Expand Down