blob: 57b4906089c81315e6c393f7520b91f5c683ec50 [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
477 if (bytesstring == NULL) {
478 bytesstring = PyUnicode_InternFromString("__bytes__");
479 if (bytesstring == NULL)
480 return NULL;
481 }
482
483 if (v == NULL)
484 return PyBytes_FromString("<NULL>");
485
486 if (PyBytes_CheckExact(v)) {
487 Py_INCREF(v);
488 return v;
489 }
490
491 /* Doesn't create a reference */
492 func = _PyType_Lookup(Py_TYPE(v), bytesstring);
493 if (func != NULL) {
494 result = PyObject_CallFunctionObjArgs(func, v, NULL);
495 if (result == NULL)
496 return NULL;
497 if (!PyBytes_Check(result)) {
498 PyErr_Format(PyExc_TypeError,
499 "__bytes__ returned non-bytes (type %.200s)",
500 Py_TYPE(result)->tp_name);
501 Py_DECREF(result);
502 return NULL;
503 }
504 return result;
505 }
506 PyErr_Clear();
507 return PyBytes_FromObject(v);
508}
509
Mark Dickinsonc008a172009-02-01 13:59:22 +0000510/* For Python 3.0.1 and later, the old three-way comparison has been
511 completely removed in favour of rich comparisons. PyObject_Compare() and
512 PyObject_Cmp() are gone, and the builtin cmp function no longer exists.
Mark Dickinsone94c6792009-02-02 20:36:42 +0000513 The old tp_compare slot has been renamed to tp_reserved, and should no
Mark Dickinsonc008a172009-02-01 13:59:22 +0000514 longer be used. Use tp_richcompare instead.
Guido van Rossum98297ee2007-11-06 21:34:58 +0000515
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000516 See (*) below for practical amendments.
517
Mark Dickinsonc008a172009-02-01 13:59:22 +0000518 tp_richcompare gets called with a first argument of the appropriate type
519 and a second object of an arbitrary type. We never do any kind of
520 coercion.
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000521
Mark Dickinsonc008a172009-02-01 13:59:22 +0000522 The tp_richcompare slot should return an object, as follows:
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000523
524 NULL if an exception occurred
525 NotImplemented if the requested comparison is not implemented
526 any other false value if the requested comparison is false
527 any other true value if the requested comparison is true
528
529 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
530 NotImplemented.
531
532 (*) Practical amendments:
533
534 - If rich comparison returns NotImplemented, == and != are decided by
535 comparing the object pointer (i.e. falling back to the base object
536 implementation).
537
Guido van Rossuma4073002002-05-31 20:03:54 +0000538*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000539
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000540/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000541int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000542
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000543static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000544
545/* Perform a rich comparison, raising TypeError when the requested comparison
546 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000547static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000548do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000549{
550 richcmpfunc f;
551 PyObject *res;
552
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000553 if (v->ob_type != w->ob_type &&
554 PyType_IsSubtype(w->ob_type, v->ob_type) &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000555 (f = w->ob_type->tp_richcompare) != NULL) {
Tim Petersf4aca752004-09-23 02:39:37 +0000556 res = (*f)(w, v, _Py_SwappedOp[op]);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000557 if (res != Py_NotImplemented)
558 return res;
559 Py_DECREF(res);
560 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000561 if ((f = v->ob_type->tp_richcompare) != NULL) {
Guido van Rossume797ec12001-01-17 15:24:28 +0000562 res = (*f)(v, w, op);
563 if (res != Py_NotImplemented)
564 return res;
565 Py_DECREF(res);
566 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000567 if ((f = w->ob_type->tp_richcompare) != NULL) {
568 res = (*f)(w, v, _Py_SwappedOp[op]);
569 if (res != Py_NotImplemented)
570 return res;
571 Py_DECREF(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000572 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000573 /* If neither object implements it, provide a sensible default
574 for == and !=, but raise an exception for ordering. */
575 switch (op) {
576 case Py_EQ:
577 res = (v == w) ? Py_True : Py_False;
578 break;
579 case Py_NE:
580 res = (v != w) ? Py_True : Py_False;
581 break;
582 default:
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000583 /* XXX Special-case None so it doesn't show as NoneType() */
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000584 PyErr_Format(PyExc_TypeError,
585 "unorderable types: %.100s() %s %.100s()",
586 v->ob_type->tp_name,
587 opstrings[op],
588 w->ob_type->tp_name);
589 return NULL;
590 }
Guido van Rossume797ec12001-01-17 15:24:28 +0000591 Py_INCREF(res);
592 return res;
593}
594
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000595/* Perform a rich comparison with object result. This wraps do_richcompare()
596 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000597
Guido van Rossume797ec12001-01-17 15:24:28 +0000598PyObject *
599PyObject_RichCompare(PyObject *v, PyObject *w, int op)
600{
601 PyObject *res;
602
603 assert(Py_LT <= op && op <= Py_GE);
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000604 if (v == NULL || w == NULL) {
605 if (!PyErr_Occurred())
606 PyErr_BadInternalCall();
607 return NULL;
608 }
Armin Rigo2b3eb402003-10-28 12:05:48 +0000609 if (Py_EnterRecursiveCall(" in cmp"))
610 return NULL;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000611 res = do_richcompare(v, w, op);
Armin Rigo2b3eb402003-10-28 12:05:48 +0000612 Py_LeaveRecursiveCall();
Guido van Rossume797ec12001-01-17 15:24:28 +0000613 return res;
614}
615
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000616/* Perform a rich comparison with integer result. This wraps
617 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000618int
619PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
620{
Raymond Hettinger93d44812004-03-21 17:01:44 +0000621 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000622 int ok;
623
Mark Dickinson4a1f5932008-11-12 23:23:36 +0000624 /* Quick result when objects are the same.
625 Guarantees that identity implies equality. */
626 if (v == w) {
627 if (op == Py_EQ)
628 return 1;
629 else if (op == Py_NE)
630 return 0;
631 }
632
Raymond Hettinger93d44812004-03-21 17:01:44 +0000633 res = PyObject_RichCompare(v, w, op);
Guido van Rossume797ec12001-01-17 15:24:28 +0000634 if (res == NULL)
635 return -1;
Guido van Rossum81912d42002-08-24 05:33:28 +0000636 if (PyBool_Check(res))
637 ok = (res == Py_True);
638 else
639 ok = PyObject_IsTrue(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000640 Py_DECREF(res);
641 return ok;
642}
Fred Drake13634cf2000-06-29 19:17:04 +0000643
644/* Set of hash utility functions to help maintaining the invariant that
Raymond Hettinger8183fa42004-03-21 17:35:06 +0000645 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000646
647 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
648*/
649
650long
Fred Drake100814d2000-07-09 15:48:49 +0000651_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000652{
Tim Peters39dce292000-08-15 03:34:48 +0000653 double intpart, fractpart;
654 int expo;
655 long hipart;
656 long x; /* the final hash value */
657 /* This is designed so that Python numbers of different types
658 * that compare equal hash to the same value; otherwise comparisons
659 * of mapping keys will turn out weird.
660 */
661
Tim Peters39dce292000-08-15 03:34:48 +0000662 fractpart = modf(v, &intpart);
Tim Peters39dce292000-08-15 03:34:48 +0000663 if (fractpart == 0.0) {
664 /* This must return the same hash as an equal int or long. */
Mark Dickinsonc96db472009-02-08 15:09:21 +0000665 if (intpart > LONG_MAX/2 || -intpart > LONG_MAX/2) {
Tim Peters39dce292000-08-15 03:34:48 +0000666 /* Convert to long and use its hash. */
667 PyObject *plong; /* converted to Python long */
668 if (Py_IS_INFINITY(intpart))
669 /* can't convert to long int -- arbitrary */
670 v = v < 0 ? -271828.0 : 314159.0;
671 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);
805 if (tp->tp_getattr != NULL)
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000806 return (*tp->tp_getattr)(v, _PyUnicode_AsString(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +0000807 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000808 "'%.50s' object has no attribute '%U'",
809 tp->tp_name, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000810 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000811}
812
813int
Fred Drake100814d2000-07-09 15:48:49 +0000814PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000815{
816 PyObject *res = PyObject_GetAttr(v, name);
817 if (res != NULL) {
818 Py_DECREF(res);
819 return 1;
820 }
821 PyErr_Clear();
822 return 0;
823}
824
825int
Fred Drake100814d2000-07-09 15:48:49 +0000826PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000827{
Christian Heimes90aa7642007-12-19 02:45:37 +0000828 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000829 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000830
Martin v. Löwis5b222132007-06-10 09:51:05 +0000831 if (!PyUnicode_Check(name)) {
832 PyErr_Format(PyExc_TypeError,
833 "attribute name must be string, not '%.200s'",
834 name->ob_type->tp_name);
835 return -1;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000836 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000837 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000838
Martin v. Löwis5b222132007-06-10 09:51:05 +0000839 PyUnicode_InternInPlace(&name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000840 if (tp->tp_setattro != NULL) {
841 err = (*tp->tp_setattro)(v, name, value);
842 Py_DECREF(name);
843 return err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000844 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000845 if (tp->tp_setattr != NULL) {
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000846 err = (*tp->tp_setattr)(v, _PyUnicode_AsString(name), value);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000847 Py_DECREF(name);
848 return err;
849 }
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000850 Py_DECREF(name);
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000851 assert(name->ob_refcnt >= 1);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000852 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
853 PyErr_Format(PyExc_TypeError,
854 "'%.100s' object has no attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000855 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000856 tp->tp_name,
857 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000858 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000859 else
860 PyErr_Format(PyExc_TypeError,
861 "'%.100s' object has only read-only 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 return -1;
867}
868
869/* Helper to get a pointer to an object's __dict__ slot, if any */
870
871PyObject **
872_PyObject_GetDictPtr(PyObject *obj)
873{
Martin v. Löwis725507b2006-03-07 12:08:51 +0000874 Py_ssize_t dictoffset;
Christian Heimes90aa7642007-12-19 02:45:37 +0000875 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000876
Tim Peters6d6c1a32001-08-02 04:15:00 +0000877 dictoffset = tp->tp_dictoffset;
878 if (dictoffset == 0)
879 return NULL;
880 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000881 Py_ssize_t tsize;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000882 size_t size;
883
884 tsize = ((PyVarObject *)obj)->ob_size;
885 if (tsize < 0)
886 tsize = -tsize;
887 size = _PyObject_VAR_SIZE(tp, tsize);
888
Tim Peters6d483d32001-10-06 21:27:34 +0000889 dictoffset += (long)size;
890 assert(dictoffset > 0);
891 assert(dictoffset % SIZEOF_VOID_P == 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000892 }
893 return (PyObject **) ((char *)obj + dictoffset);
894}
895
Tim Peters6d6c1a32001-08-02 04:15:00 +0000896PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000897PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +0000898{
899 Py_INCREF(obj);
900 return obj;
901}
902
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +0000903/* Helper used when the __next__ method is removed from a type:
904 tp_iternext is never NULL and can be safely called without checking
905 on every iteration.
906 */
907
908PyObject *
909_PyObject_NextNotImplemented(PyObject *self)
910{
911 PyErr_Format(PyExc_TypeError,
912 "'%.200s' object is not iterable",
913 Py_TYPE(self)->tp_name);
914 return NULL;
915}
916
Michael W. Hudson1593f502004-09-14 17:09:47 +0000917/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
918
Raymond Hettinger01538262003-03-17 08:24:35 +0000919PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000920PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
921{
Christian Heimes90aa7642007-12-19 02:45:37 +0000922 PyTypeObject *tp = Py_TYPE(obj);
Guido van Rossum056fbf42002-08-19 19:22:50 +0000923 PyObject *descr = NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000924 PyObject *res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000925 descrgetfunc f;
Martin v. Löwis725507b2006-03-07 12:08:51 +0000926 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000927 PyObject **dictptr;
928
Martin v. Löwis5b222132007-06-10 09:51:05 +0000929 if (!PyUnicode_Check(name)){
930 PyErr_Format(PyExc_TypeError,
931 "attribute name must be string, not '%.200s'",
932 name->ob_type->tp_name);
933 return NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000934 }
935 else
936 Py_INCREF(name);
937
Tim Peters6d6c1a32001-08-02 04:15:00 +0000938 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +0000939 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000940 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000941 }
942
Christian Heimesa62da1d2008-01-12 19:39:10 +0000943#if 0 /* XXX this is not quite _PyType_Lookup anymore */
Guido van Rossum056fbf42002-08-19 19:22:50 +0000944 /* Inline _PyType_Lookup */
945 {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000946 Py_ssize_t i, n;
Guido van Rossum056fbf42002-08-19 19:22:50 +0000947 PyObject *mro, *base, *dict;
948
949 /* Look in tp_dict of types in MRO */
950 mro = tp->tp_mro;
951 assert(mro != NULL);
952 assert(PyTuple_Check(mro));
953 n = PyTuple_GET_SIZE(mro);
954 for (i = 0; i < n; i++) {
955 base = PyTuple_GET_ITEM(mro, i);
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000956 assert(PyType_Check(base));
957 dict = ((PyTypeObject *)base)->tp_dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +0000958 assert(dict && PyDict_Check(dict));
959 descr = PyDict_GetItem(dict, name);
960 if (descr != NULL)
961 break;
962 }
963 }
Christian Heimesa62da1d2008-01-12 19:39:10 +0000964#else
965 descr = _PyType_Lookup(tp, name);
966#endif
Guido van Rossum056fbf42002-08-19 19:22:50 +0000967
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000968 Py_XINCREF(descr);
969
Tim Peters6d6c1a32001-08-02 04:15:00 +0000970 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000971 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000972 f = descr->ob_type->tp_descr_get;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000973 if (f != NULL && PyDescr_IsData(descr)) {
974 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000975 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000976 goto done;
977 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000978 }
979
Guido van Rossumc66ff442002-08-19 16:50:48 +0000980 /* Inline _PyObject_GetDictPtr */
981 dictoffset = tp->tp_dictoffset;
982 if (dictoffset != 0) {
983 PyObject *dict;
984 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000985 Py_ssize_t tsize;
Guido van Rossumc66ff442002-08-19 16:50:48 +0000986 size_t size;
987
988 tsize = ((PyVarObject *)obj)->ob_size;
989 if (tsize < 0)
990 tsize = -tsize;
991 size = _PyObject_VAR_SIZE(tp, tsize);
992
993 dictoffset += (long)size;
994 assert(dictoffset > 0);
995 assert(dictoffset % SIZEOF_VOID_P == 0);
996 }
997 dictptr = (PyObject **) ((char *)obj + dictoffset);
998 dict = *dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000999 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +00001000 Py_INCREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001001 res = PyDict_GetItem(dict, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001002 if (res != NULL) {
1003 Py_INCREF(res);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001004 Py_XDECREF(descr);
Christian Heimes969fe572008-01-25 11:23:10 +00001005 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001006 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001007 }
Christian Heimes969fe572008-01-25 11:23:10 +00001008 Py_DECREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001009 }
1010 }
1011
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001012 if (f != NULL) {
Christian Heimes90aa7642007-12-19 02:45:37 +00001013 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001014 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001015 goto done;
1016 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001017
1018 if (descr != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001019 res = descr;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001020 /* descr was already increfed above */
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001021 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001022 }
1023
1024 PyErr_Format(PyExc_AttributeError,
1025 "'%.50s' object has no attribute '%.400s'",
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +00001026 tp->tp_name, _PyUnicode_AsString(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001027 done:
1028 Py_DECREF(name);
1029 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001030}
1031
1032int
1033PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1034{
Christian Heimes90aa7642007-12-19 02:45:37 +00001035 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001036 PyObject *descr;
1037 descrsetfunc f;
1038 PyObject **dictptr;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001039 int res = -1;
1040
Martin v. Löwis5b222132007-06-10 09:51:05 +00001041 if (!PyUnicode_Check(name)){
1042 PyErr_Format(PyExc_TypeError,
1043 "attribute name must be string, not '%.200s'",
1044 name->ob_type->tp_name);
1045 return -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001046 }
1047 else
1048 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001049
1050 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001051 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001052 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001053 }
1054
1055 descr = _PyType_Lookup(tp, name);
1056 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001057 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001058 f = descr->ob_type->tp_descr_set;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001059 if (f != NULL && PyDescr_IsData(descr)) {
1060 res = f(descr, obj, value);
1061 goto done;
1062 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001063 }
1064
1065 dictptr = _PyObject_GetDictPtr(obj);
1066 if (dictptr != NULL) {
1067 PyObject *dict = *dictptr;
1068 if (dict == NULL && value != NULL) {
1069 dict = PyDict_New();
1070 if (dict == NULL)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001071 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001072 *dictptr = dict;
1073 }
1074 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +00001075 Py_INCREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001076 if (value == NULL)
1077 res = PyDict_DelItem(dict, name);
1078 else
1079 res = PyDict_SetItem(dict, name, value);
1080 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1081 PyErr_SetObject(PyExc_AttributeError, name);
Christian Heimes969fe572008-01-25 11:23:10 +00001082 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001083 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001084 }
1085 }
1086
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001087 if (f != NULL) {
1088 res = f(descr, obj, value);
1089 goto done;
1090 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001091
1092 if (descr == NULL) {
1093 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001094 "'%.100s' object has no attribute '%U'",
1095 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001096 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001097 }
1098
1099 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001100 "'%.50s' object attribute '%U' is read-only",
1101 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001102 done:
1103 Py_DECREF(name);
1104 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001105}
1106
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001107/* Test a value used as condition, e.g., in a for or if statement.
1108 Return -1 if an error occurred */
1109
1110int
Fred Drake100814d2000-07-09 15:48:49 +00001111PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001112{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001113 Py_ssize_t res;
Guido van Rossum6248f442002-08-24 06:31:34 +00001114 if (v == Py_True)
1115 return 1;
1116 if (v == Py_False)
1117 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001118 if (v == Py_None)
Neal Norwitz51290d32002-06-13 21:32:44 +00001119 return 0;
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001120 else if (v->ob_type->tp_as_number != NULL &&
Jack Diederich4dafcc42006-11-28 19:15:13 +00001121 v->ob_type->tp_as_number->nb_bool != NULL)
1122 res = (*v->ob_type->tp_as_number->nb_bool)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001123 else if (v->ob_type->tp_as_mapping != NULL &&
1124 v->ob_type->tp_as_mapping->mp_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001125 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001126 else if (v->ob_type->tp_as_sequence != NULL &&
1127 v->ob_type->tp_as_sequence->sq_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001128 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1129 else
Neal Norwitz51290d32002-06-13 21:32:44 +00001130 return 1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001131 /* if it is negative, it should be either -1 or -2 */
1132 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001133}
1134
Tim Peters803526b2002-07-07 05:13:56 +00001135/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001136 Return -1 if an error occurred */
1137
1138int
Fred Drake100814d2000-07-09 15:48:49 +00001139PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001140{
1141 int res;
1142 res = PyObject_IsTrue(v);
1143 if (res < 0)
1144 return res;
1145 return res == 0;
1146}
1147
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001148/* Test whether an object can be called */
1149
1150int
Fred Drake100814d2000-07-09 15:48:49 +00001151PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001152{
1153 if (x == NULL)
1154 return 0;
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001155 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001156}
1157
Georg Brandle32b4222007-03-10 22:13:27 +00001158/* ------------------------- PyObject_Dir() helpers ------------------------- */
1159
Tim Peters7eea37e2001-09-04 22:08:56 +00001160/* Helper for PyObject_Dir.
1161 Merge the __dict__ of aclass into dict, and recursively also all
1162 the __dict__s of aclass's base classes. The order of merging isn't
1163 defined, as it's expected that only the final set of dict keys is
1164 interesting.
1165 Return 0 on success, -1 on error.
1166*/
1167
1168static int
1169merge_class_dict(PyObject* dict, PyObject* aclass)
1170{
1171 PyObject *classdict;
1172 PyObject *bases;
1173
1174 assert(PyDict_Check(dict));
1175 assert(aclass);
1176
1177 /* Merge in the type's dict (if any). */
1178 classdict = PyObject_GetAttrString(aclass, "__dict__");
1179 if (classdict == NULL)
1180 PyErr_Clear();
1181 else {
1182 int status = PyDict_Update(dict, classdict);
1183 Py_DECREF(classdict);
1184 if (status < 0)
1185 return -1;
1186 }
1187
1188 /* Recursively merge in the base types' (if any) dicts. */
1189 bases = PyObject_GetAttrString(aclass, "__bases__");
Tim Petersbc7e8632001-09-16 20:33:22 +00001190 if (bases == NULL)
1191 PyErr_Clear();
1192 else {
Guido van Rossum44022412002-05-13 18:29:46 +00001193 /* We have no guarantee that bases is a real tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001194 Py_ssize_t i, n;
Guido van Rossum44022412002-05-13 18:29:46 +00001195 n = PySequence_Size(bases); /* This better be right */
1196 if (n < 0)
1197 PyErr_Clear();
1198 else {
1199 for (i = 0; i < n; i++) {
Tim Peters18e70832003-02-05 19:35:19 +00001200 int status;
Guido van Rossum44022412002-05-13 18:29:46 +00001201 PyObject *base = PySequence_GetItem(bases, i);
1202 if (base == NULL) {
1203 Py_DECREF(bases);
1204 return -1;
1205 }
Tim Peters18e70832003-02-05 19:35:19 +00001206 status = merge_class_dict(dict, base);
1207 Py_DECREF(base);
1208 if (status < 0) {
Guido van Rossum44022412002-05-13 18:29:46 +00001209 Py_DECREF(bases);
1210 return -1;
1211 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001212 }
1213 }
1214 Py_DECREF(bases);
1215 }
1216 return 0;
1217}
1218
Georg Brandle32b4222007-03-10 22:13:27 +00001219/* Helper for PyObject_Dir without arguments: returns the local scope. */
1220static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001221_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001222{
Georg Brandled3b8382007-03-12 13:15:14 +00001223 PyObject *names;
Georg Brandle32b4222007-03-10 22:13:27 +00001224 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001225
Georg Brandle32b4222007-03-10 22:13:27 +00001226 if (locals == NULL) {
1227 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1228 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001229 }
1230
Georg Brandled3b8382007-03-12 13:15:14 +00001231 names = PyMapping_Keys(locals);
1232 if (!names)
1233 return NULL;
1234 if (!PyList_Check(names)) {
1235 PyErr_Format(PyExc_TypeError,
1236 "dir(): expected keys() of locals to be a list, "
Christian Heimes90aa7642007-12-19 02:45:37 +00001237 "not '%.200s'", Py_TYPE(names)->tp_name);
Georg Brandled3b8382007-03-12 13:15:14 +00001238 Py_DECREF(names);
1239 return NULL;
1240 }
Georg Brandle32b4222007-03-10 22:13:27 +00001241 /* the locals don't need to be DECREF'd */
Georg Brandled3b8382007-03-12 13:15:14 +00001242 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001243}
1244
1245/* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
Guido van Rossum98297ee2007-11-06 21:34:58 +00001246 We deliberately don't suck up its __class__, as methods belonging to the
1247 metaclass would probably be more confusing than helpful.
Georg Brandle32b4222007-03-10 22:13:27 +00001248*/
Guido van Rossum98297ee2007-11-06 21:34:58 +00001249static PyObject *
Georg Brandle32b4222007-03-10 22:13:27 +00001250_specialized_dir_type(PyObject *obj)
1251{
1252 PyObject *result = NULL;
1253 PyObject *dict = PyDict_New();
1254
1255 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1256 result = PyDict_Keys(dict);
1257
1258 Py_XDECREF(dict);
Tim Peters305b5852001-09-17 02:38:46 +00001259 return result;
1260}
1261
Georg Brandle32b4222007-03-10 22:13:27 +00001262/* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1263static PyObject *
1264_specialized_dir_module(PyObject *obj)
Tim Peters7eea37e2001-09-04 22:08:56 +00001265{
Georg Brandle32b4222007-03-10 22:13:27 +00001266 PyObject *result = NULL;
1267 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
Tim Peters7eea37e2001-09-04 22:08:56 +00001268
Georg Brandle32b4222007-03-10 22:13:27 +00001269 if (dict != NULL) {
1270 if (PyDict_Check(dict))
1271 result = PyDict_Keys(dict);
1272 else {
1273 PyErr_Format(PyExc_TypeError,
1274 "%.200s.__dict__ is not a dictionary",
1275 PyModule_GetName(obj));
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001276 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001277 }
1278
Georg Brandle32b4222007-03-10 22:13:27 +00001279 Py_XDECREF(dict);
1280 return result;
1281}
Tim Peters7eea37e2001-09-04 22:08:56 +00001282
Georg Brandle32b4222007-03-10 22:13:27 +00001283/* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1284 and recursively up the __class__.__bases__ chain.
1285*/
1286static PyObject *
1287_generic_dir(PyObject *obj)
1288{
1289 PyObject *result = NULL;
1290 PyObject *dict = NULL;
1291 PyObject *itsclass = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001292
Georg Brandle32b4222007-03-10 22:13:27 +00001293 /* Get __dict__ (which may or may not be a real dict...) */
1294 dict = PyObject_GetAttrString(obj, "__dict__");
1295 if (dict == NULL) {
1296 PyErr_Clear();
1297 dict = PyDict_New();
1298 }
1299 else if (!PyDict_Check(dict)) {
1300 Py_DECREF(dict);
1301 dict = PyDict_New();
1302 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001303 else {
Georg Brandle32b4222007-03-10 22:13:27 +00001304 /* Copy __dict__ to avoid mutating it. */
1305 PyObject *temp = PyDict_Copy(dict);
1306 Py_DECREF(dict);
1307 dict = temp;
Tim Peters7eea37e2001-09-04 22:08:56 +00001308 }
1309
Georg Brandle32b4222007-03-10 22:13:27 +00001310 if (dict == NULL)
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001311 goto error;
Tim Peters7eea37e2001-09-04 22:08:56 +00001312
Georg Brandle32b4222007-03-10 22:13:27 +00001313 /* Merge in attrs reachable from its class. */
1314 itsclass = PyObject_GetAttrString(obj, "__class__");
1315 if (itsclass == NULL)
1316 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1317 __class__ exists? */
1318 PyErr_Clear();
1319 else {
1320 if (merge_class_dict(dict, itsclass) != 0)
1321 goto error;
1322 }
1323
1324 result = PyDict_Keys(dict);
Tim Peters7eea37e2001-09-04 22:08:56 +00001325 /* fall through */
Georg Brandle32b4222007-03-10 22:13:27 +00001326error:
1327 Py_XDECREF(itsclass);
1328 Py_XDECREF(dict);
1329 return result;
1330}
1331
1332/* Helper for PyObject_Dir: object introspection.
1333 This calls one of the above specialized versions if no __dir__ method
1334 exists. */
1335static PyObject *
1336_dir_object(PyObject *obj)
1337{
1338 PyObject * result = NULL;
1339 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1340 "__dir__");
1341
1342 assert(obj);
1343 if (dirfunc == NULL) {
1344 /* use default implementation */
1345 PyErr_Clear();
1346 if (PyModule_Check(obj))
1347 result = _specialized_dir_module(obj);
1348 else if (PyType_Check(obj))
1349 result = _specialized_dir_type(obj);
1350 else
1351 result = _generic_dir(obj);
1352 }
1353 else {
1354 /* use __dir__ */
1355 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1356 Py_DECREF(dirfunc);
1357 if (result == NULL)
1358 return NULL;
1359
1360 /* result must be a list */
1361 /* XXX(gbrandl): could also check if all items are strings */
1362 if (!PyList_Check(result)) {
1363 PyErr_Format(PyExc_TypeError,
1364 "__dir__() must return a list, not %.200s",
Christian Heimes90aa7642007-12-19 02:45:37 +00001365 Py_TYPE(result)->tp_name);
Georg Brandle32b4222007-03-10 22:13:27 +00001366 Py_DECREF(result);
1367 result = NULL;
1368 }
1369 }
1370
1371 return result;
1372}
1373
1374/* Implementation of dir() -- if obj is NULL, returns the names in the current
1375 (local) scope. Otherwise, performs introspection of the object: returns a
1376 sorted list of attribute names (supposedly) accessible from the object
1377*/
1378PyObject *
1379PyObject_Dir(PyObject *obj)
1380{
1381 PyObject * result;
1382
1383 if (obj == NULL)
1384 /* no object -- introspect the locals */
1385 result = _dir_locals();
1386 else
1387 /* object -- introspect the object */
1388 result = _dir_object(obj);
1389
1390 assert(result == NULL || PyList_Check(result));
1391
1392 if (result != NULL && PyList_Sort(result) != 0) {
1393 /* sorting the list failed */
1394 Py_DECREF(result);
1395 result = NULL;
1396 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001397
Tim Peters7eea37e2001-09-04 22:08:56 +00001398 return result;
1399}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001400
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001401/*
1402NoObject is usable as a non-NULL undefined value, used by the macro None.
1403There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001404so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001405(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001406*/
1407
Guido van Rossum0c182a11992-03-27 17:26:13 +00001408/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001409static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001410none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001411{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001412 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001413}
1414
Barry Warsaw9bf16442001-01-23 16:24:35 +00001415/* ARGUSED */
1416static void
Tim Peters803526b2002-07-07 05:13:56 +00001417none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001418{
1419 /* This should never get called, but we also don't want to SEGV if
Mark Dickinson934896d2009-02-21 20:59:32 +00001420 * we accidentally decref None out of existence.
Barry Warsaw9bf16442001-01-23 16:24:35 +00001421 */
Martin v. Löwis3f19b102002-08-07 16:21:51 +00001422 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001423}
1424
1425
Guido van Rossumba21a492001-08-16 08:17:26 +00001426static PyTypeObject PyNone_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001427 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001428 "NoneType",
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001429 0,
1430 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001431 none_dealloc, /*tp_dealloc*/ /*never called*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001432 0, /*tp_print*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001433 0, /*tp_getattr*/
1434 0, /*tp_setattr*/
Mark Dickinsone94c6792009-02-02 20:36:42 +00001435 0, /*tp_reserved*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001436 none_repr, /*tp_repr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001437 0, /*tp_as_number*/
1438 0, /*tp_as_sequence*/
1439 0, /*tp_as_mapping*/
Guido van Rossum9bfef441993-03-29 10:43:31 +00001440 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001441};
1442
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001443PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001444 _PyObject_EXTRA_INIT
1445 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001446};
1447
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001448/* NotImplemented is an object that can be used to signal that an
1449 operation is not implemented for the given type combination. */
1450
1451static PyObject *
1452NotImplemented_repr(PyObject *op)
1453{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001454 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001455}
1456
1457static PyTypeObject PyNotImplemented_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001458 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001459 "NotImplementedType",
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001460 0,
1461 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001462 none_dealloc, /*tp_dealloc*/ /*never called*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001463 0, /*tp_print*/
1464 0, /*tp_getattr*/
1465 0, /*tp_setattr*/
Mark Dickinsone94c6792009-02-02 20:36:42 +00001466 0, /*tp_reserved*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001467 NotImplemented_repr, /*tp_repr*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001468 0, /*tp_as_number*/
1469 0, /*tp_as_sequence*/
1470 0, /*tp_as_mapping*/
1471 0, /*tp_hash */
1472};
1473
1474PyObject _Py_NotImplementedStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001475 _PyObject_EXTRA_INIT
1476 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001477};
1478
Guido van Rossumba21a492001-08-16 08:17:26 +00001479void
1480_Py_ReadyTypes(void)
1481{
1482 if (PyType_Ready(&PyType_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001483 Py_FatalError("Can't initialize type type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001484
Fred Drake0a4dd392004-07-02 18:57:45 +00001485 if (PyType_Ready(&_PyWeakref_RefType) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001486 Py_FatalError("Can't initialize weakref type");
Fred Drake0a4dd392004-07-02 18:57:45 +00001487
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001488 if (PyType_Ready(&_PyWeakref_CallableProxyType) < 0)
1489 Py_FatalError("Can't initialize callable weakref proxy type");
1490
1491 if (PyType_Ready(&_PyWeakref_ProxyType) < 0)
1492 Py_FatalError("Can't initialize weakref proxy type");
1493
Guido van Rossum77f6a652002-04-03 22:41:51 +00001494 if (PyType_Ready(&PyBool_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001495 Py_FatalError("Can't initialize bool type");
Guido van Rossum77f6a652002-04-03 22:41:51 +00001496
Christian Heimes9c4756e2008-05-26 13:22:05 +00001497 if (PyType_Ready(&PyByteArray_Type) < 0)
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001498 Py_FatalError("Can't initialize bytearray type");
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001499
Christian Heimes72b710a2008-05-26 13:28:38 +00001500 if (PyType_Ready(&PyBytes_Type) < 0)
Guido van Rossumcacfc072002-05-24 19:01:59 +00001501 Py_FatalError("Can't initialize 'str'");
1502
Guido van Rossumba21a492001-08-16 08:17:26 +00001503 if (PyType_Ready(&PyList_Type) < 0)
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001504 Py_FatalError("Can't initialize list type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001505
1506 if (PyType_Ready(&PyNone_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001507 Py_FatalError("Can't initialize None type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001508
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001509 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1510 Py_FatalError("Can't initialize type(Ellipsis)");
1511
Guido van Rossumba21a492001-08-16 08:17:26 +00001512 if (PyType_Ready(&PyNotImplemented_Type) < 0)
Benjamin Petersonae937c02009-04-18 20:54:08 +00001513 Py_FatalError("Can't initialize NotImplemented type");
1514
1515 if (PyType_Ready(&PyTraceBack_Type) < 0)
1516 Py_FatalError("Can't initialize traceback type");
1517
1518 if (PyType_Ready(&PySuper_Type) < 0)
1519 Py_FatalError("Can't initialize super type");
1520
1521 if (PyType_Ready(&PyBaseObject_Type) < 0)
1522 Py_FatalError("Can't initialize object type");
1523
1524 if (PyType_Ready(&PyRange_Type) < 0)
1525 Py_FatalError("Can't initialize range type");
1526
1527 if (PyType_Ready(&PyDict_Type) < 0)
1528 Py_FatalError("Can't initialize dict type");
1529
1530 if (PyType_Ready(&PySet_Type) < 0)
1531 Py_FatalError("Can't initialize set type");
1532
1533 if (PyType_Ready(&PyUnicode_Type) < 0)
1534 Py_FatalError("Can't initialize str type");
1535
1536 if (PyType_Ready(&PySlice_Type) < 0)
1537 Py_FatalError("Can't initialize slice type");
1538
1539 if (PyType_Ready(&PyStaticMethod_Type) < 0)
1540 Py_FatalError("Can't initialize static method type");
1541
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001542#ifndef WITHOUT_COMPLEX
Benjamin Petersonae937c02009-04-18 20:54:08 +00001543 if (PyType_Ready(&PyComplex_Type) < 0)
1544 Py_FatalError("Can't initialize complex type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001545#endif
Benjamin Petersonae937c02009-04-18 20:54:08 +00001546 if (PyType_Ready(&PyFloat_Type) < 0)
1547 Py_FatalError("Can't initialize float type");
1548
1549 if (PyType_Ready(&PyLong_Type) < 0)
1550 Py_FatalError("Can't initialize int type");
1551
1552 if (PyType_Ready(&PyFrozenSet_Type) < 0)
1553 Py_FatalError("Can't initialize frozenset type");
1554
1555 if (PyType_Ready(&PyProperty_Type) < 0)
1556 Py_FatalError("Can't initialize property type");
1557
1558 if (PyType_Ready(&PyMemoryView_Type) < 0)
1559 Py_FatalError("Can't initialize memoryview type");
1560
1561 if (PyType_Ready(&PyTuple_Type) < 0)
1562 Py_FatalError("Can't initialize tuple type");
1563
1564 if (PyType_Ready(&PyEnum_Type) < 0)
1565 Py_FatalError("Can't initialize enumerate type");
1566
1567 if (PyType_Ready(&PyReversed_Type) < 0)
1568 Py_FatalError("Can't initialize reversed type");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001569
Guido van Rossum826d8972007-10-30 18:34:07 +00001570 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1571 Py_FatalError("Can't initialize StdPrinter");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001572
1573 if (PyType_Ready(&PyCode_Type) < 0)
1574 Py_FatalError("Can't initialize code type");
1575
1576 if (PyType_Ready(&PyFrame_Type) < 0)
1577 Py_FatalError("Can't initialize frame type");
1578
1579 if (PyType_Ready(&PyCFunction_Type) < 0)
1580 Py_FatalError("Can't initialize builtin function type");
1581
1582 if (PyType_Ready(&PyMethod_Type) < 0)
1583 Py_FatalError("Can't initialize method type");
1584
1585 if (PyType_Ready(&PyFunction_Type) < 0)
1586 Py_FatalError("Can't initialize function type");
1587
1588 if (PyType_Ready(&PyDictProxy_Type) < 0)
1589 Py_FatalError("Can't initialize dict proxy type");
1590
1591 if (PyType_Ready(&PyGen_Type) < 0)
1592 Py_FatalError("Can't initialize generator type");
1593
1594 if (PyType_Ready(&PyGetSetDescr_Type) < 0)
1595 Py_FatalError("Can't initialize get-set descriptor type");
1596
1597 if (PyType_Ready(&PyWrapperDescr_Type) < 0)
1598 Py_FatalError("Can't initialize wrapper type");
1599
1600 if (PyType_Ready(&PyEllipsis_Type) < 0)
1601 Py_FatalError("Can't initialize ellipsis type");
1602
1603 if (PyType_Ready(&PyMemberDescr_Type) < 0)
1604 Py_FatalError("Can't initialize member descriptor type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001605}
1606
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001607
Guido van Rossum84a90321996-05-22 16:34:47 +00001608#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001609
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001610void
Fred Drake100814d2000-07-09 15:48:49 +00001611_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001612{
Tim Peters34592512002-07-11 06:23:50 +00001613 _Py_INC_REFTOTAL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001614 op->ob_refcnt = 1;
Tim Peters7571a0f2003-03-23 17:52:28 +00001615 _Py_AddToAllObjects(op, 1);
Tim Peters34592512002-07-11 06:23:50 +00001616 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001617}
1618
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001619void
Fred Drake100814d2000-07-09 15:48:49 +00001620_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001621{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001622#ifdef SLOW_UNREF_CHECK
Guido van Rossum4c08d552000-03-10 22:55:18 +00001623 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001624#endif
Guido van Rossumd7047b31995-01-02 19:07:15 +00001625 if (op->ob_refcnt < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001626 Py_FatalError("UNREF negative refcnt");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001627 if (op == &refchain ||
Christian Heimesc8967002007-11-30 10:18:26 +00001628 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1629 fprintf(stderr, "* ob\n");
1630 _PyObject_Dump(op);
1631 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1632 _PyObject_Dump(op->_ob_prev->_ob_next);
1633 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1634 _PyObject_Dump(op->_ob_next->_ob_prev);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001635 Py_FatalError("UNREF invalid object");
Christian Heimesc8967002007-11-30 10:18:26 +00001636 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001637#ifdef SLOW_UNREF_CHECK
Guido van Rossum3f5da241990-12-20 15:06:42 +00001638 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1639 if (p == op)
1640 break;
1641 }
Guido van Rossumd7047b31995-01-02 19:07:15 +00001642 if (p == &refchain) /* Not found */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001643 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001644#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001645 op->_ob_next->_ob_prev = op->_ob_prev;
1646 op->_ob_prev->_ob_next = op->_ob_next;
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001647 op->_ob_next = op->_ob_prev = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001648 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001649}
1650
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001651void
Fred Drake100814d2000-07-09 15:48:49 +00001652_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001653{
Christian Heimes90aa7642007-12-19 02:45:37 +00001654 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001655 _Py_ForgetReference(op);
Guido van Rossum9776adf1994-09-07 14:36:45 +00001656 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001657}
1658
Tim Peters269b2a62003-04-17 19:52:29 +00001659/* Print all live objects. Because PyObject_Print is called, the
1660 * interpreter must be in a healthy state.
1661 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001662void
Fred Drake100814d2000-07-09 15:48:49 +00001663_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001664{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001665 PyObject *op;
Guido van Rossume09fb551997-08-05 02:04:34 +00001666 fprintf(fp, "Remaining objects:\n");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001667 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001668 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001669 if (PyObject_Print(op, fp, 0) != 0)
1670 PyErr_Clear();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001671 putc('\n', fp);
1672 }
1673}
1674
Tim Peters269b2a62003-04-17 19:52:29 +00001675/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1676 * doesn't make any calls to the Python C API, so is always safe to call.
1677 */
1678void
1679_Py_PrintReferenceAddresses(FILE *fp)
1680{
1681 PyObject *op;
1682 fprintf(fp, "Remaining object addresses:\n");
1683 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001684 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
Christian Heimes90aa7642007-12-19 02:45:37 +00001685 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001686}
1687
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001688PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001689_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001690{
1691 int i, n;
1692 PyObject *t = NULL;
1693 PyObject *res, *op;
1694
1695 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1696 return NULL;
1697 op = refchain._ob_next;
1698 res = PyList_New(0);
1699 if (res == NULL)
1700 return NULL;
1701 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1702 while (op == self || op == args || op == res || op == t ||
Christian Heimes90aa7642007-12-19 02:45:37 +00001703 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001704 op = op->_ob_next;
1705 if (op == &refchain)
1706 return res;
1707 }
1708 if (PyList_Append(res, op) < 0) {
1709 Py_DECREF(res);
1710 return NULL;
1711 }
1712 op = op->_ob_next;
1713 }
1714 return res;
1715}
1716
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001717#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001718
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001719/* Hack to force loading of cobject.o */
Guido van Rossumda9c2711996-12-05 21:58:58 +00001720PyTypeObject *_Py_cobject_hack = &PyCObject_Type;
Guido van Rossum84a90321996-05-22 16:34:47 +00001721
1722
Benjamin Petersonb173f782009-05-05 22:31:58 +00001723/* Hack to force loading of pycapsule.o */
1724PyTypeObject *_PyCapsule_hack = &PyCapsule_Type;
1725
1726
Guido van Rossum84a90321996-05-22 16:34:47 +00001727/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001728Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001729
1730
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001731/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001732
Thomas Wouters334fb892000-07-25 12:56:38 +00001733void *
Fred Drake100814d2000-07-09 15:48:49 +00001734PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001735{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001736 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001737}
1738
Thomas Wouters334fb892000-07-25 12:56:38 +00001739void *
1740PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001741{
Tim Petersaf3e8de2002-04-12 07:22:56 +00001742 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001743}
1744
1745void
Thomas Wouters334fb892000-07-25 12:56:38 +00001746PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001747{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001748 PyMem_FREE(p);
1749}
1750
1751
Guido van Rossum86610361998-04-10 22:32:46 +00001752/* These methods are used to control infinite recursion in repr, str, print,
1753 etc. Container objects that may recursively contain themselves,
1754 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1755 Py_ReprLeave() to avoid infinite recursion.
1756
1757 Py_ReprEnter() returns 0 the first time it is called for a particular
1758 object and 1 every time thereafter. It returns -1 if an exception
1759 occurred. Py_ReprLeave() has no return value.
1760
1761 See dictobject.c and listobject.c for examples of use.
1762*/
1763
1764#define KEY "Py_Repr"
1765
1766int
Fred Drake100814d2000-07-09 15:48:49 +00001767Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001768{
1769 PyObject *dict;
1770 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001771 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001772
1773 dict = PyThreadState_GetDict();
1774 if (dict == NULL)
Guido van Rossum0fc8f002003-04-15 15:12:39 +00001775 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001776 list = PyDict_GetItemString(dict, KEY);
1777 if (list == NULL) {
1778 list = PyList_New(0);
1779 if (list == NULL)
1780 return -1;
1781 if (PyDict_SetItemString(dict, KEY, list) < 0)
1782 return -1;
1783 Py_DECREF(list);
1784 }
1785 i = PyList_GET_SIZE(list);
1786 while (--i >= 0) {
1787 if (PyList_GET_ITEM(list, i) == obj)
1788 return 1;
1789 }
1790 PyList_Append(list, obj);
1791 return 0;
1792}
1793
1794void
Fred Drake100814d2000-07-09 15:48:49 +00001795Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001796{
1797 PyObject *dict;
1798 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001799 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001800
1801 dict = PyThreadState_GetDict();
Guido van Rossumeb909461998-04-11 15:17:34 +00001802 if (dict == NULL)
1803 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001804 list = PyDict_GetItemString(dict, KEY);
Guido van Rossumeb909461998-04-11 15:17:34 +00001805 if (list == NULL || !PyList_Check(list))
1806 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001807 i = PyList_GET_SIZE(list);
1808 /* Count backwards because we always expect obj to be list[-1] */
1809 while (--i >= 0) {
1810 if (PyList_GET_ITEM(list, i) == obj) {
1811 PyList_SetSlice(list, i, i + 1, NULL);
1812 break;
1813 }
1814 }
1815}
Guido van Rossumd724b232000-03-13 16:01:29 +00001816
Tim Peters803526b2002-07-07 05:13:56 +00001817/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001818
Tim Peters803526b2002-07-07 05:13:56 +00001819/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001820int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001821
Tim Peters803526b2002-07-07 05:13:56 +00001822/* List of objects that still need to be cleaned up, singly linked via their
1823 * gc headers' gc_prev pointers.
1824 */
1825PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001826
Tim Peters803526b2002-07-07 05:13:56 +00001827/* Add op to the _PyTrash_delete_later list. Called when the current
1828 * call-stack depth gets large. op must be a currently untracked gc'ed
1829 * object, with refcount 0. Py_DECREF must already have been called on it.
1830 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001831void
Fred Drake100814d2000-07-09 15:48:49 +00001832_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001833{
Tim Peters803526b2002-07-07 05:13:56 +00001834 assert(PyObject_IS_GC(op));
1835 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1836 assert(op->ob_refcnt == 0);
Neil Schemenauerf589c052002-03-29 03:05:54 +00001837 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
Guido van Rossume92e6102000-04-24 15:40:53 +00001838 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001839}
1840
Tim Peters803526b2002-07-07 05:13:56 +00001841/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1842 * the call-stack unwinds again.
1843 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001844void
Fred Drake100814d2000-07-09 15:48:49 +00001845_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001846{
1847 while (_PyTrash_delete_later) {
Tim Peters803526b2002-07-07 05:13:56 +00001848 PyObject *op = _PyTrash_delete_later;
Christian Heimes90aa7642007-12-19 02:45:37 +00001849 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001850
Neil Schemenauerf589c052002-03-29 03:05:54 +00001851 _PyTrash_delete_later =
Tim Peters803526b2002-07-07 05:13:56 +00001852 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001853
Tim Peters803526b2002-07-07 05:13:56 +00001854 /* Call the deallocator directly. This used to try to
1855 * fool Py_DECREF into calling it indirectly, but
1856 * Py_DECREF was already called on this object, and in
1857 * assorted non-release builds calling Py_DECREF again ends
1858 * up distorting allocation statistics.
1859 */
1860 assert(op->ob_refcnt == 0);
Guido van Rossumd724b232000-03-13 16:01:29 +00001861 ++_PyTrash_delete_nesting;
Tim Peters803526b2002-07-07 05:13:56 +00001862 (*dealloc)(op);
Guido van Rossumd724b232000-03-13 16:01:29 +00001863 --_PyTrash_delete_nesting;
1864 }
1865}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001866
1867#ifdef __cplusplus
1868}
1869#endif