blob: 62d7fbebf40d59b9ffcb4f373e6efdf092d3ea13 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Benjamin Peterson722954a2011-06-11 16:33:35 -05002/* Generic object operations; and implementation of None */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004#include "Python.h"
Eric Snow2ebc5ce2017-09-07 23:51:28 -06005#include "internal/pystate.h"
Benjamin Petersonfd838e62009-04-20 02:09:13 +00006#include "frameobject.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00007
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00008#ifdef __cplusplus
9extern "C" {
10#endif
11
Victor Stinnerbd303c12013-11-07 23:07:29 +010012_Py_IDENTIFIER(Py_Repr);
13_Py_IDENTIFIER(__bytes__);
14_Py_IDENTIFIER(__dir__);
15_Py_IDENTIFIER(__isabstractmethod__);
16_Py_IDENTIFIER(builtins);
17
Tim Peters34592512002-07-11 06:23:50 +000018#ifdef Py_REF_DEBUG
Neal Norwitz84632ee2006-03-04 20:00:59 +000019Py_ssize_t _Py_RefTotal;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000020
21Py_ssize_t
22_Py_GetRefTotal(void)
23{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000024 PyObject *o;
25 Py_ssize_t total = _Py_RefTotal;
Antoine Pitrou9d952542013-08-24 21:07:07 +020026 o = _PySet_Dummy;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000027 if (o != NULL)
28 total -= o->ob_refcnt;
29 return total;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000030}
Nick Coghland6009512014-11-20 21:39:37 +100031
32void
33_PyDebug_PrintTotalRefs(void) {
Eric Snowdae02762017-09-14 00:35:58 -070034 fprintf(stderr,
35 "[%" PY_FORMAT_SIZE_T "d refs, "
36 "%" PY_FORMAT_SIZE_T "d blocks]\n",
37 _Py_GetRefTotal(), _Py_GetAllocatedBlocks());
Nick Coghland6009512014-11-20 21:39:37 +100038}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000039#endif /* Py_REF_DEBUG */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000040
Guido van Rossum3f5da241990-12-20 15:06:42 +000041/* Object allocation routines used by NEWOBJ and NEWVAROBJ macros.
42 These are used by the individual routines for object creation.
43 Do not call them otherwise, they do not initialize the object! */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000044
Tim Peters78be7992003-03-23 02:51:01 +000045#ifdef Py_TRACE_REFS
Tim Peters7571a0f2003-03-23 17:52:28 +000046/* Head of circular doubly-linked list of all objects. These are linked
47 * together via the _ob_prev and _ob_next members of a PyObject, which
48 * exist only in a Py_TRACE_REFS build.
49 */
Tim Peters78be7992003-03-23 02:51:01 +000050static PyObject refchain = {&refchain, &refchain};
Tim Peters36eb4df2003-03-23 03:33:13 +000051
Tim Peters7571a0f2003-03-23 17:52:28 +000052/* Insert op at the front of the list of all objects. If force is true,
53 * op is added even if _ob_prev and _ob_next are non-NULL already. If
54 * force is false amd _ob_prev or _ob_next are non-NULL, do nothing.
55 * force should be true if and only if op points to freshly allocated,
56 * uninitialized memory, or you've unlinked op from the list and are
Tim Peters51f8d382003-03-23 18:06:08 +000057 * relinking it into the front.
Tim Peters7571a0f2003-03-23 17:52:28 +000058 * Note that objects are normally added to the list via _Py_NewReference,
59 * which is called by PyObject_Init. Not all objects are initialized that
60 * way, though; exceptions include statically allocated type objects, and
61 * statically allocated singletons (like Py_True and Py_None).
62 */
Tim Peters36eb4df2003-03-23 03:33:13 +000063void
Tim Peters7571a0f2003-03-23 17:52:28 +000064_Py_AddToAllObjects(PyObject *op, int force)
Tim Peters36eb4df2003-03-23 03:33:13 +000065{
Tim Peters7571a0f2003-03-23 17:52:28 +000066#ifdef Py_DEBUG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000067 if (!force) {
68 /* If it's initialized memory, op must be in or out of
69 * the list unambiguously.
70 */
71 assert((op->_ob_prev == NULL) == (op->_ob_next == NULL));
72 }
Tim Peters78be7992003-03-23 02:51:01 +000073#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000074 if (force || op->_ob_prev == NULL) {
75 op->_ob_next = refchain._ob_next;
76 op->_ob_prev = &refchain;
77 refchain._ob_next->_ob_prev = op;
78 refchain._ob_next = op;
79 }
Tim Peters7571a0f2003-03-23 17:52:28 +000080}
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000081#endif /* Py_TRACE_REFS */
Tim Peters78be7992003-03-23 02:51:01 +000082
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000083#ifdef COUNT_ALLOCS
Guido van Rossumc0b618a1997-05-02 03:12:38 +000084static PyTypeObject *type_list;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000085/* All types are added to type_list, at least when
86 they get one object created. That makes them
87 immortal, which unfortunately contributes to
88 garbage itself. If unlist_types_without_objects
89 is set, they will be removed from the type_list
90 once the last object is deallocated. */
Benjamin Petersona4a37fe2009-01-11 17:13:55 +000091static int unlist_types_without_objects;
92extern Py_ssize_t tuple_zero_allocs, fast_tuple_allocs;
93extern Py_ssize_t quick_int_allocs, quick_neg_int_allocs;
94extern Py_ssize_t null_strings, one_strings;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000095void
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000096dump_counts(FILE* f)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000097{
Victor Stinner25420fe2017-11-20 18:12:22 -080098 PyInterpreterState *interp = PyThreadState_GET()->interp;
99 if (!inter->core_config.show_alloc_count) {
Serhiy Storchaka7e160ce2016-07-03 21:03:53 +0300100 return;
Victor Stinner25420fe2017-11-20 18:12:22 -0800101 }
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000103 for (tp = type_list; tp; tp = tp->tp_next)
104 fprintf(f, "%s alloc'd: %" PY_FORMAT_SIZE_T "d, "
105 "freed: %" PY_FORMAT_SIZE_T "d, "
106 "max in use: %" PY_FORMAT_SIZE_T "d\n",
107 tp->tp_name, tp->tp_allocs, tp->tp_frees,
108 tp->tp_maxalloc);
109 fprintf(f, "fast tuple allocs: %" PY_FORMAT_SIZE_T "d, "
110 "empty: %" PY_FORMAT_SIZE_T "d\n",
111 fast_tuple_allocs, tuple_zero_allocs);
112 fprintf(f, "fast int allocs: pos: %" PY_FORMAT_SIZE_T "d, "
113 "neg: %" PY_FORMAT_SIZE_T "d\n",
114 quick_int_allocs, quick_neg_int_allocs);
115 fprintf(f, "null strings: %" PY_FORMAT_SIZE_T "d, "
116 "1-strings: %" PY_FORMAT_SIZE_T "d\n",
117 null_strings, one_strings);
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000118}
119
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000120PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000121get_counts(void)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000122{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000123 PyTypeObject *tp;
124 PyObject *result;
125 PyObject *v;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000126
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000127 result = PyList_New(0);
128 if (result == NULL)
129 return NULL;
130 for (tp = type_list; tp; tp = tp->tp_next) {
131 v = Py_BuildValue("(snnn)", tp->tp_name, tp->tp_allocs,
132 tp->tp_frees, tp->tp_maxalloc);
133 if (v == NULL) {
134 Py_DECREF(result);
135 return NULL;
136 }
137 if (PyList_Append(result, v) < 0) {
138 Py_DECREF(v);
139 Py_DECREF(result);
140 return NULL;
141 }
142 Py_DECREF(v);
143 }
144 return result;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000145}
146
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000147void
Fred Drake100814d2000-07-09 15:48:49 +0000148inc_count(PyTypeObject *tp)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000149{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000150 if (tp->tp_next == NULL && tp->tp_prev == NULL) {
151 /* first time; insert in linked list */
152 if (tp->tp_next != NULL) /* sanity check */
153 Py_FatalError("XXX inc_count sanity check");
154 if (type_list)
155 type_list->tp_prev = tp;
156 tp->tp_next = type_list;
157 /* Note that as of Python 2.2, heap-allocated type objects
158 * can go away, but this code requires that they stay alive
159 * until program exit. That's why we're careful with
160 * refcounts here. type_list gets a new reference to tp,
161 * while ownership of the reference type_list used to hold
162 * (if any) was transferred to tp->tp_next in the line above.
163 * tp is thus effectively immortal after this.
164 */
165 Py_INCREF(tp);
166 type_list = tp;
Tim Peters3e40c7f2003-03-23 03:04:32 +0000167#ifdef Py_TRACE_REFS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000168 /* Also insert in the doubly-linked list of all objects,
169 * if not already there.
170 */
171 _Py_AddToAllObjects((PyObject *)tp, 0);
Tim Peters78be7992003-03-23 02:51:01 +0000172#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000173 }
174 tp->tp_allocs++;
175 if (tp->tp_allocs - tp->tp_frees > tp->tp_maxalloc)
176 tp->tp_maxalloc = tp->tp_allocs - tp->tp_frees;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000177}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000178
179void dec_count(PyTypeObject *tp)
180{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000181 tp->tp_frees++;
182 if (unlist_types_without_objects &&
183 tp->tp_allocs == tp->tp_frees) {
184 /* unlink the type from type_list */
185 if (tp->tp_prev)
186 tp->tp_prev->tp_next = tp->tp_next;
187 else
188 type_list = tp->tp_next;
189 if (tp->tp_next)
190 tp->tp_next->tp_prev = tp->tp_prev;
191 tp->tp_next = tp->tp_prev = NULL;
192 Py_DECREF(tp);
193 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000194}
195
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000196#endif
197
Tim Peters7c321a82002-07-09 02:57:01 +0000198#ifdef Py_REF_DEBUG
199/* Log a fatal error; doesn't return. */
200void
201_Py_NegativeRefcount(const char *fname, int lineno, PyObject *op)
202{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000203 char buf[300];
Tim Peters7c321a82002-07-09 02:57:01 +0000204
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000205 PyOS_snprintf(buf, sizeof(buf),
206 "%s:%i object at %p has negative ref count "
207 "%" PY_FORMAT_SIZE_T "d",
208 fname, lineno, op, op->ob_refcnt);
209 Py_FatalError(buf);
Tim Peters7c321a82002-07-09 02:57:01 +0000210}
211
212#endif /* Py_REF_DEBUG */
213
Thomas Heller1328b522004-04-22 17:23:49 +0000214void
215Py_IncRef(PyObject *o)
216{
217 Py_XINCREF(o);
218}
219
220void
221Py_DecRef(PyObject *o)
222{
223 Py_XDECREF(o);
224}
225
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000226PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000227PyObject_Init(PyObject *op, PyTypeObject *tp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000228{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000229 if (op == NULL)
230 return PyErr_NoMemory();
231 /* Any changes should be reflected in PyObject_INIT (objimpl.h) */
232 Py_TYPE(op) = tp;
233 _Py_NewReference(op);
234 return op;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000235}
236
Guido van Rossumb18618d2000-05-03 23:44:39 +0000237PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000238PyObject_InitVar(PyVarObject *op, PyTypeObject *tp, Py_ssize_t size)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000239{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000240 if (op == NULL)
241 return (PyVarObject *) PyErr_NoMemory();
242 /* Any changes should be reflected in PyObject_INIT_VAR */
243 op->ob_size = size;
244 Py_TYPE(op) = tp;
245 _Py_NewReference((PyObject *)op);
246 return op;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000247}
248
249PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000250_PyObject_New(PyTypeObject *tp)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000251{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000252 PyObject *op;
253 op = (PyObject *) PyObject_MALLOC(_PyObject_SIZE(tp));
254 if (op == NULL)
255 return PyErr_NoMemory();
256 return PyObject_INIT(op, tp);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000257}
258
Guido van Rossumd0c87ee1997-05-15 21:31:03 +0000259PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000260_PyObject_NewVar(PyTypeObject *tp, Py_ssize_t nitems)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000261{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000262 PyVarObject *op;
263 const size_t size = _PyObject_VAR_SIZE(tp, nitems);
264 op = (PyVarObject *) PyObject_MALLOC(size);
265 if (op == NULL)
266 return (PyVarObject *)PyErr_NoMemory();
267 return PyObject_INIT_VAR(op, tp, nitems);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000268}
269
Antoine Pitrou796564c2013-07-30 19:59:21 +0200270void
271PyObject_CallFinalizer(PyObject *self)
272{
273 PyTypeObject *tp = Py_TYPE(self);
274
275 /* The former could happen on heaptypes created from the C API, e.g.
276 PyType_FromSpec(). */
277 if (!PyType_HasFeature(tp, Py_TPFLAGS_HAVE_FINALIZE) ||
278 tp->tp_finalize == NULL)
279 return;
280 /* tp_finalize should only be called once. */
281 if (PyType_IS_GC(tp) && _PyGC_FINALIZED(self))
282 return;
283
284 tp->tp_finalize(self);
285 if (PyType_IS_GC(tp))
286 _PyGC_SET_FINALIZED(self, 1);
287}
288
289int
290PyObject_CallFinalizerFromDealloc(PyObject *self)
291{
292 Py_ssize_t refcnt;
293
294 /* Temporarily resurrect the object. */
295 if (self->ob_refcnt != 0) {
296 Py_FatalError("PyObject_CallFinalizerFromDealloc called on "
297 "object with a non-zero refcount");
298 }
299 self->ob_refcnt = 1;
300
301 PyObject_CallFinalizer(self);
302
303 /* Undo the temporary resurrection; can't use DECREF here, it would
304 * cause a recursive call.
305 */
306 assert(self->ob_refcnt > 0);
307 if (--self->ob_refcnt == 0)
308 return 0; /* this is the normal path out */
309
310 /* tp_finalize resurrected it! Make it look like the original Py_DECREF
311 * never happened.
312 */
313 refcnt = self->ob_refcnt;
314 _Py_NewReference(self);
315 self->ob_refcnt = refcnt;
316
317 if (PyType_IS_GC(Py_TYPE(self))) {
318 assert(_PyGC_REFS(self) != _PyGC_REFS_UNTRACKED);
319 }
320 /* If Py_REF_DEBUG, _Py_NewReference bumped _Py_RefTotal, so
321 * we need to undo that. */
322 _Py_DEC_REFTOTAL;
323 /* If Py_TRACE_REFS, _Py_NewReference re-added self to the object
324 * chain, so no more to do there.
325 * If COUNT_ALLOCS, the original decref bumped tp_frees, and
326 * _Py_NewReference bumped tp_allocs: both of those need to be
327 * undone.
328 */
329#ifdef COUNT_ALLOCS
330 --Py_TYPE(self)->tp_frees;
331 --Py_TYPE(self)->tp_allocs;
332#endif
333 return -1;
334}
335
Antoine Pitrouc47bd4a2010-07-27 22:08:27 +0000336int
337PyObject_Print(PyObject *op, FILE *fp, int flags)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000338{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000339 int ret = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000340 if (PyErr_CheckSignals())
341 return -1;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000342#ifdef USE_STACKCHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000343 if (PyOS_CheckStack()) {
344 PyErr_SetString(PyExc_MemoryError, "stack overflow");
345 return -1;
346 }
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000347#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000348 clearerr(fp); /* Clear any previous error condition */
349 if (op == NULL) {
350 Py_BEGIN_ALLOW_THREADS
351 fprintf(fp, "<nil>");
352 Py_END_ALLOW_THREADS
353 }
354 else {
355 if (op->ob_refcnt <= 0)
356 /* XXX(twouters) cast refcount to long until %zd is
357 universally available */
358 Py_BEGIN_ALLOW_THREADS
359 fprintf(fp, "<refcnt %ld at %p>",
360 (long)op->ob_refcnt, op);
361 Py_END_ALLOW_THREADS
362 else {
363 PyObject *s;
364 if (flags & Py_PRINT_RAW)
365 s = PyObject_Str(op);
366 else
367 s = PyObject_Repr(op);
368 if (s == NULL)
369 ret = -1;
370 else if (PyBytes_Check(s)) {
371 fwrite(PyBytes_AS_STRING(s), 1,
372 PyBytes_GET_SIZE(s), fp);
373 }
374 else if (PyUnicode_Check(s)) {
375 PyObject *t;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200376 t = PyUnicode_AsEncodedString(s, "utf-8", "backslashreplace");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000377 if (t == NULL)
378 ret = 0;
379 else {
380 fwrite(PyBytes_AS_STRING(t), 1,
381 PyBytes_GET_SIZE(t), fp);
Victor Stinnerba6b4302010-05-17 09:33:42 +0000382 Py_DECREF(t);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000383 }
384 }
385 else {
386 PyErr_Format(PyExc_TypeError,
387 "str() or repr() returned '%.100s'",
388 s->ob_type->tp_name);
389 ret = -1;
390 }
391 Py_XDECREF(s);
392 }
393 }
394 if (ret == 0) {
395 if (ferror(fp)) {
Serhiy Storchaka55fe1ae2017-04-16 10:46:38 +0300396 PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000397 clearerr(fp);
398 ret = -1;
399 }
400 }
401 return ret;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000402}
403
Guido van Rossum38938152006-08-21 23:36:26 +0000404/* For debugging convenience. Set a breakpoint here and call it from your DLL */
405void
Thomas Woutersb2137042007-02-01 18:02:27 +0000406_Py_BreakPoint(void)
Guido van Rossum38938152006-08-21 23:36:26 +0000407{
408}
409
Neal Norwitz1a997502003-01-13 20:13:12 +0000410
Barry Warsaw9bf16442001-01-23 16:24:35 +0000411/* For debugging convenience. See Misc/gdbinit for some useful gdb hooks */
Guido van Rossum38938152006-08-21 23:36:26 +0000412void
413_PyObject_Dump(PyObject* op)
Barry Warsaw9bf16442001-01-23 16:24:35 +0000414{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000415 if (op == NULL)
416 fprintf(stderr, "NULL\n");
417 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000418 PyGILState_STATE gil;
Victor Stinnere5132102013-08-26 13:49:06 +0200419 PyObject *error_type, *error_value, *error_traceback;
420
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000421 fprintf(stderr, "object : ");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000422 gil = PyGILState_Ensure();
Victor Stinnere5132102013-08-26 13:49:06 +0200423
424 PyErr_Fetch(&error_type, &error_value, &error_traceback);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000425 (void)PyObject_Print(op, stderr, 0);
Victor Stinnere5132102013-08-26 13:49:06 +0200426 PyErr_Restore(error_type, error_value, error_traceback);
427
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000428 PyGILState_Release(gil);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000429 /* XXX(twouters) cast refcount to long until %zd is
430 universally available */
431 fprintf(stderr, "\n"
432 "type : %s\n"
433 "refcount: %ld\n"
434 "address : %p\n",
435 Py_TYPE(op)==NULL ? "NULL" : Py_TYPE(op)->tp_name,
436 (long)op->ob_refcnt,
437 op);
438 }
Barry Warsaw9bf16442001-01-23 16:24:35 +0000439}
Barry Warsaw903138f2001-01-23 16:33:18 +0000440
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000441PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000442PyObject_Repr(PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000443{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000444 PyObject *res;
445 if (PyErr_CheckSignals())
446 return NULL;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000447#ifdef USE_STACKCHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000448 if (PyOS_CheckStack()) {
449 PyErr_SetString(PyExc_MemoryError, "stack overflow");
450 return NULL;
451 }
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000452#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000453 if (v == NULL)
454 return PyUnicode_FromString("<NULL>");
455 if (Py_TYPE(v)->tp_repr == NULL)
456 return PyUnicode_FromFormat("<%s object at %p>",
457 v->ob_type->tp_name, v);
Victor Stinner33824f62013-08-26 14:05:19 +0200458
459#ifdef Py_DEBUG
460 /* PyObject_Repr() must not be called with an exception set,
Victor Stinnera8cb5152017-01-18 14:12:51 +0100461 because it can clear it (directly or indirectly) and so the
Martin Panter9955a372015-10-07 10:26:23 +0000462 caller loses its exception */
Victor Stinner33824f62013-08-26 14:05:19 +0200463 assert(!PyErr_Occurred());
464#endif
465
Serhiy Storchaka1fb72d22017-12-03 22:12:11 +0200466 /* It is possible for a type to have a tp_repr representation that loops
467 infinitely. */
468 if (Py_EnterRecursiveCall(" while getting the repr of an object"))
469 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000470 res = (*v->ob_type->tp_repr)(v);
Serhiy Storchaka1fb72d22017-12-03 22:12:11 +0200471 Py_LeaveRecursiveCall();
Victor Stinner0a54cf12011-12-01 03:22:44 +0100472 if (res == NULL)
473 return NULL;
474 if (!PyUnicode_Check(res)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000475 PyErr_Format(PyExc_TypeError,
476 "__repr__ returned non-string (type %.200s)",
477 res->ob_type->tp_name);
478 Py_DECREF(res);
479 return NULL;
480 }
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100481#ifndef Py_DEBUG
482 if (PyUnicode_READY(res) < 0)
483 return NULL;
484#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000485 return res;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000486}
487
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000488PyObject *
Guido van Rossum98297ee2007-11-06 21:34:58 +0000489PyObject_Str(PyObject *v)
Guido van Rossumc6004111993-11-05 10:22:19 +0000490{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000491 PyObject *res;
492 if (PyErr_CheckSignals())
493 return NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000494#ifdef USE_STACKCHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000495 if (PyOS_CheckStack()) {
496 PyErr_SetString(PyExc_MemoryError, "stack overflow");
497 return NULL;
498 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000499#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000500 if (v == NULL)
501 return PyUnicode_FromString("<NULL>");
502 if (PyUnicode_CheckExact(v)) {
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100503#ifndef Py_DEBUG
Victor Stinner4ead7c72011-11-20 19:48:36 +0100504 if (PyUnicode_READY(v) < 0)
505 return NULL;
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100506#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000507 Py_INCREF(v);
508 return v;
509 }
510 if (Py_TYPE(v)->tp_str == NULL)
511 return PyObject_Repr(v);
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000512
Victor Stinner33824f62013-08-26 14:05:19 +0200513#ifdef Py_DEBUG
514 /* PyObject_Str() must not be called with an exception set,
Victor Stinnera8cb5152017-01-18 14:12:51 +0100515 because it can clear it (directly or indirectly) and so the
Nick Coghland979e432014-02-09 10:43:21 +1000516 caller loses its exception */
Victor Stinner33824f62013-08-26 14:05:19 +0200517 assert(!PyErr_Occurred());
518#endif
519
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000520 /* It is possible for a type to have a tp_str representation that loops
521 infinitely. */
522 if (Py_EnterRecursiveCall(" while getting the str of an object"))
523 return NULL;
524 res = (*Py_TYPE(v)->tp_str)(v);
525 Py_LeaveRecursiveCall();
526 if (res == NULL)
527 return NULL;
528 if (!PyUnicode_Check(res)) {
529 PyErr_Format(PyExc_TypeError,
530 "__str__ returned non-string (type %.200s)",
531 Py_TYPE(res)->tp_name);
532 Py_DECREF(res);
533 return NULL;
534 }
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100535#ifndef Py_DEBUG
Victor Stinner4ead7c72011-11-20 19:48:36 +0100536 if (PyUnicode_READY(res) < 0)
537 return NULL;
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100538#endif
Victor Stinner4ead7c72011-11-20 19:48:36 +0100539 assert(_PyUnicode_CheckConsistency(res, 1));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000540 return res;
Neil Schemenauercf52c072005-08-12 17:34:58 +0000541}
542
Georg Brandl559e5d72008-06-11 18:37:52 +0000543PyObject *
544PyObject_ASCII(PyObject *v)
545{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000546 PyObject *repr, *ascii, *res;
Georg Brandl559e5d72008-06-11 18:37:52 +0000547
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000548 repr = PyObject_Repr(v);
549 if (repr == NULL)
550 return NULL;
Georg Brandl559e5d72008-06-11 18:37:52 +0000551
Victor Stinneraf037572013-04-14 18:44:10 +0200552 if (PyUnicode_IS_ASCII(repr))
553 return repr;
554
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000555 /* repr is guaranteed to be a PyUnicode object by PyObject_Repr */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200556 ascii = _PyUnicode_AsASCIIString(repr, "backslashreplace");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000557 Py_DECREF(repr);
558 if (ascii == NULL)
559 return NULL;
Georg Brandl559e5d72008-06-11 18:37:52 +0000560
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000561 res = PyUnicode_DecodeASCII(
562 PyBytes_AS_STRING(ascii),
563 PyBytes_GET_SIZE(ascii),
564 NULL);
565
566 Py_DECREF(ascii);
567 return res;
Georg Brandl559e5d72008-06-11 18:37:52 +0000568}
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000569
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000570PyObject *
571PyObject_Bytes(PyObject *v)
572{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000573 PyObject *result, *func;
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000574
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000575 if (v == NULL)
576 return PyBytes_FromString("<NULL>");
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000577
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000578 if (PyBytes_CheckExact(v)) {
579 Py_INCREF(v);
580 return v;
581 }
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000582
Benjamin Petersonce798522012-01-22 11:24:29 -0500583 func = _PyObject_LookupSpecial(v, &PyId___bytes__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000584 if (func != NULL) {
Victor Stinnerf17c3de2016-12-06 18:46:19 +0100585 result = _PyObject_CallNoArg(func);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000586 Py_DECREF(func);
587 if (result == NULL)
Benjamin Peterson41ece392010-09-11 16:39:57 +0000588 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000589 if (!PyBytes_Check(result)) {
Benjamin Peterson41ece392010-09-11 16:39:57 +0000590 PyErr_Format(PyExc_TypeError,
591 "__bytes__ returned non-bytes (type %.200s)",
592 Py_TYPE(result)->tp_name);
593 Py_DECREF(result);
594 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000595 }
596 return result;
597 }
598 else if (PyErr_Occurred())
599 return NULL;
600 return PyBytes_FromObject(v);
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000601}
602
Mark Dickinsonc008a172009-02-01 13:59:22 +0000603/* For Python 3.0.1 and later, the old three-way comparison has been
604 completely removed in favour of rich comparisons. PyObject_Compare() and
605 PyObject_Cmp() are gone, and the builtin cmp function no longer exists.
Mark Dickinsone94c6792009-02-02 20:36:42 +0000606 The old tp_compare slot has been renamed to tp_reserved, and should no
Mark Dickinsonc008a172009-02-01 13:59:22 +0000607 longer be used. Use tp_richcompare instead.
Guido van Rossum98297ee2007-11-06 21:34:58 +0000608
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000609 See (*) below for practical amendments.
610
Mark Dickinsonc008a172009-02-01 13:59:22 +0000611 tp_richcompare gets called with a first argument of the appropriate type
612 and a second object of an arbitrary type. We never do any kind of
613 coercion.
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000614
Mark Dickinsonc008a172009-02-01 13:59:22 +0000615 The tp_richcompare slot should return an object, as follows:
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000616
617 NULL if an exception occurred
618 NotImplemented if the requested comparison is not implemented
619 any other false value if the requested comparison is false
620 any other true value if the requested comparison is true
621
622 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
623 NotImplemented.
624
625 (*) Practical amendments:
626
627 - If rich comparison returns NotImplemented, == and != are decided by
628 comparing the object pointer (i.e. falling back to the base object
629 implementation).
630
Guido van Rossuma4073002002-05-31 20:03:54 +0000631*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000632
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000633/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000634int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000635
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200636static const char * const opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000637
638/* Perform a rich comparison, raising TypeError when the requested comparison
639 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000640static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000641do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000642{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000643 richcmpfunc f;
644 PyObject *res;
645 int checked_reverse_op = 0;
Guido van Rossume797ec12001-01-17 15:24:28 +0000646
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000647 if (v->ob_type != w->ob_type &&
648 PyType_IsSubtype(w->ob_type, v->ob_type) &&
649 (f = w->ob_type->tp_richcompare) != NULL) {
650 checked_reverse_op = 1;
651 res = (*f)(w, v, _Py_SwappedOp[op]);
652 if (res != Py_NotImplemented)
653 return res;
654 Py_DECREF(res);
655 }
656 if ((f = v->ob_type->tp_richcompare) != NULL) {
657 res = (*f)(v, w, op);
658 if (res != Py_NotImplemented)
659 return res;
660 Py_DECREF(res);
661 }
662 if (!checked_reverse_op && (f = w->ob_type->tp_richcompare) != NULL) {
663 res = (*f)(w, v, _Py_SwappedOp[op]);
664 if (res != Py_NotImplemented)
665 return res;
666 Py_DECREF(res);
667 }
668 /* If neither object implements it, provide a sensible default
669 for == and !=, but raise an exception for ordering. */
670 switch (op) {
671 case Py_EQ:
672 res = (v == w) ? Py_True : Py_False;
673 break;
674 case Py_NE:
675 res = (v != w) ? Py_True : Py_False;
676 break;
677 default:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000678 PyErr_Format(PyExc_TypeError,
Victor Stinner91108f02015-10-14 18:25:31 +0200679 "'%s' not supported between instances of '%.100s' and '%.100s'",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000680 opstrings[op],
Victor Stinner91108f02015-10-14 18:25:31 +0200681 v->ob_type->tp_name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000682 w->ob_type->tp_name);
683 return NULL;
684 }
685 Py_INCREF(res);
686 return res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000687}
688
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000689/* Perform a rich comparison with object result. This wraps do_richcompare()
690 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000691
Guido van Rossume797ec12001-01-17 15:24:28 +0000692PyObject *
693PyObject_RichCompare(PyObject *v, PyObject *w, int op)
694{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000695 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000696
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000697 assert(Py_LT <= op && op <= Py_GE);
698 if (v == NULL || w == NULL) {
699 if (!PyErr_Occurred())
700 PyErr_BadInternalCall();
701 return NULL;
702 }
703 if (Py_EnterRecursiveCall(" in comparison"))
704 return NULL;
705 res = do_richcompare(v, w, op);
706 Py_LeaveRecursiveCall();
707 return res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000708}
709
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000710/* Perform a rich comparison with integer result. This wraps
711 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000712int
713PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
714{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000715 PyObject *res;
716 int ok;
Guido van Rossume797ec12001-01-17 15:24:28 +0000717
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000718 /* Quick result when objects are the same.
719 Guarantees that identity implies equality. */
720 if (v == w) {
721 if (op == Py_EQ)
722 return 1;
723 else if (op == Py_NE)
724 return 0;
725 }
Mark Dickinson4a1f5932008-11-12 23:23:36 +0000726
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000727 res = PyObject_RichCompare(v, w, op);
728 if (res == NULL)
729 return -1;
730 if (PyBool_Check(res))
731 ok = (res == Py_True);
732 else
733 ok = PyObject_IsTrue(res);
734 Py_DECREF(res);
735 return ok;
Guido van Rossume797ec12001-01-17 15:24:28 +0000736}
Fred Drake13634cf2000-06-29 19:17:04 +0000737
Antoine Pitrouce4a9da2011-11-21 20:46:33 +0100738Py_hash_t
Nick Coghland1abd252008-07-15 15:46:38 +0000739PyObject_HashNotImplemented(PyObject *v)
740{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000741 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
742 Py_TYPE(v)->tp_name);
743 return -1;
Nick Coghland1abd252008-07-15 15:46:38 +0000744}
Fred Drake13634cf2000-06-29 19:17:04 +0000745
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000746Py_hash_t
Fred Drake100814d2000-07-09 15:48:49 +0000747PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000748{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000749 PyTypeObject *tp = Py_TYPE(v);
750 if (tp->tp_hash != NULL)
751 return (*tp->tp_hash)(v);
752 /* To keep to the general practice that inheriting
753 * solely from object in C code should work without
754 * an explicit call to PyType_Ready, we implicitly call
755 * PyType_Ready here and then check the tp_hash slot again
756 */
757 if (tp->tp_dict == NULL) {
758 if (PyType_Ready(tp) < 0)
759 return -1;
760 if (tp->tp_hash != NULL)
761 return (*tp->tp_hash)(v);
762 }
763 /* Otherwise, the object can't be hashed */
764 return PyObject_HashNotImplemented(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000765}
766
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000767PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000768PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000769{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000770 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000771
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000772 if (Py_TYPE(v)->tp_getattr != NULL)
773 return (*Py_TYPE(v)->tp_getattr)(v, (char*)name);
INADA Naoki3e8d6cb2017-02-21 23:57:25 +0900774 w = PyUnicode_FromString(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000775 if (w == NULL)
776 return NULL;
777 res = PyObject_GetAttr(v, w);
Victor Stinner59af08f2012-03-22 02:09:08 +0100778 Py_DECREF(w);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000779 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000780}
781
782int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000783PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000784{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000785 PyObject *res = PyObject_GetAttrString(v, name);
786 if (res != NULL) {
787 Py_DECREF(res);
788 return 1;
789 }
790 PyErr_Clear();
791 return 0;
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000792}
793
794int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000795PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000796{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000797 PyObject *s;
798 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000799
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000800 if (Py_TYPE(v)->tp_setattr != NULL)
801 return (*Py_TYPE(v)->tp_setattr)(v, (char*)name, w);
802 s = PyUnicode_InternFromString(name);
803 if (s == NULL)
804 return -1;
805 res = PyObject_SetAttr(v, s, w);
806 Py_XDECREF(s);
807 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000808}
809
Benjamin Petersonbfebb7b2011-12-15 15:34:02 -0500810int
811_PyObject_IsAbstract(PyObject *obj)
812{
813 int res;
814 PyObject* isabstract;
Benjamin Petersonbfebb7b2011-12-15 15:34:02 -0500815
816 if (obj == NULL)
817 return 0;
818
819 isabstract = _PyObject_GetAttrId(obj, &PyId___isabstractmethod__);
820 if (isabstract == NULL) {
821 if (PyErr_ExceptionMatches(PyExc_AttributeError)) {
822 PyErr_Clear();
823 return 0;
824 }
825 return -1;
826 }
827 res = PyObject_IsTrue(isabstract);
828 Py_DECREF(isabstract);
829 return res;
830}
831
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000832PyObject *
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200833_PyObject_GetAttrId(PyObject *v, _Py_Identifier *name)
834{
835 PyObject *result;
Martin v. Löwisd10759f2011-11-07 13:00:05 +0100836 PyObject *oname = _PyUnicode_FromId(name); /* borrowed */
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200837 if (!oname)
838 return NULL;
839 result = PyObject_GetAttr(v, oname);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200840 return result;
841}
842
843int
844_PyObject_HasAttrId(PyObject *v, _Py_Identifier *name)
845{
846 int result;
Martin v. Löwisd10759f2011-11-07 13:00:05 +0100847 PyObject *oname = _PyUnicode_FromId(name); /* borrowed */
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200848 if (!oname)
849 return -1;
850 result = PyObject_HasAttr(v, oname);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200851 return result;
852}
853
854int
855_PyObject_SetAttrId(PyObject *v, _Py_Identifier *name, PyObject *w)
856{
857 int result;
Martin v. Löwisd10759f2011-11-07 13:00:05 +0100858 PyObject *oname = _PyUnicode_FromId(name); /* borrowed */
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200859 if (!oname)
860 return -1;
861 result = PyObject_SetAttr(v, oname, w);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200862 return result;
863}
864
865PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000866PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000867{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000868 PyTypeObject *tp = Py_TYPE(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000869
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000870 if (!PyUnicode_Check(name)) {
871 PyErr_Format(PyExc_TypeError,
872 "attribute name must be string, not '%.200s'",
873 name->ob_type->tp_name);
874 return NULL;
875 }
876 if (tp->tp_getattro != NULL)
877 return (*tp->tp_getattro)(v, name);
878 if (tp->tp_getattr != NULL) {
Serhiy Storchaka2a404b62017-01-22 23:07:07 +0200879 const char *name_str = PyUnicode_AsUTF8(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000880 if (name_str == NULL)
881 return NULL;
Serhiy Storchaka2a404b62017-01-22 23:07:07 +0200882 return (*tp->tp_getattr)(v, (char *)name_str);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000883 }
884 PyErr_Format(PyExc_AttributeError,
885 "'%.50s' object has no attribute '%U'",
886 tp->tp_name, name);
887 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000888}
889
INADA Naoki378edee2018-01-16 20:52:41 +0900890PyObject *
891_PyObject_GetAttrWithoutError(PyObject *v, PyObject *name)
892{
893 PyTypeObject *tp = Py_TYPE(v);
894 PyObject *ret = NULL;
895
896 if (!PyUnicode_Check(name)) {
897 PyErr_Format(PyExc_TypeError,
898 "attribute name must be string, not '%.200s'",
899 name->ob_type->tp_name);
900 return NULL;
901 }
902
903 if (tp->tp_getattro == PyObject_GenericGetAttr) {
904 return _PyObject_GenericGetAttrWithDict(v, name, NULL, 1);
905 }
906 if (tp->tp_getattro != NULL) {
907 ret = (*tp->tp_getattro)(v, name);
908 }
909 else if (tp->tp_getattr != NULL) {
910 const char *name_str = PyUnicode_AsUTF8(name);
911 if (name_str == NULL)
912 return NULL;
913 ret = (*tp->tp_getattr)(v, (char *)name_str);
914 }
915 if (ret == NULL && PyErr_ExceptionMatches(PyExc_AttributeError)) {
916 PyErr_Clear();
917 }
918 return ret;
919}
920
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000921int
Fred Drake100814d2000-07-09 15:48:49 +0000922PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000923{
INADA Naoki378edee2018-01-16 20:52:41 +0900924 PyObject *res = _PyObject_GetAttrWithoutError(v, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000925 if (res != NULL) {
926 Py_DECREF(res);
927 return 1;
928 }
929 PyErr_Clear();
930 return 0;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000931}
932
933int
Fred Drake100814d2000-07-09 15:48:49 +0000934PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000935{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000936 PyTypeObject *tp = Py_TYPE(v);
937 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000938
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000939 if (!PyUnicode_Check(name)) {
940 PyErr_Format(PyExc_TypeError,
941 "attribute name must be string, not '%.200s'",
942 name->ob_type->tp_name);
943 return -1;
944 }
945 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000946
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000947 PyUnicode_InternInPlace(&name);
948 if (tp->tp_setattro != NULL) {
949 err = (*tp->tp_setattro)(v, name, value);
950 Py_DECREF(name);
951 return err;
952 }
953 if (tp->tp_setattr != NULL) {
Serhiy Storchaka2a404b62017-01-22 23:07:07 +0200954 const char *name_str = PyUnicode_AsUTF8(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000955 if (name_str == NULL)
956 return -1;
Serhiy Storchaka2a404b62017-01-22 23:07:07 +0200957 err = (*tp->tp_setattr)(v, (char *)name_str, value);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 Py_DECREF(name);
959 return err;
960 }
961 Py_DECREF(name);
962 assert(name->ob_refcnt >= 1);
963 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
964 PyErr_Format(PyExc_TypeError,
965 "'%.100s' object has no attributes "
966 "(%s .%U)",
967 tp->tp_name,
968 value==NULL ? "del" : "assign to",
969 name);
970 else
971 PyErr_Format(PyExc_TypeError,
972 "'%.100s' object has only read-only attributes "
973 "(%s .%U)",
974 tp->tp_name,
975 value==NULL ? "del" : "assign to",
976 name);
977 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000978}
979
980/* Helper to get a pointer to an object's __dict__ slot, if any */
981
982PyObject **
983_PyObject_GetDictPtr(PyObject *obj)
984{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000985 Py_ssize_t dictoffset;
986 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000987
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000988 dictoffset = tp->tp_dictoffset;
989 if (dictoffset == 0)
990 return NULL;
991 if (dictoffset < 0) {
992 Py_ssize_t tsize;
993 size_t size;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000994
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000995 tsize = ((PyVarObject *)obj)->ob_size;
996 if (tsize < 0)
997 tsize = -tsize;
998 size = _PyObject_VAR_SIZE(tp, tsize);
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000999
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001000 dictoffset += (long)size;
1001 assert(dictoffset > 0);
1002 assert(dictoffset % SIZEOF_VOID_P == 0);
1003 }
1004 return (PyObject **) ((char *)obj + dictoffset);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001005}
1006
Tim Peters6d6c1a32001-08-02 04:15:00 +00001007PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +00001008PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +00001009{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001010 Py_INCREF(obj);
1011 return obj;
Raymond Hettinger01538262003-03-17 08:24:35 +00001012}
1013
Antoine Pitroua7013882012-04-05 00:04:20 +02001014/* Convenience function to get a builtin from its name */
1015PyObject *
1016_PyObject_GetBuiltin(const char *name)
1017{
Victor Stinner53e9ec42013-11-07 00:43:05 +01001018 PyObject *mod_name, *mod, *attr;
1019
Victor Stinnerbd303c12013-11-07 23:07:29 +01001020 mod_name = _PyUnicode_FromId(&PyId_builtins); /* borrowed */
Victor Stinner53e9ec42013-11-07 00:43:05 +01001021 if (mod_name == NULL)
1022 return NULL;
1023 mod = PyImport_Import(mod_name);
Antoine Pitroua7013882012-04-05 00:04:20 +02001024 if (mod == NULL)
1025 return NULL;
1026 attr = PyObject_GetAttrString(mod, name);
1027 Py_DECREF(mod);
1028 return attr;
1029}
1030
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +00001031/* Helper used when the __next__ method is removed from a type:
1032 tp_iternext is never NULL and can be safely called without checking
1033 on every iteration.
1034 */
1035
1036PyObject *
1037_PyObject_NextNotImplemented(PyObject *self)
1038{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001039 PyErr_Format(PyExc_TypeError,
1040 "'%.200s' object is not iterable",
1041 Py_TYPE(self)->tp_name);
1042 return NULL;
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +00001043}
1044
Yury Selivanovf2392132016-12-13 19:03:51 -05001045
1046/* Specialized version of _PyObject_GenericGetAttrWithDict
1047 specifically for the LOAD_METHOD opcode.
1048
1049 Return 1 if a method is found, 0 if it's a regular attribute
1050 from __dict__ or something returned by using a descriptor
1051 protocol.
1052
1053 `method` will point to the resolved attribute or NULL. In the
1054 latter case, an error will be set.
1055*/
1056int
1057_PyObject_GetMethod(PyObject *obj, PyObject *name, PyObject **method)
1058{
1059 PyTypeObject *tp = Py_TYPE(obj);
1060 PyObject *descr;
1061 descrgetfunc f = NULL;
1062 PyObject **dictptr, *dict;
1063 PyObject *attr;
1064 int meth_found = 0;
1065
1066 assert(*method == NULL);
1067
1068 if (Py_TYPE(obj)->tp_getattro != PyObject_GenericGetAttr
1069 || !PyUnicode_Check(name)) {
1070 *method = PyObject_GetAttr(obj, name);
1071 return 0;
1072 }
1073
1074 if (tp->tp_dict == NULL && PyType_Ready(tp) < 0)
1075 return 0;
1076
1077 descr = _PyType_Lookup(tp, name);
1078 if (descr != NULL) {
1079 Py_INCREF(descr);
INADA Naoki5566bbb2017-02-03 07:43:03 +09001080 if (PyFunction_Check(descr) ||
1081 (Py_TYPE(descr) == &PyMethodDescr_Type)) {
Yury Selivanovf2392132016-12-13 19:03:51 -05001082 meth_found = 1;
1083 } else {
1084 f = descr->ob_type->tp_descr_get;
1085 if (f != NULL && PyDescr_IsData(descr)) {
1086 *method = f(descr, obj, (PyObject *)obj->ob_type);
1087 Py_DECREF(descr);
1088 return 0;
1089 }
1090 }
1091 }
1092
1093 dictptr = _PyObject_GetDictPtr(obj);
1094 if (dictptr != NULL && (dict = *dictptr) != NULL) {
1095 Py_INCREF(dict);
1096 attr = PyDict_GetItem(dict, name);
1097 if (attr != NULL) {
1098 Py_INCREF(attr);
1099 *method = attr;
1100 Py_DECREF(dict);
1101 Py_XDECREF(descr);
1102 return 0;
1103 }
1104 Py_DECREF(dict);
1105 }
1106
1107 if (meth_found) {
1108 *method = descr;
1109 return 1;
1110 }
1111
1112 if (f != NULL) {
1113 *method = f(descr, obj, (PyObject *)Py_TYPE(obj));
1114 Py_DECREF(descr);
1115 return 0;
1116 }
1117
1118 if (descr != NULL) {
1119 *method = descr;
1120 return 0;
1121 }
1122
1123 PyErr_Format(PyExc_AttributeError,
1124 "'%.50s' object has no attribute '%U'",
1125 tp->tp_name, name);
1126 return 0;
1127}
1128
1129/* Generic GetAttr functions - put these in your tp_[gs]etattro slot. */
Michael W. Hudson1593f502004-09-14 17:09:47 +00001130
Raymond Hettinger01538262003-03-17 08:24:35 +00001131PyObject *
INADA Naoki378edee2018-01-16 20:52:41 +09001132_PyObject_GenericGetAttrWithDict(PyObject *obj, PyObject *name,
1133 PyObject *dict, int suppress)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001134{
Yury Selivanovf2392132016-12-13 19:03:51 -05001135 /* Make sure the logic of _PyObject_GetMethod is in sync with
1136 this method.
INADA Naoki378edee2018-01-16 20:52:41 +09001137
1138 When suppress=1, this function suppress AttributeError.
Yury Selivanovf2392132016-12-13 19:03:51 -05001139 */
1140
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001141 PyTypeObject *tp = Py_TYPE(obj);
1142 PyObject *descr = NULL;
1143 PyObject *res = NULL;
1144 descrgetfunc f;
1145 Py_ssize_t dictoffset;
1146 PyObject **dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001147
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001148 if (!PyUnicode_Check(name)){
1149 PyErr_Format(PyExc_TypeError,
1150 "attribute name must be string, not '%.200s'",
1151 name->ob_type->tp_name);
1152 return NULL;
1153 }
Serhiy Storchaka55c861f2016-04-17 20:31:51 +03001154 Py_INCREF(name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001155
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001156 if (tp->tp_dict == NULL) {
1157 if (PyType_Ready(tp) < 0)
1158 goto done;
1159 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001160
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001161 descr = _PyType_Lookup(tp, name);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001162
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001163 f = NULL;
1164 if (descr != NULL) {
Serhiy Storchaka55c861f2016-04-17 20:31:51 +03001165 Py_INCREF(descr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001166 f = descr->ob_type->tp_descr_get;
1167 if (f != NULL && PyDescr_IsData(descr)) {
1168 res = f(descr, obj, (PyObject *)obj->ob_type);
INADA Naoki378edee2018-01-16 20:52:41 +09001169 if (res == NULL && suppress &&
1170 PyErr_ExceptionMatches(PyExc_AttributeError)) {
1171 PyErr_Clear();
1172 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001173 goto done;
1174 }
1175 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001176
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001177 if (dict == NULL) {
1178 /* Inline _PyObject_GetDictPtr */
1179 dictoffset = tp->tp_dictoffset;
1180 if (dictoffset != 0) {
1181 if (dictoffset < 0) {
1182 Py_ssize_t tsize;
1183 size_t size;
Guido van Rossumc66ff442002-08-19 16:50:48 +00001184
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001185 tsize = ((PyVarObject *)obj)->ob_size;
1186 if (tsize < 0)
1187 tsize = -tsize;
1188 size = _PyObject_VAR_SIZE(tp, tsize);
Serhiy Storchaka55c861f2016-04-17 20:31:51 +03001189 assert(size <= PY_SSIZE_T_MAX);
Guido van Rossumc66ff442002-08-19 16:50:48 +00001190
Serhiy Storchaka55c861f2016-04-17 20:31:51 +03001191 dictoffset += (Py_ssize_t)size;
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001192 assert(dictoffset > 0);
1193 assert(dictoffset % SIZEOF_VOID_P == 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001194 }
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001195 dictptr = (PyObject **) ((char *)obj + dictoffset);
1196 dict = *dictptr;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001197 }
1198 }
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001199 if (dict != NULL) {
1200 Py_INCREF(dict);
1201 res = PyDict_GetItem(dict, name);
1202 if (res != NULL) {
1203 Py_INCREF(res);
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001204 Py_DECREF(dict);
1205 goto done;
1206 }
1207 Py_DECREF(dict);
1208 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001209
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001210 if (f != NULL) {
1211 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
INADA Naoki378edee2018-01-16 20:52:41 +09001212 if (res == NULL && suppress &&
1213 PyErr_ExceptionMatches(PyExc_AttributeError)) {
1214 PyErr_Clear();
1215 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001216 goto done;
1217 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001218
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001219 if (descr != NULL) {
1220 res = descr;
Victor Stinner2d01dc02012-03-09 00:44:13 +01001221 descr = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001222 goto done;
1223 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001224
INADA Naoki378edee2018-01-16 20:52:41 +09001225 if (!suppress) {
1226 PyErr_Format(PyExc_AttributeError,
1227 "'%.50s' object has no attribute '%U'",
1228 tp->tp_name, name);
1229 }
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001230 done:
Victor Stinner2d01dc02012-03-09 00:44:13 +01001231 Py_XDECREF(descr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001232 Py_DECREF(name);
1233 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001234}
1235
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001236PyObject *
1237PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
1238{
INADA Naoki378edee2018-01-16 20:52:41 +09001239 return _PyObject_GenericGetAttrWithDict(obj, name, NULL, 0);
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001240}
1241
Tim Peters6d6c1a32001-08-02 04:15:00 +00001242int
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001243_PyObject_GenericSetAttrWithDict(PyObject *obj, PyObject *name,
1244 PyObject *value, PyObject *dict)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001245{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001246 PyTypeObject *tp = Py_TYPE(obj);
1247 PyObject *descr;
1248 descrsetfunc f;
1249 PyObject **dictptr;
1250 int res = -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001251
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001252 if (!PyUnicode_Check(name)){
1253 PyErr_Format(PyExc_TypeError,
1254 "attribute name must be string, not '%.200s'",
1255 name->ob_type->tp_name);
1256 return -1;
1257 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001258
Benjamin Peterson74529ad2012-03-09 07:25:32 -08001259 if (tp->tp_dict == NULL && PyType_Ready(tp) < 0)
1260 return -1;
1261
1262 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001263
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001264 descr = _PyType_Lookup(tp, name);
Victor Stinner2d01dc02012-03-09 00:44:13 +01001265
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001266 if (descr != NULL) {
Serhiy Storchaka55c861f2016-04-17 20:31:51 +03001267 Py_INCREF(descr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001268 f = descr->ob_type->tp_descr_set;
Serhiy Storchaka55c861f2016-04-17 20:31:51 +03001269 if (f != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001270 res = f(descr, obj, value);
1271 goto done;
1272 }
1273 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001274
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001275 if (dict == NULL) {
1276 dictptr = _PyObject_GetDictPtr(obj);
Serhiy Storchaka55c861f2016-04-17 20:31:51 +03001277 if (dictptr == NULL) {
1278 if (descr == NULL) {
1279 PyErr_Format(PyExc_AttributeError,
1280 "'%.100s' object has no attribute '%U'",
1281 tp->tp_name, name);
1282 }
1283 else {
1284 PyErr_Format(PyExc_AttributeError,
1285 "'%.50s' object attribute '%U' is read-only",
1286 tp->tp_name, name);
1287 }
Benjamin Peterson7d95e402012-04-23 11:24:50 -04001288 goto done;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001289 }
Serhiy Storchaka55c861f2016-04-17 20:31:51 +03001290 res = _PyObjectDict_SetItem(tp, dictptr, name, value);
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001291 }
Serhiy Storchaka55c861f2016-04-17 20:31:51 +03001292 else {
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001293 Py_INCREF(dict);
1294 if (value == NULL)
1295 res = PyDict_DelItem(dict, name);
1296 else
1297 res = PyDict_SetItem(dict, name, value);
Benjamin Peterson74529ad2012-03-09 07:25:32 -08001298 Py_DECREF(dict);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001299 }
Serhiy Storchaka55c861f2016-04-17 20:31:51 +03001300 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1301 PyErr_SetObject(PyExc_AttributeError, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001302
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001303 done:
Victor Stinner2d01dc02012-03-09 00:44:13 +01001304 Py_XDECREF(descr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001305 Py_DECREF(name);
1306 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001307}
1308
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001309int
1310PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1311{
1312 return _PyObject_GenericSetAttrWithDict(obj, name, value, NULL);
1313}
1314
Benjamin Peterson8eb12692012-02-19 19:59:10 -05001315int
1316PyObject_GenericSetDict(PyObject *obj, PyObject *value, void *context)
1317{
Serhiy Storchaka576f1322016-01-05 21:27:54 +02001318 PyObject **dictptr = _PyObject_GetDictPtr(obj);
Benjamin Peterson8eb12692012-02-19 19:59:10 -05001319 if (dictptr == NULL) {
1320 PyErr_SetString(PyExc_AttributeError,
1321 "This object has no __dict__");
1322 return -1;
1323 }
1324 if (value == NULL) {
1325 PyErr_SetString(PyExc_TypeError, "cannot delete __dict__");
1326 return -1;
1327 }
1328 if (!PyDict_Check(value)) {
1329 PyErr_Format(PyExc_TypeError,
1330 "__dict__ must be set to a dictionary, "
1331 "not a '%.200s'", Py_TYPE(value)->tp_name);
1332 return -1;
1333 }
Serhiy Storchaka576f1322016-01-05 21:27:54 +02001334 Py_INCREF(value);
Serhiy Storchakaec397562016-04-06 09:50:03 +03001335 Py_XSETREF(*dictptr, value);
Benjamin Peterson8eb12692012-02-19 19:59:10 -05001336 return 0;
1337}
1338
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001339
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001340/* Test a value used as condition, e.g., in a for or if statement.
1341 Return -1 if an error occurred */
1342
1343int
Fred Drake100814d2000-07-09 15:48:49 +00001344PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001345{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001346 Py_ssize_t res;
1347 if (v == Py_True)
1348 return 1;
1349 if (v == Py_False)
1350 return 0;
1351 if (v == Py_None)
1352 return 0;
1353 else if (v->ob_type->tp_as_number != NULL &&
1354 v->ob_type->tp_as_number->nb_bool != NULL)
1355 res = (*v->ob_type->tp_as_number->nb_bool)(v);
1356 else if (v->ob_type->tp_as_mapping != NULL &&
1357 v->ob_type->tp_as_mapping->mp_length != NULL)
1358 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
1359 else if (v->ob_type->tp_as_sequence != NULL &&
1360 v->ob_type->tp_as_sequence->sq_length != NULL)
1361 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1362 else
1363 return 1;
1364 /* if it is negative, it should be either -1 or -2 */
1365 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001366}
1367
Tim Peters803526b2002-07-07 05:13:56 +00001368/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001369 Return -1 if an error occurred */
1370
1371int
Fred Drake100814d2000-07-09 15:48:49 +00001372PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001373{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001374 int res;
1375 res = PyObject_IsTrue(v);
1376 if (res < 0)
1377 return res;
1378 return res == 0;
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001379}
1380
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001381/* Test whether an object can be called */
1382
1383int
Fred Drake100814d2000-07-09 15:48:49 +00001384PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001385{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001386 if (x == NULL)
1387 return 0;
1388 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001389}
1390
Tim Peters7eea37e2001-09-04 22:08:56 +00001391
Georg Brandle32b4222007-03-10 22:13:27 +00001392/* Helper for PyObject_Dir without arguments: returns the local scope. */
1393static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001394_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001395{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001396 PyObject *names;
Victor Stinner41bb43a2013-10-29 01:19:37 +01001397 PyObject *locals;
Tim Peters305b5852001-09-17 02:38:46 +00001398
Victor Stinner41bb43a2013-10-29 01:19:37 +01001399 locals = PyEval_GetLocals();
1400 if (locals == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001401 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001402
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001403 names = PyMapping_Keys(locals);
1404 if (!names)
1405 return NULL;
1406 if (!PyList_Check(names)) {
1407 PyErr_Format(PyExc_TypeError,
1408 "dir(): expected keys() of locals to be a list, "
1409 "not '%.200s'", Py_TYPE(names)->tp_name);
1410 Py_DECREF(names);
1411 return NULL;
1412 }
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001413 if (PyList_Sort(names)) {
1414 Py_DECREF(names);
1415 return NULL;
1416 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001417 /* the locals don't need to be DECREF'd */
1418 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001419}
1420
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001421/* Helper for PyObject_Dir: object introspection. */
Georg Brandle32b4222007-03-10 22:13:27 +00001422static PyObject *
1423_dir_object(PyObject *obj)
1424{
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001425 PyObject *result, *sorted;
Benjamin Petersonce798522012-01-22 11:24:29 -05001426 PyObject *dirfunc = _PyObject_LookupSpecial(obj, &PyId___dir__);
Georg Brandle32b4222007-03-10 22:13:27 +00001427
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001428 assert(obj);
1429 if (dirfunc == NULL) {
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001430 if (!PyErr_Occurred())
1431 PyErr_SetString(PyExc_TypeError, "object does not provide __dir__");
1432 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001433 }
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001434 /* use __dir__ */
Victor Stinnerf17c3de2016-12-06 18:46:19 +01001435 result = _PyObject_CallNoArg(dirfunc);
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001436 Py_DECREF(dirfunc);
1437 if (result == NULL)
1438 return NULL;
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001439 /* return sorted(result) */
1440 sorted = PySequence_List(result);
1441 Py_DECREF(result);
1442 if (sorted == NULL)
1443 return NULL;
1444 if (PyList_Sort(sorted)) {
1445 Py_DECREF(sorted);
1446 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001447 }
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001448 return sorted;
Georg Brandle32b4222007-03-10 22:13:27 +00001449}
1450
1451/* Implementation of dir() -- if obj is NULL, returns the names in the current
1452 (local) scope. Otherwise, performs introspection of the object: returns a
1453 sorted list of attribute names (supposedly) accessible from the object
1454*/
1455PyObject *
1456PyObject_Dir(PyObject *obj)
1457{
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001458 return (obj == NULL) ? _dir_locals() : _dir_object(obj);
Tim Peters7eea37e2001-09-04 22:08:56 +00001459}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001460
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001461/*
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001462None is a non-NULL undefined value.
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001463There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001464so there is exactly one (which is indestructible, by the way).
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001465*/
1466
Guido van Rossum0c182a11992-03-27 17:26:13 +00001467/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001468static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001469none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001470{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001471 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001472}
1473
Barry Warsaw9bf16442001-01-23 16:24:35 +00001474/* ARGUSED */
1475static void
Tim Peters803526b2002-07-07 05:13:56 +00001476none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001477{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001478 /* This should never get called, but we also don't want to SEGV if
1479 * we accidentally decref None out of existence.
1480 */
1481 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001482}
1483
Benjamin Petersonc4607ae2011-07-29 18:19:43 -05001484static PyObject *
1485none_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1486{
Serhiy Storchaka5ab81d72016-12-16 16:18:57 +02001487 if (PyTuple_GET_SIZE(args) || (kwargs && PyDict_GET_SIZE(kwargs))) {
Benjamin Petersonc4607ae2011-07-29 18:19:43 -05001488 PyErr_SetString(PyExc_TypeError, "NoneType takes no arguments");
1489 return NULL;
1490 }
1491 Py_RETURN_NONE;
1492}
1493
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001494static int
1495none_bool(PyObject *v)
1496{
1497 return 0;
1498}
1499
1500static PyNumberMethods none_as_number = {
1501 0, /* nb_add */
1502 0, /* nb_subtract */
1503 0, /* nb_multiply */
1504 0, /* nb_remainder */
1505 0, /* nb_divmod */
1506 0, /* nb_power */
1507 0, /* nb_negative */
1508 0, /* nb_positive */
1509 0, /* nb_absolute */
1510 (inquiry)none_bool, /* nb_bool */
1511 0, /* nb_invert */
1512 0, /* nb_lshift */
1513 0, /* nb_rshift */
1514 0, /* nb_and */
1515 0, /* nb_xor */
1516 0, /* nb_or */
1517 0, /* nb_int */
1518 0, /* nb_reserved */
1519 0, /* nb_float */
1520 0, /* nb_inplace_add */
1521 0, /* nb_inplace_subtract */
1522 0, /* nb_inplace_multiply */
1523 0, /* nb_inplace_remainder */
1524 0, /* nb_inplace_power */
1525 0, /* nb_inplace_lshift */
1526 0, /* nb_inplace_rshift */
1527 0, /* nb_inplace_and */
1528 0, /* nb_inplace_xor */
1529 0, /* nb_inplace_or */
1530 0, /* nb_floor_divide */
1531 0, /* nb_true_divide */
1532 0, /* nb_inplace_floor_divide */
1533 0, /* nb_inplace_true_divide */
1534 0, /* nb_index */
1535};
Barry Warsaw9bf16442001-01-23 16:24:35 +00001536
Alexandre Vassalotti65846c62013-11-30 17:55:48 -08001537PyTypeObject _PyNone_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001538 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1539 "NoneType",
1540 0,
1541 0,
1542 none_dealloc, /*tp_dealloc*/ /*never called*/
1543 0, /*tp_print*/
1544 0, /*tp_getattr*/
1545 0, /*tp_setattr*/
1546 0, /*tp_reserved*/
1547 none_repr, /*tp_repr*/
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001548 &none_as_number, /*tp_as_number*/
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001549 0, /*tp_as_sequence*/
1550 0, /*tp_as_mapping*/
1551 0, /*tp_hash */
Benjamin Petersonc4607ae2011-07-29 18:19:43 -05001552 0, /*tp_call */
1553 0, /*tp_str */
1554 0, /*tp_getattro */
1555 0, /*tp_setattro */
1556 0, /*tp_as_buffer */
1557 Py_TPFLAGS_DEFAULT, /*tp_flags */
1558 0, /*tp_doc */
1559 0, /*tp_traverse */
1560 0, /*tp_clear */
1561 0, /*tp_richcompare */
1562 0, /*tp_weaklistoffset */
1563 0, /*tp_iter */
1564 0, /*tp_iternext */
1565 0, /*tp_methods */
1566 0, /*tp_members */
1567 0, /*tp_getset */
1568 0, /*tp_base */
1569 0, /*tp_dict */
1570 0, /*tp_descr_get */
1571 0, /*tp_descr_set */
1572 0, /*tp_dictoffset */
1573 0, /*tp_init */
1574 0, /*tp_alloc */
1575 none_new, /*tp_new */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001576};
1577
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001578PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001579 _PyObject_EXTRA_INIT
Alexandre Vassalotti65846c62013-11-30 17:55:48 -08001580 1, &_PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001581};
1582
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001583/* NotImplemented is an object that can be used to signal that an
1584 operation is not implemented for the given type combination. */
1585
1586static PyObject *
1587NotImplemented_repr(PyObject *op)
1588{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001589 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001590}
1591
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001592static PyObject *
Alexandre Vassalottic49477b2013-11-24 02:53:45 -08001593NotImplemented_reduce(PyObject *op)
1594{
1595 return PyUnicode_FromString("NotImplemented");
1596}
1597
1598static PyMethodDef notimplemented_methods[] = {
1599 {"__reduce__", (PyCFunction)NotImplemented_reduce, METH_NOARGS, NULL},
1600 {NULL, NULL}
1601};
1602
1603static PyObject *
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001604notimplemented_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1605{
Serhiy Storchaka5ab81d72016-12-16 16:18:57 +02001606 if (PyTuple_GET_SIZE(args) || (kwargs && PyDict_GET_SIZE(kwargs))) {
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001607 PyErr_SetString(PyExc_TypeError, "NotImplementedType takes no arguments");
1608 return NULL;
1609 }
Brian Curtindfc80e32011-08-10 20:28:54 -05001610 Py_RETURN_NOTIMPLEMENTED;
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001611}
1612
Armin Ronacher226b1db2012-10-06 14:28:58 +02001613static void
1614notimplemented_dealloc(PyObject* ignore)
1615{
1616 /* This should never get called, but we also don't want to SEGV if
1617 * we accidentally decref NotImplemented out of existence.
1618 */
1619 Py_FatalError("deallocating NotImplemented");
1620}
1621
Alexandre Vassalotti65846c62013-11-30 17:55:48 -08001622PyTypeObject _PyNotImplemented_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001623 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1624 "NotImplementedType",
1625 0,
1626 0,
Armin Ronacher226b1db2012-10-06 14:28:58 +02001627 notimplemented_dealloc, /*tp_dealloc*/ /*never called*/
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001628 0, /*tp_print*/
1629 0, /*tp_getattr*/
1630 0, /*tp_setattr*/
1631 0, /*tp_reserved*/
1632 NotImplemented_repr, /*tp_repr*/
1633 0, /*tp_as_number*/
1634 0, /*tp_as_sequence*/
1635 0, /*tp_as_mapping*/
1636 0, /*tp_hash */
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001637 0, /*tp_call */
1638 0, /*tp_str */
1639 0, /*tp_getattro */
1640 0, /*tp_setattro */
1641 0, /*tp_as_buffer */
1642 Py_TPFLAGS_DEFAULT, /*tp_flags */
1643 0, /*tp_doc */
1644 0, /*tp_traverse */
1645 0, /*tp_clear */
1646 0, /*tp_richcompare */
1647 0, /*tp_weaklistoffset */
1648 0, /*tp_iter */
1649 0, /*tp_iternext */
Alexandre Vassalottic49477b2013-11-24 02:53:45 -08001650 notimplemented_methods, /*tp_methods */
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001651 0, /*tp_members */
1652 0, /*tp_getset */
1653 0, /*tp_base */
1654 0, /*tp_dict */
1655 0, /*tp_descr_get */
1656 0, /*tp_descr_set */
1657 0, /*tp_dictoffset */
1658 0, /*tp_init */
1659 0, /*tp_alloc */
1660 notimplemented_new, /*tp_new */
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001661};
1662
1663PyObject _Py_NotImplementedStruct = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001664 _PyObject_EXTRA_INIT
Alexandre Vassalotti65846c62013-11-30 17:55:48 -08001665 1, &_PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001666};
1667
Guido van Rossumba21a492001-08-16 08:17:26 +00001668void
1669_Py_ReadyTypes(void)
1670{
Victor Stinner5a1bb4e2014-06-02 14:10:59 +02001671 if (PyType_Ready(&PyBaseObject_Type) < 0)
1672 Py_FatalError("Can't initialize object type");
1673
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001674 if (PyType_Ready(&PyType_Type) < 0)
1675 Py_FatalError("Can't initialize type type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001676
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001677 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1678 Py_FatalError("Can't initialize weakref type");
Fred Drake0a4dd392004-07-02 18:57:45 +00001679
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001680 if (PyType_Ready(&_PyWeakref_CallableProxyType) < 0)
1681 Py_FatalError("Can't initialize callable weakref proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001682
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001683 if (PyType_Ready(&_PyWeakref_ProxyType) < 0)
1684 Py_FatalError("Can't initialize weakref proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001685
Victor Stinner5a1bb4e2014-06-02 14:10:59 +02001686 if (PyType_Ready(&PyLong_Type) < 0)
1687 Py_FatalError("Can't initialize int type");
1688
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001689 if (PyType_Ready(&PyBool_Type) < 0)
1690 Py_FatalError("Can't initialize bool type");
Guido van Rossum77f6a652002-04-03 22:41:51 +00001691
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001692 if (PyType_Ready(&PyByteArray_Type) < 0)
1693 Py_FatalError("Can't initialize bytearray type");
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001694
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001695 if (PyType_Ready(&PyBytes_Type) < 0)
1696 Py_FatalError("Can't initialize 'str'");
Guido van Rossumcacfc072002-05-24 19:01:59 +00001697
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001698 if (PyType_Ready(&PyList_Type) < 0)
1699 Py_FatalError("Can't initialize list type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001700
Alexandre Vassalotti65846c62013-11-30 17:55:48 -08001701 if (PyType_Ready(&_PyNone_Type) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001702 Py_FatalError("Can't initialize None type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001703
Alexandre Vassalotti65846c62013-11-30 17:55:48 -08001704 if (PyType_Ready(&_PyNotImplemented_Type) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001705 Py_FatalError("Can't initialize NotImplemented type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001706
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001707 if (PyType_Ready(&PyTraceBack_Type) < 0)
1708 Py_FatalError("Can't initialize traceback type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001709
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001710 if (PyType_Ready(&PySuper_Type) < 0)
1711 Py_FatalError("Can't initialize super type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001712
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001713 if (PyType_Ready(&PyRange_Type) < 0)
1714 Py_FatalError("Can't initialize range type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001715
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001716 if (PyType_Ready(&PyDict_Type) < 0)
1717 Py_FatalError("Can't initialize dict type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001718
Benjamin Petersondb87c992016-11-06 13:01:07 -08001719 if (PyType_Ready(&PyDictKeys_Type) < 0)
1720 Py_FatalError("Can't initialize dict keys type");
1721
1722 if (PyType_Ready(&PyDictValues_Type) < 0)
1723 Py_FatalError("Can't initialize dict values type");
1724
1725 if (PyType_Ready(&PyDictItems_Type) < 0)
1726 Py_FatalError("Can't initialize dict items type");
1727
Eric Snow96c6af92015-05-29 22:21:39 -06001728 if (PyType_Ready(&PyODict_Type) < 0)
1729 Py_FatalError("Can't initialize OrderedDict type");
1730
1731 if (PyType_Ready(&PyODictKeys_Type) < 0)
1732 Py_FatalError("Can't initialize odict_keys type");
1733
1734 if (PyType_Ready(&PyODictItems_Type) < 0)
1735 Py_FatalError("Can't initialize odict_items type");
1736
1737 if (PyType_Ready(&PyODictValues_Type) < 0)
1738 Py_FatalError("Can't initialize odict_values type");
1739
1740 if (PyType_Ready(&PyODictIter_Type) < 0)
1741 Py_FatalError("Can't initialize odict_keyiterator type");
1742
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001743 if (PyType_Ready(&PySet_Type) < 0)
1744 Py_FatalError("Can't initialize set type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001745
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001746 if (PyType_Ready(&PyUnicode_Type) < 0)
1747 Py_FatalError("Can't initialize str type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001748
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001749 if (PyType_Ready(&PySlice_Type) < 0)
1750 Py_FatalError("Can't initialize slice type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001751
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001752 if (PyType_Ready(&PyStaticMethod_Type) < 0)
1753 Py_FatalError("Can't initialize static method type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001754
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001755 if (PyType_Ready(&PyComplex_Type) < 0)
1756 Py_FatalError("Can't initialize complex type");
Skip Montanaroba1e0f42009-10-18 14:25:35 +00001757
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001758 if (PyType_Ready(&PyFloat_Type) < 0)
1759 Py_FatalError("Can't initialize float type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001760
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001761 if (PyType_Ready(&PyFrozenSet_Type) < 0)
1762 Py_FatalError("Can't initialize frozenset type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001763
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001764 if (PyType_Ready(&PyProperty_Type) < 0)
1765 Py_FatalError("Can't initialize property type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001766
Stefan Krah9a2d99e2012-02-25 12:24:21 +01001767 if (PyType_Ready(&_PyManagedBuffer_Type) < 0)
1768 Py_FatalError("Can't initialize managed buffer type");
1769
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001770 if (PyType_Ready(&PyMemoryView_Type) < 0)
1771 Py_FatalError("Can't initialize memoryview type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001772
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001773 if (PyType_Ready(&PyTuple_Type) < 0)
1774 Py_FatalError("Can't initialize tuple type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001775
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001776 if (PyType_Ready(&PyEnum_Type) < 0)
1777 Py_FatalError("Can't initialize enumerate type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001778
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001779 if (PyType_Ready(&PyReversed_Type) < 0)
1780 Py_FatalError("Can't initialize reversed type");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001781
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001782 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1783 Py_FatalError("Can't initialize StdPrinter");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001784
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001785 if (PyType_Ready(&PyCode_Type) < 0)
1786 Py_FatalError("Can't initialize code type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001787
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001788 if (PyType_Ready(&PyFrame_Type) < 0)
1789 Py_FatalError("Can't initialize frame type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001790
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001791 if (PyType_Ready(&PyCFunction_Type) < 0)
1792 Py_FatalError("Can't initialize builtin function type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001793
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001794 if (PyType_Ready(&PyMethod_Type) < 0)
1795 Py_FatalError("Can't initialize method type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001796
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001797 if (PyType_Ready(&PyFunction_Type) < 0)
1798 Py_FatalError("Can't initialize function type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001799
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001800 if (PyType_Ready(&PyDictProxy_Type) < 0)
1801 Py_FatalError("Can't initialize dict proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001802
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001803 if (PyType_Ready(&PyGen_Type) < 0)
1804 Py_FatalError("Can't initialize generator type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001805
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001806 if (PyType_Ready(&PyGetSetDescr_Type) < 0)
1807 Py_FatalError("Can't initialize get-set descriptor type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001808
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001809 if (PyType_Ready(&PyWrapperDescr_Type) < 0)
1810 Py_FatalError("Can't initialize wrapper type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001811
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001812 if (PyType_Ready(&_PyMethodWrapper_Type) < 0)
1813 Py_FatalError("Can't initialize method wrapper type");
1814
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001815 if (PyType_Ready(&PyEllipsis_Type) < 0)
1816 Py_FatalError("Can't initialize ellipsis type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001817
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001818 if (PyType_Ready(&PyMemberDescr_Type) < 0)
1819 Py_FatalError("Can't initialize member descriptor type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001820
Barry Warsaw409da152012-06-03 16:18:47 -04001821 if (PyType_Ready(&_PyNamespace_Type) < 0)
1822 Py_FatalError("Can't initialize namespace type");
Benjamin Petersone8ea97f2012-10-30 23:27:52 -04001823
Benjamin Petersonc4311282012-10-30 23:21:10 -04001824 if (PyType_Ready(&PyCapsule_Type) < 0)
1825 Py_FatalError("Can't initialize capsule type");
1826
1827 if (PyType_Ready(&PyLongRangeIter_Type) < 0)
1828 Py_FatalError("Can't initialize long range iterator type");
1829
1830 if (PyType_Ready(&PyCell_Type) < 0)
1831 Py_FatalError("Can't initialize cell type");
1832
1833 if (PyType_Ready(&PyInstanceMethod_Type) < 0)
1834 Py_FatalError("Can't initialize instance method type");
1835
1836 if (PyType_Ready(&PyClassMethodDescr_Type) < 0)
1837 Py_FatalError("Can't initialize class method descr type");
1838
1839 if (PyType_Ready(&PyMethodDescr_Type) < 0)
1840 Py_FatalError("Can't initialize method descr type");
1841
1842 if (PyType_Ready(&PyCallIter_Type) < 0)
1843 Py_FatalError("Can't initialize call iter type");
1844
1845 if (PyType_Ready(&PySeqIter_Type) < 0)
1846 Py_FatalError("Can't initialize sequence iterator type");
Yury Selivanov5376ba92015-06-22 12:19:30 -04001847
1848 if (PyType_Ready(&PyCoro_Type) < 0)
1849 Py_FatalError("Can't initialize coroutine type");
1850
1851 if (PyType_Ready(&_PyCoroWrapper_Type) < 0)
1852 Py_FatalError("Can't initialize coroutine wrapper type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001853}
1854
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001855
Guido van Rossum84a90321996-05-22 16:34:47 +00001856#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001857
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001858void
Fred Drake100814d2000-07-09 15:48:49 +00001859_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001860{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001861 _Py_INC_REFTOTAL;
1862 op->ob_refcnt = 1;
1863 _Py_AddToAllObjects(op, 1);
1864 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001865}
1866
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001867void
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001868_Py_ForgetReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001869{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001870#ifdef SLOW_UNREF_CHECK
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001871 PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001872#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001873 if (op->ob_refcnt < 0)
1874 Py_FatalError("UNREF negative refcnt");
1875 if (op == &refchain ||
1876 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1877 fprintf(stderr, "* ob\n");
1878 _PyObject_Dump(op);
1879 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1880 _PyObject_Dump(op->_ob_prev->_ob_next);
1881 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1882 _PyObject_Dump(op->_ob_next->_ob_prev);
1883 Py_FatalError("UNREF invalid object");
1884 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001885#ifdef SLOW_UNREF_CHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001886 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1887 if (p == op)
1888 break;
1889 }
1890 if (p == &refchain) /* Not found */
1891 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001892#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001893 op->_ob_next->_ob_prev = op->_ob_prev;
1894 op->_ob_prev->_ob_next = op->_ob_next;
1895 op->_ob_next = op->_ob_prev = NULL;
1896 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001897}
1898
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001899void
Fred Drake100814d2000-07-09 15:48:49 +00001900_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001901{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001902 destructor dealloc = Py_TYPE(op)->tp_dealloc;
1903 _Py_ForgetReference(op);
1904 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001905}
1906
Tim Peters269b2a62003-04-17 19:52:29 +00001907/* Print all live objects. Because PyObject_Print is called, the
1908 * interpreter must be in a healthy state.
1909 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001910void
Fred Drake100814d2000-07-09 15:48:49 +00001911_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001912{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001913 PyObject *op;
1914 fprintf(fp, "Remaining objects:\n");
1915 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
1916 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
1917 if (PyObject_Print(op, fp, 0) != 0)
1918 PyErr_Clear();
1919 putc('\n', fp);
1920 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001921}
1922
Tim Peters269b2a62003-04-17 19:52:29 +00001923/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1924 * doesn't make any calls to the Python C API, so is always safe to call.
1925 */
1926void
1927_Py_PrintReferenceAddresses(FILE *fp)
1928{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001929 PyObject *op;
1930 fprintf(fp, "Remaining object addresses:\n");
1931 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
1932 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
1933 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001934}
1935
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001936PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001937_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001938{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001939 int i, n;
1940 PyObject *t = NULL;
1941 PyObject *res, *op;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001942
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001943 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1944 return NULL;
1945 op = refchain._ob_next;
1946 res = PyList_New(0);
1947 if (res == NULL)
1948 return NULL;
1949 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1950 while (op == self || op == args || op == res || op == t ||
1951 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
1952 op = op->_ob_next;
1953 if (op == &refchain)
1954 return res;
1955 }
1956 if (PyList_Append(res, op) < 0) {
1957 Py_DECREF(res);
1958 return NULL;
1959 }
1960 op = op->_ob_next;
1961 }
1962 return res;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001963}
1964
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001965#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001966
Benjamin Petersonb173f782009-05-05 22:31:58 +00001967
Guido van Rossum84a90321996-05-22 16:34:47 +00001968/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001969Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001970
1971
David Malcolm49526f42012-06-22 14:55:41 -04001972void
1973_PyObject_DebugTypeStats(FILE *out)
1974{
1975 _PyCFunction_DebugMallocStats(out);
1976 _PyDict_DebugMallocStats(out);
1977 _PyFloat_DebugMallocStats(out);
1978 _PyFrame_DebugMallocStats(out);
1979 _PyList_DebugMallocStats(out);
1980 _PyMethod_DebugMallocStats(out);
David Malcolm49526f42012-06-22 14:55:41 -04001981 _PyTuple_DebugMallocStats(out);
1982}
Guido van Rossumb18618d2000-05-03 23:44:39 +00001983
Guido van Rossum86610361998-04-10 22:32:46 +00001984/* These methods are used to control infinite recursion in repr, str, print,
1985 etc. Container objects that may recursively contain themselves,
Martin Panter8d56c022016-05-29 04:13:35 +00001986 e.g. builtin dictionaries and lists, should use Py_ReprEnter() and
Guido van Rossum86610361998-04-10 22:32:46 +00001987 Py_ReprLeave() to avoid infinite recursion.
1988
1989 Py_ReprEnter() returns 0 the first time it is called for a particular
1990 object and 1 every time thereafter. It returns -1 if an exception
1991 occurred. Py_ReprLeave() has no return value.
1992
1993 See dictobject.c and listobject.c for examples of use.
1994*/
1995
Guido van Rossum86610361998-04-10 22:32:46 +00001996int
Fred Drake100814d2000-07-09 15:48:49 +00001997Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001998{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001999 PyObject *dict;
2000 PyObject *list;
2001 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00002002
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002003 dict = PyThreadState_GetDict();
Antoine Pitrou04d17d32014-03-31 22:04:38 +02002004 /* Ignore a missing thread-state, so that this function can be called
2005 early on startup. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002006 if (dict == NULL)
2007 return 0;
Victor Stinner7a07e452013-11-06 18:57:29 +01002008 list = _PyDict_GetItemId(dict, &PyId_Py_Repr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002009 if (list == NULL) {
2010 list = PyList_New(0);
2011 if (list == NULL)
2012 return -1;
Victor Stinner7a07e452013-11-06 18:57:29 +01002013 if (_PyDict_SetItemId(dict, &PyId_Py_Repr, list) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002014 return -1;
2015 Py_DECREF(list);
2016 }
2017 i = PyList_GET_SIZE(list);
2018 while (--i >= 0) {
2019 if (PyList_GET_ITEM(list, i) == obj)
2020 return 1;
2021 }
Victor Stinnere901d1f2013-07-17 21:58:41 +02002022 if (PyList_Append(list, obj) < 0)
2023 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002024 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00002025}
2026
2027void
Fred Drake100814d2000-07-09 15:48:49 +00002028Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00002029{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002030 PyObject *dict;
2031 PyObject *list;
2032 Py_ssize_t i;
Victor Stinner1b634932013-07-16 22:24:44 +02002033 PyObject *error_type, *error_value, *error_traceback;
2034
2035 PyErr_Fetch(&error_type, &error_value, &error_traceback);
Guido van Rossum86610361998-04-10 22:32:46 +00002036
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002037 dict = PyThreadState_GetDict();
2038 if (dict == NULL)
Victor Stinner1b634932013-07-16 22:24:44 +02002039 goto finally;
2040
Victor Stinner7a07e452013-11-06 18:57:29 +01002041 list = _PyDict_GetItemId(dict, &PyId_Py_Repr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002042 if (list == NULL || !PyList_Check(list))
Victor Stinner1b634932013-07-16 22:24:44 +02002043 goto finally;
2044
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002045 i = PyList_GET_SIZE(list);
2046 /* Count backwards because we always expect obj to be list[-1] */
2047 while (--i >= 0) {
2048 if (PyList_GET_ITEM(list, i) == obj) {
2049 PyList_SetSlice(list, i, i + 1, NULL);
2050 break;
2051 }
2052 }
Victor Stinner1b634932013-07-16 22:24:44 +02002053
2054finally:
2055 /* ignore exceptions because there is no way to report them. */
2056 PyErr_Restore(error_type, error_value, error_traceback);
Guido van Rossum86610361998-04-10 22:32:46 +00002057}
Guido van Rossumd724b232000-03-13 16:01:29 +00002058
Tim Peters803526b2002-07-07 05:13:56 +00002059/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00002060
Tim Peters803526b2002-07-07 05:13:56 +00002061/* Add op to the _PyTrash_delete_later list. Called when the current
2062 * call-stack depth gets large. op must be a currently untracked gc'ed
2063 * object, with refcount 0. Py_DECREF must already have been called on it.
2064 */
Guido van Rossumd724b232000-03-13 16:01:29 +00002065void
Fred Drake100814d2000-07-09 15:48:49 +00002066_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00002067{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002068 assert(PyObject_IS_GC(op));
Antoine Pitrou796564c2013-07-30 19:59:21 +02002069 assert(_PyGC_REFS(op) == _PyGC_REFS_UNTRACKED);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002070 assert(op->ob_refcnt == 0);
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002071 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyRuntime.gc.trash_delete_later;
2072 _PyRuntime.gc.trash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00002073}
2074
Antoine Pitrou2b0218a2012-09-06 00:59:49 +02002075/* The equivalent API, using per-thread state recursion info */
2076void
2077_PyTrash_thread_deposit_object(PyObject *op)
2078{
2079 PyThreadState *tstate = PyThreadState_GET();
2080 assert(PyObject_IS_GC(op));
Antoine Pitrou796564c2013-07-30 19:59:21 +02002081 assert(_PyGC_REFS(op) == _PyGC_REFS_UNTRACKED);
Antoine Pitrou2b0218a2012-09-06 00:59:49 +02002082 assert(op->ob_refcnt == 0);
2083 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *) tstate->trash_delete_later;
2084 tstate->trash_delete_later = op;
2085}
2086
Tim Peters803526b2002-07-07 05:13:56 +00002087/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
2088 * the call-stack unwinds again.
2089 */
Guido van Rossumd724b232000-03-13 16:01:29 +00002090void
Fred Drake100814d2000-07-09 15:48:49 +00002091_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00002092{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002093 while (_PyRuntime.gc.trash_delete_later) {
2094 PyObject *op = _PyRuntime.gc.trash_delete_later;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002095 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00002096
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002097 _PyRuntime.gc.trash_delete_later =
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002098 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00002099
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002100 /* Call the deallocator directly. This used to try to
2101 * fool Py_DECREF into calling it indirectly, but
2102 * Py_DECREF was already called on this object, and in
2103 * assorted non-release builds calling Py_DECREF again ends
2104 * up distorting allocation statistics.
2105 */
2106 assert(op->ob_refcnt == 0);
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002107 ++_PyRuntime.gc.trash_delete_nesting;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002108 (*dealloc)(op);
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002109 --_PyRuntime.gc.trash_delete_nesting;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002110 }
Guido van Rossumd724b232000-03-13 16:01:29 +00002111}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002112
Antoine Pitrou2b0218a2012-09-06 00:59:49 +02002113/* The equivalent API, using per-thread state recursion info */
2114void
2115_PyTrash_thread_destroy_chain(void)
2116{
2117 PyThreadState *tstate = PyThreadState_GET();
Xiang Zhanga66f9c62017-05-13 13:36:14 +08002118 /* We need to increase trash_delete_nesting here, otherwise,
2119 _PyTrash_thread_destroy_chain will be called recursively
2120 and then possibly crash. An example that may crash without
2121 increase:
2122 N = 500000 # need to be large enough
2123 ob = object()
2124 tups = [(ob,) for i in range(N)]
2125 for i in range(49):
2126 tups = [(tup,) for tup in tups]
2127 del tups
2128 */
2129 assert(tstate->trash_delete_nesting == 0);
2130 ++tstate->trash_delete_nesting;
Antoine Pitrou2b0218a2012-09-06 00:59:49 +02002131 while (tstate->trash_delete_later) {
2132 PyObject *op = tstate->trash_delete_later;
2133 destructor dealloc = Py_TYPE(op)->tp_dealloc;
2134
2135 tstate->trash_delete_later =
2136 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
2137
2138 /* Call the deallocator directly. This used to try to
2139 * fool Py_DECREF into calling it indirectly, but
2140 * Py_DECREF was already called on this object, and in
2141 * assorted non-release builds calling Py_DECREF again ends
2142 * up distorting allocation statistics.
2143 */
2144 assert(op->ob_refcnt == 0);
Antoine Pitrou2b0218a2012-09-06 00:59:49 +02002145 (*dealloc)(op);
Xiang Zhanga66f9c62017-05-13 13:36:14 +08002146 assert(tstate->trash_delete_nesting == 1);
Antoine Pitrou2b0218a2012-09-06 00:59:49 +02002147 }
Xiang Zhanga66f9c62017-05-13 13:36:14 +08002148 --tstate->trash_delete_nesting;
Antoine Pitrou2b0218a2012-09-06 00:59:49 +02002149}
2150
Martin v. Löwis4d0d4712010-12-03 20:14:31 +00002151#ifndef Py_TRACE_REFS
2152/* For Py_LIMITED_API, we need an out-of-line version of _Py_Dealloc.
2153 Define this here, so we can undefine the macro. */
2154#undef _Py_Dealloc
2155PyAPI_FUNC(void) _Py_Dealloc(PyObject *);
2156void
2157_Py_Dealloc(PyObject *op)
2158{
2159 _Py_INC_TPFREES(op) _Py_COUNT_ALLOCS_COMMA
2160 (*Py_TYPE(op)->tp_dealloc)(op);
2161}
2162#endif
2163
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002164#ifdef __cplusplus
2165}
2166#endif