Commit | Line | Data |
---|---|---|
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="datetime-objects.html" /> | |
13 | <link rel="prev" href="cell-objects.html" /> | |
14 | <link rel="parent" href="otherObjects.html" /> | |
15 | <link rel="next" href="datetime-objects.html" /> | |
16 | <meta name='aesop' content='information' /> | |
17 | <title>7.5.11 Generator Objects </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="7.5.10 Cell Objects" | |
25 | href="cell-objects.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="7.5 Other Objects" | |
28 | href="otherObjects.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="7.5.12 DateTime Objects" | |
31 | href="datetime-objects.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="cell-objects.html">7.5.10 Cell Objects</A> | |
46 | <b class="navlabel">Up:</b> | |
47 | <a class="sectref" rel="parent" href="otherObjects.html">7.5 Other Objects</A> | |
48 | <b class="navlabel">Next:</b> | |
49 | <a class="sectref" rel="next" href="datetime-objects.html">7.5.12 DateTime Objects</A> | |
50 | </div> | |
51 | <hr /></div> | |
52 | </DIV> | |
53 | <!--End of Navigation Panel--> | |
54 | ||
55 | <H2><A NAME="SECTION0095110000000000000000"></A><A NAME="gen-objects"></A> | |
56 | <BR> | |
57 | 7.5.11 Generator Objects | |
58 | </H2> | |
59 | ||
60 | <P> | |
61 | Generator objects are what Python uses to implement generator iterators. | |
62 | They are normally created by iterating over a function that yields values, | |
63 | rather than explicitly calling <tt class="cfunction">PyGen_New</tt>. | |
64 | ||
65 | <P> | |
66 | <dl><dt><b><tt class="ctype"><a id='l2h-741' xml:id='l2h-741'>PyGenObject</a></tt></b></dt> | |
67 | <dd> | |
68 | The C structure used for generator objects. | |
69 | </dl> | |
70 | ||
71 | <P> | |
72 | <dl><dt>PyTypeObject <b><tt id='l2h-742' xml:id='l2h-742' class="cdata">PyGen_Type</tt></b></dt> | |
73 | <dd> | |
74 | The type object corresponding to generator objects | |
75 | </dd></dl> | |
76 | ||
77 | <P> | |
78 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>int <b><tt id='l2h-743' xml:id='l2h-743' class="cfunction">PyGen_Check</tt></b>(</nobr></td><td>ob)</td></tr></table></dt> | |
79 | <dd> | |
80 | Return true if <var>ob</var> is a generator object; <var>ob</var> must not be | |
81 | <tt class="constant">NULL</tt>. | |
82 | </dd></dl> | |
83 | ||
84 | <P> | |
85 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>int <b><tt id='l2h-744' xml:id='l2h-744' class="cfunction">PyGen_CheckExact</tt></b>(</nobr></td><td>ob)</td></tr></table></dt> | |
86 | <dd> | |
87 | Return true if <var>ob</var>'s type is <var>PyGen_Type</var> | |
88 | is a generator object; <var>ob</var> must not be | |
89 | <tt class="constant">NULL</tt>. | |
90 | </dd></dl> | |
91 | ||
92 | <P> | |
93 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-745' xml:id='l2h-745' class="cfunction">PyGen_New</tt></b>(</nobr></td><td>PyFrameObject *<var>frame</var>)</td></tr></table></dt> | |
94 | <dd> | |
95 | Create and return a new generator object based on the <var>frame</var> object. | |
96 | The parameter must not be <tt class="constant">NULL</tt>. | |
97 | </dd></dl> | |
98 | ||
99 | <P> | |
100 | ||
101 | <DIV CLASS="navigation"> | |
102 | <div class='online-navigation'> | |
103 | <p></p><hr /> | |
104 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
105 | <tr> | |
106 | <td class='online-navigation'><a rel="prev" title="7.5.10 Cell Objects" | |
107 | href="cell-objects.html"><img src='../icons/previous.png' | |
108 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
109 | <td class='online-navigation'><a rel="parent" title="7.5 Other Objects" | |
110 | href="otherObjects.html"><img src='../icons/up.png' | |
111 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
112 | <td class='online-navigation'><a rel="next" title="7.5.12 DateTime Objects" | |
113 | href="datetime-objects.html"><img src='../icons/next.png' | |
114 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
115 | <td align="center" width="100%">Python/C API Reference Manual</td> | |
116 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
117 | href="contents.html"><img src='../icons/contents.png' | |
118 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
119 | <td class='online-navigation'><img src='../icons/blank.png' | |
120 | border='0' height='32' alt='' width='32' /></td> | |
121 | <td class='online-navigation'><a rel="index" title="Index" | |
122 | href="genindex.html"><img src='../icons/index.png' | |
123 | border='0' height='32' alt='Index' width='32' /></A></td> | |
124 | </tr></table> | |
125 | <div class='online-navigation'> | |
126 | <b class="navlabel">Previous:</b> | |
127 | <a class="sectref" rel="prev" href="cell-objects.html">7.5.10 Cell Objects</A> | |
128 | <b class="navlabel">Up:</b> | |
129 | <a class="sectref" rel="parent" href="otherObjects.html">7.5 Other Objects</A> | |
130 | <b class="navlabel">Next:</b> | |
131 | <a class="sectref" rel="next" href="datetime-objects.html">7.5.12 DateTime Objects</A> | |
132 | </div> | |
133 | </div> | |
134 | <hr /> | |
135 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> | |
136 | </DIV> | |
137 | <!--End of Navigation Panel--> | |
138 | <ADDRESS> | |
139 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. | |
140 | </ADDRESS> | |
141 | </BODY> | |
142 | </HTML> |