-
-
Notifications
You must be signed in to change notification settings - Fork 34.7k
gh-150831: clarify generator, generator function, and generator iterator in glossary #150905
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.
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
Open
Aniketsy
wants to merge
2
commits into
python:main
Choose a base branch
from
Aniketsy:fix-150831
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+22
−12
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -641,23 +641,33 @@ Glossary | |
| .. index:: single: generator | ||
|
|
||
| generator | ||
| A function which returns a :term:`generator iterator`. It looks like a | ||
| normal function except that it contains :keyword:`yield` expressions | ||
| for producing a series of values usable in a for-loop or that can be | ||
| retrieved one at a time with the :func:`next` function. | ||
| Informally used to mean either a :term:`generator function` or a | ||
| :term:`generator iterator`, depending on context. The formal terms | ||
| :term:`generator function` and :term:`generator iterator` are uncommon | ||
| in practice; "generator" alone is almost always sufficient. | ||
|
|
||
| .. index:: single: generator function | ||
|
|
||
| Usually refers to a generator function, but may refer to a | ||
| *generator iterator* in some contexts. In cases where the intended | ||
| meaning isn't clear, using the full terms avoids ambiguity. | ||
| generator function | ||
| A function which returns a :term:`generator` object. It looks like a | ||
| normal function except that it contains :keyword:`yield` expressions | ||
| for producing a series of values usable in a :keyword:`for`\-loop or | ||
| that can be retrieved one at a time with the :func:`next` function. | ||
| See :pep:`255`. | ||
|
|
||
| generator iterator | ||
| An object created by a :term:`generator` function. | ||
| An object created by a :term:`generator function` or a | ||
| :term:`generator expression`. | ||
|
|
||
| Each :keyword:`yield` temporarily suspends processing, remembering the | ||
| execution state (including local variables and pending | ||
| try-statements). When the *generator iterator* resumes, it picks up where | ||
| it left off (in contrast to functions which start fresh on every | ||
| invocation). | ||
| execution state (including local variables and pending try-statements). | ||
| When the *generator iterator* resumes, it picks up where it left off | ||
| (in contrast to functions which start fresh on every invocation). | ||
|
|
||
| Generator iterators also implement the :meth:`~generator.send` method | ||
| to send a value into the suspended generator, and the | ||
| :meth:`~generator.throw` method to raise an exception at the point | ||
| where the generator was paused. See :pep:`342`. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's find a reference in the docs to explain this instead of a PEP.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
|
||
| .. index:: single: generator expression | ||
|
|
||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd rather not refer people to PEPs, which are frozen historical records of the design. The docs explain how generator functions work here: https://docs.python.org/3/reference/expressions.html#yield-expressions
(I hope i have the right details of the reference.)