blob: b2a549252a812babb28f7bcf3db972265ff0e02e [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum3f5da241990-12-20 15:06:42 +00002/* Generic object operations; and implementation of None (NoObject) */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004#include "Python.h"
Guido van Rossum50e9fb92006-08-17 05:42:55 +00005#include "sliceobject.h" /* For PyEllipsis_Type */
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
Tim Peters34592512002-07-11 06:23:50 +000012#ifdef Py_REF_DEBUG
Neal Norwitz84632ee2006-03-04 20:00:59 +000013Py_ssize_t _Py_RefTotal;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000014
15Py_ssize_t
16_Py_GetRefTotal(void)
17{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000018 PyObject *o;
19 Py_ssize_t total = _Py_RefTotal;
20 /* ignore the references to the dummy object of the dicts and sets
21 because they are not reliable and not useful (now that the
22 hash table code is well-tested) */
23 o = _PyDict_Dummy();
24 if (o != NULL)
25 total -= o->ob_refcnt;
26 o = _PySet_Dummy();
27 if (o != NULL)
28 total -= o->ob_refcnt;
29 return total;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000030}
31#endif /* Py_REF_DEBUG */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000032
Mark Hammonda2905272002-07-29 13:42:14 +000033int Py_DivisionWarningFlag;
Guido van Rossum393661d2001-08-31 17:40:15 +000034
Guido van Rossum3f5da241990-12-20 15:06:42 +000035/* Object allocation routines used by NEWOBJ and NEWVAROBJ macros.
36 These are used by the individual routines for object creation.
37 Do not call them otherwise, they do not initialize the object! */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000038
Tim Peters78be7992003-03-23 02:51:01 +000039#ifdef Py_TRACE_REFS
Tim Peters7571a0f2003-03-23 17:52:28 +000040/* Head of circular doubly-linked list of all objects. These are linked
41 * together via the _ob_prev and _ob_next members of a PyObject, which
42 * exist only in a Py_TRACE_REFS build.
43 */
Tim Peters78be7992003-03-23 02:51:01 +000044static PyObject refchain = {&refchain, &refchain};
Tim Peters36eb4df2003-03-23 03:33:13 +000045
Tim Peters7571a0f2003-03-23 17:52:28 +000046/* Insert op at the front of the list of all objects. If force is true,
47 * op is added even if _ob_prev and _ob_next are non-NULL already. If
48 * force is false amd _ob_prev or _ob_next are non-NULL, do nothing.
49 * force should be true if and only if op points to freshly allocated,
50 * uninitialized memory, or you've unlinked op from the list and are
Tim Peters51f8d382003-03-23 18:06:08 +000051 * relinking it into the front.
Tim Peters7571a0f2003-03-23 17:52:28 +000052 * Note that objects are normally added to the list via _Py_NewReference,
53 * which is called by PyObject_Init. Not all objects are initialized that
54 * way, though; exceptions include statically allocated type objects, and
55 * statically allocated singletons (like Py_True and Py_None).
56 */
Tim Peters36eb4df2003-03-23 03:33:13 +000057void
Tim Peters7571a0f2003-03-23 17:52:28 +000058_Py_AddToAllObjects(PyObject *op, int force)
Tim Peters36eb4df2003-03-23 03:33:13 +000059{
Tim Peters7571a0f2003-03-23 17:52:28 +000060#ifdef Py_DEBUG
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000061 if (!force) {
62 /* If it's initialized memory, op must be in or out of
63 * the list unambiguously.
64 */
65 assert((op->_ob_prev == NULL) == (op->_ob_next == NULL));
66 }
Tim Peters78be7992003-03-23 02:51:01 +000067#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000068 if (force || op->_ob_prev == NULL) {
69 op->_ob_next = refchain._ob_next;
70 op->_ob_prev = &refchain;
71 refchain._ob_next->_ob_prev = op;
72 refchain._ob_next = op;
73 }
Tim Peters7571a0f2003-03-23 17:52:28 +000074}
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000075#endif /* Py_TRACE_REFS */
Tim Peters78be7992003-03-23 02:51:01 +000076
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000077#ifdef COUNT_ALLOCS
Guido van Rossumc0b618a1997-05-02 03:12:38 +000078static PyTypeObject *type_list;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000079/* All types are added to type_list, at least when
80 they get one object created. That makes them
81 immortal, which unfortunately contributes to
82 garbage itself. If unlist_types_without_objects
83 is set, they will be removed from the type_list
84 once the last object is deallocated. */
Benjamin Petersona4a37fe2009-01-11 17:13:55 +000085static int unlist_types_without_objects;
86extern Py_ssize_t tuple_zero_allocs, fast_tuple_allocs;
87extern Py_ssize_t quick_int_allocs, quick_neg_int_allocs;
88extern Py_ssize_t null_strings, one_strings;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000089void
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000090dump_counts(FILE* f)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000091{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000092 PyTypeObject *tp;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000093
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000094 for (tp = type_list; tp; tp = tp->tp_next)
95 fprintf(f, "%s alloc'd: %" PY_FORMAT_SIZE_T "d, "
96 "freed: %" PY_FORMAT_SIZE_T "d, "
97 "max in use: %" PY_FORMAT_SIZE_T "d\n",
98 tp->tp_name, tp->tp_allocs, tp->tp_frees,
99 tp->tp_maxalloc);
100 fprintf(f, "fast tuple allocs: %" PY_FORMAT_SIZE_T "d, "
101 "empty: %" PY_FORMAT_SIZE_T "d\n",
102 fast_tuple_allocs, tuple_zero_allocs);
103 fprintf(f, "fast int allocs: pos: %" PY_FORMAT_SIZE_T "d, "
104 "neg: %" PY_FORMAT_SIZE_T "d\n",
105 quick_int_allocs, quick_neg_int_allocs);
106 fprintf(f, "null strings: %" PY_FORMAT_SIZE_T "d, "
107 "1-strings: %" PY_FORMAT_SIZE_T "d\n",
108 null_strings, one_strings);
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000109}
110
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000111PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000112get_counts(void)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000113{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000114 PyTypeObject *tp;
115 PyObject *result;
116 PyObject *v;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000117
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000118 result = PyList_New(0);
119 if (result == NULL)
120 return NULL;
121 for (tp = type_list; tp; tp = tp->tp_next) {
122 v = Py_BuildValue("(snnn)", tp->tp_name, tp->tp_allocs,
123 tp->tp_frees, tp->tp_maxalloc);
124 if (v == NULL) {
125 Py_DECREF(result);
126 return NULL;
127 }
128 if (PyList_Append(result, v) < 0) {
129 Py_DECREF(v);
130 Py_DECREF(result);
131 return NULL;
132 }
133 Py_DECREF(v);
134 }
135 return result;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000136}
137
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000138void
Fred Drake100814d2000-07-09 15:48:49 +0000139inc_count(PyTypeObject *tp)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000140{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000141 if (tp->tp_next == NULL && tp->tp_prev == NULL) {
142 /* first time; insert in linked list */
143 if (tp->tp_next != NULL) /* sanity check */
144 Py_FatalError("XXX inc_count sanity check");
145 if (type_list)
146 type_list->tp_prev = tp;
147 tp->tp_next = type_list;
148 /* Note that as of Python 2.2, heap-allocated type objects
149 * can go away, but this code requires that they stay alive
150 * until program exit. That's why we're careful with
151 * refcounts here. type_list gets a new reference to tp,
152 * while ownership of the reference type_list used to hold
153 * (if any) was transferred to tp->tp_next in the line above.
154 * tp is thus effectively immortal after this.
155 */
156 Py_INCREF(tp);
157 type_list = tp;
Tim Peters3e40c7f2003-03-23 03:04:32 +0000158#ifdef Py_TRACE_REFS
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000159 /* Also insert in the doubly-linked list of all objects,
160 * if not already there.
161 */
162 _Py_AddToAllObjects((PyObject *)tp, 0);
Tim Peters78be7992003-03-23 02:51:01 +0000163#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000164 }
165 tp->tp_allocs++;
166 if (tp->tp_allocs - tp->tp_frees > tp->tp_maxalloc)
167 tp->tp_maxalloc = tp->tp_allocs - tp->tp_frees;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000168}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000169
170void dec_count(PyTypeObject *tp)
171{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000172 tp->tp_frees++;
173 if (unlist_types_without_objects &&
174 tp->tp_allocs == tp->tp_frees) {
175 /* unlink the type from type_list */
176 if (tp->tp_prev)
177 tp->tp_prev->tp_next = tp->tp_next;
178 else
179 type_list = tp->tp_next;
180 if (tp->tp_next)
181 tp->tp_next->tp_prev = tp->tp_prev;
182 tp->tp_next = tp->tp_prev = NULL;
183 Py_DECREF(tp);
184 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000185}
186
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000187#endif
188
Tim Peters7c321a82002-07-09 02:57:01 +0000189#ifdef Py_REF_DEBUG
190/* Log a fatal error; doesn't return. */
191void
192_Py_NegativeRefcount(const char *fname, int lineno, PyObject *op)
193{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000194 char buf[300];
Tim Peters7c321a82002-07-09 02:57:01 +0000195
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000196 PyOS_snprintf(buf, sizeof(buf),
197 "%s:%i object at %p has negative ref count "
198 "%" PY_FORMAT_SIZE_T "d",
199 fname, lineno, op, op->ob_refcnt);
200 Py_FatalError(buf);
Tim Peters7c321a82002-07-09 02:57:01 +0000201}
202
203#endif /* Py_REF_DEBUG */
204
Thomas Heller1328b522004-04-22 17:23:49 +0000205void
206Py_IncRef(PyObject *o)
207{
208 Py_XINCREF(o);
209}
210
211void
212Py_DecRef(PyObject *o)
213{
214 Py_XDECREF(o);
215}
216
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000217PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000218PyObject_Init(PyObject *op, PyTypeObject *tp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000219{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000220 if (op == NULL)
221 return PyErr_NoMemory();
222 /* Any changes should be reflected in PyObject_INIT (objimpl.h) */
223 Py_TYPE(op) = tp;
224 _Py_NewReference(op);
225 return op;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000226}
227
Guido van Rossumb18618d2000-05-03 23:44:39 +0000228PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000229PyObject_InitVar(PyVarObject *op, PyTypeObject *tp, Py_ssize_t size)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000230{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000231 if (op == NULL)
232 return (PyVarObject *) PyErr_NoMemory();
233 /* Any changes should be reflected in PyObject_INIT_VAR */
234 op->ob_size = size;
235 Py_TYPE(op) = tp;
236 _Py_NewReference((PyObject *)op);
237 return op;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000238}
239
240PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000241_PyObject_New(PyTypeObject *tp)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000242{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000243 PyObject *op;
244 op = (PyObject *) PyObject_MALLOC(_PyObject_SIZE(tp));
245 if (op == NULL)
246 return PyErr_NoMemory();
247 return PyObject_INIT(op, tp);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000248}
249
Guido van Rossumd0c87ee1997-05-15 21:31:03 +0000250PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000251_PyObject_NewVar(PyTypeObject *tp, Py_ssize_t nitems)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000252{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000253 PyVarObject *op;
254 const size_t size = _PyObject_VAR_SIZE(tp, nitems);
255 op = (PyVarObject *) PyObject_MALLOC(size);
256 if (op == NULL)
257 return (PyVarObject *)PyErr_NoMemory();
258 return PyObject_INIT_VAR(op, tp, nitems);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000259}
260
Neal Norwitz1a997502003-01-13 20:13:12 +0000261/* Implementation of PyObject_Print with recursion checking */
262static int
263internal_print(PyObject *op, FILE *fp, int flags, int nesting)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000264{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000265 int ret = 0;
266 if (nesting > 10) {
267 PyErr_SetString(PyExc_RuntimeError, "print recursion");
268 return -1;
269 }
270 if (PyErr_CheckSignals())
271 return -1;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000272#ifdef USE_STACKCHECK
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000273 if (PyOS_CheckStack()) {
274 PyErr_SetString(PyExc_MemoryError, "stack overflow");
275 return -1;
276 }
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000277#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000278 clearerr(fp); /* Clear any previous error condition */
279 if (op == NULL) {
280 Py_BEGIN_ALLOW_THREADS
281 fprintf(fp, "<nil>");
282 Py_END_ALLOW_THREADS
283 }
284 else {
285 if (op->ob_refcnt <= 0)
286 /* XXX(twouters) cast refcount to long until %zd is
287 universally available */
288 Py_BEGIN_ALLOW_THREADS
289 fprintf(fp, "<refcnt %ld at %p>",
290 (long)op->ob_refcnt, op);
291 Py_END_ALLOW_THREADS
292 else {
293 PyObject *s;
294 if (flags & Py_PRINT_RAW)
295 s = PyObject_Str(op);
296 else
297 s = PyObject_Repr(op);
298 if (s == NULL)
299 ret = -1;
300 else if (PyBytes_Check(s)) {
301 fwrite(PyBytes_AS_STRING(s), 1,
302 PyBytes_GET_SIZE(s), fp);
303 }
304 else if (PyUnicode_Check(s)) {
305 PyObject *t;
Victor Stinner2e71d012010-05-17 09:35:44 +0000306 t = PyUnicode_EncodeUTF8(PyUnicode_AS_UNICODE(s),
307 PyUnicode_GET_SIZE(s),
308 "backslashreplace");
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000309 if (t == NULL)
310 ret = 0;
311 else {
312 fwrite(PyBytes_AS_STRING(t), 1,
313 PyBytes_GET_SIZE(t), fp);
Victor Stinner2e71d012010-05-17 09:35:44 +0000314 Py_DECREF(t);
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000315 }
316 }
317 else {
318 PyErr_Format(PyExc_TypeError,
319 "str() or repr() returned '%.100s'",
320 s->ob_type->tp_name);
321 ret = -1;
322 }
323 Py_XDECREF(s);
324 }
325 }
326 if (ret == 0) {
327 if (ferror(fp)) {
328 PyErr_SetFromErrno(PyExc_IOError);
329 clearerr(fp);
330 ret = -1;
331 }
332 }
333 return ret;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000334}
335
Neal Norwitz1a997502003-01-13 20:13:12 +0000336int
337PyObject_Print(PyObject *op, FILE *fp, int flags)
338{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000339 return internal_print(op, fp, flags, 0);
Neal Norwitz1a997502003-01-13 20:13:12 +0000340}
341
Guido van Rossum38938152006-08-21 23:36:26 +0000342/* For debugging convenience. Set a breakpoint here and call it from your DLL */
343void
Thomas Woutersb2137042007-02-01 18:02:27 +0000344_Py_BreakPoint(void)
Guido van Rossum38938152006-08-21 23:36:26 +0000345{
346}
347
Neal Norwitz1a997502003-01-13 20:13:12 +0000348
Barry Warsaw9bf16442001-01-23 16:24:35 +0000349/* For debugging convenience. See Misc/gdbinit for some useful gdb hooks */
Guido van Rossum38938152006-08-21 23:36:26 +0000350void
351_PyObject_Dump(PyObject* op)
Barry Warsaw9bf16442001-01-23 16:24:35 +0000352{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000353 if (op == NULL)
354 fprintf(stderr, "NULL\n");
355 else {
Georg Brandldfd73442009-04-05 11:47:34 +0000356#ifdef WITH_THREAD
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000357 PyGILState_STATE gil;
Georg Brandldfd73442009-04-05 11:47:34 +0000358#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000359 fprintf(stderr, "object : ");
Georg Brandldfd73442009-04-05 11:47:34 +0000360#ifdef WITH_THREAD
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000361 gil = PyGILState_Ensure();
Georg Brandldfd73442009-04-05 11:47:34 +0000362#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000363 (void)PyObject_Print(op, stderr, 0);
Georg Brandldfd73442009-04-05 11:47:34 +0000364#ifdef WITH_THREAD
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000365 PyGILState_Release(gil);
Georg Brandldfd73442009-04-05 11:47:34 +0000366#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000367 /* XXX(twouters) cast refcount to long until %zd is
368 universally available */
369 fprintf(stderr, "\n"
370 "type : %s\n"
371 "refcount: %ld\n"
372 "address : %p\n",
373 Py_TYPE(op)==NULL ? "NULL" : Py_TYPE(op)->tp_name,
374 (long)op->ob_refcnt,
375 op);
376 }
Barry Warsaw9bf16442001-01-23 16:24:35 +0000377}
Barry Warsaw903138f2001-01-23 16:33:18 +0000378
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000379PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000380PyObject_Repr(PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000381{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000382 PyObject *res;
383 if (PyErr_CheckSignals())
384 return NULL;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000385#ifdef USE_STACKCHECK
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000386 if (PyOS_CheckStack()) {
387 PyErr_SetString(PyExc_MemoryError, "stack overflow");
388 return NULL;
389 }
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000390#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000391 if (v == NULL)
392 return PyUnicode_FromString("<NULL>");
393 if (Py_TYPE(v)->tp_repr == NULL)
394 return PyUnicode_FromFormat("<%s object at %p>",
395 v->ob_type->tp_name, v);
396 res = (*v->ob_type->tp_repr)(v);
397 if (res != NULL && !PyUnicode_Check(res)) {
398 PyErr_Format(PyExc_TypeError,
399 "__repr__ returned non-string (type %.200s)",
400 res->ob_type->tp_name);
401 Py_DECREF(res);
402 return NULL;
403 }
404 return res;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000405}
406
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000407PyObject *
Guido van Rossum98297ee2007-11-06 21:34:58 +0000408PyObject_Str(PyObject *v)
Guido van Rossumc6004111993-11-05 10:22:19 +0000409{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000410 PyObject *res;
411 if (PyErr_CheckSignals())
412 return NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000413#ifdef USE_STACKCHECK
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000414 if (PyOS_CheckStack()) {
415 PyErr_SetString(PyExc_MemoryError, "stack overflow");
416 return NULL;
417 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000418#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000419 if (v == NULL)
420 return PyUnicode_FromString("<NULL>");
421 if (PyUnicode_CheckExact(v)) {
422 Py_INCREF(v);
423 return v;
424 }
425 if (Py_TYPE(v)->tp_str == NULL)
426 return PyObject_Repr(v);
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000427
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000428 /* It is possible for a type to have a tp_str representation that loops
429 infinitely. */
430 if (Py_EnterRecursiveCall(" while getting the str of an object"))
431 return NULL;
432 res = (*Py_TYPE(v)->tp_str)(v);
433 Py_LeaveRecursiveCall();
434 if (res == NULL)
435 return NULL;
436 if (!PyUnicode_Check(res)) {
437 PyErr_Format(PyExc_TypeError,
438 "__str__ returned non-string (type %.200s)",
439 Py_TYPE(res)->tp_name);
440 Py_DECREF(res);
441 return NULL;
442 }
443 return res;
Neil Schemenauercf52c072005-08-12 17:34:58 +0000444}
445
Georg Brandl559e5d72008-06-11 18:37:52 +0000446PyObject *
447PyObject_ASCII(PyObject *v)
448{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000449 PyObject *repr, *ascii, *res;
Georg Brandl559e5d72008-06-11 18:37:52 +0000450
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000451 repr = PyObject_Repr(v);
452 if (repr == NULL)
453 return NULL;
Georg Brandl559e5d72008-06-11 18:37:52 +0000454
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000455 /* repr is guaranteed to be a PyUnicode object by PyObject_Repr */
456 ascii = PyUnicode_EncodeASCII(
457 PyUnicode_AS_UNICODE(repr),
458 PyUnicode_GET_SIZE(repr),
459 "backslashreplace");
Georg Brandl559e5d72008-06-11 18:37:52 +0000460
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000461 Py_DECREF(repr);
462 if (ascii == NULL)
463 return NULL;
Georg Brandl559e5d72008-06-11 18:37:52 +0000464
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000465 res = PyUnicode_DecodeASCII(
466 PyBytes_AS_STRING(ascii),
467 PyBytes_GET_SIZE(ascii),
468 NULL);
469
470 Py_DECREF(ascii);
471 return res;
Georg Brandl559e5d72008-06-11 18:37:52 +0000472}
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000473
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000474PyObject *
475PyObject_Bytes(PyObject *v)
476{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000477 PyObject *result, *func;
478 static PyObject *bytesstring = NULL;
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000479
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000480 if (v == NULL)
481 return PyBytes_FromString("<NULL>");
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000482
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000483 if (PyBytes_CheckExact(v)) {
484 Py_INCREF(v);
485 return v;
486 }
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000487
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000488 func = _PyObject_LookupSpecial(v, "__bytes__", &bytesstring);
489 if (func != NULL) {
490 result = PyObject_CallFunctionObjArgs(func, NULL);
491 Py_DECREF(func);
492 if (result == NULL)
493 return NULL;
494 if (!PyBytes_Check(result)) {
495 PyErr_Format(PyExc_TypeError,
496 "__bytes__ returned non-bytes (type %.200s)",
497 Py_TYPE(result)->tp_name);
498 Py_DECREF(result);
499 return NULL;
500 }
501 return result;
502 }
503 else if (PyErr_Occurred())
504 return NULL;
505 return PyBytes_FromObject(v);
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000506}
507
Mark Dickinsonc008a172009-02-01 13:59:22 +0000508/* For Python 3.0.1 and later, the old three-way comparison has been
509 completely removed in favour of rich comparisons. PyObject_Compare() and
510 PyObject_Cmp() are gone, and the builtin cmp function no longer exists.
Mark Dickinsone94c6792009-02-02 20:36:42 +0000511 The old tp_compare slot has been renamed to tp_reserved, and should no
Mark Dickinsonc008a172009-02-01 13:59:22 +0000512 longer be used. Use tp_richcompare instead.
Guido van Rossum98297ee2007-11-06 21:34:58 +0000513
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000514 See (*) below for practical amendments.
515
Mark Dickinsonc008a172009-02-01 13:59:22 +0000516 tp_richcompare gets called with a first argument of the appropriate type
517 and a second object of an arbitrary type. We never do any kind of
518 coercion.
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000519
Mark Dickinsonc008a172009-02-01 13:59:22 +0000520 The tp_richcompare slot should return an object, as follows:
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000521
522 NULL if an exception occurred
523 NotImplemented if the requested comparison is not implemented
524 any other false value if the requested comparison is false
525 any other true value if the requested comparison is true
526
527 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
528 NotImplemented.
529
530 (*) Practical amendments:
531
532 - If rich comparison returns NotImplemented, == and != are decided by
533 comparing the object pointer (i.e. falling back to the base object
534 implementation).
535
Guido van Rossuma4073002002-05-31 20:03:54 +0000536*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000537
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000538/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000539int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000540
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000541static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000542
543/* Perform a rich comparison, raising TypeError when the requested comparison
544 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000545static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000546do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000547{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000548 richcmpfunc f;
549 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000550
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000551 if (v->ob_type != w->ob_type &&
552 PyType_IsSubtype(w->ob_type, v->ob_type) &&
553 (f = w->ob_type->tp_richcompare) != NULL) {
554 res = (*f)(w, v, _Py_SwappedOp[op]);
555 if (res != Py_NotImplemented)
556 return res;
557 Py_DECREF(res);
558 }
559 if ((f = v->ob_type->tp_richcompare) != NULL) {
560 res = (*f)(v, w, op);
561 if (res != Py_NotImplemented)
562 return res;
563 Py_DECREF(res);
564 }
565 if ((f = w->ob_type->tp_richcompare) != NULL) {
566 res = (*f)(w, v, _Py_SwappedOp[op]);
567 if (res != Py_NotImplemented)
568 return res;
569 Py_DECREF(res);
570 }
571 /* If neither object implements it, provide a sensible default
572 for == and !=, but raise an exception for ordering. */
573 switch (op) {
574 case Py_EQ:
575 res = (v == w) ? Py_True : Py_False;
576 break;
577 case Py_NE:
578 res = (v != w) ? Py_True : Py_False;
579 break;
580 default:
581 /* XXX Special-case None so it doesn't show as NoneType() */
582 PyErr_Format(PyExc_TypeError,
583 "unorderable types: %.100s() %s %.100s()",
584 v->ob_type->tp_name,
585 opstrings[op],
586 w->ob_type->tp_name);
587 return NULL;
588 }
589 Py_INCREF(res);
590 return res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000591}
592
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000593/* Perform a rich comparison with object result. This wraps do_richcompare()
594 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000595
Guido van Rossume797ec12001-01-17 15:24:28 +0000596PyObject *
597PyObject_RichCompare(PyObject *v, PyObject *w, int op)
598{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000599 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000600
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000601 assert(Py_LT <= op && op <= Py_GE);
602 if (v == NULL || w == NULL) {
603 if (!PyErr_Occurred())
604 PyErr_BadInternalCall();
605 return NULL;
606 }
607 if (Py_EnterRecursiveCall(" in comparison"))
608 return NULL;
609 res = do_richcompare(v, w, op);
610 Py_LeaveRecursiveCall();
611 return res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000612}
613
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000614/* Perform a rich comparison with integer result. This wraps
615 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000616int
617PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
618{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000619 PyObject *res;
620 int ok;
Guido van Rossume797ec12001-01-17 15:24:28 +0000621
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000622 /* Quick result when objects are the same.
623 Guarantees that identity implies equality. */
624 if (v == w) {
625 if (op == Py_EQ)
626 return 1;
627 else if (op == Py_NE)
628 return 0;
629 }
Mark Dickinson4a1f5932008-11-12 23:23:36 +0000630
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000631 res = PyObject_RichCompare(v, w, op);
632 if (res == NULL)
633 return -1;
634 if (PyBool_Check(res))
635 ok = (res == Py_True);
636 else
637 ok = PyObject_IsTrue(res);
638 Py_DECREF(res);
639 return ok;
Guido van Rossume797ec12001-01-17 15:24:28 +0000640}
Fred Drake13634cf2000-06-29 19:17:04 +0000641
642/* Set of hash utility functions to help maintaining the invariant that
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000643 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000644
645 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
646*/
647
648long
Fred Drake100814d2000-07-09 15:48:49 +0000649_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000650{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000651 double intpart, fractpart;
652 int expo;
653 long hipart;
654 long x; /* the final hash value */
655 /* This is designed so that Python numbers of different types
656 * that compare equal hash to the same value; otherwise comparisons
657 * of mapping keys will turn out weird.
658 */
Tim Peters39dce292000-08-15 03:34:48 +0000659
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000660 fractpart = modf(v, &intpart);
661 if (fractpart == 0.0) {
662 /* This must return the same hash as an equal int or long. */
663 if (intpart > LONG_MAX/2 || -intpart > LONG_MAX/2) {
664 /* Convert to long and use its hash. */
665 PyObject *plong; /* converted to Python long */
666 if (Py_IS_INFINITY(intpart))
667 /* can't convert to long int -- arbitrary */
668 v = v < 0 ? -271828.0 : 314159.0;
669 plong = PyLong_FromDouble(v);
670 if (plong == NULL)
671 return -1;
672 x = PyObject_Hash(plong);
673 Py_DECREF(plong);
674 return x;
675 }
676 /* Fits in a C long == a Python int, so is its own hash. */
677 x = (long)intpart;
678 if (x == -1)
679 x = -2;
680 return x;
681 }
682 /* The fractional part is non-zero, so we don't have to worry about
683 * making this match the hash of some other type.
684 * Use frexp to get at the bits in the double.
685 * Since the VAX D double format has 56 mantissa bits, which is the
686 * most of any double format in use, each of these parts may have as
687 * many as (but no more than) 56 significant bits.
688 * So, assuming sizeof(long) >= 4, each part can be broken into two
689 * longs; frexp and multiplication are used to do that.
690 * Also, since the Cray double format has 15 exponent bits, which is
691 * the most of any double format in use, shifting the exponent field
692 * left by 15 won't overflow a long (again assuming sizeof(long) >= 4).
693 */
694 v = frexp(v, &expo);
695 v *= 2147483648.0; /* 2**31 */
696 hipart = (long)v; /* take the top 32 bits */
697 v = (v - (double)hipart) * 2147483648.0; /* get the next 32 bits */
698 x = hipart + (long)v + (expo << 15);
699 if (x == -1)
700 x = -2;
701 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000702}
703
704long
Fred Drake100814d2000-07-09 15:48:49 +0000705_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000706{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000707 long x;
708 size_t y = (size_t)p;
709 /* bottom 3 or 4 bits are likely to be 0; rotate y by 4 to avoid
710 excessive hash collisions for dicts and sets */
711 y = (y >> 4) | (y << (8 * SIZEOF_VOID_P - 4));
712 x = (long)y;
713 if (x == -1)
714 x = -2;
715 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000716}
717
Nick Coghland1abd252008-07-15 15:46:38 +0000718long
719PyObject_HashNotImplemented(PyObject *v)
720{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000721 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
722 Py_TYPE(v)->tp_name);
723 return -1;
Nick Coghland1abd252008-07-15 15:46:38 +0000724}
Fred Drake13634cf2000-06-29 19:17:04 +0000725
Guido van Rossum9bfef441993-03-29 10:43:31 +0000726long
Fred Drake100814d2000-07-09 15:48:49 +0000727PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000728{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000729 PyTypeObject *tp = Py_TYPE(v);
730 if (tp->tp_hash != NULL)
731 return (*tp->tp_hash)(v);
732 /* To keep to the general practice that inheriting
733 * solely from object in C code should work without
734 * an explicit call to PyType_Ready, we implicitly call
735 * PyType_Ready here and then check the tp_hash slot again
736 */
737 if (tp->tp_dict == NULL) {
738 if (PyType_Ready(tp) < 0)
739 return -1;
740 if (tp->tp_hash != NULL)
741 return (*tp->tp_hash)(v);
742 }
743 /* Otherwise, the object can't be hashed */
744 return PyObject_HashNotImplemented(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000745}
746
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000747PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000748PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000749{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000750 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000751
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000752 if (Py_TYPE(v)->tp_getattr != NULL)
753 return (*Py_TYPE(v)->tp_getattr)(v, (char*)name);
754 w = PyUnicode_InternFromString(name);
755 if (w == NULL)
756 return NULL;
757 res = PyObject_GetAttr(v, w);
758 Py_XDECREF(w);
759 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000760}
761
762int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000763PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000764{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000765 PyObject *res = PyObject_GetAttrString(v, name);
766 if (res != NULL) {
767 Py_DECREF(res);
768 return 1;
769 }
770 PyErr_Clear();
771 return 0;
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000772}
773
774int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000775PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000776{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000777 PyObject *s;
778 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000779
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000780 if (Py_TYPE(v)->tp_setattr != NULL)
781 return (*Py_TYPE(v)->tp_setattr)(v, (char*)name, w);
782 s = PyUnicode_InternFromString(name);
783 if (s == NULL)
784 return -1;
785 res = PyObject_SetAttr(v, s, w);
786 Py_XDECREF(s);
787 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000788}
789
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000790PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000791PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000792{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000793 PyTypeObject *tp = Py_TYPE(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000794
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000795 if (!PyUnicode_Check(name)) {
796 PyErr_Format(PyExc_TypeError,
797 "attribute name must be string, not '%.200s'",
798 name->ob_type->tp_name);
799 return NULL;
800 }
801 if (tp->tp_getattro != NULL)
802 return (*tp->tp_getattro)(v, name);
803 if (tp->tp_getattr != NULL) {
804 char *name_str = _PyUnicode_AsString(name);
805 if (name_str == NULL)
806 return NULL;
807 return (*tp->tp_getattr)(v, name_str);
808 }
809 PyErr_Format(PyExc_AttributeError,
810 "'%.50s' object has no attribute '%U'",
811 tp->tp_name, name);
812 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000813}
814
815int
Fred Drake100814d2000-07-09 15:48:49 +0000816PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000817{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000818 PyObject *res = PyObject_GetAttr(v, name);
819 if (res != NULL) {
820 Py_DECREF(res);
821 return 1;
822 }
823 PyErr_Clear();
824 return 0;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000825}
826
827int
Fred Drake100814d2000-07-09 15:48:49 +0000828PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000829{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000830 PyTypeObject *tp = Py_TYPE(v);
831 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000832
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000833 if (!PyUnicode_Check(name)) {
834 PyErr_Format(PyExc_TypeError,
835 "attribute name must be string, not '%.200s'",
836 name->ob_type->tp_name);
837 return -1;
838 }
839 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000840
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000841 PyUnicode_InternInPlace(&name);
842 if (tp->tp_setattro != NULL) {
843 err = (*tp->tp_setattro)(v, name, value);
844 Py_DECREF(name);
845 return err;
846 }
847 if (tp->tp_setattr != NULL) {
848 char *name_str = _PyUnicode_AsString(name);
849 if (name_str == NULL)
850 return -1;
851 err = (*tp->tp_setattr)(v, name_str, value);
852 Py_DECREF(name);
853 return err;
854 }
855 Py_DECREF(name);
856 assert(name->ob_refcnt >= 1);
857 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
858 PyErr_Format(PyExc_TypeError,
859 "'%.100s' object has no attributes "
860 "(%s .%U)",
861 tp->tp_name,
862 value==NULL ? "del" : "assign to",
863 name);
864 else
865 PyErr_Format(PyExc_TypeError,
866 "'%.100s' object has only read-only attributes "
867 "(%s .%U)",
868 tp->tp_name,
869 value==NULL ? "del" : "assign to",
870 name);
871 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000872}
873
874/* Helper to get a pointer to an object's __dict__ slot, if any */
875
876PyObject **
877_PyObject_GetDictPtr(PyObject *obj)
878{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000879 Py_ssize_t dictoffset;
880 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000881
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000882 dictoffset = tp->tp_dictoffset;
883 if (dictoffset == 0)
884 return NULL;
885 if (dictoffset < 0) {
886 Py_ssize_t tsize;
887 size_t size;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000888
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000889 tsize = ((PyVarObject *)obj)->ob_size;
890 if (tsize < 0)
891 tsize = -tsize;
892 size = _PyObject_VAR_SIZE(tp, tsize);
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000893
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000894 dictoffset += (long)size;
895 assert(dictoffset > 0);
896 assert(dictoffset % SIZEOF_VOID_P == 0);
897 }
898 return (PyObject **) ((char *)obj + dictoffset);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000899}
900
Tim Peters6d6c1a32001-08-02 04:15:00 +0000901PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000902PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +0000903{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000904 Py_INCREF(obj);
905 return obj;
Raymond Hettinger01538262003-03-17 08:24:35 +0000906}
907
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +0000908/* Helper used when the __next__ method is removed from a type:
909 tp_iternext is never NULL and can be safely called without checking
910 on every iteration.
911 */
912
913PyObject *
914_PyObject_NextNotImplemented(PyObject *self)
915{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000916 PyErr_Format(PyExc_TypeError,
917 "'%.200s' object is not iterable",
918 Py_TYPE(self)->tp_name);
919 return NULL;
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +0000920}
921
Michael W. Hudson1593f502004-09-14 17:09:47 +0000922/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
923
Raymond Hettinger01538262003-03-17 08:24:35 +0000924PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000925PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
926{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000927 PyTypeObject *tp = Py_TYPE(obj);
928 PyObject *descr = NULL;
929 PyObject *res = NULL;
930 descrgetfunc f;
931 Py_ssize_t dictoffset;
932 PyObject **dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000933
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000934 if (!PyUnicode_Check(name)){
935 PyErr_Format(PyExc_TypeError,
936 "attribute name must be string, not '%.200s'",
937 name->ob_type->tp_name);
938 return NULL;
939 }
940 else
941 Py_INCREF(name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000942
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000943 if (tp->tp_dict == NULL) {
944 if (PyType_Ready(tp) < 0)
945 goto done;
946 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000947
Christian Heimesa62da1d2008-01-12 19:39:10 +0000948#if 0 /* XXX this is not quite _PyType_Lookup anymore */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000949 /* Inline _PyType_Lookup */
950 {
951 Py_ssize_t i, n;
952 PyObject *mro, *base, *dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +0000953
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000954 /* Look in tp_dict of types in MRO */
955 mro = tp->tp_mro;
956 assert(mro != NULL);
957 assert(PyTuple_Check(mro));
958 n = PyTuple_GET_SIZE(mro);
959 for (i = 0; i < n; i++) {
960 base = PyTuple_GET_ITEM(mro, i);
961 assert(PyType_Check(base));
962 dict = ((PyTypeObject *)base)->tp_dict;
963 assert(dict && PyDict_Check(dict));
964 descr = PyDict_GetItem(dict, name);
965 if (descr != NULL)
966 break;
967 }
968 }
Christian Heimesa62da1d2008-01-12 19:39:10 +0000969#else
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000970 descr = _PyType_Lookup(tp, name);
Christian Heimesa62da1d2008-01-12 19:39:10 +0000971#endif
Guido van Rossum056fbf42002-08-19 19:22:50 +0000972
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000973 Py_XINCREF(descr);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000974
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000975 f = NULL;
976 if (descr != NULL) {
977 f = descr->ob_type->tp_descr_get;
978 if (f != NULL && PyDescr_IsData(descr)) {
979 res = f(descr, obj, (PyObject *)obj->ob_type);
980 Py_DECREF(descr);
981 goto done;
982 }
983 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000984
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000985 /* Inline _PyObject_GetDictPtr */
986 dictoffset = tp->tp_dictoffset;
987 if (dictoffset != 0) {
988 PyObject *dict;
989 if (dictoffset < 0) {
990 Py_ssize_t tsize;
991 size_t size;
Guido van Rossumc66ff442002-08-19 16:50:48 +0000992
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000993 tsize = ((PyVarObject *)obj)->ob_size;
994 if (tsize < 0)
995 tsize = -tsize;
996 size = _PyObject_VAR_SIZE(tp, tsize);
Guido van Rossumc66ff442002-08-19 16:50:48 +0000997
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000998 dictoffset += (long)size;
999 assert(dictoffset > 0);
1000 assert(dictoffset % SIZEOF_VOID_P == 0);
1001 }
1002 dictptr = (PyObject **) ((char *)obj + dictoffset);
1003 dict = *dictptr;
1004 if (dict != NULL) {
1005 Py_INCREF(dict);
1006 res = PyDict_GetItem(dict, name);
1007 if (res != NULL) {
1008 Py_INCREF(res);
1009 Py_XDECREF(descr);
1010 Py_DECREF(dict);
1011 goto done;
1012 }
1013 Py_DECREF(dict);
1014 }
1015 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001016
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001017 if (f != NULL) {
1018 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
1019 Py_DECREF(descr);
1020 goto done;
1021 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001022
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001023 if (descr != NULL) {
1024 res = descr;
1025 /* descr was already increfed above */
1026 goto done;
1027 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001028
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001029 PyErr_Format(PyExc_AttributeError,
1030 "'%.50s' object has no attribute '%U'",
1031 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001032 done:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001033 Py_DECREF(name);
1034 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001035}
1036
1037int
1038PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1039{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001040 PyTypeObject *tp = Py_TYPE(obj);
1041 PyObject *descr;
1042 descrsetfunc f;
1043 PyObject **dictptr;
1044 int res = -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001045
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001046 if (!PyUnicode_Check(name)){
1047 PyErr_Format(PyExc_TypeError,
1048 "attribute name must be string, not '%.200s'",
1049 name->ob_type->tp_name);
1050 return -1;
1051 }
1052 else
1053 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001054
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001055 if (tp->tp_dict == NULL) {
1056 if (PyType_Ready(tp) < 0)
1057 goto done;
1058 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001059
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001060 descr = _PyType_Lookup(tp, name);
1061 f = NULL;
1062 if (descr != NULL) {
1063 f = descr->ob_type->tp_descr_set;
1064 if (f != NULL && PyDescr_IsData(descr)) {
1065 res = f(descr, obj, value);
1066 goto done;
1067 }
1068 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001069
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001070 dictptr = _PyObject_GetDictPtr(obj);
1071 if (dictptr != NULL) {
1072 PyObject *dict = *dictptr;
1073 if (dict == NULL && value != NULL) {
1074 dict = PyDict_New();
1075 if (dict == NULL)
1076 goto done;
1077 *dictptr = dict;
1078 }
1079 if (dict != NULL) {
1080 Py_INCREF(dict);
1081 if (value == NULL)
1082 res = PyDict_DelItem(dict, name);
1083 else
1084 res = PyDict_SetItem(dict, name, value);
1085 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1086 PyErr_SetObject(PyExc_AttributeError, name);
1087 Py_DECREF(dict);
1088 goto done;
1089 }
1090 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001091
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001092 if (f != NULL) {
1093 res = f(descr, obj, value);
1094 goto done;
1095 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001096
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001097 if (descr == NULL) {
1098 PyErr_Format(PyExc_AttributeError,
1099 "'%.100s' object has no attribute '%U'",
1100 tp->tp_name, name);
1101 goto done;
1102 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001103
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001104 PyErr_Format(PyExc_AttributeError,
1105 "'%.50s' object attribute '%U' is read-only",
1106 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001107 done:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001108 Py_DECREF(name);
1109 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001110}
1111
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001112/* Test a value used as condition, e.g., in a for or if statement.
1113 Return -1 if an error occurred */
1114
1115int
Fred Drake100814d2000-07-09 15:48:49 +00001116PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001117{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001118 Py_ssize_t res;
1119 if (v == Py_True)
1120 return 1;
1121 if (v == Py_False)
1122 return 0;
1123 if (v == Py_None)
1124 return 0;
1125 else if (v->ob_type->tp_as_number != NULL &&
1126 v->ob_type->tp_as_number->nb_bool != NULL)
1127 res = (*v->ob_type->tp_as_number->nb_bool)(v);
1128 else if (v->ob_type->tp_as_mapping != NULL &&
1129 v->ob_type->tp_as_mapping->mp_length != NULL)
1130 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
1131 else if (v->ob_type->tp_as_sequence != NULL &&
1132 v->ob_type->tp_as_sequence->sq_length != NULL)
1133 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1134 else
1135 return 1;
1136 /* if it is negative, it should be either -1 or -2 */
1137 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001138}
1139
Tim Peters803526b2002-07-07 05:13:56 +00001140/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001141 Return -1 if an error occurred */
1142
1143int
Fred Drake100814d2000-07-09 15:48:49 +00001144PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001145{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001146 int res;
1147 res = PyObject_IsTrue(v);
1148 if (res < 0)
1149 return res;
1150 return res == 0;
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001151}
1152
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001153/* Test whether an object can be called */
1154
1155int
Fred Drake100814d2000-07-09 15:48:49 +00001156PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001157{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001158 if (x == NULL)
1159 return 0;
1160 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001161}
1162
Georg Brandle32b4222007-03-10 22:13:27 +00001163/* ------------------------- PyObject_Dir() helpers ------------------------- */
1164
Tim Peters7eea37e2001-09-04 22:08:56 +00001165/* Helper for PyObject_Dir.
1166 Merge the __dict__ of aclass into dict, and recursively also all
1167 the __dict__s of aclass's base classes. The order of merging isn't
1168 defined, as it's expected that only the final set of dict keys is
1169 interesting.
1170 Return 0 on success, -1 on error.
1171*/
1172
1173static int
1174merge_class_dict(PyObject* dict, PyObject* aclass)
1175{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001176 PyObject *classdict;
1177 PyObject *bases;
Tim Peters7eea37e2001-09-04 22:08:56 +00001178
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001179 assert(PyDict_Check(dict));
1180 assert(aclass);
Tim Peters7eea37e2001-09-04 22:08:56 +00001181
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001182 /* Merge in the type's dict (if any). */
1183 classdict = PyObject_GetAttrString(aclass, "__dict__");
1184 if (classdict == NULL)
1185 PyErr_Clear();
1186 else {
1187 int status = PyDict_Update(dict, classdict);
1188 Py_DECREF(classdict);
1189 if (status < 0)
1190 return -1;
1191 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001192
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001193 /* Recursively merge in the base types' (if any) dicts. */
1194 bases = PyObject_GetAttrString(aclass, "__bases__");
1195 if (bases == NULL)
1196 PyErr_Clear();
1197 else {
1198 /* We have no guarantee that bases is a real tuple */
1199 Py_ssize_t i, n;
1200 n = PySequence_Size(bases); /* This better be right */
1201 if (n < 0)
1202 PyErr_Clear();
1203 else {
1204 for (i = 0; i < n; i++) {
1205 int status;
1206 PyObject *base = PySequence_GetItem(bases, i);
1207 if (base == NULL) {
1208 Py_DECREF(bases);
1209 return -1;
1210 }
1211 status = merge_class_dict(dict, base);
1212 Py_DECREF(base);
1213 if (status < 0) {
1214 Py_DECREF(bases);
1215 return -1;
1216 }
1217 }
1218 }
1219 Py_DECREF(bases);
1220 }
1221 return 0;
Tim Peters7eea37e2001-09-04 22:08:56 +00001222}
1223
Georg Brandle32b4222007-03-10 22:13:27 +00001224/* Helper for PyObject_Dir without arguments: returns the local scope. */
1225static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001226_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001227{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001228 PyObject *names;
1229 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001230
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001231 if (locals == NULL) {
1232 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1233 return NULL;
1234 }
Tim Peters305b5852001-09-17 02:38:46 +00001235
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001236 names = PyMapping_Keys(locals);
1237 if (!names)
1238 return NULL;
1239 if (!PyList_Check(names)) {
1240 PyErr_Format(PyExc_TypeError,
1241 "dir(): expected keys() of locals to be a list, "
1242 "not '%.200s'", Py_TYPE(names)->tp_name);
1243 Py_DECREF(names);
1244 return NULL;
1245 }
1246 /* the locals don't need to be DECREF'd */
1247 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001248}
1249
1250/* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
Guido van Rossum98297ee2007-11-06 21:34:58 +00001251 We deliberately don't suck up its __class__, as methods belonging to the
1252 metaclass would probably be more confusing than helpful.
Georg Brandle32b4222007-03-10 22:13:27 +00001253*/
Guido van Rossum98297ee2007-11-06 21:34:58 +00001254static PyObject *
Georg Brandle32b4222007-03-10 22:13:27 +00001255_specialized_dir_type(PyObject *obj)
1256{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001257 PyObject *result = NULL;
1258 PyObject *dict = PyDict_New();
Georg Brandle32b4222007-03-10 22:13:27 +00001259
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001260 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1261 result = PyDict_Keys(dict);
Georg Brandle32b4222007-03-10 22:13:27 +00001262
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001263 Py_XDECREF(dict);
1264 return result;
Tim Peters305b5852001-09-17 02:38:46 +00001265}
1266
Georg Brandle32b4222007-03-10 22:13:27 +00001267/* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1268static PyObject *
1269_specialized_dir_module(PyObject *obj)
Tim Peters7eea37e2001-09-04 22:08:56 +00001270{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001271 PyObject *result = NULL;
1272 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
Tim Peters7eea37e2001-09-04 22:08:56 +00001273
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001274 if (dict != NULL) {
1275 if (PyDict_Check(dict))
1276 result = PyDict_Keys(dict);
1277 else {
1278 const char *name = PyModule_GetName(obj);
1279 if (name)
1280 PyErr_Format(PyExc_TypeError,
1281 "%.200s.__dict__ is not a dictionary",
1282 name);
1283 }
1284 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001285
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001286 Py_XDECREF(dict);
1287 return result;
Georg Brandle32b4222007-03-10 22:13:27 +00001288}
Tim Peters7eea37e2001-09-04 22:08:56 +00001289
Georg Brandle32b4222007-03-10 22:13:27 +00001290/* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1291 and recursively up the __class__.__bases__ chain.
1292*/
1293static PyObject *
1294_generic_dir(PyObject *obj)
1295{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001296 PyObject *result = NULL;
1297 PyObject *dict = NULL;
1298 PyObject *itsclass = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001299
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001300 /* Get __dict__ (which may or may not be a real dict...) */
1301 dict = PyObject_GetAttrString(obj, "__dict__");
1302 if (dict == NULL) {
1303 PyErr_Clear();
1304 dict = PyDict_New();
1305 }
1306 else if (!PyDict_Check(dict)) {
1307 Py_DECREF(dict);
1308 dict = PyDict_New();
1309 }
1310 else {
1311 /* Copy __dict__ to avoid mutating it. */
1312 PyObject *temp = PyDict_Copy(dict);
1313 Py_DECREF(dict);
1314 dict = temp;
1315 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001316
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001317 if (dict == NULL)
1318 goto error;
Tim Peters7eea37e2001-09-04 22:08:56 +00001319
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001320 /* Merge in attrs reachable from its class. */
1321 itsclass = PyObject_GetAttrString(obj, "__class__");
1322 if (itsclass == NULL)
1323 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1324 __class__ exists? */
1325 PyErr_Clear();
1326 else {
1327 if (merge_class_dict(dict, itsclass) != 0)
1328 goto error;
1329 }
Georg Brandle32b4222007-03-10 22:13:27 +00001330
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001331 result = PyDict_Keys(dict);
1332 /* fall through */
Georg Brandle32b4222007-03-10 22:13:27 +00001333error:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001334 Py_XDECREF(itsclass);
1335 Py_XDECREF(dict);
1336 return result;
Georg Brandle32b4222007-03-10 22:13:27 +00001337}
1338
1339/* Helper for PyObject_Dir: object introspection.
1340 This calls one of the above specialized versions if no __dir__ method
1341 exists. */
1342static PyObject *
1343_dir_object(PyObject *obj)
1344{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001345 PyObject * result = NULL;
1346 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1347 "__dir__");
Georg Brandle32b4222007-03-10 22:13:27 +00001348
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001349 assert(obj);
1350 if (dirfunc == NULL) {
1351 /* use default implementation */
1352 PyErr_Clear();
1353 if (PyModule_Check(obj))
1354 result = _specialized_dir_module(obj);
1355 else if (PyType_Check(obj))
1356 result = _specialized_dir_type(obj);
1357 else
1358 result = _generic_dir(obj);
1359 }
1360 else {
1361 /* use __dir__ */
1362 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1363 Py_DECREF(dirfunc);
1364 if (result == NULL)
1365 return NULL;
Georg Brandle32b4222007-03-10 22:13:27 +00001366
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001367 /* result must be a list */
1368 /* XXX(gbrandl): could also check if all items are strings */
1369 if (!PyList_Check(result)) {
1370 PyErr_Format(PyExc_TypeError,
1371 "__dir__() must return a list, not %.200s",
1372 Py_TYPE(result)->tp_name);
1373 Py_DECREF(result);
1374 result = NULL;
1375 }
1376 }
Georg Brandle32b4222007-03-10 22:13:27 +00001377
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001378 return result;
Georg Brandle32b4222007-03-10 22:13:27 +00001379}
1380
1381/* Implementation of dir() -- if obj is NULL, returns the names in the current
1382 (local) scope. Otherwise, performs introspection of the object: returns a
1383 sorted list of attribute names (supposedly) accessible from the object
1384*/
1385PyObject *
1386PyObject_Dir(PyObject *obj)
1387{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001388 PyObject * result;
Georg Brandle32b4222007-03-10 22:13:27 +00001389
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001390 if (obj == NULL)
1391 /* no object -- introspect the locals */
1392 result = _dir_locals();
1393 else
1394 /* object -- introspect the object */
1395 result = _dir_object(obj);
Georg Brandle32b4222007-03-10 22:13:27 +00001396
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001397 assert(result == NULL || PyList_Check(result));
Georg Brandle32b4222007-03-10 22:13:27 +00001398
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001399 if (result != NULL && PyList_Sort(result) != 0) {
1400 /* sorting the list failed */
1401 Py_DECREF(result);
1402 result = NULL;
1403 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001404
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001405 return result;
Tim Peters7eea37e2001-09-04 22:08:56 +00001406}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001407
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001408/*
1409NoObject is usable as a non-NULL undefined value, used by the macro None.
1410There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001411so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001412(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001413*/
1414
Guido van Rossum0c182a11992-03-27 17:26:13 +00001415/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001416static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001417none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001418{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001419 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001420}
1421
Barry Warsaw9bf16442001-01-23 16:24:35 +00001422/* ARGUSED */
1423static void
Tim Peters803526b2002-07-07 05:13:56 +00001424none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001425{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001426 /* This should never get called, but we also don't want to SEGV if
1427 * we accidentally decref None out of existence.
1428 */
1429 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001430}
1431
1432
Guido van Rossumba21a492001-08-16 08:17:26 +00001433static PyTypeObject PyNone_Type = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001434 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1435 "NoneType",
1436 0,
1437 0,
1438 none_dealloc, /*tp_dealloc*/ /*never called*/
1439 0, /*tp_print*/
1440 0, /*tp_getattr*/
1441 0, /*tp_setattr*/
1442 0, /*tp_reserved*/
1443 none_repr, /*tp_repr*/
1444 0, /*tp_as_number*/
1445 0, /*tp_as_sequence*/
1446 0, /*tp_as_mapping*/
1447 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001448};
1449
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001450PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001451 _PyObject_EXTRA_INIT
1452 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001453};
1454
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001455/* NotImplemented is an object that can be used to signal that an
1456 operation is not implemented for the given type combination. */
1457
1458static PyObject *
1459NotImplemented_repr(PyObject *op)
1460{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001461 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001462}
1463
1464static PyTypeObject PyNotImplemented_Type = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001465 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1466 "NotImplementedType",
1467 0,
1468 0,
1469 none_dealloc, /*tp_dealloc*/ /*never called*/
1470 0, /*tp_print*/
1471 0, /*tp_getattr*/
1472 0, /*tp_setattr*/
1473 0, /*tp_reserved*/
1474 NotImplemented_repr, /*tp_repr*/
1475 0, /*tp_as_number*/
1476 0, /*tp_as_sequence*/
1477 0, /*tp_as_mapping*/
1478 0, /*tp_hash */
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001479};
1480
1481PyObject _Py_NotImplementedStruct = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001482 _PyObject_EXTRA_INIT
1483 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001484};
1485
Guido van Rossumba21a492001-08-16 08:17:26 +00001486void
1487_Py_ReadyTypes(void)
1488{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001489 if (PyType_Ready(&PyType_Type) < 0)
1490 Py_FatalError("Can't initialize type type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001491
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001492 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1493 Py_FatalError("Can't initialize weakref type");
Fred Drake0a4dd392004-07-02 18:57:45 +00001494
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001495 if (PyType_Ready(&_PyWeakref_CallableProxyType) < 0)
1496 Py_FatalError("Can't initialize callable weakref proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001497
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001498 if (PyType_Ready(&_PyWeakref_ProxyType) < 0)
1499 Py_FatalError("Can't initialize weakref proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001500
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001501 if (PyType_Ready(&PyBool_Type) < 0)
1502 Py_FatalError("Can't initialize bool type");
Guido van Rossum77f6a652002-04-03 22:41:51 +00001503
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001504 if (PyType_Ready(&PyByteArray_Type) < 0)
1505 Py_FatalError("Can't initialize bytearray type");
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001506
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001507 if (PyType_Ready(&PyBytes_Type) < 0)
1508 Py_FatalError("Can't initialize 'str'");
Guido van Rossumcacfc072002-05-24 19:01:59 +00001509
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001510 if (PyType_Ready(&PyList_Type) < 0)
1511 Py_FatalError("Can't initialize list type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001512
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001513 if (PyType_Ready(&PyNone_Type) < 0)
1514 Py_FatalError("Can't initialize None type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001515
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001516 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1517 Py_FatalError("Can't initialize type(Ellipsis)");
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001518
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001519 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1520 Py_FatalError("Can't initialize NotImplemented type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001521
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001522 if (PyType_Ready(&PyTraceBack_Type) < 0)
1523 Py_FatalError("Can't initialize traceback type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001524
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001525 if (PyType_Ready(&PySuper_Type) < 0)
1526 Py_FatalError("Can't initialize super type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001527
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001528 if (PyType_Ready(&PyBaseObject_Type) < 0)
1529 Py_FatalError("Can't initialize object type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001530
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001531 if (PyType_Ready(&PyRange_Type) < 0)
1532 Py_FatalError("Can't initialize range type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001533
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001534 if (PyType_Ready(&PyDict_Type) < 0)
1535 Py_FatalError("Can't initialize dict type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001536
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001537 if (PyType_Ready(&PySet_Type) < 0)
1538 Py_FatalError("Can't initialize set type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001539
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001540 if (PyType_Ready(&PyUnicode_Type) < 0)
1541 Py_FatalError("Can't initialize str type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001542
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001543 if (PyType_Ready(&PySlice_Type) < 0)
1544 Py_FatalError("Can't initialize slice type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001545
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001546 if (PyType_Ready(&PyStaticMethod_Type) < 0)
1547 Py_FatalError("Can't initialize static method type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001548
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001549#ifndef WITHOUT_COMPLEX
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001550 if (PyType_Ready(&PyComplex_Type) < 0)
1551 Py_FatalError("Can't initialize complex type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001552#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001553 if (PyType_Ready(&PyFloat_Type) < 0)
1554 Py_FatalError("Can't initialize float type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001555
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001556 if (PyType_Ready(&PyLong_Type) < 0)
1557 Py_FatalError("Can't initialize int type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001558
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001559 if (PyType_Ready(&PyFrozenSet_Type) < 0)
1560 Py_FatalError("Can't initialize frozenset type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001561
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001562 if (PyType_Ready(&PyProperty_Type) < 0)
1563 Py_FatalError("Can't initialize property type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001564
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001565 if (PyType_Ready(&PyMemoryView_Type) < 0)
1566 Py_FatalError("Can't initialize memoryview type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001567
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001568 if (PyType_Ready(&PyTuple_Type) < 0)
1569 Py_FatalError("Can't initialize tuple type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001570
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001571 if (PyType_Ready(&PyEnum_Type) < 0)
1572 Py_FatalError("Can't initialize enumerate type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001573
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001574 if (PyType_Ready(&PyReversed_Type) < 0)
1575 Py_FatalError("Can't initialize reversed type");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001576
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001577 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1578 Py_FatalError("Can't initialize StdPrinter");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001579
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001580 if (PyType_Ready(&PyCode_Type) < 0)
1581 Py_FatalError("Can't initialize code type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001582
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001583 if (PyType_Ready(&PyFrame_Type) < 0)
1584 Py_FatalError("Can't initialize frame type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001585
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001586 if (PyType_Ready(&PyCFunction_Type) < 0)
1587 Py_FatalError("Can't initialize builtin function type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001588
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001589 if (PyType_Ready(&PyMethod_Type) < 0)
1590 Py_FatalError("Can't initialize method type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001591
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001592 if (PyType_Ready(&PyFunction_Type) < 0)
1593 Py_FatalError("Can't initialize function type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001594
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001595 if (PyType_Ready(&PyDictProxy_Type) < 0)
1596 Py_FatalError("Can't initialize dict proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001597
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001598 if (PyType_Ready(&PyGen_Type) < 0)
1599 Py_FatalError("Can't initialize generator type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001600
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001601 if (PyType_Ready(&PyGetSetDescr_Type) < 0)
1602 Py_FatalError("Can't initialize get-set descriptor type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001603
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001604 if (PyType_Ready(&PyWrapperDescr_Type) < 0)
1605 Py_FatalError("Can't initialize wrapper type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001606
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001607 if (PyType_Ready(&PyEllipsis_Type) < 0)
1608 Py_FatalError("Can't initialize ellipsis type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001609
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001610 if (PyType_Ready(&PyMemberDescr_Type) < 0)
1611 Py_FatalError("Can't initialize member descriptor type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001612
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001613 if (PyType_Ready(&PyFilter_Type) < 0)
1614 Py_FatalError("Can't initialize filter type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001615
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001616 if (PyType_Ready(&PyMap_Type) < 0)
1617 Py_FatalError("Can't initialize map type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001618
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001619 if (PyType_Ready(&PyZip_Type) < 0)
1620 Py_FatalError("Can't initialize zip type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001621}
1622
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001623
Guido van Rossum84a90321996-05-22 16:34:47 +00001624#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001625
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001626void
Fred Drake100814d2000-07-09 15:48:49 +00001627_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001628{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001629 _Py_INC_REFTOTAL;
1630 op->ob_refcnt = 1;
1631 _Py_AddToAllObjects(op, 1);
1632 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001633}
1634
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001635void
Fred Drake100814d2000-07-09 15:48:49 +00001636_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001637{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001638#ifdef SLOW_UNREF_CHECK
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001639 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001640#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001641 if (op->ob_refcnt < 0)
1642 Py_FatalError("UNREF negative refcnt");
1643 if (op == &refchain ||
1644 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1645 fprintf(stderr, "* ob\n");
1646 _PyObject_Dump(op);
1647 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1648 _PyObject_Dump(op->_ob_prev->_ob_next);
1649 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1650 _PyObject_Dump(op->_ob_next->_ob_prev);
1651 Py_FatalError("UNREF invalid object");
1652 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001653#ifdef SLOW_UNREF_CHECK
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001654 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1655 if (p == op)
1656 break;
1657 }
1658 if (p == &refchain) /* Not found */
1659 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001660#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001661 op->_ob_next->_ob_prev = op->_ob_prev;
1662 op->_ob_prev->_ob_next = op->_ob_next;
1663 op->_ob_next = op->_ob_prev = NULL;
1664 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001665}
1666
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001667void
Fred Drake100814d2000-07-09 15:48:49 +00001668_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001669{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001670 destructor dealloc = Py_TYPE(op)->tp_dealloc;
1671 _Py_ForgetReference(op);
1672 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001673}
1674
Tim Peters269b2a62003-04-17 19:52:29 +00001675/* Print all live objects. Because PyObject_Print is called, the
1676 * interpreter must be in a healthy state.
1677 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001678void
Fred Drake100814d2000-07-09 15:48:49 +00001679_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001680{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001681 PyObject *op;
1682 fprintf(fp, "Remaining objects:\n");
1683 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
1684 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
1685 if (PyObject_Print(op, fp, 0) != 0)
1686 PyErr_Clear();
1687 putc('\n', fp);
1688 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001689}
1690
Tim Peters269b2a62003-04-17 19:52:29 +00001691/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1692 * doesn't make any calls to the Python C API, so is always safe to call.
1693 */
1694void
1695_Py_PrintReferenceAddresses(FILE *fp)
1696{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001697 PyObject *op;
1698 fprintf(fp, "Remaining object addresses:\n");
1699 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
1700 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
1701 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001702}
1703
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001704PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001705_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001706{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001707 int i, n;
1708 PyObject *t = NULL;
1709 PyObject *res, *op;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001710
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001711 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1712 return NULL;
1713 op = refchain._ob_next;
1714 res = PyList_New(0);
1715 if (res == NULL)
1716 return NULL;
1717 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1718 while (op == self || op == args || op == res || op == t ||
1719 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
1720 op = op->_ob_next;
1721 if (op == &refchain)
1722 return res;
1723 }
1724 if (PyList_Append(res, op) < 0) {
1725 Py_DECREF(res);
1726 return NULL;
1727 }
1728 op = op->_ob_next;
1729 }
1730 return res;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001731}
1732
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001733#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001734
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001735/* Hack to force loading of cobject.o */
Guido van Rossumda9c2711996-12-05 21:58:58 +00001736PyTypeObject *_Py_cobject_hack = &PyCObject_Type;
Guido van Rossum84a90321996-05-22 16:34:47 +00001737
1738
Benjamin Petersonb173f782009-05-05 22:31:58 +00001739/* Hack to force loading of pycapsule.o */
1740PyTypeObject *_PyCapsule_hack = &PyCapsule_Type;
1741
1742
Guido van Rossum84a90321996-05-22 16:34:47 +00001743/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001744Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001745
1746
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001747/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001748
Thomas Wouters334fb892000-07-25 12:56:38 +00001749void *
Fred Drake100814d2000-07-09 15:48:49 +00001750PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001751{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001752 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001753}
1754
Thomas Wouters334fb892000-07-25 12:56:38 +00001755void *
1756PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001757{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001758 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001759}
1760
1761void
Thomas Wouters334fb892000-07-25 12:56:38 +00001762PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001763{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001764 PyMem_FREE(p);
Guido van Rossumb18618d2000-05-03 23:44:39 +00001765}
1766
1767
Guido van Rossum86610361998-04-10 22:32:46 +00001768/* These methods are used to control infinite recursion in repr, str, print,
1769 etc. Container objects that may recursively contain themselves,
1770 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1771 Py_ReprLeave() to avoid infinite recursion.
1772
1773 Py_ReprEnter() returns 0 the first time it is called for a particular
1774 object and 1 every time thereafter. It returns -1 if an exception
1775 occurred. Py_ReprLeave() has no return value.
1776
1777 See dictobject.c and listobject.c for examples of use.
1778*/
1779
1780#define KEY "Py_Repr"
1781
1782int
Fred Drake100814d2000-07-09 15:48:49 +00001783Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001784{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001785 PyObject *dict;
1786 PyObject *list;
1787 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001788
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001789 dict = PyThreadState_GetDict();
1790 if (dict == NULL)
1791 return 0;
1792 list = PyDict_GetItemString(dict, KEY);
1793 if (list == NULL) {
1794 list = PyList_New(0);
1795 if (list == NULL)
1796 return -1;
1797 if (PyDict_SetItemString(dict, KEY, list) < 0)
1798 return -1;
1799 Py_DECREF(list);
1800 }
1801 i = PyList_GET_SIZE(list);
1802 while (--i >= 0) {
1803 if (PyList_GET_ITEM(list, i) == obj)
1804 return 1;
1805 }
1806 PyList_Append(list, obj);
1807 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001808}
1809
1810void
Fred Drake100814d2000-07-09 15:48:49 +00001811Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001812{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001813 PyObject *dict;
1814 PyObject *list;
1815 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001816
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001817 dict = PyThreadState_GetDict();
1818 if (dict == NULL)
1819 return;
1820 list = PyDict_GetItemString(dict, KEY);
1821 if (list == NULL || !PyList_Check(list))
1822 return;
1823 i = PyList_GET_SIZE(list);
1824 /* Count backwards because we always expect obj to be list[-1] */
1825 while (--i >= 0) {
1826 if (PyList_GET_ITEM(list, i) == obj) {
1827 PyList_SetSlice(list, i, i + 1, NULL);
1828 break;
1829 }
1830 }
Guido van Rossum86610361998-04-10 22:32:46 +00001831}
Guido van Rossumd724b232000-03-13 16:01:29 +00001832
Tim Peters803526b2002-07-07 05:13:56 +00001833/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001834
Tim Peters803526b2002-07-07 05:13:56 +00001835/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001836int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001837
Tim Peters803526b2002-07-07 05:13:56 +00001838/* List of objects that still need to be cleaned up, singly linked via their
1839 * gc headers' gc_prev pointers.
1840 */
1841PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001842
Tim Peters803526b2002-07-07 05:13:56 +00001843/* Add op to the _PyTrash_delete_later list. Called when the current
1844 * call-stack depth gets large. op must be a currently untracked gc'ed
1845 * object, with refcount 0. Py_DECREF must already have been called on it.
1846 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001847void
Fred Drake100814d2000-07-09 15:48:49 +00001848_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001849{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001850 assert(PyObject_IS_GC(op));
1851 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1852 assert(op->ob_refcnt == 0);
1853 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
1854 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001855}
1856
Tim Peters803526b2002-07-07 05:13:56 +00001857/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1858 * the call-stack unwinds again.
1859 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001860void
Fred Drake100814d2000-07-09 15:48:49 +00001861_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001862{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001863 while (_PyTrash_delete_later) {
1864 PyObject *op = _PyTrash_delete_later;
1865 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001866
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001867 _PyTrash_delete_later =
1868 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001869
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001870 /* Call the deallocator directly. This used to try to
1871 * fool Py_DECREF into calling it indirectly, but
1872 * Py_DECREF was already called on this object, and in
1873 * assorted non-release builds calling Py_DECREF again ends
1874 * up distorting allocation statistics.
1875 */
1876 assert(op->ob_refcnt == 0);
1877 ++_PyTrash_delete_nesting;
1878 (*dealloc)(op);
1879 --_PyTrash_delete_nesting;
1880 }
Guido van Rossumd724b232000-03-13 16:01:29 +00001881}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001882
1883#ifdef __cplusplus
1884}
1885#endif