blob: eba061ba09386e2db4649ab8367196a54e8b5dc6 [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 }
Mark Dickinsonadef1ba2009-12-04 10:07:01 +0000604 if (Py_EnterRecursiveCall(" in comparison"))
Armin Rigo2b3eb402003-10-28 12:05:48 +0000605 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);
Victor Stinner7f045cf2010-03-21 21:07:44 +0000800 if (tp->tp_getattr != NULL) {
801 char *name_str = _PyUnicode_AsString(name);
802 if (name_str == NULL)
803 return NULL;
804 return (*tp->tp_getattr)(v, name_str);
805 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000806 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000807 "'%.50s' object has no attribute '%U'",
808 tp->tp_name, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000809 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000810}
811
812int
Fred Drake100814d2000-07-09 15:48:49 +0000813PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000814{
815 PyObject *res = PyObject_GetAttr(v, name);
816 if (res != NULL) {
817 Py_DECREF(res);
818 return 1;
819 }
820 PyErr_Clear();
821 return 0;
822}
823
824int
Fred Drake100814d2000-07-09 15:48:49 +0000825PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000826{
Christian Heimes90aa7642007-12-19 02:45:37 +0000827 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000828 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000829
Martin v. Löwis5b222132007-06-10 09:51:05 +0000830 if (!PyUnicode_Check(name)) {
831 PyErr_Format(PyExc_TypeError,
832 "attribute name must be string, not '%.200s'",
833 name->ob_type->tp_name);
834 return -1;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000835 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000836 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000837
Martin v. Löwis5b222132007-06-10 09:51:05 +0000838 PyUnicode_InternInPlace(&name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000839 if (tp->tp_setattro != NULL) {
840 err = (*tp->tp_setattro)(v, name, value);
841 Py_DECREF(name);
842 return err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000843 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000844 if (tp->tp_setattr != NULL) {
Victor Stinner7f045cf2010-03-21 21:07:44 +0000845 char *name_str = _PyUnicode_AsString(name);
846 if (name_str == NULL)
847 return -1;
848 err = (*tp->tp_setattr)(v, name_str, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000849 Py_DECREF(name);
850 return err;
851 }
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000852 Py_DECREF(name);
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000853 assert(name->ob_refcnt >= 1);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000854 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
855 PyErr_Format(PyExc_TypeError,
856 "'%.100s' object has no 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 else
862 PyErr_Format(PyExc_TypeError,
863 "'%.100s' object has only read-only attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000864 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000865 tp->tp_name,
866 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000867 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000868 return -1;
869}
870
871/* Helper to get a pointer to an object's __dict__ slot, if any */
872
873PyObject **
874_PyObject_GetDictPtr(PyObject *obj)
875{
Martin v. Löwis725507b2006-03-07 12:08:51 +0000876 Py_ssize_t dictoffset;
Christian Heimes90aa7642007-12-19 02:45:37 +0000877 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000878
Tim Peters6d6c1a32001-08-02 04:15:00 +0000879 dictoffset = tp->tp_dictoffset;
880 if (dictoffset == 0)
881 return NULL;
882 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000883 Py_ssize_t tsize;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000884 size_t size;
885
886 tsize = ((PyVarObject *)obj)->ob_size;
887 if (tsize < 0)
888 tsize = -tsize;
889 size = _PyObject_VAR_SIZE(tp, tsize);
890
Tim Peters6d483d32001-10-06 21:27:34 +0000891 dictoffset += (long)size;
892 assert(dictoffset > 0);
893 assert(dictoffset % SIZEOF_VOID_P == 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000894 }
895 return (PyObject **) ((char *)obj + dictoffset);
896}
897
Tim Peters6d6c1a32001-08-02 04:15:00 +0000898PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000899PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +0000900{
901 Py_INCREF(obj);
902 return obj;
903}
904
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +0000905/* Helper used when the __next__ method is removed from a type:
906 tp_iternext is never NULL and can be safely called without checking
907 on every iteration.
908 */
909
910PyObject *
911_PyObject_NextNotImplemented(PyObject *self)
912{
913 PyErr_Format(PyExc_TypeError,
914 "'%.200s' object is not iterable",
915 Py_TYPE(self)->tp_name);
916 return NULL;
917}
918
Michael W. Hudson1593f502004-09-14 17:09:47 +0000919/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
920
Raymond Hettinger01538262003-03-17 08:24:35 +0000921PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000922PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
923{
Christian Heimes90aa7642007-12-19 02:45:37 +0000924 PyTypeObject *tp = Py_TYPE(obj);
Guido van Rossum056fbf42002-08-19 19:22:50 +0000925 PyObject *descr = NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000926 PyObject *res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000927 descrgetfunc f;
Martin v. Löwis725507b2006-03-07 12:08:51 +0000928 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000929 PyObject **dictptr;
930
Martin v. Löwis5b222132007-06-10 09:51:05 +0000931 if (!PyUnicode_Check(name)){
932 PyErr_Format(PyExc_TypeError,
933 "attribute name must be string, not '%.200s'",
934 name->ob_type->tp_name);
935 return NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000936 }
937 else
938 Py_INCREF(name);
939
Tim Peters6d6c1a32001-08-02 04:15:00 +0000940 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +0000941 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000942 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000943 }
944
Christian Heimesa62da1d2008-01-12 19:39:10 +0000945#if 0 /* XXX this is not quite _PyType_Lookup anymore */
Guido van Rossum056fbf42002-08-19 19:22:50 +0000946 /* Inline _PyType_Lookup */
947 {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000948 Py_ssize_t i, n;
Guido van Rossum056fbf42002-08-19 19:22:50 +0000949 PyObject *mro, *base, *dict;
950
951 /* Look in tp_dict of types in MRO */
952 mro = tp->tp_mro;
953 assert(mro != NULL);
954 assert(PyTuple_Check(mro));
955 n = PyTuple_GET_SIZE(mro);
956 for (i = 0; i < n; i++) {
957 base = PyTuple_GET_ITEM(mro, i);
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000958 assert(PyType_Check(base));
959 dict = ((PyTypeObject *)base)->tp_dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +0000960 assert(dict && PyDict_Check(dict));
961 descr = PyDict_GetItem(dict, name);
962 if (descr != NULL)
963 break;
964 }
965 }
Christian Heimesa62da1d2008-01-12 19:39:10 +0000966#else
967 descr = _PyType_Lookup(tp, name);
968#endif
Guido van Rossum056fbf42002-08-19 19:22:50 +0000969
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000970 Py_XINCREF(descr);
971
Tim Peters6d6c1a32001-08-02 04:15:00 +0000972 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000973 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000974 f = descr->ob_type->tp_descr_get;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000975 if (f != NULL && PyDescr_IsData(descr)) {
976 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000977 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000978 goto done;
979 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000980 }
981
Guido van Rossumc66ff442002-08-19 16:50:48 +0000982 /* Inline _PyObject_GetDictPtr */
983 dictoffset = tp->tp_dictoffset;
984 if (dictoffset != 0) {
985 PyObject *dict;
986 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000987 Py_ssize_t tsize;
Guido van Rossumc66ff442002-08-19 16:50:48 +0000988 size_t size;
989
990 tsize = ((PyVarObject *)obj)->ob_size;
991 if (tsize < 0)
992 tsize = -tsize;
993 size = _PyObject_VAR_SIZE(tp, tsize);
994
995 dictoffset += (long)size;
996 assert(dictoffset > 0);
997 assert(dictoffset % SIZEOF_VOID_P == 0);
998 }
999 dictptr = (PyObject **) ((char *)obj + dictoffset);
1000 dict = *dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001001 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +00001002 Py_INCREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001003 res = PyDict_GetItem(dict, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001004 if (res != NULL) {
1005 Py_INCREF(res);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001006 Py_XDECREF(descr);
Christian Heimes969fe572008-01-25 11:23:10 +00001007 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001008 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001009 }
Christian Heimes969fe572008-01-25 11:23:10 +00001010 Py_DECREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001011 }
1012 }
1013
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001014 if (f != NULL) {
Christian Heimes90aa7642007-12-19 02:45:37 +00001015 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001016 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001017 goto done;
1018 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001019
1020 if (descr != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001021 res = descr;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001022 /* descr was already increfed above */
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001023 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001024 }
1025
1026 PyErr_Format(PyExc_AttributeError,
Victor Stinner7f045cf2010-03-21 21:07:44 +00001027 "'%.50s' object has no attribute '%U'",
1028 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001029 done:
1030 Py_DECREF(name);
1031 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001032}
1033
1034int
1035PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1036{
Christian Heimes90aa7642007-12-19 02:45:37 +00001037 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001038 PyObject *descr;
1039 descrsetfunc f;
1040 PyObject **dictptr;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001041 int res = -1;
1042
Martin v. Löwis5b222132007-06-10 09:51:05 +00001043 if (!PyUnicode_Check(name)){
1044 PyErr_Format(PyExc_TypeError,
1045 "attribute name must be string, not '%.200s'",
1046 name->ob_type->tp_name);
1047 return -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001048 }
1049 else
1050 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001051
1052 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001053 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001054 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001055 }
1056
1057 descr = _PyType_Lookup(tp, name);
1058 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001059 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001060 f = descr->ob_type->tp_descr_set;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001061 if (f != NULL && PyDescr_IsData(descr)) {
1062 res = f(descr, obj, value);
1063 goto done;
1064 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001065 }
1066
1067 dictptr = _PyObject_GetDictPtr(obj);
1068 if (dictptr != NULL) {
1069 PyObject *dict = *dictptr;
1070 if (dict == NULL && value != NULL) {
1071 dict = PyDict_New();
1072 if (dict == NULL)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001073 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001074 *dictptr = dict;
1075 }
1076 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +00001077 Py_INCREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001078 if (value == NULL)
1079 res = PyDict_DelItem(dict, name);
1080 else
1081 res = PyDict_SetItem(dict, name, value);
1082 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1083 PyErr_SetObject(PyExc_AttributeError, name);
Christian Heimes969fe572008-01-25 11:23:10 +00001084 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001085 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001086 }
1087 }
1088
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001089 if (f != NULL) {
1090 res = f(descr, obj, value);
1091 goto done;
1092 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001093
1094 if (descr == NULL) {
1095 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001096 "'%.100s' object has no attribute '%U'",
1097 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001098 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001099 }
1100
1101 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001102 "'%.50s' object attribute '%U' is read-only",
1103 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001104 done:
1105 Py_DECREF(name);
1106 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001107}
1108
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001109/* Test a value used as condition, e.g., in a for or if statement.
1110 Return -1 if an error occurred */
1111
1112int
Fred Drake100814d2000-07-09 15:48:49 +00001113PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001114{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001115 Py_ssize_t res;
Guido van Rossum6248f442002-08-24 06:31:34 +00001116 if (v == Py_True)
1117 return 1;
1118 if (v == Py_False)
1119 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001120 if (v == Py_None)
Neal Norwitz51290d32002-06-13 21:32:44 +00001121 return 0;
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001122 else if (v->ob_type->tp_as_number != NULL &&
Jack Diederich4dafcc42006-11-28 19:15:13 +00001123 v->ob_type->tp_as_number->nb_bool != NULL)
1124 res = (*v->ob_type->tp_as_number->nb_bool)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001125 else if (v->ob_type->tp_as_mapping != NULL &&
1126 v->ob_type->tp_as_mapping->mp_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001127 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001128 else if (v->ob_type->tp_as_sequence != NULL &&
1129 v->ob_type->tp_as_sequence->sq_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001130 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1131 else
Neal Norwitz51290d32002-06-13 21:32:44 +00001132 return 1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001133 /* if it is negative, it should be either -1 or -2 */
1134 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001135}
1136
Tim Peters803526b2002-07-07 05:13:56 +00001137/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001138 Return -1 if an error occurred */
1139
1140int
Fred Drake100814d2000-07-09 15:48:49 +00001141PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001142{
1143 int res;
1144 res = PyObject_IsTrue(v);
1145 if (res < 0)
1146 return res;
1147 return res == 0;
1148}
1149
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001150/* Test whether an object can be called */
1151
1152int
Fred Drake100814d2000-07-09 15:48:49 +00001153PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001154{
1155 if (x == NULL)
1156 return 0;
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001157 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001158}
1159
Georg Brandle32b4222007-03-10 22:13:27 +00001160/* ------------------------- PyObject_Dir() helpers ------------------------- */
1161
Tim Peters7eea37e2001-09-04 22:08:56 +00001162/* Helper for PyObject_Dir.
1163 Merge the __dict__ of aclass into dict, and recursively also all
1164 the __dict__s of aclass's base classes. The order of merging isn't
1165 defined, as it's expected that only the final set of dict keys is
1166 interesting.
1167 Return 0 on success, -1 on error.
1168*/
1169
1170static int
1171merge_class_dict(PyObject* dict, PyObject* aclass)
1172{
1173 PyObject *classdict;
1174 PyObject *bases;
1175
1176 assert(PyDict_Check(dict));
1177 assert(aclass);
1178
1179 /* Merge in the type's dict (if any). */
1180 classdict = PyObject_GetAttrString(aclass, "__dict__");
1181 if (classdict == NULL)
1182 PyErr_Clear();
1183 else {
1184 int status = PyDict_Update(dict, classdict);
1185 Py_DECREF(classdict);
1186 if (status < 0)
1187 return -1;
1188 }
1189
1190 /* Recursively merge in the base types' (if any) dicts. */
1191 bases = PyObject_GetAttrString(aclass, "__bases__");
Tim Petersbc7e8632001-09-16 20:33:22 +00001192 if (bases == NULL)
1193 PyErr_Clear();
1194 else {
Guido van Rossum44022412002-05-13 18:29:46 +00001195 /* We have no guarantee that bases is a real tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001196 Py_ssize_t i, n;
Guido van Rossum44022412002-05-13 18:29:46 +00001197 n = PySequence_Size(bases); /* This better be right */
1198 if (n < 0)
1199 PyErr_Clear();
1200 else {
1201 for (i = 0; i < n; i++) {
Tim Peters18e70832003-02-05 19:35:19 +00001202 int status;
Guido van Rossum44022412002-05-13 18:29:46 +00001203 PyObject *base = PySequence_GetItem(bases, i);
1204 if (base == NULL) {
1205 Py_DECREF(bases);
1206 return -1;
1207 }
Tim Peters18e70832003-02-05 19:35:19 +00001208 status = merge_class_dict(dict, base);
1209 Py_DECREF(base);
1210 if (status < 0) {
Guido van Rossum44022412002-05-13 18:29:46 +00001211 Py_DECREF(bases);
1212 return -1;
1213 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001214 }
1215 }
1216 Py_DECREF(bases);
1217 }
1218 return 0;
1219}
1220
Georg Brandle32b4222007-03-10 22:13:27 +00001221/* Helper for PyObject_Dir without arguments: returns the local scope. */
1222static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001223_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001224{
Georg Brandled3b8382007-03-12 13:15:14 +00001225 PyObject *names;
Georg Brandle32b4222007-03-10 22:13:27 +00001226 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001227
Georg Brandle32b4222007-03-10 22:13:27 +00001228 if (locals == NULL) {
1229 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1230 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001231 }
1232
Georg Brandled3b8382007-03-12 13:15:14 +00001233 names = PyMapping_Keys(locals);
1234 if (!names)
1235 return NULL;
1236 if (!PyList_Check(names)) {
1237 PyErr_Format(PyExc_TypeError,
1238 "dir(): expected keys() of locals to be a list, "
Christian Heimes90aa7642007-12-19 02:45:37 +00001239 "not '%.200s'", Py_TYPE(names)->tp_name);
Georg Brandled3b8382007-03-12 13:15:14 +00001240 Py_DECREF(names);
1241 return NULL;
1242 }
Georg Brandle32b4222007-03-10 22:13:27 +00001243 /* the locals don't need to be DECREF'd */
Georg Brandled3b8382007-03-12 13:15:14 +00001244 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001245}
1246
1247/* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
Guido van Rossum98297ee2007-11-06 21:34:58 +00001248 We deliberately don't suck up its __class__, as methods belonging to the
1249 metaclass would probably be more confusing than helpful.
Georg Brandle32b4222007-03-10 22:13:27 +00001250*/
Guido van Rossum98297ee2007-11-06 21:34:58 +00001251static PyObject *
Georg Brandle32b4222007-03-10 22:13:27 +00001252_specialized_dir_type(PyObject *obj)
1253{
1254 PyObject *result = NULL;
1255 PyObject *dict = PyDict_New();
1256
1257 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1258 result = PyDict_Keys(dict);
1259
1260 Py_XDECREF(dict);
Tim Peters305b5852001-09-17 02:38:46 +00001261 return result;
1262}
1263
Georg Brandle32b4222007-03-10 22:13:27 +00001264/* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1265static PyObject *
1266_specialized_dir_module(PyObject *obj)
Tim Peters7eea37e2001-09-04 22:08:56 +00001267{
Georg Brandle32b4222007-03-10 22:13:27 +00001268 PyObject *result = NULL;
1269 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
Tim Peters7eea37e2001-09-04 22:08:56 +00001270
Georg Brandle32b4222007-03-10 22:13:27 +00001271 if (dict != NULL) {
1272 if (PyDict_Check(dict))
1273 result = PyDict_Keys(dict);
1274 else {
Benjamin Peterson044446b2009-08-15 13:25:28 +00001275 const char *name = PyModule_GetName(obj);
1276 if (name)
1277 PyErr_Format(PyExc_TypeError,
1278 "%.200s.__dict__ is not a dictionary",
1279 name);
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001280 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001281 }
1282
Georg Brandle32b4222007-03-10 22:13:27 +00001283 Py_XDECREF(dict);
1284 return result;
1285}
Tim Peters7eea37e2001-09-04 22:08:56 +00001286
Georg Brandle32b4222007-03-10 22:13:27 +00001287/* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1288 and recursively up the __class__.__bases__ chain.
1289*/
1290static PyObject *
1291_generic_dir(PyObject *obj)
1292{
1293 PyObject *result = NULL;
1294 PyObject *dict = NULL;
1295 PyObject *itsclass = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001296
Georg Brandle32b4222007-03-10 22:13:27 +00001297 /* Get __dict__ (which may or may not be a real dict...) */
1298 dict = PyObject_GetAttrString(obj, "__dict__");
1299 if (dict == NULL) {
1300 PyErr_Clear();
1301 dict = PyDict_New();
1302 }
1303 else if (!PyDict_Check(dict)) {
1304 Py_DECREF(dict);
1305 dict = PyDict_New();
1306 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001307 else {
Georg Brandle32b4222007-03-10 22:13:27 +00001308 /* Copy __dict__ to avoid mutating it. */
1309 PyObject *temp = PyDict_Copy(dict);
1310 Py_DECREF(dict);
1311 dict = temp;
Tim Peters7eea37e2001-09-04 22:08:56 +00001312 }
1313
Georg Brandle32b4222007-03-10 22:13:27 +00001314 if (dict == NULL)
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001315 goto error;
Tim Peters7eea37e2001-09-04 22:08:56 +00001316
Georg Brandle32b4222007-03-10 22:13:27 +00001317 /* Merge in attrs reachable from its class. */
1318 itsclass = PyObject_GetAttrString(obj, "__class__");
1319 if (itsclass == NULL)
1320 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1321 __class__ exists? */
1322 PyErr_Clear();
1323 else {
1324 if (merge_class_dict(dict, itsclass) != 0)
1325 goto error;
1326 }
1327
1328 result = PyDict_Keys(dict);
Tim Peters7eea37e2001-09-04 22:08:56 +00001329 /* fall through */
Georg Brandle32b4222007-03-10 22:13:27 +00001330error:
1331 Py_XDECREF(itsclass);
1332 Py_XDECREF(dict);
1333 return result;
1334}
1335
1336/* Helper for PyObject_Dir: object introspection.
1337 This calls one of the above specialized versions if no __dir__ method
1338 exists. */
1339static PyObject *
1340_dir_object(PyObject *obj)
1341{
1342 PyObject * result = NULL;
1343 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1344 "__dir__");
1345
1346 assert(obj);
1347 if (dirfunc == NULL) {
1348 /* use default implementation */
1349 PyErr_Clear();
1350 if (PyModule_Check(obj))
1351 result = _specialized_dir_module(obj);
1352 else if (PyType_Check(obj))
1353 result = _specialized_dir_type(obj);
1354 else
1355 result = _generic_dir(obj);
1356 }
1357 else {
1358 /* use __dir__ */
1359 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1360 Py_DECREF(dirfunc);
1361 if (result == NULL)
1362 return NULL;
1363
1364 /* result must be a list */
1365 /* XXX(gbrandl): could also check if all items are strings */
1366 if (!PyList_Check(result)) {
1367 PyErr_Format(PyExc_TypeError,
1368 "__dir__() must return a list, not %.200s",
Christian Heimes90aa7642007-12-19 02:45:37 +00001369 Py_TYPE(result)->tp_name);
Georg Brandle32b4222007-03-10 22:13:27 +00001370 Py_DECREF(result);
1371 result = NULL;
1372 }
1373 }
1374
1375 return result;
1376}
1377
1378/* Implementation of dir() -- if obj is NULL, returns the names in the current
1379 (local) scope. Otherwise, performs introspection of the object: returns a
1380 sorted list of attribute names (supposedly) accessible from the object
1381*/
1382PyObject *
1383PyObject_Dir(PyObject *obj)
1384{
1385 PyObject * result;
1386
1387 if (obj == NULL)
1388 /* no object -- introspect the locals */
1389 result = _dir_locals();
1390 else
1391 /* object -- introspect the object */
1392 result = _dir_object(obj);
1393
1394 assert(result == NULL || PyList_Check(result));
1395
1396 if (result != NULL && PyList_Sort(result) != 0) {
1397 /* sorting the list failed */
1398 Py_DECREF(result);
1399 result = NULL;
1400 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001401
Tim Peters7eea37e2001-09-04 22:08:56 +00001402 return result;
1403}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001404
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001405/*
1406NoObject is usable as a non-NULL undefined value, used by the macro None.
1407There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001408so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001409(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001410*/
1411
Guido van Rossum0c182a11992-03-27 17:26:13 +00001412/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001413static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001414none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001415{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001416 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001417}
1418
Barry Warsaw9bf16442001-01-23 16:24:35 +00001419/* ARGUSED */
1420static void
Tim Peters803526b2002-07-07 05:13:56 +00001421none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001422{
1423 /* This should never get called, but we also don't want to SEGV if
Mark Dickinson934896d2009-02-21 20:59:32 +00001424 * we accidentally decref None out of existence.
Barry Warsaw9bf16442001-01-23 16:24:35 +00001425 */
Martin v. Löwis3f19b102002-08-07 16:21:51 +00001426 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001427}
1428
1429
Guido van Rossumba21a492001-08-16 08:17:26 +00001430static PyTypeObject PyNone_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001431 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001432 "NoneType",
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001433 0,
1434 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001435 none_dealloc, /*tp_dealloc*/ /*never called*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001436 0, /*tp_print*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001437 0, /*tp_getattr*/
1438 0, /*tp_setattr*/
Mark Dickinsone94c6792009-02-02 20:36:42 +00001439 0, /*tp_reserved*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001440 none_repr, /*tp_repr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001441 0, /*tp_as_number*/
1442 0, /*tp_as_sequence*/
1443 0, /*tp_as_mapping*/
Guido van Rossum9bfef441993-03-29 10:43:31 +00001444 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001445};
1446
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001447PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001448 _PyObject_EXTRA_INIT
1449 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001450};
1451
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001452/* NotImplemented is an object that can be used to signal that an
1453 operation is not implemented for the given type combination. */
1454
1455static PyObject *
1456NotImplemented_repr(PyObject *op)
1457{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001458 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001459}
1460
1461static PyTypeObject PyNotImplemented_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001462 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001463 "NotImplementedType",
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001464 0,
1465 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001466 none_dealloc, /*tp_dealloc*/ /*never called*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001467 0, /*tp_print*/
1468 0, /*tp_getattr*/
1469 0, /*tp_setattr*/
Mark Dickinsone94c6792009-02-02 20:36:42 +00001470 0, /*tp_reserved*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001471 NotImplemented_repr, /*tp_repr*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001472 0, /*tp_as_number*/
1473 0, /*tp_as_sequence*/
1474 0, /*tp_as_mapping*/
1475 0, /*tp_hash */
1476};
1477
1478PyObject _Py_NotImplementedStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001479 _PyObject_EXTRA_INIT
1480 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001481};
1482
Guido van Rossumba21a492001-08-16 08:17:26 +00001483void
1484_Py_ReadyTypes(void)
1485{
1486 if (PyType_Ready(&PyType_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001487 Py_FatalError("Can't initialize type type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001488
Fred Drake0a4dd392004-07-02 18:57:45 +00001489 if (PyType_Ready(&_PyWeakref_RefType) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001490 Py_FatalError("Can't initialize weakref type");
Fred Drake0a4dd392004-07-02 18:57:45 +00001491
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001492 if (PyType_Ready(&_PyWeakref_CallableProxyType) < 0)
1493 Py_FatalError("Can't initialize callable weakref proxy type");
1494
1495 if (PyType_Ready(&_PyWeakref_ProxyType) < 0)
1496 Py_FatalError("Can't initialize weakref proxy type");
1497
Guido van Rossum77f6a652002-04-03 22:41:51 +00001498 if (PyType_Ready(&PyBool_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001499 Py_FatalError("Can't initialize bool type");
Guido van Rossum77f6a652002-04-03 22:41:51 +00001500
Christian Heimes9c4756e2008-05-26 13:22:05 +00001501 if (PyType_Ready(&PyByteArray_Type) < 0)
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001502 Py_FatalError("Can't initialize bytearray type");
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001503
Christian Heimes72b710a2008-05-26 13:28:38 +00001504 if (PyType_Ready(&PyBytes_Type) < 0)
Guido van Rossumcacfc072002-05-24 19:01:59 +00001505 Py_FatalError("Can't initialize 'str'");
1506
Guido van Rossumba21a492001-08-16 08:17:26 +00001507 if (PyType_Ready(&PyList_Type) < 0)
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001508 Py_FatalError("Can't initialize list type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001509
1510 if (PyType_Ready(&PyNone_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001511 Py_FatalError("Can't initialize None type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001512
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001513 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1514 Py_FatalError("Can't initialize type(Ellipsis)");
1515
Guido van Rossumba21a492001-08-16 08:17:26 +00001516 if (PyType_Ready(&PyNotImplemented_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001517 Py_FatalError("Can't initialize NotImplemented type");
1518
1519 if (PyType_Ready(&PyTraceBack_Type) < 0)
1520 Py_FatalError("Can't initialize traceback type");
1521
1522 if (PyType_Ready(&PySuper_Type) < 0)
1523 Py_FatalError("Can't initialize super type");
1524
1525 if (PyType_Ready(&PyBaseObject_Type) < 0)
1526 Py_FatalError("Can't initialize object type");
1527
1528 if (PyType_Ready(&PyRange_Type) < 0)
1529 Py_FatalError("Can't initialize range type");
1530
1531 if (PyType_Ready(&PyDict_Type) < 0)
1532 Py_FatalError("Can't initialize dict type");
1533
1534 if (PyType_Ready(&PySet_Type) < 0)
1535 Py_FatalError("Can't initialize set type");
1536
1537 if (PyType_Ready(&PyUnicode_Type) < 0)
1538 Py_FatalError("Can't initialize str type");
1539
1540 if (PyType_Ready(&PySlice_Type) < 0)
1541 Py_FatalError("Can't initialize slice type");
1542
1543 if (PyType_Ready(&PyStaticMethod_Type) < 0)
1544 Py_FatalError("Can't initialize static method type");
1545
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001546#ifndef WITHOUT_COMPLEX
Benjamin Petersonae937c02009-04-18 20:54:08 +00001547 if (PyType_Ready(&PyComplex_Type) < 0)
1548 Py_FatalError("Can't initialize complex type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001549#endif
Benjamin Petersonae937c02009-04-18 20:54:08 +00001550 if (PyType_Ready(&PyFloat_Type) < 0)
1551 Py_FatalError("Can't initialize float type");
1552
1553 if (PyType_Ready(&PyLong_Type) < 0)
1554 Py_FatalError("Can't initialize int type");
1555
1556 if (PyType_Ready(&PyFrozenSet_Type) < 0)
1557 Py_FatalError("Can't initialize frozenset type");
1558
1559 if (PyType_Ready(&PyProperty_Type) < 0)
1560 Py_FatalError("Can't initialize property type");
1561
1562 if (PyType_Ready(&PyMemoryView_Type) < 0)
1563 Py_FatalError("Can't initialize memoryview type");
1564
1565 if (PyType_Ready(&PyTuple_Type) < 0)
1566 Py_FatalError("Can't initialize tuple type");
1567
1568 if (PyType_Ready(&PyEnum_Type) < 0)
1569 Py_FatalError("Can't initialize enumerate type");
1570
1571 if (PyType_Ready(&PyReversed_Type) < 0)
1572 Py_FatalError("Can't initialize reversed type");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001573
Guido van Rossum826d8972007-10-30 18:34:07 +00001574 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1575 Py_FatalError("Can't initialize StdPrinter");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001576
1577 if (PyType_Ready(&PyCode_Type) < 0)
1578 Py_FatalError("Can't initialize code type");
1579
1580 if (PyType_Ready(&PyFrame_Type) < 0)
1581 Py_FatalError("Can't initialize frame type");
1582
1583 if (PyType_Ready(&PyCFunction_Type) < 0)
1584 Py_FatalError("Can't initialize builtin function type");
1585
1586 if (PyType_Ready(&PyMethod_Type) < 0)
1587 Py_FatalError("Can't initialize method type");
1588
1589 if (PyType_Ready(&PyFunction_Type) < 0)
1590 Py_FatalError("Can't initialize function type");
1591
1592 if (PyType_Ready(&PyDictProxy_Type) < 0)
1593 Py_FatalError("Can't initialize dict proxy type");
1594
1595 if (PyType_Ready(&PyGen_Type) < 0)
1596 Py_FatalError("Can't initialize generator type");
1597
1598 if (PyType_Ready(&PyGetSetDescr_Type) < 0)
1599 Py_FatalError("Can't initialize get-set descriptor type");
1600
1601 if (PyType_Ready(&PyWrapperDescr_Type) < 0)
1602 Py_FatalError("Can't initialize wrapper type");
1603
1604 if (PyType_Ready(&PyEllipsis_Type) < 0)
1605 Py_FatalError("Can't initialize ellipsis type");
1606
1607 if (PyType_Ready(&PyMemberDescr_Type) < 0)
1608 Py_FatalError("Can't initialize member descriptor type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001609
1610 if (PyType_Ready(&PyFilter_Type) < 0)
1611 Py_FatalError("Can't initialize filter type");
1612
1613 if (PyType_Ready(&PyMap_Type) < 0)
1614 Py_FatalError("Can't initialize map type");
1615
1616 if (PyType_Ready(&PyZip_Type) < 0)
1617 Py_FatalError("Can't initialize zip type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001618}
1619
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001620
Guido van Rossum84a90321996-05-22 16:34:47 +00001621#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001622
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001623void
Fred Drake100814d2000-07-09 15:48:49 +00001624_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001625{
Tim Peters34592512002-07-11 06:23:50 +00001626 _Py_INC_REFTOTAL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001627 op->ob_refcnt = 1;
Tim Peters7571a0f2003-03-23 17:52:28 +00001628 _Py_AddToAllObjects(op, 1);
Tim Peters34592512002-07-11 06:23:50 +00001629 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001630}
1631
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001632void
Fred Drake100814d2000-07-09 15:48:49 +00001633_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001634{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001635#ifdef SLOW_UNREF_CHECK
Guido van Rossum4c08d552000-03-10 22:55:18 +00001636 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001637#endif
Guido van Rossumd7047b31995-01-02 19:07:15 +00001638 if (op->ob_refcnt < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001639 Py_FatalError("UNREF negative refcnt");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001640 if (op == &refchain ||
Christian Heimesc8967002007-11-30 10:18:26 +00001641 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1642 fprintf(stderr, "* ob\n");
1643 _PyObject_Dump(op);
1644 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1645 _PyObject_Dump(op->_ob_prev->_ob_next);
1646 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1647 _PyObject_Dump(op->_ob_next->_ob_prev);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001648 Py_FatalError("UNREF invalid object");
Christian Heimesc8967002007-11-30 10:18:26 +00001649 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001650#ifdef SLOW_UNREF_CHECK
Guido van Rossum3f5da241990-12-20 15:06:42 +00001651 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1652 if (p == op)
1653 break;
1654 }
Guido van Rossumd7047b31995-01-02 19:07:15 +00001655 if (p == &refchain) /* Not found */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001656 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001657#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001658 op->_ob_next->_ob_prev = op->_ob_prev;
1659 op->_ob_prev->_ob_next = op->_ob_next;
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001660 op->_ob_next = op->_ob_prev = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001661 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001662}
1663
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001664void
Fred Drake100814d2000-07-09 15:48:49 +00001665_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001666{
Christian Heimes90aa7642007-12-19 02:45:37 +00001667 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001668 _Py_ForgetReference(op);
Guido van Rossum9776adf1994-09-07 14:36:45 +00001669 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001670}
1671
Tim Peters269b2a62003-04-17 19:52:29 +00001672/* Print all live objects. Because PyObject_Print is called, the
1673 * interpreter must be in a healthy state.
1674 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001675void
Fred Drake100814d2000-07-09 15:48:49 +00001676_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001677{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001678 PyObject *op;
Guido van Rossume09fb551997-08-05 02:04:34 +00001679 fprintf(fp, "Remaining objects:\n");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001680 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001681 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001682 if (PyObject_Print(op, fp, 0) != 0)
1683 PyErr_Clear();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001684 putc('\n', fp);
1685 }
1686}
1687
Tim Peters269b2a62003-04-17 19:52:29 +00001688/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1689 * doesn't make any calls to the Python C API, so is always safe to call.
1690 */
1691void
1692_Py_PrintReferenceAddresses(FILE *fp)
1693{
1694 PyObject *op;
1695 fprintf(fp, "Remaining object addresses:\n");
1696 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001697 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
Christian Heimes90aa7642007-12-19 02:45:37 +00001698 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001699}
1700
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001701PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001702_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001703{
1704 int i, n;
1705 PyObject *t = NULL;
1706 PyObject *res, *op;
1707
1708 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1709 return NULL;
1710 op = refchain._ob_next;
1711 res = PyList_New(0);
1712 if (res == NULL)
1713 return NULL;
1714 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1715 while (op == self || op == args || op == res || op == t ||
Christian Heimes90aa7642007-12-19 02:45:37 +00001716 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001717 op = op->_ob_next;
1718 if (op == &refchain)
1719 return res;
1720 }
1721 if (PyList_Append(res, op) < 0) {
1722 Py_DECREF(res);
1723 return NULL;
1724 }
1725 op = op->_ob_next;
1726 }
1727 return res;
1728}
1729
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001730#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001731
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001732/* Hack to force loading of cobject.o */
Guido van Rossumda9c2711996-12-05 21:58:58 +00001733PyTypeObject *_Py_cobject_hack = &PyCObject_Type;
Guido van Rossum84a90321996-05-22 16:34:47 +00001734
1735
Benjamin Petersonb173f782009-05-05 22:31:58 +00001736/* Hack to force loading of pycapsule.o */
1737PyTypeObject *_PyCapsule_hack = &PyCapsule_Type;
1738
1739
Guido van Rossum84a90321996-05-22 16:34:47 +00001740/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001741Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001742
1743
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001744/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001745
Thomas Wouters334fb892000-07-25 12:56:38 +00001746void *
Fred Drake100814d2000-07-09 15:48:49 +00001747PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001748{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001749 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001750}
1751
Thomas Wouters334fb892000-07-25 12:56:38 +00001752void *
1753PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001754{
Tim Petersaf3e8de2002-04-12 07:22:56 +00001755 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001756}
1757
1758void
Thomas Wouters334fb892000-07-25 12:56:38 +00001759PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001760{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001761 PyMem_FREE(p);
1762}
1763
1764
Guido van Rossum86610361998-04-10 22:32:46 +00001765/* These methods are used to control infinite recursion in repr, str, print,
1766 etc. Container objects that may recursively contain themselves,
1767 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1768 Py_ReprLeave() to avoid infinite recursion.
1769
1770 Py_ReprEnter() returns 0 the first time it is called for a particular
1771 object and 1 every time thereafter. It returns -1 if an exception
1772 occurred. Py_ReprLeave() has no return value.
1773
1774 See dictobject.c and listobject.c for examples of use.
1775*/
1776
1777#define KEY "Py_Repr"
1778
1779int
Fred Drake100814d2000-07-09 15:48:49 +00001780Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001781{
1782 PyObject *dict;
1783 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001784 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001785
1786 dict = PyThreadState_GetDict();
1787 if (dict == NULL)
Guido van Rossum0fc8f002003-04-15 15:12:39 +00001788 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001789 list = PyDict_GetItemString(dict, KEY);
1790 if (list == NULL) {
1791 list = PyList_New(0);
1792 if (list == NULL)
1793 return -1;
1794 if (PyDict_SetItemString(dict, KEY, list) < 0)
1795 return -1;
1796 Py_DECREF(list);
1797 }
1798 i = PyList_GET_SIZE(list);
1799 while (--i >= 0) {
1800 if (PyList_GET_ITEM(list, i) == obj)
1801 return 1;
1802 }
1803 PyList_Append(list, obj);
1804 return 0;
1805}
1806
1807void
Fred Drake100814d2000-07-09 15:48:49 +00001808Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001809{
1810 PyObject *dict;
1811 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001812 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001813
1814 dict = PyThreadState_GetDict();
Guido van Rossumeb909461998-04-11 15:17:34 +00001815 if (dict == NULL)
1816 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001817 list = PyDict_GetItemString(dict, KEY);
Guido van Rossumeb909461998-04-11 15:17:34 +00001818 if (list == NULL || !PyList_Check(list))
1819 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001820 i = PyList_GET_SIZE(list);
1821 /* Count backwards because we always expect obj to be list[-1] */
1822 while (--i >= 0) {
1823 if (PyList_GET_ITEM(list, i) == obj) {
1824 PyList_SetSlice(list, i, i + 1, NULL);
1825 break;
1826 }
1827 }
1828}
Guido van Rossumd724b232000-03-13 16:01:29 +00001829
Tim Peters803526b2002-07-07 05:13:56 +00001830/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001831
Tim Peters803526b2002-07-07 05:13:56 +00001832/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001833int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001834
Tim Peters803526b2002-07-07 05:13:56 +00001835/* List of objects that still need to be cleaned up, singly linked via their
1836 * gc headers' gc_prev pointers.
1837 */
1838PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001839
Tim Peters803526b2002-07-07 05:13:56 +00001840/* Add op to the _PyTrash_delete_later list. Called when the current
1841 * call-stack depth gets large. op must be a currently untracked gc'ed
1842 * object, with refcount 0. Py_DECREF must already have been called on it.
1843 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001844void
Fred Drake100814d2000-07-09 15:48:49 +00001845_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001846{
Tim Peters803526b2002-07-07 05:13:56 +00001847 assert(PyObject_IS_GC(op));
1848 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1849 assert(op->ob_refcnt == 0);
Neil Schemenauerf589c052002-03-29 03:05:54 +00001850 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
Guido van Rossume92e6102000-04-24 15:40:53 +00001851 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001852}
1853
Tim Peters803526b2002-07-07 05:13:56 +00001854/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1855 * the call-stack unwinds again.
1856 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001857void
Fred Drake100814d2000-07-09 15:48:49 +00001858_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001859{
1860 while (_PyTrash_delete_later) {
Tim Peters803526b2002-07-07 05:13:56 +00001861 PyObject *op = _PyTrash_delete_later;
Christian Heimes90aa7642007-12-19 02:45:37 +00001862 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001863
Neil Schemenauerf589c052002-03-29 03:05:54 +00001864 _PyTrash_delete_later =
Tim Peters803526b2002-07-07 05:13:56 +00001865 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001866
Tim Peters803526b2002-07-07 05:13:56 +00001867 /* Call the deallocator directly. This used to try to
1868 * fool Py_DECREF into calling it indirectly, but
1869 * Py_DECREF was already called on this object, and in
1870 * assorted non-release builds calling Py_DECREF again ends
1871 * up distorting allocation statistics.
1872 */
1873 assert(op->ob_refcnt == 0);
Guido van Rossumd724b232000-03-13 16:01:29 +00001874 ++_PyTrash_delete_nesting;
Tim Peters803526b2002-07-07 05:13:56 +00001875 (*dealloc)(op);
Guido van Rossumd724b232000-03-13 16:01:29 +00001876 --_PyTrash_delete_nesting;
1877 }
1878}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001879
1880#ifdef __cplusplus
1881}
1882#endif