summaryrefslogtreecommitdiff
path: root/Doc/c-api/gen.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/c-api/gen.rst')
-rw-r--r--Doc/c-api/gen.rst38
1 files changed, 38 insertions, 0 deletions
diff --git a/Doc/c-api/gen.rst b/Doc/c-api/gen.rst
new file mode 100644
index 0000000000..0d3789a25f
--- /dev/null
+++ b/Doc/c-api/gen.rst
@@ -0,0 +1,38 @@
+.. highlightlang:: c
+
+.. _gen-objects:
+
+Generator Objects
+-----------------
+
+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 :cfunc:`PyGen_New`.
+
+
+.. ctype:: PyGenObject
+
+ The C structure used for generator objects.
+
+
+.. cvar:: PyTypeObject PyGen_Type
+
+ The type object corresponding to generator objects
+
+
+.. cfunction:: int PyGen_Check(ob)
+
+ Return true if *ob* is a generator object; *ob* must not be *NULL*.
+
+
+.. cfunction:: int PyGen_CheckExact(ob)
+
+ Return true if *ob*'s type is *PyGen_Type* is a generator object; *ob* must not
+ be *NULL*.
+
+
+.. cfunction:: PyObject* PyGen_New(PyFrameObject *frame)
+
+ Create and return a new generator object based on the *frame* object. A
+ reference to *frame* is stolen by this function. The parameter must not be
+ *NULL*.