summaryrefslogtreecommitdiffstats
path: root/Doc/c-api/iterator.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/c-api/iterator.rst')
-rw-r--r--Doc/c-api/iterator.rst50
1 files changed, 50 insertions, 0 deletions
diff --git a/Doc/c-api/iterator.rst b/Doc/c-api/iterator.rst
new file mode 100644
index 0000000..8665080
--- /dev/null
+++ b/Doc/c-api/iterator.rst
@@ -0,0 +1,50 @@
+.. highlightlang:: c
+
+.. _iterator-objects:
+
+Iterator Objects
+----------------
+
+Python provides two general-purpose iterator objects. The first, a sequence
+iterator, works with an arbitrary sequence supporting the :meth:`__getitem__`
+method. The second works with a callable object and a sentinel value, calling
+the callable for each item in the sequence, and ending the iteration when the
+sentinel value is returned.
+
+
+.. cvar:: PyTypeObject PySeqIter_Type
+
+ Type object for iterator objects returned by :cfunc:`PySeqIter_New` and the
+ one-argument form of the :func:`iter` built-in function for built-in sequence
+ types.
+
+
+.. cfunction:: int PySeqIter_Check(op)
+
+ Return true if the type of *op* is :cdata:`PySeqIter_Type`.
+
+
+.. cfunction:: PyObject* PySeqIter_New(PyObject *seq)
+
+ Return an iterator that works with a general sequence object, *seq*. The
+ iteration ends when the sequence raises :exc:`IndexError` for the subscripting
+ operation.
+
+
+.. cvar:: PyTypeObject PyCallIter_Type
+
+ Type object for iterator objects returned by :cfunc:`PyCallIter_New` and the
+ two-argument form of the :func:`iter` built-in function.
+
+
+.. cfunction:: int PyCallIter_Check(op)
+
+ Return true if the type of *op* is :cdata:`PyCallIter_Type`.
+
+
+.. cfunction:: PyObject* PyCallIter_New(PyObject *callable, PyObject *sentinel)
+
+ Return a new iterator. The first parameter, *callable*, can be any Python
+ callable object that can be called with no parameters; each call to it should
+ return the next item in the iteration. When *callable* returns a value equal to
+ *sentinel*, the iteration will be terminated.