blob: 587e8063377bbedf1ebaa476e9bd132384f41de8 [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. */
84int unlist_types_without_objects;
Sjoerd Mullender842d2cc1993-10-15 16:18:48 +000085extern int tuple_zero_allocs, fast_tuple_allocs;
86extern int quick_int_allocs, quick_neg_int_allocs;
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +000087extern int 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)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000094 fprintf(f, "%s alloc'd: %d, freed: %d, max in use: %d\n",
Tim Peters6d6c1a32001-08-02 04:15:00 +000095 tp->tp_name, tp->tp_allocs, tp->tp_frees,
Sjoerd Mullender52c1f511993-10-25 08:40:52 +000096 tp->tp_maxalloc);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000097 fprintf(f, "fast tuple allocs: %d, empty: %d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +000098 fast_tuple_allocs, tuple_zero_allocs);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000099 fprintf(f, "fast int allocs: pos: %d, neg: %d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +0000100 quick_int_allocs, quick_neg_int_allocs);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000101 fprintf(f, "null strings: %d, 1-strings: %d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +0000102 null_strings, one_strings);
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000103}
104
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000105PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000106get_counts(void)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000107{
108 PyTypeObject *tp;
109 PyObject *result;
110 PyObject *v;
111
112 result = PyList_New(0);
113 if (result == NULL)
114 return NULL;
115 for (tp = type_list; tp; tp = tp->tp_next) {
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000116 v = Py_BuildValue("(snnn)", tp->tp_name, tp->tp_allocs,
Tim Peters6d6c1a32001-08-02 04:15:00 +0000117 tp->tp_frees, tp->tp_maxalloc);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000118 if (v == NULL) {
119 Py_DECREF(result);
120 return NULL;
121 }
122 if (PyList_Append(result, v) < 0) {
123 Py_DECREF(v);
124 Py_DECREF(result);
125 return NULL;
126 }
127 Py_DECREF(v);
128 }
129 return result;
130}
131
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000132void
Fred Drake100814d2000-07-09 15:48:49 +0000133inc_count(PyTypeObject *tp)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000134{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000135 if (tp->tp_next == NULL && tp->tp_prev == NULL) {
Guido van Rossumd8953cb1995-04-06 14:46:26 +0000136 /* first time; insert in linked list */
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000137 if (tp->tp_next != NULL) /* sanity check */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000138 Py_FatalError("XXX inc_count sanity check");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000139 if (type_list)
140 type_list->tp_prev = tp;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000141 tp->tp_next = type_list;
Tim Petersc6a3ff62002-07-08 22:11:52 +0000142 /* Note that as of Python 2.2, heap-allocated type objects
143 * can go away, but this code requires that they stay alive
144 * until program exit. That's why we're careful with
145 * refcounts here. type_list gets a new reference to tp,
146 * while ownership of the reference type_list used to hold
147 * (if any) was transferred to tp->tp_next in the line above.
148 * tp is thus effectively immortal after this.
149 */
150 Py_INCREF(tp);
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000151 type_list = tp;
Tim Peters3e40c7f2003-03-23 03:04:32 +0000152#ifdef Py_TRACE_REFS
Tim Peters7571a0f2003-03-23 17:52:28 +0000153 /* Also insert in the doubly-linked list of all objects,
154 * if not already there.
155 */
156 _Py_AddToAllObjects((PyObject *)tp, 0);
Tim Peters78be7992003-03-23 02:51:01 +0000157#endif
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000158 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000159 tp->tp_allocs++;
160 if (tp->tp_allocs - tp->tp_frees > tp->tp_maxalloc)
161 tp->tp_maxalloc = tp->tp_allocs - tp->tp_frees;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000162}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000163
164void dec_count(PyTypeObject *tp)
165{
166 tp->tp_frees++;
167 if (unlist_types_without_objects &&
168 tp->tp_allocs == tp->tp_frees) {
169 /* unlink the type from type_list */
170 if (tp->tp_prev)
171 tp->tp_prev->tp_next = tp->tp_next;
172 else
173 type_list = tp->tp_next;
174 if (tp->tp_next)
175 tp->tp_next->tp_prev = tp->tp_prev;
176 tp->tp_next = tp->tp_prev = NULL;
177 Py_DECREF(tp);
178 }
179}
180
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000181#endif
182
Tim Peters7c321a82002-07-09 02:57:01 +0000183#ifdef Py_REF_DEBUG
184/* Log a fatal error; doesn't return. */
185void
186_Py_NegativeRefcount(const char *fname, int lineno, PyObject *op)
187{
188 char buf[300];
189
190 PyOS_snprintf(buf, sizeof(buf),
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000191 "%s:%i object at %p has negative ref count "
192 "%" PY_FORMAT_SIZE_T "d",
193 fname, lineno, op, op->ob_refcnt);
Tim Peters7c321a82002-07-09 02:57:01 +0000194 Py_FatalError(buf);
195}
196
197#endif /* Py_REF_DEBUG */
198
Thomas Heller1328b522004-04-22 17:23:49 +0000199void
200Py_IncRef(PyObject *o)
201{
202 Py_XINCREF(o);
203}
204
205void
206Py_DecRef(PyObject *o)
207{
208 Py_XDECREF(o);
209}
210
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000211PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000212PyObject_Init(PyObject *op, PyTypeObject *tp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000213{
Guido van Rossum6e08c142002-10-11 20:37:24 +0000214 if (op == NULL)
215 return PyErr_NoMemory();
Guido van Rossumb18618d2000-05-03 23:44:39 +0000216 /* Any changes should be reflected in PyObject_INIT (objimpl.h) */
Christian Heimes90aa7642007-12-19 02:45:37 +0000217 Py_TYPE(op) = tp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000218 _Py_NewReference(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000219 return op;
220}
221
Guido van Rossumb18618d2000-05-03 23:44:39 +0000222PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000223PyObject_InitVar(PyVarObject *op, PyTypeObject *tp, Py_ssize_t size)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000224{
Guido van Rossum6e08c142002-10-11 20:37:24 +0000225 if (op == NULL)
226 return (PyVarObject *) PyErr_NoMemory();
Guido van Rossumb18618d2000-05-03 23:44:39 +0000227 /* Any changes should be reflected in PyObject_INIT_VAR */
228 op->ob_size = size;
Christian Heimes90aa7642007-12-19 02:45:37 +0000229 Py_TYPE(op) = tp;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000230 _Py_NewReference((PyObject *)op);
231 return op;
232}
233
234PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000235_PyObject_New(PyTypeObject *tp)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000236{
237 PyObject *op;
238 op = (PyObject *) PyObject_MALLOC(_PyObject_SIZE(tp));
239 if (op == NULL)
240 return PyErr_NoMemory();
241 return PyObject_INIT(op, tp);
242}
243
Guido van Rossumd0c87ee1997-05-15 21:31:03 +0000244PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000245_PyObject_NewVar(PyTypeObject *tp, Py_ssize_t nitems)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000246{
Guido van Rossumb18618d2000-05-03 23:44:39 +0000247 PyVarObject *op;
Tim Petersf2a67da2001-10-07 03:54:51 +0000248 const size_t size = _PyObject_VAR_SIZE(tp, nitems);
Tim Peters6d483d32001-10-06 21:27:34 +0000249 op = (PyVarObject *) PyObject_MALLOC(size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000250 if (op == NULL)
Guido van Rossumd0c87ee1997-05-15 21:31:03 +0000251 return (PyVarObject *)PyErr_NoMemory();
Tim Peters6d483d32001-10-06 21:27:34 +0000252 return PyObject_INIT_VAR(op, tp, nitems);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000253}
254
Neal Norwitz1a997502003-01-13 20:13:12 +0000255/* Implementation of PyObject_Print with recursion checking */
256static int
257internal_print(PyObject *op, FILE *fp, int flags, int nesting)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000258{
Guido van Rossum278ef591991-07-27 21:40:24 +0000259 int ret = 0;
Neal Norwitz1a997502003-01-13 20:13:12 +0000260 if (nesting > 10) {
261 PyErr_SetString(PyExc_RuntimeError, "print recursion");
262 return -1;
263 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000264 if (PyErr_CheckSignals())
Guido van Rossum90933611991-06-07 16:10:43 +0000265 return -1;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000266#ifdef USE_STACKCHECK
267 if (PyOS_CheckStack()) {
Fred Drake661ea262000-10-24 19:57:45 +0000268 PyErr_SetString(PyExc_MemoryError, "stack overflow");
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000269 return -1;
270 }
271#endif
Guido van Rossum687ef6e2000-01-12 16:28:58 +0000272 clearerr(fp); /* Clear any previous error condition */
Guido van Rossum90933611991-06-07 16:10:43 +0000273 if (op == NULL) {
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000274 Py_BEGIN_ALLOW_THREADS
Guido van Rossum90933611991-06-07 16:10:43 +0000275 fprintf(fp, "<nil>");
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000276 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000277 }
Guido van Rossum90933611991-06-07 16:10:43 +0000278 else {
279 if (op->ob_refcnt <= 0)
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000280 /* XXX(twouters) cast refcount to long until %zd is
281 universally available */
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000282 Py_BEGIN_ALLOW_THREADS
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000283 fprintf(fp, "<refcnt %ld at %p>",
284 (long)op->ob_refcnt, op);
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000285 Py_END_ALLOW_THREADS
Guido van Rossum04dbf3b2007-08-07 19:51:00 +0000286 else {
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000287 PyObject *s;
288 if (flags & Py_PRINT_RAW)
289 s = PyObject_Str(op);
290 else
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000291 s = PyObject_Repr(op);
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000292 if (s == NULL)
293 ret = -1;
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000294 else if (PyString_Check(s)) {
295 fwrite(PyString_AS_STRING(s), 1,
296 PyString_GET_SIZE(s), fp);
297 }
298 else if (PyUnicode_Check(s)) {
299 PyObject *t;
300 t = _PyUnicode_AsDefaultEncodedString(s, NULL);
301 if (t == NULL)
302 ret = 0;
303 else {
304 fwrite(PyString_AS_STRING(t), 1,
305 PyString_GET_SIZE(t), fp);
306 }
307 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000308 else {
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000309 PyErr_Format(PyExc_TypeError,
310 "str() or repr() returned '%.100s'",
311 s->ob_type->tp_name);
312 ret = -1;
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000313 }
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000314 Py_XDECREF(s);
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000315 }
Guido van Rossum90933611991-06-07 16:10:43 +0000316 }
Guido van Rossum278ef591991-07-27 21:40:24 +0000317 if (ret == 0) {
318 if (ferror(fp)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000319 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum278ef591991-07-27 21:40:24 +0000320 clearerr(fp);
321 ret = -1;
322 }
323 }
324 return ret;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000325}
326
Neal Norwitz1a997502003-01-13 20:13:12 +0000327int
328PyObject_Print(PyObject *op, FILE *fp, int flags)
329{
330 return internal_print(op, fp, flags, 0);
331}
332
Guido van Rossum38938152006-08-21 23:36:26 +0000333/* For debugging convenience. Set a breakpoint here and call it from your DLL */
334void
Thomas Woutersb2137042007-02-01 18:02:27 +0000335_Py_BreakPoint(void)
Guido van Rossum38938152006-08-21 23:36:26 +0000336{
337}
338
Neal Norwitz1a997502003-01-13 20:13:12 +0000339
Barry Warsaw9bf16442001-01-23 16:24:35 +0000340/* For debugging convenience. See Misc/gdbinit for some useful gdb hooks */
Guido van Rossum38938152006-08-21 23:36:26 +0000341void
342_PyObject_Dump(PyObject* op)
Barry Warsaw9bf16442001-01-23 16:24:35 +0000343{
Barry Warsaweefb1072001-02-22 22:39:18 +0000344 if (op == NULL)
345 fprintf(stderr, "NULL\n");
346 else {
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000347 fprintf(stderr, "object : ");
Barry Warsaweefb1072001-02-22 22:39:18 +0000348 (void)PyObject_Print(op, stderr, 0);
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000349 /* XXX(twouters) cast refcount to long until %zd is
350 universally available */
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000351 fprintf(stderr, "\n"
352 "type : %s\n"
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000353 "refcount: %ld\n"
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000354 "address : %p\n",
Christian Heimes90aa7642007-12-19 02:45:37 +0000355 Py_TYPE(op)==NULL ? "NULL" : Py_TYPE(op)->tp_name,
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000356 (long)op->ob_refcnt,
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000357 op);
Barry Warsaweefb1072001-02-22 22:39:18 +0000358 }
Barry Warsaw9bf16442001-01-23 16:24:35 +0000359}
Barry Warsaw903138f2001-01-23 16:33:18 +0000360
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000361PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000362PyObject_Repr(PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000363{
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000364 PyObject *res;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000365 if (PyErr_CheckSignals())
Guido van Rossum90933611991-06-07 16:10:43 +0000366 return NULL;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000367#ifdef USE_STACKCHECK
368 if (PyOS_CheckStack()) {
Fred Drake661ea262000-10-24 19:57:45 +0000369 PyErr_SetString(PyExc_MemoryError, "stack overflow");
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000370 return NULL;
371 }
372#endif
Guido van Rossum90933611991-06-07 16:10:43 +0000373 if (v == NULL)
Walter Dörwald1ab83302007-05-18 17:15:44 +0000374 return PyUnicode_FromString("<NULL>");
Christian Heimes90aa7642007-12-19 02:45:37 +0000375 if (Py_TYPE(v)->tp_repr == NULL)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000376 return PyUnicode_FromFormat("<%s object at %p>",
377 v->ob_type->tp_name, v);
378 res = (*v->ob_type->tp_repr)(v);
379 if (res != NULL && !PyUnicode_Check(res)) {
380 PyErr_Format(PyExc_TypeError,
381 "__repr__ returned non-string (type %.200s)",
382 res->ob_type->tp_name);
383 Py_DECREF(res);
384 return NULL;
385 }
386 return res;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000387}
388
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000389PyObject *
Guido van Rossum98297ee2007-11-06 21:34:58 +0000390PyObject_Str(PyObject *v)
Guido van Rossumc6004111993-11-05 10:22:19 +0000391{
Guido van Rossum4c08d552000-03-10 22:55:18 +0000392 PyObject *res;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000393 if (PyErr_CheckSignals())
394 return NULL;
395#ifdef USE_STACKCHECK
396 if (PyOS_CheckStack()) {
397 PyErr_SetString(PyExc_MemoryError, "stack overflow");
398 return NULL;
399 }
400#endif
Guido van Rossumc6004111993-11-05 10:22:19 +0000401 if (v == NULL)
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000402 return PyUnicode_FromString("<NULL>");
Neil Schemenauercf52c072005-08-12 17:34:58 +0000403 if (PyUnicode_CheckExact(v)) {
404 Py_INCREF(v);
405 return v;
406 }
Christian Heimes90aa7642007-12-19 02:45:37 +0000407 if (Py_TYPE(v)->tp_str == NULL)
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000408 return PyObject_Repr(v);
409
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000410 /* It is possible for a type to have a tp_str representation that loops
411 infinitely. */
412 if (Py_EnterRecursiveCall(" while getting the str of an object"))
413 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +0000414 res = (*Py_TYPE(v)->tp_str)(v);
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000415 Py_LeaveRecursiveCall();
Guido van Rossum4c08d552000-03-10 22:55:18 +0000416 if (res == NULL)
417 return NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000418 if (!PyUnicode_Check(res)) {
Neil Schemenauercf52c072005-08-12 17:34:58 +0000419 PyErr_Format(PyExc_TypeError,
420 "__str__ returned non-string (type %.200s)",
Christian Heimes90aa7642007-12-19 02:45:37 +0000421 Py_TYPE(res)->tp_name);
Neil Schemenauercf52c072005-08-12 17:34:58 +0000422 Py_DECREF(res);
423 return NULL;
424 }
425 return res;
426}
427
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000428
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000429/* The new comparison philosophy is: we completely separate three-way
430 comparison from rich comparison. That is, PyObject_Compare() and
431 PyObject_Cmp() *just* use the tp_compare slot. And PyObject_RichCompare()
432 and PyObject_RichCompareBool() *just* use the tp_richcompare slot.
Guido van Rossum98297ee2007-11-06 21:34:58 +0000433
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000434 See (*) below for practical amendments.
435
436 IOW, only cmp() uses tp_compare; the comparison operators (==, !=, <=, <,
437 >=, >) only use tp_richcompare. Note that list.sort() only uses <.
438
439 (And yes, eventually we'll rip out cmp() and tp_compare.)
440
441 The calling conventions are different: tp_compare only gets called with two
442 objects of the appropriate type; tp_richcompare gets called with a first
443 argument of the appropriate type and a second object of an arbitrary type.
444 We never do any kind of coercion.
445
446 The return conventions are also different.
447
448 The tp_compare slot should return a C int, as follows:
449
450 -1 if a < b or if an exception occurred
451 0 if a == b
452 +1 if a > b
453
454 No other return values are allowed. PyObject_Compare() has the same
455 calling convention.
456
457 The tp_richcompare slot should return an object, as follows:
458
459 NULL if an exception occurred
460 NotImplemented if the requested comparison is not implemented
461 any other false value if the requested comparison is false
462 any other true value if the requested comparison is true
463
464 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
465 NotImplemented.
466
467 (*) Practical amendments:
468
469 - If rich comparison returns NotImplemented, == and != are decided by
470 comparing the object pointer (i.e. falling back to the base object
471 implementation).
472
473 - If three-way comparison is not implemented, it falls back on rich
474 comparison (but not the other way around!).
475
Guido van Rossuma4073002002-05-31 20:03:54 +0000476*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000477
478/* Forward */
479static PyObject *do_richcompare(PyObject *v, PyObject *w, int op);
480
481/* Perform a three-way comparison, raising TypeError if three-way comparison
482 is not supported. */
Guido van Rossuma4073002002-05-31 20:03:54 +0000483static int
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000484do_compare(PyObject *v, PyObject *w)
Guido van Rossuma4073002002-05-31 20:03:54 +0000485{
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000486 cmpfunc f;
487 int ok;
488
Guido van Rossum98297ee2007-11-06 21:34:58 +0000489 if (v->ob_type == w->ob_type &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000490 (f = v->ob_type->tp_compare) != NULL) {
491 return (*f)(v, w);
Guido van Rossuma4073002002-05-31 20:03:54 +0000492 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000493
494 /* Now try three-way compare before giving up. This is intentionally
495 elaborate; if you have a it will raise TypeError if it detects two
496 objects that aren't ordered with respect to each other. */
497 ok = PyObject_RichCompareBool(v, w, Py_LT);
498 if (ok < 0)
499 return -1; /* Error */
500 if (ok)
501 return -1; /* Less than */
502 ok = PyObject_RichCompareBool(v, w, Py_GT);
503 if (ok < 0)
504 return -1; /* Error */
505 if (ok)
506 return 1; /* Greater than */
507 ok = PyObject_RichCompareBool(v, w, Py_EQ);
508 if (ok < 0)
509 return -1; /* Error */
510 if (ok)
511 return 0; /* Equal */
512
513 /* Give up */
514 PyErr_Format(PyExc_TypeError,
Neal Norwitz3bd844e2006-08-29 04:39:12 +0000515 "unorderable types: '%.100s' != '%.100s'",
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000516 v->ob_type->tp_name,
517 w->ob_type->tp_name);
518 return -1;
Guido van Rossuma4073002002-05-31 20:03:54 +0000519}
520
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000521/* Perform a three-way comparison. This wraps do_compare() with a check for
522 NULL arguments and a recursion check. */
523int
524PyObject_Compare(PyObject *v, PyObject *w)
525{
526 int res;
Guido van Rossuma4073002002-05-31 20:03:54 +0000527
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000528 if (v == NULL || w == NULL) {
529 if (!PyErr_Occurred())
530 PyErr_BadInternalCall();
531 return -1;
532 }
533 if (Py_EnterRecursiveCall(" in cmp"))
534 return -1;
535 res = do_compare(v, w);
536 Py_LeaveRecursiveCall();
537 return res < 0 ? -1 : res;
538}
Guido van Rossumd1f06b92001-01-24 22:14:43 +0000539
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000540/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000541int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000542
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000543static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000544
545/* Perform a rich comparison, raising TypeError when the requested comparison
546 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000547static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000548do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000549{
550 richcmpfunc f;
551 PyObject *res;
552
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000553 if (v->ob_type != w->ob_type &&
554 PyType_IsSubtype(w->ob_type, v->ob_type) &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000555 (f = w->ob_type->tp_richcompare) != NULL) {
Tim Petersf4aca752004-09-23 02:39:37 +0000556 res = (*f)(w, v, _Py_SwappedOp[op]);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000557 if (res != Py_NotImplemented)
558 return res;
559 Py_DECREF(res);
560 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000561 if ((f = v->ob_type->tp_richcompare) != NULL) {
Guido van Rossume797ec12001-01-17 15:24:28 +0000562 res = (*f)(v, w, op);
563 if (res != Py_NotImplemented)
564 return res;
565 Py_DECREF(res);
566 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000567 if ((f = w->ob_type->tp_richcompare) != NULL) {
568 res = (*f)(w, v, _Py_SwappedOp[op]);
569 if (res != Py_NotImplemented)
570 return res;
571 Py_DECREF(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000572 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000573 /* If neither object implements it, provide a sensible default
574 for == and !=, but raise an exception for ordering. */
575 switch (op) {
576 case Py_EQ:
577 res = (v == w) ? Py_True : Py_False;
578 break;
579 case Py_NE:
580 res = (v != w) ? Py_True : Py_False;
581 break;
582 default:
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000583 /* XXX Special-case None so it doesn't show as NoneType() */
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000584 PyErr_Format(PyExc_TypeError,
585 "unorderable types: %.100s() %s %.100s()",
586 v->ob_type->tp_name,
587 opstrings[op],
588 w->ob_type->tp_name);
589 return NULL;
590 }
Guido van Rossume797ec12001-01-17 15:24:28 +0000591 Py_INCREF(res);
592 return res;
593}
594
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000595/* Perform a rich comparison with object result. This wraps do_richcompare()
596 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000597
Guido van Rossume797ec12001-01-17 15:24:28 +0000598PyObject *
599PyObject_RichCompare(PyObject *v, PyObject *w, int op)
600{
601 PyObject *res;
602
603 assert(Py_LT <= op && op <= Py_GE);
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000604 if (v == NULL || w == NULL) {
605 if (!PyErr_Occurred())
606 PyErr_BadInternalCall();
607 return NULL;
608 }
Armin Rigo2b3eb402003-10-28 12:05:48 +0000609 if (Py_EnterRecursiveCall(" in cmp"))
610 return NULL;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000611 res = do_richcompare(v, w, op);
Armin Rigo2b3eb402003-10-28 12:05:48 +0000612 Py_LeaveRecursiveCall();
Guido van Rossume797ec12001-01-17 15:24:28 +0000613 return res;
614}
615
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000616/* Perform a rich comparison with integer result. This wraps
617 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000618int
619PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
620{
Raymond Hettinger93d44812004-03-21 17:01:44 +0000621 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000622 int ok;
623
Raymond Hettinger93d44812004-03-21 17:01:44 +0000624 res = PyObject_RichCompare(v, w, op);
Guido van Rossume797ec12001-01-17 15:24:28 +0000625 if (res == NULL)
626 return -1;
Guido van Rossum81912d42002-08-24 05:33:28 +0000627 if (PyBool_Check(res))
628 ok = (res == Py_True);
629 else
630 ok = PyObject_IsTrue(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000631 Py_DECREF(res);
632 return ok;
633}
Fred Drake13634cf2000-06-29 19:17:04 +0000634
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000635/* Turn the result of a three-way comparison into the result expected by a
636 rich comparison. */
637PyObject *
638Py_CmpToRich(int op, int cmp)
639{
640 PyObject *res;
641 int ok;
642
643 if (PyErr_Occurred())
644 return NULL;
645 switch (op) {
646 case Py_LT:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000647 ok = cmp < 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000648 break;
649 case Py_LE:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000650 ok = cmp <= 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000651 break;
652 case Py_EQ:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000653 ok = cmp == 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000654 break;
655 case Py_NE:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000656 ok = cmp != 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000657 break;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000658 case Py_GT:
659 ok = cmp > 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000660 break;
661 case Py_GE:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000662 ok = cmp >= 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000663 break;
664 default:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000665 PyErr_BadArgument();
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000666 return NULL;
667 }
668 res = ok ? Py_True : Py_False;
669 Py_INCREF(res);
670 return res;
671}
672
Fred Drake13634cf2000-06-29 19:17:04 +0000673/* Set of hash utility functions to help maintaining the invariant that
Raymond Hettinger8183fa42004-03-21 17:35:06 +0000674 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000675
676 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
677*/
678
679long
Fred Drake100814d2000-07-09 15:48:49 +0000680_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000681{
Tim Peters39dce292000-08-15 03:34:48 +0000682 double intpart, fractpart;
683 int expo;
684 long hipart;
685 long x; /* the final hash value */
686 /* This is designed so that Python numbers of different types
687 * that compare equal hash to the same value; otherwise comparisons
688 * of mapping keys will turn out weird.
689 */
690
Tim Peters39dce292000-08-15 03:34:48 +0000691 fractpart = modf(v, &intpart);
Tim Peters39dce292000-08-15 03:34:48 +0000692 if (fractpart == 0.0) {
693 /* This must return the same hash as an equal int or long. */
694 if (intpart > LONG_MAX || -intpart > LONG_MAX) {
695 /* Convert to long and use its hash. */
696 PyObject *plong; /* converted to Python long */
697 if (Py_IS_INFINITY(intpart))
698 /* can't convert to long int -- arbitrary */
699 v = v < 0 ? -271828.0 : 314159.0;
700 plong = PyLong_FromDouble(v);
701 if (plong == NULL)
702 return -1;
703 x = PyObject_Hash(plong);
704 Py_DECREF(plong);
705 return x;
706 }
707 /* Fits in a C long == a Python int, so is its own hash. */
708 x = (long)intpart;
709 if (x == -1)
710 x = -2;
711 return x;
712 }
713 /* The fractional part is non-zero, so we don't have to worry about
714 * making this match the hash of some other type.
715 * Use frexp to get at the bits in the double.
Fred Drake13634cf2000-06-29 19:17:04 +0000716 * Since the VAX D double format has 56 mantissa bits, which is the
717 * most of any double format in use, each of these parts may have as
718 * many as (but no more than) 56 significant bits.
Tim Peters39dce292000-08-15 03:34:48 +0000719 * So, assuming sizeof(long) >= 4, each part can be broken into two
720 * longs; frexp and multiplication are used to do that.
721 * Also, since the Cray double format has 15 exponent bits, which is
722 * the most of any double format in use, shifting the exponent field
723 * left by 15 won't overflow a long (again assuming sizeof(long) >= 4).
Fred Drake13634cf2000-06-29 19:17:04 +0000724 */
Tim Peters39dce292000-08-15 03:34:48 +0000725 v = frexp(v, &expo);
726 v *= 2147483648.0; /* 2**31 */
727 hipart = (long)v; /* take the top 32 bits */
728 v = (v - (double)hipart) * 2147483648.0; /* get the next 32 bits */
729 x = hipart + (long)v + (expo << 15);
730 if (x == -1)
731 x = -2;
732 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000733}
734
735long
Fred Drake100814d2000-07-09 15:48:49 +0000736_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000737{
738#if SIZEOF_LONG >= SIZEOF_VOID_P
739 return (long)p;
740#else
741 /* convert to a Python long and hash that */
742 PyObject* longobj;
743 long x;
Tim Peters803526b2002-07-07 05:13:56 +0000744
Fred Drake13634cf2000-06-29 19:17:04 +0000745 if ((longobj = PyLong_FromVoidPtr(p)) == NULL) {
746 x = -1;
747 goto finally;
748 }
749 x = PyObject_Hash(longobj);
Tim Peters803526b2002-07-07 05:13:56 +0000750
Fred Drake13634cf2000-06-29 19:17:04 +0000751finally:
752 Py_XDECREF(longobj);
753 return x;
754#endif
755}
756
757
Guido van Rossum9bfef441993-03-29 10:43:31 +0000758long
Fred Drake100814d2000-07-09 15:48:49 +0000759PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000760{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000761 PyTypeObject *tp = v->ob_type;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000762 if (tp->tp_hash != NULL)
763 return (*tp->tp_hash)(v);
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000764 /* Otherwise, the object can't be hashed */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000765 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
766 v->ob_type->tp_name);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000767 return -1;
768}
769
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000770PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000771PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000772{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000773 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000774
Christian Heimes90aa7642007-12-19 02:45:37 +0000775 if (Py_TYPE(v)->tp_getattr != NULL)
776 return (*Py_TYPE(v)->tp_getattr)(v, (char*)name);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000777 w = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000778 if (w == NULL)
779 return NULL;
780 res = PyObject_GetAttr(v, w);
781 Py_XDECREF(w);
782 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000783}
784
785int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000786PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000787{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000788 PyObject *res = PyObject_GetAttrString(v, name);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000789 if (res != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000790 Py_DECREF(res);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000791 return 1;
792 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000793 PyErr_Clear();
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000794 return 0;
795}
796
797int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000798PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000799{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000800 PyObject *s;
801 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000802
Christian Heimes90aa7642007-12-19 02:45:37 +0000803 if (Py_TYPE(v)->tp_setattr != NULL)
804 return (*Py_TYPE(v)->tp_setattr)(v, (char*)name, w);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000805 s = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000806 if (s == NULL)
807 return -1;
808 res = PyObject_SetAttr(v, s, w);
809 Py_XDECREF(s);
810 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000811}
812
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000813PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000814PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000815{
Christian Heimes90aa7642007-12-19 02:45:37 +0000816 PyTypeObject *tp = Py_TYPE(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000817
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000818 if (!PyUnicode_Check(name)) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000819 PyErr_Format(PyExc_TypeError,
820 "attribute name must be string, not '%.200s'",
821 name->ob_type->tp_name);
822 return NULL;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000823 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000824 if (tp->tp_getattro != NULL)
825 return (*tp->tp_getattro)(v, name);
826 if (tp->tp_getattr != NULL)
Martin v. Löwis5b222132007-06-10 09:51:05 +0000827 return (*tp->tp_getattr)(v, PyUnicode_AsString(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +0000828 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000829 "'%.50s' object has no attribute '%U'",
830 tp->tp_name, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000831 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000832}
833
834int
Fred Drake100814d2000-07-09 15:48:49 +0000835PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000836{
837 PyObject *res = PyObject_GetAttr(v, name);
838 if (res != NULL) {
839 Py_DECREF(res);
840 return 1;
841 }
842 PyErr_Clear();
843 return 0;
844}
845
846int
Fred Drake100814d2000-07-09 15:48:49 +0000847PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000848{
Christian Heimes90aa7642007-12-19 02:45:37 +0000849 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000850 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000851
Martin v. Löwis5b222132007-06-10 09:51:05 +0000852 if (!PyUnicode_Check(name)) {
853 PyErr_Format(PyExc_TypeError,
854 "attribute name must be string, not '%.200s'",
855 name->ob_type->tp_name);
856 return -1;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000857 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000858 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000859
Martin v. Löwis5b222132007-06-10 09:51:05 +0000860 PyUnicode_InternInPlace(&name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000861 if (tp->tp_setattro != NULL) {
862 err = (*tp->tp_setattro)(v, name, value);
863 Py_DECREF(name);
864 return err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000865 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000866 if (tp->tp_setattr != NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000867 err = (*tp->tp_setattr)(v, PyUnicode_AsString(name), value);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000868 Py_DECREF(name);
869 return err;
870 }
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000871 Py_DECREF(name);
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000872 assert(name->ob_refcnt >= 1);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000873 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
874 PyErr_Format(PyExc_TypeError,
875 "'%.100s' object has no attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000876 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000877 tp->tp_name,
878 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000879 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000880 else
881 PyErr_Format(PyExc_TypeError,
882 "'%.100s' object has only read-only attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000883 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000884 tp->tp_name,
885 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000886 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000887 return -1;
888}
889
890/* Helper to get a pointer to an object's __dict__ slot, if any */
891
892PyObject **
893_PyObject_GetDictPtr(PyObject *obj)
894{
Martin v. Löwis725507b2006-03-07 12:08:51 +0000895 Py_ssize_t dictoffset;
Christian Heimes90aa7642007-12-19 02:45:37 +0000896 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000897
Tim Peters6d6c1a32001-08-02 04:15:00 +0000898 dictoffset = tp->tp_dictoffset;
899 if (dictoffset == 0)
900 return NULL;
901 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000902 Py_ssize_t tsize;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000903 size_t size;
904
905 tsize = ((PyVarObject *)obj)->ob_size;
906 if (tsize < 0)
907 tsize = -tsize;
908 size = _PyObject_VAR_SIZE(tp, tsize);
909
Tim Peters6d483d32001-10-06 21:27:34 +0000910 dictoffset += (long)size;
911 assert(dictoffset > 0);
912 assert(dictoffset % SIZEOF_VOID_P == 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000913 }
914 return (PyObject **) ((char *)obj + dictoffset);
915}
916
Tim Peters6d6c1a32001-08-02 04:15:00 +0000917PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000918PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +0000919{
920 Py_INCREF(obj);
921 return obj;
922}
923
Michael W. Hudson1593f502004-09-14 17:09:47 +0000924/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
925
Raymond Hettinger01538262003-03-17 08:24:35 +0000926PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000927PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
928{
Christian Heimes90aa7642007-12-19 02:45:37 +0000929 PyTypeObject *tp = Py_TYPE(obj);
Guido van Rossum056fbf42002-08-19 19:22:50 +0000930 PyObject *descr = NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000931 PyObject *res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000932 descrgetfunc f;
Martin v. Löwis725507b2006-03-07 12:08:51 +0000933 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000934 PyObject **dictptr;
935
Martin v. Löwis5b222132007-06-10 09:51:05 +0000936 if (!PyUnicode_Check(name)){
937 PyErr_Format(PyExc_TypeError,
938 "attribute name must be string, not '%.200s'",
939 name->ob_type->tp_name);
940 return NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000941 }
942 else
943 Py_INCREF(name);
944
Tim Peters6d6c1a32001-08-02 04:15:00 +0000945 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +0000946 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000947 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000948 }
949
Christian Heimesa62da1d2008-01-12 19:39:10 +0000950#if 0 /* XXX this is not quite _PyType_Lookup anymore */
Guido van Rossum056fbf42002-08-19 19:22:50 +0000951 /* Inline _PyType_Lookup */
952 {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000953 Py_ssize_t i, n;
Guido van Rossum056fbf42002-08-19 19:22:50 +0000954 PyObject *mro, *base, *dict;
955
956 /* Look in tp_dict of types in MRO */
957 mro = tp->tp_mro;
958 assert(mro != NULL);
959 assert(PyTuple_Check(mro));
960 n = PyTuple_GET_SIZE(mro);
961 for (i = 0; i < n; i++) {
962 base = PyTuple_GET_ITEM(mro, i);
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000963 assert(PyType_Check(base));
964 dict = ((PyTypeObject *)base)->tp_dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +0000965 assert(dict && PyDict_Check(dict));
966 descr = PyDict_GetItem(dict, name);
967 if (descr != NULL)
968 break;
969 }
970 }
Christian Heimesa62da1d2008-01-12 19:39:10 +0000971#else
972 descr = _PyType_Lookup(tp, name);
973#endif
Guido van Rossum056fbf42002-08-19 19:22:50 +0000974
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000975 Py_XINCREF(descr);
976
Tim Peters6d6c1a32001-08-02 04:15:00 +0000977 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000978 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000979 f = descr->ob_type->tp_descr_get;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000980 if (f != NULL && PyDescr_IsData(descr)) {
981 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000982 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000983 goto done;
984 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000985 }
986
Guido van Rossumc66ff442002-08-19 16:50:48 +0000987 /* Inline _PyObject_GetDictPtr */
988 dictoffset = tp->tp_dictoffset;
989 if (dictoffset != 0) {
990 PyObject *dict;
991 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000992 Py_ssize_t tsize;
Guido van Rossumc66ff442002-08-19 16:50:48 +0000993 size_t size;
994
995 tsize = ((PyVarObject *)obj)->ob_size;
996 if (tsize < 0)
997 tsize = -tsize;
998 size = _PyObject_VAR_SIZE(tp, tsize);
999
1000 dictoffset += (long)size;
1001 assert(dictoffset > 0);
1002 assert(dictoffset % SIZEOF_VOID_P == 0);
1003 }
1004 dictptr = (PyObject **) ((char *)obj + dictoffset);
1005 dict = *dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001006 if (dict != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001007 res = PyDict_GetItem(dict, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001008 if (res != NULL) {
1009 Py_INCREF(res);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001010 Py_XDECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001011 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001012 }
1013 }
1014 }
1015
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001016 if (f != NULL) {
Christian Heimes90aa7642007-12-19 02:45:37 +00001017 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001018 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001019 goto done;
1020 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001021
1022 if (descr != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001023 res = descr;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001024 /* descr was already increfed above */
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001025 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001026 }
1027
1028 PyErr_Format(PyExc_AttributeError,
1029 "'%.50s' object has no attribute '%.400s'",
Martin v. Löwis5b222132007-06-10 09:51:05 +00001030 tp->tp_name, PyUnicode_AsString(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001031 done:
1032 Py_DECREF(name);
1033 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001034}
1035
1036int
1037PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1038{
Christian Heimes90aa7642007-12-19 02:45:37 +00001039 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001040 PyObject *descr;
1041 descrsetfunc f;
1042 PyObject **dictptr;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001043 int res = -1;
1044
Martin v. Löwis5b222132007-06-10 09:51:05 +00001045 if (!PyUnicode_Check(name)){
1046 PyErr_Format(PyExc_TypeError,
1047 "attribute name must be string, not '%.200s'",
1048 name->ob_type->tp_name);
1049 return -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001050 }
1051 else
1052 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001053
1054 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001055 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001056 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001057 }
1058
1059 descr = _PyType_Lookup(tp, name);
1060 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001061 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001062 f = descr->ob_type->tp_descr_set;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001063 if (f != NULL && PyDescr_IsData(descr)) {
1064 res = f(descr, obj, value);
1065 goto done;
1066 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001067 }
1068
1069 dictptr = _PyObject_GetDictPtr(obj);
1070 if (dictptr != NULL) {
1071 PyObject *dict = *dictptr;
1072 if (dict == NULL && value != NULL) {
1073 dict = PyDict_New();
1074 if (dict == NULL)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001075 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001076 *dictptr = dict;
1077 }
1078 if (dict != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001079 if (value == NULL)
1080 res = PyDict_DelItem(dict, name);
1081 else
1082 res = PyDict_SetItem(dict, name, value);
1083 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1084 PyErr_SetObject(PyExc_AttributeError, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001085 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001086 }
1087 }
1088
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001089 if (f != NULL) {
1090 res = f(descr, obj, value);
1091 goto done;
1092 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001093
1094 if (descr == NULL) {
1095 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001096 "'%.100s' object has no attribute '%U'",
1097 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001098 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001099 }
1100
1101 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001102 "'%.50s' object attribute '%U' is read-only",
1103 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001104 done:
1105 Py_DECREF(name);
1106 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001107}
1108
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001109/* Test a value used as condition, e.g., in a for or if statement.
1110 Return -1 if an error occurred */
1111
1112int
Fred Drake100814d2000-07-09 15:48:49 +00001113PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001114{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001115 Py_ssize_t res;
Guido van Rossum6248f442002-08-24 06:31:34 +00001116 if (v == Py_True)
1117 return 1;
1118 if (v == Py_False)
1119 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001120 if (v == Py_None)
Neal Norwitz51290d32002-06-13 21:32:44 +00001121 return 0;
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001122 else if (v->ob_type->tp_as_number != NULL &&
Jack Diederich4dafcc42006-11-28 19:15:13 +00001123 v->ob_type->tp_as_number->nb_bool != NULL)
1124 res = (*v->ob_type->tp_as_number->nb_bool)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001125 else if (v->ob_type->tp_as_mapping != NULL &&
1126 v->ob_type->tp_as_mapping->mp_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001127 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001128 else if (v->ob_type->tp_as_sequence != NULL &&
1129 v->ob_type->tp_as_sequence->sq_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001130 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1131 else
Neal Norwitz51290d32002-06-13 21:32:44 +00001132 return 1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001133 /* if it is negative, it should be either -1 or -2 */
1134 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001135}
1136
Tim Peters803526b2002-07-07 05:13:56 +00001137/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001138 Return -1 if an error occurred */
1139
1140int
Fred Drake100814d2000-07-09 15:48:49 +00001141PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001142{
1143 int res;
1144 res = PyObject_IsTrue(v);
1145 if (res < 0)
1146 return res;
1147 return res == 0;
1148}
1149
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001150/* Test whether an object can be called */
1151
1152int
Fred Drake100814d2000-07-09 15:48:49 +00001153PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001154{
1155 if (x == NULL)
1156 return 0;
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001157 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001158}
1159
Georg Brandle32b4222007-03-10 22:13:27 +00001160/* ------------------------- PyObject_Dir() helpers ------------------------- */
1161
Tim Peters7eea37e2001-09-04 22:08:56 +00001162/* Helper for PyObject_Dir.
1163 Merge the __dict__ of aclass into dict, and recursively also all
1164 the __dict__s of aclass's base classes. The order of merging isn't
1165 defined, as it's expected that only the final set of dict keys is
1166 interesting.
1167 Return 0 on success, -1 on error.
1168*/
1169
1170static int
1171merge_class_dict(PyObject* dict, PyObject* aclass)
1172{
1173 PyObject *classdict;
1174 PyObject *bases;
1175
1176 assert(PyDict_Check(dict));
1177 assert(aclass);
1178
1179 /* Merge in the type's dict (if any). */
1180 classdict = PyObject_GetAttrString(aclass, "__dict__");
1181 if (classdict == NULL)
1182 PyErr_Clear();
1183 else {
1184 int status = PyDict_Update(dict, classdict);
1185 Py_DECREF(classdict);
1186 if (status < 0)
1187 return -1;
1188 }
1189
1190 /* Recursively merge in the base types' (if any) dicts. */
1191 bases = PyObject_GetAttrString(aclass, "__bases__");
Tim Petersbc7e8632001-09-16 20:33:22 +00001192 if (bases == NULL)
1193 PyErr_Clear();
1194 else {
Guido van Rossum44022412002-05-13 18:29:46 +00001195 /* We have no guarantee that bases is a real tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001196 Py_ssize_t i, n;
Guido van Rossum44022412002-05-13 18:29:46 +00001197 n = PySequence_Size(bases); /* This better be right */
1198 if (n < 0)
1199 PyErr_Clear();
1200 else {
1201 for (i = 0; i < n; i++) {
Tim Peters18e70832003-02-05 19:35:19 +00001202 int status;
Guido van Rossum44022412002-05-13 18:29:46 +00001203 PyObject *base = PySequence_GetItem(bases, i);
1204 if (base == NULL) {
1205 Py_DECREF(bases);
1206 return -1;
1207 }
Tim Peters18e70832003-02-05 19:35:19 +00001208 status = merge_class_dict(dict, base);
1209 Py_DECREF(base);
1210 if (status < 0) {
Guido van Rossum44022412002-05-13 18:29:46 +00001211 Py_DECREF(bases);
1212 return -1;
1213 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001214 }
1215 }
1216 Py_DECREF(bases);
1217 }
1218 return 0;
1219}
1220
Georg Brandle32b4222007-03-10 22:13:27 +00001221/* Helper for PyObject_Dir without arguments: returns the local scope. */
1222static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001223_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001224{
Georg Brandled3b8382007-03-12 13:15:14 +00001225 PyObject *names;
Georg Brandle32b4222007-03-10 22:13:27 +00001226 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001227
Georg Brandle32b4222007-03-10 22:13:27 +00001228 if (locals == NULL) {
1229 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1230 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001231 }
1232
Georg Brandled3b8382007-03-12 13:15:14 +00001233 names = PyMapping_Keys(locals);
1234 if (!names)
1235 return NULL;
1236 if (!PyList_Check(names)) {
1237 PyErr_Format(PyExc_TypeError,
1238 "dir(): expected keys() of locals to be a list, "
Christian Heimes90aa7642007-12-19 02:45:37 +00001239 "not '%.200s'", Py_TYPE(names)->tp_name);
Georg Brandled3b8382007-03-12 13:15:14 +00001240 Py_DECREF(names);
1241 return NULL;
1242 }
Georg Brandle32b4222007-03-10 22:13:27 +00001243 /* the locals don't need to be DECREF'd */
Georg Brandled3b8382007-03-12 13:15:14 +00001244 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001245}
1246
1247/* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
Guido van Rossum98297ee2007-11-06 21:34:58 +00001248 We deliberately don't suck up its __class__, as methods belonging to the
1249 metaclass would probably be more confusing than helpful.
Georg Brandle32b4222007-03-10 22:13:27 +00001250*/
Guido van Rossum98297ee2007-11-06 21:34:58 +00001251static PyObject *
Georg Brandle32b4222007-03-10 22:13:27 +00001252_specialized_dir_type(PyObject *obj)
1253{
1254 PyObject *result = NULL;
1255 PyObject *dict = PyDict_New();
1256
1257 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1258 result = PyDict_Keys(dict);
1259
1260 Py_XDECREF(dict);
Tim Peters305b5852001-09-17 02:38:46 +00001261 return result;
1262}
1263
Georg Brandle32b4222007-03-10 22:13:27 +00001264/* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1265static PyObject *
1266_specialized_dir_module(PyObject *obj)
Tim Peters7eea37e2001-09-04 22:08:56 +00001267{
Georg Brandle32b4222007-03-10 22:13:27 +00001268 PyObject *result = NULL;
1269 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
Tim Peters7eea37e2001-09-04 22:08:56 +00001270
Georg Brandle32b4222007-03-10 22:13:27 +00001271 if (dict != NULL) {
1272 if (PyDict_Check(dict))
1273 result = PyDict_Keys(dict);
1274 else {
1275 PyErr_Format(PyExc_TypeError,
1276 "%.200s.__dict__ is not a dictionary",
1277 PyModule_GetName(obj));
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001278 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001279 }
1280
Georg Brandle32b4222007-03-10 22:13:27 +00001281 Py_XDECREF(dict);
1282 return result;
1283}
Tim Peters7eea37e2001-09-04 22:08:56 +00001284
Georg Brandle32b4222007-03-10 22:13:27 +00001285/* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1286 and recursively up the __class__.__bases__ chain.
1287*/
1288static PyObject *
1289_generic_dir(PyObject *obj)
1290{
1291 PyObject *result = NULL;
1292 PyObject *dict = NULL;
1293 PyObject *itsclass = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001294
Georg Brandle32b4222007-03-10 22:13:27 +00001295 /* Get __dict__ (which may or may not be a real dict...) */
1296 dict = PyObject_GetAttrString(obj, "__dict__");
1297 if (dict == NULL) {
1298 PyErr_Clear();
1299 dict = PyDict_New();
1300 }
1301 else if (!PyDict_Check(dict)) {
1302 Py_DECREF(dict);
1303 dict = PyDict_New();
1304 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001305 else {
Georg Brandle32b4222007-03-10 22:13:27 +00001306 /* Copy __dict__ to avoid mutating it. */
1307 PyObject *temp = PyDict_Copy(dict);
1308 Py_DECREF(dict);
1309 dict = temp;
Tim Peters7eea37e2001-09-04 22:08:56 +00001310 }
1311
Georg Brandle32b4222007-03-10 22:13:27 +00001312 if (dict == NULL)
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001313 goto error;
Tim Peters7eea37e2001-09-04 22:08:56 +00001314
Georg Brandle32b4222007-03-10 22:13:27 +00001315 /* Merge in attrs reachable from its class. */
1316 itsclass = PyObject_GetAttrString(obj, "__class__");
1317 if (itsclass == NULL)
1318 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1319 __class__ exists? */
1320 PyErr_Clear();
1321 else {
1322 if (merge_class_dict(dict, itsclass) != 0)
1323 goto error;
1324 }
1325
1326 result = PyDict_Keys(dict);
Tim Peters7eea37e2001-09-04 22:08:56 +00001327 /* fall through */
Georg Brandle32b4222007-03-10 22:13:27 +00001328error:
1329 Py_XDECREF(itsclass);
1330 Py_XDECREF(dict);
1331 return result;
1332}
1333
1334/* Helper for PyObject_Dir: object introspection.
1335 This calls one of the above specialized versions if no __dir__ method
1336 exists. */
1337static PyObject *
1338_dir_object(PyObject *obj)
1339{
1340 PyObject * result = NULL;
1341 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1342 "__dir__");
1343
1344 assert(obj);
1345 if (dirfunc == NULL) {
1346 /* use default implementation */
1347 PyErr_Clear();
1348 if (PyModule_Check(obj))
1349 result = _specialized_dir_module(obj);
1350 else if (PyType_Check(obj))
1351 result = _specialized_dir_type(obj);
1352 else
1353 result = _generic_dir(obj);
1354 }
1355 else {
1356 /* use __dir__ */
1357 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1358 Py_DECREF(dirfunc);
1359 if (result == NULL)
1360 return NULL;
1361
1362 /* result must be a list */
1363 /* XXX(gbrandl): could also check if all items are strings */
1364 if (!PyList_Check(result)) {
1365 PyErr_Format(PyExc_TypeError,
1366 "__dir__() must return a list, not %.200s",
Christian Heimes90aa7642007-12-19 02:45:37 +00001367 Py_TYPE(result)->tp_name);
Georg Brandle32b4222007-03-10 22:13:27 +00001368 Py_DECREF(result);
1369 result = NULL;
1370 }
1371 }
1372
1373 return result;
1374}
1375
1376/* Implementation of dir() -- if obj is NULL, returns the names in the current
1377 (local) scope. Otherwise, performs introspection of the object: returns a
1378 sorted list of attribute names (supposedly) accessible from the object
1379*/
1380PyObject *
1381PyObject_Dir(PyObject *obj)
1382{
1383 PyObject * result;
1384
1385 if (obj == NULL)
1386 /* no object -- introspect the locals */
1387 result = _dir_locals();
1388 else
1389 /* object -- introspect the object */
1390 result = _dir_object(obj);
1391
1392 assert(result == NULL || PyList_Check(result));
1393
1394 if (result != NULL && PyList_Sort(result) != 0) {
1395 /* sorting the list failed */
1396 Py_DECREF(result);
1397 result = NULL;
1398 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001399
Tim Peters7eea37e2001-09-04 22:08:56 +00001400 return result;
1401}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001402
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001403/*
1404NoObject is usable as a non-NULL undefined value, used by the macro None.
1405There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001406so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001407(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001408*/
1409
Guido van Rossum0c182a11992-03-27 17:26:13 +00001410/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001411static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001412none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001413{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001414 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001415}
1416
Barry Warsaw9bf16442001-01-23 16:24:35 +00001417/* ARGUSED */
1418static void
Tim Peters803526b2002-07-07 05:13:56 +00001419none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001420{
1421 /* This should never get called, but we also don't want to SEGV if
1422 * we accidently decref None out of existance.
1423 */
Martin v. Löwis3f19b102002-08-07 16:21:51 +00001424 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001425}
1426
1427
Guido van Rossumba21a492001-08-16 08:17:26 +00001428static PyTypeObject PyNone_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001429 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001430 "NoneType",
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001431 0,
1432 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001433 none_dealloc, /*tp_dealloc*/ /*never called*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001434 0, /*tp_print*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001435 0, /*tp_getattr*/
1436 0, /*tp_setattr*/
1437 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001438 none_repr, /*tp_repr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001439 0, /*tp_as_number*/
1440 0, /*tp_as_sequence*/
1441 0, /*tp_as_mapping*/
Guido van Rossum9bfef441993-03-29 10:43:31 +00001442 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001443};
1444
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001445PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001446 _PyObject_EXTRA_INIT
1447 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001448};
1449
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001450/* NotImplemented is an object that can be used to signal that an
1451 operation is not implemented for the given type combination. */
1452
1453static PyObject *
1454NotImplemented_repr(PyObject *op)
1455{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001456 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001457}
1458
1459static PyTypeObject PyNotImplemented_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001460 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001461 "NotImplementedType",
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001462 0,
1463 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001464 none_dealloc, /*tp_dealloc*/ /*never called*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001465 0, /*tp_print*/
1466 0, /*tp_getattr*/
1467 0, /*tp_setattr*/
1468 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001469 NotImplemented_repr, /*tp_repr*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001470 0, /*tp_as_number*/
1471 0, /*tp_as_sequence*/
1472 0, /*tp_as_mapping*/
1473 0, /*tp_hash */
1474};
1475
1476PyObject _Py_NotImplementedStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001477 _PyObject_EXTRA_INIT
1478 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001479};
1480
Guido van Rossumba21a492001-08-16 08:17:26 +00001481void
1482_Py_ReadyTypes(void)
1483{
1484 if (PyType_Ready(&PyType_Type) < 0)
1485 Py_FatalError("Can't initialize 'type'");
1486
Fred Drake0a4dd392004-07-02 18:57:45 +00001487 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1488 Py_FatalError("Can't initialize 'weakref'");
1489
Guido van Rossum77f6a652002-04-03 22:41:51 +00001490 if (PyType_Ready(&PyBool_Type) < 0)
1491 Py_FatalError("Can't initialize 'bool'");
1492
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001493 if (PyType_Ready(&PyBytes_Type) < 0)
1494 Py_FatalError("Can't initialize 'bytes'");
1495
Guido van Rossumcacfc072002-05-24 19:01:59 +00001496 if (PyType_Ready(&PyString_Type) < 0)
1497 Py_FatalError("Can't initialize 'str'");
1498
Guido van Rossumba21a492001-08-16 08:17:26 +00001499 if (PyType_Ready(&PyList_Type) < 0)
1500 Py_FatalError("Can't initialize 'list'");
1501
1502 if (PyType_Ready(&PyNone_Type) < 0)
1503 Py_FatalError("Can't initialize type(None)");
1504
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001505 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1506 Py_FatalError("Can't initialize type(Ellipsis)");
1507
Guido van Rossumba21a492001-08-16 08:17:26 +00001508 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1509 Py_FatalError("Can't initialize type(NotImplemented)");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001510
1511 if (PyType_Ready(&PyCode_Type) < 0)
1512 Py_FatalError("Can't initialize 'code'");
Guido van Rossum826d8972007-10-30 18:34:07 +00001513
1514 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1515 Py_FatalError("Can't initialize StdPrinter");
Guido van Rossumba21a492001-08-16 08:17:26 +00001516}
1517
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001518
Guido van Rossum84a90321996-05-22 16:34:47 +00001519#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001520
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001521void
Fred Drake100814d2000-07-09 15:48:49 +00001522_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001523{
Tim Peters34592512002-07-11 06:23:50 +00001524 _Py_INC_REFTOTAL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001525 op->ob_refcnt = 1;
Tim Peters7571a0f2003-03-23 17:52:28 +00001526 _Py_AddToAllObjects(op, 1);
Tim Peters34592512002-07-11 06:23:50 +00001527 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001528}
1529
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001530void
Fred Drake100814d2000-07-09 15:48:49 +00001531_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001532{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001533#ifdef SLOW_UNREF_CHECK
Guido van Rossum4c08d552000-03-10 22:55:18 +00001534 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001535#endif
Guido van Rossumd7047b31995-01-02 19:07:15 +00001536 if (op->ob_refcnt < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001537 Py_FatalError("UNREF negative refcnt");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001538 if (op == &refchain ||
Christian Heimesc8967002007-11-30 10:18:26 +00001539 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1540 fprintf(stderr, "* ob\n");
1541 _PyObject_Dump(op);
1542 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1543 _PyObject_Dump(op->_ob_prev->_ob_next);
1544 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1545 _PyObject_Dump(op->_ob_next->_ob_prev);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001546 Py_FatalError("UNREF invalid object");
Christian Heimesc8967002007-11-30 10:18:26 +00001547 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001548#ifdef SLOW_UNREF_CHECK
Guido van Rossum3f5da241990-12-20 15:06:42 +00001549 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1550 if (p == op)
1551 break;
1552 }
Guido van Rossumd7047b31995-01-02 19:07:15 +00001553 if (p == &refchain) /* Not found */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001554 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001555#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001556 op->_ob_next->_ob_prev = op->_ob_prev;
1557 op->_ob_prev->_ob_next = op->_ob_next;
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001558 op->_ob_next = op->_ob_prev = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001559 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001560}
1561
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001562void
Fred Drake100814d2000-07-09 15:48:49 +00001563_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001564{
Christian Heimes90aa7642007-12-19 02:45:37 +00001565 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001566 _Py_ForgetReference(op);
Guido van Rossum9776adf1994-09-07 14:36:45 +00001567 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001568}
1569
Tim Peters269b2a62003-04-17 19:52:29 +00001570/* Print all live objects. Because PyObject_Print is called, the
1571 * interpreter must be in a healthy state.
1572 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001573void
Fred Drake100814d2000-07-09 15:48:49 +00001574_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001575{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001576 PyObject *op;
Guido van Rossume09fb551997-08-05 02:04:34 +00001577 fprintf(fp, "Remaining objects:\n");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001578 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001579 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001580 if (PyObject_Print(op, fp, 0) != 0)
1581 PyErr_Clear();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001582 putc('\n', fp);
1583 }
1584}
1585
Tim Peters269b2a62003-04-17 19:52:29 +00001586/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1587 * doesn't make any calls to the Python C API, so is always safe to call.
1588 */
1589void
1590_Py_PrintReferenceAddresses(FILE *fp)
1591{
1592 PyObject *op;
1593 fprintf(fp, "Remaining object addresses:\n");
1594 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001595 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
Christian Heimes90aa7642007-12-19 02:45:37 +00001596 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001597}
1598
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001599PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001600_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001601{
1602 int i, n;
1603 PyObject *t = NULL;
1604 PyObject *res, *op;
1605
1606 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1607 return NULL;
1608 op = refchain._ob_next;
1609 res = PyList_New(0);
1610 if (res == NULL)
1611 return NULL;
1612 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1613 while (op == self || op == args || op == res || op == t ||
Christian Heimes90aa7642007-12-19 02:45:37 +00001614 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001615 op = op->_ob_next;
1616 if (op == &refchain)
1617 return res;
1618 }
1619 if (PyList_Append(res, op) < 0) {
1620 Py_DECREF(res);
1621 return NULL;
1622 }
1623 op = op->_ob_next;
1624 }
1625 return res;
1626}
1627
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001628#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001629
1630
1631/* Hack to force loading of cobject.o */
Guido van Rossumda9c2711996-12-05 21:58:58 +00001632PyTypeObject *_Py_cobject_hack = &PyCObject_Type;
Guido van Rossum84a90321996-05-22 16:34:47 +00001633
1634
1635/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001636Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001637
1638
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001639/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001640
Thomas Wouters334fb892000-07-25 12:56:38 +00001641void *
Fred Drake100814d2000-07-09 15:48:49 +00001642PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001643{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001644 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001645}
1646
Thomas Wouters334fb892000-07-25 12:56:38 +00001647void *
1648PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001649{
Tim Petersaf3e8de2002-04-12 07:22:56 +00001650 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001651}
1652
1653void
Thomas Wouters334fb892000-07-25 12:56:38 +00001654PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001655{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001656 PyMem_FREE(p);
1657}
1658
1659
Guido van Rossum86610361998-04-10 22:32:46 +00001660/* These methods are used to control infinite recursion in repr, str, print,
1661 etc. Container objects that may recursively contain themselves,
1662 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1663 Py_ReprLeave() to avoid infinite recursion.
1664
1665 Py_ReprEnter() returns 0 the first time it is called for a particular
1666 object and 1 every time thereafter. It returns -1 if an exception
1667 occurred. Py_ReprLeave() has no return value.
1668
1669 See dictobject.c and listobject.c for examples of use.
1670*/
1671
1672#define KEY "Py_Repr"
1673
1674int
Fred Drake100814d2000-07-09 15:48:49 +00001675Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001676{
1677 PyObject *dict;
1678 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001679 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001680
1681 dict = PyThreadState_GetDict();
1682 if (dict == NULL)
Guido van Rossum0fc8f002003-04-15 15:12:39 +00001683 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001684 list = PyDict_GetItemString(dict, KEY);
1685 if (list == NULL) {
1686 list = PyList_New(0);
1687 if (list == NULL)
1688 return -1;
1689 if (PyDict_SetItemString(dict, KEY, list) < 0)
1690 return -1;
1691 Py_DECREF(list);
1692 }
1693 i = PyList_GET_SIZE(list);
1694 while (--i >= 0) {
1695 if (PyList_GET_ITEM(list, i) == obj)
1696 return 1;
1697 }
1698 PyList_Append(list, obj);
1699 return 0;
1700}
1701
1702void
Fred Drake100814d2000-07-09 15:48:49 +00001703Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001704{
1705 PyObject *dict;
1706 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001707 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001708
1709 dict = PyThreadState_GetDict();
Guido van Rossumeb909461998-04-11 15:17:34 +00001710 if (dict == NULL)
1711 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001712 list = PyDict_GetItemString(dict, KEY);
Guido van Rossumeb909461998-04-11 15:17:34 +00001713 if (list == NULL || !PyList_Check(list))
1714 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001715 i = PyList_GET_SIZE(list);
1716 /* Count backwards because we always expect obj to be list[-1] */
1717 while (--i >= 0) {
1718 if (PyList_GET_ITEM(list, i) == obj) {
1719 PyList_SetSlice(list, i, i + 1, NULL);
1720 break;
1721 }
1722 }
1723}
Guido van Rossumd724b232000-03-13 16:01:29 +00001724
Tim Peters803526b2002-07-07 05:13:56 +00001725/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001726
Tim Peters803526b2002-07-07 05:13:56 +00001727/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001728int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001729
Tim Peters803526b2002-07-07 05:13:56 +00001730/* List of objects that still need to be cleaned up, singly linked via their
1731 * gc headers' gc_prev pointers.
1732 */
1733PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001734
Tim Peters803526b2002-07-07 05:13:56 +00001735/* Add op to the _PyTrash_delete_later list. Called when the current
1736 * call-stack depth gets large. op must be a currently untracked gc'ed
1737 * object, with refcount 0. Py_DECREF must already have been called on it.
1738 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001739void
Fred Drake100814d2000-07-09 15:48:49 +00001740_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001741{
Tim Peters803526b2002-07-07 05:13:56 +00001742 assert(PyObject_IS_GC(op));
1743 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1744 assert(op->ob_refcnt == 0);
Neil Schemenauerf589c052002-03-29 03:05:54 +00001745 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
Guido van Rossume92e6102000-04-24 15:40:53 +00001746 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001747}
1748
Tim Peters803526b2002-07-07 05:13:56 +00001749/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1750 * the call-stack unwinds again.
1751 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001752void
Fred Drake100814d2000-07-09 15:48:49 +00001753_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001754{
1755 while (_PyTrash_delete_later) {
Tim Peters803526b2002-07-07 05:13:56 +00001756 PyObject *op = _PyTrash_delete_later;
Christian Heimes90aa7642007-12-19 02:45:37 +00001757 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001758
Neil Schemenauerf589c052002-03-29 03:05:54 +00001759 _PyTrash_delete_later =
Tim Peters803526b2002-07-07 05:13:56 +00001760 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001761
Tim Peters803526b2002-07-07 05:13:56 +00001762 /* Call the deallocator directly. This used to try to
1763 * fool Py_DECREF into calling it indirectly, but
1764 * Py_DECREF was already called on this object, and in
1765 * assorted non-release builds calling Py_DECREF again ends
1766 * up distorting allocation statistics.
1767 */
1768 assert(op->ob_refcnt == 0);
Guido van Rossumd724b232000-03-13 16:01:29 +00001769 ++_PyTrash_delete_nesting;
Tim Peters803526b2002-07-07 05:13:56 +00001770 (*dealloc)(op);
Guido van Rossumd724b232000-03-13 16:01:29 +00001771 --_PyTrash_delete_nesting;
1772 }
1773}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001774
1775#ifdef __cplusplus
1776}
1777#endif