Coverage Report

Created: 2025-07-04 06:49

/src/cpython/Objects/clinic/frameobject.c.h
Line
Count
Source (jump to first uncovered line)
1
/*[clinic input]
2
preserve
3
[clinic start generated code]*/
4
5
#include "pycore_critical_section.h"// Py_BEGIN_CRITICAL_SECTION()
6
7
PyDoc_STRVAR(frame_locals__doc__,
8
"Return the mapping used by the frame to look up local variables.");
9
#if defined(frame_locals_DOCSTR)
10
#   undef frame_locals_DOCSTR
11
#endif
12
#define frame_locals_DOCSTR frame_locals__doc__
13
14
#if !defined(frame_locals_DOCSTR)
15
#  define frame_locals_DOCSTR NULL
16
#endif
17
#if defined(FRAME_LOCALS_GETSETDEF)
18
#  undef FRAME_LOCALS_GETSETDEF
19
#  define FRAME_LOCALS_GETSETDEF {"f_locals", (getter)frame_locals_get, (setter)frame_locals_set, frame_locals_DOCSTR},
20
#else
21
#  define FRAME_LOCALS_GETSETDEF {"f_locals", (getter)frame_locals_get, NULL, frame_locals_DOCSTR},
22
#endif
23
24
static PyObject *
25
frame_locals_get_impl(PyFrameObject *self);
26
27
static PyObject *
28
frame_locals_get(PyObject *self, void *Py_UNUSED(context))
29
16
{
30
16
    PyObject *return_value = NULL;
31
32
16
    Py_BEGIN_CRITICAL_SECTION(self);
33
16
    return_value = frame_locals_get_impl((PyFrameObject *)self);
34
16
    Py_END_CRITICAL_SECTION();
35
36
16
    return return_value;
37
16
}
38
39
PyDoc_STRVAR(frame_lineno__doc__,
40
"Return the current line number in the frame.");
41
#if defined(frame_lineno_DOCSTR)
42
#   undef frame_lineno_DOCSTR
43
#endif
44
#define frame_lineno_DOCSTR frame_lineno__doc__
45
46
#if !defined(frame_lineno_DOCSTR)
47
#  define frame_lineno_DOCSTR NULL
48
#endif
49
#if defined(FRAME_LINENO_GETSETDEF)
50
#  undef FRAME_LINENO_GETSETDEF
51
#  define FRAME_LINENO_GETSETDEF {"f_lineno", (getter)frame_lineno_get, (setter)frame_lineno_set, frame_lineno_DOCSTR},
52
#else
53
#  define FRAME_LINENO_GETSETDEF {"f_lineno", (getter)frame_lineno_get, NULL, frame_lineno_DOCSTR},
54
#endif
55
56
static PyObject *
57
frame_lineno_get_impl(PyFrameObject *self);
58
59
static PyObject *
60
frame_lineno_get(PyObject *self, void *Py_UNUSED(context))
61
0
{
62
0
    PyObject *return_value = NULL;
63
64
0
    Py_BEGIN_CRITICAL_SECTION(self);
65
0
    return_value = frame_lineno_get_impl((PyFrameObject *)self);
66
0
    Py_END_CRITICAL_SECTION();
67
68
0
    return return_value;
69
0
}
70
71
PyDoc_STRVAR(frame_lasti__doc__,
72
"Return the index of the last attempted instruction in the frame.");
73
#if defined(frame_lasti_DOCSTR)
74
#   undef frame_lasti_DOCSTR
75
#endif
76
#define frame_lasti_DOCSTR frame_lasti__doc__
77
78
#if !defined(frame_lasti_DOCSTR)
79
#  define frame_lasti_DOCSTR NULL
80
#endif
81
#if defined(FRAME_LASTI_GETSETDEF)
82
#  undef FRAME_LASTI_GETSETDEF
83
#  define FRAME_LASTI_GETSETDEF {"f_lasti", (getter)frame_lasti_get, (setter)frame_lasti_set, frame_lasti_DOCSTR},
84
#else
85
#  define FRAME_LASTI_GETSETDEF {"f_lasti", (getter)frame_lasti_get, NULL, frame_lasti_DOCSTR},
86
#endif
87
88
static PyObject *
89
frame_lasti_get_impl(PyFrameObject *self);
90
91
static PyObject *
92
frame_lasti_get(PyObject *self, void *Py_UNUSED(context))
93
0
{
94
0
    PyObject *return_value = NULL;
95
96
0
    Py_BEGIN_CRITICAL_SECTION(self);
97
0
    return_value = frame_lasti_get_impl((PyFrameObject *)self);
98
0
    Py_END_CRITICAL_SECTION();
99
100
0
    return return_value;
101
0
}
102
103
PyDoc_STRVAR(frame_globals__doc__,
104
"Return the global variables in the frame.");
105
#if defined(frame_globals_DOCSTR)
106
#   undef frame_globals_DOCSTR
107
#endif
108
#define frame_globals_DOCSTR frame_globals__doc__
109
110
#if !defined(frame_globals_DOCSTR)
111
#  define frame_globals_DOCSTR NULL
112
#endif
113
#if defined(FRAME_GLOBALS_GETSETDEF)
114
#  undef FRAME_GLOBALS_GETSETDEF
115
#  define FRAME_GLOBALS_GETSETDEF {"f_globals", (getter)frame_globals_get, (setter)frame_globals_set, frame_globals_DOCSTR},
116
#else
117
#  define FRAME_GLOBALS_GETSETDEF {"f_globals", (getter)frame_globals_get, NULL, frame_globals_DOCSTR},
118
#endif
119
120
static PyObject *
121
frame_globals_get_impl(PyFrameObject *self);
122
123
static PyObject *
124
frame_globals_get(PyObject *self, void *Py_UNUSED(context))
125
0
{
126
0
    PyObject *return_value = NULL;
127
128
0
    Py_BEGIN_CRITICAL_SECTION(self);
129
0
    return_value = frame_globals_get_impl((PyFrameObject *)self);
130
0
    Py_END_CRITICAL_SECTION();
131
132
0
    return return_value;
133
0
}
134
135
PyDoc_STRVAR(frame_builtins__doc__,
136
"Return the built-in variables in the frame.");
137
#if defined(frame_builtins_DOCSTR)
138
#   undef frame_builtins_DOCSTR
139
#endif
140
#define frame_builtins_DOCSTR frame_builtins__doc__
141
142
#if !defined(frame_builtins_DOCSTR)
143
#  define frame_builtins_DOCSTR NULL
144
#endif
145
#if defined(FRAME_BUILTINS_GETSETDEF)
146
#  undef FRAME_BUILTINS_GETSETDEF
147
#  define FRAME_BUILTINS_GETSETDEF {"f_builtins", (getter)frame_builtins_get, (setter)frame_builtins_set, frame_builtins_DOCSTR},
148
#else
149
#  define FRAME_BUILTINS_GETSETDEF {"f_builtins", (getter)frame_builtins_get, NULL, frame_builtins_DOCSTR},
150
#endif
151
152
static PyObject *
153
frame_builtins_get_impl(PyFrameObject *self);
154
155
static PyObject *
156
frame_builtins_get(PyObject *self, void *Py_UNUSED(context))
157
0
{
158
0
    PyObject *return_value = NULL;
159
160
0
    Py_BEGIN_CRITICAL_SECTION(self);
161
0
    return_value = frame_builtins_get_impl((PyFrameObject *)self);
162
0
    Py_END_CRITICAL_SECTION();
163
164
0
    return return_value;
165
0
}
166
167
PyDoc_STRVAR(frame_code__doc__,
168
"Return the code object being executed in this frame.");
169
#if defined(frame_code_DOCSTR)
170
#   undef frame_code_DOCSTR
171
#endif
172
#define frame_code_DOCSTR frame_code__doc__
173
174
#if !defined(frame_code_DOCSTR)
175
#  define frame_code_DOCSTR NULL
176
#endif
177
#if defined(FRAME_CODE_GETSETDEF)
178
#  undef FRAME_CODE_GETSETDEF
179
#  define FRAME_CODE_GETSETDEF {"f_code", (getter)frame_code_get, (setter)frame_code_set, frame_code_DOCSTR},
180
#else
181
#  define FRAME_CODE_GETSETDEF {"f_code", (getter)frame_code_get, NULL, frame_code_DOCSTR},
182
#endif
183
184
static PyObject *
185
frame_code_get_impl(PyFrameObject *self);
186
187
static PyObject *
188
frame_code_get(PyObject *self, void *Py_UNUSED(context))
189
0
{
190
0
    return frame_code_get_impl((PyFrameObject *)self);
191
0
}
192
193
#if !defined(frame_back_DOCSTR)
194
#  define frame_back_DOCSTR NULL
195
#endif
196
#if defined(FRAME_BACK_GETSETDEF)
197
#  undef FRAME_BACK_GETSETDEF
198
#  define FRAME_BACK_GETSETDEF {"f_back", (getter)frame_back_get, (setter)frame_back_set, frame_back_DOCSTR},
199
#else
200
#  define FRAME_BACK_GETSETDEF {"f_back", (getter)frame_back_get, NULL, frame_back_DOCSTR},
201
#endif
202
203
static PyObject *
204
frame_back_get_impl(PyFrameObject *self);
205
206
static PyObject *
207
frame_back_get(PyObject *self, void *Py_UNUSED(context))
208
0
{
209
0
    PyObject *return_value = NULL;
210
211
0
    Py_BEGIN_CRITICAL_SECTION(self);
212
0
    return_value = frame_back_get_impl((PyFrameObject *)self);
213
0
    Py_END_CRITICAL_SECTION();
214
215
0
    return return_value;
216
0
}
217
218
PyDoc_STRVAR(frame_trace_opcodes__doc__,
219
"Return True if opcode tracing is enabled, False otherwise.");
220
#if defined(frame_trace_opcodes_DOCSTR)
221
#   undef frame_trace_opcodes_DOCSTR
222
#endif
223
#define frame_trace_opcodes_DOCSTR frame_trace_opcodes__doc__
224
225
#if !defined(frame_trace_opcodes_DOCSTR)
226
#  define frame_trace_opcodes_DOCSTR NULL
227
#endif
228
#if defined(FRAME_TRACE_OPCODES_GETSETDEF)
229
#  undef FRAME_TRACE_OPCODES_GETSETDEF
230
#  define FRAME_TRACE_OPCODES_GETSETDEF {"f_trace_opcodes", (getter)frame_trace_opcodes_get, (setter)frame_trace_opcodes_set, frame_trace_opcodes_DOCSTR},
231
#else
232
#  define FRAME_TRACE_OPCODES_GETSETDEF {"f_trace_opcodes", (getter)frame_trace_opcodes_get, NULL, frame_trace_opcodes_DOCSTR},
233
#endif
234
235
static PyObject *
236
frame_trace_opcodes_get_impl(PyFrameObject *self);
237
238
static PyObject *
239
frame_trace_opcodes_get(PyObject *self, void *Py_UNUSED(context))
240
0
{
241
0
    PyObject *return_value = NULL;
242
243
0
    Py_BEGIN_CRITICAL_SECTION(self);
244
0
    return_value = frame_trace_opcodes_get_impl((PyFrameObject *)self);
245
0
    Py_END_CRITICAL_SECTION();
246
247
0
    return return_value;
248
0
}
249
250
#if !defined(frame_trace_opcodes_DOCSTR)
251
#  define frame_trace_opcodes_DOCSTR NULL
252
#endif
253
#if defined(FRAME_TRACE_OPCODES_GETSETDEF)
254
#  undef FRAME_TRACE_OPCODES_GETSETDEF
255
#  define FRAME_TRACE_OPCODES_GETSETDEF {"f_trace_opcodes", (getter)frame_trace_opcodes_get, (setter)frame_trace_opcodes_set, frame_trace_opcodes_DOCSTR},
256
#else
257
#  define FRAME_TRACE_OPCODES_GETSETDEF {"f_trace_opcodes", NULL, (setter)frame_trace_opcodes_set, NULL},
258
#endif
259
260
static int
261
frame_trace_opcodes_set_impl(PyFrameObject *self, PyObject *value);
262
263
static int
264
frame_trace_opcodes_set(PyObject *self, PyObject *value, void *Py_UNUSED(context))
265
0
{
266
0
    int return_value;
267
268
0
    Py_BEGIN_CRITICAL_SECTION(self);
269
0
    return_value = frame_trace_opcodes_set_impl((PyFrameObject *)self, value);
270
0
    Py_END_CRITICAL_SECTION();
271
272
0
    return return_value;
273
0
}
274
275
#if !defined(frame_lineno_DOCSTR)
276
#  define frame_lineno_DOCSTR NULL
277
#endif
278
#if defined(FRAME_LINENO_GETSETDEF)
279
#  undef FRAME_LINENO_GETSETDEF
280
#  define FRAME_LINENO_GETSETDEF {"f_lineno", (getter)frame_lineno_get, (setter)frame_lineno_set, frame_lineno_DOCSTR},
281
#else
282
#  define FRAME_LINENO_GETSETDEF {"f_lineno", NULL, (setter)frame_lineno_set, NULL},
283
#endif
284
285
static int
286
frame_lineno_set_impl(PyFrameObject *self, PyObject *value);
287
288
static int
289
frame_lineno_set(PyObject *self, PyObject *value, void *Py_UNUSED(context))
290
0
{
291
0
    int return_value;
292
293
0
    Py_BEGIN_CRITICAL_SECTION(self);
294
0
    return_value = frame_lineno_set_impl((PyFrameObject *)self, value);
295
0
    Py_END_CRITICAL_SECTION();
296
297
0
    return return_value;
298
0
}
299
300
PyDoc_STRVAR(frame_trace__doc__,
301
"Return the trace function for this frame, or None if no trace function is set.");
302
#if defined(frame_trace_DOCSTR)
303
#   undef frame_trace_DOCSTR
304
#endif
305
#define frame_trace_DOCSTR frame_trace__doc__
306
307
#if !defined(frame_trace_DOCSTR)
308
#  define frame_trace_DOCSTR NULL
309
#endif
310
#if defined(FRAME_TRACE_GETSETDEF)
311
#  undef FRAME_TRACE_GETSETDEF
312
#  define FRAME_TRACE_GETSETDEF {"f_trace", (getter)frame_trace_get, (setter)frame_trace_set, frame_trace_DOCSTR},
313
#else
314
#  define FRAME_TRACE_GETSETDEF {"f_trace", (getter)frame_trace_get, NULL, frame_trace_DOCSTR},
315
#endif
316
317
static PyObject *
318
frame_trace_get_impl(PyFrameObject *self);
319
320
static PyObject *
321
frame_trace_get(PyObject *self, void *Py_UNUSED(context))
322
0
{
323
0
    PyObject *return_value = NULL;
324
325
0
    Py_BEGIN_CRITICAL_SECTION(self);
326
0
    return_value = frame_trace_get_impl((PyFrameObject *)self);
327
0
    Py_END_CRITICAL_SECTION();
328
329
0
    return return_value;
330
0
}
331
332
#if !defined(frame_trace_DOCSTR)
333
#  define frame_trace_DOCSTR NULL
334
#endif
335
#if defined(FRAME_TRACE_GETSETDEF)
336
#  undef FRAME_TRACE_GETSETDEF
337
#  define FRAME_TRACE_GETSETDEF {"f_trace", (getter)frame_trace_get, (setter)frame_trace_set, frame_trace_DOCSTR},
338
#else
339
#  define FRAME_TRACE_GETSETDEF {"f_trace", NULL, (setter)frame_trace_set, NULL},
340
#endif
341
342
static int
343
frame_trace_set_impl(PyFrameObject *self, PyObject *value);
344
345
static int
346
frame_trace_set(PyObject *self, PyObject *value, void *Py_UNUSED(context))
347
0
{
348
0
    int return_value;
349
350
0
    Py_BEGIN_CRITICAL_SECTION(self);
351
0
    return_value = frame_trace_set_impl((PyFrameObject *)self, value);
352
0
    Py_END_CRITICAL_SECTION();
353
354
0
    return return_value;
355
0
}
356
357
PyDoc_STRVAR(frame_generator__doc__,
358
"Return the generator or coroutine associated with this frame, or None.");
359
#if defined(frame_generator_DOCSTR)
360
#   undef frame_generator_DOCSTR
361
#endif
362
#define frame_generator_DOCSTR frame_generator__doc__
363
364
#if !defined(frame_generator_DOCSTR)
365
#  define frame_generator_DOCSTR NULL
366
#endif
367
#if defined(FRAME_GENERATOR_GETSETDEF)
368
#  undef FRAME_GENERATOR_GETSETDEF
369
#  define FRAME_GENERATOR_GETSETDEF {"f_generator", (getter)frame_generator_get, (setter)frame_generator_set, frame_generator_DOCSTR},
370
#else
371
#  define FRAME_GENERATOR_GETSETDEF {"f_generator", (getter)frame_generator_get, NULL, frame_generator_DOCSTR},
372
#endif
373
374
static PyObject *
375
frame_generator_get_impl(PyFrameObject *self);
376
377
static PyObject *
378
frame_generator_get(PyObject *self, void *Py_UNUSED(context))
379
0
{
380
0
    PyObject *return_value = NULL;
381
382
0
    Py_BEGIN_CRITICAL_SECTION(self);
383
0
    return_value = frame_generator_get_impl((PyFrameObject *)self);
384
0
    Py_END_CRITICAL_SECTION();
385
386
0
    return return_value;
387
0
}
388
389
PyDoc_STRVAR(frame_clear__doc__,
390
"clear($self, /)\n"
391
"--\n"
392
"\n"
393
"Clear all references held by the frame.");
394
395
#define FRAME_CLEAR_METHODDEF    \
396
    {"clear", (PyCFunction)frame_clear, METH_NOARGS, frame_clear__doc__},
397
398
static PyObject *
399
frame_clear_impl(PyFrameObject *self);
400
401
static PyObject *
402
frame_clear(PyObject *self, PyObject *Py_UNUSED(ignored))
403
0
{
404
0
    PyObject *return_value = NULL;
405
406
0
    Py_BEGIN_CRITICAL_SECTION(self);
407
0
    return_value = frame_clear_impl((PyFrameObject *)self);
408
0
    Py_END_CRITICAL_SECTION();
409
410
0
    return return_value;
411
0
}
412
413
PyDoc_STRVAR(frame___sizeof____doc__,
414
"__sizeof__($self, /)\n"
415
"--\n"
416
"\n"
417
"Return the size of the frame in memory, in bytes.");
418
419
#define FRAME___SIZEOF___METHODDEF    \
420
    {"__sizeof__", (PyCFunction)frame___sizeof__, METH_NOARGS, frame___sizeof____doc__},
421
422
static PyObject *
423
frame___sizeof___impl(PyFrameObject *self);
424
425
static PyObject *
426
frame___sizeof__(PyObject *self, PyObject *Py_UNUSED(ignored))
427
0
{
428
0
    PyObject *return_value = NULL;
429
430
0
    Py_BEGIN_CRITICAL_SECTION(self);
431
0
    return_value = frame___sizeof___impl((PyFrameObject *)self);
432
0
    Py_END_CRITICAL_SECTION();
433
434
0
    return return_value;
435
0
}
436
/*[clinic end generated code: output=74abf652547c0c11 input=a9049054013a1b77]*/