blob: a332c6c85e3a15c0b690bff6504447c9fbde185d [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum3f5da241990-12-20 15:06:42 +00002/* Generic object operations; and implementation of None (NoObject) */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004#include "Python.h"
Guido van Rossum50e9fb92006-08-17 05:42:55 +00005#include "sliceobject.h" /* For PyEllipsis_Type */
Benjamin Petersonfd838e62009-04-20 02:09:13 +00006#include "frameobject.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00007
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00008#ifdef __cplusplus
9extern "C" {
10#endif
11
Tim Peters34592512002-07-11 06:23:50 +000012#ifdef Py_REF_DEBUG
Neal Norwitz84632ee2006-03-04 20:00:59 +000013Py_ssize_t _Py_RefTotal;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000014
15Py_ssize_t
16_Py_GetRefTotal(void)
17{
18 PyObject *o;
19 Py_ssize_t total = _Py_RefTotal;
20 /* ignore the references to the dummy object of the dicts and sets
21 because they are not reliable and not useful (now that the
22 hash table code is well-tested) */
23 o = _PyDict_Dummy();
24 if (o != NULL)
25 total -= o->ob_refcnt;
26 o = _PySet_Dummy();
27 if (o != NULL)
28 total -= o->ob_refcnt;
29 return total;
30}
31#endif /* Py_REF_DEBUG */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000032
Mark Hammonda2905272002-07-29 13:42:14 +000033int Py_DivisionWarningFlag;
Guido van Rossum393661d2001-08-31 17:40:15 +000034
Guido van Rossum3f5da241990-12-20 15:06:42 +000035/* Object allocation routines used by NEWOBJ and NEWVAROBJ macros.
36 These are used by the individual routines for object creation.
37 Do not call them otherwise, they do not initialize the object! */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000038
Tim Peters78be7992003-03-23 02:51:01 +000039#ifdef Py_TRACE_REFS
Tim Peters7571a0f2003-03-23 17:52:28 +000040/* Head of circular doubly-linked list of all objects. These are linked
41 * together via the _ob_prev and _ob_next members of a PyObject, which
42 * exist only in a Py_TRACE_REFS build.
43 */
Tim Peters78be7992003-03-23 02:51:01 +000044static PyObject refchain = {&refchain, &refchain};
Tim Peters36eb4df2003-03-23 03:33:13 +000045
Tim Peters7571a0f2003-03-23 17:52:28 +000046/* Insert op at the front of the list of all objects. If force is true,
47 * op is added even if _ob_prev and _ob_next are non-NULL already. If
48 * force is false amd _ob_prev or _ob_next are non-NULL, do nothing.
49 * force should be true if and only if op points to freshly allocated,
50 * uninitialized memory, or you've unlinked op from the list and are
Tim Peters51f8d382003-03-23 18:06:08 +000051 * relinking it into the front.
Tim Peters7571a0f2003-03-23 17:52:28 +000052 * Note that objects are normally added to the list via _Py_NewReference,
53 * which is called by PyObject_Init. Not all objects are initialized that
54 * way, though; exceptions include statically allocated type objects, and
55 * statically allocated singletons (like Py_True and Py_None).
56 */
Tim Peters36eb4df2003-03-23 03:33:13 +000057void
Tim Peters7571a0f2003-03-23 17:52:28 +000058_Py_AddToAllObjects(PyObject *op, int force)
Tim Peters36eb4df2003-03-23 03:33:13 +000059{
Tim Peters7571a0f2003-03-23 17:52:28 +000060#ifdef Py_DEBUG
61 if (!force) {
62 /* If it's initialized memory, op must be in or out of
63 * the list unambiguously.
64 */
65 assert((op->_ob_prev == NULL) == (op->_ob_next == NULL));
66 }
Tim Peters78be7992003-03-23 02:51:01 +000067#endif
Tim Peters7571a0f2003-03-23 17:52:28 +000068 if (force || op->_ob_prev == NULL) {
69 op->_ob_next = refchain._ob_next;
70 op->_ob_prev = &refchain;
71 refchain._ob_next->_ob_prev = op;
72 refchain._ob_next = op;
73 }
74}
75#endif /* Py_TRACE_REFS */
Tim Peters78be7992003-03-23 02:51:01 +000076
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000077#ifdef COUNT_ALLOCS
Guido van Rossumc0b618a1997-05-02 03:12:38 +000078static PyTypeObject *type_list;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000079/* All types are added to type_list, at least when
80 they get one object created. That makes them
81 immortal, which unfortunately contributes to
82 garbage itself. If unlist_types_without_objects
83 is set, they will be removed from the type_list
84 once the last object is deallocated. */
Benjamin Petersona4a37fe2009-01-11 17:13:55 +000085static int unlist_types_without_objects;
86extern Py_ssize_t tuple_zero_allocs, fast_tuple_allocs;
87extern Py_ssize_t quick_int_allocs, quick_neg_int_allocs;
88extern Py_ssize_t null_strings, one_strings;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000089void
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000090dump_counts(FILE* f)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000091{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000092 PyTypeObject *tp;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000093
94 for (tp = type_list; tp; tp = tp->tp_next)
Benjamin Petersona4a37fe2009-01-11 17:13:55 +000095 fprintf(f, "%s alloc'd: %" PY_FORMAT_SIZE_T "d, "
96 "freed: %" PY_FORMAT_SIZE_T "d, "
97 "max in use: %" PY_FORMAT_SIZE_T "d\n",
Tim Peters6d6c1a32001-08-02 04:15:00 +000098 tp->tp_name, tp->tp_allocs, tp->tp_frees,
Sjoerd Mullender52c1f511993-10-25 08:40:52 +000099 tp->tp_maxalloc);
Benjamin Petersona4a37fe2009-01-11 17:13:55 +0000100 fprintf(f, "fast tuple allocs: %" PY_FORMAT_SIZE_T "d, "
101 "empty: %" PY_FORMAT_SIZE_T "d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +0000102 fast_tuple_allocs, tuple_zero_allocs);
Benjamin Petersona4a37fe2009-01-11 17:13:55 +0000103 fprintf(f, "fast int allocs: pos: %" PY_FORMAT_SIZE_T "d, "
104 "neg: %" PY_FORMAT_SIZE_T "d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +0000105 quick_int_allocs, quick_neg_int_allocs);
Benjamin Petersona4a37fe2009-01-11 17:13:55 +0000106 fprintf(f, "null strings: %" PY_FORMAT_SIZE_T "d, "
107 "1-strings: %" PY_FORMAT_SIZE_T "d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +0000108 null_strings, one_strings);
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000109}
110
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000111PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000112get_counts(void)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000113{
114 PyTypeObject *tp;
115 PyObject *result;
116 PyObject *v;
117
118 result = PyList_New(0);
119 if (result == NULL)
120 return NULL;
121 for (tp = type_list; tp; tp = tp->tp_next) {
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000122 v = Py_BuildValue("(snnn)", tp->tp_name, tp->tp_allocs,
Tim Peters6d6c1a32001-08-02 04:15:00 +0000123 tp->tp_frees, tp->tp_maxalloc);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000124 if (v == NULL) {
125 Py_DECREF(result);
126 return NULL;
127 }
128 if (PyList_Append(result, v) < 0) {
129 Py_DECREF(v);
130 Py_DECREF(result);
131 return NULL;
132 }
133 Py_DECREF(v);
134 }
135 return result;
136}
137
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000138void
Fred Drake100814d2000-07-09 15:48:49 +0000139inc_count(PyTypeObject *tp)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000140{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000141 if (tp->tp_next == NULL && tp->tp_prev == NULL) {
Guido van Rossumd8953cb1995-04-06 14:46:26 +0000142 /* first time; insert in linked list */
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000143 if (tp->tp_next != NULL) /* sanity check */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000144 Py_FatalError("XXX inc_count sanity check");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000145 if (type_list)
146 type_list->tp_prev = tp;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000147 tp->tp_next = type_list;
Tim Petersc6a3ff62002-07-08 22:11:52 +0000148 /* Note that as of Python 2.2, heap-allocated type objects
149 * can go away, but this code requires that they stay alive
150 * until program exit. That's why we're careful with
151 * refcounts here. type_list gets a new reference to tp,
152 * while ownership of the reference type_list used to hold
153 * (if any) was transferred to tp->tp_next in the line above.
154 * tp is thus effectively immortal after this.
155 */
156 Py_INCREF(tp);
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000157 type_list = tp;
Tim Peters3e40c7f2003-03-23 03:04:32 +0000158#ifdef Py_TRACE_REFS
Tim Peters7571a0f2003-03-23 17:52:28 +0000159 /* Also insert in the doubly-linked list of all objects,
160 * if not already there.
161 */
162 _Py_AddToAllObjects((PyObject *)tp, 0);
Tim Peters78be7992003-03-23 02:51:01 +0000163#endif
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000164 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000165 tp->tp_allocs++;
166 if (tp->tp_allocs - tp->tp_frees > tp->tp_maxalloc)
167 tp->tp_maxalloc = tp->tp_allocs - tp->tp_frees;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000168}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000169
170void dec_count(PyTypeObject *tp)
171{
172 tp->tp_frees++;
173 if (unlist_types_without_objects &&
174 tp->tp_allocs == tp->tp_frees) {
175 /* unlink the type from type_list */
176 if (tp->tp_prev)
177 tp->tp_prev->tp_next = tp->tp_next;
178 else
179 type_list = tp->tp_next;
180 if (tp->tp_next)
181 tp->tp_next->tp_prev = tp->tp_prev;
182 tp->tp_next = tp->tp_prev = NULL;
183 Py_DECREF(tp);
184 }
185}
186
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000187#endif
188
Tim Peters7c321a82002-07-09 02:57:01 +0000189#ifdef Py_REF_DEBUG
190/* Log a fatal error; doesn't return. */
191void
192_Py_NegativeRefcount(const char *fname, int lineno, PyObject *op)
193{
194 char buf[300];
195
196 PyOS_snprintf(buf, sizeof(buf),
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000197 "%s:%i object at %p has negative ref count "
198 "%" PY_FORMAT_SIZE_T "d",
199 fname, lineno, op, op->ob_refcnt);
Tim Peters7c321a82002-07-09 02:57:01 +0000200 Py_FatalError(buf);
201}
202
203#endif /* Py_REF_DEBUG */
204
Thomas Heller1328b522004-04-22 17:23:49 +0000205void
206Py_IncRef(PyObject *o)
207{
208 Py_XINCREF(o);
209}
210
211void
212Py_DecRef(PyObject *o)
213{
214 Py_XDECREF(o);
215}
216
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000217PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000218PyObject_Init(PyObject *op, PyTypeObject *tp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000219{
Guido van Rossum6e08c142002-10-11 20:37:24 +0000220 if (op == NULL)
221 return PyErr_NoMemory();
Guido van Rossumb18618d2000-05-03 23:44:39 +0000222 /* Any changes should be reflected in PyObject_INIT (objimpl.h) */
Christian Heimes90aa7642007-12-19 02:45:37 +0000223 Py_TYPE(op) = tp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000224 _Py_NewReference(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000225 return op;
226}
227
Guido van Rossumb18618d2000-05-03 23:44:39 +0000228PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000229PyObject_InitVar(PyVarObject *op, PyTypeObject *tp, Py_ssize_t size)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000230{
Guido van Rossum6e08c142002-10-11 20:37:24 +0000231 if (op == NULL)
232 return (PyVarObject *) PyErr_NoMemory();
Guido van Rossumb18618d2000-05-03 23:44:39 +0000233 /* Any changes should be reflected in PyObject_INIT_VAR */
234 op->ob_size = size;
Christian Heimes90aa7642007-12-19 02:45:37 +0000235 Py_TYPE(op) = tp;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000236 _Py_NewReference((PyObject *)op);
237 return op;
238}
239
240PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000241_PyObject_New(PyTypeObject *tp)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000242{
243 PyObject *op;
244 op = (PyObject *) PyObject_MALLOC(_PyObject_SIZE(tp));
245 if (op == NULL)
246 return PyErr_NoMemory();
247 return PyObject_INIT(op, tp);
248}
249
Guido van Rossumd0c87ee1997-05-15 21:31:03 +0000250PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000251_PyObject_NewVar(PyTypeObject *tp, Py_ssize_t nitems)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000252{
Guido van Rossumb18618d2000-05-03 23:44:39 +0000253 PyVarObject *op;
Tim Petersf2a67da2001-10-07 03:54:51 +0000254 const size_t size = _PyObject_VAR_SIZE(tp, nitems);
Tim Peters6d483d32001-10-06 21:27:34 +0000255 op = (PyVarObject *) PyObject_MALLOC(size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000256 if (op == NULL)
Guido van Rossumd0c87ee1997-05-15 21:31:03 +0000257 return (PyVarObject *)PyErr_NoMemory();
Tim Peters6d483d32001-10-06 21:27:34 +0000258 return PyObject_INIT_VAR(op, tp, nitems);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000259}
260
Neal Norwitz1a997502003-01-13 20:13:12 +0000261/* Implementation of PyObject_Print with recursion checking */
262static int
263internal_print(PyObject *op, FILE *fp, int flags, int nesting)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000264{
Guido van Rossum278ef591991-07-27 21:40:24 +0000265 int ret = 0;
Neal Norwitz1a997502003-01-13 20:13:12 +0000266 if (nesting > 10) {
267 PyErr_SetString(PyExc_RuntimeError, "print recursion");
268 return -1;
269 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000270 if (PyErr_CheckSignals())
Guido van Rossum90933611991-06-07 16:10:43 +0000271 return -1;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000272#ifdef USE_STACKCHECK
273 if (PyOS_CheckStack()) {
Fred Drake661ea262000-10-24 19:57:45 +0000274 PyErr_SetString(PyExc_MemoryError, "stack overflow");
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000275 return -1;
276 }
277#endif
Guido van Rossum687ef6e2000-01-12 16:28:58 +0000278 clearerr(fp); /* Clear any previous error condition */
Guido van Rossum90933611991-06-07 16:10:43 +0000279 if (op == NULL) {
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000280 Py_BEGIN_ALLOW_THREADS
Guido van Rossum90933611991-06-07 16:10:43 +0000281 fprintf(fp, "<nil>");
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000282 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000283 }
Guido van Rossum90933611991-06-07 16:10:43 +0000284 else {
285 if (op->ob_refcnt <= 0)
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000286 /* XXX(twouters) cast refcount to long until %zd is
287 universally available */
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000288 Py_BEGIN_ALLOW_THREADS
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000289 fprintf(fp, "<refcnt %ld at %p>",
290 (long)op->ob_refcnt, op);
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000291 Py_END_ALLOW_THREADS
Guido van Rossum04dbf3b2007-08-07 19:51:00 +0000292 else {
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000293 PyObject *s;
294 if (flags & Py_PRINT_RAW)
295 s = PyObject_Str(op);
296 else
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000297 s = PyObject_Repr(op);
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000298 if (s == NULL)
299 ret = -1;
Christian Heimes72b710a2008-05-26 13:28:38 +0000300 else if (PyBytes_Check(s)) {
301 fwrite(PyBytes_AS_STRING(s), 1,
302 PyBytes_GET_SIZE(s), fp);
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000303 }
304 else if (PyUnicode_Check(s)) {
305 PyObject *t;
306 t = _PyUnicode_AsDefaultEncodedString(s, NULL);
307 if (t == NULL)
308 ret = 0;
309 else {
Christian Heimes72b710a2008-05-26 13:28:38 +0000310 fwrite(PyBytes_AS_STRING(t), 1,
311 PyBytes_GET_SIZE(t), fp);
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000312 }
313 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000314 else {
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000315 PyErr_Format(PyExc_TypeError,
316 "str() or repr() returned '%.100s'",
317 s->ob_type->tp_name);
318 ret = -1;
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000319 }
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000320 Py_XDECREF(s);
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000321 }
Guido van Rossum90933611991-06-07 16:10:43 +0000322 }
Guido van Rossum278ef591991-07-27 21:40:24 +0000323 if (ret == 0) {
324 if (ferror(fp)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000325 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum278ef591991-07-27 21:40:24 +0000326 clearerr(fp);
327 ret = -1;
328 }
329 }
330 return ret;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000331}
332
Neal Norwitz1a997502003-01-13 20:13:12 +0000333int
334PyObject_Print(PyObject *op, FILE *fp, int flags)
335{
336 return internal_print(op, fp, flags, 0);
337}
338
Guido van Rossum38938152006-08-21 23:36:26 +0000339/* For debugging convenience. Set a breakpoint here and call it from your DLL */
340void
Thomas Woutersb2137042007-02-01 18:02:27 +0000341_Py_BreakPoint(void)
Guido van Rossum38938152006-08-21 23:36:26 +0000342{
343}
344
Neal Norwitz1a997502003-01-13 20:13:12 +0000345
Barry Warsaw9bf16442001-01-23 16:24:35 +0000346/* For debugging convenience. See Misc/gdbinit for some useful gdb hooks */
Guido van Rossum38938152006-08-21 23:36:26 +0000347void
348_PyObject_Dump(PyObject* op)
Barry Warsaw9bf16442001-01-23 16:24:35 +0000349{
Barry Warsaweefb1072001-02-22 22:39:18 +0000350 if (op == NULL)
351 fprintf(stderr, "NULL\n");
352 else {
Georg Brandldfd73442009-04-05 11:47:34 +0000353#ifdef WITH_THREAD
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +0000354 PyGILState_STATE gil;
Georg Brandldfd73442009-04-05 11:47:34 +0000355#endif
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000356 fprintf(stderr, "object : ");
Georg Brandldfd73442009-04-05 11:47:34 +0000357#ifdef WITH_THREAD
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +0000358 gil = PyGILState_Ensure();
Georg Brandldfd73442009-04-05 11:47:34 +0000359#endif
Barry Warsaweefb1072001-02-22 22:39:18 +0000360 (void)PyObject_Print(op, stderr, 0);
Georg Brandldfd73442009-04-05 11:47:34 +0000361#ifdef WITH_THREAD
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +0000362 PyGILState_Release(gil);
Georg Brandldfd73442009-04-05 11:47:34 +0000363#endif
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000364 /* XXX(twouters) cast refcount to long until %zd is
365 universally available */
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000366 fprintf(stderr, "\n"
367 "type : %s\n"
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000368 "refcount: %ld\n"
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000369 "address : %p\n",
Christian Heimes90aa7642007-12-19 02:45:37 +0000370 Py_TYPE(op)==NULL ? "NULL" : Py_TYPE(op)->tp_name,
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000371 (long)op->ob_refcnt,
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000372 op);
Barry Warsaweefb1072001-02-22 22:39:18 +0000373 }
Barry Warsaw9bf16442001-01-23 16:24:35 +0000374}
Barry Warsaw903138f2001-01-23 16:33:18 +0000375
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000376PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000377PyObject_Repr(PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000378{
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000379 PyObject *res;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000380 if (PyErr_CheckSignals())
Guido van Rossum90933611991-06-07 16:10:43 +0000381 return NULL;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000382#ifdef USE_STACKCHECK
383 if (PyOS_CheckStack()) {
Fred Drake661ea262000-10-24 19:57:45 +0000384 PyErr_SetString(PyExc_MemoryError, "stack overflow");
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000385 return NULL;
386 }
387#endif
Guido van Rossum90933611991-06-07 16:10:43 +0000388 if (v == NULL)
Walter Dörwald1ab83302007-05-18 17:15:44 +0000389 return PyUnicode_FromString("<NULL>");
Christian Heimes90aa7642007-12-19 02:45:37 +0000390 if (Py_TYPE(v)->tp_repr == NULL)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000391 return PyUnicode_FromFormat("<%s object at %p>",
392 v->ob_type->tp_name, v);
393 res = (*v->ob_type->tp_repr)(v);
394 if (res != NULL && !PyUnicode_Check(res)) {
395 PyErr_Format(PyExc_TypeError,
396 "__repr__ returned non-string (type %.200s)",
397 res->ob_type->tp_name);
398 Py_DECREF(res);
399 return NULL;
400 }
401 return res;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000402}
403
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000404PyObject *
Guido van Rossum98297ee2007-11-06 21:34:58 +0000405PyObject_Str(PyObject *v)
Guido van Rossumc6004111993-11-05 10:22:19 +0000406{
Guido van Rossum4c08d552000-03-10 22:55:18 +0000407 PyObject *res;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000408 if (PyErr_CheckSignals())
409 return NULL;
410#ifdef USE_STACKCHECK
411 if (PyOS_CheckStack()) {
412 PyErr_SetString(PyExc_MemoryError, "stack overflow");
413 return NULL;
414 }
415#endif
Guido van Rossumc6004111993-11-05 10:22:19 +0000416 if (v == NULL)
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000417 return PyUnicode_FromString("<NULL>");
Neil Schemenauercf52c072005-08-12 17:34:58 +0000418 if (PyUnicode_CheckExact(v)) {
419 Py_INCREF(v);
420 return v;
421 }
Christian Heimes90aa7642007-12-19 02:45:37 +0000422 if (Py_TYPE(v)->tp_str == NULL)
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000423 return PyObject_Repr(v);
424
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000425 /* It is possible for a type to have a tp_str representation that loops
426 infinitely. */
427 if (Py_EnterRecursiveCall(" while getting the str of an object"))
428 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +0000429 res = (*Py_TYPE(v)->tp_str)(v);
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000430 Py_LeaveRecursiveCall();
Guido van Rossum4c08d552000-03-10 22:55:18 +0000431 if (res == NULL)
432 return NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000433 if (!PyUnicode_Check(res)) {
Neil Schemenauercf52c072005-08-12 17:34:58 +0000434 PyErr_Format(PyExc_TypeError,
435 "__str__ returned non-string (type %.200s)",
Christian Heimes90aa7642007-12-19 02:45:37 +0000436 Py_TYPE(res)->tp_name);
Neil Schemenauercf52c072005-08-12 17:34:58 +0000437 Py_DECREF(res);
438 return NULL;
439 }
440 return res;
441}
442
Georg Brandl559e5d72008-06-11 18:37:52 +0000443PyObject *
444PyObject_ASCII(PyObject *v)
445{
446 PyObject *repr, *ascii, *res;
447
448 repr = PyObject_Repr(v);
449 if (repr == NULL)
450 return NULL;
451
452 /* repr is guaranteed to be a PyUnicode object by PyObject_Repr */
453 ascii = PyUnicode_EncodeASCII(
454 PyUnicode_AS_UNICODE(repr),
455 PyUnicode_GET_SIZE(repr),
456 "backslashreplace");
457
458 Py_DECREF(repr);
459 if (ascii == NULL)
460 return NULL;
461
462 res = PyUnicode_DecodeASCII(
463 PyBytes_AS_STRING(ascii),
464 PyBytes_GET_SIZE(ascii),
465 NULL);
466
467 Py_DECREF(ascii);
468 return res;
469}
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000470
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000471PyObject *
472PyObject_Bytes(PyObject *v)
473{
Christian Heimesff869fa2008-08-28 11:28:26 +0000474 PyObject *result, *func;
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000475 static PyObject *bytesstring = NULL;
476
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000477 if (v == NULL)
478 return PyBytes_FromString("<NULL>");
479
480 if (PyBytes_CheckExact(v)) {
481 Py_INCREF(v);
482 return v;
483 }
484
Benjamin Peterson224205f2009-05-08 03:25:19 +0000485 func = _PyObject_LookupSpecial(v, "__bytes__", &bytesstring);
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000486 if (func != NULL) {
Benjamin Petersonda136962009-05-08 03:27:59 +0000487 result = PyObject_CallFunctionObjArgs(func, NULL);
Benjamin Peterson224205f2009-05-08 03:25:19 +0000488 Py_DECREF(func);
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000489 if (result == NULL)
490 return NULL;
491 if (!PyBytes_Check(result)) {
492 PyErr_Format(PyExc_TypeError,
493 "__bytes__ returned non-bytes (type %.200s)",
494 Py_TYPE(result)->tp_name);
495 Py_DECREF(result);
496 return NULL;
497 }
498 return result;
499 }
Benjamin Peterson94c65d92009-05-25 03:10:48 +0000500 else if (PyErr_Occurred())
501 return NULL;
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000502 return PyBytes_FromObject(v);
503}
504
Mark Dickinsonc008a172009-02-01 13:59:22 +0000505/* For Python 3.0.1 and later, the old three-way comparison has been
506 completely removed in favour of rich comparisons. PyObject_Compare() and
507 PyObject_Cmp() are gone, and the builtin cmp function no longer exists.
Mark Dickinsone94c6792009-02-02 20:36:42 +0000508 The old tp_compare slot has been renamed to tp_reserved, and should no
Mark Dickinsonc008a172009-02-01 13:59:22 +0000509 longer be used. Use tp_richcompare instead.
Guido van Rossum98297ee2007-11-06 21:34:58 +0000510
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000511 See (*) below for practical amendments.
512
Mark Dickinsonc008a172009-02-01 13:59:22 +0000513 tp_richcompare gets called with a first argument of the appropriate type
514 and a second object of an arbitrary type. We never do any kind of
515 coercion.
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000516
Mark Dickinsonc008a172009-02-01 13:59:22 +0000517 The tp_richcompare slot should return an object, as follows:
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000518
519 NULL if an exception occurred
520 NotImplemented if the requested comparison is not implemented
521 any other false value if the requested comparison is false
522 any other true value if the requested comparison is true
523
524 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
525 NotImplemented.
526
527 (*) Practical amendments:
528
529 - If rich comparison returns NotImplemented, == and != are decided by
530 comparing the object pointer (i.e. falling back to the base object
531 implementation).
532
Guido van Rossuma4073002002-05-31 20:03:54 +0000533*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000534
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000535/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000536int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000537
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000538static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000539
540/* Perform a rich comparison, raising TypeError when the requested comparison
541 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000542static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000543do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000544{
545 richcmpfunc f;
546 PyObject *res;
Mark Dickinson6f1d0492009-11-15 13:58:49 +0000547 int checked_reverse_op = 0;
Guido van Rossume797ec12001-01-17 15:24:28 +0000548
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000549 if (v->ob_type != w->ob_type &&
550 PyType_IsSubtype(w->ob_type, v->ob_type) &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000551 (f = w->ob_type->tp_richcompare) != NULL) {
Mark Dickinson6f1d0492009-11-15 13:58:49 +0000552 checked_reverse_op = 1;
Tim Petersf4aca752004-09-23 02:39:37 +0000553 res = (*f)(w, v, _Py_SwappedOp[op]);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000554 if (res != Py_NotImplemented)
555 return res;
556 Py_DECREF(res);
557 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000558 if ((f = v->ob_type->tp_richcompare) != NULL) {
Guido van Rossume797ec12001-01-17 15:24:28 +0000559 res = (*f)(v, w, op);
560 if (res != Py_NotImplemented)
561 return res;
562 Py_DECREF(res);
563 }
Mark Dickinson6f1d0492009-11-15 13:58:49 +0000564 if (!checked_reverse_op && (f = w->ob_type->tp_richcompare) != NULL) {
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000565 res = (*f)(w, v, _Py_SwappedOp[op]);
566 if (res != Py_NotImplemented)
567 return res;
568 Py_DECREF(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000569 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000570 /* If neither object implements it, provide a sensible default
571 for == and !=, but raise an exception for ordering. */
572 switch (op) {
573 case Py_EQ:
574 res = (v == w) ? Py_True : Py_False;
575 break;
576 case Py_NE:
577 res = (v != w) ? Py_True : Py_False;
578 break;
579 default:
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000580 /* XXX Special-case None so it doesn't show as NoneType() */
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000581 PyErr_Format(PyExc_TypeError,
582 "unorderable types: %.100s() %s %.100s()",
583 v->ob_type->tp_name,
584 opstrings[op],
585 w->ob_type->tp_name);
586 return NULL;
587 }
Guido van Rossume797ec12001-01-17 15:24:28 +0000588 Py_INCREF(res);
589 return res;
590}
591
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000592/* Perform a rich comparison with object result. This wraps do_richcompare()
593 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000594
Guido van Rossume797ec12001-01-17 15:24:28 +0000595PyObject *
596PyObject_RichCompare(PyObject *v, PyObject *w, int op)
597{
598 PyObject *res;
599
600 assert(Py_LT <= op && op <= Py_GE);
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000601 if (v == NULL || w == NULL) {
602 if (!PyErr_Occurred())
603 PyErr_BadInternalCall();
604 return NULL;
605 }
Mark Dickinson67114932009-12-04 10:06:06 +0000606 if (Py_EnterRecursiveCall(" in comparison"))
Armin Rigo2b3eb402003-10-28 12:05:48 +0000607 return NULL;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000608 res = do_richcompare(v, w, op);
Armin Rigo2b3eb402003-10-28 12:05:48 +0000609 Py_LeaveRecursiveCall();
Guido van Rossume797ec12001-01-17 15:24:28 +0000610 return res;
611}
612
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000613/* Perform a rich comparison with integer result. This wraps
614 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000615int
616PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
617{
Raymond Hettinger93d44812004-03-21 17:01:44 +0000618 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000619 int ok;
620
Mark Dickinson4a1f5932008-11-12 23:23:36 +0000621 /* Quick result when objects are the same.
622 Guarantees that identity implies equality. */
623 if (v == w) {
624 if (op == Py_EQ)
625 return 1;
626 else if (op == Py_NE)
627 return 0;
628 }
629
Raymond Hettinger93d44812004-03-21 17:01:44 +0000630 res = PyObject_RichCompare(v, w, op);
Guido van Rossume797ec12001-01-17 15:24:28 +0000631 if (res == NULL)
632 return -1;
Guido van Rossum81912d42002-08-24 05:33:28 +0000633 if (PyBool_Check(res))
634 ok = (res == Py_True);
635 else
636 ok = PyObject_IsTrue(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000637 Py_DECREF(res);
638 return ok;
639}
Fred Drake13634cf2000-06-29 19:17:04 +0000640
641/* Set of hash utility functions to help maintaining the invariant that
Raymond Hettinger8183fa42004-03-21 17:35:06 +0000642 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000643
644 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
645*/
646
647long
Fred Drake100814d2000-07-09 15:48:49 +0000648_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000649{
Tim Peters39dce292000-08-15 03:34:48 +0000650 double intpart, fractpart;
651 int expo;
652 long hipart;
653 long x; /* the final hash value */
654 /* This is designed so that Python numbers of different types
655 * that compare equal hash to the same value; otherwise comparisons
656 * of mapping keys will turn out weird.
657 */
658
Tim Peters39dce292000-08-15 03:34:48 +0000659 fractpart = modf(v, &intpart);
Tim Peters39dce292000-08-15 03:34:48 +0000660 if (fractpart == 0.0) {
661 /* This must return the same hash as an equal int or long. */
Mark Dickinsonc96db472009-02-08 15:09:21 +0000662 if (intpart > LONG_MAX/2 || -intpart > LONG_MAX/2) {
Tim Peters39dce292000-08-15 03:34:48 +0000663 /* Convert to long and use its hash. */
664 PyObject *plong; /* converted to Python long */
665 if (Py_IS_INFINITY(intpart))
666 /* can't convert to long int -- arbitrary */
667 v = v < 0 ? -271828.0 : 314159.0;
668 plong = PyLong_FromDouble(v);
669 if (plong == NULL)
670 return -1;
671 x = PyObject_Hash(plong);
672 Py_DECREF(plong);
673 return x;
674 }
675 /* Fits in a C long == a Python int, so is its own hash. */
676 x = (long)intpart;
677 if (x == -1)
678 x = -2;
679 return x;
680 }
681 /* The fractional part is non-zero, so we don't have to worry about
682 * making this match the hash of some other type.
683 * Use frexp to get at the bits in the double.
Fred Drake13634cf2000-06-29 19:17:04 +0000684 * Since the VAX D double format has 56 mantissa bits, which is the
685 * most of any double format in use, each of these parts may have as
686 * many as (but no more than) 56 significant bits.
Tim Peters39dce292000-08-15 03:34:48 +0000687 * So, assuming sizeof(long) >= 4, each part can be broken into two
688 * longs; frexp and multiplication are used to do that.
689 * Also, since the Cray double format has 15 exponent bits, which is
690 * the most of any double format in use, shifting the exponent field
691 * left by 15 won't overflow a long (again assuming sizeof(long) >= 4).
Fred Drake13634cf2000-06-29 19:17:04 +0000692 */
Tim Peters39dce292000-08-15 03:34:48 +0000693 v = frexp(v, &expo);
694 v *= 2147483648.0; /* 2**31 */
695 hipart = (long)v; /* take the top 32 bits */
696 v = (v - (double)hipart) * 2147483648.0; /* get the next 32 bits */
697 x = hipart + (long)v + (expo << 15);
698 if (x == -1)
699 x = -2;
700 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000701}
702
703long
Fred Drake100814d2000-07-09 15:48:49 +0000704_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000705{
Fred Drake13634cf2000-06-29 19:17:04 +0000706 long x;
Antoine Pitrou79eee6b2009-02-13 14:01:05 +0000707 size_t y = (size_t)p;
708 /* bottom 3 or 4 bits are likely to be 0; rotate y by 4 to avoid
709 excessive hash collisions for dicts and sets */
710 y = (y >> 4) | (y << (8 * SIZEOF_VOID_P - 4));
711 x = (long)y;
712 if (x == -1)
713 x = -2;
Fred Drake13634cf2000-06-29 19:17:04 +0000714 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000715}
716
Nick Coghland1abd252008-07-15 15:46:38 +0000717long
718PyObject_HashNotImplemented(PyObject *v)
719{
720 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
721 Py_TYPE(v)->tp_name);
722 return -1;
723}
Fred Drake13634cf2000-06-29 19:17:04 +0000724
Guido van Rossum9bfef441993-03-29 10:43:31 +0000725long
Fred Drake100814d2000-07-09 15:48:49 +0000726PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000727{
Nick Coghland1abd252008-07-15 15:46:38 +0000728 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000729 if (tp->tp_hash != NULL)
730 return (*tp->tp_hash)(v);
Nick Coghlanf1f2f682008-12-30 07:29:12 +0000731 /* To keep to the general practice that inheriting
732 * solely from object in C code should work without
733 * an explicit call to PyType_Ready, we implicitly call
734 * PyType_Ready here and then check the tp_hash slot again
735 */
736 if (tp->tp_dict == NULL) {
737 if (PyType_Ready(tp) < 0)
738 return -1;
739 if (tp->tp_hash != NULL)
740 return (*tp->tp_hash)(v);
741 }
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000742 /* Otherwise, the object can't be hashed */
Nick Coghland1abd252008-07-15 15:46:38 +0000743 return PyObject_HashNotImplemented(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000744}
745
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000746PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000747PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000748{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000749 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000750
Christian Heimes90aa7642007-12-19 02:45:37 +0000751 if (Py_TYPE(v)->tp_getattr != NULL)
752 return (*Py_TYPE(v)->tp_getattr)(v, (char*)name);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000753 w = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000754 if (w == NULL)
755 return NULL;
756 res = PyObject_GetAttr(v, w);
757 Py_XDECREF(w);
758 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000759}
760
761int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000762PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000763{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000764 PyObject *res = PyObject_GetAttrString(v, name);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000765 if (res != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000766 Py_DECREF(res);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000767 return 1;
768 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000769 PyErr_Clear();
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000770 return 0;
771}
772
773int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000774PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000775{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000776 PyObject *s;
777 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000778
Christian Heimes90aa7642007-12-19 02:45:37 +0000779 if (Py_TYPE(v)->tp_setattr != NULL)
780 return (*Py_TYPE(v)->tp_setattr)(v, (char*)name, w);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000781 s = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000782 if (s == NULL)
783 return -1;
784 res = PyObject_SetAttr(v, s, w);
785 Py_XDECREF(s);
786 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000787}
788
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000789PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000790PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000791{
Christian Heimes90aa7642007-12-19 02:45:37 +0000792 PyTypeObject *tp = Py_TYPE(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000793
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000794 if (!PyUnicode_Check(name)) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000795 PyErr_Format(PyExc_TypeError,
796 "attribute name must be string, not '%.200s'",
797 name->ob_type->tp_name);
798 return NULL;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000799 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000800 if (tp->tp_getattro != NULL)
801 return (*tp->tp_getattro)(v, name);
Victor Stinner624dbf62010-03-12 17:17:58 +0000802 if (tp->tp_getattr != NULL) {
803 char *name_str = _PyUnicode_AsString(name);
804 if (name_str == NULL)
805 return NULL;
806 return (*tp->tp_getattr)(v, name_str);
807 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000808 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000809 "'%.50s' object has no attribute '%U'",
810 tp->tp_name, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000811 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000812}
813
814int
Fred Drake100814d2000-07-09 15:48:49 +0000815PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000816{
817 PyObject *res = PyObject_GetAttr(v, name);
818 if (res != NULL) {
819 Py_DECREF(res);
820 return 1;
821 }
822 PyErr_Clear();
823 return 0;
824}
825
826int
Fred Drake100814d2000-07-09 15:48:49 +0000827PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000828{
Christian Heimes90aa7642007-12-19 02:45:37 +0000829 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000830 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000831
Martin v. Löwis5b222132007-06-10 09:51:05 +0000832 if (!PyUnicode_Check(name)) {
833 PyErr_Format(PyExc_TypeError,
834 "attribute name must be string, not '%.200s'",
835 name->ob_type->tp_name);
836 return -1;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000837 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000838 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000839
Martin v. Löwis5b222132007-06-10 09:51:05 +0000840 PyUnicode_InternInPlace(&name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000841 if (tp->tp_setattro != NULL) {
842 err = (*tp->tp_setattro)(v, name, value);
843 Py_DECREF(name);
844 return err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000845 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000846 if (tp->tp_setattr != NULL) {
Victor Stinner624dbf62010-03-12 17:17:58 +0000847 char *name_str = _PyUnicode_AsString(name);
848 if (name_str == NULL)
849 return -1;
850 err = (*tp->tp_setattr)(v, name_str, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000851 Py_DECREF(name);
852 return err;
853 }
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000854 Py_DECREF(name);
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000855 assert(name->ob_refcnt >= 1);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000856 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
857 PyErr_Format(PyExc_TypeError,
858 "'%.100s' object has no attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000859 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000860 tp->tp_name,
861 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000862 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000863 else
864 PyErr_Format(PyExc_TypeError,
865 "'%.100s' object has only read-only attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000866 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000867 tp->tp_name,
868 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000869 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000870 return -1;
871}
872
873/* Helper to get a pointer to an object's __dict__ slot, if any */
874
875PyObject **
876_PyObject_GetDictPtr(PyObject *obj)
877{
Martin v. Löwis725507b2006-03-07 12:08:51 +0000878 Py_ssize_t dictoffset;
Christian Heimes90aa7642007-12-19 02:45:37 +0000879 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000880
Tim Peters6d6c1a32001-08-02 04:15:00 +0000881 dictoffset = tp->tp_dictoffset;
882 if (dictoffset == 0)
883 return NULL;
884 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000885 Py_ssize_t tsize;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000886 size_t size;
887
888 tsize = ((PyVarObject *)obj)->ob_size;
889 if (tsize < 0)
890 tsize = -tsize;
891 size = _PyObject_VAR_SIZE(tp, tsize);
892
Tim Peters6d483d32001-10-06 21:27:34 +0000893 dictoffset += (long)size;
894 assert(dictoffset > 0);
895 assert(dictoffset % SIZEOF_VOID_P == 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000896 }
897 return (PyObject **) ((char *)obj + dictoffset);
898}
899
Tim Peters6d6c1a32001-08-02 04:15:00 +0000900PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000901PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +0000902{
903 Py_INCREF(obj);
904 return obj;
905}
906
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +0000907/* Helper used when the __next__ method is removed from a type:
908 tp_iternext is never NULL and can be safely called without checking
909 on every iteration.
910 */
911
912PyObject *
913_PyObject_NextNotImplemented(PyObject *self)
914{
915 PyErr_Format(PyExc_TypeError,
916 "'%.200s' object is not iterable",
917 Py_TYPE(self)->tp_name);
918 return NULL;
919}
920
Michael W. Hudson1593f502004-09-14 17:09:47 +0000921/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
922
Raymond Hettinger01538262003-03-17 08:24:35 +0000923PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000924PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
925{
Christian Heimes90aa7642007-12-19 02:45:37 +0000926 PyTypeObject *tp = Py_TYPE(obj);
Guido van Rossum056fbf42002-08-19 19:22:50 +0000927 PyObject *descr = NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000928 PyObject *res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000929 descrgetfunc f;
Martin v. Löwis725507b2006-03-07 12:08:51 +0000930 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000931 PyObject **dictptr;
932
Martin v. Löwis5b222132007-06-10 09:51:05 +0000933 if (!PyUnicode_Check(name)){
934 PyErr_Format(PyExc_TypeError,
935 "attribute name must be string, not '%.200s'",
936 name->ob_type->tp_name);
937 return NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000938 }
939 else
940 Py_INCREF(name);
941
Tim Peters6d6c1a32001-08-02 04:15:00 +0000942 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +0000943 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000944 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000945 }
946
Christian Heimesa62da1d2008-01-12 19:39:10 +0000947#if 0 /* XXX this is not quite _PyType_Lookup anymore */
Guido van Rossum056fbf42002-08-19 19:22:50 +0000948 /* Inline _PyType_Lookup */
949 {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000950 Py_ssize_t i, n;
Guido van Rossum056fbf42002-08-19 19:22:50 +0000951 PyObject *mro, *base, *dict;
952
953 /* Look in tp_dict of types in MRO */
954 mro = tp->tp_mro;
955 assert(mro != NULL);
956 assert(PyTuple_Check(mro));
957 n = PyTuple_GET_SIZE(mro);
958 for (i = 0; i < n; i++) {
959 base = PyTuple_GET_ITEM(mro, i);
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000960 assert(PyType_Check(base));
961 dict = ((PyTypeObject *)base)->tp_dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +0000962 assert(dict && PyDict_Check(dict));
963 descr = PyDict_GetItem(dict, name);
964 if (descr != NULL)
965 break;
966 }
967 }
Christian Heimesa62da1d2008-01-12 19:39:10 +0000968#else
969 descr = _PyType_Lookup(tp, name);
970#endif
Guido van Rossum056fbf42002-08-19 19:22:50 +0000971
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000972 Py_XINCREF(descr);
973
Tim Peters6d6c1a32001-08-02 04:15:00 +0000974 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000975 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000976 f = descr->ob_type->tp_descr_get;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000977 if (f != NULL && PyDescr_IsData(descr)) {
978 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000979 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000980 goto done;
981 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000982 }
983
Guido van Rossumc66ff442002-08-19 16:50:48 +0000984 /* Inline _PyObject_GetDictPtr */
985 dictoffset = tp->tp_dictoffset;
986 if (dictoffset != 0) {
987 PyObject *dict;
988 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000989 Py_ssize_t tsize;
Guido van Rossumc66ff442002-08-19 16:50:48 +0000990 size_t size;
991
992 tsize = ((PyVarObject *)obj)->ob_size;
993 if (tsize < 0)
994 tsize = -tsize;
995 size = _PyObject_VAR_SIZE(tp, tsize);
996
997 dictoffset += (long)size;
998 assert(dictoffset > 0);
999 assert(dictoffset % SIZEOF_VOID_P == 0);
1000 }
1001 dictptr = (PyObject **) ((char *)obj + dictoffset);
1002 dict = *dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001003 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +00001004 Py_INCREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001005 res = PyDict_GetItem(dict, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001006 if (res != NULL) {
1007 Py_INCREF(res);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001008 Py_XDECREF(descr);
Christian Heimes969fe572008-01-25 11:23:10 +00001009 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001010 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001011 }
Christian Heimes969fe572008-01-25 11:23:10 +00001012 Py_DECREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001013 }
1014 }
1015
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001016 if (f != NULL) {
Christian Heimes90aa7642007-12-19 02:45:37 +00001017 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001018 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001019 goto done;
1020 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001021
1022 if (descr != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001023 res = descr;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001024 /* descr was already increfed above */
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001025 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001026 }
1027
1028 PyErr_Format(PyExc_AttributeError,
Victor Stinner624dbf62010-03-12 17:17:58 +00001029 "'%.50s' object has no attribute '%U'",
1030 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001031 done:
1032 Py_DECREF(name);
1033 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001034}
1035
1036int
1037PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1038{
Christian Heimes90aa7642007-12-19 02:45:37 +00001039 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001040 PyObject *descr;
1041 descrsetfunc f;
1042 PyObject **dictptr;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001043 int res = -1;
1044
Martin v. Löwis5b222132007-06-10 09:51:05 +00001045 if (!PyUnicode_Check(name)){
1046 PyErr_Format(PyExc_TypeError,
1047 "attribute name must be string, not '%.200s'",
1048 name->ob_type->tp_name);
1049 return -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001050 }
1051 else
1052 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001053
1054 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001055 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001056 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001057 }
1058
1059 descr = _PyType_Lookup(tp, name);
1060 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001061 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001062 f = descr->ob_type->tp_descr_set;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001063 if (f != NULL && PyDescr_IsData(descr)) {
1064 res = f(descr, obj, value);
1065 goto done;
1066 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001067 }
1068
1069 dictptr = _PyObject_GetDictPtr(obj);
1070 if (dictptr != NULL) {
1071 PyObject *dict = *dictptr;
1072 if (dict == NULL && value != NULL) {
1073 dict = PyDict_New();
1074 if (dict == NULL)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001075 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001076 *dictptr = dict;
1077 }
1078 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +00001079 Py_INCREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001080 if (value == NULL)
1081 res = PyDict_DelItem(dict, name);
1082 else
1083 res = PyDict_SetItem(dict, name, value);
1084 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1085 PyErr_SetObject(PyExc_AttributeError, name);
Christian Heimes969fe572008-01-25 11:23:10 +00001086 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001087 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001088 }
1089 }
1090
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001091 if (f != NULL) {
1092 res = f(descr, obj, value);
1093 goto done;
1094 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001095
1096 if (descr == NULL) {
1097 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001098 "'%.100s' object has no attribute '%U'",
1099 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001100 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001101 }
1102
1103 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001104 "'%.50s' object attribute '%U' is read-only",
1105 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001106 done:
1107 Py_DECREF(name);
1108 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001109}
1110
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001111/* Test a value used as condition, e.g., in a for or if statement.
1112 Return -1 if an error occurred */
1113
1114int
Fred Drake100814d2000-07-09 15:48:49 +00001115PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001116{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001117 Py_ssize_t res;
Guido van Rossum6248f442002-08-24 06:31:34 +00001118 if (v == Py_True)
1119 return 1;
1120 if (v == Py_False)
1121 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001122 if (v == Py_None)
Neal Norwitz51290d32002-06-13 21:32:44 +00001123 return 0;
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001124 else if (v->ob_type->tp_as_number != NULL &&
Jack Diederich4dafcc42006-11-28 19:15:13 +00001125 v->ob_type->tp_as_number->nb_bool != NULL)
1126 res = (*v->ob_type->tp_as_number->nb_bool)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001127 else if (v->ob_type->tp_as_mapping != NULL &&
1128 v->ob_type->tp_as_mapping->mp_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001129 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001130 else if (v->ob_type->tp_as_sequence != NULL &&
1131 v->ob_type->tp_as_sequence->sq_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001132 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1133 else
Neal Norwitz51290d32002-06-13 21:32:44 +00001134 return 1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001135 /* if it is negative, it should be either -1 or -2 */
1136 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001137}
1138
Tim Peters803526b2002-07-07 05:13:56 +00001139/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001140 Return -1 if an error occurred */
1141
1142int
Fred Drake100814d2000-07-09 15:48:49 +00001143PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001144{
1145 int res;
1146 res = PyObject_IsTrue(v);
1147 if (res < 0)
1148 return res;
1149 return res == 0;
1150}
1151
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001152/* Test whether an object can be called */
1153
1154int
Fred Drake100814d2000-07-09 15:48:49 +00001155PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001156{
1157 if (x == NULL)
1158 return 0;
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001159 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001160}
1161
Georg Brandle32b4222007-03-10 22:13:27 +00001162/* ------------------------- PyObject_Dir() helpers ------------------------- */
1163
Tim Peters7eea37e2001-09-04 22:08:56 +00001164/* Helper for PyObject_Dir.
1165 Merge the __dict__ of aclass into dict, and recursively also all
1166 the __dict__s of aclass's base classes. The order of merging isn't
1167 defined, as it's expected that only the final set of dict keys is
1168 interesting.
1169 Return 0 on success, -1 on error.
1170*/
1171
1172static int
1173merge_class_dict(PyObject* dict, PyObject* aclass)
1174{
1175 PyObject *classdict;
1176 PyObject *bases;
1177
1178 assert(PyDict_Check(dict));
1179 assert(aclass);
1180
1181 /* Merge in the type's dict (if any). */
1182 classdict = PyObject_GetAttrString(aclass, "__dict__");
1183 if (classdict == NULL)
1184 PyErr_Clear();
1185 else {
1186 int status = PyDict_Update(dict, classdict);
1187 Py_DECREF(classdict);
1188 if (status < 0)
1189 return -1;
1190 }
1191
1192 /* Recursively merge in the base types' (if any) dicts. */
1193 bases = PyObject_GetAttrString(aclass, "__bases__");
Tim Petersbc7e8632001-09-16 20:33:22 +00001194 if (bases == NULL)
1195 PyErr_Clear();
1196 else {
Guido van Rossum44022412002-05-13 18:29:46 +00001197 /* We have no guarantee that bases is a real tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001198 Py_ssize_t i, n;
Guido van Rossum44022412002-05-13 18:29:46 +00001199 n = PySequence_Size(bases); /* This better be right */
1200 if (n < 0)
1201 PyErr_Clear();
1202 else {
1203 for (i = 0; i < n; i++) {
Tim Peters18e70832003-02-05 19:35:19 +00001204 int status;
Guido van Rossum44022412002-05-13 18:29:46 +00001205 PyObject *base = PySequence_GetItem(bases, i);
1206 if (base == NULL) {
1207 Py_DECREF(bases);
1208 return -1;
1209 }
Tim Peters18e70832003-02-05 19:35:19 +00001210 status = merge_class_dict(dict, base);
1211 Py_DECREF(base);
1212 if (status < 0) {
Guido van Rossum44022412002-05-13 18:29:46 +00001213 Py_DECREF(bases);
1214 return -1;
1215 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001216 }
1217 }
1218 Py_DECREF(bases);
1219 }
1220 return 0;
1221}
1222
Georg Brandle32b4222007-03-10 22:13:27 +00001223/* Helper for PyObject_Dir without arguments: returns the local scope. */
1224static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001225_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001226{
Georg Brandled3b8382007-03-12 13:15:14 +00001227 PyObject *names;
Georg Brandle32b4222007-03-10 22:13:27 +00001228 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001229
Georg Brandle32b4222007-03-10 22:13:27 +00001230 if (locals == NULL) {
1231 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1232 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001233 }
1234
Georg Brandled3b8382007-03-12 13:15:14 +00001235 names = PyMapping_Keys(locals);
1236 if (!names)
1237 return NULL;
1238 if (!PyList_Check(names)) {
1239 PyErr_Format(PyExc_TypeError,
1240 "dir(): expected keys() of locals to be a list, "
Christian Heimes90aa7642007-12-19 02:45:37 +00001241 "not '%.200s'", Py_TYPE(names)->tp_name);
Georg Brandled3b8382007-03-12 13:15:14 +00001242 Py_DECREF(names);
1243 return NULL;
1244 }
Georg Brandle32b4222007-03-10 22:13:27 +00001245 /* the locals don't need to be DECREF'd */
Georg Brandled3b8382007-03-12 13:15:14 +00001246 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001247}
1248
1249/* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
Guido van Rossum98297ee2007-11-06 21:34:58 +00001250 We deliberately don't suck up its __class__, as methods belonging to the
1251 metaclass would probably be more confusing than helpful.
Georg Brandle32b4222007-03-10 22:13:27 +00001252*/
Guido van Rossum98297ee2007-11-06 21:34:58 +00001253static PyObject *
Georg Brandle32b4222007-03-10 22:13:27 +00001254_specialized_dir_type(PyObject *obj)
1255{
1256 PyObject *result = NULL;
1257 PyObject *dict = PyDict_New();
1258
1259 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1260 result = PyDict_Keys(dict);
1261
1262 Py_XDECREF(dict);
Tim Peters305b5852001-09-17 02:38:46 +00001263 return result;
1264}
1265
Georg Brandle32b4222007-03-10 22:13:27 +00001266/* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1267static PyObject *
1268_specialized_dir_module(PyObject *obj)
Tim Peters7eea37e2001-09-04 22:08:56 +00001269{
Georg Brandle32b4222007-03-10 22:13:27 +00001270 PyObject *result = NULL;
1271 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
Tim Peters7eea37e2001-09-04 22:08:56 +00001272
Georg Brandle32b4222007-03-10 22:13:27 +00001273 if (dict != NULL) {
1274 if (PyDict_Check(dict))
1275 result = PyDict_Keys(dict);
1276 else {
Benjamin Peterson14327712009-08-15 13:23:05 +00001277 const char *name = PyModule_GetName(obj);
1278 if (name)
1279 PyErr_Format(PyExc_TypeError,
1280 "%.200s.__dict__ is not a dictionary",
1281 name);
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001282 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001283 }
1284
Georg Brandle32b4222007-03-10 22:13:27 +00001285 Py_XDECREF(dict);
1286 return result;
1287}
Tim Peters7eea37e2001-09-04 22:08:56 +00001288
Georg Brandle32b4222007-03-10 22:13:27 +00001289/* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1290 and recursively up the __class__.__bases__ chain.
1291*/
1292static PyObject *
1293_generic_dir(PyObject *obj)
1294{
1295 PyObject *result = NULL;
1296 PyObject *dict = NULL;
1297 PyObject *itsclass = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001298
Georg Brandle32b4222007-03-10 22:13:27 +00001299 /* Get __dict__ (which may or may not be a real dict...) */
1300 dict = PyObject_GetAttrString(obj, "__dict__");
1301 if (dict == NULL) {
1302 PyErr_Clear();
1303 dict = PyDict_New();
1304 }
1305 else if (!PyDict_Check(dict)) {
1306 Py_DECREF(dict);
1307 dict = PyDict_New();
1308 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001309 else {
Georg Brandle32b4222007-03-10 22:13:27 +00001310 /* Copy __dict__ to avoid mutating it. */
1311 PyObject *temp = PyDict_Copy(dict);
1312 Py_DECREF(dict);
1313 dict = temp;
Tim Peters7eea37e2001-09-04 22:08:56 +00001314 }
1315
Georg Brandle32b4222007-03-10 22:13:27 +00001316 if (dict == NULL)
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001317 goto error;
Tim Peters7eea37e2001-09-04 22:08:56 +00001318
Georg Brandle32b4222007-03-10 22:13:27 +00001319 /* Merge in attrs reachable from its class. */
1320 itsclass = PyObject_GetAttrString(obj, "__class__");
1321 if (itsclass == NULL)
1322 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1323 __class__ exists? */
1324 PyErr_Clear();
1325 else {
1326 if (merge_class_dict(dict, itsclass) != 0)
1327 goto error;
1328 }
1329
1330 result = PyDict_Keys(dict);
Tim Peters7eea37e2001-09-04 22:08:56 +00001331 /* fall through */
Georg Brandle32b4222007-03-10 22:13:27 +00001332error:
1333 Py_XDECREF(itsclass);
1334 Py_XDECREF(dict);
1335 return result;
1336}
1337
1338/* Helper for PyObject_Dir: object introspection.
1339 This calls one of the above specialized versions if no __dir__ method
1340 exists. */
1341static PyObject *
1342_dir_object(PyObject *obj)
1343{
1344 PyObject * result = NULL;
1345 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1346 "__dir__");
1347
1348 assert(obj);
1349 if (dirfunc == NULL) {
1350 /* use default implementation */
1351 PyErr_Clear();
1352 if (PyModule_Check(obj))
1353 result = _specialized_dir_module(obj);
1354 else if (PyType_Check(obj))
1355 result = _specialized_dir_type(obj);
1356 else
1357 result = _generic_dir(obj);
1358 }
1359 else {
1360 /* use __dir__ */
1361 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1362 Py_DECREF(dirfunc);
1363 if (result == NULL)
1364 return NULL;
1365
1366 /* result must be a list */
1367 /* XXX(gbrandl): could also check if all items are strings */
1368 if (!PyList_Check(result)) {
1369 PyErr_Format(PyExc_TypeError,
1370 "__dir__() must return a list, not %.200s",
Christian Heimes90aa7642007-12-19 02:45:37 +00001371 Py_TYPE(result)->tp_name);
Georg Brandle32b4222007-03-10 22:13:27 +00001372 Py_DECREF(result);
1373 result = NULL;
1374 }
1375 }
1376
1377 return result;
1378}
1379
1380/* Implementation of dir() -- if obj is NULL, returns the names in the current
1381 (local) scope. Otherwise, performs introspection of the object: returns a
1382 sorted list of attribute names (supposedly) accessible from the object
1383*/
1384PyObject *
1385PyObject_Dir(PyObject *obj)
1386{
1387 PyObject * result;
1388
1389 if (obj == NULL)
1390 /* no object -- introspect the locals */
1391 result = _dir_locals();
1392 else
1393 /* object -- introspect the object */
1394 result = _dir_object(obj);
1395
1396 assert(result == NULL || PyList_Check(result));
1397
1398 if (result != NULL && PyList_Sort(result) != 0) {
1399 /* sorting the list failed */
1400 Py_DECREF(result);
1401 result = NULL;
1402 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001403
Tim Peters7eea37e2001-09-04 22:08:56 +00001404 return result;
1405}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001406
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001407/*
1408NoObject is usable as a non-NULL undefined value, used by the macro None.
1409There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001410so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001411(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001412*/
1413
Guido van Rossum0c182a11992-03-27 17:26:13 +00001414/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001415static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001416none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001417{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001418 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001419}
1420
Barry Warsaw9bf16442001-01-23 16:24:35 +00001421/* ARGUSED */
1422static void
Tim Peters803526b2002-07-07 05:13:56 +00001423none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001424{
1425 /* This should never get called, but we also don't want to SEGV if
Mark Dickinson934896d2009-02-21 20:59:32 +00001426 * we accidentally decref None out of existence.
Barry Warsaw9bf16442001-01-23 16:24:35 +00001427 */
Martin v. Löwis3f19b102002-08-07 16:21:51 +00001428 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001429}
1430
1431
Guido van Rossumba21a492001-08-16 08:17:26 +00001432static PyTypeObject PyNone_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001433 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001434 "NoneType",
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001435 0,
1436 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001437 none_dealloc, /*tp_dealloc*/ /*never called*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001438 0, /*tp_print*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001439 0, /*tp_getattr*/
1440 0, /*tp_setattr*/
Mark Dickinsone94c6792009-02-02 20:36:42 +00001441 0, /*tp_reserved*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001442 none_repr, /*tp_repr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001443 0, /*tp_as_number*/
1444 0, /*tp_as_sequence*/
1445 0, /*tp_as_mapping*/
Guido van Rossum9bfef441993-03-29 10:43:31 +00001446 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001447};
1448
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001449PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001450 _PyObject_EXTRA_INIT
1451 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001452};
1453
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001454/* NotImplemented is an object that can be used to signal that an
1455 operation is not implemented for the given type combination. */
1456
1457static PyObject *
1458NotImplemented_repr(PyObject *op)
1459{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001460 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001461}
1462
1463static PyTypeObject PyNotImplemented_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001464 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001465 "NotImplementedType",
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001466 0,
1467 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001468 none_dealloc, /*tp_dealloc*/ /*never called*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001469 0, /*tp_print*/
1470 0, /*tp_getattr*/
1471 0, /*tp_setattr*/
Mark Dickinsone94c6792009-02-02 20:36:42 +00001472 0, /*tp_reserved*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001473 NotImplemented_repr, /*tp_repr*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001474 0, /*tp_as_number*/
1475 0, /*tp_as_sequence*/
1476 0, /*tp_as_mapping*/
1477 0, /*tp_hash */
1478};
1479
1480PyObject _Py_NotImplementedStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001481 _PyObject_EXTRA_INIT
1482 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001483};
1484
Guido van Rossumba21a492001-08-16 08:17:26 +00001485void
1486_Py_ReadyTypes(void)
1487{
1488 if (PyType_Ready(&PyType_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001489 Py_FatalError("Can't initialize type type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001490
Fred Drake0a4dd392004-07-02 18:57:45 +00001491 if (PyType_Ready(&_PyWeakref_RefType) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001492 Py_FatalError("Can't initialize weakref type");
Fred Drake0a4dd392004-07-02 18:57:45 +00001493
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001494 if (PyType_Ready(&_PyWeakref_CallableProxyType) < 0)
1495 Py_FatalError("Can't initialize callable weakref proxy type");
1496
1497 if (PyType_Ready(&_PyWeakref_ProxyType) < 0)
1498 Py_FatalError("Can't initialize weakref proxy type");
1499
Guido van Rossum77f6a652002-04-03 22:41:51 +00001500 if (PyType_Ready(&PyBool_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001501 Py_FatalError("Can't initialize bool type");
Guido van Rossum77f6a652002-04-03 22:41:51 +00001502
Christian Heimes9c4756e2008-05-26 13:22:05 +00001503 if (PyType_Ready(&PyByteArray_Type) < 0)
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001504 Py_FatalError("Can't initialize bytearray type");
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001505
Christian Heimes72b710a2008-05-26 13:28:38 +00001506 if (PyType_Ready(&PyBytes_Type) < 0)
Guido van Rossumcacfc072002-05-24 19:01:59 +00001507 Py_FatalError("Can't initialize 'str'");
1508
Guido van Rossumba21a492001-08-16 08:17:26 +00001509 if (PyType_Ready(&PyList_Type) < 0)
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001510 Py_FatalError("Can't initialize list type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001511
1512 if (PyType_Ready(&PyNone_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001513 Py_FatalError("Can't initialize None type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001514
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001515 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1516 Py_FatalError("Can't initialize type(Ellipsis)");
1517
Guido van Rossumba21a492001-08-16 08:17:26 +00001518 if (PyType_Ready(&PyNotImplemented_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001519 Py_FatalError("Can't initialize NotImplemented type");
1520
1521 if (PyType_Ready(&PyTraceBack_Type) < 0)
1522 Py_FatalError("Can't initialize traceback type");
1523
1524 if (PyType_Ready(&PySuper_Type) < 0)
1525 Py_FatalError("Can't initialize super type");
1526
1527 if (PyType_Ready(&PyBaseObject_Type) < 0)
1528 Py_FatalError("Can't initialize object type");
1529
1530 if (PyType_Ready(&PyRange_Type) < 0)
1531 Py_FatalError("Can't initialize range type");
1532
1533 if (PyType_Ready(&PyDict_Type) < 0)
1534 Py_FatalError("Can't initialize dict type");
1535
1536 if (PyType_Ready(&PySet_Type) < 0)
1537 Py_FatalError("Can't initialize set type");
1538
1539 if (PyType_Ready(&PyUnicode_Type) < 0)
1540 Py_FatalError("Can't initialize str type");
1541
1542 if (PyType_Ready(&PySlice_Type) < 0)
1543 Py_FatalError("Can't initialize slice type");
1544
1545 if (PyType_Ready(&PyStaticMethod_Type) < 0)
1546 Py_FatalError("Can't initialize static method type");
1547
1548 if (PyType_Ready(&PyComplex_Type) < 0)
1549 Py_FatalError("Can't initialize complex type");
Skip Montanaroba1e0f42009-10-18 14:25:35 +00001550
Benjamin Petersonae937c02009-04-18 20:54:08 +00001551 if (PyType_Ready(&PyFloat_Type) < 0)
1552 Py_FatalError("Can't initialize float type");
1553
1554 if (PyType_Ready(&PyLong_Type) < 0)
1555 Py_FatalError("Can't initialize int type");
1556
1557 if (PyType_Ready(&PyFrozenSet_Type) < 0)
1558 Py_FatalError("Can't initialize frozenset type");
1559
1560 if (PyType_Ready(&PyProperty_Type) < 0)
1561 Py_FatalError("Can't initialize property type");
1562
1563 if (PyType_Ready(&PyMemoryView_Type) < 0)
1564 Py_FatalError("Can't initialize memoryview type");
1565
1566 if (PyType_Ready(&PyTuple_Type) < 0)
1567 Py_FatalError("Can't initialize tuple type");
1568
1569 if (PyType_Ready(&PyEnum_Type) < 0)
1570 Py_FatalError("Can't initialize enumerate type");
1571
1572 if (PyType_Ready(&PyReversed_Type) < 0)
1573 Py_FatalError("Can't initialize reversed type");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001574
Guido van Rossum826d8972007-10-30 18:34:07 +00001575 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1576 Py_FatalError("Can't initialize StdPrinter");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001577
1578 if (PyType_Ready(&PyCode_Type) < 0)
1579 Py_FatalError("Can't initialize code type");
1580
1581 if (PyType_Ready(&PyFrame_Type) < 0)
1582 Py_FatalError("Can't initialize frame type");
1583
1584 if (PyType_Ready(&PyCFunction_Type) < 0)
1585 Py_FatalError("Can't initialize builtin function type");
1586
1587 if (PyType_Ready(&PyMethod_Type) < 0)
1588 Py_FatalError("Can't initialize method type");
1589
1590 if (PyType_Ready(&PyFunction_Type) < 0)
1591 Py_FatalError("Can't initialize function type");
1592
1593 if (PyType_Ready(&PyDictProxy_Type) < 0)
1594 Py_FatalError("Can't initialize dict proxy type");
1595
1596 if (PyType_Ready(&PyGen_Type) < 0)
1597 Py_FatalError("Can't initialize generator type");
1598
1599 if (PyType_Ready(&PyGetSetDescr_Type) < 0)
1600 Py_FatalError("Can't initialize get-set descriptor type");
1601
1602 if (PyType_Ready(&PyWrapperDescr_Type) < 0)
1603 Py_FatalError("Can't initialize wrapper type");
1604
1605 if (PyType_Ready(&PyEllipsis_Type) < 0)
1606 Py_FatalError("Can't initialize ellipsis type");
1607
1608 if (PyType_Ready(&PyMemberDescr_Type) < 0)
1609 Py_FatalError("Can't initialize member descriptor type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001610
1611 if (PyType_Ready(&PyFilter_Type) < 0)
1612 Py_FatalError("Can't initialize filter type");
1613
1614 if (PyType_Ready(&PyMap_Type) < 0)
1615 Py_FatalError("Can't initialize map type");
1616
1617 if (PyType_Ready(&PyZip_Type) < 0)
1618 Py_FatalError("Can't initialize zip type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001619}
1620
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001621
Guido van Rossum84a90321996-05-22 16:34:47 +00001622#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001623
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001624void
Fred Drake100814d2000-07-09 15:48:49 +00001625_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001626{
Tim Peters34592512002-07-11 06:23:50 +00001627 _Py_INC_REFTOTAL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001628 op->ob_refcnt = 1;
Tim Peters7571a0f2003-03-23 17:52:28 +00001629 _Py_AddToAllObjects(op, 1);
Tim Peters34592512002-07-11 06:23:50 +00001630 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001631}
1632
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001633void
Fred Drake100814d2000-07-09 15:48:49 +00001634_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001635{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001636#ifdef SLOW_UNREF_CHECK
Guido van Rossum4c08d552000-03-10 22:55:18 +00001637 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001638#endif
Guido van Rossumd7047b31995-01-02 19:07:15 +00001639 if (op->ob_refcnt < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001640 Py_FatalError("UNREF negative refcnt");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001641 if (op == &refchain ||
Christian Heimesc8967002007-11-30 10:18:26 +00001642 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1643 fprintf(stderr, "* ob\n");
1644 _PyObject_Dump(op);
1645 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1646 _PyObject_Dump(op->_ob_prev->_ob_next);
1647 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1648 _PyObject_Dump(op->_ob_next->_ob_prev);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001649 Py_FatalError("UNREF invalid object");
Christian Heimesc8967002007-11-30 10:18:26 +00001650 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001651#ifdef SLOW_UNREF_CHECK
Guido van Rossum3f5da241990-12-20 15:06:42 +00001652 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1653 if (p == op)
1654 break;
1655 }
Guido van Rossumd7047b31995-01-02 19:07:15 +00001656 if (p == &refchain) /* Not found */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001657 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001658#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001659 op->_ob_next->_ob_prev = op->_ob_prev;
1660 op->_ob_prev->_ob_next = op->_ob_next;
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001661 op->_ob_next = op->_ob_prev = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001662 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001663}
1664
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001665void
Fred Drake100814d2000-07-09 15:48:49 +00001666_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001667{
Christian Heimes90aa7642007-12-19 02:45:37 +00001668 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001669 _Py_ForgetReference(op);
Guido van Rossum9776adf1994-09-07 14:36:45 +00001670 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001671}
1672
Tim Peters269b2a62003-04-17 19:52:29 +00001673/* Print all live objects. Because PyObject_Print is called, the
1674 * interpreter must be in a healthy state.
1675 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001676void
Fred Drake100814d2000-07-09 15:48:49 +00001677_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001678{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001679 PyObject *op;
Guido van Rossume09fb551997-08-05 02:04:34 +00001680 fprintf(fp, "Remaining objects:\n");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001681 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001682 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001683 if (PyObject_Print(op, fp, 0) != 0)
1684 PyErr_Clear();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001685 putc('\n', fp);
1686 }
1687}
1688
Tim Peters269b2a62003-04-17 19:52:29 +00001689/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1690 * doesn't make any calls to the Python C API, so is always safe to call.
1691 */
1692void
1693_Py_PrintReferenceAddresses(FILE *fp)
1694{
1695 PyObject *op;
1696 fprintf(fp, "Remaining object addresses:\n");
1697 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001698 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
Christian Heimes90aa7642007-12-19 02:45:37 +00001699 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001700}
1701
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001702PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001703_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001704{
1705 int i, n;
1706 PyObject *t = NULL;
1707 PyObject *res, *op;
1708
1709 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1710 return NULL;
1711 op = refchain._ob_next;
1712 res = PyList_New(0);
1713 if (res == NULL)
1714 return NULL;
1715 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1716 while (op == self || op == args || op == res || op == t ||
Christian Heimes90aa7642007-12-19 02:45:37 +00001717 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001718 op = op->_ob_next;
1719 if (op == &refchain)
1720 return res;
1721 }
1722 if (PyList_Append(res, op) < 0) {
1723 Py_DECREF(res);
1724 return NULL;
1725 }
1726 op = op->_ob_next;
1727 }
1728 return res;
1729}
1730
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001731#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001732
Guido van Rossum84a90321996-05-22 16:34:47 +00001733
Benjamin Petersonb173f782009-05-05 22:31:58 +00001734/* Hack to force loading of pycapsule.o */
1735PyTypeObject *_PyCapsule_hack = &PyCapsule_Type;
1736
1737
Guido van Rossum84a90321996-05-22 16:34:47 +00001738/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001739Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001740
1741
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001742/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001743
Thomas Wouters334fb892000-07-25 12:56:38 +00001744void *
Fred Drake100814d2000-07-09 15:48:49 +00001745PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001746{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001747 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001748}
1749
Thomas Wouters334fb892000-07-25 12:56:38 +00001750void *
1751PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001752{
Tim Petersaf3e8de2002-04-12 07:22:56 +00001753 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001754}
1755
1756void
Thomas Wouters334fb892000-07-25 12:56:38 +00001757PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001758{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001759 PyMem_FREE(p);
1760}
1761
1762
Guido van Rossum86610361998-04-10 22:32:46 +00001763/* These methods are used to control infinite recursion in repr, str, print,
1764 etc. Container objects that may recursively contain themselves,
1765 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1766 Py_ReprLeave() to avoid infinite recursion.
1767
1768 Py_ReprEnter() returns 0 the first time it is called for a particular
1769 object and 1 every time thereafter. It returns -1 if an exception
1770 occurred. Py_ReprLeave() has no return value.
1771
1772 See dictobject.c and listobject.c for examples of use.
1773*/
1774
1775#define KEY "Py_Repr"
1776
1777int
Fred Drake100814d2000-07-09 15:48:49 +00001778Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001779{
1780 PyObject *dict;
1781 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001782 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001783
1784 dict = PyThreadState_GetDict();
1785 if (dict == NULL)
Guido van Rossum0fc8f002003-04-15 15:12:39 +00001786 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001787 list = PyDict_GetItemString(dict, KEY);
1788 if (list == NULL) {
1789 list = PyList_New(0);
1790 if (list == NULL)
1791 return -1;
1792 if (PyDict_SetItemString(dict, KEY, list) < 0)
1793 return -1;
1794 Py_DECREF(list);
1795 }
1796 i = PyList_GET_SIZE(list);
1797 while (--i >= 0) {
1798 if (PyList_GET_ITEM(list, i) == obj)
1799 return 1;
1800 }
1801 PyList_Append(list, obj);
1802 return 0;
1803}
1804
1805void
Fred Drake100814d2000-07-09 15:48:49 +00001806Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001807{
1808 PyObject *dict;
1809 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001810 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001811
1812 dict = PyThreadState_GetDict();
Guido van Rossumeb909461998-04-11 15:17:34 +00001813 if (dict == NULL)
1814 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001815 list = PyDict_GetItemString(dict, KEY);
Guido van Rossumeb909461998-04-11 15:17:34 +00001816 if (list == NULL || !PyList_Check(list))
1817 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001818 i = PyList_GET_SIZE(list);
1819 /* Count backwards because we always expect obj to be list[-1] */
1820 while (--i >= 0) {
1821 if (PyList_GET_ITEM(list, i) == obj) {
1822 PyList_SetSlice(list, i, i + 1, NULL);
1823 break;
1824 }
1825 }
1826}
Guido van Rossumd724b232000-03-13 16:01:29 +00001827
Tim Peters803526b2002-07-07 05:13:56 +00001828/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001829
Tim Peters803526b2002-07-07 05:13:56 +00001830/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001831int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001832
Tim Peters803526b2002-07-07 05:13:56 +00001833/* List of objects that still need to be cleaned up, singly linked via their
1834 * gc headers' gc_prev pointers.
1835 */
1836PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001837
Tim Peters803526b2002-07-07 05:13:56 +00001838/* Add op to the _PyTrash_delete_later list. Called when the current
1839 * call-stack depth gets large. op must be a currently untracked gc'ed
1840 * object, with refcount 0. Py_DECREF must already have been called on it.
1841 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001842void
Fred Drake100814d2000-07-09 15:48:49 +00001843_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001844{
Tim Peters803526b2002-07-07 05:13:56 +00001845 assert(PyObject_IS_GC(op));
1846 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1847 assert(op->ob_refcnt == 0);
Neil Schemenauerf589c052002-03-29 03:05:54 +00001848 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
Guido van Rossume92e6102000-04-24 15:40:53 +00001849 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001850}
1851
Tim Peters803526b2002-07-07 05:13:56 +00001852/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1853 * the call-stack unwinds again.
1854 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001855void
Fred Drake100814d2000-07-09 15:48:49 +00001856_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001857{
1858 while (_PyTrash_delete_later) {
Tim Peters803526b2002-07-07 05:13:56 +00001859 PyObject *op = _PyTrash_delete_later;
Christian Heimes90aa7642007-12-19 02:45:37 +00001860 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001861
Neil Schemenauerf589c052002-03-29 03:05:54 +00001862 _PyTrash_delete_later =
Tim Peters803526b2002-07-07 05:13:56 +00001863 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001864
Tim Peters803526b2002-07-07 05:13:56 +00001865 /* Call the deallocator directly. This used to try to
1866 * fool Py_DECREF into calling it indirectly, but
1867 * Py_DECREF was already called on this object, and in
1868 * assorted non-release builds calling Py_DECREF again ends
1869 * up distorting allocation statistics.
1870 */
1871 assert(op->ob_refcnt == 0);
Guido van Rossumd724b232000-03-13 16:01:29 +00001872 ++_PyTrash_delete_nesting;
Tim Peters803526b2002-07-07 05:13:56 +00001873 (*dealloc)(op);
Guido van Rossumd724b232000-03-13 16:01:29 +00001874 --_PyTrash_delete_nesting;
1875 }
1876}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001877
1878#ifdef __cplusplus
1879}
1880#endif