Skip to content

bpo-46771: Implement task cancel requests #31513

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 3 commits into from
Feb 24, 2022
Merged

bpo-46771: Implement task cancel requests #31513

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a231718
Implement task cancel requests
Tinche Feb 22, 2022
ab5bce9
Tweak task docstrings
Tinche Feb 24, 2022
532a5be
Run `make regen-all`
Tinche Feb 24, 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
Tweak task docstrings
  • Loading branch information
@Tinche
Tinche committed Feb 24, 2022
commit ab5bce9d1c3879b290cb5da517b771d86fca97e4
14 changes: 14 additions & 0 deletions Lib/asyncio/tasks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,8 @@ def cancel(self, msg=None):
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.
"""
self._log_traceback = False
if self.done():
Expand All @@ -217,9 +219,21 @@ def cancel(self, msg=None):
return True

def cancelling(self):
Copy link
Copy Markdown
Contributor

@asvetlov asvetlov Feb 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the cancelling() the best name for returning the number or cancel requests?
It was good for bool flag, a counter needs better name IMHO.

Copy link
Copy Markdown
Member

@gvanrossum gvanrossum Feb 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, do you have a suggestion? I was thinking that it's still usable as a "truthy" value. Usually when you're interested in the cancel count you should call uncancel() and use its return value.

Copy link
Copy Markdown
Contributor

@asvetlov asvetlov Feb 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no good answer.
cancel_requests_count() describes exact meaning but the name is too long.
cancelling() can return bool but it looks like procrastination: why return less info than we really have.
The third option is dropping cancelling() method entirely, it is not required by the current asyncio code.
We can consider adding the method later on-demand.

Copy link
Copy Markdown
Contributor

@asvetlov asvetlov Feb 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: .cancelling() doesn't exist in Python 3.10

Copy link
Copy Markdown
Member

@gvanrossum gvanrossum Feb 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's used in TaskGroup currently, so if we were to delete it we'd have to rewrite the code there in this same PR. It's also used by Task.__repr__() (via _task_repr_info()). But of those will work even though we upgraded it from a bool to an int. I'd say let's keep it for now, if we regret it we can rename or remove it before beta 1.

Copy link
Copy Markdown
Contributor

@asvetlov asvetlov Feb 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deal!

"""Return the count of the task's cancellation requests.

This count is incremented when .cancel() is called
and may be decremented using .uncancel().
"""
return self._num_cancels_requested

def uncancel(self):
"""Decrement the task's count of cancellation requests.

This should be used by tasks that catch CancelledError
and wish to continue indefinitely until they are cancelled again.

Returns the remaining number of cancellation requests.
"""
if self._num_cancels_requested > 0:
self._num_cancels_requested -= 1
return self._num_cancels_requested
Expand Down
15 changes: 7 additions & 8 deletions Modules/_asynciomodule.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2191,6 +2191,8 @@ 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.
[clinic start generated code]*/

static PyObject *
Expand Down Expand Up @@ -2238,13 +2240,10 @@ _asyncio_Task_cancel_impl(TaskObj *self, PyObject *msg)
/*[clinic input]
_asyncio.Task.cancelling

Return True if the task is in the process of being cancelled.

This is set once .cancel() is called
and remains set until .uncancel() is called.
Return the count of the task's cancellation requests.

As long as this flag is set, further .cancel() calls will be ignored,
until .uncancel() is called to reset it.
This count is incremented when .cancel() is called
and may be decremented using .uncancel().
[clinic start generated code]*/

static PyObject *
Expand All @@ -2258,12 +2257,12 @@ _asyncio_Task_cancelling_impl(TaskObj *self)
/*[clinic input]
_asyncio.Task.uncancel

Reset the flag returned by cancelling().
Decrement the task's count of cancellation requests.

This should be used by tasks that catch CancelledError
and wish to continue indefinitely until they are cancelled again.

Returns the previous value of the flag.
Returns the remaining number of cancellation requests.
[clinic start generated code]*/

static PyObject *
Expand Down