<!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=
"datetime-objects.html" />
<link rel=
"prev" href=
"cell-objects.html" />
<link rel=
"parent" href=
"otherObjects.html" />
<link rel=
"next" href=
"datetime-objects.html" />
<meta name='aesop' content='information'
/>
<title>7.5.11 Generator 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.10 Cell Objects"
href=
"cell-objects.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.12 DateTime Objects"
href=
"datetime-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=
"cell-objects.html">7.5.10 Cell 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=
"datetime-objects.html">7.5.12 DateTime Objects
</A>
<!--End of Navigation Panel-->
<H2><A NAME=
"SECTION0095110000000000000000"></A><A NAME=
"gen-objects"></A>
Generator objects are what Python uses to implement generator iterators.
They are normally created by iterating over a function that yields values,
rather than explicitly calling
<tt class=
"cfunction">PyGen_New
</tt>.
<dl><dt><b><tt class=
"ctype"><a id='l2h-
741' xml:id='l2h-
741'
>PyGenObject
</a></tt></b></dt>
The C structure used for generator objects.
<dl><dt>PyTypeObject
<b><tt id='l2h-
742' xml:id='l2h-
742'
class=
"cdata">PyGen_Type
</tt></b></dt>
The type object corresponding to generator objects
<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>
Return true if
<var>ob
</var> is a generator object;
<var>ob
</var> must not be
<tt class=
"constant">NULL
</tt>.
<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>
Return true if
<var>ob
</var>'s type is
<var>PyGen_Type
</var>
is a generator object;
<var>ob
</var> must not be
<tt class=
"constant">NULL
</tt>.
<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>
Create and return a new generator object based on the
<var>frame
</var> object.
The parameter must not be
<tt class=
"constant">NULL
</tt>.
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"7.5.10 Cell Objects"
href=
"cell-objects.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.12 DateTime Objects"
href=
"datetime-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=
"cell-objects.html">7.5.10 Cell 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=
"datetime-objects.html">7.5.12 DateTime 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.