gh-141004: Document missing built-in iterator types in the C API #141006
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
ZeroIntensity
added
needs backport to 3.13
bedevere-app
bot
added
awaiting core review
docs
Member
|
I think all of the type objects should be soft-deprecated. They're not very useful, and making them public API makes it hard to convert them to heap types. Also, |
Member
Author
|
All the iterator type objects, or all the type objects in #141004?
Will do. |
ZeroIntensity
commented
Nov 5, 2025
encukou
approved these changes
Nov 6, 2025
Member
encukou
left a comment
encukou
left a comment
There was a problem hiding this comment.
Looks good!
Two things to consider, but if you like the current PR I'm happy with it too:
- a table like in https://docs.python.org/3/c-api/code.html#code-object-flags
- merging “Builtin Iterator Types” with the next section, as “Other Iterator Types”
Member
Author
|
I like the table idea a lot. I went with that. |
|
Thanks @ZeroIntensity for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Nov 6, 2025
…nGH-141006) Adds documentation for each of the following: - PyEnum_Type - PyFilter_Type - PyMap_Type - PyReversed_Type - PyZip_Type In addition, PyRange_Type and PyRange_Check are also documented. (cherry picked from commit 1697cb5) Co-authored-by: Peter Bierma <[email protected]>
|
GH-141134 is a backport of this pull request to the 3.14 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Nov 6, 2025
…nGH-141006) Adds documentation for each of the following: - PyEnum_Type - PyFilter_Type - PyMap_Type - PyReversed_Type - PyZip_Type In addition, PyRange_Type and PyRange_Check are also documented. (cherry picked from commit 1697cb5) Co-authored-by: Peter Bierma <[email protected]>
|
GH-141135 is a backport of this pull request to the 3.13 branch. |
ZeroIntensity
added a commit
that referenced
this pull request
Nov 6, 2025
…41006) (GH-141134) gh-141004: Document built-in iterator types in the C API (GH-141006) Adds documentation for each of the following: - PyEnum_Type - PyFilter_Type - PyMap_Type - PyReversed_Type - PyZip_Type In addition, PyRange_Type and PyRange_Check are also documented. (cherry picked from commit 1697cb5) Co-authored-by: Peter Bierma <[email protected]>
ZeroIntensity
added a commit
that referenced
this pull request
Nov 6, 2025
…41006) (GH-141135) gh-141004: Document built-in iterator types in the C API (GH-141006) Adds documentation for each of the following: - PyEnum_Type - PyFilter_Type - PyMap_Type - PyReversed_Type - PyZip_Type In addition, PyRange_Type and PyRange_Check are also documented. (cherry picked from commit 1697cb5) Co-authored-by: Peter Bierma <[email protected]>
StanFromIreland
pushed a commit
to StanFromIreland/cpython
that referenced
this pull request
Dec 6, 2025
…nGH-141006) Adds documentation for each of the following: - PyEnum_Type - PyFilter_Type - PyMap_Type - PyReversed_Type - PyZip_Type In addition, PyRange_Type and PyRange_Check are also documented.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
📚 Documentation preview 📚: https://cpython-previews--141006.org.readthedocs.build/en/141006/c-api/iterator.html