gh-148091: asyncio : clarify Future.cancel(msg) behaviour by manoj-k-m · Pull Request #148248 · python/cpython

manoj-k-m · 2026-04-08T12:28:14Z

The msg parameter of Future.cancel() is currently undocumented.

This change clarifies that the optional msg argument is passed as the argument to asyncio.CancelledError raised when
a cancelled Future is awaited, and that it can be of any object.

Fixes #148091

Issue: Document how the msg parameter for asyncio.futures.Future.cancel is used #148091

skip news

bedevere-app · 2026-04-08T12:28:20Z

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

bedevere-app · 2026-04-08T12:33:54Z

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

bedevere-app · 2026-04-08T12:41:03Z

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

manoj-k-m · 2026-04-08T12:46:27Z

@bedevere-bot skip news

ZeroIntensity

Please update the asyncio documentation, not the docstring. We don't generate the documentation from docstrings.

bedevere-app · 2026-04-08T15:45:16Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

…rary/asyncio-future.rst

bedevere-app · 2026-04-09T00:02:17Z

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

bedevere-app · 2026-04-09T00:07:19Z

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

bedevere-app · 2026-04-09T00:10:18Z

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

bedevere-app · 2026-04-09T00:12:04Z

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

manoj-k-m · 2026-04-09T00:15:08Z

I have made the requested changes; please review again.

bedevere-app · 2026-04-09T00:15:14Z

Thanks for making the requested changes!

@ZeroIntensity: please review the changes made to this pull request.

Doc/library/asyncio-future.rst

miss-islington-app · 2026-04-09T14:11:36Z

Thanks @manoj-k-m for the PR, and @kumaraditya303 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

…GH-148248) (cherry picked from commit 2acb8d9257c4f5049777d9d462092373b0b3feca) Co-authored-by: Manoj K M <136242596+manoj-k-m@users.noreply.github.com>

bedevere-app · 2026-04-09T14:11:44Z

GH-148299 is a backport of this pull request to the 3.14 branch.

bedevere-app · 2026-04-09T14:11:49Z

GH-148300 is a backport of this pull request to the 3.13 branch.

…GH-148248) (cherry picked from commit 2acb8d9) Co-authored-by: Manoj K M <136242596+manoj-k-m@users.noreply.github.com>

…8248) (#148300) gh-148091: clarify asyncio.Future.cancel(msg) behaviour (GH-148248) (cherry picked from commit 2acb8d9) Co-authored-by: Manoj K M <136242596+manoj-k-m@users.noreply.github.com>

…8248) (#148299) gh-148091: clarify asyncio.Future.cancel(msg) behaviour (GH-148248) (cherry picked from commit 2acb8d9) Co-authored-by: Manoj K M <136242596+manoj-k-m@users.noreply.github.com>

asyncio : clarify Future.cancel(msg) behaviour

790d500

manoj-k-m requested review from 1st1, asvetlov, kumaraditya303 and willingc as code owners April 8, 2026 12:28

bedevere-app bot added the awaiting review label Apr 8, 2026

manoj-k-m changed the title ~~asyncio : clarify Future.cancel(msg) behaviour~~ gh-148091: asyncio : clarify Future.cancel(msg) behaviour Apr 8, 2026

bedevere-app bot mentioned this pull request Apr 8, 2026

Document how the msg parameter for asyncio.futures.Future.cancel is used #148091

Closed

fix lint: wrap doc line

60b2aed

fix lint : extra space after 'Future'

a670ced

ZeroIntensity requested changes Apr 8, 2026

View reviewed changes

bedevere-app bot added awaiting changes and removed awaiting review labels Apr 8, 2026

Removed docstring from Lib/asyncio/futures.py and added it in Doc/lib…

98cd575

…rary/asyncio-future.rst

Fixed Lint Issues by removing trailing whitespace

440530c

Fix Lint Issues by removing trailing whitespace

40ed4cd

Fix Lint Issues by removing trailing whitespace

5f560fd

bedevere-app bot added awaiting change review and removed awaiting changes labels Apr 9, 2026

bedevere-app bot requested a review from ZeroIntensity April 9, 2026 00:15

ZeroIntensity added docs Documentation in the Doc dir skip news needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Apr 9, 2026

github-project-automation bot added this to Docs PRs Apr 9, 2026

github-project-automation bot moved this to Todo in Docs PRs Apr 9, 2026

ZeroIntensity reviewed Apr 9, 2026

View reviewed changes

Doc/library/asyncio-future.rst Outdated Show resolved Hide resolved

Fixed spacing in Doc/library/asyncio-future.rst

cc322d8

kumaraditya303 reviewed Apr 9, 2026

View reviewed changes

Doc/library/asyncio-future.rst Outdated Show resolved Hide resolved

Changed msg's explanation

fa83911

kumaraditya303 reviewed Apr 9, 2026

View reviewed changes

Doc/library/asyncio-future.rst Outdated Show resolved Hide resolved

Changed msg's explanation and made it shorter

3da4499

kumaraditya303 approved these changes Apr 9, 2026

View reviewed changes

bedevere-app bot added awaiting merge and removed awaiting change review labels Apr 9, 2026

kumaraditya303 merged commit 2acb8d9 into python:main Apr 9, 2026
33 of 34 checks passed

github-project-automation bot moved this from Todo to Done in Docs PRs Apr 9, 2026

bedevere-app bot removed the awaiting merge label Apr 9, 2026

bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Apr 9, 2026

bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Apr 9, 2026

Uh oh!

Conversation

manoj-k-m commented Apr 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bedevere-app bot commented Apr 8, 2026

Uh oh!

bedevere-app bot commented Apr 8, 2026

Uh oh!

bedevere-app bot commented Apr 8, 2026

Uh oh!

manoj-k-m commented Apr 8, 2026

Uh oh!

ZeroIntensity left a comment

Choose a reason for hiding this comment

Uh oh!

bedevere-app bot commented Apr 8, 2026

Uh oh!

bedevere-app bot commented Apr 9, 2026

Uh oh!

bedevere-app bot commented Apr 9, 2026

Uh oh!

bedevere-app bot commented Apr 9, 2026

Uh oh!

bedevere-app bot commented Apr 9, 2026

Uh oh!

manoj-k-m commented Apr 9, 2026

Uh oh!

bedevere-app bot commented Apr 9, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

miss-islington-app bot commented Apr 9, 2026

Uh oh!

bedevere-app bot commented Apr 9, 2026

Uh oh!

bedevere-app bot commented Apr 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

manoj-k-m commented Apr 8, 2026 •

edited

Loading