Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1 | .. highlightlang:: c |
| 2 | |
| 3 | .. _iterator-objects: |
| 4 | |
| 5 | Iterator Objects |
| 6 | ---------------- |
| 7 | |
| 8 | Python provides two general-purpose iterator objects. The first, a sequence |
| 9 | iterator, works with an arbitrary sequence supporting the :meth:`__getitem__` |
| 10 | method. The second works with a callable object and a sentinel value, calling |
| 11 | the callable for each item in the sequence, and ending the iteration when the |
| 12 | sentinel value is returned. |
| 13 | |
| 14 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 15 | .. c:var:: PyTypeObject PySeqIter_Type |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 16 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 17 | Type object for iterator objects returned by :c:func:`PySeqIter_New` and the |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 18 | one-argument form of the :func:`iter` built-in function for built-in sequence |
| 19 | types. |
| 20 | |
| 21 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 22 | .. c:function:: int PySeqIter_Check(op) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 23 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 24 | Return true if the type of *op* is :c:data:`PySeqIter_Type`. |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 25 | |
| 26 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 27 | .. c:function:: PyObject* PySeqIter_New(PyObject *seq) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 28 | |
| 29 | Return an iterator that works with a general sequence object, *seq*. The |
| 30 | iteration ends when the sequence raises :exc:`IndexError` for the subscripting |
| 31 | operation. |
| 32 | |
| 33 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 34 | .. c:var:: PyTypeObject PyCallIter_Type |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 35 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 36 | Type object for iterator objects returned by :c:func:`PyCallIter_New` and the |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 37 | two-argument form of the :func:`iter` built-in function. |
| 38 | |
| 39 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 40 | .. c:function:: int PyCallIter_Check(op) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 41 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 42 | Return true if the type of *op* is :c:data:`PyCallIter_Type`. |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 43 | |
| 44 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 45 | .. c:function:: PyObject* PyCallIter_New(PyObject *callable, PyObject *sentinel) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 46 | |
| 47 | Return a new iterator. The first parameter, *callable*, can be any Python |
| 48 | callable object that can be called with no parameters; each call to it should |
| 49 | return the next item in the iteration. When *callable* returns a value equal to |
| 50 | *sentinel*, the iteration will be terminated. |