Skip to content

bpo-31033: Add a msg argument to Future.cancel() and Task.cancel() #19979

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
cjerdonek merged 8 commits into from
May 15, 2020
Merged

bpo-31033: Add a msg argument to Future.cancel() and Task.cancel() #19979

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0ed5e4e
Add argument clinic changes.
cjerdonek May 7, 2020
5c8489f
Add failing tests.
cjerdonek May 7, 2020
58a2257
Add C implementation.
cjerdonek May 7, 2020
86e13df
Add pure Python implementation.
cjerdonek May 7, 2020
403baa2
Add docs and NEWS entry.
cjerdonek May 7, 2020
6b133a2
Make None msg result in no arguments.
cjerdonek May 8, 2020
a0434c9
Test the getter and setter.
cjerdonek May 8, 2020
22a54cc
Remove the _create_cancelled_error() helper function.
cjerdonek May 15, 2020
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
Add docs and NEWS entry.
  • Loading branch information
@cjerdonek
cjerdonek committed May 14, 2020
commit 403baa28f49019a7c948a68f6d3882580f40dee5
8 changes: 7 additions & 1 deletion Doc/library/asyncio-future.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,14 +170,17 @@ Future Object
Returns the number of callbacks removed, which is typically 1,
unless a callback was added more than once.

.. method:: cancel()
.. method:: cancel(msg=None)

Cancel the Future and schedule callbacks.

If the Future is already *done* or *cancelled*, return ``False``.
Otherwise, change the Future's state to *cancelled*,
schedule the callbacks, and return ``True``.

.. versionchanged:: 3.9
Added the ``msg`` parameter.

.. method:: exception()

Return the exception that was set on this Future.
Expand Down Expand Up @@ -255,3 +258,6 @@ the Future has a result::
- asyncio Future is not compatible with the
:func:`concurrent.futures.wait` and
:func:`concurrent.futures.as_completed` functions.

- :meth:`asyncio.Future.cancel` accepts an optional ``msg`` argument,
but :func:`concurrent.futures.cancel` does not.
5 changes: 4 additions & 1 deletion Doc/library/asyncio-task.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -723,7 +723,7 @@ Task Object
.. deprecated-removed:: 3.8 3.10
The *loop* parameter.

.. method:: cancel()
.. method:: cancel(msg=None)

Request the Task to be cancelled.

Expand All @@ -738,6 +738,9 @@ Task Object
suppressing cancellation completely is not common and is actively
discouraged.

.. versionchanged:: 3.9
Added the ``msg`` parameter.

.. _asyncio_example_task_cancel:

The following example illustrates how coroutines can intercept
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Library/2020-05-07-06-41-20.bpo-31033.waCj3n.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add a ``msg`` argument to :meth:`Future.cancel` and :meth:`Task.cancel`.