diff options
| author | Craig Jennings <c@cjennings.net> | 2024-04-07 13:41:34 -0500 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2024-04-07 13:41:34 -0500 |
| commit | 754bbf7a25a8dda49b5d08ef0d0443bbf5af0e36 (patch) | |
| tree | f1190704f78f04a2b0b4c977d20fe96a828377f1 /devdocs/python~3.12/c-api%2Fgen.html | |
new repository
Diffstat (limited to 'devdocs/python~3.12/c-api%2Fgen.html')
| -rw-r--r-- | devdocs/python~3.12/c-api%2Fgen.html | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/devdocs/python~3.12/c-api%2Fgen.html b/devdocs/python~3.12/c-api%2Fgen.html new file mode 100644 index 00000000..e345d932 --- /dev/null +++ b/devdocs/python~3.12/c-api%2Fgen.html @@ -0,0 +1,24 @@ + <span id="gen-objects"></span><h1>Generator Objects</h1> <p>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 <a class="reference internal" href="#c.PyGen_New" title="PyGen_New"><code>PyGen_New()</code></a> or <a class="reference internal" href="#c.PyGen_NewWithQualName" title="PyGen_NewWithQualName"><code>PyGen_NewWithQualName()</code></a>.</p> <dl class="c type"> <dt class="sig sig-object c" id="c.PyGenObject"> +<code>type PyGenObject</code> </dt> <dd> +<p>The C structure used for generator objects.</p> </dd> +</dl> <dl class="c var"> <dt class="sig sig-object c" id="c.PyGen_Type"> +<code>PyTypeObject PyGen_Type</code> </dt> <dd> +<p>The type object corresponding to generator objects.</p> </dd> +</dl> <dl class="c function"> <dt class="sig sig-object c" id="c.PyGen_Check"> +<code>int PyGen_Check(PyObject *ob)</code> </dt> <dd> +<p>Return true if <em>ob</em> is a generator object; <em>ob</em> must not be <code>NULL</code>. This function always succeeds.</p> </dd> +</dl> <dl class="c function"> <dt class="sig sig-object c" id="c.PyGen_CheckExact"> +<code>int PyGen_CheckExact(PyObject *ob)</code> </dt> <dd> +<p>Return true if <em>ob</em>’s type is <a class="reference internal" href="#c.PyGen_Type" title="PyGen_Type"><code>PyGen_Type</code></a>; <em>ob</em> must not be <code>NULL</code>. This function always succeeds.</p> </dd> +</dl> <dl class="c function"> <dt class="sig sig-object c" id="c.PyGen_New"> +<code>PyObject *PyGen_New(PyFrameObject *frame)</code> </dt> <dd> +<em class="refcount">Return value: New reference.</em><p>Create and return a new generator object based on the <em>frame</em> object. A reference to <em>frame</em> is stolen by this function. The argument must not be <code>NULL</code>.</p> </dd> +</dl> <dl class="c function"> <dt class="sig sig-object c" id="c.PyGen_NewWithQualName"> +<code>PyObject *PyGen_NewWithQualName(PyFrameObject *frame, PyObject *name, PyObject *qualname)</code> </dt> <dd> +<em class="refcount">Return value: New reference.</em><p>Create and return a new generator object based on the <em>frame</em> object, with <code>__name__</code> and <code>__qualname__</code> set to <em>name</em> and <em>qualname</em>. A reference to <em>frame</em> is stolen by this function. The <em>frame</em> argument must not be <code>NULL</code>.</p> </dd> +</dl> <div class="_attribution"> + <p class="_attribution-p"> + © 2001–2023 Python Software Foundation<br>Licensed under the PSF License.<br> + <a href="https://docs.python.org/3.12/c-api/gen.html" class="_attribution-link">https://docs.python.org/3.12/c-api/gen.html</a> + </p> +</div> |