blob: 4d3d6590cced339df27c642dc668d74f5bc8c188 [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
Mark Dickinson14721502010-04-06 10:29:17 +0000659 if (!Py_IS_FINITE(v)) {
660 if (Py_IS_INFINITY(v))
661 return v < 0 ? -271828 : 314159;
662 else
663 return 0;
664 }
Tim Peters39dce292000-08-15 03:34:48 +0000665 fractpart = modf(v, &intpart);
Tim Peters39dce292000-08-15 03:34:48 +0000666 if (fractpart == 0.0) {
667 /* This must return the same hash as an equal int or long. */
Mark Dickinsonc96db472009-02-08 15:09:21 +0000668 if (intpart > LONG_MAX/2 || -intpart > LONG_MAX/2) {
Tim Peters39dce292000-08-15 03:34:48 +0000669 /* Convert to long and use its hash. */
670 PyObject *plong; /* converted to Python long */
Tim Peters39dce292000-08-15 03:34:48 +0000671 plong = PyLong_FromDouble(v);
672 if (plong == NULL)
673 return -1;
674 x = PyObject_Hash(plong);
675 Py_DECREF(plong);
676 return x;
677 }
678 /* Fits in a C long == a Python int, so is its own hash. */
679 x = (long)intpart;
680 if (x == -1)
681 x = -2;
682 return x;
683 }
684 /* The fractional part is non-zero, so we don't have to worry about
685 * making this match the hash of some other type.
686 * Use frexp to get at the bits in the double.
Fred Drake13634cf2000-06-29 19:17:04 +0000687 * Since the VAX D double format has 56 mantissa bits, which is the
688 * most of any double format in use, each of these parts may have as
689 * many as (but no more than) 56 significant bits.
Tim Peters39dce292000-08-15 03:34:48 +0000690 * So, assuming sizeof(long) >= 4, each part can be broken into two
691 * longs; frexp and multiplication are used to do that.
692 * Also, since the Cray double format has 15 exponent bits, which is
693 * the most of any double format in use, shifting the exponent field
694 * left by 15 won't overflow a long (again assuming sizeof(long) >= 4).
Fred Drake13634cf2000-06-29 19:17:04 +0000695 */
Tim Peters39dce292000-08-15 03:34:48 +0000696 v = frexp(v, &expo);
697 v *= 2147483648.0; /* 2**31 */
698 hipart = (long)v; /* take the top 32 bits */
699 v = (v - (double)hipart) * 2147483648.0; /* get the next 32 bits */
700 x = hipart + (long)v + (expo << 15);
701 if (x == -1)
702 x = -2;
703 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000704}
705
706long
Fred Drake100814d2000-07-09 15:48:49 +0000707_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000708{
Fred Drake13634cf2000-06-29 19:17:04 +0000709 long x;
Antoine Pitrou79eee6b2009-02-13 14:01:05 +0000710 size_t y = (size_t)p;
711 /* bottom 3 or 4 bits are likely to be 0; rotate y by 4 to avoid
712 excessive hash collisions for dicts and sets */
713 y = (y >> 4) | (y << (8 * SIZEOF_VOID_P - 4));
714 x = (long)y;
715 if (x == -1)
716 x = -2;
Fred Drake13634cf2000-06-29 19:17:04 +0000717 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000718}
719
Nick Coghland1abd252008-07-15 15:46:38 +0000720long
721PyObject_HashNotImplemented(PyObject *v)
722{
723 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
724 Py_TYPE(v)->tp_name);
725 return -1;
726}
Fred Drake13634cf2000-06-29 19:17:04 +0000727
Guido van Rossum9bfef441993-03-29 10:43:31 +0000728long
Fred Drake100814d2000-07-09 15:48:49 +0000729PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000730{
Nick Coghland1abd252008-07-15 15:46:38 +0000731 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000732 if (tp->tp_hash != NULL)
733 return (*tp->tp_hash)(v);
Nick Coghlanf1f2f682008-12-30 07:29:12 +0000734 /* To keep to the general practice that inheriting
735 * solely from object in C code should work without
736 * an explicit call to PyType_Ready, we implicitly call
737 * PyType_Ready here and then check the tp_hash slot again
738 */
739 if (tp->tp_dict == NULL) {
740 if (PyType_Ready(tp) < 0)
741 return -1;
742 if (tp->tp_hash != NULL)
743 return (*tp->tp_hash)(v);
744 }
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000745 /* Otherwise, the object can't be hashed */
Nick Coghland1abd252008-07-15 15:46:38 +0000746 return PyObject_HashNotImplemented(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000747}
748
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000749PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000750PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000751{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000752 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000753
Christian Heimes90aa7642007-12-19 02:45:37 +0000754 if (Py_TYPE(v)->tp_getattr != NULL)
755 return (*Py_TYPE(v)->tp_getattr)(v, (char*)name);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000756 w = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000757 if (w == NULL)
758 return NULL;
759 res = PyObject_GetAttr(v, w);
760 Py_XDECREF(w);
761 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000762}
763
764int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000765PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000766{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000767 PyObject *res = PyObject_GetAttrString(v, name);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000768 if (res != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000769 Py_DECREF(res);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000770 return 1;
771 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000772 PyErr_Clear();
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000773 return 0;
774}
775
776int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000777PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000778{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000779 PyObject *s;
780 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000781
Christian Heimes90aa7642007-12-19 02:45:37 +0000782 if (Py_TYPE(v)->tp_setattr != NULL)
783 return (*Py_TYPE(v)->tp_setattr)(v, (char*)name, w);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000784 s = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000785 if (s == NULL)
786 return -1;
787 res = PyObject_SetAttr(v, s, w);
788 Py_XDECREF(s);
789 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000790}
791
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000792PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000793PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000794{
Christian Heimes90aa7642007-12-19 02:45:37 +0000795 PyTypeObject *tp = Py_TYPE(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000796
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000797 if (!PyUnicode_Check(name)) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000798 PyErr_Format(PyExc_TypeError,
799 "attribute name must be string, not '%.200s'",
800 name->ob_type->tp_name);
801 return NULL;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000802 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000803 if (tp->tp_getattro != NULL)
804 return (*tp->tp_getattro)(v, name);
Victor Stinner624dbf62010-03-12 17:17:58 +0000805 if (tp->tp_getattr != NULL) {
806 char *name_str = _PyUnicode_AsString(name);
807 if (name_str == NULL)
808 return NULL;
809 return (*tp->tp_getattr)(v, name_str);
810 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000811 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000812 "'%.50s' object has no attribute '%U'",
813 tp->tp_name, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000814 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000815}
816
817int
Fred Drake100814d2000-07-09 15:48:49 +0000818PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000819{
820 PyObject *res = PyObject_GetAttr(v, name);
821 if (res != NULL) {
822 Py_DECREF(res);
823 return 1;
824 }
825 PyErr_Clear();
826 return 0;
827}
828
829int
Fred Drake100814d2000-07-09 15:48:49 +0000830PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000831{
Christian Heimes90aa7642007-12-19 02:45:37 +0000832 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000833 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000834
Martin v. Löwis5b222132007-06-10 09:51:05 +0000835 if (!PyUnicode_Check(name)) {
836 PyErr_Format(PyExc_TypeError,
837 "attribute name must be string, not '%.200s'",
838 name->ob_type->tp_name);
839 return -1;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000840 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000841 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000842
Martin v. Löwis5b222132007-06-10 09:51:05 +0000843 PyUnicode_InternInPlace(&name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000844 if (tp->tp_setattro != NULL) {
845 err = (*tp->tp_setattro)(v, name, value);
846 Py_DECREF(name);
847 return err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000848 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000849 if (tp->tp_setattr != NULL) {
Victor Stinner624dbf62010-03-12 17:17:58 +0000850 char *name_str = _PyUnicode_AsString(name);
851 if (name_str == NULL)
852 return -1;
853 err = (*tp->tp_setattr)(v, name_str, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000854 Py_DECREF(name);
855 return err;
856 }
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000857 Py_DECREF(name);
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000858 assert(name->ob_refcnt >= 1);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000859 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
860 PyErr_Format(PyExc_TypeError,
861 "'%.100s' object has no attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000862 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000863 tp->tp_name,
864 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000865 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000866 else
867 PyErr_Format(PyExc_TypeError,
868 "'%.100s' object has only read-only attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000869 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000870 tp->tp_name,
871 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000872 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000873 return -1;
874}
875
876/* Helper to get a pointer to an object's __dict__ slot, if any */
877
878PyObject **
879_PyObject_GetDictPtr(PyObject *obj)
880{
Martin v. Löwis725507b2006-03-07 12:08:51 +0000881 Py_ssize_t dictoffset;
Christian Heimes90aa7642007-12-19 02:45:37 +0000882 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000883
Tim Peters6d6c1a32001-08-02 04:15:00 +0000884 dictoffset = tp->tp_dictoffset;
885 if (dictoffset == 0)
886 return NULL;
887 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000888 Py_ssize_t tsize;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000889 size_t size;
890
891 tsize = ((PyVarObject *)obj)->ob_size;
892 if (tsize < 0)
893 tsize = -tsize;
894 size = _PyObject_VAR_SIZE(tp, tsize);
895
Tim Peters6d483d32001-10-06 21:27:34 +0000896 dictoffset += (long)size;
897 assert(dictoffset > 0);
898 assert(dictoffset % SIZEOF_VOID_P == 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000899 }
900 return (PyObject **) ((char *)obj + dictoffset);
901}
902
Tim Peters6d6c1a32001-08-02 04:15:00 +0000903PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000904PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +0000905{
906 Py_INCREF(obj);
907 return obj;
908}
909
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +0000910/* Helper used when the __next__ method is removed from a type:
911 tp_iternext is never NULL and can be safely called without checking
912 on every iteration.
913 */
914
915PyObject *
916_PyObject_NextNotImplemented(PyObject *self)
917{
918 PyErr_Format(PyExc_TypeError,
919 "'%.200s' object is not iterable",
920 Py_TYPE(self)->tp_name);
921 return NULL;
922}
923
Michael W. Hudson1593f502004-09-14 17:09:47 +0000924/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
925
Raymond Hettinger01538262003-03-17 08:24:35 +0000926PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000927PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
928{
Christian Heimes90aa7642007-12-19 02:45:37 +0000929 PyTypeObject *tp = Py_TYPE(obj);
Guido van Rossum056fbf42002-08-19 19:22:50 +0000930 PyObject *descr = NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000931 PyObject *res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000932 descrgetfunc f;
Martin v. Löwis725507b2006-03-07 12:08:51 +0000933 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000934 PyObject **dictptr;
935
Martin v. Löwis5b222132007-06-10 09:51:05 +0000936 if (!PyUnicode_Check(name)){
937 PyErr_Format(PyExc_TypeError,
938 "attribute name must be string, not '%.200s'",
939 name->ob_type->tp_name);
940 return NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000941 }
942 else
943 Py_INCREF(name);
944
Tim Peters6d6c1a32001-08-02 04:15:00 +0000945 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +0000946 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000947 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000948 }
949
Christian Heimesa62da1d2008-01-12 19:39:10 +0000950#if 0 /* XXX this is not quite _PyType_Lookup anymore */
Guido van Rossum056fbf42002-08-19 19:22:50 +0000951 /* Inline _PyType_Lookup */
952 {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000953 Py_ssize_t i, n;
Guido van Rossum056fbf42002-08-19 19:22:50 +0000954 PyObject *mro, *base, *dict;
955
956 /* Look in tp_dict of types in MRO */
957 mro = tp->tp_mro;
958 assert(mro != NULL);
959 assert(PyTuple_Check(mro));
960 n = PyTuple_GET_SIZE(mro);
961 for (i = 0; i < n; i++) {
962 base = PyTuple_GET_ITEM(mro, i);
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000963 assert(PyType_Check(base));
964 dict = ((PyTypeObject *)base)->tp_dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +0000965 assert(dict && PyDict_Check(dict));
966 descr = PyDict_GetItem(dict, name);
967 if (descr != NULL)
968 break;
969 }
970 }
Christian Heimesa62da1d2008-01-12 19:39:10 +0000971#else
972 descr = _PyType_Lookup(tp, name);
973#endif
Guido van Rossum056fbf42002-08-19 19:22:50 +0000974
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000975 Py_XINCREF(descr);
976
Tim Peters6d6c1a32001-08-02 04:15:00 +0000977 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000978 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000979 f = descr->ob_type->tp_descr_get;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000980 if (f != NULL && PyDescr_IsData(descr)) {
981 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000982 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000983 goto done;
984 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000985 }
986
Guido van Rossumc66ff442002-08-19 16:50:48 +0000987 /* Inline _PyObject_GetDictPtr */
988 dictoffset = tp->tp_dictoffset;
989 if (dictoffset != 0) {
990 PyObject *dict;
991 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000992 Py_ssize_t tsize;
Guido van Rossumc66ff442002-08-19 16:50:48 +0000993 size_t size;
994
995 tsize = ((PyVarObject *)obj)->ob_size;
996 if (tsize < 0)
997 tsize = -tsize;
998 size = _PyObject_VAR_SIZE(tp, tsize);
999
1000 dictoffset += (long)size;
1001 assert(dictoffset > 0);
1002 assert(dictoffset % SIZEOF_VOID_P == 0);
1003 }
1004 dictptr = (PyObject **) ((char *)obj + dictoffset);
1005 dict = *dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001006 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +00001007 Py_INCREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001008 res = PyDict_GetItem(dict, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001009 if (res != NULL) {
1010 Py_INCREF(res);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001011 Py_XDECREF(descr);
Christian Heimes969fe572008-01-25 11:23:10 +00001012 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001013 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001014 }
Christian Heimes969fe572008-01-25 11:23:10 +00001015 Py_DECREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001016 }
1017 }
1018
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001019 if (f != NULL) {
Christian Heimes90aa7642007-12-19 02:45:37 +00001020 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001021 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001022 goto done;
1023 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001024
1025 if (descr != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001026 res = descr;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001027 /* descr was already increfed above */
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001028 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001029 }
1030
1031 PyErr_Format(PyExc_AttributeError,
Victor Stinner624dbf62010-03-12 17:17:58 +00001032 "'%.50s' object has no attribute '%U'",
1033 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001034 done:
1035 Py_DECREF(name);
1036 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001037}
1038
1039int
1040PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1041{
Christian Heimes90aa7642007-12-19 02:45:37 +00001042 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001043 PyObject *descr;
1044 descrsetfunc f;
1045 PyObject **dictptr;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001046 int res = -1;
1047
Martin v. Löwis5b222132007-06-10 09:51:05 +00001048 if (!PyUnicode_Check(name)){
1049 PyErr_Format(PyExc_TypeError,
1050 "attribute name must be string, not '%.200s'",
1051 name->ob_type->tp_name);
1052 return -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001053 }
1054 else
1055 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001056
1057 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001058 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001059 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001060 }
1061
1062 descr = _PyType_Lookup(tp, name);
1063 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001064 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001065 f = descr->ob_type->tp_descr_set;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001066 if (f != NULL && PyDescr_IsData(descr)) {
1067 res = f(descr, obj, value);
1068 goto done;
1069 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001070 }
1071
1072 dictptr = _PyObject_GetDictPtr(obj);
1073 if (dictptr != NULL) {
1074 PyObject *dict = *dictptr;
1075 if (dict == NULL && value != NULL) {
1076 dict = PyDict_New();
1077 if (dict == NULL)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001078 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001079 *dictptr = dict;
1080 }
1081 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +00001082 Py_INCREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001083 if (value == NULL)
1084 res = PyDict_DelItem(dict, name);
1085 else
1086 res = PyDict_SetItem(dict, name, value);
1087 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1088 PyErr_SetObject(PyExc_AttributeError, name);
Christian Heimes969fe572008-01-25 11:23:10 +00001089 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001090 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001091 }
1092 }
1093
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001094 if (f != NULL) {
1095 res = f(descr, obj, value);
1096 goto done;
1097 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001098
1099 if (descr == NULL) {
1100 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001101 "'%.100s' object has no attribute '%U'",
1102 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001103 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001104 }
1105
1106 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001107 "'%.50s' object attribute '%U' is read-only",
1108 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001109 done:
1110 Py_DECREF(name);
1111 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001112}
1113
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001114/* Test a value used as condition, e.g., in a for or if statement.
1115 Return -1 if an error occurred */
1116
1117int
Fred Drake100814d2000-07-09 15:48:49 +00001118PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001119{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001120 Py_ssize_t res;
Guido van Rossum6248f442002-08-24 06:31:34 +00001121 if (v == Py_True)
1122 return 1;
1123 if (v == Py_False)
1124 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001125 if (v == Py_None)
Neal Norwitz51290d32002-06-13 21:32:44 +00001126 return 0;
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001127 else if (v->ob_type->tp_as_number != NULL &&
Jack Diederich4dafcc42006-11-28 19:15:13 +00001128 v->ob_type->tp_as_number->nb_bool != NULL)
1129 res = (*v->ob_type->tp_as_number->nb_bool)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001130 else if (v->ob_type->tp_as_mapping != NULL &&
1131 v->ob_type->tp_as_mapping->mp_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001132 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001133 else if (v->ob_type->tp_as_sequence != NULL &&
1134 v->ob_type->tp_as_sequence->sq_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001135 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1136 else
Neal Norwitz51290d32002-06-13 21:32:44 +00001137 return 1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001138 /* if it is negative, it should be either -1 or -2 */
1139 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001140}
1141
Tim Peters803526b2002-07-07 05:13:56 +00001142/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001143 Return -1 if an error occurred */
1144
1145int
Fred Drake100814d2000-07-09 15:48:49 +00001146PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001147{
1148 int res;
1149 res = PyObject_IsTrue(v);
1150 if (res < 0)
1151 return res;
1152 return res == 0;
1153}
1154
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001155/* Test whether an object can be called */
1156
1157int
Fred Drake100814d2000-07-09 15:48:49 +00001158PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001159{
1160 if (x == NULL)
1161 return 0;
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001162 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001163}
1164
Georg Brandle32b4222007-03-10 22:13:27 +00001165/* ------------------------- PyObject_Dir() helpers ------------------------- */
1166
Tim Peters7eea37e2001-09-04 22:08:56 +00001167/* Helper for PyObject_Dir.
1168 Merge the __dict__ of aclass into dict, and recursively also all
1169 the __dict__s of aclass's base classes. The order of merging isn't
1170 defined, as it's expected that only the final set of dict keys is
1171 interesting.
1172 Return 0 on success, -1 on error.
1173*/
1174
1175static int
1176merge_class_dict(PyObject* dict, PyObject* aclass)
1177{
1178 PyObject *classdict;
1179 PyObject *bases;
1180
1181 assert(PyDict_Check(dict));
1182 assert(aclass);
1183
1184 /* Merge in the type's dict (if any). */
1185 classdict = PyObject_GetAttrString(aclass, "__dict__");
1186 if (classdict == NULL)
1187 PyErr_Clear();
1188 else {
1189 int status = PyDict_Update(dict, classdict);
1190 Py_DECREF(classdict);
1191 if (status < 0)
1192 return -1;
1193 }
1194
1195 /* Recursively merge in the base types' (if any) dicts. */
1196 bases = PyObject_GetAttrString(aclass, "__bases__");
Tim Petersbc7e8632001-09-16 20:33:22 +00001197 if (bases == NULL)
1198 PyErr_Clear();
1199 else {
Guido van Rossum44022412002-05-13 18:29:46 +00001200 /* We have no guarantee that bases is a real tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001201 Py_ssize_t i, n;
Guido van Rossum44022412002-05-13 18:29:46 +00001202 n = PySequence_Size(bases); /* This better be right */
1203 if (n < 0)
1204 PyErr_Clear();
1205 else {
1206 for (i = 0; i < n; i++) {
Tim Peters18e70832003-02-05 19:35:19 +00001207 int status;
Guido van Rossum44022412002-05-13 18:29:46 +00001208 PyObject *base = PySequence_GetItem(bases, i);
1209 if (base == NULL) {
1210 Py_DECREF(bases);
1211 return -1;
1212 }
Tim Peters18e70832003-02-05 19:35:19 +00001213 status = merge_class_dict(dict, base);
1214 Py_DECREF(base);
1215 if (status < 0) {
Guido van Rossum44022412002-05-13 18:29:46 +00001216 Py_DECREF(bases);
1217 return -1;
1218 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001219 }
1220 }
1221 Py_DECREF(bases);
1222 }
1223 return 0;
1224}
1225
Georg Brandle32b4222007-03-10 22:13:27 +00001226/* Helper for PyObject_Dir without arguments: returns the local scope. */
1227static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001228_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001229{
Georg Brandled3b8382007-03-12 13:15:14 +00001230 PyObject *names;
Georg Brandle32b4222007-03-10 22:13:27 +00001231 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001232
Georg Brandle32b4222007-03-10 22:13:27 +00001233 if (locals == NULL) {
1234 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1235 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001236 }
1237
Georg Brandled3b8382007-03-12 13:15:14 +00001238 names = PyMapping_Keys(locals);
1239 if (!names)
1240 return NULL;
1241 if (!PyList_Check(names)) {
1242 PyErr_Format(PyExc_TypeError,
1243 "dir(): expected keys() of locals to be a list, "
Christian Heimes90aa7642007-12-19 02:45:37 +00001244 "not '%.200s'", Py_TYPE(names)->tp_name);
Georg Brandled3b8382007-03-12 13:15:14 +00001245 Py_DECREF(names);
1246 return NULL;
1247 }
Georg Brandle32b4222007-03-10 22:13:27 +00001248 /* the locals don't need to be DECREF'd */
Georg Brandled3b8382007-03-12 13:15:14 +00001249 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001250}
1251
1252/* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
Guido van Rossum98297ee2007-11-06 21:34:58 +00001253 We deliberately don't suck up its __class__, as methods belonging to the
1254 metaclass would probably be more confusing than helpful.
Georg Brandle32b4222007-03-10 22:13:27 +00001255*/
Guido van Rossum98297ee2007-11-06 21:34:58 +00001256static PyObject *
Georg Brandle32b4222007-03-10 22:13:27 +00001257_specialized_dir_type(PyObject *obj)
1258{
1259 PyObject *result = NULL;
1260 PyObject *dict = PyDict_New();
1261
1262 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1263 result = PyDict_Keys(dict);
1264
1265 Py_XDECREF(dict);
Tim Peters305b5852001-09-17 02:38:46 +00001266 return result;
1267}
1268
Georg Brandle32b4222007-03-10 22:13:27 +00001269/* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1270static PyObject *
1271_specialized_dir_module(PyObject *obj)
Tim Peters7eea37e2001-09-04 22:08:56 +00001272{
Georg Brandle32b4222007-03-10 22:13:27 +00001273 PyObject *result = NULL;
1274 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
Tim Peters7eea37e2001-09-04 22:08:56 +00001275
Georg Brandle32b4222007-03-10 22:13:27 +00001276 if (dict != NULL) {
1277 if (PyDict_Check(dict))
1278 result = PyDict_Keys(dict);
1279 else {
Benjamin Peterson14327712009-08-15 13:23:05 +00001280 const char *name = PyModule_GetName(obj);
1281 if (name)
1282 PyErr_Format(PyExc_TypeError,
1283 "%.200s.__dict__ is not a dictionary",
1284 name);
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001285 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001286 }
1287
Georg Brandle32b4222007-03-10 22:13:27 +00001288 Py_XDECREF(dict);
1289 return result;
1290}
Tim Peters7eea37e2001-09-04 22:08:56 +00001291
Georg Brandle32b4222007-03-10 22:13:27 +00001292/* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1293 and recursively up the __class__.__bases__ chain.
1294*/
1295static PyObject *
1296_generic_dir(PyObject *obj)
1297{
1298 PyObject *result = NULL;
1299 PyObject *dict = NULL;
1300 PyObject *itsclass = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001301
Georg Brandle32b4222007-03-10 22:13:27 +00001302 /* Get __dict__ (which may or may not be a real dict...) */
1303 dict = PyObject_GetAttrString(obj, "__dict__");
1304 if (dict == NULL) {
1305 PyErr_Clear();
1306 dict = PyDict_New();
1307 }
1308 else if (!PyDict_Check(dict)) {
1309 Py_DECREF(dict);
1310 dict = PyDict_New();
1311 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001312 else {
Georg Brandle32b4222007-03-10 22:13:27 +00001313 /* Copy __dict__ to avoid mutating it. */
1314 PyObject *temp = PyDict_Copy(dict);
1315 Py_DECREF(dict);
1316 dict = temp;
Tim Peters7eea37e2001-09-04 22:08:56 +00001317 }
1318
Georg Brandle32b4222007-03-10 22:13:27 +00001319 if (dict == NULL)
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001320 goto error;
Tim Peters7eea37e2001-09-04 22:08:56 +00001321
Georg Brandle32b4222007-03-10 22:13:27 +00001322 /* Merge in attrs reachable from its class. */
1323 itsclass = PyObject_GetAttrString(obj, "__class__");
1324 if (itsclass == NULL)
1325 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1326 __class__ exists? */
1327 PyErr_Clear();
1328 else {
1329 if (merge_class_dict(dict, itsclass) != 0)
1330 goto error;
1331 }
1332
1333 result = PyDict_Keys(dict);
Tim Peters7eea37e2001-09-04 22:08:56 +00001334 /* fall through */
Georg Brandle32b4222007-03-10 22:13:27 +00001335error:
1336 Py_XDECREF(itsclass);
1337 Py_XDECREF(dict);
1338 return result;
1339}
1340
1341/* Helper for PyObject_Dir: object introspection.
1342 This calls one of the above specialized versions if no __dir__ method
1343 exists. */
1344static PyObject *
1345_dir_object(PyObject *obj)
1346{
1347 PyObject * result = NULL;
1348 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1349 "__dir__");
1350
1351 assert(obj);
1352 if (dirfunc == NULL) {
1353 /* use default implementation */
1354 PyErr_Clear();
1355 if (PyModule_Check(obj))
1356 result = _specialized_dir_module(obj);
1357 else if (PyType_Check(obj))
1358 result = _specialized_dir_type(obj);
1359 else
1360 result = _generic_dir(obj);
1361 }
1362 else {
1363 /* use __dir__ */
1364 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1365 Py_DECREF(dirfunc);
1366 if (result == NULL)
1367 return NULL;
1368
1369 /* result must be a list */
1370 /* XXX(gbrandl): could also check if all items are strings */
1371 if (!PyList_Check(result)) {
1372 PyErr_Format(PyExc_TypeError,
1373 "__dir__() must return a list, not %.200s",
Christian Heimes90aa7642007-12-19 02:45:37 +00001374 Py_TYPE(result)->tp_name);
Georg Brandle32b4222007-03-10 22:13:27 +00001375 Py_DECREF(result);
1376 result = NULL;
1377 }
1378 }
1379
1380 return result;
1381}
1382
1383/* Implementation of dir() -- if obj is NULL, returns the names in the current
1384 (local) scope. Otherwise, performs introspection of the object: returns a
1385 sorted list of attribute names (supposedly) accessible from the object
1386*/
1387PyObject *
1388PyObject_Dir(PyObject *obj)
1389{
1390 PyObject * result;
1391
1392 if (obj == NULL)
1393 /* no object -- introspect the locals */
1394 result = _dir_locals();
1395 else
1396 /* object -- introspect the object */
1397 result = _dir_object(obj);
1398
1399 assert(result == NULL || PyList_Check(result));
1400
1401 if (result != NULL && PyList_Sort(result) != 0) {
1402 /* sorting the list failed */
1403 Py_DECREF(result);
1404 result = NULL;
1405 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001406
Tim Peters7eea37e2001-09-04 22:08:56 +00001407 return result;
1408}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001409
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001410/*
1411NoObject is usable as a non-NULL undefined value, used by the macro None.
1412There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001413so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001414(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001415*/
1416
Guido van Rossum0c182a11992-03-27 17:26:13 +00001417/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001418static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001419none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001420{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001421 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001422}
1423
Barry Warsaw9bf16442001-01-23 16:24:35 +00001424/* ARGUSED */
1425static void
Tim Peters803526b2002-07-07 05:13:56 +00001426none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001427{
1428 /* This should never get called, but we also don't want to SEGV if
Mark Dickinson934896d2009-02-21 20:59:32 +00001429 * we accidentally decref None out of existence.
Barry Warsaw9bf16442001-01-23 16:24:35 +00001430 */
Martin v. Löwis3f19b102002-08-07 16:21:51 +00001431 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001432}
1433
1434
Guido van Rossumba21a492001-08-16 08:17:26 +00001435static PyTypeObject PyNone_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001436 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001437 "NoneType",
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001438 0,
1439 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001440 none_dealloc, /*tp_dealloc*/ /*never called*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001441 0, /*tp_print*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001442 0, /*tp_getattr*/
1443 0, /*tp_setattr*/
Mark Dickinsone94c6792009-02-02 20:36:42 +00001444 0, /*tp_reserved*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001445 none_repr, /*tp_repr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001446 0, /*tp_as_number*/
1447 0, /*tp_as_sequence*/
1448 0, /*tp_as_mapping*/
Guido van Rossum9bfef441993-03-29 10:43:31 +00001449 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001450};
1451
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001452PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001453 _PyObject_EXTRA_INIT
1454 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001455};
1456
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001457/* NotImplemented is an object that can be used to signal that an
1458 operation is not implemented for the given type combination. */
1459
1460static PyObject *
1461NotImplemented_repr(PyObject *op)
1462{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001463 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001464}
1465
1466static PyTypeObject PyNotImplemented_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001467 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001468 "NotImplementedType",
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001469 0,
1470 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001471 none_dealloc, /*tp_dealloc*/ /*never called*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001472 0, /*tp_print*/
1473 0, /*tp_getattr*/
1474 0, /*tp_setattr*/
Mark Dickinsone94c6792009-02-02 20:36:42 +00001475 0, /*tp_reserved*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001476 NotImplemented_repr, /*tp_repr*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001477 0, /*tp_as_number*/
1478 0, /*tp_as_sequence*/
1479 0, /*tp_as_mapping*/
1480 0, /*tp_hash */
1481};
1482
1483PyObject _Py_NotImplementedStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001484 _PyObject_EXTRA_INIT
1485 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001486};
1487
Guido van Rossumba21a492001-08-16 08:17:26 +00001488void
1489_Py_ReadyTypes(void)
1490{
1491 if (PyType_Ready(&PyType_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001492 Py_FatalError("Can't initialize type type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001493
Fred Drake0a4dd392004-07-02 18:57:45 +00001494 if (PyType_Ready(&_PyWeakref_RefType) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001495 Py_FatalError("Can't initialize weakref type");
Fred Drake0a4dd392004-07-02 18:57:45 +00001496
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001497 if (PyType_Ready(&_PyWeakref_CallableProxyType) < 0)
1498 Py_FatalError("Can't initialize callable weakref proxy type");
1499
1500 if (PyType_Ready(&_PyWeakref_ProxyType) < 0)
1501 Py_FatalError("Can't initialize weakref proxy type");
1502
Guido van Rossum77f6a652002-04-03 22:41:51 +00001503 if (PyType_Ready(&PyBool_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001504 Py_FatalError("Can't initialize bool type");
Guido van Rossum77f6a652002-04-03 22:41:51 +00001505
Christian Heimes9c4756e2008-05-26 13:22:05 +00001506 if (PyType_Ready(&PyByteArray_Type) < 0)
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001507 Py_FatalError("Can't initialize bytearray type");
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001508
Christian Heimes72b710a2008-05-26 13:28:38 +00001509 if (PyType_Ready(&PyBytes_Type) < 0)
Guido van Rossumcacfc072002-05-24 19:01:59 +00001510 Py_FatalError("Can't initialize 'str'");
1511
Guido van Rossumba21a492001-08-16 08:17:26 +00001512 if (PyType_Ready(&PyList_Type) < 0)
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001513 Py_FatalError("Can't initialize list type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001514
1515 if (PyType_Ready(&PyNone_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001516 Py_FatalError("Can't initialize None type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001517
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001518 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1519 Py_FatalError("Can't initialize type(Ellipsis)");
1520
Guido van Rossumba21a492001-08-16 08:17:26 +00001521 if (PyType_Ready(&PyNotImplemented_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001522 Py_FatalError("Can't initialize NotImplemented type");
1523
1524 if (PyType_Ready(&PyTraceBack_Type) < 0)
1525 Py_FatalError("Can't initialize traceback type");
1526
1527 if (PyType_Ready(&PySuper_Type) < 0)
1528 Py_FatalError("Can't initialize super type");
1529
1530 if (PyType_Ready(&PyBaseObject_Type) < 0)
1531 Py_FatalError("Can't initialize object type");
1532
1533 if (PyType_Ready(&PyRange_Type) < 0)
1534 Py_FatalError("Can't initialize range type");
1535
1536 if (PyType_Ready(&PyDict_Type) < 0)
1537 Py_FatalError("Can't initialize dict type");
1538
1539 if (PyType_Ready(&PySet_Type) < 0)
1540 Py_FatalError("Can't initialize set type");
1541
1542 if (PyType_Ready(&PyUnicode_Type) < 0)
1543 Py_FatalError("Can't initialize str type");
1544
1545 if (PyType_Ready(&PySlice_Type) < 0)
1546 Py_FatalError("Can't initialize slice type");
1547
1548 if (PyType_Ready(&PyStaticMethod_Type) < 0)
1549 Py_FatalError("Can't initialize static method type");
1550
1551 if (PyType_Ready(&PyComplex_Type) < 0)
1552 Py_FatalError("Can't initialize complex type");
Skip Montanaroba1e0f42009-10-18 14:25:35 +00001553
Benjamin Petersonae937c02009-04-18 20:54:08 +00001554 if (PyType_Ready(&PyFloat_Type) < 0)
1555 Py_FatalError("Can't initialize float type");
1556
1557 if (PyType_Ready(&PyLong_Type) < 0)
1558 Py_FatalError("Can't initialize int type");
1559
1560 if (PyType_Ready(&PyFrozenSet_Type) < 0)
1561 Py_FatalError("Can't initialize frozenset type");
1562
1563 if (PyType_Ready(&PyProperty_Type) < 0)
1564 Py_FatalError("Can't initialize property type");
1565
1566 if (PyType_Ready(&PyMemoryView_Type) < 0)
1567 Py_FatalError("Can't initialize memoryview type");
1568
1569 if (PyType_Ready(&PyTuple_Type) < 0)
1570 Py_FatalError("Can't initialize tuple type");
1571
1572 if (PyType_Ready(&PyEnum_Type) < 0)
1573 Py_FatalError("Can't initialize enumerate type");
1574
1575 if (PyType_Ready(&PyReversed_Type) < 0)
1576 Py_FatalError("Can't initialize reversed type");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001577
Guido van Rossum826d8972007-10-30 18:34:07 +00001578 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1579 Py_FatalError("Can't initialize StdPrinter");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001580
1581 if (PyType_Ready(&PyCode_Type) < 0)
1582 Py_FatalError("Can't initialize code type");
1583
1584 if (PyType_Ready(&PyFrame_Type) < 0)
1585 Py_FatalError("Can't initialize frame type");
1586
1587 if (PyType_Ready(&PyCFunction_Type) < 0)
1588 Py_FatalError("Can't initialize builtin function type");
1589
1590 if (PyType_Ready(&PyMethod_Type) < 0)
1591 Py_FatalError("Can't initialize method type");
1592
1593 if (PyType_Ready(&PyFunction_Type) < 0)
1594 Py_FatalError("Can't initialize function type");
1595
1596 if (PyType_Ready(&PyDictProxy_Type) < 0)
1597 Py_FatalError("Can't initialize dict proxy type");
1598
1599 if (PyType_Ready(&PyGen_Type) < 0)
1600 Py_FatalError("Can't initialize generator type");
1601
1602 if (PyType_Ready(&PyGetSetDescr_Type) < 0)
1603 Py_FatalError("Can't initialize get-set descriptor type");
1604
1605 if (PyType_Ready(&PyWrapperDescr_Type) < 0)
1606 Py_FatalError("Can't initialize wrapper type");
1607
1608 if (PyType_Ready(&PyEllipsis_Type) < 0)
1609 Py_FatalError("Can't initialize ellipsis type");
1610
1611 if (PyType_Ready(&PyMemberDescr_Type) < 0)
1612 Py_FatalError("Can't initialize member descriptor type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001613
1614 if (PyType_Ready(&PyFilter_Type) < 0)
1615 Py_FatalError("Can't initialize filter type");
1616
1617 if (PyType_Ready(&PyMap_Type) < 0)
1618 Py_FatalError("Can't initialize map type");
1619
1620 if (PyType_Ready(&PyZip_Type) < 0)
1621 Py_FatalError("Can't initialize zip type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001622}
1623
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001624
Guido van Rossum84a90321996-05-22 16:34:47 +00001625#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001626
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001627void
Fred Drake100814d2000-07-09 15:48:49 +00001628_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001629{
Tim Peters34592512002-07-11 06:23:50 +00001630 _Py_INC_REFTOTAL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001631 op->ob_refcnt = 1;
Tim Peters7571a0f2003-03-23 17:52:28 +00001632 _Py_AddToAllObjects(op, 1);
Tim Peters34592512002-07-11 06:23:50 +00001633 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001634}
1635
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001636void
Fred Drake100814d2000-07-09 15:48:49 +00001637_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001638{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001639#ifdef SLOW_UNREF_CHECK
Guido van Rossum4c08d552000-03-10 22:55:18 +00001640 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001641#endif
Guido van Rossumd7047b31995-01-02 19:07:15 +00001642 if (op->ob_refcnt < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001643 Py_FatalError("UNREF negative refcnt");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001644 if (op == &refchain ||
Christian Heimesc8967002007-11-30 10:18:26 +00001645 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1646 fprintf(stderr, "* ob\n");
1647 _PyObject_Dump(op);
1648 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1649 _PyObject_Dump(op->_ob_prev->_ob_next);
1650 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1651 _PyObject_Dump(op->_ob_next->_ob_prev);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001652 Py_FatalError("UNREF invalid object");
Christian Heimesc8967002007-11-30 10:18:26 +00001653 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001654#ifdef SLOW_UNREF_CHECK
Guido van Rossum3f5da241990-12-20 15:06:42 +00001655 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1656 if (p == op)
1657 break;
1658 }
Guido van Rossumd7047b31995-01-02 19:07:15 +00001659 if (p == &refchain) /* Not found */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001660 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001661#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001662 op->_ob_next->_ob_prev = op->_ob_prev;
1663 op->_ob_prev->_ob_next = op->_ob_next;
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001664 op->_ob_next = op->_ob_prev = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001665 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001666}
1667
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001668void
Fred Drake100814d2000-07-09 15:48:49 +00001669_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001670{
Christian Heimes90aa7642007-12-19 02:45:37 +00001671 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001672 _Py_ForgetReference(op);
Guido van Rossum9776adf1994-09-07 14:36:45 +00001673 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001674}
1675
Tim Peters269b2a62003-04-17 19:52:29 +00001676/* Print all live objects. Because PyObject_Print is called, the
1677 * interpreter must be in a healthy state.
1678 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001679void
Fred Drake100814d2000-07-09 15:48:49 +00001680_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001681{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001682 PyObject *op;
Guido van Rossume09fb551997-08-05 02:04:34 +00001683 fprintf(fp, "Remaining objects:\n");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001684 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001685 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001686 if (PyObject_Print(op, fp, 0) != 0)
1687 PyErr_Clear();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001688 putc('\n', fp);
1689 }
1690}
1691
Tim Peters269b2a62003-04-17 19:52:29 +00001692/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1693 * doesn't make any calls to the Python C API, so is always safe to call.
1694 */
1695void
1696_Py_PrintReferenceAddresses(FILE *fp)
1697{
1698 PyObject *op;
1699 fprintf(fp, "Remaining object addresses:\n");
1700 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001701 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
Christian Heimes90aa7642007-12-19 02:45:37 +00001702 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001703}
1704
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001705PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001706_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001707{
1708 int i, n;
1709 PyObject *t = NULL;
1710 PyObject *res, *op;
1711
1712 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1713 return NULL;
1714 op = refchain._ob_next;
1715 res = PyList_New(0);
1716 if (res == NULL)
1717 return NULL;
1718 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1719 while (op == self || op == args || op == res || op == t ||
Christian Heimes90aa7642007-12-19 02:45:37 +00001720 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001721 op = op->_ob_next;
1722 if (op == &refchain)
1723 return res;
1724 }
1725 if (PyList_Append(res, op) < 0) {
1726 Py_DECREF(res);
1727 return NULL;
1728 }
1729 op = op->_ob_next;
1730 }
1731 return res;
1732}
1733
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001734#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001735
Guido van Rossum84a90321996-05-22 16:34:47 +00001736
Benjamin Petersonb173f782009-05-05 22:31:58 +00001737/* Hack to force loading of pycapsule.o */
1738PyTypeObject *_PyCapsule_hack = &PyCapsule_Type;
1739
1740
Guido van Rossum84a90321996-05-22 16:34:47 +00001741/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001742Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001743
1744
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001745/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001746
Thomas Wouters334fb892000-07-25 12:56:38 +00001747void *
Fred Drake100814d2000-07-09 15:48:49 +00001748PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001749{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001750 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001751}
1752
Thomas Wouters334fb892000-07-25 12:56:38 +00001753void *
1754PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001755{
Tim Petersaf3e8de2002-04-12 07:22:56 +00001756 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001757}
1758
1759void
Thomas Wouters334fb892000-07-25 12:56:38 +00001760PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001761{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001762 PyMem_FREE(p);
1763}
1764
1765
Guido van Rossum86610361998-04-10 22:32:46 +00001766/* These methods are used to control infinite recursion in repr, str, print,
1767 etc. Container objects that may recursively contain themselves,
1768 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1769 Py_ReprLeave() to avoid infinite recursion.
1770
1771 Py_ReprEnter() returns 0 the first time it is called for a particular
1772 object and 1 every time thereafter. It returns -1 if an exception
1773 occurred. Py_ReprLeave() has no return value.
1774
1775 See dictobject.c and listobject.c for examples of use.
1776*/
1777
1778#define KEY "Py_Repr"
1779
1780int
Fred Drake100814d2000-07-09 15:48:49 +00001781Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001782{
1783 PyObject *dict;
1784 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001785 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001786
1787 dict = PyThreadState_GetDict();
1788 if (dict == NULL)
Guido van Rossum0fc8f002003-04-15 15:12:39 +00001789 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001790 list = PyDict_GetItemString(dict, KEY);
1791 if (list == NULL) {
1792 list = PyList_New(0);
1793 if (list == NULL)
1794 return -1;
1795 if (PyDict_SetItemString(dict, KEY, list) < 0)
1796 return -1;
1797 Py_DECREF(list);
1798 }
1799 i = PyList_GET_SIZE(list);
1800 while (--i >= 0) {
1801 if (PyList_GET_ITEM(list, i) == obj)
1802 return 1;
1803 }
1804 PyList_Append(list, obj);
1805 return 0;
1806}
1807
1808void
Fred Drake100814d2000-07-09 15:48:49 +00001809Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001810{
1811 PyObject *dict;
1812 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001813 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001814
1815 dict = PyThreadState_GetDict();
Guido van Rossumeb909461998-04-11 15:17:34 +00001816 if (dict == NULL)
1817 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001818 list = PyDict_GetItemString(dict, KEY);
Guido van Rossumeb909461998-04-11 15:17:34 +00001819 if (list == NULL || !PyList_Check(list))
1820 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001821 i = PyList_GET_SIZE(list);
1822 /* Count backwards because we always expect obj to be list[-1] */
1823 while (--i >= 0) {
1824 if (PyList_GET_ITEM(list, i) == obj) {
1825 PyList_SetSlice(list, i, i + 1, NULL);
1826 break;
1827 }
1828 }
1829}
Guido van Rossumd724b232000-03-13 16:01:29 +00001830
Tim Peters803526b2002-07-07 05:13:56 +00001831/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001832
Tim Peters803526b2002-07-07 05:13:56 +00001833/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001834int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001835
Tim Peters803526b2002-07-07 05:13:56 +00001836/* List of objects that still need to be cleaned up, singly linked via their
1837 * gc headers' gc_prev pointers.
1838 */
1839PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001840
Tim Peters803526b2002-07-07 05:13:56 +00001841/* Add op to the _PyTrash_delete_later list. Called when the current
1842 * call-stack depth gets large. op must be a currently untracked gc'ed
1843 * object, with refcount 0. Py_DECREF must already have been called on it.
1844 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001845void
Fred Drake100814d2000-07-09 15:48:49 +00001846_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001847{
Tim Peters803526b2002-07-07 05:13:56 +00001848 assert(PyObject_IS_GC(op));
1849 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1850 assert(op->ob_refcnt == 0);
Neil Schemenauerf589c052002-03-29 03:05:54 +00001851 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
Guido van Rossume92e6102000-04-24 15:40:53 +00001852 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001853}
1854
Tim Peters803526b2002-07-07 05:13:56 +00001855/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1856 * the call-stack unwinds again.
1857 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001858void
Fred Drake100814d2000-07-09 15:48:49 +00001859_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001860{
1861 while (_PyTrash_delete_later) {
Tim Peters803526b2002-07-07 05:13:56 +00001862 PyObject *op = _PyTrash_delete_later;
Christian Heimes90aa7642007-12-19 02:45:37 +00001863 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001864
Neil Schemenauerf589c052002-03-29 03:05:54 +00001865 _PyTrash_delete_later =
Tim Peters803526b2002-07-07 05:13:56 +00001866 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001867
Tim Peters803526b2002-07-07 05:13:56 +00001868 /* Call the deallocator directly. This used to try to
1869 * fool Py_DECREF into calling it indirectly, but
1870 * Py_DECREF was already called on this object, and in
1871 * assorted non-release builds calling Py_DECREF again ends
1872 * up distorting allocation statistics.
1873 */
1874 assert(op->ob_refcnt == 0);
Guido van Rossumd724b232000-03-13 16:01:29 +00001875 ++_PyTrash_delete_nesting;
Tim Peters803526b2002-07-07 05:13:56 +00001876 (*dealloc)(op);
Guido van Rossumd724b232000-03-13 16:01:29 +00001877 --_PyTrash_delete_nesting;
1878 }
1879}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001880
1881#ifdef __cplusplus
1882}
1883#endif