gh-141004: Document remaining iterator types#141010

ZeroIntensity

Issue: Document the entire C API #141004

📚 Documentation preview 📚: https://cpython-previews--141010.org.readthedocs.build/en/141010/c-api/iterator.html#other-iterator-objects

Co-authored-by: Petr Viktorin <encukou@gmail.com>

miss-islington-app

Thanks @ZeroIntensity for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

…GH-141010) Add documentation for each of the following: - PyByteArrayIter_Type - PyBytesIter_Type - PyListIter_Type - PyListRevIter_Type - PySetIter_Type - PyTupleIter_Type - PyRangeIter_Type - PyLongRangeIter_Type - PyDictIterKey_Type - PyDictRevIterKey_Type - PyDictIterValue_Type - PyDictRevIterValue_Type - PyDictIterItem_Type - PyDictRevIterItem_Type --------- (cherry picked from commit 35528fc) Co-authored-by: Peter Bierma <zintensitydev@gmail.com> Co-authored-by: Petr Viktorin <encukou@gmail.com>

bedevere-app

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

…GH-141010) Add documentation for each of the following: - PyByteArrayIter_Type - PyBytesIter_Type - PyListIter_Type - PyListRevIter_Type - PySetIter_Type - PyTupleIter_Type - PyRangeIter_Type - PyLongRangeIter_Type - PyDictIterKey_Type - PyDictRevIterKey_Type - PyDictIterValue_Type - PyDictRevIterValue_Type - PyDictIterItem_Type - PyDictRevIterItem_Type --------- (cherry picked from commit 35528fc) Co-authored-by: Peter Bierma <zintensitydev@gmail.com> Co-authored-by: Petr Viktorin <encukou@gmail.com>

bedevere-app

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

…1010) (GH-141046) gh-141004: Document missing iterator types in the C API (GH-141010) Add documentation for each of the following: - PyByteArrayIter_Type - PyBytesIter_Type - PyListIter_Type - PyListRevIter_Type - PySetIter_Type - PyTupleIter_Type - PyRangeIter_Type - PyLongRangeIter_Type - PyDictIterKey_Type - PyDictRevIterKey_Type - PyDictIterValue_Type - PyDictRevIterValue_Type - PyDictIterItem_Type - PyDictRevIterItem_Type --------- (cherry picked from commit 35528fc) Co-authored-by: Peter Bierma <zintensitydev@gmail.com> Co-authored-by: Petr Viktorin <encukou@gmail.com>

…1010) (GH-141047) gh-141004: Document missing iterator types in the C API (GH-141010) Add documentation for each of the following: - PyByteArrayIter_Type - PyBytesIter_Type - PyListIter_Type - PyListRevIter_Type - PySetIter_Type - PyTupleIter_Type - PyRangeIter_Type - PyLongRangeIter_Type - PyDictIterKey_Type - PyDictRevIterKey_Type - PyDictIterValue_Type - PyDictRevIterValue_Type - PyDictIterItem_Type - PyDictRevIterItem_Type --------- (cherry picked from commit 35528fc) Co-authored-by: Peter Bierma <zintensitydev@gmail.com> Co-authored-by: Petr Viktorin <encukou@gmail.com>

bedevere-bot

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot ARM64 MacOS M1 Refleaks NoGIL 3.13 (tier-2) has failed when building commit a3756c6.

What do you need to do:

Don't panic.
Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
Go to the page of the buildbot that failed (https://buildbot.python.org/#/builders/1396/builds/1732) and take a look at the build logs.
Check if the failure is related to this commit (a3756c6) or if it is a false positive.
If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/#/builders/1396/builds/1732

Failed tests:

test.test_multiprocessing_forkserver.test_processes

Failed subtests:

test_repr_rlock - test.test_multiprocessing_forkserver.test_processes.WithProcessesTestLock.test_repr_rlock
test_sock_client_racing - test.test_asyncio.test_sock_lowlevel.SelectEventLoopTests.test_sock_client_racing

Test leaking resources:

test_sock_lowlevel: memory blocks

Summary of the results of the build (if available):

==

Click to see traceback logs

Traceback (most recent call last):
  File "/Users/buildbot/buildarea/3.13.itamaro-macos-arm64-aws.macos-with-brew.refleak.nogil/build/Lib/test/test_asyncio/test_sock_lowlevel.py", line 273, in test_sock_client_racing
    self.loop.run_until_complete(asyncio.wait_for(
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^
        self._basetest_sock_send_racing(listener, sock), 10))
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/buildbot/buildarea/3.13.itamaro-macos-arm64-aws.macos-with-brew.refleak.nogil/build/Lib/asyncio/base_events.py", line 725, in run_until_complete
    return future.result()
           ~~~~~~~~~~~~~^^
  File "/Users/buildbot/buildarea/3.13.itamaro-macos-arm64-aws.macos-with-brew.refleak.nogil/build/Lib/asyncio/tasks.py", line 507, in wait_for
    return await fut
           ^^^^^^^^^
  File "/Users/buildbot/buildarea/3.13.itamaro-macos-arm64-aws.macos-with-brew.refleak.nogil/build/Lib/test/test_asyncio/test_sock_lowlevel.py", line 196, in _basetest_sock_send_racing
    sock.send(b' ' * size)
    ~~~~~~~~~^^^^^^^^^^^^^
ConnectionResetError: [Errno 54] Connection reset by peer


Traceback (most recent call last):
  File "/Users/buildbot/buildarea/3.13.itamaro-macos-arm64-aws.macos-with-brew.refleak.nogil/build/Lib/test/_test_multiprocessing.py", line 1492, in test_repr_rlock
    self.assertEqual('<RLock(SomeOtherThread, nonzero)>', repr(lock))
    ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
AssertionError: '<RLock(SomeOtherThread, nonzero)>' != '<RLock(None, 0)>'
- <RLock(SomeOtherThread, nonzero)>
+ <RLock(None, 0)>

…GH-141010) Add documentation for each of the following: - PyByteArrayIter_Type - PyBytesIter_Type - PyListIter_Type - PyListRevIter_Type - PySetIter_Type - PyTupleIter_Type - PyRangeIter_Type - PyLongRangeIter_Type - PyDictIterKey_Type - PyDictRevIterKey_Type - PyDictIterValue_Type - PyDictRevIterValue_Type - PyDictIterItem_Type - PyDictRevIterItem_Type --------- Co-authored-by: Petr Viktorin <encukou@gmail.com>

Document PyByteArrayIter_Type

cadfc16

Document PyBytesIter_Type

e4b2dad

Fix missing s.

2902970

Document PyListIter_Type, PyListRevIter_Type

8d63104

bedevere-app Bot added awaiting core review docs Documentation in the Doc dir skip news labels Nov 4, 2025

ZeroIntensity added needs backport to 3.13 bugs and security fixes needs backport to 3.14 and removed docs Documentation in the Doc dir awaiting core review skip news labels Nov 4, 2025

bedevere-app Bot mentioned this pull request Nov 4, 2025

Document the entire C API #141004

Open

ZeroIntensity added docs Documentation in the Doc dir awaiting core review skip news labels Nov 4, 2025

github-project-automation Bot added this to Docs PRs Nov 4, 2025

github-project-automation Bot moved this to Todo in Docs PRs Nov 4, 2025

ZeroIntensity added 2 commits November 4, 2025 12:45

Document PySetIter_Type

c8fb023

Document PyTupleIter_Type

1c2797f

ZeroIntensity changed the title ~~gh-141004: Document remaining missing iterator types~~ Nov 4, 2025

encukou reviewed Nov 4, 2025

View reviewed changes

ZeroIntensity and others added 2 commits November 5, 2025 07:07

Don't expose implementation details. …

0d06cce

Co-authored-by: Petr Viktorin <encukou@gmail.com>

Fix newline thingy.

69e4976

encukou approved these changes Nov 5, 2025

View reviewed changes

bedevere-app Bot added awaiting merge and removed awaiting core review labels Nov 5, 2025

Update Doc/c-api/iterator.rst …

b2bc1d9

Co-authored-by: Petr Viktorin <encukou@gmail.com>

ZeroIntensity deleted the document-missing-iterators branch November 5, 2025 14:13

github-project-automation Bot moved this from Todo to Done in Docs PRs Nov 5, 2025

bedevere-app Bot removed the awaiting merge label Nov 5, 2025

bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Nov 5, 2025

bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Nov 5, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gh-141004: Document remaining iterator types#141010

gh-141004: Document remaining iterator types#141010
ZeroIntensity merged 9 commits into
python:mainfrom
ZeroIntensity:document-missing-iterators

ZeroIntensity commented Nov 4, 2025 •

edited

Loading

Uh oh!

Uh oh!

miss-islington-app Bot commented Nov 5, 2025

Uh oh!

bedevere-app Bot commented Nov 5, 2025

Uh oh!

bedevere-app Bot commented Nov 5, 2025

Uh oh!

bedevere-bot commented Nov 5, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

ZeroIntensity commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

miss-islington-app Bot commented Nov 5, 2025

Uh oh!

bedevere-app Bot commented Nov 5, 2025

Uh oh!

bedevere-app Bot commented Nov 5, 2025

Uh oh!

bedevere-bot commented Nov 5, 2025

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ZeroIntensity commented Nov 4, 2025 •

edited

Loading