gh-114104: clarify asynchronous comprehension docs to match runtime behavior #121175
Conversation
This file contains 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
|
All commit authors signed the Contributor License Agreement. |
bedevere-app
bot
added
docs
hauntsaninja
pushed a commit
to python/mypy
that referenced
this pull request
Jun 30, 2024
Fixes #10534 This PR fixes a bug in typechecking asynchronous generators. Mypy currently typechecks a generator/comprehension as `AsyncGenerator` if the leftmost expression contains `await`, or if it contains an `async for`. However, there are other situations where we should get async generator: If there is an `await` expression in any of the conditions or in any sequence except for the leftmost one, the generator/comprehension should also be typechecked as `AsyncGenerator`. I've implemented this change in Mypy and added a test case to assert this behavior. If I enter the test cases into a regular repl, I can confirm that the runtime representation is generator/async_generator as the test case expects. According to the [language reference](https://docs.python.org/3/reference/expressions.html#grammar-token-python-grammar-comp_for): > If a comprehension contains either async for clauses or await expressions or other asynchronous comprehensions it is called an asynchronous comprehension. Confusingly, the documentation itself is actually not quite correct either, as pointed out in python/cpython#114104 Alongside this change, I've made a PR to update the docs to be more precise: python/cpython#121175 has more details.
hauntsaninja
approved these changes
Jun 30, 2024
|
Thanks for improving this and thanks for the mypy PR as well! |
Doc/reference/expressions.rst
Outdated
Comment on lines
223
to
224
| :keyword:`!await` expressions anywhere except the iterable expression in the leftmost | ||
| :keyword:`!for` clause, or other asynchronous comprehensions, it is called an |
There was a problem hiding this comment.
"except the iterable expression in the leftmost :keyword:!for clause" is also applied to "other asynchronous comprehensions".
For example:
(x for x in foo(y async for y in a))Here the "for x" comprehension expression is not asynchronous.
kumaraditya303
approved these changes
Jul 1, 2024
kumaraditya303
added
needs backport to 3.12
|
Thanks @yangdanny97 for the PR, and @kumaraditya303 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jul 1, 2024
…time behavior (pythonGH-121175) (cherry picked from commit 91313af) Co-authored-by: Danny Yang <yangdanny97@users.noreply.github.com>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jul 1, 2024
…time behavior (pythonGH-121175) (cherry picked from commit 91313af) Co-authored-by: Danny Yang <yangdanny97@users.noreply.github.com>
|
GH-121234 is a backport of this pull request to the 3.13 branch. |
|
GH-121235 is a backport of this pull request to the 3.12 branch. |
Akasurde
pushed a commit
to Akasurde/cpython
that referenced
this pull request
Jul 3, 2024
noahbkim
pushed a commit
to hudson-trading/cpython
that referenced
this pull request
Jul 11, 2024
estyxx
pushed a commit
to estyxx/cpython
that referenced
this pull request
Jul 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The documentation currently states:
According to the #114104,
awaitin the leftmost sequence of a comprehension does not make it an asynchronous comprehension, and the comments indicate that this is the intended behavior.This PR updates the documentation to reflect that.
awaitare compiled to async generators #114104📚 Documentation preview 📚: https://cpython-previews--121175.org.readthedocs.build/