python / python/cpython

concurrent.futures.Future.add_done_callback: calling thread description error.

Open
#122,676 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

asyncio.run_coroutine_threadsafe will return a concurrent.futures.Future.
And according to its doc concurrent.futures.Future.add_done_callback() :

Added callables are called in the order that they were added and are always ** called in a thread belonging to the process that added them. **

But acually, the callback is called in where Future.set_result() is called according to its source.

Linked PRs
  • gh-122678

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the concurrent.futures.Future.add_done_callback() documentation and the behavior reached through asyncio.run_coroutine_threadsafe; compare the wording with the Future.set_result() source path. Done means the documentation accurately describes the thread in which callbacks run, with the existing linked PR considered before making changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.