FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-141004: Document missing built-in iterator types in the C API by ZeroIntensity · Pull Request #141006 · python/cpython · GitHub

/ cpython Public

gh-141004: Document missing built-in iterator types in the C API - #141006

Merged
ZeroIntensity merged 8 commits into
python:mainfrom
ZeroIntensity:document-missing-types
Nov 6, 2025
ConversationCommits (8)ChecksFiles changed
Merged

gh-141004: Document missing built-in iterator types in the C API#141006
ZeroIntensity merged 8 commits into
python:mainfrom
ZeroIntensity:document-missing-types

Conversation

ZeroIntensity commented Nov 4, 2025 •
edited
Loading

Copy link
Copy Markdown
Member

ZeroIntensity added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Nov 4, 2025
bedevere-app Bot added awaiting core review docs Documentation in the Doc dir skip news labels Nov 4, 2025
github-project-automation Bot moved this to Todo in Docs PRs Nov 4, 2025
bedevere-app Bot mentioned this pull request Nov 4, 2025
Open

encukou commented Nov 4, 2025

Copy link
Copy Markdown
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, PyRangeIter_Type/PyLongRangeIter_Type exposes too much an implementation detail.
Could you check with the C API WG?

ZeroIntensity commented Nov 4, 2025

Copy link
Copy Markdown
Member Author

All the iterator type objects, or all the type objects in #141004?

Could you check with the C API WG?

Will do.

ZeroIntensity commented Nov 5, 2025
View reviewed changes
Comment thread Doc/c-api/iterator.rst Outdated
encukou approved these changes Nov 6, 2025
View reviewed changes

encukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Looks good!
Two things to consider, but if you like the current PR I'm happy with it too:

ZeroIntensity commented Nov 6, 2025

Copy link
Copy Markdown
Member Author

I like the table idea a lot. I went with that.

ZeroIntensity merged commit 1697cb5 into python:main Nov 6, 2025
28 checks passed
ZeroIntensity deleted the document-missing-types branch November 6, 2025 12:29
github-project-automation Bot moved this from Todo to Done in Docs PRs Nov 6, 2025

miss-islington-app Bot commented Nov 6, 2025

Copy link
Copy Markdown

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
pythongh-141004: Document built-in iterator types in the C API (pytho…
9670901 
…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 <zintensitydev@gmail.com>

bedevere-app Bot commented Nov 6, 2025

Copy link
Copy Markdown

GH-141134 is a backport of this pull request to the 3.14 branch.

bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Nov 6, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 6, 2025
pythongh-141004: Document built-in iterator types in the C API (pytho…
2d19841 
…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 <zintensitydev@gmail.com>

bedevere-app Bot commented Nov 6, 2025

Copy link
Copy Markdown

GH-141135 is a backport of this pull request to the 3.13 branch.

bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Nov 6, 2025
ZeroIntensity added a commit that referenced this pull request Nov 6, 2025
[3.14] gh-141004: Document built-in iterator types in the C API (GH-1…
cd5508d 
…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 <zintensitydev@gmail.com>
ZeroIntensity added a commit that referenced this pull request Nov 6, 2025
[3.13] gh-141004: Document built-in iterator types in the C API (GH-1…
a8cd8f0 
…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 <zintensitydev@gmail.com>
StanFromIreland pushed a commit to StanFromIreland/cpython that referenced this pull request Dec 6, 2025
pythongh-141004: Document built-in iterator types in the C API (pytho…
9b3cde2 
…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.
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

encukou encukou approved these changes

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

Back | FazBrowse Home | New Git URL