blob: 002acd04be68a8109e4073c5b27e78a36f437e5e [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum3f5da241990-12-20 15:06:42 +00002/* Generic object operations; and implementation of None (NoObject) */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004#include "Python.h"
Guido van Rossum50e9fb92006-08-17 05:42:55 +00005#include "sliceobject.h" /* For PyEllipsis_Type */
Benjamin Petersonfd838e62009-04-20 02:09:13 +00006#include "frameobject.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00007
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00008#ifdef __cplusplus
9extern "C" {
10#endif
11
Tim Peters34592512002-07-11 06:23:50 +000012#ifdef Py_REF_DEBUG
Neal Norwitz84632ee2006-03-04 20:00:59 +000013Py_ssize_t _Py_RefTotal;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000014
15Py_ssize_t
16_Py_GetRefTotal(void)
17{
18 PyObject *o;
19 Py_ssize_t total = _Py_RefTotal;
20 /* ignore the references to the dummy object of the dicts and sets
21 because they are not reliable and not useful (now that the
22 hash table code is well-tested) */
23 o = _PyDict_Dummy();
24 if (o != NULL)
25 total -= o->ob_refcnt;
26 o = _PySet_Dummy();
27 if (o != NULL)
28 total -= o->ob_refcnt;
29 return total;
30}
31#endif /* Py_REF_DEBUG */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000032
Mark Hammonda2905272002-07-29 13:42:14 +000033int Py_DivisionWarningFlag;
Guido van Rossum393661d2001-08-31 17:40:15 +000034
Guido van Rossum3f5da241990-12-20 15:06:42 +000035/* Object allocation routines used by NEWOBJ and NEWVAROBJ macros.
36 These are used by the individual routines for object creation.
37 Do not call them otherwise, they do not initialize the object! */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000038
Tim Peters78be7992003-03-23 02:51:01 +000039#ifdef Py_TRACE_REFS
Tim Peters7571a0f2003-03-23 17:52:28 +000040/* Head of circular doubly-linked list of all objects. These are linked
41 * together via the _ob_prev and _ob_next members of a PyObject, which
42 * exist only in a Py_TRACE_REFS build.
43 */
Tim Peters78be7992003-03-23 02:51:01 +000044static PyObject refchain = {&refchain, &refchain};
Tim Peters36eb4df2003-03-23 03:33:13 +000045
Tim Peters7571a0f2003-03-23 17:52:28 +000046/* Insert op at the front of the list of all objects. If force is true,
47 * op is added even if _ob_prev and _ob_next are non-NULL already. If
48 * force is false amd _ob_prev or _ob_next are non-NULL, do nothing.
49 * force should be true if and only if op points to freshly allocated,
50 * uninitialized memory, or you've unlinked op from the list and are
Tim Peters51f8d382003-03-23 18:06:08 +000051 * relinking it into the front.
Tim Peters7571a0f2003-03-23 17:52:28 +000052 * Note that objects are normally added to the list via _Py_NewReference,
53 * which is called by PyObject_Init. Not all objects are initialized that
54 * way, though; exceptions include statically allocated type objects, and
55 * statically allocated singletons (like Py_True and Py_None).
56 */
Tim Peters36eb4df2003-03-23 03:33:13 +000057void
Tim Peters7571a0f2003-03-23 17:52:28 +000058_Py_AddToAllObjects(PyObject *op, int force)
Tim Peters36eb4df2003-03-23 03:33:13 +000059{
Tim Peters7571a0f2003-03-23 17:52:28 +000060#ifdef Py_DEBUG
61 if (!force) {
62 /* If it's initialized memory, op must be in or out of
63 * the list unambiguously.
64 */
65 assert((op->_ob_prev == NULL) == (op->_ob_next == NULL));
66 }
Tim Peters78be7992003-03-23 02:51:01 +000067#endif
Tim Peters7571a0f2003-03-23 17:52:28 +000068 if (force || op->_ob_prev == NULL) {
69 op->_ob_next = refchain._ob_next;
70 op->_ob_prev = &refchain;
71 refchain._ob_next->_ob_prev = op;
72 refchain._ob_next = op;
73 }
74}
75#endif /* Py_TRACE_REFS */
Tim Peters78be7992003-03-23 02:51:01 +000076
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000077#ifdef COUNT_ALLOCS
Guido van Rossumc0b618a1997-05-02 03:12:38 +000078static PyTypeObject *type_list;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000079/* All types are added to type_list, at least when
80 they get one object created. That makes them
81 immortal, which unfortunately contributes to
82 garbage itself. If unlist_types_without_objects
83 is set, they will be removed from the type_list
84 once the last object is deallocated. */
Benjamin Petersona4a37fe2009-01-11 17:13:55 +000085static int unlist_types_without_objects;
86extern Py_ssize_t tuple_zero_allocs, fast_tuple_allocs;
87extern Py_ssize_t quick_int_allocs, quick_neg_int_allocs;
88extern Py_ssize_t null_strings, one_strings;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000089void
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000090dump_counts(FILE* f)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000091{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000092 PyTypeObject *tp;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000093
94 for (tp = type_list; tp; tp = tp->tp_next)
Benjamin Petersona4a37fe2009-01-11 17:13:55 +000095 fprintf(f, "%s alloc'd: %" PY_FORMAT_SIZE_T "d, "
96 "freed: %" PY_FORMAT_SIZE_T "d, "
97 "max in use: %" PY_FORMAT_SIZE_T "d\n",
Tim Peters6d6c1a32001-08-02 04:15:00 +000098 tp->tp_name, tp->tp_allocs, tp->tp_frees,
Sjoerd Mullender52c1f511993-10-25 08:40:52 +000099 tp->tp_maxalloc);
Benjamin Petersona4a37fe2009-01-11 17:13:55 +0000100 fprintf(f, "fast tuple allocs: %" PY_FORMAT_SIZE_T "d, "
101 "empty: %" PY_FORMAT_SIZE_T "d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +0000102 fast_tuple_allocs, tuple_zero_allocs);
Benjamin Petersona4a37fe2009-01-11 17:13:55 +0000103 fprintf(f, "fast int allocs: pos: %" PY_FORMAT_SIZE_T "d, "
104 "neg: %" PY_FORMAT_SIZE_T "d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +0000105 quick_int_allocs, quick_neg_int_allocs);
Benjamin Petersona4a37fe2009-01-11 17:13:55 +0000106 fprintf(f, "null strings: %" PY_FORMAT_SIZE_T "d, "
107 "1-strings: %" PY_FORMAT_SIZE_T "d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +0000108 null_strings, one_strings);
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000109}
110
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000111PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000112get_counts(void)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000113{
114 PyTypeObject *tp;
115 PyObject *result;
116 PyObject *v;
117
118 result = PyList_New(0);
119 if (result == NULL)
120 return NULL;
121 for (tp = type_list; tp; tp = tp->tp_next) {
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000122 v = Py_BuildValue("(snnn)", tp->tp_name, tp->tp_allocs,
Tim Peters6d6c1a32001-08-02 04:15:00 +0000123 tp->tp_frees, tp->tp_maxalloc);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000124 if (v == NULL) {
125 Py_DECREF(result);
126 return NULL;
127 }
128 if (PyList_Append(result, v) < 0) {
129 Py_DECREF(v);
130 Py_DECREF(result);
131 return NULL;
132 }
133 Py_DECREF(v);
134 }
135 return result;
136}
137
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000138void
Fred Drake100814d2000-07-09 15:48:49 +0000139inc_count(PyTypeObject *tp)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000140{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000141 if (tp->tp_next == NULL && tp->tp_prev == NULL) {
Guido van Rossumd8953cb1995-04-06 14:46:26 +0000142 /* first time; insert in linked list */
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000143 if (tp->tp_next != NULL) /* sanity check */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000144 Py_FatalError("XXX inc_count sanity check");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000145 if (type_list)
146 type_list->tp_prev = tp;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000147 tp->tp_next = type_list;
Tim Petersc6a3ff62002-07-08 22:11:52 +0000148 /* Note that as of Python 2.2, heap-allocated type objects
149 * can go away, but this code requires that they stay alive
150 * until program exit. That's why we're careful with
151 * refcounts here. type_list gets a new reference to tp,
152 * while ownership of the reference type_list used to hold
153 * (if any) was transferred to tp->tp_next in the line above.
154 * tp is thus effectively immortal after this.
155 */
156 Py_INCREF(tp);
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000157 type_list = tp;
Tim Peters3e40c7f2003-03-23 03:04:32 +0000158#ifdef Py_TRACE_REFS
Tim Peters7571a0f2003-03-23 17:52:28 +0000159 /* Also insert in the doubly-linked list of all objects,
160 * if not already there.
161 */
162 _Py_AddToAllObjects((PyObject *)tp, 0);
Tim Peters78be7992003-03-23 02:51:01 +0000163#endif
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000164 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000165 tp->tp_allocs++;
166 if (tp->tp_allocs - tp->tp_frees > tp->tp_maxalloc)
167 tp->tp_maxalloc = tp->tp_allocs - tp->tp_frees;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000168}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000169
170void dec_count(PyTypeObject *tp)
171{
172 tp->tp_frees++;
173 if (unlist_types_without_objects &&
174 tp->tp_allocs == tp->tp_frees) {
175 /* unlink the type from type_list */
176 if (tp->tp_prev)
177 tp->tp_prev->tp_next = tp->tp_next;
178 else
179 type_list = tp->tp_next;
180 if (tp->tp_next)
181 tp->tp_next->tp_prev = tp->tp_prev;
182 tp->tp_next = tp->tp_prev = NULL;
183 Py_DECREF(tp);
184 }
185}
186
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000187#endif
188
Tim Peters7c321a82002-07-09 02:57:01 +0000189#ifdef Py_REF_DEBUG
190/* Log a fatal error; doesn't return. */
191void
192_Py_NegativeRefcount(const char *fname, int lineno, PyObject *op)
193{
194 char buf[300];
195
196 PyOS_snprintf(buf, sizeof(buf),
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000197 "%s:%i object at %p has negative ref count "
198 "%" PY_FORMAT_SIZE_T "d",
199 fname, lineno, op, op->ob_refcnt);
Tim Peters7c321a82002-07-09 02:57:01 +0000200 Py_FatalError(buf);
201}
202
203#endif /* Py_REF_DEBUG */
204
Thomas Heller1328b522004-04-22 17:23:49 +0000205void
206Py_IncRef(PyObject *o)
207{
208 Py_XINCREF(o);
209}
210
211void
212Py_DecRef(PyObject *o)
213{
214 Py_XDECREF(o);
215}
216
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000217PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000218PyObject_Init(PyObject *op, PyTypeObject *tp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000219{
Guido van Rossum6e08c142002-10-11 20:37:24 +0000220 if (op == NULL)
221 return PyErr_NoMemory();
Guido van Rossumb18618d2000-05-03 23:44:39 +0000222 /* Any changes should be reflected in PyObject_INIT (objimpl.h) */
Christian Heimes90aa7642007-12-19 02:45:37 +0000223 Py_TYPE(op) = tp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000224 _Py_NewReference(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000225 return op;
226}
227
Guido van Rossumb18618d2000-05-03 23:44:39 +0000228PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000229PyObject_InitVar(PyVarObject *op, PyTypeObject *tp, Py_ssize_t size)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000230{
Guido van Rossum6e08c142002-10-11 20:37:24 +0000231 if (op == NULL)
232 return (PyVarObject *) PyErr_NoMemory();
Guido van Rossumb18618d2000-05-03 23:44:39 +0000233 /* Any changes should be reflected in PyObject_INIT_VAR */
234 op->ob_size = size;
Christian Heimes90aa7642007-12-19 02:45:37 +0000235 Py_TYPE(op) = tp;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000236 _Py_NewReference((PyObject *)op);
237 return op;
238}
239
240PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000241_PyObject_New(PyTypeObject *tp)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000242{
243 PyObject *op;
244 op = (PyObject *) PyObject_MALLOC(_PyObject_SIZE(tp));
245 if (op == NULL)
246 return PyErr_NoMemory();
247 return PyObject_INIT(op, tp);
248}
249
Guido van Rossumd0c87ee1997-05-15 21:31:03 +0000250PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000251_PyObject_NewVar(PyTypeObject *tp, Py_ssize_t nitems)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000252{
Guido van Rossumb18618d2000-05-03 23:44:39 +0000253 PyVarObject *op;
Tim Petersf2a67da2001-10-07 03:54:51 +0000254 const size_t size = _PyObject_VAR_SIZE(tp, nitems);
Tim Peters6d483d32001-10-06 21:27:34 +0000255 op = (PyVarObject *) PyObject_MALLOC(size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000256 if (op == NULL)
Guido van Rossumd0c87ee1997-05-15 21:31:03 +0000257 return (PyVarObject *)PyErr_NoMemory();
Tim Peters6d483d32001-10-06 21:27:34 +0000258 return PyObject_INIT_VAR(op, tp, nitems);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000259}
260
Neal Norwitz1a997502003-01-13 20:13:12 +0000261/* Implementation of PyObject_Print with recursion checking */
262static int
263internal_print(PyObject *op, FILE *fp, int flags, int nesting)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000264{
Guido van Rossum278ef591991-07-27 21:40:24 +0000265 int ret = 0;
Neal Norwitz1a997502003-01-13 20:13:12 +0000266 if (nesting > 10) {
267 PyErr_SetString(PyExc_RuntimeError, "print recursion");
268 return -1;
269 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000270 if (PyErr_CheckSignals())
Guido van Rossum90933611991-06-07 16:10:43 +0000271 return -1;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000272#ifdef USE_STACKCHECK
273 if (PyOS_CheckStack()) {
Fred Drake661ea262000-10-24 19:57:45 +0000274 PyErr_SetString(PyExc_MemoryError, "stack overflow");
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000275 return -1;
276 }
277#endif
Guido van Rossum687ef6e2000-01-12 16:28:58 +0000278 clearerr(fp); /* Clear any previous error condition */
Guido van Rossum90933611991-06-07 16:10:43 +0000279 if (op == NULL) {
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000280 Py_BEGIN_ALLOW_THREADS
Guido van Rossum90933611991-06-07 16:10:43 +0000281 fprintf(fp, "<nil>");
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000282 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000283 }
Guido van Rossum90933611991-06-07 16:10:43 +0000284 else {
285 if (op->ob_refcnt <= 0)
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000286 /* XXX(twouters) cast refcount to long until %zd is
287 universally available */
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000288 Py_BEGIN_ALLOW_THREADS
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000289 fprintf(fp, "<refcnt %ld at %p>",
290 (long)op->ob_refcnt, op);
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000291 Py_END_ALLOW_THREADS
Guido van Rossum04dbf3b2007-08-07 19:51:00 +0000292 else {
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000293 PyObject *s;
294 if (flags & Py_PRINT_RAW)
295 s = PyObject_Str(op);
296 else
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000297 s = PyObject_Repr(op);
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000298 if (s == NULL)
299 ret = -1;
Christian Heimes72b710a2008-05-26 13:28:38 +0000300 else if (PyBytes_Check(s)) {
301 fwrite(PyBytes_AS_STRING(s), 1,
302 PyBytes_GET_SIZE(s), fp);
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000303 }
304 else if (PyUnicode_Check(s)) {
305 PyObject *t;
306 t = _PyUnicode_AsDefaultEncodedString(s, NULL);
307 if (t == NULL)
308 ret = 0;
309 else {
Christian Heimes72b710a2008-05-26 13:28:38 +0000310 fwrite(PyBytes_AS_STRING(t), 1,
311 PyBytes_GET_SIZE(t), fp);
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000312 }
313 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000314 else {
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000315 PyErr_Format(PyExc_TypeError,
316 "str() or repr() returned '%.100s'",
317 s->ob_type->tp_name);
318 ret = -1;
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000319 }
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000320 Py_XDECREF(s);
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000321 }
Guido van Rossum90933611991-06-07 16:10:43 +0000322 }
Guido van Rossum278ef591991-07-27 21:40:24 +0000323 if (ret == 0) {
324 if (ferror(fp)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000325 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum278ef591991-07-27 21:40:24 +0000326 clearerr(fp);
327 ret = -1;
328 }
329 }
330 return ret;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000331}
332
Neal Norwitz1a997502003-01-13 20:13:12 +0000333int
334PyObject_Print(PyObject *op, FILE *fp, int flags)
335{
336 return internal_print(op, fp, flags, 0);
337}
338
Guido van Rossum38938152006-08-21 23:36:26 +0000339/* For debugging convenience. Set a breakpoint here and call it from your DLL */
340void
Thomas Woutersb2137042007-02-01 18:02:27 +0000341_Py_BreakPoint(void)
Guido van Rossum38938152006-08-21 23:36:26 +0000342{
343}
344
Neal Norwitz1a997502003-01-13 20:13:12 +0000345
Barry Warsaw9bf16442001-01-23 16:24:35 +0000346/* For debugging convenience. See Misc/gdbinit for some useful gdb hooks */
Guido van Rossum38938152006-08-21 23:36:26 +0000347void
348_PyObject_Dump(PyObject* op)
Barry Warsaw9bf16442001-01-23 16:24:35 +0000349{
Barry Warsaweefb1072001-02-22 22:39:18 +0000350 if (op == NULL)
351 fprintf(stderr, "NULL\n");
352 else {
Georg Brandldfd73442009-04-05 11:47:34 +0000353#ifdef WITH_THREAD
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +0000354 PyGILState_STATE gil;
Georg Brandldfd73442009-04-05 11:47:34 +0000355#endif
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000356 fprintf(stderr, "object : ");
Georg Brandldfd73442009-04-05 11:47:34 +0000357#ifdef WITH_THREAD
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +0000358 gil = PyGILState_Ensure();
Georg Brandldfd73442009-04-05 11:47:34 +0000359#endif
Barry Warsaweefb1072001-02-22 22:39:18 +0000360 (void)PyObject_Print(op, stderr, 0);
Georg Brandldfd73442009-04-05 11:47:34 +0000361#ifdef WITH_THREAD
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +0000362 PyGILState_Release(gil);
Georg Brandldfd73442009-04-05 11:47:34 +0000363#endif
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000364 /* XXX(twouters) cast refcount to long until %zd is
365 universally available */
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000366 fprintf(stderr, "\n"
367 "type : %s\n"
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000368 "refcount: %ld\n"
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000369 "address : %p\n",
Christian Heimes90aa7642007-12-19 02:45:37 +0000370 Py_TYPE(op)==NULL ? "NULL" : Py_TYPE(op)->tp_name,
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000371 (long)op->ob_refcnt,
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000372 op);
Barry Warsaweefb1072001-02-22 22:39:18 +0000373 }
Barry Warsaw9bf16442001-01-23 16:24:35 +0000374}
Barry Warsaw903138f2001-01-23 16:33:18 +0000375
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000376PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000377PyObject_Repr(PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000378{
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000379 PyObject *res;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000380 if (PyErr_CheckSignals())
Guido van Rossum90933611991-06-07 16:10:43 +0000381 return NULL;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000382#ifdef USE_STACKCHECK
383 if (PyOS_CheckStack()) {
Fred Drake661ea262000-10-24 19:57:45 +0000384 PyErr_SetString(PyExc_MemoryError, "stack overflow");
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000385 return NULL;
386 }
387#endif
Guido van Rossum90933611991-06-07 16:10:43 +0000388 if (v == NULL)
Walter Dörwald1ab83302007-05-18 17:15:44 +0000389 return PyUnicode_FromString("<NULL>");
Christian Heimes90aa7642007-12-19 02:45:37 +0000390 if (Py_TYPE(v)->tp_repr == NULL)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000391 return PyUnicode_FromFormat("<%s object at %p>",
392 v->ob_type->tp_name, v);
393 res = (*v->ob_type->tp_repr)(v);
394 if (res != NULL && !PyUnicode_Check(res)) {
395 PyErr_Format(PyExc_TypeError,
396 "__repr__ returned non-string (type %.200s)",
397 res->ob_type->tp_name);
398 Py_DECREF(res);
399 return NULL;
400 }
401 return res;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000402}
403
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000404PyObject *
Guido van Rossum98297ee2007-11-06 21:34:58 +0000405PyObject_Str(PyObject *v)
Guido van Rossumc6004111993-11-05 10:22:19 +0000406{
Guido van Rossum4c08d552000-03-10 22:55:18 +0000407 PyObject *res;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000408 if (PyErr_CheckSignals())
409 return NULL;
410#ifdef USE_STACKCHECK
411 if (PyOS_CheckStack()) {
412 PyErr_SetString(PyExc_MemoryError, "stack overflow");
413 return NULL;
414 }
415#endif
Guido van Rossumc6004111993-11-05 10:22:19 +0000416 if (v == NULL)
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000417 return PyUnicode_FromString("<NULL>");
Neil Schemenauercf52c072005-08-12 17:34:58 +0000418 if (PyUnicode_CheckExact(v)) {
419 Py_INCREF(v);
420 return v;
421 }
Christian Heimes90aa7642007-12-19 02:45:37 +0000422 if (Py_TYPE(v)->tp_str == NULL)
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000423 return PyObject_Repr(v);
424
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000425 /* It is possible for a type to have a tp_str representation that loops
426 infinitely. */
427 if (Py_EnterRecursiveCall(" while getting the str of an object"))
428 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +0000429 res = (*Py_TYPE(v)->tp_str)(v);
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000430 Py_LeaveRecursiveCall();
Guido van Rossum4c08d552000-03-10 22:55:18 +0000431 if (res == NULL)
432 return NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000433 if (!PyUnicode_Check(res)) {
Neil Schemenauercf52c072005-08-12 17:34:58 +0000434 PyErr_Format(PyExc_TypeError,
435 "__str__ returned non-string (type %.200s)",
Christian Heimes90aa7642007-12-19 02:45:37 +0000436 Py_TYPE(res)->tp_name);
Neil Schemenauercf52c072005-08-12 17:34:58 +0000437 Py_DECREF(res);
438 return NULL;
439 }
440 return res;
441}
442
Georg Brandl559e5d72008-06-11 18:37:52 +0000443PyObject *
444PyObject_ASCII(PyObject *v)
445{
446 PyObject *repr, *ascii, *res;
447
448 repr = PyObject_Repr(v);
449 if (repr == NULL)
450 return NULL;
451
452 /* repr is guaranteed to be a PyUnicode object by PyObject_Repr */
453 ascii = PyUnicode_EncodeASCII(
454 PyUnicode_AS_UNICODE(repr),
455 PyUnicode_GET_SIZE(repr),
456 "backslashreplace");
457
458 Py_DECREF(repr);
459 if (ascii == NULL)
460 return NULL;
461
462 res = PyUnicode_DecodeASCII(
463 PyBytes_AS_STRING(ascii),
464 PyBytes_GET_SIZE(ascii),
465 NULL);
466
467 Py_DECREF(ascii);
468 return res;
469}
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000470
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000471PyObject *
472PyObject_Bytes(PyObject *v)
473{
Christian Heimesff869fa2008-08-28 11:28:26 +0000474 PyObject *result, *func;
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000475 static PyObject *bytesstring = NULL;
476
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000477 if (v == NULL)
478 return PyBytes_FromString("<NULL>");
479
480 if (PyBytes_CheckExact(v)) {
481 Py_INCREF(v);
482 return v;
483 }
484
Benjamin Peterson224205f2009-05-08 03:25:19 +0000485 func = _PyObject_LookupSpecial(v, "__bytes__", &bytesstring);
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000486 if (func != NULL) {
Benjamin Petersonda136962009-05-08 03:27:59 +0000487 result = PyObject_CallFunctionObjArgs(func, NULL);
Benjamin Peterson224205f2009-05-08 03:25:19 +0000488 Py_DECREF(func);
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000489 if (result == NULL)
490 return NULL;
491 if (!PyBytes_Check(result)) {
492 PyErr_Format(PyExc_TypeError,
493 "__bytes__ returned non-bytes (type %.200s)",
494 Py_TYPE(result)->tp_name);
495 Py_DECREF(result);
496 return NULL;
497 }
498 return result;
499 }
Benjamin Peterson94c65d92009-05-25 03:10:48 +0000500 else if (PyErr_Occurred())
501 return NULL;
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000502 return PyBytes_FromObject(v);
503}
504
Mark Dickinsonc008a172009-02-01 13:59:22 +0000505/* For Python 3.0.1 and later, the old three-way comparison has been
506 completely removed in favour of rich comparisons. PyObject_Compare() and
507 PyObject_Cmp() are gone, and the builtin cmp function no longer exists.
Mark Dickinsone94c6792009-02-02 20:36:42 +0000508 The old tp_compare slot has been renamed to tp_reserved, and should no
Mark Dickinsonc008a172009-02-01 13:59:22 +0000509 longer be used. Use tp_richcompare instead.
Guido van Rossum98297ee2007-11-06 21:34:58 +0000510
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000511 See (*) below for practical amendments.
512
Mark Dickinsonc008a172009-02-01 13:59:22 +0000513 tp_richcompare gets called with a first argument of the appropriate type
514 and a second object of an arbitrary type. We never do any kind of
515 coercion.
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000516
Mark Dickinsonc008a172009-02-01 13:59:22 +0000517 The tp_richcompare slot should return an object, as follows:
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000518
519 NULL if an exception occurred
520 NotImplemented if the requested comparison is not implemented
521 any other false value if the requested comparison is false
522 any other true value if the requested comparison is true
523
524 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
525 NotImplemented.
526
527 (*) Practical amendments:
528
529 - If rich comparison returns NotImplemented, == and != are decided by
530 comparing the object pointer (i.e. falling back to the base object
531 implementation).
532
Guido van Rossuma4073002002-05-31 20:03:54 +0000533*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000534
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000535/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000536int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000537
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000538static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000539
540/* Perform a rich comparison, raising TypeError when the requested comparison
541 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000542static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000543do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000544{
545 richcmpfunc f;
546 PyObject *res;
Mark Dickinson6f1d0492009-11-15 13:58:49 +0000547 int checked_reverse_op = 0;
Guido van Rossume797ec12001-01-17 15:24:28 +0000548
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000549 if (v->ob_type != w->ob_type &&
550 PyType_IsSubtype(w->ob_type, v->ob_type) &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000551 (f = w->ob_type->tp_richcompare) != NULL) {
Mark Dickinson6f1d0492009-11-15 13:58:49 +0000552 checked_reverse_op = 1;
Tim Petersf4aca752004-09-23 02:39:37 +0000553 res = (*f)(w, v, _Py_SwappedOp[op]);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000554 if (res != Py_NotImplemented)
555 return res;
556 Py_DECREF(res);
557 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000558 if ((f = v->ob_type->tp_richcompare) != NULL) {
Guido van Rossume797ec12001-01-17 15:24:28 +0000559 res = (*f)(v, w, op);
560 if (res != Py_NotImplemented)
561 return res;
562 Py_DECREF(res);
563 }
Mark Dickinson6f1d0492009-11-15 13:58:49 +0000564 if (!checked_reverse_op && (f = w->ob_type->tp_richcompare) != NULL) {
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000565 res = (*f)(w, v, _Py_SwappedOp[op]);
566 if (res != Py_NotImplemented)
567 return res;
568 Py_DECREF(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000569 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000570 /* If neither object implements it, provide a sensible default
571 for == and !=, but raise an exception for ordering. */
572 switch (op) {
573 case Py_EQ:
574 res = (v == w) ? Py_True : Py_False;
575 break;
576 case Py_NE:
577 res = (v != w) ? Py_True : Py_False;
578 break;
579 default:
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000580 /* XXX Special-case None so it doesn't show as NoneType() */
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000581 PyErr_Format(PyExc_TypeError,
582 "unorderable types: %.100s() %s %.100s()",
583 v->ob_type->tp_name,
584 opstrings[op],
585 w->ob_type->tp_name);
586 return NULL;
587 }
Guido van Rossume797ec12001-01-17 15:24:28 +0000588 Py_INCREF(res);
589 return res;
590}
591
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000592/* Perform a rich comparison with object result. This wraps do_richcompare()
593 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000594
Guido van Rossume797ec12001-01-17 15:24:28 +0000595PyObject *
596PyObject_RichCompare(PyObject *v, PyObject *w, int op)
597{
598 PyObject *res;
599
600 assert(Py_LT <= op && op <= Py_GE);
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000601 if (v == NULL || w == NULL) {
602 if (!PyErr_Occurred())
603 PyErr_BadInternalCall();
604 return NULL;
605 }
Armin Rigo2b3eb402003-10-28 12:05:48 +0000606 if (Py_EnterRecursiveCall(" in cmp"))
607 return NULL;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000608 res = do_richcompare(v, w, op);
Armin Rigo2b3eb402003-10-28 12:05:48 +0000609 Py_LeaveRecursiveCall();
Guido van Rossume797ec12001-01-17 15:24:28 +0000610 return res;
611}
612
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000613/* Perform a rich comparison with integer result. This wraps
614 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000615int
616PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
617{
Raymond Hettinger93d44812004-03-21 17:01:44 +0000618 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000619 int ok;
620
Mark Dickinson4a1f5932008-11-12 23:23:36 +0000621 /* Quick result when objects are the same.
622 Guarantees that identity implies equality. */
623 if (v == w) {
624 if (op == Py_EQ)
625 return 1;
626 else if (op == Py_NE)
627 return 0;
628 }
629
Raymond Hettinger93d44812004-03-21 17:01:44 +0000630 res = PyObject_RichCompare(v, w, op);
Guido van Rossume797ec12001-01-17 15:24:28 +0000631 if (res == NULL)
632 return -1;
Guido van Rossum81912d42002-08-24 05:33:28 +0000633 if (PyBool_Check(res))
634 ok = (res == Py_True);
635 else
636 ok = PyObject_IsTrue(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000637 Py_DECREF(res);
638 return ok;
639}
Fred Drake13634cf2000-06-29 19:17:04 +0000640
641/* Set of hash utility functions to help maintaining the invariant that
Raymond Hettinger8183fa42004-03-21 17:35:06 +0000642 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000643
644 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
645*/
646
647long
Fred Drake100814d2000-07-09 15:48:49 +0000648_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000649{
Tim Peters39dce292000-08-15 03:34:48 +0000650 double intpart, fractpart;
651 int expo;
652 long hipart;
653 long x; /* the final hash value */
654 /* This is designed so that Python numbers of different types
655 * that compare equal hash to the same value; otherwise comparisons
656 * of mapping keys will turn out weird.
657 */
658
Tim Peters39dce292000-08-15 03:34:48 +0000659 fractpart = modf(v, &intpart);
Tim Peters39dce292000-08-15 03:34:48 +0000660 if (fractpart == 0.0) {
661 /* This must return the same hash as an equal int or long. */
Mark Dickinsonc96db472009-02-08 15:09:21 +0000662 if (intpart > LONG_MAX/2 || -intpart > LONG_MAX/2) {
Tim Peters39dce292000-08-15 03:34:48 +0000663 /* Convert to long and use its hash. */
664 PyObject *plong; /* converted to Python long */
665 if (Py_IS_INFINITY(intpart))
666 /* can't convert to long int -- arbitrary */
667 v = v < 0 ? -271828.0 : 314159.0;
668 plong = PyLong_FromDouble(v);
669 if (plong == NULL)
670 return -1;
671 x = PyObject_Hash(plong);
672 Py_DECREF(plong);
673 return x;
674 }
675 /* Fits in a C long == a Python int, so is its own hash. */
676 x = (long)intpart;
677 if (x == -1)
678 x = -2;
679 return x;
680 }
681 /* The fractional part is non-zero, so we don't have to worry about
682 * making this match the hash of some other type.
683 * Use frexp to get at the bits in the double.
Fred Drake13634cf2000-06-29 19:17:04 +0000684 * Since the VAX D double format has 56 mantissa bits, which is the
685 * most of any double format in use, each of these parts may have as
686 * many as (but no more than) 56 significant bits.
Tim Peters39dce292000-08-15 03:34:48 +0000687 * So, assuming sizeof(long) >= 4, each part can be broken into two
688 * longs; frexp and multiplication are used to do that.
689 * Also, since the Cray double format has 15 exponent bits, which is
690 * the most of any double format in use, shifting the exponent field
691 * left by 15 won't overflow a long (again assuming sizeof(long) >= 4).
Fred Drake13634cf2000-06-29 19:17:04 +0000692 */
Tim Peters39dce292000-08-15 03:34:48 +0000693 v = frexp(v, &expo);
694 v *= 2147483648.0; /* 2**31 */
695 hipart = (long)v; /* take the top 32 bits */
696 v = (v - (double)hipart) * 2147483648.0; /* get the next 32 bits */
697 x = hipart + (long)v + (expo << 15);
698 if (x == -1)
699 x = -2;
700 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000701}
702
703long
Fred Drake100814d2000-07-09 15:48:49 +0000704_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000705{
Fred Drake13634cf2000-06-29 19:17:04 +0000706 long x;
Antoine Pitrou79eee6b2009-02-13 14:01:05 +0000707 size_t y = (size_t)p;
708 /* bottom 3 or 4 bits are likely to be 0; rotate y by 4 to avoid
709 excessive hash collisions for dicts and sets */
710 y = (y >> 4) | (y << (8 * SIZEOF_VOID_P - 4));
711 x = (long)y;
712 if (x == -1)
713 x = -2;
Fred Drake13634cf2000-06-29 19:17:04 +0000714 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000715}
716
Nick Coghland1abd252008-07-15 15:46:38 +0000717long
718PyObject_HashNotImplemented(PyObject *v)
719{
720 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
721 Py_TYPE(v)->tp_name);
722 return -1;
723}
Fred Drake13634cf2000-06-29 19:17:04 +0000724
Guido van Rossum9bfef441993-03-29 10:43:31 +0000725long
Fred Drake100814d2000-07-09 15:48:49 +0000726PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000727{
Nick Coghland1abd252008-07-15 15:46:38 +0000728 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000729 if (tp->tp_hash != NULL)
730 return (*tp->tp_hash)(v);
Nick Coghlanf1f2f682008-12-30 07:29:12 +0000731 /* To keep to the general practice that inheriting
732 * solely from object in C code should work without
733 * an explicit call to PyType_Ready, we implicitly call
734 * PyType_Ready here and then check the tp_hash slot again
735 */
736 if (tp->tp_dict == NULL) {
737 if (PyType_Ready(tp) < 0)
738 return -1;
739 if (tp->tp_hash != NULL)
740 return (*tp->tp_hash)(v);
741 }
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000742 /* Otherwise, the object can't be hashed */
Nick Coghland1abd252008-07-15 15:46:38 +0000743 return PyObject_HashNotImplemented(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000744}
745
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000746PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000747PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000748{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000749 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000750
Christian Heimes90aa7642007-12-19 02:45:37 +0000751 if (Py_TYPE(v)->tp_getattr != NULL)
752 return (*Py_TYPE(v)->tp_getattr)(v, (char*)name);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000753 w = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000754 if (w == NULL)
755 return NULL;
756 res = PyObject_GetAttr(v, w);
757 Py_XDECREF(w);
758 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000759}
760
761int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000762PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000763{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000764 PyObject *res = PyObject_GetAttrString(v, name);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000765 if (res != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000766 Py_DECREF(res);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000767 return 1;
768 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000769 PyErr_Clear();
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000770 return 0;
771}
772
773int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000774PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000775{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000776 PyObject *s;
777 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000778
Christian Heimes90aa7642007-12-19 02:45:37 +0000779 if (Py_TYPE(v)->tp_setattr != NULL)
780 return (*Py_TYPE(v)->tp_setattr)(v, (char*)name, w);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000781 s = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000782 if (s == NULL)
783 return -1;
784 res = PyObject_SetAttr(v, s, w);
785 Py_XDECREF(s);
786 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000787}
788
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000789PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000790PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000791{
Christian Heimes90aa7642007-12-19 02:45:37 +0000792 PyTypeObject *tp = Py_TYPE(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000793
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000794 if (!PyUnicode_Check(name)) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000795 PyErr_Format(PyExc_TypeError,
796 "attribute name must be string, not '%.200s'",
797 name->ob_type->tp_name);
798 return NULL;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000799 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000800 if (tp->tp_getattro != NULL)
801 return (*tp->tp_getattro)(v, name);
802 if (tp->tp_getattr != NULL)
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000803 return (*tp->tp_getattr)(v, _PyUnicode_AsString(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +0000804 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000805 "'%.50s' object has no attribute '%U'",
806 tp->tp_name, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000807 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000808}
809
810int
Fred Drake100814d2000-07-09 15:48:49 +0000811PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000812{
813 PyObject *res = PyObject_GetAttr(v, name);
814 if (res != NULL) {
815 Py_DECREF(res);
816 return 1;
817 }
818 PyErr_Clear();
819 return 0;
820}
821
822int
Fred Drake100814d2000-07-09 15:48:49 +0000823PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000824{
Christian Heimes90aa7642007-12-19 02:45:37 +0000825 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000826 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000827
Martin v. Löwis5b222132007-06-10 09:51:05 +0000828 if (!PyUnicode_Check(name)) {
829 PyErr_Format(PyExc_TypeError,
830 "attribute name must be string, not '%.200s'",
831 name->ob_type->tp_name);
832 return -1;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000833 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000834 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000835
Martin v. Löwis5b222132007-06-10 09:51:05 +0000836 PyUnicode_InternInPlace(&name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000837 if (tp->tp_setattro != NULL) {
838 err = (*tp->tp_setattro)(v, name, value);
839 Py_DECREF(name);
840 return err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000841 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000842 if (tp->tp_setattr != NULL) {
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000843 err = (*tp->tp_setattr)(v, _PyUnicode_AsString(name), value);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000844 Py_DECREF(name);
845 return err;
846 }
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000847 Py_DECREF(name);
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000848 assert(name->ob_refcnt >= 1);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000849 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
850 PyErr_Format(PyExc_TypeError,
851 "'%.100s' object has no attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000852 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000853 tp->tp_name,
854 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000855 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000856 else
857 PyErr_Format(PyExc_TypeError,
858 "'%.100s' object has only read-only attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000859 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000860 tp->tp_name,
861 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000862 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000863 return -1;
864}
865
866/* Helper to get a pointer to an object's __dict__ slot, if any */
867
868PyObject **
869_PyObject_GetDictPtr(PyObject *obj)
870{
Martin v. Löwis725507b2006-03-07 12:08:51 +0000871 Py_ssize_t dictoffset;
Christian Heimes90aa7642007-12-19 02:45:37 +0000872 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000873
Tim Peters6d6c1a32001-08-02 04:15:00 +0000874 dictoffset = tp->tp_dictoffset;
875 if (dictoffset == 0)
876 return NULL;
877 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000878 Py_ssize_t tsize;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000879 size_t size;
880
881 tsize = ((PyVarObject *)obj)->ob_size;
882 if (tsize < 0)
883 tsize = -tsize;
884 size = _PyObject_VAR_SIZE(tp, tsize);
885
Tim Peters6d483d32001-10-06 21:27:34 +0000886 dictoffset += (long)size;
887 assert(dictoffset > 0);
888 assert(dictoffset % SIZEOF_VOID_P == 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000889 }
890 return (PyObject **) ((char *)obj + dictoffset);
891}
892
Tim Peters6d6c1a32001-08-02 04:15:00 +0000893PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000894PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +0000895{
896 Py_INCREF(obj);
897 return obj;
898}
899
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +0000900/* Helper used when the __next__ method is removed from a type:
901 tp_iternext is never NULL and can be safely called without checking
902 on every iteration.
903 */
904
905PyObject *
906_PyObject_NextNotImplemented(PyObject *self)
907{
908 PyErr_Format(PyExc_TypeError,
909 "'%.200s' object is not iterable",
910 Py_TYPE(self)->tp_name);
911 return NULL;
912}
913
Michael W. Hudson1593f502004-09-14 17:09:47 +0000914/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
915
Raymond Hettinger01538262003-03-17 08:24:35 +0000916PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000917PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
918{
Christian Heimes90aa7642007-12-19 02:45:37 +0000919 PyTypeObject *tp = Py_TYPE(obj);
Guido van Rossum056fbf42002-08-19 19:22:50 +0000920 PyObject *descr = NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000921 PyObject *res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000922 descrgetfunc f;
Martin v. Löwis725507b2006-03-07 12:08:51 +0000923 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000924 PyObject **dictptr;
925
Martin v. Löwis5b222132007-06-10 09:51:05 +0000926 if (!PyUnicode_Check(name)){
927 PyErr_Format(PyExc_TypeError,
928 "attribute name must be string, not '%.200s'",
929 name->ob_type->tp_name);
930 return NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000931 }
932 else
933 Py_INCREF(name);
934
Tim Peters6d6c1a32001-08-02 04:15:00 +0000935 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +0000936 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000937 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000938 }
939
Christian Heimesa62da1d2008-01-12 19:39:10 +0000940#if 0 /* XXX this is not quite _PyType_Lookup anymore */
Guido van Rossum056fbf42002-08-19 19:22:50 +0000941 /* Inline _PyType_Lookup */
942 {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000943 Py_ssize_t i, n;
Guido van Rossum056fbf42002-08-19 19:22:50 +0000944 PyObject *mro, *base, *dict;
945
946 /* Look in tp_dict of types in MRO */
947 mro = tp->tp_mro;
948 assert(mro != NULL);
949 assert(PyTuple_Check(mro));
950 n = PyTuple_GET_SIZE(mro);
951 for (i = 0; i < n; i++) {
952 base = PyTuple_GET_ITEM(mro, i);
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000953 assert(PyType_Check(base));
954 dict = ((PyTypeObject *)base)->tp_dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +0000955 assert(dict && PyDict_Check(dict));
956 descr = PyDict_GetItem(dict, name);
957 if (descr != NULL)
958 break;
959 }
960 }
Christian Heimesa62da1d2008-01-12 19:39:10 +0000961#else
962 descr = _PyType_Lookup(tp, name);
963#endif
Guido van Rossum056fbf42002-08-19 19:22:50 +0000964
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000965 Py_XINCREF(descr);
966
Tim Peters6d6c1a32001-08-02 04:15:00 +0000967 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000968 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000969 f = descr->ob_type->tp_descr_get;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000970 if (f != NULL && PyDescr_IsData(descr)) {
971 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000972 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000973 goto done;
974 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000975 }
976
Guido van Rossumc66ff442002-08-19 16:50:48 +0000977 /* Inline _PyObject_GetDictPtr */
978 dictoffset = tp->tp_dictoffset;
979 if (dictoffset != 0) {
980 PyObject *dict;
981 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000982 Py_ssize_t tsize;
Guido van Rossumc66ff442002-08-19 16:50:48 +0000983 size_t size;
984
985 tsize = ((PyVarObject *)obj)->ob_size;
986 if (tsize < 0)
987 tsize = -tsize;
988 size = _PyObject_VAR_SIZE(tp, tsize);
989
990 dictoffset += (long)size;
991 assert(dictoffset > 0);
992 assert(dictoffset % SIZEOF_VOID_P == 0);
993 }
994 dictptr = (PyObject **) ((char *)obj + dictoffset);
995 dict = *dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000996 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +0000997 Py_INCREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000998 res = PyDict_GetItem(dict, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000999 if (res != NULL) {
1000 Py_INCREF(res);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001001 Py_XDECREF(descr);
Christian Heimes969fe572008-01-25 11:23:10 +00001002 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001003 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001004 }
Christian Heimes969fe572008-01-25 11:23:10 +00001005 Py_DECREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001006 }
1007 }
1008
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001009 if (f != NULL) {
Christian Heimes90aa7642007-12-19 02:45:37 +00001010 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001011 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001012 goto done;
1013 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001014
1015 if (descr != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001016 res = descr;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001017 /* descr was already increfed above */
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001018 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001019 }
1020
1021 PyErr_Format(PyExc_AttributeError,
1022 "'%.50s' object has no attribute '%.400s'",
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +00001023 tp->tp_name, _PyUnicode_AsString(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001024 done:
1025 Py_DECREF(name);
1026 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001027}
1028
1029int
1030PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1031{
Christian Heimes90aa7642007-12-19 02:45:37 +00001032 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001033 PyObject *descr;
1034 descrsetfunc f;
1035 PyObject **dictptr;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001036 int res = -1;
1037
Martin v. Löwis5b222132007-06-10 09:51:05 +00001038 if (!PyUnicode_Check(name)){
1039 PyErr_Format(PyExc_TypeError,
1040 "attribute name must be string, not '%.200s'",
1041 name->ob_type->tp_name);
1042 return -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001043 }
1044 else
1045 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001046
1047 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001048 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001049 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001050 }
1051
1052 descr = _PyType_Lookup(tp, name);
1053 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001054 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001055 f = descr->ob_type->tp_descr_set;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001056 if (f != NULL && PyDescr_IsData(descr)) {
1057 res = f(descr, obj, value);
1058 goto done;
1059 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001060 }
1061
1062 dictptr = _PyObject_GetDictPtr(obj);
1063 if (dictptr != NULL) {
1064 PyObject *dict = *dictptr;
1065 if (dict == NULL && value != NULL) {
1066 dict = PyDict_New();
1067 if (dict == NULL)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001068 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001069 *dictptr = dict;
1070 }
1071 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +00001072 Py_INCREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001073 if (value == NULL)
1074 res = PyDict_DelItem(dict, name);
1075 else
1076 res = PyDict_SetItem(dict, name, value);
1077 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1078 PyErr_SetObject(PyExc_AttributeError, name);
Christian Heimes969fe572008-01-25 11:23:10 +00001079 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001080 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001081 }
1082 }
1083
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001084 if (f != NULL) {
1085 res = f(descr, obj, value);
1086 goto done;
1087 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001088
1089 if (descr == NULL) {
1090 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001091 "'%.100s' object has no attribute '%U'",
1092 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001093 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001094 }
1095
1096 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001097 "'%.50s' object attribute '%U' is read-only",
1098 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001099 done:
1100 Py_DECREF(name);
1101 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001102}
1103
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001104/* Test a value used as condition, e.g., in a for or if statement.
1105 Return -1 if an error occurred */
1106
1107int
Fred Drake100814d2000-07-09 15:48:49 +00001108PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001109{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001110 Py_ssize_t res;
Guido van Rossum6248f442002-08-24 06:31:34 +00001111 if (v == Py_True)
1112 return 1;
1113 if (v == Py_False)
1114 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001115 if (v == Py_None)
Neal Norwitz51290d32002-06-13 21:32:44 +00001116 return 0;
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001117 else if (v->ob_type->tp_as_number != NULL &&
Jack Diederich4dafcc42006-11-28 19:15:13 +00001118 v->ob_type->tp_as_number->nb_bool != NULL)
1119 res = (*v->ob_type->tp_as_number->nb_bool)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001120 else if (v->ob_type->tp_as_mapping != NULL &&
1121 v->ob_type->tp_as_mapping->mp_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001122 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001123 else if (v->ob_type->tp_as_sequence != NULL &&
1124 v->ob_type->tp_as_sequence->sq_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001125 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1126 else
Neal Norwitz51290d32002-06-13 21:32:44 +00001127 return 1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001128 /* if it is negative, it should be either -1 or -2 */
1129 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001130}
1131
Tim Peters803526b2002-07-07 05:13:56 +00001132/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001133 Return -1 if an error occurred */
1134
1135int
Fred Drake100814d2000-07-09 15:48:49 +00001136PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001137{
1138 int res;
1139 res = PyObject_IsTrue(v);
1140 if (res < 0)
1141 return res;
1142 return res == 0;
1143}
1144
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001145/* Test whether an object can be called */
1146
1147int
Fred Drake100814d2000-07-09 15:48:49 +00001148PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001149{
1150 if (x == NULL)
1151 return 0;
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001152 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001153}
1154
Georg Brandle32b4222007-03-10 22:13:27 +00001155/* ------------------------- PyObject_Dir() helpers ------------------------- */
1156
Tim Peters7eea37e2001-09-04 22:08:56 +00001157/* Helper for PyObject_Dir.
1158 Merge the __dict__ of aclass into dict, and recursively also all
1159 the __dict__s of aclass's base classes. The order of merging isn't
1160 defined, as it's expected that only the final set of dict keys is
1161 interesting.
1162 Return 0 on success, -1 on error.
1163*/
1164
1165static int
1166merge_class_dict(PyObject* dict, PyObject* aclass)
1167{
1168 PyObject *classdict;
1169 PyObject *bases;
1170
1171 assert(PyDict_Check(dict));
1172 assert(aclass);
1173
1174 /* Merge in the type's dict (if any). */
1175 classdict = PyObject_GetAttrString(aclass, "__dict__");
1176 if (classdict == NULL)
1177 PyErr_Clear();
1178 else {
1179 int status = PyDict_Update(dict, classdict);
1180 Py_DECREF(classdict);
1181 if (status < 0)
1182 return -1;
1183 }
1184
1185 /* Recursively merge in the base types' (if any) dicts. */
1186 bases = PyObject_GetAttrString(aclass, "__bases__");
Tim Petersbc7e8632001-09-16 20:33:22 +00001187 if (bases == NULL)
1188 PyErr_Clear();
1189 else {
Guido van Rossum44022412002-05-13 18:29:46 +00001190 /* We have no guarantee that bases is a real tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001191 Py_ssize_t i, n;
Guido van Rossum44022412002-05-13 18:29:46 +00001192 n = PySequence_Size(bases); /* This better be right */
1193 if (n < 0)
1194 PyErr_Clear();
1195 else {
1196 for (i = 0; i < n; i++) {
Tim Peters18e70832003-02-05 19:35:19 +00001197 int status;
Guido van Rossum44022412002-05-13 18:29:46 +00001198 PyObject *base = PySequence_GetItem(bases, i);
1199 if (base == NULL) {
1200 Py_DECREF(bases);
1201 return -1;
1202 }
Tim Peters18e70832003-02-05 19:35:19 +00001203 status = merge_class_dict(dict, base);
1204 Py_DECREF(base);
1205 if (status < 0) {
Guido van Rossum44022412002-05-13 18:29:46 +00001206 Py_DECREF(bases);
1207 return -1;
1208 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001209 }
1210 }
1211 Py_DECREF(bases);
1212 }
1213 return 0;
1214}
1215
Georg Brandle32b4222007-03-10 22:13:27 +00001216/* Helper for PyObject_Dir without arguments: returns the local scope. */
1217static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001218_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001219{
Georg Brandled3b8382007-03-12 13:15:14 +00001220 PyObject *names;
Georg Brandle32b4222007-03-10 22:13:27 +00001221 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001222
Georg Brandle32b4222007-03-10 22:13:27 +00001223 if (locals == NULL) {
1224 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1225 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001226 }
1227
Georg Brandled3b8382007-03-12 13:15:14 +00001228 names = PyMapping_Keys(locals);
1229 if (!names)
1230 return NULL;
1231 if (!PyList_Check(names)) {
1232 PyErr_Format(PyExc_TypeError,
1233 "dir(): expected keys() of locals to be a list, "
Christian Heimes90aa7642007-12-19 02:45:37 +00001234 "not '%.200s'", Py_TYPE(names)->tp_name);
Georg Brandled3b8382007-03-12 13:15:14 +00001235 Py_DECREF(names);
1236 return NULL;
1237 }
Georg Brandle32b4222007-03-10 22:13:27 +00001238 /* the locals don't need to be DECREF'd */
Georg Brandled3b8382007-03-12 13:15:14 +00001239 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001240}
1241
1242/* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
Guido van Rossum98297ee2007-11-06 21:34:58 +00001243 We deliberately don't suck up its __class__, as methods belonging to the
1244 metaclass would probably be more confusing than helpful.
Georg Brandle32b4222007-03-10 22:13:27 +00001245*/
Guido van Rossum98297ee2007-11-06 21:34:58 +00001246static PyObject *
Georg Brandle32b4222007-03-10 22:13:27 +00001247_specialized_dir_type(PyObject *obj)
1248{
1249 PyObject *result = NULL;
1250 PyObject *dict = PyDict_New();
1251
1252 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1253 result = PyDict_Keys(dict);
1254
1255 Py_XDECREF(dict);
Tim Peters305b5852001-09-17 02:38:46 +00001256 return result;
1257}
1258
Georg Brandle32b4222007-03-10 22:13:27 +00001259/* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1260static PyObject *
1261_specialized_dir_module(PyObject *obj)
Tim Peters7eea37e2001-09-04 22:08:56 +00001262{
Georg Brandle32b4222007-03-10 22:13:27 +00001263 PyObject *result = NULL;
1264 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
Tim Peters7eea37e2001-09-04 22:08:56 +00001265
Georg Brandle32b4222007-03-10 22:13:27 +00001266 if (dict != NULL) {
1267 if (PyDict_Check(dict))
1268 result = PyDict_Keys(dict);
1269 else {
Benjamin Peterson14327712009-08-15 13:23:05 +00001270 const char *name = PyModule_GetName(obj);
1271 if (name)
1272 PyErr_Format(PyExc_TypeError,
1273 "%.200s.__dict__ is not a dictionary",
1274 name);
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001275 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001276 }
1277
Georg Brandle32b4222007-03-10 22:13:27 +00001278 Py_XDECREF(dict);
1279 return result;
1280}
Tim Peters7eea37e2001-09-04 22:08:56 +00001281
Georg Brandle32b4222007-03-10 22:13:27 +00001282/* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1283 and recursively up the __class__.__bases__ chain.
1284*/
1285static PyObject *
1286_generic_dir(PyObject *obj)
1287{
1288 PyObject *result = NULL;
1289 PyObject *dict = NULL;
1290 PyObject *itsclass = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001291
Georg Brandle32b4222007-03-10 22:13:27 +00001292 /* Get __dict__ (which may or may not be a real dict...) */
1293 dict = PyObject_GetAttrString(obj, "__dict__");
1294 if (dict == NULL) {
1295 PyErr_Clear();
1296 dict = PyDict_New();
1297 }
1298 else if (!PyDict_Check(dict)) {
1299 Py_DECREF(dict);
1300 dict = PyDict_New();
1301 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001302 else {
Georg Brandle32b4222007-03-10 22:13:27 +00001303 /* Copy __dict__ to avoid mutating it. */
1304 PyObject *temp = PyDict_Copy(dict);
1305 Py_DECREF(dict);
1306 dict = temp;
Tim Peters7eea37e2001-09-04 22:08:56 +00001307 }
1308
Georg Brandle32b4222007-03-10 22:13:27 +00001309 if (dict == NULL)
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001310 goto error;
Tim Peters7eea37e2001-09-04 22:08:56 +00001311
Georg Brandle32b4222007-03-10 22:13:27 +00001312 /* Merge in attrs reachable from its class. */
1313 itsclass = PyObject_GetAttrString(obj, "__class__");
1314 if (itsclass == NULL)
1315 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1316 __class__ exists? */
1317 PyErr_Clear();
1318 else {
1319 if (merge_class_dict(dict, itsclass) != 0)
1320 goto error;
1321 }
1322
1323 result = PyDict_Keys(dict);
Tim Peters7eea37e2001-09-04 22:08:56 +00001324 /* fall through */
Georg Brandle32b4222007-03-10 22:13:27 +00001325error:
1326 Py_XDECREF(itsclass);
1327 Py_XDECREF(dict);
1328 return result;
1329}
1330
1331/* Helper for PyObject_Dir: object introspection.
1332 This calls one of the above specialized versions if no __dir__ method
1333 exists. */
1334static PyObject *
1335_dir_object(PyObject *obj)
1336{
1337 PyObject * result = NULL;
1338 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1339 "__dir__");
1340
1341 assert(obj);
1342 if (dirfunc == NULL) {
1343 /* use default implementation */
1344 PyErr_Clear();
1345 if (PyModule_Check(obj))
1346 result = _specialized_dir_module(obj);
1347 else if (PyType_Check(obj))
1348 result = _specialized_dir_type(obj);
1349 else
1350 result = _generic_dir(obj);
1351 }
1352 else {
1353 /* use __dir__ */
1354 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1355 Py_DECREF(dirfunc);
1356 if (result == NULL)
1357 return NULL;
1358
1359 /* result must be a list */
1360 /* XXX(gbrandl): could also check if all items are strings */
1361 if (!PyList_Check(result)) {
1362 PyErr_Format(PyExc_TypeError,
1363 "__dir__() must return a list, not %.200s",
Christian Heimes90aa7642007-12-19 02:45:37 +00001364 Py_TYPE(result)->tp_name);
Georg Brandle32b4222007-03-10 22:13:27 +00001365 Py_DECREF(result);
1366 result = NULL;
1367 }
1368 }
1369
1370 return result;
1371}
1372
1373/* Implementation of dir() -- if obj is NULL, returns the names in the current
1374 (local) scope. Otherwise, performs introspection of the object: returns a
1375 sorted list of attribute names (supposedly) accessible from the object
1376*/
1377PyObject *
1378PyObject_Dir(PyObject *obj)
1379{
1380 PyObject * result;
1381
1382 if (obj == NULL)
1383 /* no object -- introspect the locals */
1384 result = _dir_locals();
1385 else
1386 /* object -- introspect the object */
1387 result = _dir_object(obj);
1388
1389 assert(result == NULL || PyList_Check(result));
1390
1391 if (result != NULL && PyList_Sort(result) != 0) {
1392 /* sorting the list failed */
1393 Py_DECREF(result);
1394 result = NULL;
1395 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001396
Tim Peters7eea37e2001-09-04 22:08:56 +00001397 return result;
1398}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001399
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001400/*
1401NoObject is usable as a non-NULL undefined value, used by the macro None.
1402There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001403so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001404(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001405*/
1406
Guido van Rossum0c182a11992-03-27 17:26:13 +00001407/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001408static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001409none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001410{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001411 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001412}
1413
Barry Warsaw9bf16442001-01-23 16:24:35 +00001414/* ARGUSED */
1415static void
Tim Peters803526b2002-07-07 05:13:56 +00001416none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001417{
1418 /* This should never get called, but we also don't want to SEGV if
Mark Dickinson934896d2009-02-21 20:59:32 +00001419 * we accidentally decref None out of existence.
Barry Warsaw9bf16442001-01-23 16:24:35 +00001420 */
Martin v. Löwis3f19b102002-08-07 16:21:51 +00001421 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001422}
1423
1424
Guido van Rossumba21a492001-08-16 08:17:26 +00001425static PyTypeObject PyNone_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001426 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001427 "NoneType",
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001428 0,
1429 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001430 none_dealloc, /*tp_dealloc*/ /*never called*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001431 0, /*tp_print*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001432 0, /*tp_getattr*/
1433 0, /*tp_setattr*/
Mark Dickinsone94c6792009-02-02 20:36:42 +00001434 0, /*tp_reserved*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001435 none_repr, /*tp_repr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001436 0, /*tp_as_number*/
1437 0, /*tp_as_sequence*/
1438 0, /*tp_as_mapping*/
Guido van Rossum9bfef441993-03-29 10:43:31 +00001439 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001440};
1441
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001442PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001443 _PyObject_EXTRA_INIT
1444 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001445};
1446
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001447/* NotImplemented is an object that can be used to signal that an
1448 operation is not implemented for the given type combination. */
1449
1450static PyObject *
1451NotImplemented_repr(PyObject *op)
1452{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001453 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001454}
1455
1456static PyTypeObject PyNotImplemented_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001457 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001458 "NotImplementedType",
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001459 0,
1460 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001461 none_dealloc, /*tp_dealloc*/ /*never called*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001462 0, /*tp_print*/
1463 0, /*tp_getattr*/
1464 0, /*tp_setattr*/
Mark Dickinsone94c6792009-02-02 20:36:42 +00001465 0, /*tp_reserved*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001466 NotImplemented_repr, /*tp_repr*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001467 0, /*tp_as_number*/
1468 0, /*tp_as_sequence*/
1469 0, /*tp_as_mapping*/
1470 0, /*tp_hash */
1471};
1472
1473PyObject _Py_NotImplementedStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001474 _PyObject_EXTRA_INIT
1475 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001476};
1477
Guido van Rossumba21a492001-08-16 08:17:26 +00001478void
1479_Py_ReadyTypes(void)
1480{
1481 if (PyType_Ready(&PyType_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001482 Py_FatalError("Can't initialize type type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001483
Fred Drake0a4dd392004-07-02 18:57:45 +00001484 if (PyType_Ready(&_PyWeakref_RefType) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001485 Py_FatalError("Can't initialize weakref type");
Fred Drake0a4dd392004-07-02 18:57:45 +00001486
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001487 if (PyType_Ready(&_PyWeakref_CallableProxyType) < 0)
1488 Py_FatalError("Can't initialize callable weakref proxy type");
1489
1490 if (PyType_Ready(&_PyWeakref_ProxyType) < 0)
1491 Py_FatalError("Can't initialize weakref proxy type");
1492
Guido van Rossum77f6a652002-04-03 22:41:51 +00001493 if (PyType_Ready(&PyBool_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001494 Py_FatalError("Can't initialize bool type");
Guido van Rossum77f6a652002-04-03 22:41:51 +00001495
Christian Heimes9c4756e2008-05-26 13:22:05 +00001496 if (PyType_Ready(&PyByteArray_Type) < 0)
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001497 Py_FatalError("Can't initialize bytearray type");
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001498
Christian Heimes72b710a2008-05-26 13:28:38 +00001499 if (PyType_Ready(&PyBytes_Type) < 0)
Guido van Rossumcacfc072002-05-24 19:01:59 +00001500 Py_FatalError("Can't initialize 'str'");
1501
Guido van Rossumba21a492001-08-16 08:17:26 +00001502 if (PyType_Ready(&PyList_Type) < 0)
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001503 Py_FatalError("Can't initialize list type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001504
1505 if (PyType_Ready(&PyNone_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001506 Py_FatalError("Can't initialize None type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001507
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001508 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1509 Py_FatalError("Can't initialize type(Ellipsis)");
1510
Guido van Rossumba21a492001-08-16 08:17:26 +00001511 if (PyType_Ready(&PyNotImplemented_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001512 Py_FatalError("Can't initialize NotImplemented type");
1513
1514 if (PyType_Ready(&PyTraceBack_Type) < 0)
1515 Py_FatalError("Can't initialize traceback type");
1516
1517 if (PyType_Ready(&PySuper_Type) < 0)
1518 Py_FatalError("Can't initialize super type");
1519
1520 if (PyType_Ready(&PyBaseObject_Type) < 0)
1521 Py_FatalError("Can't initialize object type");
1522
1523 if (PyType_Ready(&PyRange_Type) < 0)
1524 Py_FatalError("Can't initialize range type");
1525
1526 if (PyType_Ready(&PyDict_Type) < 0)
1527 Py_FatalError("Can't initialize dict type");
1528
1529 if (PyType_Ready(&PySet_Type) < 0)
1530 Py_FatalError("Can't initialize set type");
1531
1532 if (PyType_Ready(&PyUnicode_Type) < 0)
1533 Py_FatalError("Can't initialize str type");
1534
1535 if (PyType_Ready(&PySlice_Type) < 0)
1536 Py_FatalError("Can't initialize slice type");
1537
1538 if (PyType_Ready(&PyStaticMethod_Type) < 0)
1539 Py_FatalError("Can't initialize static method type");
1540
1541 if (PyType_Ready(&PyComplex_Type) < 0)
1542 Py_FatalError("Can't initialize complex type");
Skip Montanaroba1e0f42009-10-18 14:25:35 +00001543
Benjamin Petersonae937c02009-04-18 20:54:08 +00001544 if (PyType_Ready(&PyFloat_Type) < 0)
1545 Py_FatalError("Can't initialize float type");
1546
1547 if (PyType_Ready(&PyLong_Type) < 0)
1548 Py_FatalError("Can't initialize int type");
1549
1550 if (PyType_Ready(&PyFrozenSet_Type) < 0)
1551 Py_FatalError("Can't initialize frozenset type");
1552
1553 if (PyType_Ready(&PyProperty_Type) < 0)
1554 Py_FatalError("Can't initialize property type");
1555
1556 if (PyType_Ready(&PyMemoryView_Type) < 0)
1557 Py_FatalError("Can't initialize memoryview type");
1558
1559 if (PyType_Ready(&PyTuple_Type) < 0)
1560 Py_FatalError("Can't initialize tuple type");
1561
1562 if (PyType_Ready(&PyEnum_Type) < 0)
1563 Py_FatalError("Can't initialize enumerate type");
1564
1565 if (PyType_Ready(&PyReversed_Type) < 0)
1566 Py_FatalError("Can't initialize reversed type");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001567
Guido van Rossum826d8972007-10-30 18:34:07 +00001568 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1569 Py_FatalError("Can't initialize StdPrinter");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001570
1571 if (PyType_Ready(&PyCode_Type) < 0)
1572 Py_FatalError("Can't initialize code type");
1573
1574 if (PyType_Ready(&PyFrame_Type) < 0)
1575 Py_FatalError("Can't initialize frame type");
1576
1577 if (PyType_Ready(&PyCFunction_Type) < 0)
1578 Py_FatalError("Can't initialize builtin function type");
1579
1580 if (PyType_Ready(&PyMethod_Type) < 0)
1581 Py_FatalError("Can't initialize method type");
1582
1583 if (PyType_Ready(&PyFunction_Type) < 0)
1584 Py_FatalError("Can't initialize function type");
1585
1586 if (PyType_Ready(&PyDictProxy_Type) < 0)
1587 Py_FatalError("Can't initialize dict proxy type");
1588
1589 if (PyType_Ready(&PyGen_Type) < 0)
1590 Py_FatalError("Can't initialize generator type");
1591
1592 if (PyType_Ready(&PyGetSetDescr_Type) < 0)
1593 Py_FatalError("Can't initialize get-set descriptor type");
1594
1595 if (PyType_Ready(&PyWrapperDescr_Type) < 0)
1596 Py_FatalError("Can't initialize wrapper type");
1597
1598 if (PyType_Ready(&PyEllipsis_Type) < 0)
1599 Py_FatalError("Can't initialize ellipsis type");
1600
1601 if (PyType_Ready(&PyMemberDescr_Type) < 0)
1602 Py_FatalError("Can't initialize member descriptor type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001603
1604 if (PyType_Ready(&PyFilter_Type) < 0)
1605 Py_FatalError("Can't initialize filter type");
1606
1607 if (PyType_Ready(&PyMap_Type) < 0)
1608 Py_FatalError("Can't initialize map type");
1609
1610 if (PyType_Ready(&PyZip_Type) < 0)
1611 Py_FatalError("Can't initialize zip type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001612}
1613
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001614
Guido van Rossum84a90321996-05-22 16:34:47 +00001615#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001616
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001617void
Fred Drake100814d2000-07-09 15:48:49 +00001618_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001619{
Tim Peters34592512002-07-11 06:23:50 +00001620 _Py_INC_REFTOTAL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001621 op->ob_refcnt = 1;
Tim Peters7571a0f2003-03-23 17:52:28 +00001622 _Py_AddToAllObjects(op, 1);
Tim Peters34592512002-07-11 06:23:50 +00001623 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001624}
1625
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001626void
Fred Drake100814d2000-07-09 15:48:49 +00001627_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001628{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001629#ifdef SLOW_UNREF_CHECK
Guido van Rossum4c08d552000-03-10 22:55:18 +00001630 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001631#endif
Guido van Rossumd7047b31995-01-02 19:07:15 +00001632 if (op->ob_refcnt < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001633 Py_FatalError("UNREF negative refcnt");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001634 if (op == &refchain ||
Christian Heimesc8967002007-11-30 10:18:26 +00001635 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1636 fprintf(stderr, "* ob\n");
1637 _PyObject_Dump(op);
1638 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1639 _PyObject_Dump(op->_ob_prev->_ob_next);
1640 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1641 _PyObject_Dump(op->_ob_next->_ob_prev);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001642 Py_FatalError("UNREF invalid object");
Christian Heimesc8967002007-11-30 10:18:26 +00001643 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001644#ifdef SLOW_UNREF_CHECK
Guido van Rossum3f5da241990-12-20 15:06:42 +00001645 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1646 if (p == op)
1647 break;
1648 }
Guido van Rossumd7047b31995-01-02 19:07:15 +00001649 if (p == &refchain) /* Not found */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001650 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001651#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001652 op->_ob_next->_ob_prev = op->_ob_prev;
1653 op->_ob_prev->_ob_next = op->_ob_next;
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001654 op->_ob_next = op->_ob_prev = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001655 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001656}
1657
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001658void
Fred Drake100814d2000-07-09 15:48:49 +00001659_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001660{
Christian Heimes90aa7642007-12-19 02:45:37 +00001661 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001662 _Py_ForgetReference(op);
Guido van Rossum9776adf1994-09-07 14:36:45 +00001663 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001664}
1665
Tim Peters269b2a62003-04-17 19:52:29 +00001666/* Print all live objects. Because PyObject_Print is called, the
1667 * interpreter must be in a healthy state.
1668 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001669void
Fred Drake100814d2000-07-09 15:48:49 +00001670_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001671{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001672 PyObject *op;
Guido van Rossume09fb551997-08-05 02:04:34 +00001673 fprintf(fp, "Remaining objects:\n");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001674 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001675 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001676 if (PyObject_Print(op, fp, 0) != 0)
1677 PyErr_Clear();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001678 putc('\n', fp);
1679 }
1680}
1681
Tim Peters269b2a62003-04-17 19:52:29 +00001682/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1683 * doesn't make any calls to the Python C API, so is always safe to call.
1684 */
1685void
1686_Py_PrintReferenceAddresses(FILE *fp)
1687{
1688 PyObject *op;
1689 fprintf(fp, "Remaining object addresses:\n");
1690 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001691 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
Christian Heimes90aa7642007-12-19 02:45:37 +00001692 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001693}
1694
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001695PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001696_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001697{
1698 int i, n;
1699 PyObject *t = NULL;
1700 PyObject *res, *op;
1701
1702 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1703 return NULL;
1704 op = refchain._ob_next;
1705 res = PyList_New(0);
1706 if (res == NULL)
1707 return NULL;
1708 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1709 while (op == self || op == args || op == res || op == t ||
Christian Heimes90aa7642007-12-19 02:45:37 +00001710 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001711 op = op->_ob_next;
1712 if (op == &refchain)
1713 return res;
1714 }
1715 if (PyList_Append(res, op) < 0) {
1716 Py_DECREF(res);
1717 return NULL;
1718 }
1719 op = op->_ob_next;
1720 }
1721 return res;
1722}
1723
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001724#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001725
Guido van Rossum84a90321996-05-22 16:34:47 +00001726
Benjamin Petersonb173f782009-05-05 22:31:58 +00001727/* Hack to force loading of pycapsule.o */
1728PyTypeObject *_PyCapsule_hack = &PyCapsule_Type;
1729
1730
Guido van Rossum84a90321996-05-22 16:34:47 +00001731/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001732Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001733
1734
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001735/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001736
Thomas Wouters334fb892000-07-25 12:56:38 +00001737void *
Fred Drake100814d2000-07-09 15:48:49 +00001738PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001739{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001740 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001741}
1742
Thomas Wouters334fb892000-07-25 12:56:38 +00001743void *
1744PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001745{
Tim Petersaf3e8de2002-04-12 07:22:56 +00001746 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001747}
1748
1749void
Thomas Wouters334fb892000-07-25 12:56:38 +00001750PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001751{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001752 PyMem_FREE(p);
1753}
1754
1755
Guido van Rossum86610361998-04-10 22:32:46 +00001756/* These methods are used to control infinite recursion in repr, str, print,
1757 etc. Container objects that may recursively contain themselves,
1758 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1759 Py_ReprLeave() to avoid infinite recursion.
1760
1761 Py_ReprEnter() returns 0 the first time it is called for a particular
1762 object and 1 every time thereafter. It returns -1 if an exception
1763 occurred. Py_ReprLeave() has no return value.
1764
1765 See dictobject.c and listobject.c for examples of use.
1766*/
1767
1768#define KEY "Py_Repr"
1769
1770int
Fred Drake100814d2000-07-09 15:48:49 +00001771Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001772{
1773 PyObject *dict;
1774 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001775 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001776
1777 dict = PyThreadState_GetDict();
1778 if (dict == NULL)
Guido van Rossum0fc8f002003-04-15 15:12:39 +00001779 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001780 list = PyDict_GetItemString(dict, KEY);
1781 if (list == NULL) {
1782 list = PyList_New(0);
1783 if (list == NULL)
1784 return -1;
1785 if (PyDict_SetItemString(dict, KEY, list) < 0)
1786 return -1;
1787 Py_DECREF(list);
1788 }
1789 i = PyList_GET_SIZE(list);
1790 while (--i >= 0) {
1791 if (PyList_GET_ITEM(list, i) == obj)
1792 return 1;
1793 }
1794 PyList_Append(list, obj);
1795 return 0;
1796}
1797
1798void
Fred Drake100814d2000-07-09 15:48:49 +00001799Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001800{
1801 PyObject *dict;
1802 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001803 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001804
1805 dict = PyThreadState_GetDict();
Guido van Rossumeb909461998-04-11 15:17:34 +00001806 if (dict == NULL)
1807 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001808 list = PyDict_GetItemString(dict, KEY);
Guido van Rossumeb909461998-04-11 15:17:34 +00001809 if (list == NULL || !PyList_Check(list))
1810 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001811 i = PyList_GET_SIZE(list);
1812 /* Count backwards because we always expect obj to be list[-1] */
1813 while (--i >= 0) {
1814 if (PyList_GET_ITEM(list, i) == obj) {
1815 PyList_SetSlice(list, i, i + 1, NULL);
1816 break;
1817 }
1818 }
1819}
Guido van Rossumd724b232000-03-13 16:01:29 +00001820
Tim Peters803526b2002-07-07 05:13:56 +00001821/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001822
Tim Peters803526b2002-07-07 05:13:56 +00001823/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001824int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001825
Tim Peters803526b2002-07-07 05:13:56 +00001826/* List of objects that still need to be cleaned up, singly linked via their
1827 * gc headers' gc_prev pointers.
1828 */
1829PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001830
Tim Peters803526b2002-07-07 05:13:56 +00001831/* Add op to the _PyTrash_delete_later list. Called when the current
1832 * call-stack depth gets large. op must be a currently untracked gc'ed
1833 * object, with refcount 0. Py_DECREF must already have been called on it.
1834 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001835void
Fred Drake100814d2000-07-09 15:48:49 +00001836_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001837{
Tim Peters803526b2002-07-07 05:13:56 +00001838 assert(PyObject_IS_GC(op));
1839 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1840 assert(op->ob_refcnt == 0);
Neil Schemenauerf589c052002-03-29 03:05:54 +00001841 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
Guido van Rossume92e6102000-04-24 15:40:53 +00001842 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001843}
1844
Tim Peters803526b2002-07-07 05:13:56 +00001845/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1846 * the call-stack unwinds again.
1847 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001848void
Fred Drake100814d2000-07-09 15:48:49 +00001849_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001850{
1851 while (_PyTrash_delete_later) {
Tim Peters803526b2002-07-07 05:13:56 +00001852 PyObject *op = _PyTrash_delete_later;
Christian Heimes90aa7642007-12-19 02:45:37 +00001853 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001854
Neil Schemenauerf589c052002-03-29 03:05:54 +00001855 _PyTrash_delete_later =
Tim Peters803526b2002-07-07 05:13:56 +00001856 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001857
Tim Peters803526b2002-07-07 05:13:56 +00001858 /* Call the deallocator directly. This used to try to
1859 * fool Py_DECREF into calling it indirectly, but
1860 * Py_DECREF was already called on this object, and in
1861 * assorted non-release builds calling Py_DECREF again ends
1862 * up distorting allocation statistics.
1863 */
1864 assert(op->ob_refcnt == 0);
Guido van Rossumd724b232000-03-13 16:01:29 +00001865 ++_PyTrash_delete_nesting;
Tim Peters803526b2002-07-07 05:13:56 +00001866 (*dealloc)(op);
Guido van Rossumd724b232000-03-13 16:01:29 +00001867 --_PyTrash_delete_nesting;
1868 }
1869}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001870
1871#ifdef __cplusplus
1872}
1873#endif