11
11
gen_traverse(PyGenObject *gen, visitproc visit, void *arg)
13
Py_VISIT((PyObject *)gen->gi_frame);
14
Py_VISIT(gen->gi_code);
13
Py_VISIT((PyObject *)gen->gi_frame);
14
Py_VISIT(gen->gi_code);
19
19
gen_dealloc(PyGenObject *gen)
21
PyObject *self = (PyObject *) gen;
23
_PyObject_GC_UNTRACK(gen);
25
if (gen->gi_weakreflist != NULL)
26
PyObject_ClearWeakRefs(self);
28
_PyObject_GC_TRACK(self);
30
if (gen->gi_frame != NULL && gen->gi_frame->f_stacktop != NULL) {
31
/* Generator is paused, so we need to close */
32
Py_TYPE(gen)->tp_del(self);
33
if (self->ob_refcnt > 0)
34
return; /* resurrected. :( */
37
_PyObject_GC_UNTRACK(self);
38
Py_CLEAR(gen->gi_frame);
39
Py_CLEAR(gen->gi_code);
21
PyObject *self = (PyObject *) gen;
23
_PyObject_GC_UNTRACK(gen);
25
if (gen->gi_weakreflist != NULL)
26
PyObject_ClearWeakRefs(self);
28
_PyObject_GC_TRACK(self);
30
if (gen->gi_frame != NULL && gen->gi_frame->f_stacktop != NULL) {
31
/* Generator is paused, so we need to close */
32
Py_TYPE(gen)->tp_del(self);
33
if (self->ob_refcnt > 0)
34
return; /* resurrected. :( */
37
_PyObject_GC_UNTRACK(self);
38
Py_CLEAR(gen->gi_frame);
39
Py_CLEAR(gen->gi_code);
45
45
gen_send_ex(PyGenObject *gen, PyObject *arg, int exc)
47
PyThreadState *tstate = PyThreadState_GET();
48
PyFrameObject *f = gen->gi_frame;
51
if (gen->gi_running) {
52
PyErr_SetString(PyExc_ValueError,
53
"generator already executing");
56
if (f==NULL || f->f_stacktop == NULL) {
57
/* Only set exception if called from send() */
59
PyErr_SetNone(PyExc_StopIteration);
63
if (f->f_lasti == -1) {
64
if (arg && arg != Py_None) {
65
PyErr_SetString(PyExc_TypeError,
66
"can't send non-None value to a "
67
"just-started generator");
71
/* Push arg onto the frame's value stack */
72
result = arg ? arg : Py_None;
74
*(f->f_stacktop++) = result;
77
/* Generators always return to their most recent caller, not
78
* necessarily their creator. */
79
Py_XINCREF(tstate->frame);
80
assert(f->f_back == NULL);
81
f->f_back = tstate->frame;
84
result = PyEval_EvalFrameEx(f, exc);
87
/* Don't keep the reference to f_back any longer than necessary. It
88
* may keep a chain of frames alive or it could create a reference
90
assert(f->f_back == tstate->frame);
93
/* If the generator just returned (as opposed to yielding), signal
94
* that the generator is exhausted. */
95
if (result == Py_None && f->f_stacktop == NULL) {
98
/* Set exception if not called by gen_iternext() */
100
PyErr_SetNone(PyExc_StopIteration);
103
if (!result || f->f_stacktop == NULL) {
104
/* generator can't be rerun, so release the frame */
106
gen->gi_frame = NULL;
47
PyThreadState *tstate = PyThreadState_GET();
48
PyFrameObject *f = gen->gi_frame;
51
if (gen->gi_running) {
52
PyErr_SetString(PyExc_ValueError,
53
"generator already executing");
56
if (f==NULL || f->f_stacktop == NULL) {
57
/* Only set exception if called from send() */
59
PyErr_SetNone(PyExc_StopIteration);
63
if (f->f_lasti == -1) {
64
if (arg && arg != Py_None) {
65
PyErr_SetString(PyExc_TypeError,
66
"can't send non-None value to a "
67
"just-started generator");
71
/* Push arg onto the frame's value stack */
72
result = arg ? arg : Py_None;
74
*(f->f_stacktop++) = result;
77
/* Generators always return to their most recent caller, not
78
* necessarily their creator. */
79
Py_XINCREF(tstate->frame);
80
assert(f->f_back == NULL);
81
f->f_back = tstate->frame;
84
result = PyEval_EvalFrameEx(f, exc);
87
/* Don't keep the reference to f_back any longer than necessary. It
88
* may keep a chain of frames alive or it could create a reference
90
assert(f->f_back == tstate->frame);
93
/* If the generator just returned (as opposed to yielding), signal
94
* that the generator is exhausted. */
95
if (result == Py_None && f->f_stacktop == NULL) {
98
/* Set exception if not called by gen_iternext() */
100
PyErr_SetNone(PyExc_StopIteration);
103
if (!result || f->f_stacktop == NULL) {
104
/* generator can't be rerun, so release the frame */
106
gen->gi_frame = NULL;
112
112
PyDoc_STRVAR(send_doc,
125
125
static PyObject *
126
126
gen_close(PyGenObject *gen, PyObject *args)
129
PyErr_SetNone(PyExc_GeneratorExit);
130
retval = gen_send_ex(gen, Py_None, 1);
133
PyErr_SetString(PyExc_RuntimeError,
134
"generator ignored GeneratorExit");
137
if (PyErr_ExceptionMatches(PyExc_StopIteration)
138
|| PyErr_ExceptionMatches(PyExc_GeneratorExit))
140
PyErr_Clear(); /* ignore these errors */
129
PyErr_SetNone(PyExc_GeneratorExit);
130
retval = gen_send_ex(gen, Py_None, 1);
133
PyErr_SetString(PyExc_RuntimeError,
134
"generator ignored GeneratorExit");
137
if (PyErr_ExceptionMatches(PyExc_StopIteration)
138
|| PyErr_ExceptionMatches(PyExc_GeneratorExit))
140
PyErr_Clear(); /* ignore these errors */
148
148
gen_del(PyObject *self)
151
PyObject *error_type, *error_value, *error_traceback;
152
PyGenObject *gen = (PyGenObject *)self;
154
if (gen->gi_frame == NULL || gen->gi_frame->f_stacktop == NULL)
155
/* Generator isn't paused, so no need to close */
158
/* Temporarily resurrect the object. */
159
assert(self->ob_refcnt == 0);
162
/* Save the current exception, if any. */
163
PyErr_Fetch(&error_type, &error_value, &error_traceback);
165
res = gen_close(gen, NULL);
168
PyErr_WriteUnraisable(self);
172
/* Restore the saved exception. */
173
PyErr_Restore(error_type, error_value, error_traceback);
175
/* Undo the temporary resurrection; can't use DECREF here, it would
176
* cause a recursive call.
178
assert(self->ob_refcnt > 0);
179
if (--self->ob_refcnt == 0)
180
return; /* this is the normal path out */
182
/* close() resurrected it! Make it look like the original Py_DECREF
186
Py_ssize_t refcnt = self->ob_refcnt;
187
_Py_NewReference(self);
188
self->ob_refcnt = refcnt;
190
assert(PyType_IS_GC(self->ob_type) &&
191
_Py_AS_GC(self)->gc.gc_refs != _PyGC_REFS_UNTRACKED);
193
/* If Py_REF_DEBUG, _Py_NewReference bumped _Py_RefTotal, so
194
* we need to undo that. */
196
/* If Py_TRACE_REFS, _Py_NewReference re-added self to the object
197
* chain, so no more to do there.
198
* If COUNT_ALLOCS, the original decref bumped tp_frees, and
199
* _Py_NewReference bumped tp_allocs: both of those need to be
151
PyObject *error_type, *error_value, *error_traceback;
152
PyGenObject *gen = (PyGenObject *)self;
154
if (gen->gi_frame == NULL || gen->gi_frame->f_stacktop == NULL)
155
/* Generator isn't paused, so no need to close */
158
/* Temporarily resurrect the object. */
159
assert(self->ob_refcnt == 0);
162
/* Save the current exception, if any. */
163
PyErr_Fetch(&error_type, &error_value, &error_traceback);
165
res = gen_close(gen, NULL);
168
PyErr_WriteUnraisable(self);
172
/* Restore the saved exception. */
173
PyErr_Restore(error_type, error_value, error_traceback);
175
/* Undo the temporary resurrection; can't use DECREF here, it would
176
* cause a recursive call.
178
assert(self->ob_refcnt > 0);
179
if (--self->ob_refcnt == 0)
180
return; /* this is the normal path out */
182
/* close() resurrected it! Make it look like the original Py_DECREF
186
Py_ssize_t refcnt = self->ob_refcnt;
187
_Py_NewReference(self);
188
self->ob_refcnt = refcnt;
190
assert(PyType_IS_GC(self->ob_type) &&
191
_Py_AS_GC(self)->gc.gc_refs != _PyGC_REFS_UNTRACKED);
193
/* If Py_REF_DEBUG, _Py_NewReference bumped _Py_RefTotal, so
194
* we need to undo that. */
196
/* If Py_TRACE_REFS, _Py_NewReference re-added self to the object
197
* chain, so no more to do there.
198
* If COUNT_ALLOCS, the original decref bumped tp_frees, and
199
* _Py_NewReference bumped tp_allocs: both of those need to be
202
202
#ifdef COUNT_ALLOCS
203
--self->ob_type->tp_frees;
204
--self->ob_type->tp_allocs;
203
--self->ob_type->tp_frees;
204
--self->ob_type->tp_allocs;
214
214
static PyObject *
215
215
gen_throw(PyGenObject *gen, PyObject *args)
219
PyObject *val = NULL;
221
if (!PyArg_UnpackTuple(args, "throw", 1, 3, &typ, &val, &tb))
224
/* First, check the traceback argument, replacing None with
228
else if (tb != NULL && !PyTraceBack_Check(tb)) {
229
PyErr_SetString(PyExc_TypeError,
230
"throw() third argument must be a traceback object");
238
if (PyExceptionClass_Check(typ)) {
239
PyErr_NormalizeException(&typ, &val, &tb);
242
else if (PyExceptionInstance_Check(typ)) {
243
/* Raising an instance. The value should be a dummy. */
244
if (val && val != Py_None) {
245
PyErr_SetString(PyExc_TypeError,
246
"instance exception may not have a separate value");
250
/* Normalize to raise <class>, <instance> */
253
typ = PyExceptionInstance_Class(typ);
258
/* Not something you can raise. throw() fails. */
259
PyErr_Format(PyExc_TypeError,
260
"exceptions must be classes, or instances, not %s",
261
typ->ob_type->tp_name);
265
PyErr_Restore(typ, val, tb);
266
return gen_send_ex(gen, Py_None, 1);
219
PyObject *val = NULL;
221
if (!PyArg_UnpackTuple(args, "throw", 1, 3, &typ, &val, &tb))
224
/* First, check the traceback argument, replacing None with
228
else if (tb != NULL && !PyTraceBack_Check(tb)) {
229
PyErr_SetString(PyExc_TypeError,
230
"throw() third argument must be a traceback object");
238
if (PyExceptionClass_Check(typ)) {
239
PyErr_NormalizeException(&typ, &val, &tb);
242
else if (PyExceptionInstance_Check(typ)) {
243
/* Raising an instance. The value should be a dummy. */
244
if (val && val != Py_None) {
245
PyErr_SetString(PyExc_TypeError,
246
"instance exception may not have a separate value");
250
/* Normalize to raise <class>, <instance> */
253
typ = PyExceptionInstance_Class(typ);
258
/* Not something you can raise. throw() fails. */
259
PyErr_Format(PyExc_TypeError,
260
"exceptions must be classes, or instances, not %s",
261
typ->ob_type->tp_name);
265
PyErr_Restore(typ, val, tb);
266
return gen_send_ex(gen, Py_None, 1);
269
/* Didn't use our arguments, so restore their original refcounts */
269
/* Didn't use our arguments, so restore their original refcounts */
277
277
static PyObject *
278
278
gen_iternext(PyGenObject *gen)
280
return gen_send_ex(gen, NULL, 0);
280
return gen_send_ex(gen, NULL, 0);
284
284
static PyObject *
285
285
gen_repr(PyGenObject *gen)
288
code_name = PyString_AsString(((PyCodeObject *)gen->gi_code)->co_name);
289
if (code_name == NULL)
291
return PyString_FromFormat("<generator object %.200s at %p>",
288
code_name = PyString_AsString(((PyCodeObject *)gen->gi_code)->co_name);
289
if (code_name == NULL)
291
return PyString_FromFormat("<generator object %.200s at %p>",
296
296
static PyObject *
297
297
gen_get_name(PyGenObject *gen)
299
PyObject *name = ((PyCodeObject *)gen->gi_code)->co_name;
299
PyObject *name = ((PyCodeObject *)gen->gi_code)->co_name;
306
306
"Return the name of the generator's associated code object.");
308
308
static PyGetSetDef gen_getsetlist[] = {
309
{"__name__", (getter)gen_get_name, NULL, gen__name__doc__},
309
{"__name__", (getter)gen_get_name, NULL, gen__name__doc__},
314
314
static PyMemberDef gen_memberlist[] = {
315
{"gi_frame", T_OBJECT, offsetof(PyGenObject, gi_frame), RO},
316
{"gi_running", T_INT, offsetof(PyGenObject, gi_running), RO},
317
{"gi_code", T_OBJECT, offsetof(PyGenObject, gi_code), RO},
318
{NULL} /* Sentinel */
315
{"gi_frame", T_OBJECT, offsetof(PyGenObject, gi_frame), RO},
316
{"gi_running", T_INT, offsetof(PyGenObject, gi_running), RO},
317
{"gi_code", T_OBJECT, offsetof(PyGenObject, gi_code), RO},
318
{NULL} /* Sentinel */
321
321
static PyMethodDef gen_methods[] = {
322
{"send",(PyCFunction)gen_send, METH_O, send_doc},
323
{"throw",(PyCFunction)gen_throw, METH_VARARGS, throw_doc},
324
{"close",(PyCFunction)gen_close, METH_NOARGS, close_doc},
325
{NULL, NULL} /* Sentinel */
322
{"send",(PyCFunction)gen_send, METH_O, send_doc},
323
{"throw",(PyCFunction)gen_throw, METH_VARARGS, throw_doc},
324
{"close",(PyCFunction)gen_close, METH_NOARGS, close_doc},
325
{NULL, NULL} /* Sentinel */
328
328
PyTypeObject PyGen_Type = {
329
PyVarObject_HEAD_INIT(&PyType_Type, 0)
330
"generator", /* tp_name */
331
sizeof(PyGenObject), /* tp_basicsize */
334
(destructor)gen_dealloc, /* tp_dealloc */
339
(reprfunc)gen_repr, /* tp_repr */
340
0, /* tp_as_number */
341
0, /* tp_as_sequence */
342
0, /* tp_as_mapping */
346
PyObject_GenericGetAttr, /* tp_getattro */
348
0, /* tp_as_buffer */
349
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
351
(traverseproc)gen_traverse, /* tp_traverse */
353
0, /* tp_richcompare */
354
offsetof(PyGenObject, gi_weakreflist), /* tp_weaklistoffset */
355
PyObject_SelfIter, /* tp_iter */
356
(iternextfunc)gen_iternext, /* tp_iternext */
357
gen_methods, /* tp_methods */
358
gen_memberlist, /* tp_members */
359
gen_getsetlist, /* tp_getset */
329
PyVarObject_HEAD_INIT(&PyType_Type, 0)
330
"generator", /* tp_name */
331
sizeof(PyGenObject), /* tp_basicsize */
334
(destructor)gen_dealloc, /* tp_dealloc */
339
(reprfunc)gen_repr, /* tp_repr */
340
0, /* tp_as_number */
341
0, /* tp_as_sequence */
342
0, /* tp_as_mapping */
346
PyObject_GenericGetAttr, /* tp_getattro */
348
0, /* tp_as_buffer */
349
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
351
(traverseproc)gen_traverse, /* tp_traverse */
353
0, /* tp_richcompare */
354
offsetof(PyGenObject, gi_weakreflist), /* tp_weaklistoffset */
355
PyObject_SelfIter, /* tp_iter */
356
(iternextfunc)gen_iternext, /* tp_iternext */
357
gen_methods, /* tp_methods */
358
gen_memberlist, /* tp_members */
359
gen_getsetlist, /* tp_getset */
363
0, /* tp_descr_get */
364
0, /* tp_descr_set */
365
0, /* tp_dictoffset */
374
0, /* tp_subclasses */
376
gen_del, /* tp_del */
363
0, /* tp_descr_get */
364
0, /* tp_descr_set */
365
0, /* tp_dictoffset */
374
0, /* tp_subclasses */
376
gen_del, /* tp_del */
380
380
PyGen_New(PyFrameObject *f)
382
PyGenObject *gen = PyObject_GC_New(PyGenObject, &PyGen_Type);
388
Py_INCREF(f->f_code);
389
gen->gi_code = (PyObject *)(f->f_code);
391
gen->gi_weakreflist = NULL;
392
_PyObject_GC_TRACK(gen);
393
return (PyObject *)gen;
382
PyGenObject *gen = PyObject_GC_New(PyGenObject, &PyGen_Type);
388
Py_INCREF(f->f_code);
389
gen->gi_code = (PyObject *)(f->f_code);
391
gen->gi_weakreflist = NULL;
392
_PyObject_GC_TRACK(gen);
393
return (PyObject *)gen;
397
397
PyGen_NeedsFinalizing(PyGenObject *gen)
400
PyFrameObject *f = gen->gi_frame;
402
if (f == NULL || f->f_stacktop == NULL || f->f_iblock <= 0)
403
return 0; /* no frame or empty blockstack == no finalization */
405
/* Any block type besides a loop requires cleanup. */
408
if (f->f_blockstack[i].b_type != SETUP_LOOP)
412
/* No blocks except loops, it's safe to skip finalization. */
400
PyFrameObject *f = gen->gi_frame;
402
if (f == NULL || f->f_stacktop == NULL || f->f_iblock <= 0)
403
return 0; /* no frame or empty blockstack == no finalization */
405
/* Any block type besides a loop requires cleanup. */
408
if (f->f_blockstack[i].b_type != SETUP_LOOP)
412
/* No blocks except loops, it's safe to skip finalization. */