ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: usr / share / doc / python-docs-2.7.5 / html / _sources / c-api

.. 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.

.. c:var:: PyTypeObject PySeqIter_Type

Type object for iterator objects returned by :c:func:`PySeqIter_New` and the
   one-argument form of the :func:`iter` built-in function for built-in sequence
   types.

.. versionadded:: 2.2

.. c:function:: int PySeqIter_Check(op)

Return true if the type of *op* is :c:data:`PySeqIter_Type`.

.. versionadded:: 2.2

.. c:function:: 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.

.. versionadded:: 2.2

.. c:var:: PyTypeObject PyCallIter_Type

Type object for iterator objects returned by :c:func:`PyCallIter_New` and the
   two-argument form of the :func:`iter` built-in function.

.. versionadded:: 2.2

.. c:function:: int PyCallIter_Check(op)

Return true if the type of *op* is :c:data:`PyCallIter_Type`.

.. versionadded:: 2.2

.. c:function:: 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.

.. versionadded:: 2.2

[-] string.txt [edit]
[-] long.txt [edit]
[-] tuple.txt [edit]
[-] type.txt [edit]
[-] utilities.txt [edit]
[-] module.txt [edit]
[-] reflection.txt [edit]
[-] list.txt [edit]
[-] buffer.txt [edit]
[-] none.txt [edit]
[-] datetime.txt [edit]
[-] gcsupport.txt [edit]
[-] cobject.txt [edit]
[-] veryhigh.txt [edit]
[-] init.txt [edit]
[+] ..
[-] index.txt [edit]
[-] refcounting.txt [edit]
[-] gen.txt [edit]
[-] dict.txt [edit]
[-] sequence.txt [edit]
[-] weakref.txt [edit]
[-] set.txt [edit]
[-] int.txt [edit]
[-] class.txt [edit]
[-] float.txt [edit]
[-] objimpl.txt [edit]
[-] mapping.txt [edit]
[-] abstract.txt [edit]
[-] import.txt [edit]
[-] method.txt [edit]
[-] complex.txt [edit]
[-] concrete.txt [edit]
[-] iter.txt [edit]
[-] function.txt [edit]
[-] iterator.txt [edit]
[-] unicode.txt [edit]
[-] file.txt [edit]
[-] conversion.txt [edit]
[-] memory.txt [edit]
[-] bool.txt [edit]
[-] object.txt [edit]
[-] bytearray.txt [edit]
[-] marshal.txt [edit]
[-] slice.txt [edit]
[-] descriptor.txt [edit]
[-] arg.txt [edit]
[-] codec.txt [edit]
[-] code.txt [edit]
[-] cell.txt [edit]
[-] number.txt [edit]
[-] objbuffer.txt [edit]
[-] sys.txt [edit]
[-] typeobj.txt [edit]
[-] exceptions.txt [edit]
[-] intro.txt [edit]
[-] allocation.txt [edit]
[-] structures.txt [edit]
[-] capsule.txt [edit]