blob: 9544b9ac08779e8d71aa7a9f94bfd95bfa34f5a6 [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 Petersonc15a0732008-08-26 16:46:47 +0000500 return PyBytes_FromObject(v);
501}
502
Mark Dickinsonc008a172009-02-01 13:59:22 +0000503/* For Python 3.0.1 and later, the old three-way comparison has been
504 completely removed in favour of rich comparisons. PyObject_Compare() and
505 PyObject_Cmp() are gone, and the builtin cmp function no longer exists.
Mark Dickinsone94c6792009-02-02 20:36:42 +0000506 The old tp_compare slot has been renamed to tp_reserved, and should no
Mark Dickinsonc008a172009-02-01 13:59:22 +0000507 longer be used. Use tp_richcompare instead.
Guido van Rossum98297ee2007-11-06 21:34:58 +0000508
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000509 See (*) below for practical amendments.
510
Mark Dickinsonc008a172009-02-01 13:59:22 +0000511 tp_richcompare gets called with a first argument of the appropriate type
512 and a second object of an arbitrary type. We never do any kind of
513 coercion.
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000514
Mark Dickinsonc008a172009-02-01 13:59:22 +0000515 The tp_richcompare slot should return an object, as follows:
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000516
517 NULL if an exception occurred
518 NotImplemented if the requested comparison is not implemented
519 any other false value if the requested comparison is false
520 any other true value if the requested comparison is true
521
522 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
523 NotImplemented.
524
525 (*) Practical amendments:
526
527 - If rich comparison returns NotImplemented, == and != are decided by
528 comparing the object pointer (i.e. falling back to the base object
529 implementation).
530
Guido van Rossuma4073002002-05-31 20:03:54 +0000531*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000532
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000533/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000534int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000535
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000536static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000537
538/* Perform a rich comparison, raising TypeError when the requested comparison
539 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000540static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000541do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000542{
543 richcmpfunc f;
544 PyObject *res;
545
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000546 if (v->ob_type != w->ob_type &&
547 PyType_IsSubtype(w->ob_type, v->ob_type) &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000548 (f = w->ob_type->tp_richcompare) != NULL) {
Tim Petersf4aca752004-09-23 02:39:37 +0000549 res = (*f)(w, v, _Py_SwappedOp[op]);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000550 if (res != Py_NotImplemented)
551 return res;
552 Py_DECREF(res);
553 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000554 if ((f = v->ob_type->tp_richcompare) != NULL) {
Guido van Rossume797ec12001-01-17 15:24:28 +0000555 res = (*f)(v, w, op);
556 if (res != Py_NotImplemented)
557 return res;
558 Py_DECREF(res);
559 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000560 if ((f = w->ob_type->tp_richcompare) != NULL) {
561 res = (*f)(w, v, _Py_SwappedOp[op]);
562 if (res != Py_NotImplemented)
563 return res;
564 Py_DECREF(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000565 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000566 /* If neither object implements it, provide a sensible default
567 for == and !=, but raise an exception for ordering. */
568 switch (op) {
569 case Py_EQ:
570 res = (v == w) ? Py_True : Py_False;
571 break;
572 case Py_NE:
573 res = (v != w) ? Py_True : Py_False;
574 break;
575 default:
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000576 /* XXX Special-case None so it doesn't show as NoneType() */
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000577 PyErr_Format(PyExc_TypeError,
578 "unorderable types: %.100s() %s %.100s()",
579 v->ob_type->tp_name,
580 opstrings[op],
581 w->ob_type->tp_name);
582 return NULL;
583 }
Guido van Rossume797ec12001-01-17 15:24:28 +0000584 Py_INCREF(res);
585 return res;
586}
587
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000588/* Perform a rich comparison with object result. This wraps do_richcompare()
589 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000590
Guido van Rossume797ec12001-01-17 15:24:28 +0000591PyObject *
592PyObject_RichCompare(PyObject *v, PyObject *w, int op)
593{
594 PyObject *res;
595
596 assert(Py_LT <= op && op <= Py_GE);
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000597 if (v == NULL || w == NULL) {
598 if (!PyErr_Occurred())
599 PyErr_BadInternalCall();
600 return NULL;
601 }
Armin Rigo2b3eb402003-10-28 12:05:48 +0000602 if (Py_EnterRecursiveCall(" in cmp"))
603 return NULL;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000604 res = do_richcompare(v, w, op);
Armin Rigo2b3eb402003-10-28 12:05:48 +0000605 Py_LeaveRecursiveCall();
Guido van Rossume797ec12001-01-17 15:24:28 +0000606 return res;
607}
608
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000609/* Perform a rich comparison with integer result. This wraps
610 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000611int
612PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
613{
Raymond Hettinger93d44812004-03-21 17:01:44 +0000614 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000615 int ok;
616
Mark Dickinson4a1f5932008-11-12 23:23:36 +0000617 /* Quick result when objects are the same.
618 Guarantees that identity implies equality. */
619 if (v == w) {
620 if (op == Py_EQ)
621 return 1;
622 else if (op == Py_NE)
623 return 0;
624 }
625
Raymond Hettinger93d44812004-03-21 17:01:44 +0000626 res = PyObject_RichCompare(v, w, op);
Guido van Rossume797ec12001-01-17 15:24:28 +0000627 if (res == NULL)
628 return -1;
Guido van Rossum81912d42002-08-24 05:33:28 +0000629 if (PyBool_Check(res))
630 ok = (res == Py_True);
631 else
632 ok = PyObject_IsTrue(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000633 Py_DECREF(res);
634 return ok;
635}
Fred Drake13634cf2000-06-29 19:17:04 +0000636
637/* Set of hash utility functions to help maintaining the invariant that
Raymond Hettinger8183fa42004-03-21 17:35:06 +0000638 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000639
640 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
641*/
642
643long
Fred Drake100814d2000-07-09 15:48:49 +0000644_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000645{
Tim Peters39dce292000-08-15 03:34:48 +0000646 double intpart, fractpart;
647 int expo;
648 long hipart;
649 long x; /* the final hash value */
650 /* This is designed so that Python numbers of different types
651 * that compare equal hash to the same value; otherwise comparisons
652 * of mapping keys will turn out weird.
653 */
654
Tim Peters39dce292000-08-15 03:34:48 +0000655 fractpart = modf(v, &intpart);
Tim Peters39dce292000-08-15 03:34:48 +0000656 if (fractpart == 0.0) {
657 /* This must return the same hash as an equal int or long. */
Mark Dickinsonc96db472009-02-08 15:09:21 +0000658 if (intpart > LONG_MAX/2 || -intpart > LONG_MAX/2) {
Tim Peters39dce292000-08-15 03:34:48 +0000659 /* Convert to long and use its hash. */
660 PyObject *plong; /* converted to Python long */
661 if (Py_IS_INFINITY(intpart))
662 /* can't convert to long int -- arbitrary */
663 v = v < 0 ? -271828.0 : 314159.0;
664 plong = PyLong_FromDouble(v);
665 if (plong == NULL)
666 return -1;
667 x = PyObject_Hash(plong);
668 Py_DECREF(plong);
669 return x;
670 }
671 /* Fits in a C long == a Python int, so is its own hash. */
672 x = (long)intpart;
673 if (x == -1)
674 x = -2;
675 return x;
676 }
677 /* The fractional part is non-zero, so we don't have to worry about
678 * making this match the hash of some other type.
679 * Use frexp to get at the bits in the double.
Fred Drake13634cf2000-06-29 19:17:04 +0000680 * Since the VAX D double format has 56 mantissa bits, which is the
681 * most of any double format in use, each of these parts may have as
682 * many as (but no more than) 56 significant bits.
Tim Peters39dce292000-08-15 03:34:48 +0000683 * So, assuming sizeof(long) >= 4, each part can be broken into two
684 * longs; frexp and multiplication are used to do that.
685 * Also, since the Cray double format has 15 exponent bits, which is
686 * the most of any double format in use, shifting the exponent field
687 * left by 15 won't overflow a long (again assuming sizeof(long) >= 4).
Fred Drake13634cf2000-06-29 19:17:04 +0000688 */
Tim Peters39dce292000-08-15 03:34:48 +0000689 v = frexp(v, &expo);
690 v *= 2147483648.0; /* 2**31 */
691 hipart = (long)v; /* take the top 32 bits */
692 v = (v - (double)hipart) * 2147483648.0; /* get the next 32 bits */
693 x = hipart + (long)v + (expo << 15);
694 if (x == -1)
695 x = -2;
696 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000697}
698
699long
Fred Drake100814d2000-07-09 15:48:49 +0000700_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000701{
Fred Drake13634cf2000-06-29 19:17:04 +0000702 long x;
Antoine Pitrou79eee6b2009-02-13 14:01:05 +0000703 size_t y = (size_t)p;
704 /* bottom 3 or 4 bits are likely to be 0; rotate y by 4 to avoid
705 excessive hash collisions for dicts and sets */
706 y = (y >> 4) | (y << (8 * SIZEOF_VOID_P - 4));
707 x = (long)y;
708 if (x == -1)
709 x = -2;
Fred Drake13634cf2000-06-29 19:17:04 +0000710 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000711}
712
Nick Coghland1abd252008-07-15 15:46:38 +0000713long
714PyObject_HashNotImplemented(PyObject *v)
715{
716 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
717 Py_TYPE(v)->tp_name);
718 return -1;
719}
Fred Drake13634cf2000-06-29 19:17:04 +0000720
Guido van Rossum9bfef441993-03-29 10:43:31 +0000721long
Fred Drake100814d2000-07-09 15:48:49 +0000722PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000723{
Nick Coghland1abd252008-07-15 15:46:38 +0000724 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000725 if (tp->tp_hash != NULL)
726 return (*tp->tp_hash)(v);
Nick Coghlanf1f2f682008-12-30 07:29:12 +0000727 /* To keep to the general practice that inheriting
728 * solely from object in C code should work without
729 * an explicit call to PyType_Ready, we implicitly call
730 * PyType_Ready here and then check the tp_hash slot again
731 */
732 if (tp->tp_dict == NULL) {
733 if (PyType_Ready(tp) < 0)
734 return -1;
735 if (tp->tp_hash != NULL)
736 return (*tp->tp_hash)(v);
737 }
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000738 /* Otherwise, the object can't be hashed */
Nick Coghland1abd252008-07-15 15:46:38 +0000739 return PyObject_HashNotImplemented(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000740}
741
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000742PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000743PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000744{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000745 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000746
Christian Heimes90aa7642007-12-19 02:45:37 +0000747 if (Py_TYPE(v)->tp_getattr != NULL)
748 return (*Py_TYPE(v)->tp_getattr)(v, (char*)name);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000749 w = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000750 if (w == NULL)
751 return NULL;
752 res = PyObject_GetAttr(v, w);
753 Py_XDECREF(w);
754 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000755}
756
757int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000758PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000759{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000760 PyObject *res = PyObject_GetAttrString(v, name);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000761 if (res != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000762 Py_DECREF(res);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000763 return 1;
764 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000765 PyErr_Clear();
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000766 return 0;
767}
768
769int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000770PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000771{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000772 PyObject *s;
773 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000774
Christian Heimes90aa7642007-12-19 02:45:37 +0000775 if (Py_TYPE(v)->tp_setattr != NULL)
776 return (*Py_TYPE(v)->tp_setattr)(v, (char*)name, w);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000777 s = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000778 if (s == NULL)
779 return -1;
780 res = PyObject_SetAttr(v, s, w);
781 Py_XDECREF(s);
782 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000783}
784
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000785PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000786PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000787{
Christian Heimes90aa7642007-12-19 02:45:37 +0000788 PyTypeObject *tp = Py_TYPE(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000789
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000790 if (!PyUnicode_Check(name)) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000791 PyErr_Format(PyExc_TypeError,
792 "attribute name must be string, not '%.200s'",
793 name->ob_type->tp_name);
794 return NULL;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000795 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000796 if (tp->tp_getattro != NULL)
797 return (*tp->tp_getattro)(v, name);
798 if (tp->tp_getattr != NULL)
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000799 return (*tp->tp_getattr)(v, _PyUnicode_AsString(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +0000800 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000801 "'%.50s' object has no attribute '%U'",
802 tp->tp_name, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000803 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000804}
805
806int
Fred Drake100814d2000-07-09 15:48:49 +0000807PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000808{
809 PyObject *res = PyObject_GetAttr(v, name);
810 if (res != NULL) {
811 Py_DECREF(res);
812 return 1;
813 }
814 PyErr_Clear();
815 return 0;
816}
817
818int
Fred Drake100814d2000-07-09 15:48:49 +0000819PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000820{
Christian Heimes90aa7642007-12-19 02:45:37 +0000821 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000822 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000823
Martin v. Löwis5b222132007-06-10 09:51:05 +0000824 if (!PyUnicode_Check(name)) {
825 PyErr_Format(PyExc_TypeError,
826 "attribute name must be string, not '%.200s'",
827 name->ob_type->tp_name);
828 return -1;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000829 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000830 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000831
Martin v. Löwis5b222132007-06-10 09:51:05 +0000832 PyUnicode_InternInPlace(&name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000833 if (tp->tp_setattro != NULL) {
834 err = (*tp->tp_setattro)(v, name, value);
835 Py_DECREF(name);
836 return err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000837 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000838 if (tp->tp_setattr != NULL) {
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000839 err = (*tp->tp_setattr)(v, _PyUnicode_AsString(name), value);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000840 Py_DECREF(name);
841 return err;
842 }
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000843 Py_DECREF(name);
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000844 assert(name->ob_refcnt >= 1);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000845 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
846 PyErr_Format(PyExc_TypeError,
847 "'%.100s' object has no attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000848 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000849 tp->tp_name,
850 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000851 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000852 else
853 PyErr_Format(PyExc_TypeError,
854 "'%.100s' object has only read-only attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000855 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000856 tp->tp_name,
857 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000858 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000859 return -1;
860}
861
862/* Helper to get a pointer to an object's __dict__ slot, if any */
863
864PyObject **
865_PyObject_GetDictPtr(PyObject *obj)
866{
Martin v. Löwis725507b2006-03-07 12:08:51 +0000867 Py_ssize_t dictoffset;
Christian Heimes90aa7642007-12-19 02:45:37 +0000868 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000869
Tim Peters6d6c1a32001-08-02 04:15:00 +0000870 dictoffset = tp->tp_dictoffset;
871 if (dictoffset == 0)
872 return NULL;
873 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000874 Py_ssize_t tsize;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000875 size_t size;
876
877 tsize = ((PyVarObject *)obj)->ob_size;
878 if (tsize < 0)
879 tsize = -tsize;
880 size = _PyObject_VAR_SIZE(tp, tsize);
881
Tim Peters6d483d32001-10-06 21:27:34 +0000882 dictoffset += (long)size;
883 assert(dictoffset > 0);
884 assert(dictoffset % SIZEOF_VOID_P == 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000885 }
886 return (PyObject **) ((char *)obj + dictoffset);
887}
888
Tim Peters6d6c1a32001-08-02 04:15:00 +0000889PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000890PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +0000891{
892 Py_INCREF(obj);
893 return obj;
894}
895
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +0000896/* Helper used when the __next__ method is removed from a type:
897 tp_iternext is never NULL and can be safely called without checking
898 on every iteration.
899 */
900
901PyObject *
902_PyObject_NextNotImplemented(PyObject *self)
903{
904 PyErr_Format(PyExc_TypeError,
905 "'%.200s' object is not iterable",
906 Py_TYPE(self)->tp_name);
907 return NULL;
908}
909
Michael W. Hudson1593f502004-09-14 17:09:47 +0000910/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
911
Raymond Hettinger01538262003-03-17 08:24:35 +0000912PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000913PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
914{
Christian Heimes90aa7642007-12-19 02:45:37 +0000915 PyTypeObject *tp = Py_TYPE(obj);
Guido van Rossum056fbf42002-08-19 19:22:50 +0000916 PyObject *descr = NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000917 PyObject *res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000918 descrgetfunc f;
Martin v. Löwis725507b2006-03-07 12:08:51 +0000919 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000920 PyObject **dictptr;
921
Martin v. Löwis5b222132007-06-10 09:51:05 +0000922 if (!PyUnicode_Check(name)){
923 PyErr_Format(PyExc_TypeError,
924 "attribute name must be string, not '%.200s'",
925 name->ob_type->tp_name);
926 return NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000927 }
928 else
929 Py_INCREF(name);
930
Tim Peters6d6c1a32001-08-02 04:15:00 +0000931 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +0000932 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000933 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000934 }
935
Christian Heimesa62da1d2008-01-12 19:39:10 +0000936#if 0 /* XXX this is not quite _PyType_Lookup anymore */
Guido van Rossum056fbf42002-08-19 19:22:50 +0000937 /* Inline _PyType_Lookup */
938 {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000939 Py_ssize_t i, n;
Guido van Rossum056fbf42002-08-19 19:22:50 +0000940 PyObject *mro, *base, *dict;
941
942 /* Look in tp_dict of types in MRO */
943 mro = tp->tp_mro;
944 assert(mro != NULL);
945 assert(PyTuple_Check(mro));
946 n = PyTuple_GET_SIZE(mro);
947 for (i = 0; i < n; i++) {
948 base = PyTuple_GET_ITEM(mro, i);
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000949 assert(PyType_Check(base));
950 dict = ((PyTypeObject *)base)->tp_dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +0000951 assert(dict && PyDict_Check(dict));
952 descr = PyDict_GetItem(dict, name);
953 if (descr != NULL)
954 break;
955 }
956 }
Christian Heimesa62da1d2008-01-12 19:39:10 +0000957#else
958 descr = _PyType_Lookup(tp, name);
959#endif
Guido van Rossum056fbf42002-08-19 19:22:50 +0000960
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000961 Py_XINCREF(descr);
962
Tim Peters6d6c1a32001-08-02 04:15:00 +0000963 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000964 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000965 f = descr->ob_type->tp_descr_get;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000966 if (f != NULL && PyDescr_IsData(descr)) {
967 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000968 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000969 goto done;
970 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000971 }
972
Guido van Rossumc66ff442002-08-19 16:50:48 +0000973 /* Inline _PyObject_GetDictPtr */
974 dictoffset = tp->tp_dictoffset;
975 if (dictoffset != 0) {
976 PyObject *dict;
977 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000978 Py_ssize_t tsize;
Guido van Rossumc66ff442002-08-19 16:50:48 +0000979 size_t size;
980
981 tsize = ((PyVarObject *)obj)->ob_size;
982 if (tsize < 0)
983 tsize = -tsize;
984 size = _PyObject_VAR_SIZE(tp, tsize);
985
986 dictoffset += (long)size;
987 assert(dictoffset > 0);
988 assert(dictoffset % SIZEOF_VOID_P == 0);
989 }
990 dictptr = (PyObject **) ((char *)obj + dictoffset);
991 dict = *dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000992 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +0000993 Py_INCREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000994 res = PyDict_GetItem(dict, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000995 if (res != NULL) {
996 Py_INCREF(res);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000997 Py_XDECREF(descr);
Christian Heimes969fe572008-01-25 11:23:10 +0000998 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000999 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001000 }
Christian Heimes969fe572008-01-25 11:23:10 +00001001 Py_DECREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001002 }
1003 }
1004
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001005 if (f != NULL) {
Christian Heimes90aa7642007-12-19 02:45:37 +00001006 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001007 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001008 goto done;
1009 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001010
1011 if (descr != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001012 res = descr;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001013 /* descr was already increfed above */
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001014 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001015 }
1016
1017 PyErr_Format(PyExc_AttributeError,
1018 "'%.50s' object has no attribute '%.400s'",
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +00001019 tp->tp_name, _PyUnicode_AsString(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001020 done:
1021 Py_DECREF(name);
1022 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001023}
1024
1025int
1026PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1027{
Christian Heimes90aa7642007-12-19 02:45:37 +00001028 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001029 PyObject *descr;
1030 descrsetfunc f;
1031 PyObject **dictptr;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001032 int res = -1;
1033
Martin v. Löwis5b222132007-06-10 09:51:05 +00001034 if (!PyUnicode_Check(name)){
1035 PyErr_Format(PyExc_TypeError,
1036 "attribute name must be string, not '%.200s'",
1037 name->ob_type->tp_name);
1038 return -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001039 }
1040 else
1041 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001042
1043 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001044 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001045 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001046 }
1047
1048 descr = _PyType_Lookup(tp, name);
1049 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001050 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001051 f = descr->ob_type->tp_descr_set;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001052 if (f != NULL && PyDescr_IsData(descr)) {
1053 res = f(descr, obj, value);
1054 goto done;
1055 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001056 }
1057
1058 dictptr = _PyObject_GetDictPtr(obj);
1059 if (dictptr != NULL) {
1060 PyObject *dict = *dictptr;
1061 if (dict == NULL && value != NULL) {
1062 dict = PyDict_New();
1063 if (dict == NULL)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001064 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001065 *dictptr = dict;
1066 }
1067 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +00001068 Py_INCREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001069 if (value == NULL)
1070 res = PyDict_DelItem(dict, name);
1071 else
1072 res = PyDict_SetItem(dict, name, value);
1073 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1074 PyErr_SetObject(PyExc_AttributeError, name);
Christian Heimes969fe572008-01-25 11:23:10 +00001075 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001076 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001077 }
1078 }
1079
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001080 if (f != NULL) {
1081 res = f(descr, obj, value);
1082 goto done;
1083 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001084
1085 if (descr == NULL) {
1086 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001087 "'%.100s' object has no attribute '%U'",
1088 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001089 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001090 }
1091
1092 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001093 "'%.50s' object attribute '%U' is read-only",
1094 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001095 done:
1096 Py_DECREF(name);
1097 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001098}
1099
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001100/* Test a value used as condition, e.g., in a for or if statement.
1101 Return -1 if an error occurred */
1102
1103int
Fred Drake100814d2000-07-09 15:48:49 +00001104PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001105{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001106 Py_ssize_t res;
Guido van Rossum6248f442002-08-24 06:31:34 +00001107 if (v == Py_True)
1108 return 1;
1109 if (v == Py_False)
1110 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001111 if (v == Py_None)
Neal Norwitz51290d32002-06-13 21:32:44 +00001112 return 0;
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001113 else if (v->ob_type->tp_as_number != NULL &&
Jack Diederich4dafcc42006-11-28 19:15:13 +00001114 v->ob_type->tp_as_number->nb_bool != NULL)
1115 res = (*v->ob_type->tp_as_number->nb_bool)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001116 else if (v->ob_type->tp_as_mapping != NULL &&
1117 v->ob_type->tp_as_mapping->mp_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001118 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001119 else if (v->ob_type->tp_as_sequence != NULL &&
1120 v->ob_type->tp_as_sequence->sq_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001121 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1122 else
Neal Norwitz51290d32002-06-13 21:32:44 +00001123 return 1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001124 /* if it is negative, it should be either -1 or -2 */
1125 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001126}
1127
Tim Peters803526b2002-07-07 05:13:56 +00001128/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001129 Return -1 if an error occurred */
1130
1131int
Fred Drake100814d2000-07-09 15:48:49 +00001132PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001133{
1134 int res;
1135 res = PyObject_IsTrue(v);
1136 if (res < 0)
1137 return res;
1138 return res == 0;
1139}
1140
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001141/* Test whether an object can be called */
1142
1143int
Fred Drake100814d2000-07-09 15:48:49 +00001144PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001145{
1146 if (x == NULL)
1147 return 0;
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001148 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001149}
1150
Georg Brandle32b4222007-03-10 22:13:27 +00001151/* ------------------------- PyObject_Dir() helpers ------------------------- */
1152
Tim Peters7eea37e2001-09-04 22:08:56 +00001153/* Helper for PyObject_Dir.
1154 Merge the __dict__ of aclass into dict, and recursively also all
1155 the __dict__s of aclass's base classes. The order of merging isn't
1156 defined, as it's expected that only the final set of dict keys is
1157 interesting.
1158 Return 0 on success, -1 on error.
1159*/
1160
1161static int
1162merge_class_dict(PyObject* dict, PyObject* aclass)
1163{
1164 PyObject *classdict;
1165 PyObject *bases;
1166
1167 assert(PyDict_Check(dict));
1168 assert(aclass);
1169
1170 /* Merge in the type's dict (if any). */
1171 classdict = PyObject_GetAttrString(aclass, "__dict__");
1172 if (classdict == NULL)
1173 PyErr_Clear();
1174 else {
1175 int status = PyDict_Update(dict, classdict);
1176 Py_DECREF(classdict);
1177 if (status < 0)
1178 return -1;
1179 }
1180
1181 /* Recursively merge in the base types' (if any) dicts. */
1182 bases = PyObject_GetAttrString(aclass, "__bases__");
Tim Petersbc7e8632001-09-16 20:33:22 +00001183 if (bases == NULL)
1184 PyErr_Clear();
1185 else {
Guido van Rossum44022412002-05-13 18:29:46 +00001186 /* We have no guarantee that bases is a real tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001187 Py_ssize_t i, n;
Guido van Rossum44022412002-05-13 18:29:46 +00001188 n = PySequence_Size(bases); /* This better be right */
1189 if (n < 0)
1190 PyErr_Clear();
1191 else {
1192 for (i = 0; i < n; i++) {
Tim Peters18e70832003-02-05 19:35:19 +00001193 int status;
Guido van Rossum44022412002-05-13 18:29:46 +00001194 PyObject *base = PySequence_GetItem(bases, i);
1195 if (base == NULL) {
1196 Py_DECREF(bases);
1197 return -1;
1198 }
Tim Peters18e70832003-02-05 19:35:19 +00001199 status = merge_class_dict(dict, base);
1200 Py_DECREF(base);
1201 if (status < 0) {
Guido van Rossum44022412002-05-13 18:29:46 +00001202 Py_DECREF(bases);
1203 return -1;
1204 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001205 }
1206 }
1207 Py_DECREF(bases);
1208 }
1209 return 0;
1210}
1211
Georg Brandle32b4222007-03-10 22:13:27 +00001212/* Helper for PyObject_Dir without arguments: returns the local scope. */
1213static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001214_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001215{
Georg Brandled3b8382007-03-12 13:15:14 +00001216 PyObject *names;
Georg Brandle32b4222007-03-10 22:13:27 +00001217 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001218
Georg Brandle32b4222007-03-10 22:13:27 +00001219 if (locals == NULL) {
1220 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1221 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001222 }
1223
Georg Brandled3b8382007-03-12 13:15:14 +00001224 names = PyMapping_Keys(locals);
1225 if (!names)
1226 return NULL;
1227 if (!PyList_Check(names)) {
1228 PyErr_Format(PyExc_TypeError,
1229 "dir(): expected keys() of locals to be a list, "
Christian Heimes90aa7642007-12-19 02:45:37 +00001230 "not '%.200s'", Py_TYPE(names)->tp_name);
Georg Brandled3b8382007-03-12 13:15:14 +00001231 Py_DECREF(names);
1232 return NULL;
1233 }
Georg Brandle32b4222007-03-10 22:13:27 +00001234 /* the locals don't need to be DECREF'd */
Georg Brandled3b8382007-03-12 13:15:14 +00001235 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001236}
1237
1238/* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
Guido van Rossum98297ee2007-11-06 21:34:58 +00001239 We deliberately don't suck up its __class__, as methods belonging to the
1240 metaclass would probably be more confusing than helpful.
Georg Brandle32b4222007-03-10 22:13:27 +00001241*/
Guido van Rossum98297ee2007-11-06 21:34:58 +00001242static PyObject *
Georg Brandle32b4222007-03-10 22:13:27 +00001243_specialized_dir_type(PyObject *obj)
1244{
1245 PyObject *result = NULL;
1246 PyObject *dict = PyDict_New();
1247
1248 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1249 result = PyDict_Keys(dict);
1250
1251 Py_XDECREF(dict);
Tim Peters305b5852001-09-17 02:38:46 +00001252 return result;
1253}
1254
Georg Brandle32b4222007-03-10 22:13:27 +00001255/* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1256static PyObject *
1257_specialized_dir_module(PyObject *obj)
Tim Peters7eea37e2001-09-04 22:08:56 +00001258{
Georg Brandle32b4222007-03-10 22:13:27 +00001259 PyObject *result = NULL;
1260 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
Tim Peters7eea37e2001-09-04 22:08:56 +00001261
Georg Brandle32b4222007-03-10 22:13:27 +00001262 if (dict != NULL) {
1263 if (PyDict_Check(dict))
1264 result = PyDict_Keys(dict);
1265 else {
1266 PyErr_Format(PyExc_TypeError,
1267 "%.200s.__dict__ is not a dictionary",
1268 PyModule_GetName(obj));
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001269 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001270 }
1271
Georg Brandle32b4222007-03-10 22:13:27 +00001272 Py_XDECREF(dict);
1273 return result;
1274}
Tim Peters7eea37e2001-09-04 22:08:56 +00001275
Georg Brandle32b4222007-03-10 22:13:27 +00001276/* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1277 and recursively up the __class__.__bases__ chain.
1278*/
1279static PyObject *
1280_generic_dir(PyObject *obj)
1281{
1282 PyObject *result = NULL;
1283 PyObject *dict = NULL;
1284 PyObject *itsclass = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001285
Georg Brandle32b4222007-03-10 22:13:27 +00001286 /* Get __dict__ (which may or may not be a real dict...) */
1287 dict = PyObject_GetAttrString(obj, "__dict__");
1288 if (dict == NULL) {
1289 PyErr_Clear();
1290 dict = PyDict_New();
1291 }
1292 else if (!PyDict_Check(dict)) {
1293 Py_DECREF(dict);
1294 dict = PyDict_New();
1295 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001296 else {
Georg Brandle32b4222007-03-10 22:13:27 +00001297 /* Copy __dict__ to avoid mutating it. */
1298 PyObject *temp = PyDict_Copy(dict);
1299 Py_DECREF(dict);
1300 dict = temp;
Tim Peters7eea37e2001-09-04 22:08:56 +00001301 }
1302
Georg Brandle32b4222007-03-10 22:13:27 +00001303 if (dict == NULL)
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001304 goto error;
Tim Peters7eea37e2001-09-04 22:08:56 +00001305
Georg Brandle32b4222007-03-10 22:13:27 +00001306 /* Merge in attrs reachable from its class. */
1307 itsclass = PyObject_GetAttrString(obj, "__class__");
1308 if (itsclass == NULL)
1309 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1310 __class__ exists? */
1311 PyErr_Clear();
1312 else {
1313 if (merge_class_dict(dict, itsclass) != 0)
1314 goto error;
1315 }
1316
1317 result = PyDict_Keys(dict);
Tim Peters7eea37e2001-09-04 22:08:56 +00001318 /* fall through */
Georg Brandle32b4222007-03-10 22:13:27 +00001319error:
1320 Py_XDECREF(itsclass);
1321 Py_XDECREF(dict);
1322 return result;
1323}
1324
1325/* Helper for PyObject_Dir: object introspection.
1326 This calls one of the above specialized versions if no __dir__ method
1327 exists. */
1328static PyObject *
1329_dir_object(PyObject *obj)
1330{
1331 PyObject * result = NULL;
1332 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1333 "__dir__");
1334
1335 assert(obj);
1336 if (dirfunc == NULL) {
1337 /* use default implementation */
1338 PyErr_Clear();
1339 if (PyModule_Check(obj))
1340 result = _specialized_dir_module(obj);
1341 else if (PyType_Check(obj))
1342 result = _specialized_dir_type(obj);
1343 else
1344 result = _generic_dir(obj);
1345 }
1346 else {
1347 /* use __dir__ */
1348 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1349 Py_DECREF(dirfunc);
1350 if (result == NULL)
1351 return NULL;
1352
1353 /* result must be a list */
1354 /* XXX(gbrandl): could also check if all items are strings */
1355 if (!PyList_Check(result)) {
1356 PyErr_Format(PyExc_TypeError,
1357 "__dir__() must return a list, not %.200s",
Christian Heimes90aa7642007-12-19 02:45:37 +00001358 Py_TYPE(result)->tp_name);
Georg Brandle32b4222007-03-10 22:13:27 +00001359 Py_DECREF(result);
1360 result = NULL;
1361 }
1362 }
1363
1364 return result;
1365}
1366
1367/* Implementation of dir() -- if obj is NULL, returns the names in the current
1368 (local) scope. Otherwise, performs introspection of the object: returns a
1369 sorted list of attribute names (supposedly) accessible from the object
1370*/
1371PyObject *
1372PyObject_Dir(PyObject *obj)
1373{
1374 PyObject * result;
1375
1376 if (obj == NULL)
1377 /* no object -- introspect the locals */
1378 result = _dir_locals();
1379 else
1380 /* object -- introspect the object */
1381 result = _dir_object(obj);
1382
1383 assert(result == NULL || PyList_Check(result));
1384
1385 if (result != NULL && PyList_Sort(result) != 0) {
1386 /* sorting the list failed */
1387 Py_DECREF(result);
1388 result = NULL;
1389 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001390
Tim Peters7eea37e2001-09-04 22:08:56 +00001391 return result;
1392}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001393
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001394/*
1395NoObject is usable as a non-NULL undefined value, used by the macro None.
1396There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001397so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001398(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001399*/
1400
Guido van Rossum0c182a11992-03-27 17:26:13 +00001401/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001402static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001403none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001404{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001405 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001406}
1407
Barry Warsaw9bf16442001-01-23 16:24:35 +00001408/* ARGUSED */
1409static void
Tim Peters803526b2002-07-07 05:13:56 +00001410none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001411{
1412 /* This should never get called, but we also don't want to SEGV if
Mark Dickinson934896d2009-02-21 20:59:32 +00001413 * we accidentally decref None out of existence.
Barry Warsaw9bf16442001-01-23 16:24:35 +00001414 */
Martin v. Löwis3f19b102002-08-07 16:21:51 +00001415 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001416}
1417
1418
Guido van Rossumba21a492001-08-16 08:17:26 +00001419static PyTypeObject PyNone_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001420 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001421 "NoneType",
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001422 0,
1423 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001424 none_dealloc, /*tp_dealloc*/ /*never called*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001425 0, /*tp_print*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001426 0, /*tp_getattr*/
1427 0, /*tp_setattr*/
Mark Dickinsone94c6792009-02-02 20:36:42 +00001428 0, /*tp_reserved*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001429 none_repr, /*tp_repr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001430 0, /*tp_as_number*/
1431 0, /*tp_as_sequence*/
1432 0, /*tp_as_mapping*/
Guido van Rossum9bfef441993-03-29 10:43:31 +00001433 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001434};
1435
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001436PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001437 _PyObject_EXTRA_INIT
1438 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001439};
1440
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001441/* NotImplemented is an object that can be used to signal that an
1442 operation is not implemented for the given type combination. */
1443
1444static PyObject *
1445NotImplemented_repr(PyObject *op)
1446{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001447 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001448}
1449
1450static PyTypeObject PyNotImplemented_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001451 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001452 "NotImplementedType",
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001453 0,
1454 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001455 none_dealloc, /*tp_dealloc*/ /*never called*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001456 0, /*tp_print*/
1457 0, /*tp_getattr*/
1458 0, /*tp_setattr*/
Mark Dickinsone94c6792009-02-02 20:36:42 +00001459 0, /*tp_reserved*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001460 NotImplemented_repr, /*tp_repr*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001461 0, /*tp_as_number*/
1462 0, /*tp_as_sequence*/
1463 0, /*tp_as_mapping*/
1464 0, /*tp_hash */
1465};
1466
1467PyObject _Py_NotImplementedStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001468 _PyObject_EXTRA_INIT
1469 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001470};
1471
Guido van Rossumba21a492001-08-16 08:17:26 +00001472void
1473_Py_ReadyTypes(void)
1474{
1475 if (PyType_Ready(&PyType_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001476 Py_FatalError("Can't initialize type type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001477
Fred Drake0a4dd392004-07-02 18:57:45 +00001478 if (PyType_Ready(&_PyWeakref_RefType) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001479 Py_FatalError("Can't initialize weakref type");
Fred Drake0a4dd392004-07-02 18:57:45 +00001480
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001481 if (PyType_Ready(&_PyWeakref_CallableProxyType) < 0)
1482 Py_FatalError("Can't initialize callable weakref proxy type");
1483
1484 if (PyType_Ready(&_PyWeakref_ProxyType) < 0)
1485 Py_FatalError("Can't initialize weakref proxy type");
1486
Guido van Rossum77f6a652002-04-03 22:41:51 +00001487 if (PyType_Ready(&PyBool_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001488 Py_FatalError("Can't initialize bool type");
Guido van Rossum77f6a652002-04-03 22:41:51 +00001489
Christian Heimes9c4756e2008-05-26 13:22:05 +00001490 if (PyType_Ready(&PyByteArray_Type) < 0)
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001491 Py_FatalError("Can't initialize bytearray type");
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001492
Christian Heimes72b710a2008-05-26 13:28:38 +00001493 if (PyType_Ready(&PyBytes_Type) < 0)
Guido van Rossumcacfc072002-05-24 19:01:59 +00001494 Py_FatalError("Can't initialize 'str'");
1495
Guido van Rossumba21a492001-08-16 08:17:26 +00001496 if (PyType_Ready(&PyList_Type) < 0)
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001497 Py_FatalError("Can't initialize list type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001498
1499 if (PyType_Ready(&PyNone_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001500 Py_FatalError("Can't initialize None type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001501
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001502 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1503 Py_FatalError("Can't initialize type(Ellipsis)");
1504
Guido van Rossumba21a492001-08-16 08:17:26 +00001505 if (PyType_Ready(&PyNotImplemented_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001506 Py_FatalError("Can't initialize NotImplemented type");
1507
1508 if (PyType_Ready(&PyTraceBack_Type) < 0)
1509 Py_FatalError("Can't initialize traceback type");
1510
1511 if (PyType_Ready(&PySuper_Type) < 0)
1512 Py_FatalError("Can't initialize super type");
1513
1514 if (PyType_Ready(&PyBaseObject_Type) < 0)
1515 Py_FatalError("Can't initialize object type");
1516
1517 if (PyType_Ready(&PyRange_Type) < 0)
1518 Py_FatalError("Can't initialize range type");
1519
1520 if (PyType_Ready(&PyDict_Type) < 0)
1521 Py_FatalError("Can't initialize dict type");
1522
1523 if (PyType_Ready(&PySet_Type) < 0)
1524 Py_FatalError("Can't initialize set type");
1525
1526 if (PyType_Ready(&PyUnicode_Type) < 0)
1527 Py_FatalError("Can't initialize str type");
1528
1529 if (PyType_Ready(&PySlice_Type) < 0)
1530 Py_FatalError("Can't initialize slice type");
1531
1532 if (PyType_Ready(&PyStaticMethod_Type) < 0)
1533 Py_FatalError("Can't initialize static method type");
1534
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001535#ifndef WITHOUT_COMPLEX
Benjamin Petersonae937c02009-04-18 20:54:08 +00001536 if (PyType_Ready(&PyComplex_Type) < 0)
1537 Py_FatalError("Can't initialize complex type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001538#endif
Benjamin Petersonae937c02009-04-18 20:54:08 +00001539 if (PyType_Ready(&PyFloat_Type) < 0)
1540 Py_FatalError("Can't initialize float type");
1541
1542 if (PyType_Ready(&PyLong_Type) < 0)
1543 Py_FatalError("Can't initialize int type");
1544
1545 if (PyType_Ready(&PyFrozenSet_Type) < 0)
1546 Py_FatalError("Can't initialize frozenset type");
1547
1548 if (PyType_Ready(&PyProperty_Type) < 0)
1549 Py_FatalError("Can't initialize property type");
1550
1551 if (PyType_Ready(&PyMemoryView_Type) < 0)
1552 Py_FatalError("Can't initialize memoryview type");
1553
1554 if (PyType_Ready(&PyTuple_Type) < 0)
1555 Py_FatalError("Can't initialize tuple type");
1556
1557 if (PyType_Ready(&PyEnum_Type) < 0)
1558 Py_FatalError("Can't initialize enumerate type");
1559
1560 if (PyType_Ready(&PyReversed_Type) < 0)
1561 Py_FatalError("Can't initialize reversed type");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001562
Guido van Rossum826d8972007-10-30 18:34:07 +00001563 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1564 Py_FatalError("Can't initialize StdPrinter");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001565
1566 if (PyType_Ready(&PyCode_Type) < 0)
1567 Py_FatalError("Can't initialize code type");
1568
1569 if (PyType_Ready(&PyFrame_Type) < 0)
1570 Py_FatalError("Can't initialize frame type");
1571
1572 if (PyType_Ready(&PyCFunction_Type) < 0)
1573 Py_FatalError("Can't initialize builtin function type");
1574
1575 if (PyType_Ready(&PyMethod_Type) < 0)
1576 Py_FatalError("Can't initialize method type");
1577
1578 if (PyType_Ready(&PyFunction_Type) < 0)
1579 Py_FatalError("Can't initialize function type");
1580
1581 if (PyType_Ready(&PyDictProxy_Type) < 0)
1582 Py_FatalError("Can't initialize dict proxy type");
1583
1584 if (PyType_Ready(&PyGen_Type) < 0)
1585 Py_FatalError("Can't initialize generator type");
1586
1587 if (PyType_Ready(&PyGetSetDescr_Type) < 0)
1588 Py_FatalError("Can't initialize get-set descriptor type");
1589
1590 if (PyType_Ready(&PyWrapperDescr_Type) < 0)
1591 Py_FatalError("Can't initialize wrapper type");
1592
1593 if (PyType_Ready(&PyEllipsis_Type) < 0)
1594 Py_FatalError("Can't initialize ellipsis type");
1595
1596 if (PyType_Ready(&PyMemberDescr_Type) < 0)
1597 Py_FatalError("Can't initialize member descriptor type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001598}
1599
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001600
Guido van Rossum84a90321996-05-22 16:34:47 +00001601#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001602
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001603void
Fred Drake100814d2000-07-09 15:48:49 +00001604_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001605{
Tim Peters34592512002-07-11 06:23:50 +00001606 _Py_INC_REFTOTAL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001607 op->ob_refcnt = 1;
Tim Peters7571a0f2003-03-23 17:52:28 +00001608 _Py_AddToAllObjects(op, 1);
Tim Peters34592512002-07-11 06:23:50 +00001609 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001610}
1611
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001612void
Fred Drake100814d2000-07-09 15:48:49 +00001613_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001614{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001615#ifdef SLOW_UNREF_CHECK
Guido van Rossum4c08d552000-03-10 22:55:18 +00001616 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001617#endif
Guido van Rossumd7047b31995-01-02 19:07:15 +00001618 if (op->ob_refcnt < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001619 Py_FatalError("UNREF negative refcnt");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001620 if (op == &refchain ||
Christian Heimesc8967002007-11-30 10:18:26 +00001621 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1622 fprintf(stderr, "* ob\n");
1623 _PyObject_Dump(op);
1624 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1625 _PyObject_Dump(op->_ob_prev->_ob_next);
1626 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1627 _PyObject_Dump(op->_ob_next->_ob_prev);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001628 Py_FatalError("UNREF invalid object");
Christian Heimesc8967002007-11-30 10:18:26 +00001629 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001630#ifdef SLOW_UNREF_CHECK
Guido van Rossum3f5da241990-12-20 15:06:42 +00001631 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1632 if (p == op)
1633 break;
1634 }
Guido van Rossumd7047b31995-01-02 19:07:15 +00001635 if (p == &refchain) /* Not found */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001636 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001637#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001638 op->_ob_next->_ob_prev = op->_ob_prev;
1639 op->_ob_prev->_ob_next = op->_ob_next;
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001640 op->_ob_next = op->_ob_prev = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001641 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001642}
1643
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001644void
Fred Drake100814d2000-07-09 15:48:49 +00001645_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001646{
Christian Heimes90aa7642007-12-19 02:45:37 +00001647 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001648 _Py_ForgetReference(op);
Guido van Rossum9776adf1994-09-07 14:36:45 +00001649 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001650}
1651
Tim Peters269b2a62003-04-17 19:52:29 +00001652/* Print all live objects. Because PyObject_Print is called, the
1653 * interpreter must be in a healthy state.
1654 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001655void
Fred Drake100814d2000-07-09 15:48:49 +00001656_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001657{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001658 PyObject *op;
Guido van Rossume09fb551997-08-05 02:04:34 +00001659 fprintf(fp, "Remaining objects:\n");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001660 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001661 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001662 if (PyObject_Print(op, fp, 0) != 0)
1663 PyErr_Clear();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001664 putc('\n', fp);
1665 }
1666}
1667
Tim Peters269b2a62003-04-17 19:52:29 +00001668/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1669 * doesn't make any calls to the Python C API, so is always safe to call.
1670 */
1671void
1672_Py_PrintReferenceAddresses(FILE *fp)
1673{
1674 PyObject *op;
1675 fprintf(fp, "Remaining object addresses:\n");
1676 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001677 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
Christian Heimes90aa7642007-12-19 02:45:37 +00001678 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001679}
1680
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001681PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001682_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001683{
1684 int i, n;
1685 PyObject *t = NULL;
1686 PyObject *res, *op;
1687
1688 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1689 return NULL;
1690 op = refchain._ob_next;
1691 res = PyList_New(0);
1692 if (res == NULL)
1693 return NULL;
1694 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1695 while (op == self || op == args || op == res || op == t ||
Christian Heimes90aa7642007-12-19 02:45:37 +00001696 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001697 op = op->_ob_next;
1698 if (op == &refchain)
1699 return res;
1700 }
1701 if (PyList_Append(res, op) < 0) {
1702 Py_DECREF(res);
1703 return NULL;
1704 }
1705 op = op->_ob_next;
1706 }
1707 return res;
1708}
1709
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001710#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001711
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001712/* Hack to force loading of cobject.o */
Guido van Rossumda9c2711996-12-05 21:58:58 +00001713PyTypeObject *_Py_cobject_hack = &PyCObject_Type;
Guido van Rossum84a90321996-05-22 16:34:47 +00001714
1715
Benjamin Petersonb173f782009-05-05 22:31:58 +00001716/* Hack to force loading of pycapsule.o */
1717PyTypeObject *_PyCapsule_hack = &PyCapsule_Type;
1718
1719
Guido van Rossum84a90321996-05-22 16:34:47 +00001720/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001721Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001722
1723
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001724/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001725
Thomas Wouters334fb892000-07-25 12:56:38 +00001726void *
Fred Drake100814d2000-07-09 15:48:49 +00001727PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001728{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001729 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001730}
1731
Thomas Wouters334fb892000-07-25 12:56:38 +00001732void *
1733PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001734{
Tim Petersaf3e8de2002-04-12 07:22:56 +00001735 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001736}
1737
1738void
Thomas Wouters334fb892000-07-25 12:56:38 +00001739PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001740{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001741 PyMem_FREE(p);
1742}
1743
1744
Guido van Rossum86610361998-04-10 22:32:46 +00001745/* These methods are used to control infinite recursion in repr, str, print,
1746 etc. Container objects that may recursively contain themselves,
1747 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1748 Py_ReprLeave() to avoid infinite recursion.
1749
1750 Py_ReprEnter() returns 0 the first time it is called for a particular
1751 object and 1 every time thereafter. It returns -1 if an exception
1752 occurred. Py_ReprLeave() has no return value.
1753
1754 See dictobject.c and listobject.c for examples of use.
1755*/
1756
1757#define KEY "Py_Repr"
1758
1759int
Fred Drake100814d2000-07-09 15:48:49 +00001760Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001761{
1762 PyObject *dict;
1763 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001764 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001765
1766 dict = PyThreadState_GetDict();
1767 if (dict == NULL)
Guido van Rossum0fc8f002003-04-15 15:12:39 +00001768 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001769 list = PyDict_GetItemString(dict, KEY);
1770 if (list == NULL) {
1771 list = PyList_New(0);
1772 if (list == NULL)
1773 return -1;
1774 if (PyDict_SetItemString(dict, KEY, list) < 0)
1775 return -1;
1776 Py_DECREF(list);
1777 }
1778 i = PyList_GET_SIZE(list);
1779 while (--i >= 0) {
1780 if (PyList_GET_ITEM(list, i) == obj)
1781 return 1;
1782 }
1783 PyList_Append(list, obj);
1784 return 0;
1785}
1786
1787void
Fred Drake100814d2000-07-09 15:48:49 +00001788Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001789{
1790 PyObject *dict;
1791 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001792 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001793
1794 dict = PyThreadState_GetDict();
Guido van Rossumeb909461998-04-11 15:17:34 +00001795 if (dict == NULL)
1796 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001797 list = PyDict_GetItemString(dict, KEY);
Guido van Rossumeb909461998-04-11 15:17:34 +00001798 if (list == NULL || !PyList_Check(list))
1799 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001800 i = PyList_GET_SIZE(list);
1801 /* Count backwards because we always expect obj to be list[-1] */
1802 while (--i >= 0) {
1803 if (PyList_GET_ITEM(list, i) == obj) {
1804 PyList_SetSlice(list, i, i + 1, NULL);
1805 break;
1806 }
1807 }
1808}
Guido van Rossumd724b232000-03-13 16:01:29 +00001809
Tim Peters803526b2002-07-07 05:13:56 +00001810/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001811
Tim Peters803526b2002-07-07 05:13:56 +00001812/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001813int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001814
Tim Peters803526b2002-07-07 05:13:56 +00001815/* List of objects that still need to be cleaned up, singly linked via their
1816 * gc headers' gc_prev pointers.
1817 */
1818PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001819
Tim Peters803526b2002-07-07 05:13:56 +00001820/* Add op to the _PyTrash_delete_later list. Called when the current
1821 * call-stack depth gets large. op must be a currently untracked gc'ed
1822 * object, with refcount 0. Py_DECREF must already have been called on it.
1823 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001824void
Fred Drake100814d2000-07-09 15:48:49 +00001825_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001826{
Tim Peters803526b2002-07-07 05:13:56 +00001827 assert(PyObject_IS_GC(op));
1828 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1829 assert(op->ob_refcnt == 0);
Neil Schemenauerf589c052002-03-29 03:05:54 +00001830 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
Guido van Rossume92e6102000-04-24 15:40:53 +00001831 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001832}
1833
Tim Peters803526b2002-07-07 05:13:56 +00001834/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1835 * the call-stack unwinds again.
1836 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001837void
Fred Drake100814d2000-07-09 15:48:49 +00001838_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001839{
1840 while (_PyTrash_delete_later) {
Tim Peters803526b2002-07-07 05:13:56 +00001841 PyObject *op = _PyTrash_delete_later;
Christian Heimes90aa7642007-12-19 02:45:37 +00001842 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001843
Neil Schemenauerf589c052002-03-29 03:05:54 +00001844 _PyTrash_delete_later =
Tim Peters803526b2002-07-07 05:13:56 +00001845 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001846
Tim Peters803526b2002-07-07 05:13:56 +00001847 /* Call the deallocator directly. This used to try to
1848 * fool Py_DECREF into calling it indirectly, but
1849 * Py_DECREF was already called on this object, and in
1850 * assorted non-release builds calling Py_DECREF again ends
1851 * up distorting allocation statistics.
1852 */
1853 assert(op->ob_refcnt == 0);
Guido van Rossumd724b232000-03-13 16:01:29 +00001854 ++_PyTrash_delete_nesting;
Tim Peters803526b2002-07-07 05:13:56 +00001855 (*dealloc)(op);
Guido van Rossumd724b232000-03-13 16:01:29 +00001856 --_PyTrash_delete_nesting;
1857 }
1858}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001859
1860#ifdef __cplusplus
1861}
1862#endif