Skip to content

gh-148091: asyncio : clarify Future.cancel(msg) behaviour #148248

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
kumaraditya303 merged 10 commits into from
Apr 9, 2026
+4 −0
Merged

gh-148091: asyncio : clarify Future.cancel(msg) behaviour #148248

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
790d500
asyncio : clarify Future.cancel(msg) behaviour
Apr 8, 2026
60b2aed
fix lint: wrap doc line
Apr 8, 2026
a670ced
fix lint : extra space after 'Future'
Apr 8, 2026
98cd575
Removed docstring from Lib/asyncio/futures.py and added it in Doc/lib…
Apr 9, 2026
440530c
Fixed Lint Issues by removing trailing whitespace
Apr 9, 2026
40ed4cd
Fix Lint Issues by removing trailing whitespace
Apr 9, 2026
5f560fd
Fix Lint Issues by removing trailing whitespace
Apr 9, 2026
cc322d8
Fixed spacing in Doc/library/asyncio-future.rst
Apr 9, 2026
fa83911
Changed msg's explanation
Apr 9, 2026
3da4499
Changed msg's explanation and made it shorter
Apr 9, 2026
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
Removed docstring from Lib/asyncio/futures.py and added it in Doc/lib… 
…rary/asyncio-future.rst
  • Loading branch information
Manoj committed Apr 9, 2026
commit 98cd575646889a51136e10a9212161f5f32d601c
4 changes: 4 additions & 0 deletions Doc/library/asyncio-future.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,10 @@ Future Object
If the Future is already *done* or *cancelled*, return ``False``.
Otherwise, change the Future's state to *cancelled*,
schedule the callbacks, and return ``True``.

The optional argument *msg* is passed as the argument to the
:exc:`CancelledError` exception raised when a cancelled Future
is awaited. It can be any object.
Comment thread
kumaraditya303 marked this conversation as resolved.
Outdated

.. versionchanged:: 3.9
Added the *msg* parameter.
Expand Down
4 changes: 0 additions & 4 deletions Lib/asyncio/futures.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,10 +159,6 @@ def cancel(self, msg=None):
If the future is already done or cancelled, return False. Otherwise,
change the future's state to cancelled, schedule the callbacks and
return True.

The optional argument *msg* is passed as the argument to the
asyncio.CancelledError exception raised when a cancelled Future
is awaited. It can be any object.
"""
self.__log_traceback = False
if self._state != _PENDING:
Expand Down
Loading