blob: ee18bc3c22e02f132c2dc4666d1576675c1335b0 [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 */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00006
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007#ifdef __cplusplus
8extern "C" {
9#endif
10
Tim Peters34592512002-07-11 06:23:50 +000011#ifdef Py_REF_DEBUG
Neal Norwitz84632ee2006-03-04 20:00:59 +000012Py_ssize_t _Py_RefTotal;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000013
14Py_ssize_t
15_Py_GetRefTotal(void)
16{
17 PyObject *o;
18 Py_ssize_t total = _Py_RefTotal;
19 /* ignore the references to the dummy object of the dicts and sets
20 because they are not reliable and not useful (now that the
21 hash table code is well-tested) */
22 o = _PyDict_Dummy();
23 if (o != NULL)
24 total -= o->ob_refcnt;
25 o = _PySet_Dummy();
26 if (o != NULL)
27 total -= o->ob_refcnt;
28 return total;
29}
30#endif /* Py_REF_DEBUG */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000031
Mark Hammonda2905272002-07-29 13:42:14 +000032int Py_DivisionWarningFlag;
Guido van Rossum393661d2001-08-31 17:40:15 +000033
Guido van Rossum3f5da241990-12-20 15:06:42 +000034/* Object allocation routines used by NEWOBJ and NEWVAROBJ macros.
35 These are used by the individual routines for object creation.
36 Do not call them otherwise, they do not initialize the object! */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000037
Tim Peters78be7992003-03-23 02:51:01 +000038#ifdef Py_TRACE_REFS
Tim Peters7571a0f2003-03-23 17:52:28 +000039/* Head of circular doubly-linked list of all objects. These are linked
40 * together via the _ob_prev and _ob_next members of a PyObject, which
41 * exist only in a Py_TRACE_REFS build.
42 */
Tim Peters78be7992003-03-23 02:51:01 +000043static PyObject refchain = {&refchain, &refchain};
Tim Peters36eb4df2003-03-23 03:33:13 +000044
Tim Peters7571a0f2003-03-23 17:52:28 +000045/* Insert op at the front of the list of all objects. If force is true,
46 * op is added even if _ob_prev and _ob_next are non-NULL already. If
47 * force is false amd _ob_prev or _ob_next are non-NULL, do nothing.
48 * force should be true if and only if op points to freshly allocated,
49 * uninitialized memory, or you've unlinked op from the list and are
Tim Peters51f8d382003-03-23 18:06:08 +000050 * relinking it into the front.
Tim Peters7571a0f2003-03-23 17:52:28 +000051 * Note that objects are normally added to the list via _Py_NewReference,
52 * which is called by PyObject_Init. Not all objects are initialized that
53 * way, though; exceptions include statically allocated type objects, and
54 * statically allocated singletons (like Py_True and Py_None).
55 */
Tim Peters36eb4df2003-03-23 03:33:13 +000056void
Tim Peters7571a0f2003-03-23 17:52:28 +000057_Py_AddToAllObjects(PyObject *op, int force)
Tim Peters36eb4df2003-03-23 03:33:13 +000058{
Tim Peters7571a0f2003-03-23 17:52:28 +000059#ifdef Py_DEBUG
60 if (!force) {
61 /* If it's initialized memory, op must be in or out of
62 * the list unambiguously.
63 */
64 assert((op->_ob_prev == NULL) == (op->_ob_next == NULL));
65 }
Tim Peters78be7992003-03-23 02:51:01 +000066#endif
Tim Peters7571a0f2003-03-23 17:52:28 +000067 if (force || op->_ob_prev == NULL) {
68 op->_ob_next = refchain._ob_next;
69 op->_ob_prev = &refchain;
70 refchain._ob_next->_ob_prev = op;
71 refchain._ob_next = op;
72 }
73}
74#endif /* Py_TRACE_REFS */
Tim Peters78be7992003-03-23 02:51:01 +000075
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000076#ifdef COUNT_ALLOCS
Guido van Rossumc0b618a1997-05-02 03:12:38 +000077static PyTypeObject *type_list;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000078/* All types are added to type_list, at least when
79 they get one object created. That makes them
80 immortal, which unfortunately contributes to
81 garbage itself. If unlist_types_without_objects
82 is set, they will be removed from the type_list
83 once the last object is deallocated. */
Benjamin Petersona4a37fe2009-01-11 17:13:55 +000084static int unlist_types_without_objects;
85extern Py_ssize_t tuple_zero_allocs, fast_tuple_allocs;
86extern Py_ssize_t quick_int_allocs, quick_neg_int_allocs;
87extern Py_ssize_t null_strings, one_strings;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000088void
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000089dump_counts(FILE* f)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000090{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000091 PyTypeObject *tp;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000092
93 for (tp = type_list; tp; tp = tp->tp_next)
Benjamin Petersona4a37fe2009-01-11 17:13:55 +000094 fprintf(f, "%s alloc'd: %" PY_FORMAT_SIZE_T "d, "
95 "freed: %" PY_FORMAT_SIZE_T "d, "
96 "max in use: %" PY_FORMAT_SIZE_T "d\n",
Tim Peters6d6c1a32001-08-02 04:15:00 +000097 tp->tp_name, tp->tp_allocs, tp->tp_frees,
Sjoerd Mullender52c1f511993-10-25 08:40:52 +000098 tp->tp_maxalloc);
Benjamin Petersona4a37fe2009-01-11 17:13:55 +000099 fprintf(f, "fast tuple allocs: %" PY_FORMAT_SIZE_T "d, "
100 "empty: %" PY_FORMAT_SIZE_T "d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +0000101 fast_tuple_allocs, tuple_zero_allocs);
Benjamin Petersona4a37fe2009-01-11 17:13:55 +0000102 fprintf(f, "fast int allocs: pos: %" PY_FORMAT_SIZE_T "d, "
103 "neg: %" PY_FORMAT_SIZE_T "d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +0000104 quick_int_allocs, quick_neg_int_allocs);
Benjamin Petersona4a37fe2009-01-11 17:13:55 +0000105 fprintf(f, "null strings: %" PY_FORMAT_SIZE_T "d, "
106 "1-strings: %" PY_FORMAT_SIZE_T "d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +0000107 null_strings, one_strings);
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000108}
109
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000110PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000111get_counts(void)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000112{
113 PyTypeObject *tp;
114 PyObject *result;
115 PyObject *v;
116
117 result = PyList_New(0);
118 if (result == NULL)
119 return NULL;
120 for (tp = type_list; tp; tp = tp->tp_next) {
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000121 v = Py_BuildValue("(snnn)", tp->tp_name, tp->tp_allocs,
Tim Peters6d6c1a32001-08-02 04:15:00 +0000122 tp->tp_frees, tp->tp_maxalloc);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000123 if (v == NULL) {
124 Py_DECREF(result);
125 return NULL;
126 }
127 if (PyList_Append(result, v) < 0) {
128 Py_DECREF(v);
129 Py_DECREF(result);
130 return NULL;
131 }
132 Py_DECREF(v);
133 }
134 return result;
135}
136
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000137void
Fred Drake100814d2000-07-09 15:48:49 +0000138inc_count(PyTypeObject *tp)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000139{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000140 if (tp->tp_next == NULL && tp->tp_prev == NULL) {
Guido van Rossumd8953cb1995-04-06 14:46:26 +0000141 /* first time; insert in linked list */
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000142 if (tp->tp_next != NULL) /* sanity check */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000143 Py_FatalError("XXX inc_count sanity check");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000144 if (type_list)
145 type_list->tp_prev = tp;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000146 tp->tp_next = type_list;
Tim Petersc6a3ff62002-07-08 22:11:52 +0000147 /* Note that as of Python 2.2, heap-allocated type objects
148 * can go away, but this code requires that they stay alive
149 * until program exit. That's why we're careful with
150 * refcounts here. type_list gets a new reference to tp,
151 * while ownership of the reference type_list used to hold
152 * (if any) was transferred to tp->tp_next in the line above.
153 * tp is thus effectively immortal after this.
154 */
155 Py_INCREF(tp);
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000156 type_list = tp;
Tim Peters3e40c7f2003-03-23 03:04:32 +0000157#ifdef Py_TRACE_REFS
Tim Peters7571a0f2003-03-23 17:52:28 +0000158 /* Also insert in the doubly-linked list of all objects,
159 * if not already there.
160 */
161 _Py_AddToAllObjects((PyObject *)tp, 0);
Tim Peters78be7992003-03-23 02:51:01 +0000162#endif
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000163 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000164 tp->tp_allocs++;
165 if (tp->tp_allocs - tp->tp_frees > tp->tp_maxalloc)
166 tp->tp_maxalloc = tp->tp_allocs - tp->tp_frees;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000167}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000168
169void dec_count(PyTypeObject *tp)
170{
171 tp->tp_frees++;
172 if (unlist_types_without_objects &&
173 tp->tp_allocs == tp->tp_frees) {
174 /* unlink the type from type_list */
175 if (tp->tp_prev)
176 tp->tp_prev->tp_next = tp->tp_next;
177 else
178 type_list = tp->tp_next;
179 if (tp->tp_next)
180 tp->tp_next->tp_prev = tp->tp_prev;
181 tp->tp_next = tp->tp_prev = NULL;
182 Py_DECREF(tp);
183 }
184}
185
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000186#endif
187
Tim Peters7c321a82002-07-09 02:57:01 +0000188#ifdef Py_REF_DEBUG
189/* Log a fatal error; doesn't return. */
190void
191_Py_NegativeRefcount(const char *fname, int lineno, PyObject *op)
192{
193 char buf[300];
194
195 PyOS_snprintf(buf, sizeof(buf),
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000196 "%s:%i object at %p has negative ref count "
197 "%" PY_FORMAT_SIZE_T "d",
198 fname, lineno, op, op->ob_refcnt);
Tim Peters7c321a82002-07-09 02:57:01 +0000199 Py_FatalError(buf);
200}
201
202#endif /* Py_REF_DEBUG */
203
Thomas Heller1328b522004-04-22 17:23:49 +0000204void
205Py_IncRef(PyObject *o)
206{
207 Py_XINCREF(o);
208}
209
210void
211Py_DecRef(PyObject *o)
212{
213 Py_XDECREF(o);
214}
215
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000216PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000217PyObject_Init(PyObject *op, PyTypeObject *tp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000218{
Guido van Rossum6e08c142002-10-11 20:37:24 +0000219 if (op == NULL)
220 return PyErr_NoMemory();
Guido van Rossumb18618d2000-05-03 23:44:39 +0000221 /* Any changes should be reflected in PyObject_INIT (objimpl.h) */
Christian Heimes90aa7642007-12-19 02:45:37 +0000222 Py_TYPE(op) = tp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000223 _Py_NewReference(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000224 return op;
225}
226
Guido van Rossumb18618d2000-05-03 23:44:39 +0000227PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000228PyObject_InitVar(PyVarObject *op, PyTypeObject *tp, Py_ssize_t size)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000229{
Guido van Rossum6e08c142002-10-11 20:37:24 +0000230 if (op == NULL)
231 return (PyVarObject *) PyErr_NoMemory();
Guido van Rossumb18618d2000-05-03 23:44:39 +0000232 /* Any changes should be reflected in PyObject_INIT_VAR */
233 op->ob_size = size;
Christian Heimes90aa7642007-12-19 02:45:37 +0000234 Py_TYPE(op) = tp;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000235 _Py_NewReference((PyObject *)op);
236 return op;
237}
238
239PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000240_PyObject_New(PyTypeObject *tp)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000241{
242 PyObject *op;
243 op = (PyObject *) PyObject_MALLOC(_PyObject_SIZE(tp));
244 if (op == NULL)
245 return PyErr_NoMemory();
246 return PyObject_INIT(op, tp);
247}
248
Guido van Rossumd0c87ee1997-05-15 21:31:03 +0000249PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000250_PyObject_NewVar(PyTypeObject *tp, Py_ssize_t nitems)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000251{
Guido van Rossumb18618d2000-05-03 23:44:39 +0000252 PyVarObject *op;
Tim Petersf2a67da2001-10-07 03:54:51 +0000253 const size_t size = _PyObject_VAR_SIZE(tp, nitems);
Tim Peters6d483d32001-10-06 21:27:34 +0000254 op = (PyVarObject *) PyObject_MALLOC(size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000255 if (op == NULL)
Guido van Rossumd0c87ee1997-05-15 21:31:03 +0000256 return (PyVarObject *)PyErr_NoMemory();
Tim Peters6d483d32001-10-06 21:27:34 +0000257 return PyObject_INIT_VAR(op, tp, nitems);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000258}
259
Neal Norwitz1a997502003-01-13 20:13:12 +0000260/* Implementation of PyObject_Print with recursion checking */
261static int
262internal_print(PyObject *op, FILE *fp, int flags, int nesting)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000263{
Guido van Rossum278ef591991-07-27 21:40:24 +0000264 int ret = 0;
Neal Norwitz1a997502003-01-13 20:13:12 +0000265 if (nesting > 10) {
266 PyErr_SetString(PyExc_RuntimeError, "print recursion");
267 return -1;
268 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000269 if (PyErr_CheckSignals())
Guido van Rossum90933611991-06-07 16:10:43 +0000270 return -1;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000271#ifdef USE_STACKCHECK
272 if (PyOS_CheckStack()) {
Fred Drake661ea262000-10-24 19:57:45 +0000273 PyErr_SetString(PyExc_MemoryError, "stack overflow");
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000274 return -1;
275 }
276#endif
Guido van Rossum687ef6e2000-01-12 16:28:58 +0000277 clearerr(fp); /* Clear any previous error condition */
Guido van Rossum90933611991-06-07 16:10:43 +0000278 if (op == NULL) {
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000279 Py_BEGIN_ALLOW_THREADS
Guido van Rossum90933611991-06-07 16:10:43 +0000280 fprintf(fp, "<nil>");
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000281 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000282 }
Guido van Rossum90933611991-06-07 16:10:43 +0000283 else {
284 if (op->ob_refcnt <= 0)
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000285 /* XXX(twouters) cast refcount to long until %zd is
286 universally available */
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000287 Py_BEGIN_ALLOW_THREADS
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000288 fprintf(fp, "<refcnt %ld at %p>",
289 (long)op->ob_refcnt, op);
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000290 Py_END_ALLOW_THREADS
Guido van Rossum04dbf3b2007-08-07 19:51:00 +0000291 else {
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000292 PyObject *s;
293 if (flags & Py_PRINT_RAW)
294 s = PyObject_Str(op);
295 else
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000296 s = PyObject_Repr(op);
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000297 if (s == NULL)
298 ret = -1;
Christian Heimes72b710a2008-05-26 13:28:38 +0000299 else if (PyBytes_Check(s)) {
300 fwrite(PyBytes_AS_STRING(s), 1,
301 PyBytes_GET_SIZE(s), fp);
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000302 }
303 else if (PyUnicode_Check(s)) {
304 PyObject *t;
305 t = _PyUnicode_AsDefaultEncodedString(s, NULL);
306 if (t == NULL)
307 ret = 0;
308 else {
Christian Heimes72b710a2008-05-26 13:28:38 +0000309 fwrite(PyBytes_AS_STRING(t), 1,
310 PyBytes_GET_SIZE(t), fp);
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000311 }
312 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000313 else {
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000314 PyErr_Format(PyExc_TypeError,
315 "str() or repr() returned '%.100s'",
316 s->ob_type->tp_name);
317 ret = -1;
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000318 }
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000319 Py_XDECREF(s);
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000320 }
Guido van Rossum90933611991-06-07 16:10:43 +0000321 }
Guido van Rossum278ef591991-07-27 21:40:24 +0000322 if (ret == 0) {
323 if (ferror(fp)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000324 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum278ef591991-07-27 21:40:24 +0000325 clearerr(fp);
326 ret = -1;
327 }
328 }
329 return ret;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000330}
331
Neal Norwitz1a997502003-01-13 20:13:12 +0000332int
333PyObject_Print(PyObject *op, FILE *fp, int flags)
334{
335 return internal_print(op, fp, flags, 0);
336}
337
Guido van Rossum38938152006-08-21 23:36:26 +0000338/* For debugging convenience. Set a breakpoint here and call it from your DLL */
339void
Thomas Woutersb2137042007-02-01 18:02:27 +0000340_Py_BreakPoint(void)
Guido van Rossum38938152006-08-21 23:36:26 +0000341{
342}
343
Neal Norwitz1a997502003-01-13 20:13:12 +0000344
Barry Warsaw9bf16442001-01-23 16:24:35 +0000345/* For debugging convenience. See Misc/gdbinit for some useful gdb hooks */
Guido van Rossum38938152006-08-21 23:36:26 +0000346void
347_PyObject_Dump(PyObject* op)
Barry Warsaw9bf16442001-01-23 16:24:35 +0000348{
Barry Warsaweefb1072001-02-22 22:39:18 +0000349 if (op == NULL)
350 fprintf(stderr, "NULL\n");
351 else {
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +0000352 PyGILState_STATE gil;
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000353 fprintf(stderr, "object : ");
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +0000354 gil = PyGILState_Ensure();
Barry Warsaweefb1072001-02-22 22:39:18 +0000355 (void)PyObject_Print(op, stderr, 0);
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +0000356 PyGILState_Release(gil);
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000357 /* XXX(twouters) cast refcount to long until %zd is
358 universally available */
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000359 fprintf(stderr, "\n"
360 "type : %s\n"
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000361 "refcount: %ld\n"
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000362 "address : %p\n",
Christian Heimes90aa7642007-12-19 02:45:37 +0000363 Py_TYPE(op)==NULL ? "NULL" : Py_TYPE(op)->tp_name,
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000364 (long)op->ob_refcnt,
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000365 op);
Barry Warsaweefb1072001-02-22 22:39:18 +0000366 }
Barry Warsaw9bf16442001-01-23 16:24:35 +0000367}
Barry Warsaw903138f2001-01-23 16:33:18 +0000368
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000369PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000370PyObject_Repr(PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000371{
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000372 PyObject *res;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000373 if (PyErr_CheckSignals())
Guido van Rossum90933611991-06-07 16:10:43 +0000374 return NULL;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000375#ifdef USE_STACKCHECK
376 if (PyOS_CheckStack()) {
Fred Drake661ea262000-10-24 19:57:45 +0000377 PyErr_SetString(PyExc_MemoryError, "stack overflow");
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000378 return NULL;
379 }
380#endif
Guido van Rossum90933611991-06-07 16:10:43 +0000381 if (v == NULL)
Walter Dörwald1ab83302007-05-18 17:15:44 +0000382 return PyUnicode_FromString("<NULL>");
Christian Heimes90aa7642007-12-19 02:45:37 +0000383 if (Py_TYPE(v)->tp_repr == NULL)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000384 return PyUnicode_FromFormat("<%s object at %p>",
385 v->ob_type->tp_name, v);
386 res = (*v->ob_type->tp_repr)(v);
387 if (res != NULL && !PyUnicode_Check(res)) {
388 PyErr_Format(PyExc_TypeError,
389 "__repr__ returned non-string (type %.200s)",
390 res->ob_type->tp_name);
391 Py_DECREF(res);
392 return NULL;
393 }
394 return res;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000395}
396
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000397PyObject *
Guido van Rossum98297ee2007-11-06 21:34:58 +0000398PyObject_Str(PyObject *v)
Guido van Rossumc6004111993-11-05 10:22:19 +0000399{
Guido van Rossum4c08d552000-03-10 22:55:18 +0000400 PyObject *res;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000401 if (PyErr_CheckSignals())
402 return NULL;
403#ifdef USE_STACKCHECK
404 if (PyOS_CheckStack()) {
405 PyErr_SetString(PyExc_MemoryError, "stack overflow");
406 return NULL;
407 }
408#endif
Guido van Rossumc6004111993-11-05 10:22:19 +0000409 if (v == NULL)
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000410 return PyUnicode_FromString("<NULL>");
Neil Schemenauercf52c072005-08-12 17:34:58 +0000411 if (PyUnicode_CheckExact(v)) {
412 Py_INCREF(v);
413 return v;
414 }
Christian Heimes90aa7642007-12-19 02:45:37 +0000415 if (Py_TYPE(v)->tp_str == NULL)
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000416 return PyObject_Repr(v);
417
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000418 /* It is possible for a type to have a tp_str representation that loops
419 infinitely. */
420 if (Py_EnterRecursiveCall(" while getting the str of an object"))
421 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +0000422 res = (*Py_TYPE(v)->tp_str)(v);
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000423 Py_LeaveRecursiveCall();
Guido van Rossum4c08d552000-03-10 22:55:18 +0000424 if (res == NULL)
425 return NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000426 if (!PyUnicode_Check(res)) {
Neil Schemenauercf52c072005-08-12 17:34:58 +0000427 PyErr_Format(PyExc_TypeError,
428 "__str__ returned non-string (type %.200s)",
Christian Heimes90aa7642007-12-19 02:45:37 +0000429 Py_TYPE(res)->tp_name);
Neil Schemenauercf52c072005-08-12 17:34:58 +0000430 Py_DECREF(res);
431 return NULL;
432 }
433 return res;
434}
435
Georg Brandl559e5d72008-06-11 18:37:52 +0000436PyObject *
437PyObject_ASCII(PyObject *v)
438{
439 PyObject *repr, *ascii, *res;
440
441 repr = PyObject_Repr(v);
442 if (repr == NULL)
443 return NULL;
444
445 /* repr is guaranteed to be a PyUnicode object by PyObject_Repr */
446 ascii = PyUnicode_EncodeASCII(
447 PyUnicode_AS_UNICODE(repr),
448 PyUnicode_GET_SIZE(repr),
449 "backslashreplace");
450
451 Py_DECREF(repr);
452 if (ascii == NULL)
453 return NULL;
454
455 res = PyUnicode_DecodeASCII(
456 PyBytes_AS_STRING(ascii),
457 PyBytes_GET_SIZE(ascii),
458 NULL);
459
460 Py_DECREF(ascii);
461 return res;
462}
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000463
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000464PyObject *
465PyObject_Bytes(PyObject *v)
466{
Christian Heimesff869fa2008-08-28 11:28:26 +0000467 PyObject *result, *func;
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000468 static PyObject *bytesstring = NULL;
469
470 if (bytesstring == NULL) {
471 bytesstring = PyUnicode_InternFromString("__bytes__");
472 if (bytesstring == NULL)
473 return NULL;
474 }
475
476 if (v == NULL)
477 return PyBytes_FromString("<NULL>");
478
479 if (PyBytes_CheckExact(v)) {
480 Py_INCREF(v);
481 return v;
482 }
483
484 /* Doesn't create a reference */
485 func = _PyType_Lookup(Py_TYPE(v), bytesstring);
486 if (func != NULL) {
487 result = PyObject_CallFunctionObjArgs(func, v, NULL);
488 if (result == NULL)
489 return NULL;
490 if (!PyBytes_Check(result)) {
491 PyErr_Format(PyExc_TypeError,
492 "__bytes__ returned non-bytes (type %.200s)",
493 Py_TYPE(result)->tp_name);
494 Py_DECREF(result);
495 return NULL;
496 }
497 return result;
498 }
499 PyErr_Clear();
500 return PyBytes_FromObject(v);
501}
502
Mark Dickinsonc008a172009-02-01 13:59:22 +0000503/* For Python 3.0.1 and later, the old three-way comparison has been
504 completely removed in favour of rich comparisons. PyObject_Compare() and
505 PyObject_Cmp() are gone, and the builtin cmp function no longer exists.
Mark Dickinsone94c6792009-02-02 20:36:42 +0000506 The old tp_compare slot has been renamed to tp_reserved, and should no
Mark Dickinsonc008a172009-02-01 13:59:22 +0000507 longer be used. Use tp_richcompare instead.
Guido van Rossum98297ee2007-11-06 21:34:58 +0000508
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000509 See (*) below for practical amendments.
510
Mark Dickinsonc008a172009-02-01 13:59:22 +0000511 tp_richcompare gets called with a first argument of the appropriate type
512 and a second object of an arbitrary type. We never do any kind of
513 coercion.
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000514
Mark Dickinsonc008a172009-02-01 13:59:22 +0000515 The tp_richcompare slot should return an object, as follows:
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000516
517 NULL if an exception occurred
518 NotImplemented if the requested comparison is not implemented
519 any other false value if the requested comparison is false
520 any other true value if the requested comparison is true
521
522 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
523 NotImplemented.
524
525 (*) Practical amendments:
526
527 - If rich comparison returns NotImplemented, == and != are decided by
528 comparing the object pointer (i.e. falling back to the base object
529 implementation).
530
Guido van Rossuma4073002002-05-31 20:03:54 +0000531*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000532
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000533/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000534int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000535
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000536static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000537
538/* Perform a rich comparison, raising TypeError when the requested comparison
539 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000540static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000541do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000542{
543 richcmpfunc f;
544 PyObject *res;
545
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000546 if (v->ob_type != w->ob_type &&
547 PyType_IsSubtype(w->ob_type, v->ob_type) &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000548 (f = w->ob_type->tp_richcompare) != NULL) {
Tim Petersf4aca752004-09-23 02:39:37 +0000549 res = (*f)(w, v, _Py_SwappedOp[op]);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000550 if (res != Py_NotImplemented)
551 return res;
552 Py_DECREF(res);
553 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000554 if ((f = v->ob_type->tp_richcompare) != NULL) {
Guido van Rossume797ec12001-01-17 15:24:28 +0000555 res = (*f)(v, w, op);
556 if (res != Py_NotImplemented)
557 return res;
558 Py_DECREF(res);
559 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000560 if ((f = w->ob_type->tp_richcompare) != NULL) {
561 res = (*f)(w, v, _Py_SwappedOp[op]);
562 if (res != Py_NotImplemented)
563 return res;
564 Py_DECREF(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000565 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000566 /* If neither object implements it, provide a sensible default
567 for == and !=, but raise an exception for ordering. */
568 switch (op) {
569 case Py_EQ:
570 res = (v == w) ? Py_True : Py_False;
571 break;
572 case Py_NE:
573 res = (v != w) ? Py_True : Py_False;
574 break;
575 default:
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000576 /* XXX Special-case None so it doesn't show as NoneType() */
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000577 PyErr_Format(PyExc_TypeError,
578 "unorderable types: %.100s() %s %.100s()",
579 v->ob_type->tp_name,
580 opstrings[op],
581 w->ob_type->tp_name);
582 return NULL;
583 }
Guido van Rossume797ec12001-01-17 15:24:28 +0000584 Py_INCREF(res);
585 return res;
586}
587
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000588/* Perform a rich comparison with object result. This wraps do_richcompare()
589 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000590
Guido van Rossume797ec12001-01-17 15:24:28 +0000591PyObject *
592PyObject_RichCompare(PyObject *v, PyObject *w, int op)
593{
594 PyObject *res;
595
596 assert(Py_LT <= op && op <= Py_GE);
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000597 if (v == NULL || w == NULL) {
598 if (!PyErr_Occurred())
599 PyErr_BadInternalCall();
600 return NULL;
601 }
Armin Rigo2b3eb402003-10-28 12:05:48 +0000602 if (Py_EnterRecursiveCall(" in cmp"))
603 return NULL;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000604 res = do_richcompare(v, w, op);
Armin Rigo2b3eb402003-10-28 12:05:48 +0000605 Py_LeaveRecursiveCall();
Guido van Rossume797ec12001-01-17 15:24:28 +0000606 return res;
607}
608
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000609/* Perform a rich comparison with integer result. This wraps
610 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000611int
612PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
613{
Raymond Hettinger93d44812004-03-21 17:01:44 +0000614 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000615 int ok;
616
Mark Dickinson4a1f5932008-11-12 23:23:36 +0000617 /* Quick result when objects are the same.
618 Guarantees that identity implies equality. */
619 if (v == w) {
620 if (op == Py_EQ)
621 return 1;
622 else if (op == Py_NE)
623 return 0;
624 }
625
Raymond Hettinger93d44812004-03-21 17:01:44 +0000626 res = PyObject_RichCompare(v, w, op);
Guido van Rossume797ec12001-01-17 15:24:28 +0000627 if (res == NULL)
628 return -1;
Guido van Rossum81912d42002-08-24 05:33:28 +0000629 if (PyBool_Check(res))
630 ok = (res == Py_True);
631 else
632 ok = PyObject_IsTrue(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000633 Py_DECREF(res);
634 return ok;
635}
Fred Drake13634cf2000-06-29 19:17:04 +0000636
637/* Set of hash utility functions to help maintaining the invariant that
Raymond Hettinger8183fa42004-03-21 17:35:06 +0000638 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000639
640 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
641*/
642
643long
Fred Drake100814d2000-07-09 15:48:49 +0000644_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000645{
Tim Peters39dce292000-08-15 03:34:48 +0000646 double intpart, fractpart;
647 int expo;
648 long hipart;
649 long x; /* the final hash value */
650 /* This is designed so that Python numbers of different types
651 * that compare equal hash to the same value; otherwise comparisons
652 * of mapping keys will turn out weird.
653 */
654
Tim Peters39dce292000-08-15 03:34:48 +0000655 fractpart = modf(v, &intpart);
Tim Peters39dce292000-08-15 03:34:48 +0000656 if (fractpart == 0.0) {
657 /* This must return the same hash as an equal int or long. */
Mark Dickinsonc96db472009-02-08 15:09:21 +0000658 if (intpart > LONG_MAX/2 || -intpart > LONG_MAX/2) {
Tim Peters39dce292000-08-15 03:34:48 +0000659 /* Convert to long and use its hash. */
660 PyObject *plong; /* converted to Python long */
661 if (Py_IS_INFINITY(intpart))
662 /* can't convert to long int -- arbitrary */
663 v = v < 0 ? -271828.0 : 314159.0;
664 plong = PyLong_FromDouble(v);
665 if (plong == NULL)
666 return -1;
667 x = PyObject_Hash(plong);
668 Py_DECREF(plong);
669 return x;
670 }
671 /* Fits in a C long == a Python int, so is its own hash. */
672 x = (long)intpart;
673 if (x == -1)
674 x = -2;
675 return x;
676 }
677 /* The fractional part is non-zero, so we don't have to worry about
678 * making this match the hash of some other type.
679 * Use frexp to get at the bits in the double.
Fred Drake13634cf2000-06-29 19:17:04 +0000680 * Since the VAX D double format has 56 mantissa bits, which is the
681 * most of any double format in use, each of these parts may have as
682 * many as (but no more than) 56 significant bits.
Tim Peters39dce292000-08-15 03:34:48 +0000683 * So, assuming sizeof(long) >= 4, each part can be broken into two
684 * longs; frexp and multiplication are used to do that.
685 * Also, since the Cray double format has 15 exponent bits, which is
686 * the most of any double format in use, shifting the exponent field
687 * left by 15 won't overflow a long (again assuming sizeof(long) >= 4).
Fred Drake13634cf2000-06-29 19:17:04 +0000688 */
Tim Peters39dce292000-08-15 03:34:48 +0000689 v = frexp(v, &expo);
690 v *= 2147483648.0; /* 2**31 */
691 hipart = (long)v; /* take the top 32 bits */
692 v = (v - (double)hipart) * 2147483648.0; /* get the next 32 bits */
693 x = hipart + (long)v + (expo << 15);
694 if (x == -1)
695 x = -2;
696 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000697}
698
699long
Fred Drake100814d2000-07-09 15:48:49 +0000700_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000701{
702#if SIZEOF_LONG >= SIZEOF_VOID_P
703 return (long)p;
704#else
705 /* convert to a Python long and hash that */
706 PyObject* longobj;
707 long x;
Tim Peters803526b2002-07-07 05:13:56 +0000708
Fred Drake13634cf2000-06-29 19:17:04 +0000709 if ((longobj = PyLong_FromVoidPtr(p)) == NULL) {
710 x = -1;
711 goto finally;
712 }
713 x = PyObject_Hash(longobj);
Tim Peters803526b2002-07-07 05:13:56 +0000714
Fred Drake13634cf2000-06-29 19:17:04 +0000715finally:
716 Py_XDECREF(longobj);
717 return x;
718#endif
719}
720
Nick Coghland1abd252008-07-15 15:46:38 +0000721long
722PyObject_HashNotImplemented(PyObject *v)
723{
724 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
725 Py_TYPE(v)->tp_name);
726 return -1;
727}
Fred Drake13634cf2000-06-29 19:17:04 +0000728
Guido van Rossum9bfef441993-03-29 10:43:31 +0000729long
Fred Drake100814d2000-07-09 15:48:49 +0000730PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000731{
Nick Coghland1abd252008-07-15 15:46:38 +0000732 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000733 if (tp->tp_hash != NULL)
734 return (*tp->tp_hash)(v);
Nick Coghlanf1f2f682008-12-30 07:29:12 +0000735 /* To keep to the general practice that inheriting
736 * solely from object in C code should work without
737 * an explicit call to PyType_Ready, we implicitly call
738 * PyType_Ready here and then check the tp_hash slot again
739 */
740 if (tp->tp_dict == NULL) {
741 if (PyType_Ready(tp) < 0)
742 return -1;
743 if (tp->tp_hash != NULL)
744 return (*tp->tp_hash)(v);
745 }
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000746 /* Otherwise, the object can't be hashed */
Nick Coghland1abd252008-07-15 15:46:38 +0000747 return PyObject_HashNotImplemented(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000748}
749
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000750PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000751PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000752{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000753 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000754
Christian Heimes90aa7642007-12-19 02:45:37 +0000755 if (Py_TYPE(v)->tp_getattr != NULL)
756 return (*Py_TYPE(v)->tp_getattr)(v, (char*)name);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000757 w = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000758 if (w == NULL)
759 return NULL;
760 res = PyObject_GetAttr(v, w);
761 Py_XDECREF(w);
762 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000763}
764
765int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000766PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000767{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000768 PyObject *res = PyObject_GetAttrString(v, name);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000769 if (res != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000770 Py_DECREF(res);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000771 return 1;
772 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000773 PyErr_Clear();
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000774 return 0;
775}
776
777int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000778PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000779{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000780 PyObject *s;
781 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000782
Christian Heimes90aa7642007-12-19 02:45:37 +0000783 if (Py_TYPE(v)->tp_setattr != NULL)
784 return (*Py_TYPE(v)->tp_setattr)(v, (char*)name, w);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000785 s = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000786 if (s == NULL)
787 return -1;
788 res = PyObject_SetAttr(v, s, w);
789 Py_XDECREF(s);
790 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000791}
792
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000793PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000794PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000795{
Christian Heimes90aa7642007-12-19 02:45:37 +0000796 PyTypeObject *tp = Py_TYPE(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000797
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000798 if (!PyUnicode_Check(name)) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000799 PyErr_Format(PyExc_TypeError,
800 "attribute name must be string, not '%.200s'",
801 name->ob_type->tp_name);
802 return NULL;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000803 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000804 if (tp->tp_getattro != NULL)
805 return (*tp->tp_getattro)(v, name);
806 if (tp->tp_getattr != NULL)
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000807 return (*tp->tp_getattr)(v, _PyUnicode_AsString(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +0000808 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000809 "'%.50s' object has no attribute '%U'",
810 tp->tp_name, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000811 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000812}
813
814int
Fred Drake100814d2000-07-09 15:48:49 +0000815PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000816{
817 PyObject *res = PyObject_GetAttr(v, name);
818 if (res != NULL) {
819 Py_DECREF(res);
820 return 1;
821 }
822 PyErr_Clear();
823 return 0;
824}
825
826int
Fred Drake100814d2000-07-09 15:48:49 +0000827PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000828{
Christian Heimes90aa7642007-12-19 02:45:37 +0000829 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000830 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000831
Martin v. Löwis5b222132007-06-10 09:51:05 +0000832 if (!PyUnicode_Check(name)) {
833 PyErr_Format(PyExc_TypeError,
834 "attribute name must be string, not '%.200s'",
835 name->ob_type->tp_name);
836 return -1;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000837 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000838 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000839
Martin v. Löwis5b222132007-06-10 09:51:05 +0000840 PyUnicode_InternInPlace(&name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000841 if (tp->tp_setattro != NULL) {
842 err = (*tp->tp_setattro)(v, name, value);
843 Py_DECREF(name);
844 return err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000845 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000846 if (tp->tp_setattr != NULL) {
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000847 err = (*tp->tp_setattr)(v, _PyUnicode_AsString(name), value);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000848 Py_DECREF(name);
849 return err;
850 }
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000851 Py_DECREF(name);
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000852 assert(name->ob_refcnt >= 1);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000853 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
854 PyErr_Format(PyExc_TypeError,
855 "'%.100s' object has no attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000856 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000857 tp->tp_name,
858 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000859 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000860 else
861 PyErr_Format(PyExc_TypeError,
862 "'%.100s' object has only read-only attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000863 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000864 tp->tp_name,
865 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000866 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000867 return -1;
868}
869
870/* Helper to get a pointer to an object's __dict__ slot, if any */
871
872PyObject **
873_PyObject_GetDictPtr(PyObject *obj)
874{
Martin v. Löwis725507b2006-03-07 12:08:51 +0000875 Py_ssize_t dictoffset;
Christian Heimes90aa7642007-12-19 02:45:37 +0000876 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000877
Tim Peters6d6c1a32001-08-02 04:15:00 +0000878 dictoffset = tp->tp_dictoffset;
879 if (dictoffset == 0)
880 return NULL;
881 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000882 Py_ssize_t tsize;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000883 size_t size;
884
885 tsize = ((PyVarObject *)obj)->ob_size;
886 if (tsize < 0)
887 tsize = -tsize;
888 size = _PyObject_VAR_SIZE(tp, tsize);
889
Tim Peters6d483d32001-10-06 21:27:34 +0000890 dictoffset += (long)size;
891 assert(dictoffset > 0);
892 assert(dictoffset % SIZEOF_VOID_P == 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000893 }
894 return (PyObject **) ((char *)obj + dictoffset);
895}
896
Tim Peters6d6c1a32001-08-02 04:15:00 +0000897PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000898PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +0000899{
900 Py_INCREF(obj);
901 return obj;
902}
903
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +0000904/* Helper used when the __next__ method is removed from a type:
905 tp_iternext is never NULL and can be safely called without checking
906 on every iteration.
907 */
908
909PyObject *
910_PyObject_NextNotImplemented(PyObject *self)
911{
912 PyErr_Format(PyExc_TypeError,
913 "'%.200s' object is not iterable",
914 Py_TYPE(self)->tp_name);
915 return NULL;
916}
917
Michael W. Hudson1593f502004-09-14 17:09:47 +0000918/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
919
Raymond Hettinger01538262003-03-17 08:24:35 +0000920PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000921PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
922{
Christian Heimes90aa7642007-12-19 02:45:37 +0000923 PyTypeObject *tp = Py_TYPE(obj);
Guido van Rossum056fbf42002-08-19 19:22:50 +0000924 PyObject *descr = NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000925 PyObject *res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000926 descrgetfunc f;
Martin v. Löwis725507b2006-03-07 12:08:51 +0000927 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000928 PyObject **dictptr;
929
Martin v. Löwis5b222132007-06-10 09:51:05 +0000930 if (!PyUnicode_Check(name)){
931 PyErr_Format(PyExc_TypeError,
932 "attribute name must be string, not '%.200s'",
933 name->ob_type->tp_name);
934 return NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000935 }
936 else
937 Py_INCREF(name);
938
Tim Peters6d6c1a32001-08-02 04:15:00 +0000939 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +0000940 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000941 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000942 }
943
Christian Heimesa62da1d2008-01-12 19:39:10 +0000944#if 0 /* XXX this is not quite _PyType_Lookup anymore */
Guido van Rossum056fbf42002-08-19 19:22:50 +0000945 /* Inline _PyType_Lookup */
946 {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000947 Py_ssize_t i, n;
Guido van Rossum056fbf42002-08-19 19:22:50 +0000948 PyObject *mro, *base, *dict;
949
950 /* Look in tp_dict of types in MRO */
951 mro = tp->tp_mro;
952 assert(mro != NULL);
953 assert(PyTuple_Check(mro));
954 n = PyTuple_GET_SIZE(mro);
955 for (i = 0; i < n; i++) {
956 base = PyTuple_GET_ITEM(mro, i);
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000957 assert(PyType_Check(base));
958 dict = ((PyTypeObject *)base)->tp_dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +0000959 assert(dict && PyDict_Check(dict));
960 descr = PyDict_GetItem(dict, name);
961 if (descr != NULL)
962 break;
963 }
964 }
Christian Heimesa62da1d2008-01-12 19:39:10 +0000965#else
966 descr = _PyType_Lookup(tp, name);
967#endif
Guido van Rossum056fbf42002-08-19 19:22:50 +0000968
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000969 Py_XINCREF(descr);
970
Tim Peters6d6c1a32001-08-02 04:15:00 +0000971 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000972 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000973 f = descr->ob_type->tp_descr_get;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000974 if (f != NULL && PyDescr_IsData(descr)) {
975 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000976 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000977 goto done;
978 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000979 }
980
Guido van Rossumc66ff442002-08-19 16:50:48 +0000981 /* Inline _PyObject_GetDictPtr */
982 dictoffset = tp->tp_dictoffset;
983 if (dictoffset != 0) {
984 PyObject *dict;
985 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000986 Py_ssize_t tsize;
Guido van Rossumc66ff442002-08-19 16:50:48 +0000987 size_t size;
988
989 tsize = ((PyVarObject *)obj)->ob_size;
990 if (tsize < 0)
991 tsize = -tsize;
992 size = _PyObject_VAR_SIZE(tp, tsize);
993
994 dictoffset += (long)size;
995 assert(dictoffset > 0);
996 assert(dictoffset % SIZEOF_VOID_P == 0);
997 }
998 dictptr = (PyObject **) ((char *)obj + dictoffset);
999 dict = *dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001000 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +00001001 Py_INCREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001002 res = PyDict_GetItem(dict, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001003 if (res != NULL) {
1004 Py_INCREF(res);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001005 Py_XDECREF(descr);
Christian Heimes969fe572008-01-25 11:23:10 +00001006 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001007 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001008 }
Christian Heimes969fe572008-01-25 11:23:10 +00001009 Py_DECREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001010 }
1011 }
1012
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001013 if (f != NULL) {
Christian Heimes90aa7642007-12-19 02:45:37 +00001014 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001015 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001016 goto done;
1017 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001018
1019 if (descr != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001020 res = descr;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001021 /* descr was already increfed above */
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001022 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001023 }
1024
1025 PyErr_Format(PyExc_AttributeError,
1026 "'%.50s' object has no attribute '%.400s'",
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +00001027 tp->tp_name, _PyUnicode_AsString(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001028 done:
1029 Py_DECREF(name);
1030 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001031}
1032
1033int
1034PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1035{
Christian Heimes90aa7642007-12-19 02:45:37 +00001036 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001037 PyObject *descr;
1038 descrsetfunc f;
1039 PyObject **dictptr;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001040 int res = -1;
1041
Martin v. Löwis5b222132007-06-10 09:51:05 +00001042 if (!PyUnicode_Check(name)){
1043 PyErr_Format(PyExc_TypeError,
1044 "attribute name must be string, not '%.200s'",
1045 name->ob_type->tp_name);
1046 return -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001047 }
1048 else
1049 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001050
1051 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001052 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001053 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001054 }
1055
1056 descr = _PyType_Lookup(tp, name);
1057 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001058 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001059 f = descr->ob_type->tp_descr_set;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001060 if (f != NULL && PyDescr_IsData(descr)) {
1061 res = f(descr, obj, value);
1062 goto done;
1063 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001064 }
1065
1066 dictptr = _PyObject_GetDictPtr(obj);
1067 if (dictptr != NULL) {
1068 PyObject *dict = *dictptr;
1069 if (dict == NULL && value != NULL) {
1070 dict = PyDict_New();
1071 if (dict == NULL)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001072 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001073 *dictptr = dict;
1074 }
1075 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +00001076 Py_INCREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001077 if (value == NULL)
1078 res = PyDict_DelItem(dict, name);
1079 else
1080 res = PyDict_SetItem(dict, name, value);
1081 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1082 PyErr_SetObject(PyExc_AttributeError, name);
Christian Heimes969fe572008-01-25 11:23:10 +00001083 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001084 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001085 }
1086 }
1087
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001088 if (f != NULL) {
1089 res = f(descr, obj, value);
1090 goto done;
1091 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001092
1093 if (descr == NULL) {
1094 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001095 "'%.100s' object has no attribute '%U'",
1096 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001097 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001098 }
1099
1100 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001101 "'%.50s' object attribute '%U' is read-only",
1102 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001103 done:
1104 Py_DECREF(name);
1105 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001106}
1107
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001108/* Test a value used as condition, e.g., in a for or if statement.
1109 Return -1 if an error occurred */
1110
1111int
Fred Drake100814d2000-07-09 15:48:49 +00001112PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001113{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001114 Py_ssize_t res;
Guido van Rossum6248f442002-08-24 06:31:34 +00001115 if (v == Py_True)
1116 return 1;
1117 if (v == Py_False)
1118 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001119 if (v == Py_None)
Neal Norwitz51290d32002-06-13 21:32:44 +00001120 return 0;
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001121 else if (v->ob_type->tp_as_number != NULL &&
Jack Diederich4dafcc42006-11-28 19:15:13 +00001122 v->ob_type->tp_as_number->nb_bool != NULL)
1123 res = (*v->ob_type->tp_as_number->nb_bool)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001124 else if (v->ob_type->tp_as_mapping != NULL &&
1125 v->ob_type->tp_as_mapping->mp_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001126 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001127 else if (v->ob_type->tp_as_sequence != NULL &&
1128 v->ob_type->tp_as_sequence->sq_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001129 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1130 else
Neal Norwitz51290d32002-06-13 21:32:44 +00001131 return 1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001132 /* if it is negative, it should be either -1 or -2 */
1133 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001134}
1135
Tim Peters803526b2002-07-07 05:13:56 +00001136/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001137 Return -1 if an error occurred */
1138
1139int
Fred Drake100814d2000-07-09 15:48:49 +00001140PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001141{
1142 int res;
1143 res = PyObject_IsTrue(v);
1144 if (res < 0)
1145 return res;
1146 return res == 0;
1147}
1148
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001149/* Test whether an object can be called */
1150
1151int
Fred Drake100814d2000-07-09 15:48:49 +00001152PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001153{
1154 if (x == NULL)
1155 return 0;
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001156 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001157}
1158
Georg Brandle32b4222007-03-10 22:13:27 +00001159/* ------------------------- PyObject_Dir() helpers ------------------------- */
1160
Tim Peters7eea37e2001-09-04 22:08:56 +00001161/* Helper for PyObject_Dir.
1162 Merge the __dict__ of aclass into dict, and recursively also all
1163 the __dict__s of aclass's base classes. The order of merging isn't
1164 defined, as it's expected that only the final set of dict keys is
1165 interesting.
1166 Return 0 on success, -1 on error.
1167*/
1168
1169static int
1170merge_class_dict(PyObject* dict, PyObject* aclass)
1171{
1172 PyObject *classdict;
1173 PyObject *bases;
1174
1175 assert(PyDict_Check(dict));
1176 assert(aclass);
1177
1178 /* Merge in the type's dict (if any). */
1179 classdict = PyObject_GetAttrString(aclass, "__dict__");
1180 if (classdict == NULL)
1181 PyErr_Clear();
1182 else {
1183 int status = PyDict_Update(dict, classdict);
1184 Py_DECREF(classdict);
1185 if (status < 0)
1186 return -1;
1187 }
1188
1189 /* Recursively merge in the base types' (if any) dicts. */
1190 bases = PyObject_GetAttrString(aclass, "__bases__");
Tim Petersbc7e8632001-09-16 20:33:22 +00001191 if (bases == NULL)
1192 PyErr_Clear();
1193 else {
Guido van Rossum44022412002-05-13 18:29:46 +00001194 /* We have no guarantee that bases is a real tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001195 Py_ssize_t i, n;
Guido van Rossum44022412002-05-13 18:29:46 +00001196 n = PySequence_Size(bases); /* This better be right */
1197 if (n < 0)
1198 PyErr_Clear();
1199 else {
1200 for (i = 0; i < n; i++) {
Tim Peters18e70832003-02-05 19:35:19 +00001201 int status;
Guido van Rossum44022412002-05-13 18:29:46 +00001202 PyObject *base = PySequence_GetItem(bases, i);
1203 if (base == NULL) {
1204 Py_DECREF(bases);
1205 return -1;
1206 }
Tim Peters18e70832003-02-05 19:35:19 +00001207 status = merge_class_dict(dict, base);
1208 Py_DECREF(base);
1209 if (status < 0) {
Guido van Rossum44022412002-05-13 18:29:46 +00001210 Py_DECREF(bases);
1211 return -1;
1212 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001213 }
1214 }
1215 Py_DECREF(bases);
1216 }
1217 return 0;
1218}
1219
Georg Brandle32b4222007-03-10 22:13:27 +00001220/* Helper for PyObject_Dir without arguments: returns the local scope. */
1221static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001222_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001223{
Georg Brandled3b8382007-03-12 13:15:14 +00001224 PyObject *names;
Georg Brandle32b4222007-03-10 22:13:27 +00001225 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001226
Georg Brandle32b4222007-03-10 22:13:27 +00001227 if (locals == NULL) {
1228 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1229 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001230 }
1231
Georg Brandled3b8382007-03-12 13:15:14 +00001232 names = PyMapping_Keys(locals);
1233 if (!names)
1234 return NULL;
1235 if (!PyList_Check(names)) {
1236 PyErr_Format(PyExc_TypeError,
1237 "dir(): expected keys() of locals to be a list, "
Christian Heimes90aa7642007-12-19 02:45:37 +00001238 "not '%.200s'", Py_TYPE(names)->tp_name);
Georg Brandled3b8382007-03-12 13:15:14 +00001239 Py_DECREF(names);
1240 return NULL;
1241 }
Georg Brandle32b4222007-03-10 22:13:27 +00001242 /* the locals don't need to be DECREF'd */
Georg Brandled3b8382007-03-12 13:15:14 +00001243 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001244}
1245
1246/* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
Guido van Rossum98297ee2007-11-06 21:34:58 +00001247 We deliberately don't suck up its __class__, as methods belonging to the
1248 metaclass would probably be more confusing than helpful.
Georg Brandle32b4222007-03-10 22:13:27 +00001249*/
Guido van Rossum98297ee2007-11-06 21:34:58 +00001250static PyObject *
Georg Brandle32b4222007-03-10 22:13:27 +00001251_specialized_dir_type(PyObject *obj)
1252{
1253 PyObject *result = NULL;
1254 PyObject *dict = PyDict_New();
1255
1256 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1257 result = PyDict_Keys(dict);
1258
1259 Py_XDECREF(dict);
Tim Peters305b5852001-09-17 02:38:46 +00001260 return result;
1261}
1262
Georg Brandle32b4222007-03-10 22:13:27 +00001263/* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1264static PyObject *
1265_specialized_dir_module(PyObject *obj)
Tim Peters7eea37e2001-09-04 22:08:56 +00001266{
Georg Brandle32b4222007-03-10 22:13:27 +00001267 PyObject *result = NULL;
1268 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
Tim Peters7eea37e2001-09-04 22:08:56 +00001269
Georg Brandle32b4222007-03-10 22:13:27 +00001270 if (dict != NULL) {
1271 if (PyDict_Check(dict))
1272 result = PyDict_Keys(dict);
1273 else {
1274 PyErr_Format(PyExc_TypeError,
1275 "%.200s.__dict__ is not a dictionary",
1276 PyModule_GetName(obj));
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001277 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001278 }
1279
Georg Brandle32b4222007-03-10 22:13:27 +00001280 Py_XDECREF(dict);
1281 return result;
1282}
Tim Peters7eea37e2001-09-04 22:08:56 +00001283
Georg Brandle32b4222007-03-10 22:13:27 +00001284/* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1285 and recursively up the __class__.__bases__ chain.
1286*/
1287static PyObject *
1288_generic_dir(PyObject *obj)
1289{
1290 PyObject *result = NULL;
1291 PyObject *dict = NULL;
1292 PyObject *itsclass = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001293
Georg Brandle32b4222007-03-10 22:13:27 +00001294 /* Get __dict__ (which may or may not be a real dict...) */
1295 dict = PyObject_GetAttrString(obj, "__dict__");
1296 if (dict == NULL) {
1297 PyErr_Clear();
1298 dict = PyDict_New();
1299 }
1300 else if (!PyDict_Check(dict)) {
1301 Py_DECREF(dict);
1302 dict = PyDict_New();
1303 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001304 else {
Georg Brandle32b4222007-03-10 22:13:27 +00001305 /* Copy __dict__ to avoid mutating it. */
1306 PyObject *temp = PyDict_Copy(dict);
1307 Py_DECREF(dict);
1308 dict = temp;
Tim Peters7eea37e2001-09-04 22:08:56 +00001309 }
1310
Georg Brandle32b4222007-03-10 22:13:27 +00001311 if (dict == NULL)
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001312 goto error;
Tim Peters7eea37e2001-09-04 22:08:56 +00001313
Georg Brandle32b4222007-03-10 22:13:27 +00001314 /* Merge in attrs reachable from its class. */
1315 itsclass = PyObject_GetAttrString(obj, "__class__");
1316 if (itsclass == NULL)
1317 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1318 __class__ exists? */
1319 PyErr_Clear();
1320 else {
1321 if (merge_class_dict(dict, itsclass) != 0)
1322 goto error;
1323 }
1324
1325 result = PyDict_Keys(dict);
Tim Peters7eea37e2001-09-04 22:08:56 +00001326 /* fall through */
Georg Brandle32b4222007-03-10 22:13:27 +00001327error:
1328 Py_XDECREF(itsclass);
1329 Py_XDECREF(dict);
1330 return result;
1331}
1332
1333/* Helper for PyObject_Dir: object introspection.
1334 This calls one of the above specialized versions if no __dir__ method
1335 exists. */
1336static PyObject *
1337_dir_object(PyObject *obj)
1338{
1339 PyObject * result = NULL;
1340 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1341 "__dir__");
1342
1343 assert(obj);
1344 if (dirfunc == NULL) {
1345 /* use default implementation */
1346 PyErr_Clear();
1347 if (PyModule_Check(obj))
1348 result = _specialized_dir_module(obj);
1349 else if (PyType_Check(obj))
1350 result = _specialized_dir_type(obj);
1351 else
1352 result = _generic_dir(obj);
1353 }
1354 else {
1355 /* use __dir__ */
1356 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1357 Py_DECREF(dirfunc);
1358 if (result == NULL)
1359 return NULL;
1360
1361 /* result must be a list */
1362 /* XXX(gbrandl): could also check if all items are strings */
1363 if (!PyList_Check(result)) {
1364 PyErr_Format(PyExc_TypeError,
1365 "__dir__() must return a list, not %.200s",
Christian Heimes90aa7642007-12-19 02:45:37 +00001366 Py_TYPE(result)->tp_name);
Georg Brandle32b4222007-03-10 22:13:27 +00001367 Py_DECREF(result);
1368 result = NULL;
1369 }
1370 }
1371
1372 return result;
1373}
1374
1375/* Implementation of dir() -- if obj is NULL, returns the names in the current
1376 (local) scope. Otherwise, performs introspection of the object: returns a
1377 sorted list of attribute names (supposedly) accessible from the object
1378*/
1379PyObject *
1380PyObject_Dir(PyObject *obj)
1381{
1382 PyObject * result;
1383
1384 if (obj == NULL)
1385 /* no object -- introspect the locals */
1386 result = _dir_locals();
1387 else
1388 /* object -- introspect the object */
1389 result = _dir_object(obj);
1390
1391 assert(result == NULL || PyList_Check(result));
1392
1393 if (result != NULL && PyList_Sort(result) != 0) {
1394 /* sorting the list failed */
1395 Py_DECREF(result);
1396 result = NULL;
1397 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001398
Tim Peters7eea37e2001-09-04 22:08:56 +00001399 return result;
1400}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001401
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001402/*
1403NoObject is usable as a non-NULL undefined value, used by the macro None.
1404There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001405so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001406(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001407*/
1408
Guido van Rossum0c182a11992-03-27 17:26:13 +00001409/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001410static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001411none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001412{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001413 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001414}
1415
Barry Warsaw9bf16442001-01-23 16:24:35 +00001416/* ARGUSED */
1417static void
Tim Peters803526b2002-07-07 05:13:56 +00001418none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001419{
1420 /* This should never get called, but we also don't want to SEGV if
1421 * we accidently decref None out of existance.
1422 */
Martin v. Löwis3f19b102002-08-07 16:21:51 +00001423 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001424}
1425
1426
Guido van Rossumba21a492001-08-16 08:17:26 +00001427static PyTypeObject PyNone_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001428 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001429 "NoneType",
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001430 0,
1431 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001432 none_dealloc, /*tp_dealloc*/ /*never called*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001433 0, /*tp_print*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001434 0, /*tp_getattr*/
1435 0, /*tp_setattr*/
Mark Dickinsone94c6792009-02-02 20:36:42 +00001436 0, /*tp_reserved*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001437 none_repr, /*tp_repr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001438 0, /*tp_as_number*/
1439 0, /*tp_as_sequence*/
1440 0, /*tp_as_mapping*/
Guido van Rossum9bfef441993-03-29 10:43:31 +00001441 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001442};
1443
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001444PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001445 _PyObject_EXTRA_INIT
1446 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001447};
1448
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001449/* NotImplemented is an object that can be used to signal that an
1450 operation is not implemented for the given type combination. */
1451
1452static PyObject *
1453NotImplemented_repr(PyObject *op)
1454{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001455 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001456}
1457
1458static PyTypeObject PyNotImplemented_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001459 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001460 "NotImplementedType",
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001461 0,
1462 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001463 none_dealloc, /*tp_dealloc*/ /*never called*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001464 0, /*tp_print*/
1465 0, /*tp_getattr*/
1466 0, /*tp_setattr*/
Mark Dickinsone94c6792009-02-02 20:36:42 +00001467 0, /*tp_reserved*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001468 NotImplemented_repr, /*tp_repr*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001469 0, /*tp_as_number*/
1470 0, /*tp_as_sequence*/
1471 0, /*tp_as_mapping*/
1472 0, /*tp_hash */
1473};
1474
1475PyObject _Py_NotImplementedStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001476 _PyObject_EXTRA_INIT
1477 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001478};
1479
Guido van Rossumba21a492001-08-16 08:17:26 +00001480void
1481_Py_ReadyTypes(void)
1482{
1483 if (PyType_Ready(&PyType_Type) < 0)
1484 Py_FatalError("Can't initialize 'type'");
1485
Fred Drake0a4dd392004-07-02 18:57:45 +00001486 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1487 Py_FatalError("Can't initialize 'weakref'");
1488
Guido van Rossum77f6a652002-04-03 22:41:51 +00001489 if (PyType_Ready(&PyBool_Type) < 0)
1490 Py_FatalError("Can't initialize 'bool'");
1491
Christian Heimes9c4756e2008-05-26 13:22:05 +00001492 if (PyType_Ready(&PyByteArray_Type) < 0)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001493 Py_FatalError("Can't initialize 'bytes'");
1494
Christian Heimes72b710a2008-05-26 13:28:38 +00001495 if (PyType_Ready(&PyBytes_Type) < 0)
Guido van Rossumcacfc072002-05-24 19:01:59 +00001496 Py_FatalError("Can't initialize 'str'");
1497
Guido van Rossumba21a492001-08-16 08:17:26 +00001498 if (PyType_Ready(&PyList_Type) < 0)
1499 Py_FatalError("Can't initialize 'list'");
1500
1501 if (PyType_Ready(&PyNone_Type) < 0)
1502 Py_FatalError("Can't initialize type(None)");
1503
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001504 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1505 Py_FatalError("Can't initialize type(Ellipsis)");
1506
Guido van Rossumba21a492001-08-16 08:17:26 +00001507 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1508 Py_FatalError("Can't initialize type(NotImplemented)");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001509
1510 if (PyType_Ready(&PyCode_Type) < 0)
1511 Py_FatalError("Can't initialize 'code'");
Guido van Rossum826d8972007-10-30 18:34:07 +00001512
1513 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1514 Py_FatalError("Can't initialize StdPrinter");
Guido van Rossumba21a492001-08-16 08:17:26 +00001515}
1516
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001517
Guido van Rossum84a90321996-05-22 16:34:47 +00001518#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001519
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001520void
Fred Drake100814d2000-07-09 15:48:49 +00001521_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001522{
Tim Peters34592512002-07-11 06:23:50 +00001523 _Py_INC_REFTOTAL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001524 op->ob_refcnt = 1;
Tim Peters7571a0f2003-03-23 17:52:28 +00001525 _Py_AddToAllObjects(op, 1);
Tim Peters34592512002-07-11 06:23:50 +00001526 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001527}
1528
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001529void
Fred Drake100814d2000-07-09 15:48:49 +00001530_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001531{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001532#ifdef SLOW_UNREF_CHECK
Guido van Rossum4c08d552000-03-10 22:55:18 +00001533 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001534#endif
Guido van Rossumd7047b31995-01-02 19:07:15 +00001535 if (op->ob_refcnt < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001536 Py_FatalError("UNREF negative refcnt");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001537 if (op == &refchain ||
Christian Heimesc8967002007-11-30 10:18:26 +00001538 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1539 fprintf(stderr, "* ob\n");
1540 _PyObject_Dump(op);
1541 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1542 _PyObject_Dump(op->_ob_prev->_ob_next);
1543 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1544 _PyObject_Dump(op->_ob_next->_ob_prev);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001545 Py_FatalError("UNREF invalid object");
Christian Heimesc8967002007-11-30 10:18:26 +00001546 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001547#ifdef SLOW_UNREF_CHECK
Guido van Rossum3f5da241990-12-20 15:06:42 +00001548 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1549 if (p == op)
1550 break;
1551 }
Guido van Rossumd7047b31995-01-02 19:07:15 +00001552 if (p == &refchain) /* Not found */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001553 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001554#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001555 op->_ob_next->_ob_prev = op->_ob_prev;
1556 op->_ob_prev->_ob_next = op->_ob_next;
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001557 op->_ob_next = op->_ob_prev = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001558 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001559}
1560
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001561void
Fred Drake100814d2000-07-09 15:48:49 +00001562_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001563{
Christian Heimes90aa7642007-12-19 02:45:37 +00001564 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001565 _Py_ForgetReference(op);
Guido van Rossum9776adf1994-09-07 14:36:45 +00001566 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001567}
1568
Tim Peters269b2a62003-04-17 19:52:29 +00001569/* Print all live objects. Because PyObject_Print is called, the
1570 * interpreter must be in a healthy state.
1571 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001572void
Fred Drake100814d2000-07-09 15:48:49 +00001573_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001574{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001575 PyObject *op;
Guido van Rossume09fb551997-08-05 02:04:34 +00001576 fprintf(fp, "Remaining objects:\n");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001577 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001578 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001579 if (PyObject_Print(op, fp, 0) != 0)
1580 PyErr_Clear();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001581 putc('\n', fp);
1582 }
1583}
1584
Tim Peters269b2a62003-04-17 19:52:29 +00001585/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1586 * doesn't make any calls to the Python C API, so is always safe to call.
1587 */
1588void
1589_Py_PrintReferenceAddresses(FILE *fp)
1590{
1591 PyObject *op;
1592 fprintf(fp, "Remaining object addresses:\n");
1593 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001594 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
Christian Heimes90aa7642007-12-19 02:45:37 +00001595 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001596}
1597
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001598PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001599_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001600{
1601 int i, n;
1602 PyObject *t = NULL;
1603 PyObject *res, *op;
1604
1605 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1606 return NULL;
1607 op = refchain._ob_next;
1608 res = PyList_New(0);
1609 if (res == NULL)
1610 return NULL;
1611 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1612 while (op == self || op == args || op == res || op == t ||
Christian Heimes90aa7642007-12-19 02:45:37 +00001613 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001614 op = op->_ob_next;
1615 if (op == &refchain)
1616 return res;
1617 }
1618 if (PyList_Append(res, op) < 0) {
1619 Py_DECREF(res);
1620 return NULL;
1621 }
1622 op = op->_ob_next;
1623 }
1624 return res;
1625}
1626
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001627#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001628
1629
1630/* Hack to force loading of cobject.o */
Guido van Rossumda9c2711996-12-05 21:58:58 +00001631PyTypeObject *_Py_cobject_hack = &PyCObject_Type;
Guido van Rossum84a90321996-05-22 16:34:47 +00001632
1633
1634/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001635Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001636
1637
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001638/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001639
Thomas Wouters334fb892000-07-25 12:56:38 +00001640void *
Fred Drake100814d2000-07-09 15:48:49 +00001641PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001642{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001643 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001644}
1645
Thomas Wouters334fb892000-07-25 12:56:38 +00001646void *
1647PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001648{
Tim Petersaf3e8de2002-04-12 07:22:56 +00001649 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001650}
1651
1652void
Thomas Wouters334fb892000-07-25 12:56:38 +00001653PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001654{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001655 PyMem_FREE(p);
1656}
1657
1658
Guido van Rossum86610361998-04-10 22:32:46 +00001659/* These methods are used to control infinite recursion in repr, str, print,
1660 etc. Container objects that may recursively contain themselves,
1661 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1662 Py_ReprLeave() to avoid infinite recursion.
1663
1664 Py_ReprEnter() returns 0 the first time it is called for a particular
1665 object and 1 every time thereafter. It returns -1 if an exception
1666 occurred. Py_ReprLeave() has no return value.
1667
1668 See dictobject.c and listobject.c for examples of use.
1669*/
1670
1671#define KEY "Py_Repr"
1672
1673int
Fred Drake100814d2000-07-09 15:48:49 +00001674Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001675{
1676 PyObject *dict;
1677 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001678 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001679
1680 dict = PyThreadState_GetDict();
1681 if (dict == NULL)
Guido van Rossum0fc8f002003-04-15 15:12:39 +00001682 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001683 list = PyDict_GetItemString(dict, KEY);
1684 if (list == NULL) {
1685 list = PyList_New(0);
1686 if (list == NULL)
1687 return -1;
1688 if (PyDict_SetItemString(dict, KEY, list) < 0)
1689 return -1;
1690 Py_DECREF(list);
1691 }
1692 i = PyList_GET_SIZE(list);
1693 while (--i >= 0) {
1694 if (PyList_GET_ITEM(list, i) == obj)
1695 return 1;
1696 }
1697 PyList_Append(list, obj);
1698 return 0;
1699}
1700
1701void
Fred Drake100814d2000-07-09 15:48:49 +00001702Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001703{
1704 PyObject *dict;
1705 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001706 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001707
1708 dict = PyThreadState_GetDict();
Guido van Rossumeb909461998-04-11 15:17:34 +00001709 if (dict == NULL)
1710 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001711 list = PyDict_GetItemString(dict, KEY);
Guido van Rossumeb909461998-04-11 15:17:34 +00001712 if (list == NULL || !PyList_Check(list))
1713 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001714 i = PyList_GET_SIZE(list);
1715 /* Count backwards because we always expect obj to be list[-1] */
1716 while (--i >= 0) {
1717 if (PyList_GET_ITEM(list, i) == obj) {
1718 PyList_SetSlice(list, i, i + 1, NULL);
1719 break;
1720 }
1721 }
1722}
Guido van Rossumd724b232000-03-13 16:01:29 +00001723
Tim Peters803526b2002-07-07 05:13:56 +00001724/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001725
Tim Peters803526b2002-07-07 05:13:56 +00001726/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001727int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001728
Tim Peters803526b2002-07-07 05:13:56 +00001729/* List of objects that still need to be cleaned up, singly linked via their
1730 * gc headers' gc_prev pointers.
1731 */
1732PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001733
Tim Peters803526b2002-07-07 05:13:56 +00001734/* Add op to the _PyTrash_delete_later list. Called when the current
1735 * call-stack depth gets large. op must be a currently untracked gc'ed
1736 * object, with refcount 0. Py_DECREF must already have been called on it.
1737 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001738void
Fred Drake100814d2000-07-09 15:48:49 +00001739_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001740{
Tim Peters803526b2002-07-07 05:13:56 +00001741 assert(PyObject_IS_GC(op));
1742 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1743 assert(op->ob_refcnt == 0);
Neil Schemenauerf589c052002-03-29 03:05:54 +00001744 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
Guido van Rossume92e6102000-04-24 15:40:53 +00001745 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001746}
1747
Tim Peters803526b2002-07-07 05:13:56 +00001748/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1749 * the call-stack unwinds again.
1750 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001751void
Fred Drake100814d2000-07-09 15:48:49 +00001752_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001753{
1754 while (_PyTrash_delete_later) {
Tim Peters803526b2002-07-07 05:13:56 +00001755 PyObject *op = _PyTrash_delete_later;
Christian Heimes90aa7642007-12-19 02:45:37 +00001756 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001757
Neil Schemenauerf589c052002-03-29 03:05:54 +00001758 _PyTrash_delete_later =
Tim Peters803526b2002-07-07 05:13:56 +00001759 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001760
Tim Peters803526b2002-07-07 05:13:56 +00001761 /* Call the deallocator directly. This used to try to
1762 * fool Py_DECREF into calling it indirectly, but
1763 * Py_DECREF was already called on this object, and in
1764 * assorted non-release builds calling Py_DECREF again ends
1765 * up distorting allocation statistics.
1766 */
1767 assert(op->ob_refcnt == 0);
Guido van Rossumd724b232000-03-13 16:01:29 +00001768 ++_PyTrash_delete_nesting;
Tim Peters803526b2002-07-07 05:13:56 +00001769 (*dealloc)(op);
Guido van Rossumd724b232000-03-13 16:01:29 +00001770 --_PyTrash_delete_nesting;
1771 }
1772}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001773
1774#ifdef __cplusplus
1775}
1776#endif