<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"api.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"api.html" title='Python/C API Reference Manual'
/>
<link rel='contents' href='contents.html'
title=
"Contents" />
<link rel='index' href='genindex.html' title='Index'
/>
<link rel='last' href='about.html' title='About this document...'
/>
<link rel='help' href='about.html' title='About this document...'
/>
<link rel=
"next" href=
"descriptor-objects.html" />
<link rel=
"prev" href=
"moduleObjects.html" />
<link rel=
"parent" href=
"otherObjects.html" />
<link rel=
"next" href=
"descriptor-objects.html" />
<meta name='aesop' content='information'
/>
<title>7.5.5 Iterator Objects
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"7.5.4 Module Objects"
href=
"moduleObjects.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"7.5 Other Objects"
href=
"otherObjects.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"7.5.6 Descriptor Objects"
href=
"descriptor-objects.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python/C API Reference Manual
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><img src='../icons/blank.png'
border='
0' height='
32' alt='' width='
32'
/></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"moduleObjects.html">7.5.4 Module Objects
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"otherObjects.html">7.5 Other Objects
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"descriptor-objects.html">7.5.6 Descriptor Objects
</A>
<!--End of Navigation Panel-->
<H2><A NAME=
"SECTION009550000000000000000"></A><A NAME=
"iterator-objects"></A>
Python provides two general-purpose iterator objects. The first, a
sequence iterator, works with an arbitrary sequence supporting the
<tt class=
"method">__getitem__()
</tt> 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
<dl><dt>PyTypeObject
<b><tt id='l2h-
697' xml:id='l2h-
697'
class=
"cdata">PySeqIter_Type
</tt></b></dt>
Type object for iterator objects returned by
<tt class=
"cfunction">PySeqIter_New()
</tt> and the one-argument form of the
<tt class=
"function">iter()
</tt> built-in function for built-in sequence types.
<span class=
"versionnote">New in version
2.2.
</span>
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline"><td><nobr>int
<b><tt id='l2h-
698' xml:id='l2h-
698'
class=
"cfunction">PySeqIter_Check
</tt></b>(
</nobr></td><td>op)
</td></tr></table></dt>
Return true if the type of
<var>op
</var> is
<tt class=
"cdata">PySeqIter_Type
</tt>.
<span class=
"versionnote">New in version
2.2.
</span>
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline"><td><nobr>PyObject*
<b><tt id='l2h-
699' xml:id='l2h-
699'
class=
"cfunction">PySeqIter_New
</tt></b>(
</nobr></td><td>PyObject *
<var>seq
</var>)
</td></tr></table></dt>
<div class=
"refcount-info">
<span class=
"label">Return value:
</span>
<span class=
"value">New reference.
</span>
Return an iterator that works with a general sequence object,
<var>seq
</var>. The iteration ends when the sequence raises
<tt class=
"exception">IndexError
</tt> for the subscripting operation.
<span class=
"versionnote">New in version
2.2.
</span>
<dl><dt>PyTypeObject
<b><tt id='l2h-
700' xml:id='l2h-
700'
class=
"cdata">PyCallIter_Type
</tt></b></dt>
Type object for iterator objects returned by
<tt class=
"cfunction">PyCallIter_New()
</tt> and the two-argument form of the
<tt class=
"function">iter()
</tt> built-in function.
<span class=
"versionnote">New in version
2.2.
</span>
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline"><td><nobr>int
<b><tt id='l2h-
701' xml:id='l2h-
701'
class=
"cfunction">PyCallIter_Check
</tt></b>(
</nobr></td><td>op)
</td></tr></table></dt>
Return true if the type of
<var>op
</var> is
<tt class=
"cdata">PyCallIter_Type
</tt>.
<span class=
"versionnote">New in version
2.2.
</span>
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline"><td><nobr>PyObject*
<b><tt id='l2h-
702' xml:id='l2h-
702'
class=
"cfunction">PyCallIter_New
</tt></b>(
</nobr></td><td>PyObject *
<var>callable
</var>,
PyObject *
<var>sentinel
</var>)
</td></tr></table></dt>
<div class=
"refcount-info">
<span class=
"label">Return value:
</span>
<span class=
"value">New reference.
</span>
Return a new iterator. The first parameter,
<var>callable
</var>, 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
<var>callable
</var> returns a value equal to
<var>sentinel
</var>, the
iteration will be terminated.
<span class=
"versionnote">New in version
2.2.
</span>
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"7.5.4 Module Objects"
href=
"moduleObjects.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"7.5 Other Objects"
href=
"otherObjects.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"7.5.6 Descriptor Objects"
href=
"descriptor-objects.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python/C API Reference Manual
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><img src='../icons/blank.png'
border='
0' height='
32' alt='' width='
32'
/></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"moduleObjects.html">7.5.4 Module Objects
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"otherObjects.html">7.5 Other Objects
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"descriptor-objects.html">7.5.6 Descriptor Objects
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.