gh-121333: Clarify what is the default executor for asyncio.run_in_executor #121335
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aisk
requested review from
1st1,
asvetlov,
gvanrossum,
kumaraditya303 and
willingc
as code owners
bedevere-app
bot
added
docs
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
kumaraditya303
approved these changes
Jul 4, 2024
gvanrossum
reviewed
Jul 4, 2024
Doc/library/asyncio-eventloop.rst
Outdated
Comment on lines
1263
to
1265
| The *executor* argument should be an :class:`concurrent.futures.Executor` | ||
| instance. The default executor is used if *executor* is ``None``. | ||
| The *executor* argument should be a :class:`concurrent.futures.Executor` | ||
| instance. The default executor :class:`concurrent.futures.ThreadPoolExecutor` | ||
| is used if not set by :meth:`loop.set_default_executor`. |
There was a problem hiding this comment.
Sorry to butt in, but this is still pretty imprecise. First the executor argument may also be None. Second, the default executor is not just any ThreadPoolExecutor, it is the default executor of the event loop (loop), which is always a ThreadPoolExecutor. This may indeed be set using set_default_executor, otherwise it is "lazy-initialized" by run_in_executor if needed.
There was a problem hiding this comment.
Thanks for the review, how about this, regardless the format:
The *executor* argument should be a :class:`concurrent.futures.Executor`
instance. The default executor of the event loop is used if *executor* is ``None``.
The default executor can be set by :meth:`loop.set_default_executor`, otherwise,
a :class:`concurrent.futures.ThreadPoolExecutor` will be lazy-initialized by
:func:`run_in_executor` if needed.
kumaraditya303
approved these changes
Jul 9, 2024
kumaraditya303
added
needs backport to 3.12
|
Thanks @aisk for the PR, and @kumaraditya303 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12. |
|
Thanks @aisk for the PR, and @kumaraditya303 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jul 9, 2024
…_in_executor (pythonGH-121335) (cherry picked from commit facf986) Co-authored-by: AN Long <aisk@users.noreply.github.com> Co-authored-by: Kumar Aditya <kumaraditya@python.org>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jul 9, 2024
…_in_executor (pythonGH-121335) (cherry picked from commit facf986) Co-authored-by: AN Long <aisk@users.noreply.github.com> Co-authored-by: Kumar Aditya <kumaraditya@python.org>
|
GH-121525 is a backport of this pull request to the 3.12 branch. |
|
GH-121526 is a backport of this pull request to the 3.13 branch. |
noahbkim
pushed a commit
to hudson-trading/cpython
that referenced
this pull request
Jul 11, 2024
…_in_executor (python#121335) Co-authored-by: Kumar Aditya <kumaraditya@python.org>
estyxx
pushed a commit
to estyxx/cpython
that referenced
this pull request
Jul 17, 2024
…_in_executor (python#121335) Co-authored-by: Kumar Aditya <kumaraditya@python.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
asyncio.run_in_executor#121333📚 Documentation preview 📚: https://cpython-previews--121335.org.readthedocs.build/