blob: a29c31a43d6376d5f01c83272d764bd2a1a452cd [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;
547
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000548 if (v->ob_type != w->ob_type &&
549 PyType_IsSubtype(w->ob_type, v->ob_type) &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000550 (f = w->ob_type->tp_richcompare) != NULL) {
Tim Petersf4aca752004-09-23 02:39:37 +0000551 res = (*f)(w, v, _Py_SwappedOp[op]);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000552 if (res != Py_NotImplemented)
553 return res;
554 Py_DECREF(res);
555 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000556 if ((f = v->ob_type->tp_richcompare) != NULL) {
Guido van Rossume797ec12001-01-17 15:24:28 +0000557 res = (*f)(v, w, op);
558 if (res != Py_NotImplemented)
559 return res;
560 Py_DECREF(res);
561 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000562 if ((f = w->ob_type->tp_richcompare) != NULL) {
563 res = (*f)(w, v, _Py_SwappedOp[op]);
564 if (res != Py_NotImplemented)
565 return res;
566 Py_DECREF(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000567 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000568 /* If neither object implements it, provide a sensible default
569 for == and !=, but raise an exception for ordering. */
570 switch (op) {
571 case Py_EQ:
572 res = (v == w) ? Py_True : Py_False;
573 break;
574 case Py_NE:
575 res = (v != w) ? Py_True : Py_False;
576 break;
577 default:
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000578 /* XXX Special-case None so it doesn't show as NoneType() */
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000579 PyErr_Format(PyExc_TypeError,
580 "unorderable types: %.100s() %s %.100s()",
581 v->ob_type->tp_name,
582 opstrings[op],
583 w->ob_type->tp_name);
584 return NULL;
585 }
Guido van Rossume797ec12001-01-17 15:24:28 +0000586 Py_INCREF(res);
587 return res;
588}
589
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000590/* Perform a rich comparison with object result. This wraps do_richcompare()
591 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000592
Guido van Rossume797ec12001-01-17 15:24:28 +0000593PyObject *
594PyObject_RichCompare(PyObject *v, PyObject *w, int op)
595{
596 PyObject *res;
597
598 assert(Py_LT <= op && op <= Py_GE);
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000599 if (v == NULL || w == NULL) {
600 if (!PyErr_Occurred())
601 PyErr_BadInternalCall();
602 return NULL;
603 }
Armin Rigo2b3eb402003-10-28 12:05:48 +0000604 if (Py_EnterRecursiveCall(" in cmp"))
605 return NULL;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000606 res = do_richcompare(v, w, op);
Armin Rigo2b3eb402003-10-28 12:05:48 +0000607 Py_LeaveRecursiveCall();
Guido van Rossume797ec12001-01-17 15:24:28 +0000608 return res;
609}
610
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000611/* Perform a rich comparison with integer result. This wraps
612 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000613int
614PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
615{
Raymond Hettinger93d44812004-03-21 17:01:44 +0000616 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000617 int ok;
618
Mark Dickinson4a1f5932008-11-12 23:23:36 +0000619 /* Quick result when objects are the same.
620 Guarantees that identity implies equality. */
621 if (v == w) {
622 if (op == Py_EQ)
623 return 1;
624 else if (op == Py_NE)
625 return 0;
626 }
627
Raymond Hettinger93d44812004-03-21 17:01:44 +0000628 res = PyObject_RichCompare(v, w, op);
Guido van Rossume797ec12001-01-17 15:24:28 +0000629 if (res == NULL)
630 return -1;
Guido van Rossum81912d42002-08-24 05:33:28 +0000631 if (PyBool_Check(res))
632 ok = (res == Py_True);
633 else
634 ok = PyObject_IsTrue(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000635 Py_DECREF(res);
636 return ok;
637}
Fred Drake13634cf2000-06-29 19:17:04 +0000638
639/* Set of hash utility functions to help maintaining the invariant that
Raymond Hettinger8183fa42004-03-21 17:35:06 +0000640 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000641
642 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
643*/
644
645long
Fred Drake100814d2000-07-09 15:48:49 +0000646_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000647{
Tim Peters39dce292000-08-15 03:34:48 +0000648 double intpart, fractpart;
649 int expo;
650 long hipart;
651 long x; /* the final hash value */
652 /* This is designed so that Python numbers of different types
653 * that compare equal hash to the same value; otherwise comparisons
654 * of mapping keys will turn out weird.
655 */
656
Tim Peters39dce292000-08-15 03:34:48 +0000657 fractpart = modf(v, &intpart);
Tim Peters39dce292000-08-15 03:34:48 +0000658 if (fractpart == 0.0) {
659 /* This must return the same hash as an equal int or long. */
Mark Dickinsonc96db472009-02-08 15:09:21 +0000660 if (intpart > LONG_MAX/2 || -intpart > LONG_MAX/2) {
Tim Peters39dce292000-08-15 03:34:48 +0000661 /* Convert to long and use its hash. */
662 PyObject *plong; /* converted to Python long */
663 if (Py_IS_INFINITY(intpart))
664 /* can't convert to long int -- arbitrary */
665 v = v < 0 ? -271828.0 : 314159.0;
666 plong = PyLong_FromDouble(v);
667 if (plong == NULL)
668 return -1;
669 x = PyObject_Hash(plong);
670 Py_DECREF(plong);
671 return x;
672 }
673 /* Fits in a C long == a Python int, so is its own hash. */
674 x = (long)intpart;
675 if (x == -1)
676 x = -2;
677 return x;
678 }
679 /* The fractional part is non-zero, so we don't have to worry about
680 * making this match the hash of some other type.
681 * Use frexp to get at the bits in the double.
Fred Drake13634cf2000-06-29 19:17:04 +0000682 * Since the VAX D double format has 56 mantissa bits, which is the
683 * most of any double format in use, each of these parts may have as
684 * many as (but no more than) 56 significant bits.
Tim Peters39dce292000-08-15 03:34:48 +0000685 * So, assuming sizeof(long) >= 4, each part can be broken into two
686 * longs; frexp and multiplication are used to do that.
687 * Also, since the Cray double format has 15 exponent bits, which is
688 * the most of any double format in use, shifting the exponent field
689 * left by 15 won't overflow a long (again assuming sizeof(long) >= 4).
Fred Drake13634cf2000-06-29 19:17:04 +0000690 */
Tim Peters39dce292000-08-15 03:34:48 +0000691 v = frexp(v, &expo);
692 v *= 2147483648.0; /* 2**31 */
693 hipart = (long)v; /* take the top 32 bits */
694 v = (v - (double)hipart) * 2147483648.0; /* get the next 32 bits */
695 x = hipart + (long)v + (expo << 15);
696 if (x == -1)
697 x = -2;
698 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000699}
700
701long
Fred Drake100814d2000-07-09 15:48:49 +0000702_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000703{
Fred Drake13634cf2000-06-29 19:17:04 +0000704 long x;
Antoine Pitrou79eee6b2009-02-13 14:01:05 +0000705 size_t y = (size_t)p;
706 /* bottom 3 or 4 bits are likely to be 0; rotate y by 4 to avoid
707 excessive hash collisions for dicts and sets */
708 y = (y >> 4) | (y << (8 * SIZEOF_VOID_P - 4));
709 x = (long)y;
710 if (x == -1)
711 x = -2;
Fred Drake13634cf2000-06-29 19:17:04 +0000712 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000713}
714
Nick Coghland1abd252008-07-15 15:46:38 +0000715long
716PyObject_HashNotImplemented(PyObject *v)
717{
718 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
719 Py_TYPE(v)->tp_name);
720 return -1;
721}
Fred Drake13634cf2000-06-29 19:17:04 +0000722
Guido van Rossum9bfef441993-03-29 10:43:31 +0000723long
Fred Drake100814d2000-07-09 15:48:49 +0000724PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000725{
Nick Coghland1abd252008-07-15 15:46:38 +0000726 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000727 if (tp->tp_hash != NULL)
728 return (*tp->tp_hash)(v);
Nick Coghlanf1f2f682008-12-30 07:29:12 +0000729 /* To keep to the general practice that inheriting
730 * solely from object in C code should work without
731 * an explicit call to PyType_Ready, we implicitly call
732 * PyType_Ready here and then check the tp_hash slot again
733 */
734 if (tp->tp_dict == NULL) {
735 if (PyType_Ready(tp) < 0)
736 return -1;
737 if (tp->tp_hash != NULL)
738 return (*tp->tp_hash)(v);
739 }
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000740 /* Otherwise, the object can't be hashed */
Nick Coghland1abd252008-07-15 15:46:38 +0000741 return PyObject_HashNotImplemented(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000742}
743
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000744PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000745PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000746{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000747 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000748
Christian Heimes90aa7642007-12-19 02:45:37 +0000749 if (Py_TYPE(v)->tp_getattr != NULL)
750 return (*Py_TYPE(v)->tp_getattr)(v, (char*)name);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000751 w = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000752 if (w == NULL)
753 return NULL;
754 res = PyObject_GetAttr(v, w);
755 Py_XDECREF(w);
756 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000757}
758
759int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000760PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000761{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000762 PyObject *res = PyObject_GetAttrString(v, name);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000763 if (res != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000764 Py_DECREF(res);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000765 return 1;
766 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000767 PyErr_Clear();
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000768 return 0;
769}
770
771int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000772PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000773{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000774 PyObject *s;
775 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000776
Christian Heimes90aa7642007-12-19 02:45:37 +0000777 if (Py_TYPE(v)->tp_setattr != NULL)
778 return (*Py_TYPE(v)->tp_setattr)(v, (char*)name, w);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000779 s = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000780 if (s == NULL)
781 return -1;
782 res = PyObject_SetAttr(v, s, w);
783 Py_XDECREF(s);
784 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000785}
786
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000787PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000788PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000789{
Christian Heimes90aa7642007-12-19 02:45:37 +0000790 PyTypeObject *tp = Py_TYPE(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000791
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000792 if (!PyUnicode_Check(name)) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000793 PyErr_Format(PyExc_TypeError,
794 "attribute name must be string, not '%.200s'",
795 name->ob_type->tp_name);
796 return NULL;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000797 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000798 if (tp->tp_getattro != NULL)
799 return (*tp->tp_getattro)(v, name);
800 if (tp->tp_getattr != NULL)
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000801 return (*tp->tp_getattr)(v, _PyUnicode_AsString(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +0000802 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000803 "'%.50s' object has no attribute '%U'",
804 tp->tp_name, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000805 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000806}
807
808int
Fred Drake100814d2000-07-09 15:48:49 +0000809PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000810{
811 PyObject *res = PyObject_GetAttr(v, name);
812 if (res != NULL) {
813 Py_DECREF(res);
814 return 1;
815 }
816 PyErr_Clear();
817 return 0;
818}
819
820int
Fred Drake100814d2000-07-09 15:48:49 +0000821PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000822{
Christian Heimes90aa7642007-12-19 02:45:37 +0000823 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000824 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000825
Martin v. Löwis5b222132007-06-10 09:51:05 +0000826 if (!PyUnicode_Check(name)) {
827 PyErr_Format(PyExc_TypeError,
828 "attribute name must be string, not '%.200s'",
829 name->ob_type->tp_name);
830 return -1;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000831 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000832 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000833
Martin v. Löwis5b222132007-06-10 09:51:05 +0000834 PyUnicode_InternInPlace(&name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000835 if (tp->tp_setattro != NULL) {
836 err = (*tp->tp_setattro)(v, name, value);
837 Py_DECREF(name);
838 return err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000839 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000840 if (tp->tp_setattr != NULL) {
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000841 err = (*tp->tp_setattr)(v, _PyUnicode_AsString(name), value);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000842 Py_DECREF(name);
843 return err;
844 }
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000845 Py_DECREF(name);
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000846 assert(name->ob_refcnt >= 1);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000847 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
848 PyErr_Format(PyExc_TypeError,
849 "'%.100s' object has no attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000850 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000851 tp->tp_name,
852 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000853 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000854 else
855 PyErr_Format(PyExc_TypeError,
856 "'%.100s' object has only read-only attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000857 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000858 tp->tp_name,
859 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000860 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000861 return -1;
862}
863
864/* Helper to get a pointer to an object's __dict__ slot, if any */
865
866PyObject **
867_PyObject_GetDictPtr(PyObject *obj)
868{
Martin v. Löwis725507b2006-03-07 12:08:51 +0000869 Py_ssize_t dictoffset;
Christian Heimes90aa7642007-12-19 02:45:37 +0000870 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000871
Tim Peters6d6c1a32001-08-02 04:15:00 +0000872 dictoffset = tp->tp_dictoffset;
873 if (dictoffset == 0)
874 return NULL;
875 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000876 Py_ssize_t tsize;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000877 size_t size;
878
879 tsize = ((PyVarObject *)obj)->ob_size;
880 if (tsize < 0)
881 tsize = -tsize;
882 size = _PyObject_VAR_SIZE(tp, tsize);
883
Tim Peters6d483d32001-10-06 21:27:34 +0000884 dictoffset += (long)size;
885 assert(dictoffset > 0);
886 assert(dictoffset % SIZEOF_VOID_P == 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000887 }
888 return (PyObject **) ((char *)obj + dictoffset);
889}
890
Tim Peters6d6c1a32001-08-02 04:15:00 +0000891PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000892PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +0000893{
894 Py_INCREF(obj);
895 return obj;
896}
897
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +0000898/* Helper used when the __next__ method is removed from a type:
899 tp_iternext is never NULL and can be safely called without checking
900 on every iteration.
901 */
902
903PyObject *
904_PyObject_NextNotImplemented(PyObject *self)
905{
906 PyErr_Format(PyExc_TypeError,
907 "'%.200s' object is not iterable",
908 Py_TYPE(self)->tp_name);
909 return NULL;
910}
911
Michael W. Hudson1593f502004-09-14 17:09:47 +0000912/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
913
Raymond Hettinger01538262003-03-17 08:24:35 +0000914PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000915PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
916{
Christian Heimes90aa7642007-12-19 02:45:37 +0000917 PyTypeObject *tp = Py_TYPE(obj);
Guido van Rossum056fbf42002-08-19 19:22:50 +0000918 PyObject *descr = NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000919 PyObject *res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000920 descrgetfunc f;
Martin v. Löwis725507b2006-03-07 12:08:51 +0000921 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000922 PyObject **dictptr;
923
Martin v. Löwis5b222132007-06-10 09:51:05 +0000924 if (!PyUnicode_Check(name)){
925 PyErr_Format(PyExc_TypeError,
926 "attribute name must be string, not '%.200s'",
927 name->ob_type->tp_name);
928 return NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000929 }
930 else
931 Py_INCREF(name);
932
Tim Peters6d6c1a32001-08-02 04:15:00 +0000933 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +0000934 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000935 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000936 }
937
Christian Heimesa62da1d2008-01-12 19:39:10 +0000938#if 0 /* XXX this is not quite _PyType_Lookup anymore */
Guido van Rossum056fbf42002-08-19 19:22:50 +0000939 /* Inline _PyType_Lookup */
940 {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000941 Py_ssize_t i, n;
Guido van Rossum056fbf42002-08-19 19:22:50 +0000942 PyObject *mro, *base, *dict;
943
944 /* Look in tp_dict of types in MRO */
945 mro = tp->tp_mro;
946 assert(mro != NULL);
947 assert(PyTuple_Check(mro));
948 n = PyTuple_GET_SIZE(mro);
949 for (i = 0; i < n; i++) {
950 base = PyTuple_GET_ITEM(mro, i);
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000951 assert(PyType_Check(base));
952 dict = ((PyTypeObject *)base)->tp_dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +0000953 assert(dict && PyDict_Check(dict));
954 descr = PyDict_GetItem(dict, name);
955 if (descr != NULL)
956 break;
957 }
958 }
Christian Heimesa62da1d2008-01-12 19:39:10 +0000959#else
960 descr = _PyType_Lookup(tp, name);
961#endif
Guido van Rossum056fbf42002-08-19 19:22:50 +0000962
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000963 Py_XINCREF(descr);
964
Tim Peters6d6c1a32001-08-02 04:15:00 +0000965 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000966 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000967 f = descr->ob_type->tp_descr_get;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000968 if (f != NULL && PyDescr_IsData(descr)) {
969 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000970 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000971 goto done;
972 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000973 }
974
Guido van Rossumc66ff442002-08-19 16:50:48 +0000975 /* Inline _PyObject_GetDictPtr */
976 dictoffset = tp->tp_dictoffset;
977 if (dictoffset != 0) {
978 PyObject *dict;
979 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000980 Py_ssize_t tsize;
Guido van Rossumc66ff442002-08-19 16:50:48 +0000981 size_t size;
982
983 tsize = ((PyVarObject *)obj)->ob_size;
984 if (tsize < 0)
985 tsize = -tsize;
986 size = _PyObject_VAR_SIZE(tp, tsize);
987
988 dictoffset += (long)size;
989 assert(dictoffset > 0);
990 assert(dictoffset % SIZEOF_VOID_P == 0);
991 }
992 dictptr = (PyObject **) ((char *)obj + dictoffset);
993 dict = *dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000994 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +0000995 Py_INCREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000996 res = PyDict_GetItem(dict, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000997 if (res != NULL) {
998 Py_INCREF(res);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000999 Py_XDECREF(descr);
Christian Heimes969fe572008-01-25 11:23:10 +00001000 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001001 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001002 }
Christian Heimes969fe572008-01-25 11:23:10 +00001003 Py_DECREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001004 }
1005 }
1006
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001007 if (f != NULL) {
Christian Heimes90aa7642007-12-19 02:45:37 +00001008 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001009 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001010 goto done;
1011 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001012
1013 if (descr != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001014 res = descr;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001015 /* descr was already increfed above */
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001016 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001017 }
1018
1019 PyErr_Format(PyExc_AttributeError,
1020 "'%.50s' object has no attribute '%.400s'",
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +00001021 tp->tp_name, _PyUnicode_AsString(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001022 done:
1023 Py_DECREF(name);
1024 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001025}
1026
1027int
1028PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1029{
Christian Heimes90aa7642007-12-19 02:45:37 +00001030 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001031 PyObject *descr;
1032 descrsetfunc f;
1033 PyObject **dictptr;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001034 int res = -1;
1035
Martin v. Löwis5b222132007-06-10 09:51:05 +00001036 if (!PyUnicode_Check(name)){
1037 PyErr_Format(PyExc_TypeError,
1038 "attribute name must be string, not '%.200s'",
1039 name->ob_type->tp_name);
1040 return -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001041 }
1042 else
1043 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001044
1045 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001046 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001047 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001048 }
1049
1050 descr = _PyType_Lookup(tp, name);
1051 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001052 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001053 f = descr->ob_type->tp_descr_set;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001054 if (f != NULL && PyDescr_IsData(descr)) {
1055 res = f(descr, obj, value);
1056 goto done;
1057 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001058 }
1059
1060 dictptr = _PyObject_GetDictPtr(obj);
1061 if (dictptr != NULL) {
1062 PyObject *dict = *dictptr;
1063 if (dict == NULL && value != NULL) {
1064 dict = PyDict_New();
1065 if (dict == NULL)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001066 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001067 *dictptr = dict;
1068 }
1069 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +00001070 Py_INCREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001071 if (value == NULL)
1072 res = PyDict_DelItem(dict, name);
1073 else
1074 res = PyDict_SetItem(dict, name, value);
1075 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1076 PyErr_SetObject(PyExc_AttributeError, name);
Christian Heimes969fe572008-01-25 11:23:10 +00001077 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001078 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001079 }
1080 }
1081
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001082 if (f != NULL) {
1083 res = f(descr, obj, value);
1084 goto done;
1085 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001086
1087 if (descr == NULL) {
1088 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001089 "'%.100s' object has no attribute '%U'",
1090 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001091 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001092 }
1093
1094 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001095 "'%.50s' object attribute '%U' is read-only",
1096 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001097 done:
1098 Py_DECREF(name);
1099 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001100}
1101
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001102/* Test a value used as condition, e.g., in a for or if statement.
1103 Return -1 if an error occurred */
1104
1105int
Fred Drake100814d2000-07-09 15:48:49 +00001106PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001107{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001108 Py_ssize_t res;
Guido van Rossum6248f442002-08-24 06:31:34 +00001109 if (v == Py_True)
1110 return 1;
1111 if (v == Py_False)
1112 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001113 if (v == Py_None)
Neal Norwitz51290d32002-06-13 21:32:44 +00001114 return 0;
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001115 else if (v->ob_type->tp_as_number != NULL &&
Jack Diederich4dafcc42006-11-28 19:15:13 +00001116 v->ob_type->tp_as_number->nb_bool != NULL)
1117 res = (*v->ob_type->tp_as_number->nb_bool)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001118 else if (v->ob_type->tp_as_mapping != NULL &&
1119 v->ob_type->tp_as_mapping->mp_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001120 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001121 else if (v->ob_type->tp_as_sequence != NULL &&
1122 v->ob_type->tp_as_sequence->sq_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001123 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1124 else
Neal Norwitz51290d32002-06-13 21:32:44 +00001125 return 1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001126 /* if it is negative, it should be either -1 or -2 */
1127 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001128}
1129
Tim Peters803526b2002-07-07 05:13:56 +00001130/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001131 Return -1 if an error occurred */
1132
1133int
Fred Drake100814d2000-07-09 15:48:49 +00001134PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001135{
1136 int res;
1137 res = PyObject_IsTrue(v);
1138 if (res < 0)
1139 return res;
1140 return res == 0;
1141}
1142
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001143/* Test whether an object can be called */
1144
1145int
Fred Drake100814d2000-07-09 15:48:49 +00001146PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001147{
1148 if (x == NULL)
1149 return 0;
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001150 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001151}
1152
Georg Brandle32b4222007-03-10 22:13:27 +00001153/* ------------------------- PyObject_Dir() helpers ------------------------- */
1154
Tim Peters7eea37e2001-09-04 22:08:56 +00001155/* Helper for PyObject_Dir.
1156 Merge the __dict__ of aclass into dict, and recursively also all
1157 the __dict__s of aclass's base classes. The order of merging isn't
1158 defined, as it's expected that only the final set of dict keys is
1159 interesting.
1160 Return 0 on success, -1 on error.
1161*/
1162
1163static int
1164merge_class_dict(PyObject* dict, PyObject* aclass)
1165{
1166 PyObject *classdict;
1167 PyObject *bases;
1168
1169 assert(PyDict_Check(dict));
1170 assert(aclass);
1171
1172 /* Merge in the type's dict (if any). */
1173 classdict = PyObject_GetAttrString(aclass, "__dict__");
1174 if (classdict == NULL)
1175 PyErr_Clear();
1176 else {
1177 int status = PyDict_Update(dict, classdict);
1178 Py_DECREF(classdict);
1179 if (status < 0)
1180 return -1;
1181 }
1182
1183 /* Recursively merge in the base types' (if any) dicts. */
1184 bases = PyObject_GetAttrString(aclass, "__bases__");
Tim Petersbc7e8632001-09-16 20:33:22 +00001185 if (bases == NULL)
1186 PyErr_Clear();
1187 else {
Guido van Rossum44022412002-05-13 18:29:46 +00001188 /* We have no guarantee that bases is a real tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001189 Py_ssize_t i, n;
Guido van Rossum44022412002-05-13 18:29:46 +00001190 n = PySequence_Size(bases); /* This better be right */
1191 if (n < 0)
1192 PyErr_Clear();
1193 else {
1194 for (i = 0; i < n; i++) {
Tim Peters18e70832003-02-05 19:35:19 +00001195 int status;
Guido van Rossum44022412002-05-13 18:29:46 +00001196 PyObject *base = PySequence_GetItem(bases, i);
1197 if (base == NULL) {
1198 Py_DECREF(bases);
1199 return -1;
1200 }
Tim Peters18e70832003-02-05 19:35:19 +00001201 status = merge_class_dict(dict, base);
1202 Py_DECREF(base);
1203 if (status < 0) {
Guido van Rossum44022412002-05-13 18:29:46 +00001204 Py_DECREF(bases);
1205 return -1;
1206 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001207 }
1208 }
1209 Py_DECREF(bases);
1210 }
1211 return 0;
1212}
1213
Georg Brandle32b4222007-03-10 22:13:27 +00001214/* Helper for PyObject_Dir without arguments: returns the local scope. */
1215static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001216_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001217{
Georg Brandled3b8382007-03-12 13:15:14 +00001218 PyObject *names;
Georg Brandle32b4222007-03-10 22:13:27 +00001219 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001220
Georg Brandle32b4222007-03-10 22:13:27 +00001221 if (locals == NULL) {
1222 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1223 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001224 }
1225
Georg Brandled3b8382007-03-12 13:15:14 +00001226 names = PyMapping_Keys(locals);
1227 if (!names)
1228 return NULL;
1229 if (!PyList_Check(names)) {
1230 PyErr_Format(PyExc_TypeError,
1231 "dir(): expected keys() of locals to be a list, "
Christian Heimes90aa7642007-12-19 02:45:37 +00001232 "not '%.200s'", Py_TYPE(names)->tp_name);
Georg Brandled3b8382007-03-12 13:15:14 +00001233 Py_DECREF(names);
1234 return NULL;
1235 }
Georg Brandle32b4222007-03-10 22:13:27 +00001236 /* the locals don't need to be DECREF'd */
Georg Brandled3b8382007-03-12 13:15:14 +00001237 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001238}
1239
1240/* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
Guido van Rossum98297ee2007-11-06 21:34:58 +00001241 We deliberately don't suck up its __class__, as methods belonging to the
1242 metaclass would probably be more confusing than helpful.
Georg Brandle32b4222007-03-10 22:13:27 +00001243*/
Guido van Rossum98297ee2007-11-06 21:34:58 +00001244static PyObject *
Georg Brandle32b4222007-03-10 22:13:27 +00001245_specialized_dir_type(PyObject *obj)
1246{
1247 PyObject *result = NULL;
1248 PyObject *dict = PyDict_New();
1249
1250 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1251 result = PyDict_Keys(dict);
1252
1253 Py_XDECREF(dict);
Tim Peters305b5852001-09-17 02:38:46 +00001254 return result;
1255}
1256
Georg Brandle32b4222007-03-10 22:13:27 +00001257/* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1258static PyObject *
1259_specialized_dir_module(PyObject *obj)
Tim Peters7eea37e2001-09-04 22:08:56 +00001260{
Georg Brandle32b4222007-03-10 22:13:27 +00001261 PyObject *result = NULL;
1262 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
Tim Peters7eea37e2001-09-04 22:08:56 +00001263
Georg Brandle32b4222007-03-10 22:13:27 +00001264 if (dict != NULL) {
1265 if (PyDict_Check(dict))
1266 result = PyDict_Keys(dict);
1267 else {
1268 PyErr_Format(PyExc_TypeError,
1269 "%.200s.__dict__ is not a dictionary",
1270 PyModule_GetName(obj));
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001271 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001272 }
1273
Georg Brandle32b4222007-03-10 22:13:27 +00001274 Py_XDECREF(dict);
1275 return result;
1276}
Tim Peters7eea37e2001-09-04 22:08:56 +00001277
Georg Brandle32b4222007-03-10 22:13:27 +00001278/* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1279 and recursively up the __class__.__bases__ chain.
1280*/
1281static PyObject *
1282_generic_dir(PyObject *obj)
1283{
1284 PyObject *result = NULL;
1285 PyObject *dict = NULL;
1286 PyObject *itsclass = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001287
Georg Brandle32b4222007-03-10 22:13:27 +00001288 /* Get __dict__ (which may or may not be a real dict...) */
1289 dict = PyObject_GetAttrString(obj, "__dict__");
1290 if (dict == NULL) {
1291 PyErr_Clear();
1292 dict = PyDict_New();
1293 }
1294 else if (!PyDict_Check(dict)) {
1295 Py_DECREF(dict);
1296 dict = PyDict_New();
1297 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001298 else {
Georg Brandle32b4222007-03-10 22:13:27 +00001299 /* Copy __dict__ to avoid mutating it. */
1300 PyObject *temp = PyDict_Copy(dict);
1301 Py_DECREF(dict);
1302 dict = temp;
Tim Peters7eea37e2001-09-04 22:08:56 +00001303 }
1304
Georg Brandle32b4222007-03-10 22:13:27 +00001305 if (dict == NULL)
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001306 goto error;
Tim Peters7eea37e2001-09-04 22:08:56 +00001307
Georg Brandle32b4222007-03-10 22:13:27 +00001308 /* Merge in attrs reachable from its class. */
1309 itsclass = PyObject_GetAttrString(obj, "__class__");
1310 if (itsclass == NULL)
1311 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1312 __class__ exists? */
1313 PyErr_Clear();
1314 else {
1315 if (merge_class_dict(dict, itsclass) != 0)
1316 goto error;
1317 }
1318
1319 result = PyDict_Keys(dict);
Tim Peters7eea37e2001-09-04 22:08:56 +00001320 /* fall through */
Georg Brandle32b4222007-03-10 22:13:27 +00001321error:
1322 Py_XDECREF(itsclass);
1323 Py_XDECREF(dict);
1324 return result;
1325}
1326
1327/* Helper for PyObject_Dir: object introspection.
1328 This calls one of the above specialized versions if no __dir__ method
1329 exists. */
1330static PyObject *
1331_dir_object(PyObject *obj)
1332{
1333 PyObject * result = NULL;
1334 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1335 "__dir__");
1336
1337 assert(obj);
1338 if (dirfunc == NULL) {
1339 /* use default implementation */
1340 PyErr_Clear();
1341 if (PyModule_Check(obj))
1342 result = _specialized_dir_module(obj);
1343 else if (PyType_Check(obj))
1344 result = _specialized_dir_type(obj);
1345 else
1346 result = _generic_dir(obj);
1347 }
1348 else {
1349 /* use __dir__ */
1350 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1351 Py_DECREF(dirfunc);
1352 if (result == NULL)
1353 return NULL;
1354
1355 /* result must be a list */
1356 /* XXX(gbrandl): could also check if all items are strings */
1357 if (!PyList_Check(result)) {
1358 PyErr_Format(PyExc_TypeError,
1359 "__dir__() must return a list, not %.200s",
Christian Heimes90aa7642007-12-19 02:45:37 +00001360 Py_TYPE(result)->tp_name);
Georg Brandle32b4222007-03-10 22:13:27 +00001361 Py_DECREF(result);
1362 result = NULL;
1363 }
1364 }
1365
1366 return result;
1367}
1368
1369/* Implementation of dir() -- if obj is NULL, returns the names in the current
1370 (local) scope. Otherwise, performs introspection of the object: returns a
1371 sorted list of attribute names (supposedly) accessible from the object
1372*/
1373PyObject *
1374PyObject_Dir(PyObject *obj)
1375{
1376 PyObject * result;
1377
1378 if (obj == NULL)
1379 /* no object -- introspect the locals */
1380 result = _dir_locals();
1381 else
1382 /* object -- introspect the object */
1383 result = _dir_object(obj);
1384
1385 assert(result == NULL || PyList_Check(result));
1386
1387 if (result != NULL && PyList_Sort(result) != 0) {
1388 /* sorting the list failed */
1389 Py_DECREF(result);
1390 result = NULL;
1391 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001392
Tim Peters7eea37e2001-09-04 22:08:56 +00001393 return result;
1394}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001395
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001396/*
1397NoObject is usable as a non-NULL undefined value, used by the macro None.
1398There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001399so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001400(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001401*/
1402
Guido van Rossum0c182a11992-03-27 17:26:13 +00001403/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001404static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001405none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001406{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001407 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001408}
1409
Barry Warsaw9bf16442001-01-23 16:24:35 +00001410/* ARGUSED */
1411static void
Tim Peters803526b2002-07-07 05:13:56 +00001412none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001413{
1414 /* This should never get called, but we also don't want to SEGV if
Mark Dickinson934896d2009-02-21 20:59:32 +00001415 * we accidentally decref None out of existence.
Barry Warsaw9bf16442001-01-23 16:24:35 +00001416 */
Martin v. Löwis3f19b102002-08-07 16:21:51 +00001417 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001418}
1419
1420
Guido van Rossumba21a492001-08-16 08:17:26 +00001421static PyTypeObject PyNone_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001422 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001423 "NoneType",
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001424 0,
1425 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001426 none_dealloc, /*tp_dealloc*/ /*never called*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001427 0, /*tp_print*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001428 0, /*tp_getattr*/
1429 0, /*tp_setattr*/
Mark Dickinsone94c6792009-02-02 20:36:42 +00001430 0, /*tp_reserved*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001431 none_repr, /*tp_repr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001432 0, /*tp_as_number*/
1433 0, /*tp_as_sequence*/
1434 0, /*tp_as_mapping*/
Guido van Rossum9bfef441993-03-29 10:43:31 +00001435 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001436};
1437
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001438PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001439 _PyObject_EXTRA_INIT
1440 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001441};
1442
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001443/* NotImplemented is an object that can be used to signal that an
1444 operation is not implemented for the given type combination. */
1445
1446static PyObject *
1447NotImplemented_repr(PyObject *op)
1448{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001449 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001450}
1451
1452static PyTypeObject PyNotImplemented_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001453 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001454 "NotImplementedType",
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001455 0,
1456 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001457 none_dealloc, /*tp_dealloc*/ /*never called*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001458 0, /*tp_print*/
1459 0, /*tp_getattr*/
1460 0, /*tp_setattr*/
Mark Dickinsone94c6792009-02-02 20:36:42 +00001461 0, /*tp_reserved*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001462 NotImplemented_repr, /*tp_repr*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001463 0, /*tp_as_number*/
1464 0, /*tp_as_sequence*/
1465 0, /*tp_as_mapping*/
1466 0, /*tp_hash */
1467};
1468
1469PyObject _Py_NotImplementedStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001470 _PyObject_EXTRA_INIT
1471 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001472};
1473
Guido van Rossumba21a492001-08-16 08:17:26 +00001474void
1475_Py_ReadyTypes(void)
1476{
1477 if (PyType_Ready(&PyType_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001478 Py_FatalError("Can't initialize type type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001479
Fred Drake0a4dd392004-07-02 18:57:45 +00001480 if (PyType_Ready(&_PyWeakref_RefType) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001481 Py_FatalError("Can't initialize weakref type");
Fred Drake0a4dd392004-07-02 18:57:45 +00001482
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001483 if (PyType_Ready(&_PyWeakref_CallableProxyType) < 0)
1484 Py_FatalError("Can't initialize callable weakref proxy type");
1485
1486 if (PyType_Ready(&_PyWeakref_ProxyType) < 0)
1487 Py_FatalError("Can't initialize weakref proxy type");
1488
Guido van Rossum77f6a652002-04-03 22:41:51 +00001489 if (PyType_Ready(&PyBool_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001490 Py_FatalError("Can't initialize bool type");
Guido van Rossum77f6a652002-04-03 22:41:51 +00001491
Christian Heimes9c4756e2008-05-26 13:22:05 +00001492 if (PyType_Ready(&PyByteArray_Type) < 0)
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001493 Py_FatalError("Can't initialize bytearray type");
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001494
Christian Heimes72b710a2008-05-26 13:28:38 +00001495 if (PyType_Ready(&PyBytes_Type) < 0)
Guido van Rossumcacfc072002-05-24 19:01:59 +00001496 Py_FatalError("Can't initialize 'str'");
1497
Guido van Rossumba21a492001-08-16 08:17:26 +00001498 if (PyType_Ready(&PyList_Type) < 0)
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001499 Py_FatalError("Can't initialize list type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001500
1501 if (PyType_Ready(&PyNone_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001502 Py_FatalError("Can't initialize None type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001503
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001504 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1505 Py_FatalError("Can't initialize type(Ellipsis)");
1506
Guido van Rossumba21a492001-08-16 08:17:26 +00001507 if (PyType_Ready(&PyNotImplemented_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001508 Py_FatalError("Can't initialize NotImplemented type");
1509
1510 if (PyType_Ready(&PyTraceBack_Type) < 0)
1511 Py_FatalError("Can't initialize traceback type");
1512
1513 if (PyType_Ready(&PySuper_Type) < 0)
1514 Py_FatalError("Can't initialize super type");
1515
1516 if (PyType_Ready(&PyBaseObject_Type) < 0)
1517 Py_FatalError("Can't initialize object type");
1518
1519 if (PyType_Ready(&PyRange_Type) < 0)
1520 Py_FatalError("Can't initialize range type");
1521
1522 if (PyType_Ready(&PyDict_Type) < 0)
1523 Py_FatalError("Can't initialize dict type");
1524
1525 if (PyType_Ready(&PySet_Type) < 0)
1526 Py_FatalError("Can't initialize set type");
1527
1528 if (PyType_Ready(&PyUnicode_Type) < 0)
1529 Py_FatalError("Can't initialize str type");
1530
1531 if (PyType_Ready(&PySlice_Type) < 0)
1532 Py_FatalError("Can't initialize slice type");
1533
1534 if (PyType_Ready(&PyStaticMethod_Type) < 0)
1535 Py_FatalError("Can't initialize static method type");
1536
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001537#ifndef WITHOUT_COMPLEX
Benjamin Petersonae937c02009-04-18 20:54:08 +00001538 if (PyType_Ready(&PyComplex_Type) < 0)
1539 Py_FatalError("Can't initialize complex type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001540#endif
Benjamin Petersonae937c02009-04-18 20:54:08 +00001541 if (PyType_Ready(&PyFloat_Type) < 0)
1542 Py_FatalError("Can't initialize float type");
1543
1544 if (PyType_Ready(&PyLong_Type) < 0)
1545 Py_FatalError("Can't initialize int type");
1546
1547 if (PyType_Ready(&PyFrozenSet_Type) < 0)
1548 Py_FatalError("Can't initialize frozenset type");
1549
1550 if (PyType_Ready(&PyProperty_Type) < 0)
1551 Py_FatalError("Can't initialize property type");
1552
1553 if (PyType_Ready(&PyMemoryView_Type) < 0)
1554 Py_FatalError("Can't initialize memoryview type");
1555
1556 if (PyType_Ready(&PyTuple_Type) < 0)
1557 Py_FatalError("Can't initialize tuple type");
1558
1559 if (PyType_Ready(&PyEnum_Type) < 0)
1560 Py_FatalError("Can't initialize enumerate type");
1561
1562 if (PyType_Ready(&PyReversed_Type) < 0)
1563 Py_FatalError("Can't initialize reversed type");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001564
Guido van Rossum826d8972007-10-30 18:34:07 +00001565 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1566 Py_FatalError("Can't initialize StdPrinter");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001567
1568 if (PyType_Ready(&PyCode_Type) < 0)
1569 Py_FatalError("Can't initialize code type");
1570
1571 if (PyType_Ready(&PyFrame_Type) < 0)
1572 Py_FatalError("Can't initialize frame type");
1573
1574 if (PyType_Ready(&PyCFunction_Type) < 0)
1575 Py_FatalError("Can't initialize builtin function type");
1576
1577 if (PyType_Ready(&PyMethod_Type) < 0)
1578 Py_FatalError("Can't initialize method type");
1579
1580 if (PyType_Ready(&PyFunction_Type) < 0)
1581 Py_FatalError("Can't initialize function type");
1582
1583 if (PyType_Ready(&PyDictProxy_Type) < 0)
1584 Py_FatalError("Can't initialize dict proxy type");
1585
1586 if (PyType_Ready(&PyGen_Type) < 0)
1587 Py_FatalError("Can't initialize generator type");
1588
1589 if (PyType_Ready(&PyGetSetDescr_Type) < 0)
1590 Py_FatalError("Can't initialize get-set descriptor type");
1591
1592 if (PyType_Ready(&PyWrapperDescr_Type) < 0)
1593 Py_FatalError("Can't initialize wrapper type");
1594
1595 if (PyType_Ready(&PyEllipsis_Type) < 0)
1596 Py_FatalError("Can't initialize ellipsis type");
1597
1598 if (PyType_Ready(&PyMemberDescr_Type) < 0)
1599 Py_FatalError("Can't initialize member descriptor type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001600
1601 if (PyType_Ready(&PyFilter_Type) < 0)
1602 Py_FatalError("Can't initialize filter type");
1603
1604 if (PyType_Ready(&PyMap_Type) < 0)
1605 Py_FatalError("Can't initialize map type");
1606
1607 if (PyType_Ready(&PyZip_Type) < 0)
1608 Py_FatalError("Can't initialize zip type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001609}
1610
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001611
Guido van Rossum84a90321996-05-22 16:34:47 +00001612#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001613
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001614void
Fred Drake100814d2000-07-09 15:48:49 +00001615_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001616{
Tim Peters34592512002-07-11 06:23:50 +00001617 _Py_INC_REFTOTAL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001618 op->ob_refcnt = 1;
Tim Peters7571a0f2003-03-23 17:52:28 +00001619 _Py_AddToAllObjects(op, 1);
Tim Peters34592512002-07-11 06:23:50 +00001620 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001621}
1622
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001623void
Fred Drake100814d2000-07-09 15:48:49 +00001624_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001625{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001626#ifdef SLOW_UNREF_CHECK
Guido van Rossum4c08d552000-03-10 22:55:18 +00001627 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001628#endif
Guido van Rossumd7047b31995-01-02 19:07:15 +00001629 if (op->ob_refcnt < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001630 Py_FatalError("UNREF negative refcnt");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001631 if (op == &refchain ||
Christian Heimesc8967002007-11-30 10:18:26 +00001632 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1633 fprintf(stderr, "* ob\n");
1634 _PyObject_Dump(op);
1635 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1636 _PyObject_Dump(op->_ob_prev->_ob_next);
1637 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1638 _PyObject_Dump(op->_ob_next->_ob_prev);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001639 Py_FatalError("UNREF invalid object");
Christian Heimesc8967002007-11-30 10:18:26 +00001640 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001641#ifdef SLOW_UNREF_CHECK
Guido van Rossum3f5da241990-12-20 15:06:42 +00001642 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1643 if (p == op)
1644 break;
1645 }
Guido van Rossumd7047b31995-01-02 19:07:15 +00001646 if (p == &refchain) /* Not found */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001647 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001648#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001649 op->_ob_next->_ob_prev = op->_ob_prev;
1650 op->_ob_prev->_ob_next = op->_ob_next;
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001651 op->_ob_next = op->_ob_prev = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001652 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001653}
1654
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001655void
Fred Drake100814d2000-07-09 15:48:49 +00001656_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001657{
Christian Heimes90aa7642007-12-19 02:45:37 +00001658 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001659 _Py_ForgetReference(op);
Guido van Rossum9776adf1994-09-07 14:36:45 +00001660 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001661}
1662
Tim Peters269b2a62003-04-17 19:52:29 +00001663/* Print all live objects. Because PyObject_Print is called, the
1664 * interpreter must be in a healthy state.
1665 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001666void
Fred Drake100814d2000-07-09 15:48:49 +00001667_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001668{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001669 PyObject *op;
Guido van Rossume09fb551997-08-05 02:04:34 +00001670 fprintf(fp, "Remaining objects:\n");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001671 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001672 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001673 if (PyObject_Print(op, fp, 0) != 0)
1674 PyErr_Clear();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001675 putc('\n', fp);
1676 }
1677}
1678
Tim Peters269b2a62003-04-17 19:52:29 +00001679/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1680 * doesn't make any calls to the Python C API, so is always safe to call.
1681 */
1682void
1683_Py_PrintReferenceAddresses(FILE *fp)
1684{
1685 PyObject *op;
1686 fprintf(fp, "Remaining object addresses:\n");
1687 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001688 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
Christian Heimes90aa7642007-12-19 02:45:37 +00001689 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001690}
1691
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001692PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001693_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001694{
1695 int i, n;
1696 PyObject *t = NULL;
1697 PyObject *res, *op;
1698
1699 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1700 return NULL;
1701 op = refchain._ob_next;
1702 res = PyList_New(0);
1703 if (res == NULL)
1704 return NULL;
1705 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1706 while (op == self || op == args || op == res || op == t ||
Christian Heimes90aa7642007-12-19 02:45:37 +00001707 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001708 op = op->_ob_next;
1709 if (op == &refchain)
1710 return res;
1711 }
1712 if (PyList_Append(res, op) < 0) {
1713 Py_DECREF(res);
1714 return NULL;
1715 }
1716 op = op->_ob_next;
1717 }
1718 return res;
1719}
1720
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001721#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001722
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001723/* Hack to force loading of cobject.o */
Guido van Rossumda9c2711996-12-05 21:58:58 +00001724PyTypeObject *_Py_cobject_hack = &PyCObject_Type;
Guido van Rossum84a90321996-05-22 16:34:47 +00001725
1726
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