Skip to content

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

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.

Sign up for GitHub

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

Merged
ZeroIntensity merged 8 commits into from
Nov 6, 2025
Merged

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

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ac588e5
Document missing built-in types in the C API.
ZeroIntensity Nov 4, 2025
37d4968
Use the existing iterator page instead of adding a new one.
ZeroIntensity Nov 4, 2025
5ca81a4
Document range objects as well.
ZeroIntensity Nov 4, 2025
9175dee
Fix failing build.
ZeroIntensity Nov 4, 2025
9eb029b
Remove iterator type documentation
ZeroIntensity Nov 5, 2025
0408148
Merge branch 'main' into document-missing-types
ZeroIntensity Nov 5, 2025
caa1f8f
Stupid trailing newline
ZeroIntensity Nov 5, 2025
a754636
Make a table.
ZeroIntensity Nov 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Document range objects as well.
  • Loading branch information
@ZeroIntensity
ZeroIntensity committed Nov 4, 2025
commit 5ca81a4fcad7e95085d624b18e4a0965d8afc701
29 changes: 28 additions & 1 deletion Doc/c-api/iterator.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,33 @@ sentinel value is returned.
*sentinel*, the iteration will be terminated.


.. _other-builtin-types:

.. _range-objects:
Range Objects
^^^^^^^^^^^^^

.. c:var:: PyTypeObject PyRange_Type

The type object for :class:`range` objects.


.. c:var:: PyTypeObject PyRangeIter_Type

The type object for iterators over :class:`range` objects.


.. c:var:: PyTypeObject PyLongRangeIter_Type

The type object for iterators over :class:`range` objects with large bounds.


Comment thread
ZeroIntensity marked this conversation as resolved.
Outdated
.. c:function:: int PyRange_Check(PyObject *o)

Return true if the object *o* is an instance of a :class:`range` object.
This function always succeeds.


.. _other-builtin-iterator-types:

Other Builtin Iterator Types
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -78,3 +104,4 @@ provide no additional functions. They are here for completeness.
.. c:var:: PyTypeObject PyZip_Type

The type object for :class:`zip` objects.

Loading