From 754bbf7a25a8dda49b5d08ef0d0443bbf5af0e36 Mon Sep 17 00:00:00 2001 From: Craig Jennings Date: Sun, 7 Apr 2024 13:41:34 -0500 Subject: new repository --- devdocs/python~3.12/c-api%2Fiterator.html | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 devdocs/python~3.12/c-api%2Fiterator.html (limited to 'devdocs/python~3.12/c-api%2Fiterator.html') diff --git a/devdocs/python~3.12/c-api%2Fiterator.html b/devdocs/python~3.12/c-api%2Fiterator.html new file mode 100644 index 00000000..abe6b2e0 --- /dev/null +++ b/devdocs/python~3.12/c-api%2Fiterator.html @@ -0,0 +1,24 @@ +

Iterator Objects

Python provides two general-purpose iterator objects. The first, a sequence iterator, works with an arbitrary sequence supporting the __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.

+PyTypeObject PySeqIter_Type
+ Part of the Stable ABI.

Type object for iterator objects returned by PySeqIter_New() and the one-argument form of the iter() built-in function for built-in sequence types.

+
+int PySeqIter_Check(PyObject *op)
+

Return true if the type of op is PySeqIter_Type. This function always succeeds.

+
+PyObject *PySeqIter_New(PyObject *seq)
+Return value: New reference. Part of the Stable ABI.

Return an iterator that works with a general sequence object, seq. The iteration ends when the sequence raises IndexError for the subscripting operation.

+
+PyTypeObject PyCallIter_Type
+ Part of the Stable ABI.

Type object for iterator objects returned by PyCallIter_New() and the two-argument form of the iter() built-in function.

+
+int PyCallIter_Check(PyObject *op)
+

Return true if the type of op is PyCallIter_Type. This function always succeeds.

+
+PyObject *PyCallIter_New(PyObject *callable, PyObject *sentinel)
+Return value: New reference. Part of the Stable ABI.

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.

+
+

+ © 2001–2023 Python Software Foundation
Licensed under the PSF License.
+ https://docs.python.org/3.12/c-api/iterator.html +

+
-- cgit v1.2.3