blob: 15d26a79883d1c89bfbb3cbce6cf9cf8f80f7d88 [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
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000503/* The new comparison philosophy is: we completely separate three-way
504 comparison from rich comparison. That is, PyObject_Compare() and
505 PyObject_Cmp() *just* use the tp_compare slot. And PyObject_RichCompare()
506 and PyObject_RichCompareBool() *just* use the tp_richcompare slot.
Guido van Rossum98297ee2007-11-06 21:34:58 +0000507
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000508 See (*) below for practical amendments.
509
510 IOW, only cmp() uses tp_compare; the comparison operators (==, !=, <=, <,
511 >=, >) only use tp_richcompare. Note that list.sort() only uses <.
512
513 (And yes, eventually we'll rip out cmp() and tp_compare.)
514
515 The calling conventions are different: tp_compare only gets called with two
516 objects of the appropriate type; tp_richcompare gets called with a first
517 argument of the appropriate type and a second object of an arbitrary type.
518 We never do any kind of coercion.
519
520 The return conventions are also different.
521
522 The tp_compare slot should return a C int, as follows:
523
524 -1 if a < b or if an exception occurred
525 0 if a == b
526 +1 if a > b
527
528 No other return values are allowed. PyObject_Compare() has the same
529 calling convention.
530
531 The tp_richcompare slot should return an object, as follows:
532
533 NULL if an exception occurred
534 NotImplemented if the requested comparison is not implemented
535 any other false value if the requested comparison is false
536 any other true value if the requested comparison is true
537
538 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
539 NotImplemented.
540
541 (*) Practical amendments:
542
543 - If rich comparison returns NotImplemented, == and != are decided by
544 comparing the object pointer (i.e. falling back to the base object
545 implementation).
546
547 - If three-way comparison is not implemented, it falls back on rich
548 comparison (but not the other way around!).
549
Guido van Rossuma4073002002-05-31 20:03:54 +0000550*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000551
552/* Forward */
553static PyObject *do_richcompare(PyObject *v, PyObject *w, int op);
554
555/* Perform a three-way comparison, raising TypeError if three-way comparison
556 is not supported. */
Guido van Rossuma4073002002-05-31 20:03:54 +0000557static int
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000558do_compare(PyObject *v, PyObject *w)
Guido van Rossuma4073002002-05-31 20:03:54 +0000559{
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000560 cmpfunc f;
561 int ok;
562
Guido van Rossum98297ee2007-11-06 21:34:58 +0000563 if (v->ob_type == w->ob_type &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000564 (f = v->ob_type->tp_compare) != NULL) {
565 return (*f)(v, w);
Guido van Rossuma4073002002-05-31 20:03:54 +0000566 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000567
568 /* Now try three-way compare before giving up. This is intentionally
569 elaborate; if you have a it will raise TypeError if it detects two
570 objects that aren't ordered with respect to each other. */
571 ok = PyObject_RichCompareBool(v, w, Py_LT);
572 if (ok < 0)
573 return -1; /* Error */
574 if (ok)
575 return -1; /* Less than */
576 ok = PyObject_RichCompareBool(v, w, Py_GT);
577 if (ok < 0)
578 return -1; /* Error */
579 if (ok)
580 return 1; /* Greater than */
581 ok = PyObject_RichCompareBool(v, w, Py_EQ);
582 if (ok < 0)
583 return -1; /* Error */
584 if (ok)
585 return 0; /* Equal */
586
587 /* Give up */
588 PyErr_Format(PyExc_TypeError,
Neal Norwitz3bd844e2006-08-29 04:39:12 +0000589 "unorderable types: '%.100s' != '%.100s'",
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000590 v->ob_type->tp_name,
591 w->ob_type->tp_name);
592 return -1;
Guido van Rossuma4073002002-05-31 20:03:54 +0000593}
594
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000595/* Perform a three-way comparison. This wraps do_compare() with a check for
596 NULL arguments and a recursion check. */
597int
598PyObject_Compare(PyObject *v, PyObject *w)
599{
600 int res;
Guido van Rossuma4073002002-05-31 20:03:54 +0000601
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000602 if (v == NULL || w == NULL) {
603 if (!PyErr_Occurred())
604 PyErr_BadInternalCall();
605 return -1;
606 }
607 if (Py_EnterRecursiveCall(" in cmp"))
608 return -1;
609 res = do_compare(v, w);
610 Py_LeaveRecursiveCall();
611 return res < 0 ? -1 : res;
612}
Guido van Rossumd1f06b92001-01-24 22:14:43 +0000613
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000614/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000615int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000616
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000617static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000618
619/* Perform a rich comparison, raising TypeError when the requested comparison
620 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000621static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000622do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000623{
624 richcmpfunc f;
625 PyObject *res;
626
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000627 if (v->ob_type != w->ob_type &&
628 PyType_IsSubtype(w->ob_type, v->ob_type) &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000629 (f = w->ob_type->tp_richcompare) != NULL) {
Tim Petersf4aca752004-09-23 02:39:37 +0000630 res = (*f)(w, v, _Py_SwappedOp[op]);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000631 if (res != Py_NotImplemented)
632 return res;
633 Py_DECREF(res);
634 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000635 if ((f = v->ob_type->tp_richcompare) != NULL) {
Guido van Rossume797ec12001-01-17 15:24:28 +0000636 res = (*f)(v, w, op);
637 if (res != Py_NotImplemented)
638 return res;
639 Py_DECREF(res);
640 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000641 if ((f = w->ob_type->tp_richcompare) != NULL) {
642 res = (*f)(w, v, _Py_SwappedOp[op]);
643 if (res != Py_NotImplemented)
644 return res;
645 Py_DECREF(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000646 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000647 /* If neither object implements it, provide a sensible default
648 for == and !=, but raise an exception for ordering. */
649 switch (op) {
650 case Py_EQ:
651 res = (v == w) ? Py_True : Py_False;
652 break;
653 case Py_NE:
654 res = (v != w) ? Py_True : Py_False;
655 break;
656 default:
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000657 /* XXX Special-case None so it doesn't show as NoneType() */
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000658 PyErr_Format(PyExc_TypeError,
659 "unorderable types: %.100s() %s %.100s()",
660 v->ob_type->tp_name,
661 opstrings[op],
662 w->ob_type->tp_name);
663 return NULL;
664 }
Guido van Rossume797ec12001-01-17 15:24:28 +0000665 Py_INCREF(res);
666 return res;
667}
668
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000669/* Perform a rich comparison with object result. This wraps do_richcompare()
670 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000671
Guido van Rossume797ec12001-01-17 15:24:28 +0000672PyObject *
673PyObject_RichCompare(PyObject *v, PyObject *w, int op)
674{
675 PyObject *res;
676
677 assert(Py_LT <= op && op <= Py_GE);
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000678 if (v == NULL || w == NULL) {
679 if (!PyErr_Occurred())
680 PyErr_BadInternalCall();
681 return NULL;
682 }
Armin Rigo2b3eb402003-10-28 12:05:48 +0000683 if (Py_EnterRecursiveCall(" in cmp"))
684 return NULL;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000685 res = do_richcompare(v, w, op);
Armin Rigo2b3eb402003-10-28 12:05:48 +0000686 Py_LeaveRecursiveCall();
Guido van Rossume797ec12001-01-17 15:24:28 +0000687 return res;
688}
689
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000690/* Perform a rich comparison with integer result. This wraps
691 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000692int
693PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
694{
Raymond Hettinger93d44812004-03-21 17:01:44 +0000695 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000696 int ok;
697
Mark Dickinson4a1f5932008-11-12 23:23:36 +0000698 /* Quick result when objects are the same.
699 Guarantees that identity implies equality. */
700 if (v == w) {
701 if (op == Py_EQ)
702 return 1;
703 else if (op == Py_NE)
704 return 0;
705 }
706
Raymond Hettinger93d44812004-03-21 17:01:44 +0000707 res = PyObject_RichCompare(v, w, op);
Guido van Rossume797ec12001-01-17 15:24:28 +0000708 if (res == NULL)
709 return -1;
Guido van Rossum81912d42002-08-24 05:33:28 +0000710 if (PyBool_Check(res))
711 ok = (res == Py_True);
712 else
713 ok = PyObject_IsTrue(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000714 Py_DECREF(res);
715 return ok;
716}
Fred Drake13634cf2000-06-29 19:17:04 +0000717
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000718/* Turn the result of a three-way comparison into the result expected by a
719 rich comparison. */
720PyObject *
721Py_CmpToRich(int op, int cmp)
722{
723 PyObject *res;
724 int ok;
725
726 if (PyErr_Occurred())
727 return NULL;
728 switch (op) {
729 case Py_LT:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000730 ok = cmp < 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000731 break;
732 case Py_LE:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000733 ok = cmp <= 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000734 break;
735 case Py_EQ:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000736 ok = cmp == 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000737 break;
738 case Py_NE:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000739 ok = cmp != 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000740 break;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000741 case Py_GT:
742 ok = cmp > 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000743 break;
744 case Py_GE:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000745 ok = cmp >= 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000746 break;
747 default:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000748 PyErr_BadArgument();
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000749 return NULL;
750 }
751 res = ok ? Py_True : Py_False;
752 Py_INCREF(res);
753 return res;
754}
755
Fred Drake13634cf2000-06-29 19:17:04 +0000756/* Set of hash utility functions to help maintaining the invariant that
Raymond Hettinger8183fa42004-03-21 17:35:06 +0000757 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000758
759 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
760*/
761
762long
Fred Drake100814d2000-07-09 15:48:49 +0000763_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000764{
Tim Peters39dce292000-08-15 03:34:48 +0000765 double intpart, fractpart;
766 int expo;
767 long hipart;
768 long x; /* the final hash value */
769 /* This is designed so that Python numbers of different types
770 * that compare equal hash to the same value; otherwise comparisons
771 * of mapping keys will turn out weird.
772 */
773
Tim Peters39dce292000-08-15 03:34:48 +0000774 fractpart = modf(v, &intpart);
Tim Peters39dce292000-08-15 03:34:48 +0000775 if (fractpart == 0.0) {
776 /* This must return the same hash as an equal int or long. */
777 if (intpart > LONG_MAX || -intpart > LONG_MAX) {
778 /* Convert to long and use its hash. */
779 PyObject *plong; /* converted to Python long */
780 if (Py_IS_INFINITY(intpart))
781 /* can't convert to long int -- arbitrary */
782 v = v < 0 ? -271828.0 : 314159.0;
783 plong = PyLong_FromDouble(v);
784 if (plong == NULL)
785 return -1;
786 x = PyObject_Hash(plong);
787 Py_DECREF(plong);
788 return x;
789 }
790 /* Fits in a C long == a Python int, so is its own hash. */
791 x = (long)intpart;
792 if (x == -1)
793 x = -2;
794 return x;
795 }
796 /* The fractional part is non-zero, so we don't have to worry about
797 * making this match the hash of some other type.
798 * Use frexp to get at the bits in the double.
Fred Drake13634cf2000-06-29 19:17:04 +0000799 * Since the VAX D double format has 56 mantissa bits, which is the
800 * most of any double format in use, each of these parts may have as
801 * many as (but no more than) 56 significant bits.
Tim Peters39dce292000-08-15 03:34:48 +0000802 * So, assuming sizeof(long) >= 4, each part can be broken into two
803 * longs; frexp and multiplication are used to do that.
804 * Also, since the Cray double format has 15 exponent bits, which is
805 * the most of any double format in use, shifting the exponent field
806 * left by 15 won't overflow a long (again assuming sizeof(long) >= 4).
Fred Drake13634cf2000-06-29 19:17:04 +0000807 */
Tim Peters39dce292000-08-15 03:34:48 +0000808 v = frexp(v, &expo);
809 v *= 2147483648.0; /* 2**31 */
810 hipart = (long)v; /* take the top 32 bits */
811 v = (v - (double)hipart) * 2147483648.0; /* get the next 32 bits */
812 x = hipart + (long)v + (expo << 15);
813 if (x == -1)
814 x = -2;
815 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000816}
817
818long
Fred Drake100814d2000-07-09 15:48:49 +0000819_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000820{
821#if SIZEOF_LONG >= SIZEOF_VOID_P
822 return (long)p;
823#else
824 /* convert to a Python long and hash that */
825 PyObject* longobj;
826 long x;
Tim Peters803526b2002-07-07 05:13:56 +0000827
Fred Drake13634cf2000-06-29 19:17:04 +0000828 if ((longobj = PyLong_FromVoidPtr(p)) == NULL) {
829 x = -1;
830 goto finally;
831 }
832 x = PyObject_Hash(longobj);
Tim Peters803526b2002-07-07 05:13:56 +0000833
Fred Drake13634cf2000-06-29 19:17:04 +0000834finally:
835 Py_XDECREF(longobj);
836 return x;
837#endif
838}
839
Nick Coghland1abd252008-07-15 15:46:38 +0000840long
841PyObject_HashNotImplemented(PyObject *v)
842{
843 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
844 Py_TYPE(v)->tp_name);
845 return -1;
846}
Fred Drake13634cf2000-06-29 19:17:04 +0000847
Guido van Rossum9bfef441993-03-29 10:43:31 +0000848long
Fred Drake100814d2000-07-09 15:48:49 +0000849PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000850{
Nick Coghland1abd252008-07-15 15:46:38 +0000851 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000852 if (tp->tp_hash != NULL)
853 return (*tp->tp_hash)(v);
Nick Coghlanf1f2f682008-12-30 07:29:12 +0000854 /* To keep to the general practice that inheriting
855 * solely from object in C code should work without
856 * an explicit call to PyType_Ready, we implicitly call
857 * PyType_Ready here and then check the tp_hash slot again
858 */
859 if (tp->tp_dict == NULL) {
860 if (PyType_Ready(tp) < 0)
861 return -1;
862 if (tp->tp_hash != NULL)
863 return (*tp->tp_hash)(v);
864 }
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000865 /* Otherwise, the object can't be hashed */
Nick Coghland1abd252008-07-15 15:46:38 +0000866 return PyObject_HashNotImplemented(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000867}
868
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000869PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000870PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000871{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000872 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000873
Christian Heimes90aa7642007-12-19 02:45:37 +0000874 if (Py_TYPE(v)->tp_getattr != NULL)
875 return (*Py_TYPE(v)->tp_getattr)(v, (char*)name);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000876 w = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000877 if (w == NULL)
878 return NULL;
879 res = PyObject_GetAttr(v, w);
880 Py_XDECREF(w);
881 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000882}
883
884int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000885PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000886{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000887 PyObject *res = PyObject_GetAttrString(v, name);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000888 if (res != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000889 Py_DECREF(res);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000890 return 1;
891 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000892 PyErr_Clear();
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000893 return 0;
894}
895
896int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000897PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000898{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000899 PyObject *s;
900 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000901
Christian Heimes90aa7642007-12-19 02:45:37 +0000902 if (Py_TYPE(v)->tp_setattr != NULL)
903 return (*Py_TYPE(v)->tp_setattr)(v, (char*)name, w);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000904 s = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000905 if (s == NULL)
906 return -1;
907 res = PyObject_SetAttr(v, s, w);
908 Py_XDECREF(s);
909 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000910}
911
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000912PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000913PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000914{
Christian Heimes90aa7642007-12-19 02:45:37 +0000915 PyTypeObject *tp = Py_TYPE(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000916
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000917 if (!PyUnicode_Check(name)) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000918 PyErr_Format(PyExc_TypeError,
919 "attribute name must be string, not '%.200s'",
920 name->ob_type->tp_name);
921 return NULL;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000922 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000923 if (tp->tp_getattro != NULL)
924 return (*tp->tp_getattro)(v, name);
925 if (tp->tp_getattr != NULL)
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000926 return (*tp->tp_getattr)(v, _PyUnicode_AsString(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +0000927 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000928 "'%.50s' object has no attribute '%U'",
929 tp->tp_name, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000930 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000931}
932
933int
Fred Drake100814d2000-07-09 15:48:49 +0000934PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000935{
936 PyObject *res = PyObject_GetAttr(v, name);
937 if (res != NULL) {
938 Py_DECREF(res);
939 return 1;
940 }
941 PyErr_Clear();
942 return 0;
943}
944
945int
Fred Drake100814d2000-07-09 15:48:49 +0000946PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000947{
Christian Heimes90aa7642007-12-19 02:45:37 +0000948 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000949 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000950
Martin v. Löwis5b222132007-06-10 09:51:05 +0000951 if (!PyUnicode_Check(name)) {
952 PyErr_Format(PyExc_TypeError,
953 "attribute name must be string, not '%.200s'",
954 name->ob_type->tp_name);
955 return -1;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000956 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000957 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000958
Martin v. Löwis5b222132007-06-10 09:51:05 +0000959 PyUnicode_InternInPlace(&name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000960 if (tp->tp_setattro != NULL) {
961 err = (*tp->tp_setattro)(v, name, value);
962 Py_DECREF(name);
963 return err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000964 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000965 if (tp->tp_setattr != NULL) {
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000966 err = (*tp->tp_setattr)(v, _PyUnicode_AsString(name), value);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000967 Py_DECREF(name);
968 return err;
969 }
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000970 Py_DECREF(name);
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000971 assert(name->ob_refcnt >= 1);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000972 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
973 PyErr_Format(PyExc_TypeError,
974 "'%.100s' object has no attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000975 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000976 tp->tp_name,
977 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000978 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000979 else
980 PyErr_Format(PyExc_TypeError,
981 "'%.100s' object has only read-only attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000982 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000983 tp->tp_name,
984 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000985 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000986 return -1;
987}
988
989/* Helper to get a pointer to an object's __dict__ slot, if any */
990
991PyObject **
992_PyObject_GetDictPtr(PyObject *obj)
993{
Martin v. Löwis725507b2006-03-07 12:08:51 +0000994 Py_ssize_t dictoffset;
Christian Heimes90aa7642007-12-19 02:45:37 +0000995 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000996
Tim Peters6d6c1a32001-08-02 04:15:00 +0000997 dictoffset = tp->tp_dictoffset;
998 if (dictoffset == 0)
999 return NULL;
1000 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001001 Py_ssize_t tsize;
Guido van Rossum2eb0b872002-03-01 22:24:49 +00001002 size_t size;
1003
1004 tsize = ((PyVarObject *)obj)->ob_size;
1005 if (tsize < 0)
1006 tsize = -tsize;
1007 size = _PyObject_VAR_SIZE(tp, tsize);
1008
Tim Peters6d483d32001-10-06 21:27:34 +00001009 dictoffset += (long)size;
1010 assert(dictoffset > 0);
1011 assert(dictoffset % SIZEOF_VOID_P == 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001012 }
1013 return (PyObject **) ((char *)obj + dictoffset);
1014}
1015
Tim Peters6d6c1a32001-08-02 04:15:00 +00001016PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +00001017PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +00001018{
1019 Py_INCREF(obj);
1020 return obj;
1021}
1022
Michael W. Hudson1593f502004-09-14 17:09:47 +00001023/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
1024
Raymond Hettinger01538262003-03-17 08:24:35 +00001025PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001026PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
1027{
Christian Heimes90aa7642007-12-19 02:45:37 +00001028 PyTypeObject *tp = Py_TYPE(obj);
Guido van Rossum056fbf42002-08-19 19:22:50 +00001029 PyObject *descr = NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001030 PyObject *res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001031 descrgetfunc f;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001032 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001033 PyObject **dictptr;
1034
Martin v. Löwis5b222132007-06-10 09:51:05 +00001035 if (!PyUnicode_Check(name)){
1036 PyErr_Format(PyExc_TypeError,
1037 "attribute name must be string, not '%.200s'",
1038 name->ob_type->tp_name);
1039 return NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001040 }
1041 else
1042 Py_INCREF(name);
1043
Tim Peters6d6c1a32001-08-02 04:15:00 +00001044 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001045 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001046 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001047 }
1048
Christian Heimesa62da1d2008-01-12 19:39:10 +00001049#if 0 /* XXX this is not quite _PyType_Lookup anymore */
Guido van Rossum056fbf42002-08-19 19:22:50 +00001050 /* Inline _PyType_Lookup */
1051 {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001052 Py_ssize_t i, n;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001053 PyObject *mro, *base, *dict;
1054
1055 /* Look in tp_dict of types in MRO */
1056 mro = tp->tp_mro;
1057 assert(mro != NULL);
1058 assert(PyTuple_Check(mro));
1059 n = PyTuple_GET_SIZE(mro);
1060 for (i = 0; i < n; i++) {
1061 base = PyTuple_GET_ITEM(mro, i);
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001062 assert(PyType_Check(base));
1063 dict = ((PyTypeObject *)base)->tp_dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001064 assert(dict && PyDict_Check(dict));
1065 descr = PyDict_GetItem(dict, name);
1066 if (descr != NULL)
1067 break;
1068 }
1069 }
Christian Heimesa62da1d2008-01-12 19:39:10 +00001070#else
1071 descr = _PyType_Lookup(tp, name);
1072#endif
Guido van Rossum056fbf42002-08-19 19:22:50 +00001073
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001074 Py_XINCREF(descr);
1075
Tim Peters6d6c1a32001-08-02 04:15:00 +00001076 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001077 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001078 f = descr->ob_type->tp_descr_get;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001079 if (f != NULL && PyDescr_IsData(descr)) {
1080 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001081 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001082 goto done;
1083 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001084 }
1085
Guido van Rossumc66ff442002-08-19 16:50:48 +00001086 /* Inline _PyObject_GetDictPtr */
1087 dictoffset = tp->tp_dictoffset;
1088 if (dictoffset != 0) {
1089 PyObject *dict;
1090 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001091 Py_ssize_t tsize;
Guido van Rossumc66ff442002-08-19 16:50:48 +00001092 size_t size;
1093
1094 tsize = ((PyVarObject *)obj)->ob_size;
1095 if (tsize < 0)
1096 tsize = -tsize;
1097 size = _PyObject_VAR_SIZE(tp, tsize);
1098
1099 dictoffset += (long)size;
1100 assert(dictoffset > 0);
1101 assert(dictoffset % SIZEOF_VOID_P == 0);
1102 }
1103 dictptr = (PyObject **) ((char *)obj + dictoffset);
1104 dict = *dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001105 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +00001106 Py_INCREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001107 res = PyDict_GetItem(dict, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001108 if (res != NULL) {
1109 Py_INCREF(res);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001110 Py_XDECREF(descr);
Christian Heimes969fe572008-01-25 11:23:10 +00001111 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001112 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001113 }
Christian Heimes969fe572008-01-25 11:23:10 +00001114 Py_DECREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001115 }
1116 }
1117
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001118 if (f != NULL) {
Christian Heimes90aa7642007-12-19 02:45:37 +00001119 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001120 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001121 goto done;
1122 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001123
1124 if (descr != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001125 res = descr;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001126 /* descr was already increfed above */
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001127 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001128 }
1129
1130 PyErr_Format(PyExc_AttributeError,
1131 "'%.50s' object has no attribute '%.400s'",
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +00001132 tp->tp_name, _PyUnicode_AsString(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001133 done:
1134 Py_DECREF(name);
1135 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001136}
1137
1138int
1139PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1140{
Christian Heimes90aa7642007-12-19 02:45:37 +00001141 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001142 PyObject *descr;
1143 descrsetfunc f;
1144 PyObject **dictptr;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001145 int res = -1;
1146
Martin v. Löwis5b222132007-06-10 09:51:05 +00001147 if (!PyUnicode_Check(name)){
1148 PyErr_Format(PyExc_TypeError,
1149 "attribute name must be string, not '%.200s'",
1150 name->ob_type->tp_name);
1151 return -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001152 }
1153 else
1154 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001155
1156 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001157 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001158 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001159 }
1160
1161 descr = _PyType_Lookup(tp, name);
1162 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001163 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001164 f = descr->ob_type->tp_descr_set;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001165 if (f != NULL && PyDescr_IsData(descr)) {
1166 res = f(descr, obj, value);
1167 goto done;
1168 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001169 }
1170
1171 dictptr = _PyObject_GetDictPtr(obj);
1172 if (dictptr != NULL) {
1173 PyObject *dict = *dictptr;
1174 if (dict == NULL && value != NULL) {
1175 dict = PyDict_New();
1176 if (dict == NULL)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001177 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001178 *dictptr = dict;
1179 }
1180 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +00001181 Py_INCREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001182 if (value == NULL)
1183 res = PyDict_DelItem(dict, name);
1184 else
1185 res = PyDict_SetItem(dict, name, value);
1186 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1187 PyErr_SetObject(PyExc_AttributeError, name);
Christian Heimes969fe572008-01-25 11:23:10 +00001188 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001189 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001190 }
1191 }
1192
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001193 if (f != NULL) {
1194 res = f(descr, obj, value);
1195 goto done;
1196 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001197
1198 if (descr == NULL) {
1199 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001200 "'%.100s' object has no attribute '%U'",
1201 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001202 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001203 }
1204
1205 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001206 "'%.50s' object attribute '%U' is read-only",
1207 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001208 done:
1209 Py_DECREF(name);
1210 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001211}
1212
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001213/* Test a value used as condition, e.g., in a for or if statement.
1214 Return -1 if an error occurred */
1215
1216int
Fred Drake100814d2000-07-09 15:48:49 +00001217PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001218{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001219 Py_ssize_t res;
Guido van Rossum6248f442002-08-24 06:31:34 +00001220 if (v == Py_True)
1221 return 1;
1222 if (v == Py_False)
1223 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001224 if (v == Py_None)
Neal Norwitz51290d32002-06-13 21:32:44 +00001225 return 0;
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001226 else if (v->ob_type->tp_as_number != NULL &&
Jack Diederich4dafcc42006-11-28 19:15:13 +00001227 v->ob_type->tp_as_number->nb_bool != NULL)
1228 res = (*v->ob_type->tp_as_number->nb_bool)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001229 else if (v->ob_type->tp_as_mapping != NULL &&
1230 v->ob_type->tp_as_mapping->mp_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001231 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001232 else if (v->ob_type->tp_as_sequence != NULL &&
1233 v->ob_type->tp_as_sequence->sq_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001234 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1235 else
Neal Norwitz51290d32002-06-13 21:32:44 +00001236 return 1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001237 /* if it is negative, it should be either -1 or -2 */
1238 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001239}
1240
Tim Peters803526b2002-07-07 05:13:56 +00001241/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001242 Return -1 if an error occurred */
1243
1244int
Fred Drake100814d2000-07-09 15:48:49 +00001245PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001246{
1247 int res;
1248 res = PyObject_IsTrue(v);
1249 if (res < 0)
1250 return res;
1251 return res == 0;
1252}
1253
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001254/* Test whether an object can be called */
1255
1256int
Fred Drake100814d2000-07-09 15:48:49 +00001257PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001258{
1259 if (x == NULL)
1260 return 0;
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001261 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001262}
1263
Georg Brandle32b4222007-03-10 22:13:27 +00001264/* ------------------------- PyObject_Dir() helpers ------------------------- */
1265
Tim Peters7eea37e2001-09-04 22:08:56 +00001266/* Helper for PyObject_Dir.
1267 Merge the __dict__ of aclass into dict, and recursively also all
1268 the __dict__s of aclass's base classes. The order of merging isn't
1269 defined, as it's expected that only the final set of dict keys is
1270 interesting.
1271 Return 0 on success, -1 on error.
1272*/
1273
1274static int
1275merge_class_dict(PyObject* dict, PyObject* aclass)
1276{
1277 PyObject *classdict;
1278 PyObject *bases;
1279
1280 assert(PyDict_Check(dict));
1281 assert(aclass);
1282
1283 /* Merge in the type's dict (if any). */
1284 classdict = PyObject_GetAttrString(aclass, "__dict__");
1285 if (classdict == NULL)
1286 PyErr_Clear();
1287 else {
1288 int status = PyDict_Update(dict, classdict);
1289 Py_DECREF(classdict);
1290 if (status < 0)
1291 return -1;
1292 }
1293
1294 /* Recursively merge in the base types' (if any) dicts. */
1295 bases = PyObject_GetAttrString(aclass, "__bases__");
Tim Petersbc7e8632001-09-16 20:33:22 +00001296 if (bases == NULL)
1297 PyErr_Clear();
1298 else {
Guido van Rossum44022412002-05-13 18:29:46 +00001299 /* We have no guarantee that bases is a real tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001300 Py_ssize_t i, n;
Guido van Rossum44022412002-05-13 18:29:46 +00001301 n = PySequence_Size(bases); /* This better be right */
1302 if (n < 0)
1303 PyErr_Clear();
1304 else {
1305 for (i = 0; i < n; i++) {
Tim Peters18e70832003-02-05 19:35:19 +00001306 int status;
Guido van Rossum44022412002-05-13 18:29:46 +00001307 PyObject *base = PySequence_GetItem(bases, i);
1308 if (base == NULL) {
1309 Py_DECREF(bases);
1310 return -1;
1311 }
Tim Peters18e70832003-02-05 19:35:19 +00001312 status = merge_class_dict(dict, base);
1313 Py_DECREF(base);
1314 if (status < 0) {
Guido van Rossum44022412002-05-13 18:29:46 +00001315 Py_DECREF(bases);
1316 return -1;
1317 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001318 }
1319 }
1320 Py_DECREF(bases);
1321 }
1322 return 0;
1323}
1324
Georg Brandle32b4222007-03-10 22:13:27 +00001325/* Helper for PyObject_Dir without arguments: returns the local scope. */
1326static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001327_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001328{
Georg Brandled3b8382007-03-12 13:15:14 +00001329 PyObject *names;
Georg Brandle32b4222007-03-10 22:13:27 +00001330 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001331
Georg Brandle32b4222007-03-10 22:13:27 +00001332 if (locals == NULL) {
1333 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1334 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001335 }
1336
Georg Brandled3b8382007-03-12 13:15:14 +00001337 names = PyMapping_Keys(locals);
1338 if (!names)
1339 return NULL;
1340 if (!PyList_Check(names)) {
1341 PyErr_Format(PyExc_TypeError,
1342 "dir(): expected keys() of locals to be a list, "
Christian Heimes90aa7642007-12-19 02:45:37 +00001343 "not '%.200s'", Py_TYPE(names)->tp_name);
Georg Brandled3b8382007-03-12 13:15:14 +00001344 Py_DECREF(names);
1345 return NULL;
1346 }
Georg Brandle32b4222007-03-10 22:13:27 +00001347 /* the locals don't need to be DECREF'd */
Georg Brandled3b8382007-03-12 13:15:14 +00001348 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001349}
1350
1351/* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
Guido van Rossum98297ee2007-11-06 21:34:58 +00001352 We deliberately don't suck up its __class__, as methods belonging to the
1353 metaclass would probably be more confusing than helpful.
Georg Brandle32b4222007-03-10 22:13:27 +00001354*/
Guido van Rossum98297ee2007-11-06 21:34:58 +00001355static PyObject *
Georg Brandle32b4222007-03-10 22:13:27 +00001356_specialized_dir_type(PyObject *obj)
1357{
1358 PyObject *result = NULL;
1359 PyObject *dict = PyDict_New();
1360
1361 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1362 result = PyDict_Keys(dict);
1363
1364 Py_XDECREF(dict);
Tim Peters305b5852001-09-17 02:38:46 +00001365 return result;
1366}
1367
Georg Brandle32b4222007-03-10 22:13:27 +00001368/* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1369static PyObject *
1370_specialized_dir_module(PyObject *obj)
Tim Peters7eea37e2001-09-04 22:08:56 +00001371{
Georg Brandle32b4222007-03-10 22:13:27 +00001372 PyObject *result = NULL;
1373 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
Tim Peters7eea37e2001-09-04 22:08:56 +00001374
Georg Brandle32b4222007-03-10 22:13:27 +00001375 if (dict != NULL) {
1376 if (PyDict_Check(dict))
1377 result = PyDict_Keys(dict);
1378 else {
1379 PyErr_Format(PyExc_TypeError,
1380 "%.200s.__dict__ is not a dictionary",
1381 PyModule_GetName(obj));
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001382 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001383 }
1384
Georg Brandle32b4222007-03-10 22:13:27 +00001385 Py_XDECREF(dict);
1386 return result;
1387}
Tim Peters7eea37e2001-09-04 22:08:56 +00001388
Georg Brandle32b4222007-03-10 22:13:27 +00001389/* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1390 and recursively up the __class__.__bases__ chain.
1391*/
1392static PyObject *
1393_generic_dir(PyObject *obj)
1394{
1395 PyObject *result = NULL;
1396 PyObject *dict = NULL;
1397 PyObject *itsclass = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001398
Georg Brandle32b4222007-03-10 22:13:27 +00001399 /* Get __dict__ (which may or may not be a real dict...) */
1400 dict = PyObject_GetAttrString(obj, "__dict__");
1401 if (dict == NULL) {
1402 PyErr_Clear();
1403 dict = PyDict_New();
1404 }
1405 else if (!PyDict_Check(dict)) {
1406 Py_DECREF(dict);
1407 dict = PyDict_New();
1408 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001409 else {
Georg Brandle32b4222007-03-10 22:13:27 +00001410 /* Copy __dict__ to avoid mutating it. */
1411 PyObject *temp = PyDict_Copy(dict);
1412 Py_DECREF(dict);
1413 dict = temp;
Tim Peters7eea37e2001-09-04 22:08:56 +00001414 }
1415
Georg Brandle32b4222007-03-10 22:13:27 +00001416 if (dict == NULL)
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001417 goto error;
Tim Peters7eea37e2001-09-04 22:08:56 +00001418
Georg Brandle32b4222007-03-10 22:13:27 +00001419 /* Merge in attrs reachable from its class. */
1420 itsclass = PyObject_GetAttrString(obj, "__class__");
1421 if (itsclass == NULL)
1422 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1423 __class__ exists? */
1424 PyErr_Clear();
1425 else {
1426 if (merge_class_dict(dict, itsclass) != 0)
1427 goto error;
1428 }
1429
1430 result = PyDict_Keys(dict);
Tim Peters7eea37e2001-09-04 22:08:56 +00001431 /* fall through */
Georg Brandle32b4222007-03-10 22:13:27 +00001432error:
1433 Py_XDECREF(itsclass);
1434 Py_XDECREF(dict);
1435 return result;
1436}
1437
1438/* Helper for PyObject_Dir: object introspection.
1439 This calls one of the above specialized versions if no __dir__ method
1440 exists. */
1441static PyObject *
1442_dir_object(PyObject *obj)
1443{
1444 PyObject * result = NULL;
1445 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1446 "__dir__");
1447
1448 assert(obj);
1449 if (dirfunc == NULL) {
1450 /* use default implementation */
1451 PyErr_Clear();
1452 if (PyModule_Check(obj))
1453 result = _specialized_dir_module(obj);
1454 else if (PyType_Check(obj))
1455 result = _specialized_dir_type(obj);
1456 else
1457 result = _generic_dir(obj);
1458 }
1459 else {
1460 /* use __dir__ */
1461 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1462 Py_DECREF(dirfunc);
1463 if (result == NULL)
1464 return NULL;
1465
1466 /* result must be a list */
1467 /* XXX(gbrandl): could also check if all items are strings */
1468 if (!PyList_Check(result)) {
1469 PyErr_Format(PyExc_TypeError,
1470 "__dir__() must return a list, not %.200s",
Christian Heimes90aa7642007-12-19 02:45:37 +00001471 Py_TYPE(result)->tp_name);
Georg Brandle32b4222007-03-10 22:13:27 +00001472 Py_DECREF(result);
1473 result = NULL;
1474 }
1475 }
1476
1477 return result;
1478}
1479
1480/* Implementation of dir() -- if obj is NULL, returns the names in the current
1481 (local) scope. Otherwise, performs introspection of the object: returns a
1482 sorted list of attribute names (supposedly) accessible from the object
1483*/
1484PyObject *
1485PyObject_Dir(PyObject *obj)
1486{
1487 PyObject * result;
1488
1489 if (obj == NULL)
1490 /* no object -- introspect the locals */
1491 result = _dir_locals();
1492 else
1493 /* object -- introspect the object */
1494 result = _dir_object(obj);
1495
1496 assert(result == NULL || PyList_Check(result));
1497
1498 if (result != NULL && PyList_Sort(result) != 0) {
1499 /* sorting the list failed */
1500 Py_DECREF(result);
1501 result = NULL;
1502 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001503
Tim Peters7eea37e2001-09-04 22:08:56 +00001504 return result;
1505}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001506
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001507/*
1508NoObject is usable as a non-NULL undefined value, used by the macro None.
1509There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001510so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001511(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001512*/
1513
Guido van Rossum0c182a11992-03-27 17:26:13 +00001514/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001515static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001516none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001517{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001518 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001519}
1520
Barry Warsaw9bf16442001-01-23 16:24:35 +00001521/* ARGUSED */
1522static void
Tim Peters803526b2002-07-07 05:13:56 +00001523none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001524{
1525 /* This should never get called, but we also don't want to SEGV if
1526 * we accidently decref None out of existance.
1527 */
Martin v. Löwis3f19b102002-08-07 16:21:51 +00001528 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001529}
1530
1531
Guido van Rossumba21a492001-08-16 08:17:26 +00001532static PyTypeObject PyNone_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001533 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001534 "NoneType",
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001535 0,
1536 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001537 none_dealloc, /*tp_dealloc*/ /*never called*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001538 0, /*tp_print*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001539 0, /*tp_getattr*/
1540 0, /*tp_setattr*/
1541 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001542 none_repr, /*tp_repr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001543 0, /*tp_as_number*/
1544 0, /*tp_as_sequence*/
1545 0, /*tp_as_mapping*/
Guido van Rossum9bfef441993-03-29 10:43:31 +00001546 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001547};
1548
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001549PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001550 _PyObject_EXTRA_INIT
1551 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001552};
1553
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001554/* NotImplemented is an object that can be used to signal that an
1555 operation is not implemented for the given type combination. */
1556
1557static PyObject *
1558NotImplemented_repr(PyObject *op)
1559{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001560 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001561}
1562
1563static PyTypeObject PyNotImplemented_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001564 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001565 "NotImplementedType",
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001566 0,
1567 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001568 none_dealloc, /*tp_dealloc*/ /*never called*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001569 0, /*tp_print*/
1570 0, /*tp_getattr*/
1571 0, /*tp_setattr*/
1572 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001573 NotImplemented_repr, /*tp_repr*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001574 0, /*tp_as_number*/
1575 0, /*tp_as_sequence*/
1576 0, /*tp_as_mapping*/
1577 0, /*tp_hash */
1578};
1579
1580PyObject _Py_NotImplementedStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001581 _PyObject_EXTRA_INIT
1582 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001583};
1584
Guido van Rossumba21a492001-08-16 08:17:26 +00001585void
1586_Py_ReadyTypes(void)
1587{
1588 if (PyType_Ready(&PyType_Type) < 0)
1589 Py_FatalError("Can't initialize 'type'");
1590
Fred Drake0a4dd392004-07-02 18:57:45 +00001591 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1592 Py_FatalError("Can't initialize 'weakref'");
1593
Guido van Rossum77f6a652002-04-03 22:41:51 +00001594 if (PyType_Ready(&PyBool_Type) < 0)
1595 Py_FatalError("Can't initialize 'bool'");
1596
Christian Heimes9c4756e2008-05-26 13:22:05 +00001597 if (PyType_Ready(&PyByteArray_Type) < 0)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001598 Py_FatalError("Can't initialize 'bytes'");
1599
Christian Heimes72b710a2008-05-26 13:28:38 +00001600 if (PyType_Ready(&PyBytes_Type) < 0)
Guido van Rossumcacfc072002-05-24 19:01:59 +00001601 Py_FatalError("Can't initialize 'str'");
1602
Guido van Rossumba21a492001-08-16 08:17:26 +00001603 if (PyType_Ready(&PyList_Type) < 0)
1604 Py_FatalError("Can't initialize 'list'");
1605
1606 if (PyType_Ready(&PyNone_Type) < 0)
1607 Py_FatalError("Can't initialize type(None)");
1608
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001609 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1610 Py_FatalError("Can't initialize type(Ellipsis)");
1611
Guido van Rossumba21a492001-08-16 08:17:26 +00001612 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1613 Py_FatalError("Can't initialize type(NotImplemented)");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001614
1615 if (PyType_Ready(&PyCode_Type) < 0)
1616 Py_FatalError("Can't initialize 'code'");
Guido van Rossum826d8972007-10-30 18:34:07 +00001617
1618 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1619 Py_FatalError("Can't initialize StdPrinter");
Guido van Rossumba21a492001-08-16 08:17:26 +00001620}
1621
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001622
Guido van Rossum84a90321996-05-22 16:34:47 +00001623#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001624
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001625void
Fred Drake100814d2000-07-09 15:48:49 +00001626_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001627{
Tim Peters34592512002-07-11 06:23:50 +00001628 _Py_INC_REFTOTAL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001629 op->ob_refcnt = 1;
Tim Peters7571a0f2003-03-23 17:52:28 +00001630 _Py_AddToAllObjects(op, 1);
Tim Peters34592512002-07-11 06:23:50 +00001631 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001632}
1633
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001634void
Fred Drake100814d2000-07-09 15:48:49 +00001635_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001636{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001637#ifdef SLOW_UNREF_CHECK
Guido van Rossum4c08d552000-03-10 22:55:18 +00001638 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001639#endif
Guido van Rossumd7047b31995-01-02 19:07:15 +00001640 if (op->ob_refcnt < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001641 Py_FatalError("UNREF negative refcnt");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001642 if (op == &refchain ||
Christian Heimesc8967002007-11-30 10:18:26 +00001643 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1644 fprintf(stderr, "* ob\n");
1645 _PyObject_Dump(op);
1646 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1647 _PyObject_Dump(op->_ob_prev->_ob_next);
1648 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1649 _PyObject_Dump(op->_ob_next->_ob_prev);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001650 Py_FatalError("UNREF invalid object");
Christian Heimesc8967002007-11-30 10:18:26 +00001651 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001652#ifdef SLOW_UNREF_CHECK
Guido van Rossum3f5da241990-12-20 15:06:42 +00001653 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1654 if (p == op)
1655 break;
1656 }
Guido van Rossumd7047b31995-01-02 19:07:15 +00001657 if (p == &refchain) /* Not found */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001658 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001659#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001660 op->_ob_next->_ob_prev = op->_ob_prev;
1661 op->_ob_prev->_ob_next = op->_ob_next;
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001662 op->_ob_next = op->_ob_prev = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001663 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001664}
1665
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001666void
Fred Drake100814d2000-07-09 15:48:49 +00001667_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001668{
Christian Heimes90aa7642007-12-19 02:45:37 +00001669 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001670 _Py_ForgetReference(op);
Guido van Rossum9776adf1994-09-07 14:36:45 +00001671 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001672}
1673
Tim Peters269b2a62003-04-17 19:52:29 +00001674/* Print all live objects. Because PyObject_Print is called, the
1675 * interpreter must be in a healthy state.
1676 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001677void
Fred Drake100814d2000-07-09 15:48:49 +00001678_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001679{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001680 PyObject *op;
Guido van Rossume09fb551997-08-05 02:04:34 +00001681 fprintf(fp, "Remaining objects:\n");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001682 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001683 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001684 if (PyObject_Print(op, fp, 0) != 0)
1685 PyErr_Clear();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001686 putc('\n', fp);
1687 }
1688}
1689
Tim Peters269b2a62003-04-17 19:52:29 +00001690/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1691 * doesn't make any calls to the Python C API, so is always safe to call.
1692 */
1693void
1694_Py_PrintReferenceAddresses(FILE *fp)
1695{
1696 PyObject *op;
1697 fprintf(fp, "Remaining object addresses:\n");
1698 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001699 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
Christian Heimes90aa7642007-12-19 02:45:37 +00001700 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001701}
1702
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001703PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001704_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001705{
1706 int i, n;
1707 PyObject *t = NULL;
1708 PyObject *res, *op;
1709
1710 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1711 return NULL;
1712 op = refchain._ob_next;
1713 res = PyList_New(0);
1714 if (res == NULL)
1715 return NULL;
1716 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1717 while (op == self || op == args || op == res || op == t ||
Christian Heimes90aa7642007-12-19 02:45:37 +00001718 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001719 op = op->_ob_next;
1720 if (op == &refchain)
1721 return res;
1722 }
1723 if (PyList_Append(res, op) < 0) {
1724 Py_DECREF(res);
1725 return NULL;
1726 }
1727 op = op->_ob_next;
1728 }
1729 return res;
1730}
1731
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001732#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001733
1734
1735/* Hack to force loading of cobject.o */
Guido van Rossumda9c2711996-12-05 21:58:58 +00001736PyTypeObject *_Py_cobject_hack = &PyCObject_Type;
Guido van Rossum84a90321996-05-22 16:34:47 +00001737
1738
1739/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001740Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001741
1742
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001743/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001744
Thomas Wouters334fb892000-07-25 12:56:38 +00001745void *
Fred Drake100814d2000-07-09 15:48:49 +00001746PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001747{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001748 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001749}
1750
Thomas Wouters334fb892000-07-25 12:56:38 +00001751void *
1752PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001753{
Tim Petersaf3e8de2002-04-12 07:22:56 +00001754 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001755}
1756
1757void
Thomas Wouters334fb892000-07-25 12:56:38 +00001758PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001759{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001760 PyMem_FREE(p);
1761}
1762
1763
Guido van Rossum86610361998-04-10 22:32:46 +00001764/* These methods are used to control infinite recursion in repr, str, print,
1765 etc. Container objects that may recursively contain themselves,
1766 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1767 Py_ReprLeave() to avoid infinite recursion.
1768
1769 Py_ReprEnter() returns 0 the first time it is called for a particular
1770 object and 1 every time thereafter. It returns -1 if an exception
1771 occurred. Py_ReprLeave() has no return value.
1772
1773 See dictobject.c and listobject.c for examples of use.
1774*/
1775
1776#define KEY "Py_Repr"
1777
1778int
Fred Drake100814d2000-07-09 15:48:49 +00001779Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001780{
1781 PyObject *dict;
1782 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001783 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001784
1785 dict = PyThreadState_GetDict();
1786 if (dict == NULL)
Guido van Rossum0fc8f002003-04-15 15:12:39 +00001787 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001788 list = PyDict_GetItemString(dict, KEY);
1789 if (list == NULL) {
1790 list = PyList_New(0);
1791 if (list == NULL)
1792 return -1;
1793 if (PyDict_SetItemString(dict, KEY, list) < 0)
1794 return -1;
1795 Py_DECREF(list);
1796 }
1797 i = PyList_GET_SIZE(list);
1798 while (--i >= 0) {
1799 if (PyList_GET_ITEM(list, i) == obj)
1800 return 1;
1801 }
1802 PyList_Append(list, obj);
1803 return 0;
1804}
1805
1806void
Fred Drake100814d2000-07-09 15:48:49 +00001807Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001808{
1809 PyObject *dict;
1810 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001811 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001812
1813 dict = PyThreadState_GetDict();
Guido van Rossumeb909461998-04-11 15:17:34 +00001814 if (dict == NULL)
1815 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001816 list = PyDict_GetItemString(dict, KEY);
Guido van Rossumeb909461998-04-11 15:17:34 +00001817 if (list == NULL || !PyList_Check(list))
1818 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001819 i = PyList_GET_SIZE(list);
1820 /* Count backwards because we always expect obj to be list[-1] */
1821 while (--i >= 0) {
1822 if (PyList_GET_ITEM(list, i) == obj) {
1823 PyList_SetSlice(list, i, i + 1, NULL);
1824 break;
1825 }
1826 }
1827}
Guido van Rossumd724b232000-03-13 16:01:29 +00001828
Tim Peters803526b2002-07-07 05:13:56 +00001829/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001830
Tim Peters803526b2002-07-07 05:13:56 +00001831/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001832int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001833
Tim Peters803526b2002-07-07 05:13:56 +00001834/* List of objects that still need to be cleaned up, singly linked via their
1835 * gc headers' gc_prev pointers.
1836 */
1837PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001838
Tim Peters803526b2002-07-07 05:13:56 +00001839/* Add op to the _PyTrash_delete_later list. Called when the current
1840 * call-stack depth gets large. op must be a currently untracked gc'ed
1841 * object, with refcount 0. Py_DECREF must already have been called on it.
1842 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001843void
Fred Drake100814d2000-07-09 15:48:49 +00001844_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001845{
Tim Peters803526b2002-07-07 05:13:56 +00001846 assert(PyObject_IS_GC(op));
1847 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1848 assert(op->ob_refcnt == 0);
Neil Schemenauerf589c052002-03-29 03:05:54 +00001849 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
Guido van Rossume92e6102000-04-24 15:40:53 +00001850 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001851}
1852
Tim Peters803526b2002-07-07 05:13:56 +00001853/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1854 * the call-stack unwinds again.
1855 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001856void
Fred Drake100814d2000-07-09 15:48:49 +00001857_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001858{
1859 while (_PyTrash_delete_later) {
Tim Peters803526b2002-07-07 05:13:56 +00001860 PyObject *op = _PyTrash_delete_later;
Christian Heimes90aa7642007-12-19 02:45:37 +00001861 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001862
Neil Schemenauerf589c052002-03-29 03:05:54 +00001863 _PyTrash_delete_later =
Tim Peters803526b2002-07-07 05:13:56 +00001864 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001865
Tim Peters803526b2002-07-07 05:13:56 +00001866 /* Call the deallocator directly. This used to try to
1867 * fool Py_DECREF into calling it indirectly, but
1868 * Py_DECREF was already called on this object, and in
1869 * assorted non-release builds calling Py_DECREF again ends
1870 * up distorting allocation statistics.
1871 */
1872 assert(op->ob_refcnt == 0);
Guido van Rossumd724b232000-03-13 16:01:29 +00001873 ++_PyTrash_delete_nesting;
Tim Peters803526b2002-07-07 05:13:56 +00001874 (*dealloc)(op);
Guido van Rossumd724b232000-03-13 16:01:29 +00001875 --_PyTrash_delete_nesting;
1876 }
1877}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001878
1879#ifdef __cplusplus
1880}
1881#endif