projects / OpenSPARC-T2-SAM / blame
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / amd64 / html / python / api / iterator.html
CommitLineData
920dae64
AT		 1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html>
3<head>
4<link rel="STYLESHEET" href="api.css" type='text/css' />
5<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
6<link rel='start' href='../index.html' title='Python Documentation Index' />
7<link rel="first" href="api.html" title='Python/C API Reference Manual' />
8<link rel='contents' href='contents.html' title="Contents" />
9<link rel='index' href='genindex.html' title='Index' />
10<link rel='last' href='about.html' title='About this document...' />
11<link rel='help' href='about.html' title='About this document...' />
12<link rel="next" href="abstract-buffer.html" />
13<link rel="prev" href="mapping.html" />
14<link rel="parent" href="abstract.html" />
15<link rel="next" href="abstract-buffer.html" />
16<meta name='aesop' content='information' />
17<title>6.5 Iterator Protocol </title>
18</head>
19<body>
20<DIV CLASS="navigation">
21<div id='top-navigation-panel' xml:id='top-navigation-panel'>
22<table align="center" width="100%" cellpadding="0" cellspacing="2">
23<tr>
24<td class='online-navigation'><a rel="prev" title="6.4 Mapping Protocol"
25 href="mapping.html"><img src='../icons/previous.png'
26 border='0' height='32' alt='Previous Page' width='32' /></A></td>
27<td class='online-navigation'><a rel="parent" title="6. Abstract Objects Layer"
28 href="abstract.html"><img src='../icons/up.png'
29 border='0' height='32' alt='Up One Level' width='32' /></A></td>
30<td class='online-navigation'><a rel="next" title="6.6 Buffer Protocol"
31 href="abstract-buffer.html"><img src='../icons/next.png'
32 border='0' height='32' alt='Next Page' width='32' /></A></td>
33<td align="center" width="100%">Python/C API Reference Manual</td>
34<td class='online-navigation'><a rel="contents" title="Table of Contents"
35 href="contents.html"><img src='../icons/contents.png'
36 border='0' height='32' alt='Contents' width='32' /></A></td>
37<td class='online-navigation'><img src='../icons/blank.png'
38 border='0' height='32' alt='' width='32' /></td>
39<td class='online-navigation'><a rel="index" title="Index"
40 href="genindex.html"><img src='../icons/index.png'
41 border='0' height='32' alt='Index' width='32' /></A></td>
42</tr></table>
43<div class='online-navigation'>
44<b class="navlabel">Previous:</b>
45<a class="sectref" rel="prev" href="mapping.html">6.4 Mapping Protocol</A>
46<b class="navlabel">Up:</b>
47<a class="sectref" rel="parent" href="abstract.html">6. Abstract Objects Layer</A>
48<b class="navlabel">Next:</b>
49<a class="sectref" rel="next" href="abstract-buffer.html">6.6 Buffer Protocol</A>
50</div>
51<hr /></div>
52</DIV>
53<!--End of Navigation Panel-->
54
55<H1><A NAME="SECTION008500000000000000000"></A><A NAME="iterator"></A>
56<BR>
576.5 Iterator Protocol
58</H1>
59
60<P>
61
62<span class="versionnote">New in version 2.2.</span>
63
64<P>
65There are only a couple of functions specifically for working with
66iterators.
67
68<P>
69<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>int&nbsp;<b><tt id='l2h-346' xml:id='l2h-346' class="cfunction">PyIter_Check</tt></b>(</nobr></td><td>PyObject *<var>o</var>)</td></tr></table></dt>
70<dd>
71 Return true if the object <var>o</var> supports the iterator protocol.
72</dd></dl>
73
74<P>
75<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject*&nbsp;<b><tt id='l2h-347' xml:id='l2h-347' class="cfunction">PyIter_Next</tt></b>(</nobr></td><td>PyObject *<var>o</var>)</td></tr></table></dt>
76<dd>
77<div class="refcount-info">
78 <span class="label">Return value:</span>
79 <span class="value">New reference.</span>
80</div>
81 Return the next value from the iteration <var>o</var>. If the object is
82 an iterator, this retrieves the next value from the iteration, and
83 returns <tt class="constant">NULL</tt> with no exception set if there are no remaining
84 items. If the object is not an iterator, <tt class="exception">TypeError</tt> is
85 raised, or if there is an error in retrieving the item, returns
86 <tt class="constant">NULL</tt> and passes along the exception.
87</dd></dl>
88
89<P>
90To write a loop which iterates over an iterator, the C code should
91look something like this:
92
93<P>
94<div class="verbatim"><pre>
95PyObject *iterator = PyObject_GetIter(obj);
96PyObject *item;
97
98if (iterator == NULL) {
99 /* propagate error */
100}
101
102while (item = PyIter_Next(iterator)) {
103 /* do something with item */
104 ...
105 /* release reference when done */
106 Py_DECREF(item);
107}
108
109Py_DECREF(iterator);
110
111if (PyErr_Occurred()) {
112 /* propagate error */
113}
114else {
115 /* continue doing useful work */
116}
117</pre></div>
118
119<P>
120
121<DIV CLASS="navigation">
122<div class='online-navigation'>
123<p></p><hr />
124<table align="center" width="100%" cellpadding="0" cellspacing="2">
125<tr>
126<td class='online-navigation'><a rel="prev" title="6.4 Mapping Protocol"
127 href="mapping.html"><img src='../icons/previous.png'
128 border='0' height='32' alt='Previous Page' width='32' /></A></td>
129<td class='online-navigation'><a rel="parent" title="6. Abstract Objects Layer"
130 href="abstract.html"><img src='../icons/up.png'
131 border='0' height='32' alt='Up One Level' width='32' /></A></td>
132<td class='online-navigation'><a rel="next" title="6.6 Buffer Protocol"
133 href="abstract-buffer.html"><img src='../icons/next.png'
134 border='0' height='32' alt='Next Page' width='32' /></A></td>
135<td align="center" width="100%">Python/C API Reference Manual</td>
136<td class='online-navigation'><a rel="contents" title="Table of Contents"
137 href="contents.html"><img src='../icons/contents.png'
138 border='0' height='32' alt='Contents' width='32' /></A></td>
139<td class='online-navigation'><img src='../icons/blank.png'
140 border='0' height='32' alt='' width='32' /></td>
141<td class='online-navigation'><a rel="index" title="Index"
142 href="genindex.html"><img src='../icons/index.png'
143 border='0' height='32' alt='Index' width='32' /></A></td>
144</tr></table>
145<div class='online-navigation'>
146<b class="navlabel">Previous:</b>
147<a class="sectref" rel="prev" href="mapping.html">6.4 Mapping Protocol</A>
148<b class="navlabel">Up:</b>
149<a class="sectref" rel="parent" href="abstract.html">6. Abstract Objects Layer</A>
150<b class="navlabel">Next:</b>
151<a class="sectref" rel="next" href="abstract-buffer.html">6.6 Buffer Protocol</A>
152</div>
153</div>
154<hr />
155<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
156</DIV>
157<!--End of Navigation Panel-->
158<ADDRESS>
159See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
160</ADDRESS>
161</BODY>
162</HTML>
Full OpenSPARC architecture tarball including simulator, hypervisor, and OBP.