blob: bf0e6d174dc0712184bad44e356572088ff7d086 [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 */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00006
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007#ifdef __cplusplus
8extern "C" {
9#endif
10
Tim Peters34592512002-07-11 06:23:50 +000011#ifdef Py_REF_DEBUG
Neal Norwitz84632ee2006-03-04 20:00:59 +000012Py_ssize_t _Py_RefTotal;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000013
14Py_ssize_t
15_Py_GetRefTotal(void)
16{
17 PyObject *o;
18 Py_ssize_t total = _Py_RefTotal;
19 /* ignore the references to the dummy object of the dicts and sets
20 because they are not reliable and not useful (now that the
21 hash table code is well-tested) */
22 o = _PyDict_Dummy();
23 if (o != NULL)
24 total -= o->ob_refcnt;
25 o = _PySet_Dummy();
26 if (o != NULL)
27 total -= o->ob_refcnt;
28 return total;
29}
30#endif /* Py_REF_DEBUG */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000031
Mark Hammonda2905272002-07-29 13:42:14 +000032int Py_DivisionWarningFlag;
Guido van Rossum393661d2001-08-31 17:40:15 +000033
Guido van Rossum3f5da241990-12-20 15:06:42 +000034/* Object allocation routines used by NEWOBJ and NEWVAROBJ macros.
35 These are used by the individual routines for object creation.
36 Do not call them otherwise, they do not initialize the object! */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000037
Tim Peters78be7992003-03-23 02:51:01 +000038#ifdef Py_TRACE_REFS
Tim Peters7571a0f2003-03-23 17:52:28 +000039/* Head of circular doubly-linked list of all objects. These are linked
40 * together via the _ob_prev and _ob_next members of a PyObject, which
41 * exist only in a Py_TRACE_REFS build.
42 */
Tim Peters78be7992003-03-23 02:51:01 +000043static PyObject refchain = {&refchain, &refchain};
Tim Peters36eb4df2003-03-23 03:33:13 +000044
Tim Peters7571a0f2003-03-23 17:52:28 +000045/* Insert op at the front of the list of all objects. If force is true,
46 * op is added even if _ob_prev and _ob_next are non-NULL already. If
47 * force is false amd _ob_prev or _ob_next are non-NULL, do nothing.
48 * force should be true if and only if op points to freshly allocated,
49 * uninitialized memory, or you've unlinked op from the list and are
Tim Peters51f8d382003-03-23 18:06:08 +000050 * relinking it into the front.
Tim Peters7571a0f2003-03-23 17:52:28 +000051 * Note that objects are normally added to the list via _Py_NewReference,
52 * which is called by PyObject_Init. Not all objects are initialized that
53 * way, though; exceptions include statically allocated type objects, and
54 * statically allocated singletons (like Py_True and Py_None).
55 */
Tim Peters36eb4df2003-03-23 03:33:13 +000056void
Tim Peters7571a0f2003-03-23 17:52:28 +000057_Py_AddToAllObjects(PyObject *op, int force)
Tim Peters36eb4df2003-03-23 03:33:13 +000058{
Tim Peters7571a0f2003-03-23 17:52:28 +000059#ifdef Py_DEBUG
60 if (!force) {
61 /* If it's initialized memory, op must be in or out of
62 * the list unambiguously.
63 */
64 assert((op->_ob_prev == NULL) == (op->_ob_next == NULL));
65 }
Tim Peters78be7992003-03-23 02:51:01 +000066#endif
Tim Peters7571a0f2003-03-23 17:52:28 +000067 if (force || op->_ob_prev == NULL) {
68 op->_ob_next = refchain._ob_next;
69 op->_ob_prev = &refchain;
70 refchain._ob_next->_ob_prev = op;
71 refchain._ob_next = op;
72 }
73}
74#endif /* Py_TRACE_REFS */
Tim Peters78be7992003-03-23 02:51:01 +000075
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000076#ifdef COUNT_ALLOCS
Guido van Rossumc0b618a1997-05-02 03:12:38 +000077static PyTypeObject *type_list;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000078/* All types are added to type_list, at least when
79 they get one object created. That makes them
80 immortal, which unfortunately contributes to
81 garbage itself. If unlist_types_without_objects
82 is set, they will be removed from the type_list
83 once the last object is deallocated. */
84int unlist_types_without_objects;
Sjoerd Mullender842d2cc1993-10-15 16:18:48 +000085extern int tuple_zero_allocs, fast_tuple_allocs;
86extern int quick_int_allocs, quick_neg_int_allocs;
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +000087extern int null_strings, one_strings;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000088void
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000089dump_counts(FILE* f)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000090{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000091 PyTypeObject *tp;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000092
93 for (tp = type_list; tp; tp = tp->tp_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000094 fprintf(f, "%s alloc'd: %d, freed: %d, max in use: %d\n",
Tim Peters6d6c1a32001-08-02 04:15:00 +000095 tp->tp_name, tp->tp_allocs, tp->tp_frees,
Sjoerd Mullender52c1f511993-10-25 08:40:52 +000096 tp->tp_maxalloc);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000097 fprintf(f, "fast tuple allocs: %d, empty: %d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +000098 fast_tuple_allocs, tuple_zero_allocs);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000099 fprintf(f, "fast int allocs: pos: %d, neg: %d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +0000100 quick_int_allocs, quick_neg_int_allocs);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000101 fprintf(f, "null strings: %d, 1-strings: %d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +0000102 null_strings, one_strings);
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000103}
104
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000105PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000106get_counts(void)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000107{
108 PyTypeObject *tp;
109 PyObject *result;
110 PyObject *v;
111
112 result = PyList_New(0);
113 if (result == NULL)
114 return NULL;
115 for (tp = type_list; tp; tp = tp->tp_next) {
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000116 v = Py_BuildValue("(snnn)", tp->tp_name, tp->tp_allocs,
Tim Peters6d6c1a32001-08-02 04:15:00 +0000117 tp->tp_frees, tp->tp_maxalloc);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000118 if (v == NULL) {
119 Py_DECREF(result);
120 return NULL;
121 }
122 if (PyList_Append(result, v) < 0) {
123 Py_DECREF(v);
124 Py_DECREF(result);
125 return NULL;
126 }
127 Py_DECREF(v);
128 }
129 return result;
130}
131
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000132void
Fred Drake100814d2000-07-09 15:48:49 +0000133inc_count(PyTypeObject *tp)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000134{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000135 if (tp->tp_next == NULL && tp->tp_prev == NULL) {
Guido van Rossumd8953cb1995-04-06 14:46:26 +0000136 /* first time; insert in linked list */
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000137 if (tp->tp_next != NULL) /* sanity check */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000138 Py_FatalError("XXX inc_count sanity check");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000139 if (type_list)
140 type_list->tp_prev = tp;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000141 tp->tp_next = type_list;
Tim Petersc6a3ff62002-07-08 22:11:52 +0000142 /* Note that as of Python 2.2, heap-allocated type objects
143 * can go away, but this code requires that they stay alive
144 * until program exit. That's why we're careful with
145 * refcounts here. type_list gets a new reference to tp,
146 * while ownership of the reference type_list used to hold
147 * (if any) was transferred to tp->tp_next in the line above.
148 * tp is thus effectively immortal after this.
149 */
150 Py_INCREF(tp);
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000151 type_list = tp;
Tim Peters3e40c7f2003-03-23 03:04:32 +0000152#ifdef Py_TRACE_REFS
Tim Peters7571a0f2003-03-23 17:52:28 +0000153 /* Also insert in the doubly-linked list of all objects,
154 * if not already there.
155 */
156 _Py_AddToAllObjects((PyObject *)tp, 0);
Tim Peters78be7992003-03-23 02:51:01 +0000157#endif
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000158 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000159 tp->tp_allocs++;
160 if (tp->tp_allocs - tp->tp_frees > tp->tp_maxalloc)
161 tp->tp_maxalloc = tp->tp_allocs - tp->tp_frees;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000162}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000163
164void dec_count(PyTypeObject *tp)
165{
166 tp->tp_frees++;
167 if (unlist_types_without_objects &&
168 tp->tp_allocs == tp->tp_frees) {
169 /* unlink the type from type_list */
170 if (tp->tp_prev)
171 tp->tp_prev->tp_next = tp->tp_next;
172 else
173 type_list = tp->tp_next;
174 if (tp->tp_next)
175 tp->tp_next->tp_prev = tp->tp_prev;
176 tp->tp_next = tp->tp_prev = NULL;
177 Py_DECREF(tp);
178 }
179}
180
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000181#endif
182
Tim Peters7c321a82002-07-09 02:57:01 +0000183#ifdef Py_REF_DEBUG
184/* Log a fatal error; doesn't return. */
185void
186_Py_NegativeRefcount(const char *fname, int lineno, PyObject *op)
187{
188 char buf[300];
189
190 PyOS_snprintf(buf, sizeof(buf),
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000191 "%s:%i object at %p has negative ref count "
192 "%" PY_FORMAT_SIZE_T "d",
193 fname, lineno, op, op->ob_refcnt);
Tim Peters7c321a82002-07-09 02:57:01 +0000194 Py_FatalError(buf);
195}
196
197#endif /* Py_REF_DEBUG */
198
Thomas Heller1328b522004-04-22 17:23:49 +0000199void
200Py_IncRef(PyObject *o)
201{
202 Py_XINCREF(o);
203}
204
205void
206Py_DecRef(PyObject *o)
207{
208 Py_XDECREF(o);
209}
210
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000211PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000212PyObject_Init(PyObject *op, PyTypeObject *tp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000213{
Guido van Rossum6e08c142002-10-11 20:37:24 +0000214 if (op == NULL)
215 return PyErr_NoMemory();
Guido van Rossumb18618d2000-05-03 23:44:39 +0000216 /* Any changes should be reflected in PyObject_INIT (objimpl.h) */
Christian Heimes90aa7642007-12-19 02:45:37 +0000217 Py_TYPE(op) = tp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000218 _Py_NewReference(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000219 return op;
220}
221
Guido van Rossumb18618d2000-05-03 23:44:39 +0000222PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000223PyObject_InitVar(PyVarObject *op, PyTypeObject *tp, Py_ssize_t size)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000224{
Guido van Rossum6e08c142002-10-11 20:37:24 +0000225 if (op == NULL)
226 return (PyVarObject *) PyErr_NoMemory();
Guido van Rossumb18618d2000-05-03 23:44:39 +0000227 /* Any changes should be reflected in PyObject_INIT_VAR */
228 op->ob_size = size;
Christian Heimes90aa7642007-12-19 02:45:37 +0000229 Py_TYPE(op) = tp;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000230 _Py_NewReference((PyObject *)op);
231 return op;
232}
233
234PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000235_PyObject_New(PyTypeObject *tp)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000236{
237 PyObject *op;
238 op = (PyObject *) PyObject_MALLOC(_PyObject_SIZE(tp));
239 if (op == NULL)
240 return PyErr_NoMemory();
241 return PyObject_INIT(op, tp);
242}
243
Guido van Rossumd0c87ee1997-05-15 21:31:03 +0000244PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000245_PyObject_NewVar(PyTypeObject *tp, Py_ssize_t nitems)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000246{
Guido van Rossumb18618d2000-05-03 23:44:39 +0000247 PyVarObject *op;
Tim Petersf2a67da2001-10-07 03:54:51 +0000248 const size_t size = _PyObject_VAR_SIZE(tp, nitems);
Tim Peters6d483d32001-10-06 21:27:34 +0000249 op = (PyVarObject *) PyObject_MALLOC(size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000250 if (op == NULL)
Guido van Rossumd0c87ee1997-05-15 21:31:03 +0000251 return (PyVarObject *)PyErr_NoMemory();
Tim Peters6d483d32001-10-06 21:27:34 +0000252 return PyObject_INIT_VAR(op, tp, nitems);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000253}
254
Neal Norwitz1a997502003-01-13 20:13:12 +0000255/* Implementation of PyObject_Print with recursion checking */
256static int
257internal_print(PyObject *op, FILE *fp, int flags, int nesting)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000258{
Guido van Rossum278ef591991-07-27 21:40:24 +0000259 int ret = 0;
Neal Norwitz1a997502003-01-13 20:13:12 +0000260 if (nesting > 10) {
261 PyErr_SetString(PyExc_RuntimeError, "print recursion");
262 return -1;
263 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000264 if (PyErr_CheckSignals())
Guido van Rossum90933611991-06-07 16:10:43 +0000265 return -1;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000266#ifdef USE_STACKCHECK
267 if (PyOS_CheckStack()) {
Fred Drake661ea262000-10-24 19:57:45 +0000268 PyErr_SetString(PyExc_MemoryError, "stack overflow");
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000269 return -1;
270 }
271#endif
Guido van Rossum687ef6e2000-01-12 16:28:58 +0000272 clearerr(fp); /* Clear any previous error condition */
Guido van Rossum90933611991-06-07 16:10:43 +0000273 if (op == NULL) {
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000274 Py_BEGIN_ALLOW_THREADS
Guido van Rossum90933611991-06-07 16:10:43 +0000275 fprintf(fp, "<nil>");
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000276 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000277 }
Guido van Rossum90933611991-06-07 16:10:43 +0000278 else {
279 if (op->ob_refcnt <= 0)
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000280 /* XXX(twouters) cast refcount to long until %zd is
281 universally available */
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000282 Py_BEGIN_ALLOW_THREADS
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000283 fprintf(fp, "<refcnt %ld at %p>",
284 (long)op->ob_refcnt, op);
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000285 Py_END_ALLOW_THREADS
Guido van Rossum04dbf3b2007-08-07 19:51:00 +0000286 else {
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000287 PyObject *s;
288 if (flags & Py_PRINT_RAW)
289 s = PyObject_Str(op);
290 else
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000291 s = PyObject_Repr(op);
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000292 if (s == NULL)
293 ret = -1;
Christian Heimes72b710a2008-05-26 13:28:38 +0000294 else if (PyBytes_Check(s)) {
295 fwrite(PyBytes_AS_STRING(s), 1,
296 PyBytes_GET_SIZE(s), fp);
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000297 }
298 else if (PyUnicode_Check(s)) {
299 PyObject *t;
300 t = _PyUnicode_AsDefaultEncodedString(s, NULL);
301 if (t == NULL)
302 ret = 0;
303 else {
Christian Heimes72b710a2008-05-26 13:28:38 +0000304 fwrite(PyBytes_AS_STRING(t), 1,
305 PyBytes_GET_SIZE(t), fp);
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000306 }
307 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000308 else {
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000309 PyErr_Format(PyExc_TypeError,
310 "str() or repr() returned '%.100s'",
311 s->ob_type->tp_name);
312 ret = -1;
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000313 }
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000314 Py_XDECREF(s);
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000315 }
Guido van Rossum90933611991-06-07 16:10:43 +0000316 }
Guido van Rossum278ef591991-07-27 21:40:24 +0000317 if (ret == 0) {
318 if (ferror(fp)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000319 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum278ef591991-07-27 21:40:24 +0000320 clearerr(fp);
321 ret = -1;
322 }
323 }
324 return ret;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000325}
326
Neal Norwitz1a997502003-01-13 20:13:12 +0000327int
328PyObject_Print(PyObject *op, FILE *fp, int flags)
329{
330 return internal_print(op, fp, flags, 0);
331}
332
Guido van Rossum38938152006-08-21 23:36:26 +0000333/* For debugging convenience. Set a breakpoint here and call it from your DLL */
334void
Thomas Woutersb2137042007-02-01 18:02:27 +0000335_Py_BreakPoint(void)
Guido van Rossum38938152006-08-21 23:36:26 +0000336{
337}
338
Neal Norwitz1a997502003-01-13 20:13:12 +0000339
Barry Warsaw9bf16442001-01-23 16:24:35 +0000340/* For debugging convenience. See Misc/gdbinit for some useful gdb hooks */
Guido van Rossum38938152006-08-21 23:36:26 +0000341void
342_PyObject_Dump(PyObject* op)
Barry Warsaw9bf16442001-01-23 16:24:35 +0000343{
Barry Warsaweefb1072001-02-22 22:39:18 +0000344 if (op == NULL)
345 fprintf(stderr, "NULL\n");
346 else {
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +0000347 PyGILState_STATE gil;
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000348 fprintf(stderr, "object : ");
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +0000349 gil = PyGILState_Ensure();
Barry Warsaweefb1072001-02-22 22:39:18 +0000350 (void)PyObject_Print(op, stderr, 0);
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +0000351 PyGILState_Release(gil);
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000352 /* XXX(twouters) cast refcount to long until %zd is
353 universally available */
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000354 fprintf(stderr, "\n"
355 "type : %s\n"
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000356 "refcount: %ld\n"
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000357 "address : %p\n",
Christian Heimes90aa7642007-12-19 02:45:37 +0000358 Py_TYPE(op)==NULL ? "NULL" : Py_TYPE(op)->tp_name,
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000359 (long)op->ob_refcnt,
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000360 op);
Barry Warsaweefb1072001-02-22 22:39:18 +0000361 }
Barry Warsaw9bf16442001-01-23 16:24:35 +0000362}
Barry Warsaw903138f2001-01-23 16:33:18 +0000363
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000364PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000365PyObject_Repr(PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000366{
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000367 PyObject *res;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000368 if (PyErr_CheckSignals())
Guido van Rossum90933611991-06-07 16:10:43 +0000369 return NULL;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000370#ifdef USE_STACKCHECK
371 if (PyOS_CheckStack()) {
Fred Drake661ea262000-10-24 19:57:45 +0000372 PyErr_SetString(PyExc_MemoryError, "stack overflow");
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000373 return NULL;
374 }
375#endif
Guido van Rossum90933611991-06-07 16:10:43 +0000376 if (v == NULL)
Walter Dörwald1ab83302007-05-18 17:15:44 +0000377 return PyUnicode_FromString("<NULL>");
Christian Heimes90aa7642007-12-19 02:45:37 +0000378 if (Py_TYPE(v)->tp_repr == NULL)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000379 return PyUnicode_FromFormat("<%s object at %p>",
380 v->ob_type->tp_name, v);
381 res = (*v->ob_type->tp_repr)(v);
382 if (res != NULL && !PyUnicode_Check(res)) {
383 PyErr_Format(PyExc_TypeError,
384 "__repr__ returned non-string (type %.200s)",
385 res->ob_type->tp_name);
386 Py_DECREF(res);
387 return NULL;
388 }
389 return res;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000390}
391
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000392PyObject *
Guido van Rossum98297ee2007-11-06 21:34:58 +0000393PyObject_Str(PyObject *v)
Guido van Rossumc6004111993-11-05 10:22:19 +0000394{
Guido van Rossum4c08d552000-03-10 22:55:18 +0000395 PyObject *res;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000396 if (PyErr_CheckSignals())
397 return NULL;
398#ifdef USE_STACKCHECK
399 if (PyOS_CheckStack()) {
400 PyErr_SetString(PyExc_MemoryError, "stack overflow");
401 return NULL;
402 }
403#endif
Guido van Rossumc6004111993-11-05 10:22:19 +0000404 if (v == NULL)
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000405 return PyUnicode_FromString("<NULL>");
Neil Schemenauercf52c072005-08-12 17:34:58 +0000406 if (PyUnicode_CheckExact(v)) {
407 Py_INCREF(v);
408 return v;
409 }
Christian Heimes90aa7642007-12-19 02:45:37 +0000410 if (Py_TYPE(v)->tp_str == NULL)
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000411 return PyObject_Repr(v);
412
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000413 /* It is possible for a type to have a tp_str representation that loops
414 infinitely. */
415 if (Py_EnterRecursiveCall(" while getting the str of an object"))
416 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +0000417 res = (*Py_TYPE(v)->tp_str)(v);
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000418 Py_LeaveRecursiveCall();
Guido van Rossum4c08d552000-03-10 22:55:18 +0000419 if (res == NULL)
420 return NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000421 if (!PyUnicode_Check(res)) {
Neil Schemenauercf52c072005-08-12 17:34:58 +0000422 PyErr_Format(PyExc_TypeError,
423 "__str__ returned non-string (type %.200s)",
Christian Heimes90aa7642007-12-19 02:45:37 +0000424 Py_TYPE(res)->tp_name);
Neil Schemenauercf52c072005-08-12 17:34:58 +0000425 Py_DECREF(res);
426 return NULL;
427 }
428 return res;
429}
430
Georg Brandl559e5d72008-06-11 18:37:52 +0000431PyObject *
432PyObject_ASCII(PyObject *v)
433{
434 PyObject *repr, *ascii, *res;
435
436 repr = PyObject_Repr(v);
437 if (repr == NULL)
438 return NULL;
439
440 /* repr is guaranteed to be a PyUnicode object by PyObject_Repr */
441 ascii = PyUnicode_EncodeASCII(
442 PyUnicode_AS_UNICODE(repr),
443 PyUnicode_GET_SIZE(repr),
444 "backslashreplace");
445
446 Py_DECREF(repr);
447 if (ascii == NULL)
448 return NULL;
449
450 res = PyUnicode_DecodeASCII(
451 PyBytes_AS_STRING(ascii),
452 PyBytes_GET_SIZE(ascii),
453 NULL);
454
455 Py_DECREF(ascii);
456 return res;
457}
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000458
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000459PyObject *
460PyObject_Bytes(PyObject *v)
461{
Christian Heimesff869fa2008-08-28 11:28:26 +0000462 PyObject *result, *func;
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000463 static PyObject *bytesstring = NULL;
464
465 if (bytesstring == NULL) {
466 bytesstring = PyUnicode_InternFromString("__bytes__");
467 if (bytesstring == NULL)
468 return NULL;
469 }
470
471 if (v == NULL)
472 return PyBytes_FromString("<NULL>");
473
474 if (PyBytes_CheckExact(v)) {
475 Py_INCREF(v);
476 return v;
477 }
478
479 /* Doesn't create a reference */
480 func = _PyType_Lookup(Py_TYPE(v), bytesstring);
481 if (func != NULL) {
482 result = PyObject_CallFunctionObjArgs(func, v, NULL);
483 if (result == NULL)
484 return NULL;
485 if (!PyBytes_Check(result)) {
486 PyErr_Format(PyExc_TypeError,
487 "__bytes__ returned non-bytes (type %.200s)",
488 Py_TYPE(result)->tp_name);
489 Py_DECREF(result);
490 return NULL;
491 }
492 return result;
493 }
494 PyErr_Clear();
495 return PyBytes_FromObject(v);
496}
497
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000498/* The new comparison philosophy is: we completely separate three-way
499 comparison from rich comparison. That is, PyObject_Compare() and
500 PyObject_Cmp() *just* use the tp_compare slot. And PyObject_RichCompare()
501 and PyObject_RichCompareBool() *just* use the tp_richcompare slot.
Guido van Rossum98297ee2007-11-06 21:34:58 +0000502
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000503 See (*) below for practical amendments.
504
505 IOW, only cmp() uses tp_compare; the comparison operators (==, !=, <=, <,
506 >=, >) only use tp_richcompare. Note that list.sort() only uses <.
507
508 (And yes, eventually we'll rip out cmp() and tp_compare.)
509
510 The calling conventions are different: tp_compare only gets called with two
511 objects of the appropriate type; tp_richcompare gets called with a first
512 argument of the appropriate type and a second object of an arbitrary type.
513 We never do any kind of coercion.
514
515 The return conventions are also different.
516
517 The tp_compare slot should return a C int, as follows:
518
519 -1 if a < b or if an exception occurred
520 0 if a == b
521 +1 if a > b
522
523 No other return values are allowed. PyObject_Compare() has the same
524 calling convention.
525
526 The tp_richcompare slot should return an object, as follows:
527
528 NULL if an exception occurred
529 NotImplemented if the requested comparison is not implemented
530 any other false value if the requested comparison is false
531 any other true value if the requested comparison is true
532
533 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
534 NotImplemented.
535
536 (*) Practical amendments:
537
538 - If rich comparison returns NotImplemented, == and != are decided by
539 comparing the object pointer (i.e. falling back to the base object
540 implementation).
541
542 - If three-way comparison is not implemented, it falls back on rich
543 comparison (but not the other way around!).
544
Guido van Rossuma4073002002-05-31 20:03:54 +0000545*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000546
547/* Forward */
548static PyObject *do_richcompare(PyObject *v, PyObject *w, int op);
549
550/* Perform a three-way comparison, raising TypeError if three-way comparison
551 is not supported. */
Guido van Rossuma4073002002-05-31 20:03:54 +0000552static int
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000553do_compare(PyObject *v, PyObject *w)
Guido van Rossuma4073002002-05-31 20:03:54 +0000554{
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000555 cmpfunc f;
556 int ok;
557
Guido van Rossum98297ee2007-11-06 21:34:58 +0000558 if (v->ob_type == w->ob_type &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000559 (f = v->ob_type->tp_compare) != NULL) {
560 return (*f)(v, w);
Guido van Rossuma4073002002-05-31 20:03:54 +0000561 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000562
563 /* Now try three-way compare before giving up. This is intentionally
564 elaborate; if you have a it will raise TypeError if it detects two
565 objects that aren't ordered with respect to each other. */
566 ok = PyObject_RichCompareBool(v, w, Py_LT);
567 if (ok < 0)
568 return -1; /* Error */
569 if (ok)
570 return -1; /* Less than */
571 ok = PyObject_RichCompareBool(v, w, Py_GT);
572 if (ok < 0)
573 return -1; /* Error */
574 if (ok)
575 return 1; /* Greater than */
576 ok = PyObject_RichCompareBool(v, w, Py_EQ);
577 if (ok < 0)
578 return -1; /* Error */
579 if (ok)
580 return 0; /* Equal */
581
582 /* Give up */
583 PyErr_Format(PyExc_TypeError,
Neal Norwitz3bd844e2006-08-29 04:39:12 +0000584 "unorderable types: '%.100s' != '%.100s'",
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000585 v->ob_type->tp_name,
586 w->ob_type->tp_name);
587 return -1;
Guido van Rossuma4073002002-05-31 20:03:54 +0000588}
589
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000590/* Perform a three-way comparison. This wraps do_compare() with a check for
591 NULL arguments and a recursion check. */
592int
593PyObject_Compare(PyObject *v, PyObject *w)
594{
595 int res;
Guido van Rossuma4073002002-05-31 20:03:54 +0000596
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000597 if (v == NULL || w == NULL) {
598 if (!PyErr_Occurred())
599 PyErr_BadInternalCall();
600 return -1;
601 }
602 if (Py_EnterRecursiveCall(" in cmp"))
603 return -1;
604 res = do_compare(v, w);
605 Py_LeaveRecursiveCall();
606 return res < 0 ? -1 : res;
607}
Guido van Rossumd1f06b92001-01-24 22:14:43 +0000608
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000609/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000610int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000611
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000612static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000613
614/* Perform a rich comparison, raising TypeError when the requested comparison
615 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000616static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000617do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000618{
619 richcmpfunc f;
620 PyObject *res;
621
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000622 if (v->ob_type != w->ob_type &&
623 PyType_IsSubtype(w->ob_type, v->ob_type) &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000624 (f = w->ob_type->tp_richcompare) != NULL) {
Tim Petersf4aca752004-09-23 02:39:37 +0000625 res = (*f)(w, v, _Py_SwappedOp[op]);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000626 if (res != Py_NotImplemented)
627 return res;
628 Py_DECREF(res);
629 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000630 if ((f = v->ob_type->tp_richcompare) != NULL) {
Guido van Rossume797ec12001-01-17 15:24:28 +0000631 res = (*f)(v, w, op);
632 if (res != Py_NotImplemented)
633 return res;
634 Py_DECREF(res);
635 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000636 if ((f = w->ob_type->tp_richcompare) != NULL) {
637 res = (*f)(w, v, _Py_SwappedOp[op]);
638 if (res != Py_NotImplemented)
639 return res;
640 Py_DECREF(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000641 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000642 /* If neither object implements it, provide a sensible default
643 for == and !=, but raise an exception for ordering. */
644 switch (op) {
645 case Py_EQ:
646 res = (v == w) ? Py_True : Py_False;
647 break;
648 case Py_NE:
649 res = (v != w) ? Py_True : Py_False;
650 break;
651 default:
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000652 /* XXX Special-case None so it doesn't show as NoneType() */
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000653 PyErr_Format(PyExc_TypeError,
654 "unorderable types: %.100s() %s %.100s()",
655 v->ob_type->tp_name,
656 opstrings[op],
657 w->ob_type->tp_name);
658 return NULL;
659 }
Guido van Rossume797ec12001-01-17 15:24:28 +0000660 Py_INCREF(res);
661 return res;
662}
663
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000664/* Perform a rich comparison with object result. This wraps do_richcompare()
665 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000666
Guido van Rossume797ec12001-01-17 15:24:28 +0000667PyObject *
668PyObject_RichCompare(PyObject *v, PyObject *w, int op)
669{
670 PyObject *res;
671
672 assert(Py_LT <= op && op <= Py_GE);
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000673 if (v == NULL || w == NULL) {
674 if (!PyErr_Occurred())
675 PyErr_BadInternalCall();
676 return NULL;
677 }
Armin Rigo2b3eb402003-10-28 12:05:48 +0000678 if (Py_EnterRecursiveCall(" in cmp"))
679 return NULL;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000680 res = do_richcompare(v, w, op);
Armin Rigo2b3eb402003-10-28 12:05:48 +0000681 Py_LeaveRecursiveCall();
Guido van Rossume797ec12001-01-17 15:24:28 +0000682 return res;
683}
684
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000685/* Perform a rich comparison with integer result. This wraps
686 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000687int
688PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
689{
Raymond Hettinger93d44812004-03-21 17:01:44 +0000690 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000691 int ok;
692
Mark Dickinson4a1f5932008-11-12 23:23:36 +0000693 /* Quick result when objects are the same.
694 Guarantees that identity implies equality. */
695 if (v == w) {
696 if (op == Py_EQ)
697 return 1;
698 else if (op == Py_NE)
699 return 0;
700 }
701
Raymond Hettinger93d44812004-03-21 17:01:44 +0000702 res = PyObject_RichCompare(v, w, op);
Guido van Rossume797ec12001-01-17 15:24:28 +0000703 if (res == NULL)
704 return -1;
Guido van Rossum81912d42002-08-24 05:33:28 +0000705 if (PyBool_Check(res))
706 ok = (res == Py_True);
707 else
708 ok = PyObject_IsTrue(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000709 Py_DECREF(res);
710 return ok;
711}
Fred Drake13634cf2000-06-29 19:17:04 +0000712
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000713/* Turn the result of a three-way comparison into the result expected by a
714 rich comparison. */
715PyObject *
716Py_CmpToRich(int op, int cmp)
717{
718 PyObject *res;
719 int ok;
720
721 if (PyErr_Occurred())
722 return NULL;
723 switch (op) {
724 case Py_LT:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000725 ok = cmp < 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000726 break;
727 case Py_LE:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000728 ok = cmp <= 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000729 break;
730 case Py_EQ:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000731 ok = cmp == 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000732 break;
733 case Py_NE:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000734 ok = cmp != 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000735 break;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000736 case Py_GT:
737 ok = cmp > 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000738 break;
739 case Py_GE:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000740 ok = cmp >= 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000741 break;
742 default:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000743 PyErr_BadArgument();
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000744 return NULL;
745 }
746 res = ok ? Py_True : Py_False;
747 Py_INCREF(res);
748 return res;
749}
750
Fred Drake13634cf2000-06-29 19:17:04 +0000751/* Set of hash utility functions to help maintaining the invariant that
Raymond Hettinger8183fa42004-03-21 17:35:06 +0000752 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000753
754 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
755*/
756
757long
Fred Drake100814d2000-07-09 15:48:49 +0000758_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000759{
Tim Peters39dce292000-08-15 03:34:48 +0000760 double intpart, fractpart;
761 int expo;
762 long hipart;
763 long x; /* the final hash value */
764 /* This is designed so that Python numbers of different types
765 * that compare equal hash to the same value; otherwise comparisons
766 * of mapping keys will turn out weird.
767 */
768
Tim Peters39dce292000-08-15 03:34:48 +0000769 fractpart = modf(v, &intpart);
Tim Peters39dce292000-08-15 03:34:48 +0000770 if (fractpart == 0.0) {
771 /* This must return the same hash as an equal int or long. */
772 if (intpart > LONG_MAX || -intpart > LONG_MAX) {
773 /* Convert to long and use its hash. */
774 PyObject *plong; /* converted to Python long */
775 if (Py_IS_INFINITY(intpart))
776 /* can't convert to long int -- arbitrary */
777 v = v < 0 ? -271828.0 : 314159.0;
778 plong = PyLong_FromDouble(v);
779 if (plong == NULL)
780 return -1;
781 x = PyObject_Hash(plong);
782 Py_DECREF(plong);
783 return x;
784 }
785 /* Fits in a C long == a Python int, so is its own hash. */
786 x = (long)intpart;
787 if (x == -1)
788 x = -2;
789 return x;
790 }
791 /* The fractional part is non-zero, so we don't have to worry about
792 * making this match the hash of some other type.
793 * Use frexp to get at the bits in the double.
Fred Drake13634cf2000-06-29 19:17:04 +0000794 * Since the VAX D double format has 56 mantissa bits, which is the
795 * most of any double format in use, each of these parts may have as
796 * many as (but no more than) 56 significant bits.
Tim Peters39dce292000-08-15 03:34:48 +0000797 * So, assuming sizeof(long) >= 4, each part can be broken into two
798 * longs; frexp and multiplication are used to do that.
799 * Also, since the Cray double format has 15 exponent bits, which is
800 * the most of any double format in use, shifting the exponent field
801 * left by 15 won't overflow a long (again assuming sizeof(long) >= 4).
Fred Drake13634cf2000-06-29 19:17:04 +0000802 */
Tim Peters39dce292000-08-15 03:34:48 +0000803 v = frexp(v, &expo);
804 v *= 2147483648.0; /* 2**31 */
805 hipart = (long)v; /* take the top 32 bits */
806 v = (v - (double)hipart) * 2147483648.0; /* get the next 32 bits */
807 x = hipart + (long)v + (expo << 15);
808 if (x == -1)
809 x = -2;
810 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000811}
812
813long
Fred Drake100814d2000-07-09 15:48:49 +0000814_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000815{
816#if SIZEOF_LONG >= SIZEOF_VOID_P
817 return (long)p;
818#else
819 /* convert to a Python long and hash that */
820 PyObject* longobj;
821 long x;
Tim Peters803526b2002-07-07 05:13:56 +0000822
Fred Drake13634cf2000-06-29 19:17:04 +0000823 if ((longobj = PyLong_FromVoidPtr(p)) == NULL) {
824 x = -1;
825 goto finally;
826 }
827 x = PyObject_Hash(longobj);
Tim Peters803526b2002-07-07 05:13:56 +0000828
Fred Drake13634cf2000-06-29 19:17:04 +0000829finally:
830 Py_XDECREF(longobj);
831 return x;
832#endif
833}
834
Nick Coghland1abd252008-07-15 15:46:38 +0000835long
836PyObject_HashNotImplemented(PyObject *v)
837{
838 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
839 Py_TYPE(v)->tp_name);
840 return -1;
841}
Fred Drake13634cf2000-06-29 19:17:04 +0000842
Guido van Rossum9bfef441993-03-29 10:43:31 +0000843long
Fred Drake100814d2000-07-09 15:48:49 +0000844PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000845{
Nick Coghland1abd252008-07-15 15:46:38 +0000846 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000847 if (tp->tp_hash != NULL)
848 return (*tp->tp_hash)(v);
Nick Coghlanf1f2f682008-12-30 07:29:12 +0000849 /* To keep to the general practice that inheriting
850 * solely from object in C code should work without
851 * an explicit call to PyType_Ready, we implicitly call
852 * PyType_Ready here and then check the tp_hash slot again
853 */
854 if (tp->tp_dict == NULL) {
855 if (PyType_Ready(tp) < 0)
856 return -1;
857 if (tp->tp_hash != NULL)
858 return (*tp->tp_hash)(v);
859 }
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000860 /* Otherwise, the object can't be hashed */
Nick Coghland1abd252008-07-15 15:46:38 +0000861 return PyObject_HashNotImplemented(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000862}
863
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000864PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000865PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000866{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000867 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000868
Christian Heimes90aa7642007-12-19 02:45:37 +0000869 if (Py_TYPE(v)->tp_getattr != NULL)
870 return (*Py_TYPE(v)->tp_getattr)(v, (char*)name);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000871 w = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000872 if (w == NULL)
873 return NULL;
874 res = PyObject_GetAttr(v, w);
875 Py_XDECREF(w);
876 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000877}
878
879int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000880PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000881{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000882 PyObject *res = PyObject_GetAttrString(v, name);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000883 if (res != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000884 Py_DECREF(res);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000885 return 1;
886 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000887 PyErr_Clear();
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000888 return 0;
889}
890
891int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000892PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000893{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000894 PyObject *s;
895 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000896
Christian Heimes90aa7642007-12-19 02:45:37 +0000897 if (Py_TYPE(v)->tp_setattr != NULL)
898 return (*Py_TYPE(v)->tp_setattr)(v, (char*)name, w);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000899 s = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000900 if (s == NULL)
901 return -1;
902 res = PyObject_SetAttr(v, s, w);
903 Py_XDECREF(s);
904 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000905}
906
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000907PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000908PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000909{
Christian Heimes90aa7642007-12-19 02:45:37 +0000910 PyTypeObject *tp = Py_TYPE(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000911
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000912 if (!PyUnicode_Check(name)) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000913 PyErr_Format(PyExc_TypeError,
914 "attribute name must be string, not '%.200s'",
915 name->ob_type->tp_name);
916 return NULL;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000917 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000918 if (tp->tp_getattro != NULL)
919 return (*tp->tp_getattro)(v, name);
920 if (tp->tp_getattr != NULL)
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000921 return (*tp->tp_getattr)(v, _PyUnicode_AsString(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +0000922 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000923 "'%.50s' object has no attribute '%U'",
924 tp->tp_name, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000925 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000926}
927
928int
Fred Drake100814d2000-07-09 15:48:49 +0000929PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000930{
931 PyObject *res = PyObject_GetAttr(v, name);
932 if (res != NULL) {
933 Py_DECREF(res);
934 return 1;
935 }
936 PyErr_Clear();
937 return 0;
938}
939
940int
Fred Drake100814d2000-07-09 15:48:49 +0000941PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000942{
Christian Heimes90aa7642007-12-19 02:45:37 +0000943 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000944 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000945
Martin v. Löwis5b222132007-06-10 09:51:05 +0000946 if (!PyUnicode_Check(name)) {
947 PyErr_Format(PyExc_TypeError,
948 "attribute name must be string, not '%.200s'",
949 name->ob_type->tp_name);
950 return -1;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000951 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000952 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000953
Martin v. Löwis5b222132007-06-10 09:51:05 +0000954 PyUnicode_InternInPlace(&name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000955 if (tp->tp_setattro != NULL) {
956 err = (*tp->tp_setattro)(v, name, value);
957 Py_DECREF(name);
958 return err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000959 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000960 if (tp->tp_setattr != NULL) {
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000961 err = (*tp->tp_setattr)(v, _PyUnicode_AsString(name), value);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000962 Py_DECREF(name);
963 return err;
964 }
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000965 Py_DECREF(name);
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000966 assert(name->ob_refcnt >= 1);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000967 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
968 PyErr_Format(PyExc_TypeError,
969 "'%.100s' object has no attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000970 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000971 tp->tp_name,
972 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000973 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000974 else
975 PyErr_Format(PyExc_TypeError,
976 "'%.100s' object has only read-only attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000977 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000978 tp->tp_name,
979 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000980 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000981 return -1;
982}
983
984/* Helper to get a pointer to an object's __dict__ slot, if any */
985
986PyObject **
987_PyObject_GetDictPtr(PyObject *obj)
988{
Martin v. Löwis725507b2006-03-07 12:08:51 +0000989 Py_ssize_t dictoffset;
Christian Heimes90aa7642007-12-19 02:45:37 +0000990 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000991
Tim Peters6d6c1a32001-08-02 04:15:00 +0000992 dictoffset = tp->tp_dictoffset;
993 if (dictoffset == 0)
994 return NULL;
995 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000996 Py_ssize_t tsize;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000997 size_t size;
998
999 tsize = ((PyVarObject *)obj)->ob_size;
1000 if (tsize < 0)
1001 tsize = -tsize;
1002 size = _PyObject_VAR_SIZE(tp, tsize);
1003
Tim Peters6d483d32001-10-06 21:27:34 +00001004 dictoffset += (long)size;
1005 assert(dictoffset > 0);
1006 assert(dictoffset % SIZEOF_VOID_P == 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001007 }
1008 return (PyObject **) ((char *)obj + dictoffset);
1009}
1010
Tim Peters6d6c1a32001-08-02 04:15:00 +00001011PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +00001012PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +00001013{
1014 Py_INCREF(obj);
1015 return obj;
1016}
1017
Michael W. Hudson1593f502004-09-14 17:09:47 +00001018/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
1019
Raymond Hettinger01538262003-03-17 08:24:35 +00001020PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001021PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
1022{
Christian Heimes90aa7642007-12-19 02:45:37 +00001023 PyTypeObject *tp = Py_TYPE(obj);
Guido van Rossum056fbf42002-08-19 19:22:50 +00001024 PyObject *descr = NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001025 PyObject *res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001026 descrgetfunc f;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001027 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001028 PyObject **dictptr;
1029
Martin v. Löwis5b222132007-06-10 09:51:05 +00001030 if (!PyUnicode_Check(name)){
1031 PyErr_Format(PyExc_TypeError,
1032 "attribute name must be string, not '%.200s'",
1033 name->ob_type->tp_name);
1034 return NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001035 }
1036 else
1037 Py_INCREF(name);
1038
Tim Peters6d6c1a32001-08-02 04:15:00 +00001039 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001040 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001041 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001042 }
1043
Christian Heimesa62da1d2008-01-12 19:39:10 +00001044#if 0 /* XXX this is not quite _PyType_Lookup anymore */
Guido van Rossum056fbf42002-08-19 19:22:50 +00001045 /* Inline _PyType_Lookup */
1046 {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001047 Py_ssize_t i, n;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001048 PyObject *mro, *base, *dict;
1049
1050 /* Look in tp_dict of types in MRO */
1051 mro = tp->tp_mro;
1052 assert(mro != NULL);
1053 assert(PyTuple_Check(mro));
1054 n = PyTuple_GET_SIZE(mro);
1055 for (i = 0; i < n; i++) {
1056 base = PyTuple_GET_ITEM(mro, i);
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001057 assert(PyType_Check(base));
1058 dict = ((PyTypeObject *)base)->tp_dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001059 assert(dict && PyDict_Check(dict));
1060 descr = PyDict_GetItem(dict, name);
1061 if (descr != NULL)
1062 break;
1063 }
1064 }
Christian Heimesa62da1d2008-01-12 19:39:10 +00001065#else
1066 descr = _PyType_Lookup(tp, name);
1067#endif
Guido van Rossum056fbf42002-08-19 19:22:50 +00001068
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001069 Py_XINCREF(descr);
1070
Tim Peters6d6c1a32001-08-02 04:15:00 +00001071 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001072 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001073 f = descr->ob_type->tp_descr_get;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001074 if (f != NULL && PyDescr_IsData(descr)) {
1075 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001076 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001077 goto done;
1078 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001079 }
1080
Guido van Rossumc66ff442002-08-19 16:50:48 +00001081 /* Inline _PyObject_GetDictPtr */
1082 dictoffset = tp->tp_dictoffset;
1083 if (dictoffset != 0) {
1084 PyObject *dict;
1085 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001086 Py_ssize_t tsize;
Guido van Rossumc66ff442002-08-19 16:50:48 +00001087 size_t size;
1088
1089 tsize = ((PyVarObject *)obj)->ob_size;
1090 if (tsize < 0)
1091 tsize = -tsize;
1092 size = _PyObject_VAR_SIZE(tp, tsize);
1093
1094 dictoffset += (long)size;
1095 assert(dictoffset > 0);
1096 assert(dictoffset % SIZEOF_VOID_P == 0);
1097 }
1098 dictptr = (PyObject **) ((char *)obj + dictoffset);
1099 dict = *dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001100 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +00001101 Py_INCREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001102 res = PyDict_GetItem(dict, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001103 if (res != NULL) {
1104 Py_INCREF(res);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001105 Py_XDECREF(descr);
Christian Heimes969fe572008-01-25 11:23:10 +00001106 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001107 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001108 }
Christian Heimes969fe572008-01-25 11:23:10 +00001109 Py_DECREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001110 }
1111 }
1112
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001113 if (f != NULL) {
Christian Heimes90aa7642007-12-19 02:45:37 +00001114 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001115 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001116 goto done;
1117 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001118
1119 if (descr != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001120 res = descr;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001121 /* descr was already increfed above */
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001122 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001123 }
1124
1125 PyErr_Format(PyExc_AttributeError,
1126 "'%.50s' object has no attribute '%.400s'",
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +00001127 tp->tp_name, _PyUnicode_AsString(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001128 done:
1129 Py_DECREF(name);
1130 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001131}
1132
1133int
1134PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1135{
Christian Heimes90aa7642007-12-19 02:45:37 +00001136 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001137 PyObject *descr;
1138 descrsetfunc f;
1139 PyObject **dictptr;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001140 int res = -1;
1141
Martin v. Löwis5b222132007-06-10 09:51:05 +00001142 if (!PyUnicode_Check(name)){
1143 PyErr_Format(PyExc_TypeError,
1144 "attribute name must be string, not '%.200s'",
1145 name->ob_type->tp_name);
1146 return -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001147 }
1148 else
1149 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001150
1151 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001152 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001153 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001154 }
1155
1156 descr = _PyType_Lookup(tp, name);
1157 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001158 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001159 f = descr->ob_type->tp_descr_set;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001160 if (f != NULL && PyDescr_IsData(descr)) {
1161 res = f(descr, obj, value);
1162 goto done;
1163 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001164 }
1165
1166 dictptr = _PyObject_GetDictPtr(obj);
1167 if (dictptr != NULL) {
1168 PyObject *dict = *dictptr;
1169 if (dict == NULL && value != NULL) {
1170 dict = PyDict_New();
1171 if (dict == NULL)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001172 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001173 *dictptr = dict;
1174 }
1175 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +00001176 Py_INCREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001177 if (value == NULL)
1178 res = PyDict_DelItem(dict, name);
1179 else
1180 res = PyDict_SetItem(dict, name, value);
1181 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1182 PyErr_SetObject(PyExc_AttributeError, name);
Christian Heimes969fe572008-01-25 11:23:10 +00001183 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001184 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001185 }
1186 }
1187
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001188 if (f != NULL) {
1189 res = f(descr, obj, value);
1190 goto done;
1191 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001192
1193 if (descr == NULL) {
1194 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001195 "'%.100s' object has no attribute '%U'",
1196 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001197 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001198 }
1199
1200 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001201 "'%.50s' object attribute '%U' is read-only",
1202 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001203 done:
1204 Py_DECREF(name);
1205 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001206}
1207
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001208/* Test a value used as condition, e.g., in a for or if statement.
1209 Return -1 if an error occurred */
1210
1211int
Fred Drake100814d2000-07-09 15:48:49 +00001212PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001213{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001214 Py_ssize_t res;
Guido van Rossum6248f442002-08-24 06:31:34 +00001215 if (v == Py_True)
1216 return 1;
1217 if (v == Py_False)
1218 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001219 if (v == Py_None)
Neal Norwitz51290d32002-06-13 21:32:44 +00001220 return 0;
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001221 else if (v->ob_type->tp_as_number != NULL &&
Jack Diederich4dafcc42006-11-28 19:15:13 +00001222 v->ob_type->tp_as_number->nb_bool != NULL)
1223 res = (*v->ob_type->tp_as_number->nb_bool)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001224 else if (v->ob_type->tp_as_mapping != NULL &&
1225 v->ob_type->tp_as_mapping->mp_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001226 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001227 else if (v->ob_type->tp_as_sequence != NULL &&
1228 v->ob_type->tp_as_sequence->sq_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001229 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1230 else
Neal Norwitz51290d32002-06-13 21:32:44 +00001231 return 1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001232 /* if it is negative, it should be either -1 or -2 */
1233 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001234}
1235
Tim Peters803526b2002-07-07 05:13:56 +00001236/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001237 Return -1 if an error occurred */
1238
1239int
Fred Drake100814d2000-07-09 15:48:49 +00001240PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001241{
1242 int res;
1243 res = PyObject_IsTrue(v);
1244 if (res < 0)
1245 return res;
1246 return res == 0;
1247}
1248
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001249/* Test whether an object can be called */
1250
1251int
Fred Drake100814d2000-07-09 15:48:49 +00001252PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001253{
1254 if (x == NULL)
1255 return 0;
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001256 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001257}
1258
Georg Brandle32b4222007-03-10 22:13:27 +00001259/* ------------------------- PyObject_Dir() helpers ------------------------- */
1260
Tim Peters7eea37e2001-09-04 22:08:56 +00001261/* Helper for PyObject_Dir.
1262 Merge the __dict__ of aclass into dict, and recursively also all
1263 the __dict__s of aclass's base classes. The order of merging isn't
1264 defined, as it's expected that only the final set of dict keys is
1265 interesting.
1266 Return 0 on success, -1 on error.
1267*/
1268
1269static int
1270merge_class_dict(PyObject* dict, PyObject* aclass)
1271{
1272 PyObject *classdict;
1273 PyObject *bases;
1274
1275 assert(PyDict_Check(dict));
1276 assert(aclass);
1277
1278 /* Merge in the type's dict (if any). */
1279 classdict = PyObject_GetAttrString(aclass, "__dict__");
1280 if (classdict == NULL)
1281 PyErr_Clear();
1282 else {
1283 int status = PyDict_Update(dict, classdict);
1284 Py_DECREF(classdict);
1285 if (status < 0)
1286 return -1;
1287 }
1288
1289 /* Recursively merge in the base types' (if any) dicts. */
1290 bases = PyObject_GetAttrString(aclass, "__bases__");
Tim Petersbc7e8632001-09-16 20:33:22 +00001291 if (bases == NULL)
1292 PyErr_Clear();
1293 else {
Guido van Rossum44022412002-05-13 18:29:46 +00001294 /* We have no guarantee that bases is a real tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001295 Py_ssize_t i, n;
Guido van Rossum44022412002-05-13 18:29:46 +00001296 n = PySequence_Size(bases); /* This better be right */
1297 if (n < 0)
1298 PyErr_Clear();
1299 else {
1300 for (i = 0; i < n; i++) {
Tim Peters18e70832003-02-05 19:35:19 +00001301 int status;
Guido van Rossum44022412002-05-13 18:29:46 +00001302 PyObject *base = PySequence_GetItem(bases, i);
1303 if (base == NULL) {
1304 Py_DECREF(bases);
1305 return -1;
1306 }
Tim Peters18e70832003-02-05 19:35:19 +00001307 status = merge_class_dict(dict, base);
1308 Py_DECREF(base);
1309 if (status < 0) {
Guido van Rossum44022412002-05-13 18:29:46 +00001310 Py_DECREF(bases);
1311 return -1;
1312 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001313 }
1314 }
1315 Py_DECREF(bases);
1316 }
1317 return 0;
1318}
1319
Georg Brandle32b4222007-03-10 22:13:27 +00001320/* Helper for PyObject_Dir without arguments: returns the local scope. */
1321static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001322_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001323{
Georg Brandled3b8382007-03-12 13:15:14 +00001324 PyObject *names;
Georg Brandle32b4222007-03-10 22:13:27 +00001325 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001326
Georg Brandle32b4222007-03-10 22:13:27 +00001327 if (locals == NULL) {
1328 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1329 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001330 }
1331
Georg Brandled3b8382007-03-12 13:15:14 +00001332 names = PyMapping_Keys(locals);
1333 if (!names)
1334 return NULL;
1335 if (!PyList_Check(names)) {
1336 PyErr_Format(PyExc_TypeError,
1337 "dir(): expected keys() of locals to be a list, "
Christian Heimes90aa7642007-12-19 02:45:37 +00001338 "not '%.200s'", Py_TYPE(names)->tp_name);
Georg Brandled3b8382007-03-12 13:15:14 +00001339 Py_DECREF(names);
1340 return NULL;
1341 }
Georg Brandle32b4222007-03-10 22:13:27 +00001342 /* the locals don't need to be DECREF'd */
Georg Brandled3b8382007-03-12 13:15:14 +00001343 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001344}
1345
1346/* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
Guido van Rossum98297ee2007-11-06 21:34:58 +00001347 We deliberately don't suck up its __class__, as methods belonging to the
1348 metaclass would probably be more confusing than helpful.
Georg Brandle32b4222007-03-10 22:13:27 +00001349*/
Guido van Rossum98297ee2007-11-06 21:34:58 +00001350static PyObject *
Georg Brandle32b4222007-03-10 22:13:27 +00001351_specialized_dir_type(PyObject *obj)
1352{
1353 PyObject *result = NULL;
1354 PyObject *dict = PyDict_New();
1355
1356 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1357 result = PyDict_Keys(dict);
1358
1359 Py_XDECREF(dict);
Tim Peters305b5852001-09-17 02:38:46 +00001360 return result;
1361}
1362
Georg Brandle32b4222007-03-10 22:13:27 +00001363/* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1364static PyObject *
1365_specialized_dir_module(PyObject *obj)
Tim Peters7eea37e2001-09-04 22:08:56 +00001366{
Georg Brandle32b4222007-03-10 22:13:27 +00001367 PyObject *result = NULL;
1368 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
Tim Peters7eea37e2001-09-04 22:08:56 +00001369
Georg Brandle32b4222007-03-10 22:13:27 +00001370 if (dict != NULL) {
1371 if (PyDict_Check(dict))
1372 result = PyDict_Keys(dict);
1373 else {
1374 PyErr_Format(PyExc_TypeError,
1375 "%.200s.__dict__ is not a dictionary",
1376 PyModule_GetName(obj));
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001377 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001378 }
1379
Georg Brandle32b4222007-03-10 22:13:27 +00001380 Py_XDECREF(dict);
1381 return result;
1382}
Tim Peters7eea37e2001-09-04 22:08:56 +00001383
Georg Brandle32b4222007-03-10 22:13:27 +00001384/* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1385 and recursively up the __class__.__bases__ chain.
1386*/
1387static PyObject *
1388_generic_dir(PyObject *obj)
1389{
1390 PyObject *result = NULL;
1391 PyObject *dict = NULL;
1392 PyObject *itsclass = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001393
Georg Brandle32b4222007-03-10 22:13:27 +00001394 /* Get __dict__ (which may or may not be a real dict...) */
1395 dict = PyObject_GetAttrString(obj, "__dict__");
1396 if (dict == NULL) {
1397 PyErr_Clear();
1398 dict = PyDict_New();
1399 }
1400 else if (!PyDict_Check(dict)) {
1401 Py_DECREF(dict);
1402 dict = PyDict_New();
1403 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001404 else {
Georg Brandle32b4222007-03-10 22:13:27 +00001405 /* Copy __dict__ to avoid mutating it. */
1406 PyObject *temp = PyDict_Copy(dict);
1407 Py_DECREF(dict);
1408 dict = temp;
Tim Peters7eea37e2001-09-04 22:08:56 +00001409 }
1410
Georg Brandle32b4222007-03-10 22:13:27 +00001411 if (dict == NULL)
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001412 goto error;
Tim Peters7eea37e2001-09-04 22:08:56 +00001413
Georg Brandle32b4222007-03-10 22:13:27 +00001414 /* Merge in attrs reachable from its class. */
1415 itsclass = PyObject_GetAttrString(obj, "__class__");
1416 if (itsclass == NULL)
1417 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1418 __class__ exists? */
1419 PyErr_Clear();
1420 else {
1421 if (merge_class_dict(dict, itsclass) != 0)
1422 goto error;
1423 }
1424
1425 result = PyDict_Keys(dict);
Tim Peters7eea37e2001-09-04 22:08:56 +00001426 /* fall through */
Georg Brandle32b4222007-03-10 22:13:27 +00001427error:
1428 Py_XDECREF(itsclass);
1429 Py_XDECREF(dict);
1430 return result;
1431}
1432
1433/* Helper for PyObject_Dir: object introspection.
1434 This calls one of the above specialized versions if no __dir__ method
1435 exists. */
1436static PyObject *
1437_dir_object(PyObject *obj)
1438{
1439 PyObject * result = NULL;
1440 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1441 "__dir__");
1442
1443 assert(obj);
1444 if (dirfunc == NULL) {
1445 /* use default implementation */
1446 PyErr_Clear();
1447 if (PyModule_Check(obj))
1448 result = _specialized_dir_module(obj);
1449 else if (PyType_Check(obj))
1450 result = _specialized_dir_type(obj);
1451 else
1452 result = _generic_dir(obj);
1453 }
1454 else {
1455 /* use __dir__ */
1456 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1457 Py_DECREF(dirfunc);
1458 if (result == NULL)
1459 return NULL;
1460
1461 /* result must be a list */
1462 /* XXX(gbrandl): could also check if all items are strings */
1463 if (!PyList_Check(result)) {
1464 PyErr_Format(PyExc_TypeError,
1465 "__dir__() must return a list, not %.200s",
Christian Heimes90aa7642007-12-19 02:45:37 +00001466 Py_TYPE(result)->tp_name);
Georg Brandle32b4222007-03-10 22:13:27 +00001467 Py_DECREF(result);
1468 result = NULL;
1469 }
1470 }
1471
1472 return result;
1473}
1474
1475/* Implementation of dir() -- if obj is NULL, returns the names in the current
1476 (local) scope. Otherwise, performs introspection of the object: returns a
1477 sorted list of attribute names (supposedly) accessible from the object
1478*/
1479PyObject *
1480PyObject_Dir(PyObject *obj)
1481{
1482 PyObject * result;
1483
1484 if (obj == NULL)
1485 /* no object -- introspect the locals */
1486 result = _dir_locals();
1487 else
1488 /* object -- introspect the object */
1489 result = _dir_object(obj);
1490
1491 assert(result == NULL || PyList_Check(result));
1492
1493 if (result != NULL && PyList_Sort(result) != 0) {
1494 /* sorting the list failed */
1495 Py_DECREF(result);
1496 result = NULL;
1497 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001498
Tim Peters7eea37e2001-09-04 22:08:56 +00001499 return result;
1500}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001501
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001502/*
1503NoObject is usable as a non-NULL undefined value, used by the macro None.
1504There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001505so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001506(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001507*/
1508
Guido van Rossum0c182a11992-03-27 17:26:13 +00001509/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001510static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001511none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001512{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001513 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001514}
1515
Barry Warsaw9bf16442001-01-23 16:24:35 +00001516/* ARGUSED */
1517static void
Tim Peters803526b2002-07-07 05:13:56 +00001518none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001519{
1520 /* This should never get called, but we also don't want to SEGV if
1521 * we accidently decref None out of existance.
1522 */
Martin v. Löwis3f19b102002-08-07 16:21:51 +00001523 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001524}
1525
1526
Guido van Rossumba21a492001-08-16 08:17:26 +00001527static PyTypeObject PyNone_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001528 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001529 "NoneType",
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001530 0,
1531 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001532 none_dealloc, /*tp_dealloc*/ /*never called*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001533 0, /*tp_print*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001534 0, /*tp_getattr*/
1535 0, /*tp_setattr*/
1536 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001537 none_repr, /*tp_repr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001538 0, /*tp_as_number*/
1539 0, /*tp_as_sequence*/
1540 0, /*tp_as_mapping*/
Guido van Rossum9bfef441993-03-29 10:43:31 +00001541 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001542};
1543
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001544PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001545 _PyObject_EXTRA_INIT
1546 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001547};
1548
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001549/* NotImplemented is an object that can be used to signal that an
1550 operation is not implemented for the given type combination. */
1551
1552static PyObject *
1553NotImplemented_repr(PyObject *op)
1554{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001555 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001556}
1557
1558static PyTypeObject PyNotImplemented_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001559 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001560 "NotImplementedType",
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001561 0,
1562 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001563 none_dealloc, /*tp_dealloc*/ /*never called*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001564 0, /*tp_print*/
1565 0, /*tp_getattr*/
1566 0, /*tp_setattr*/
1567 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001568 NotImplemented_repr, /*tp_repr*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001569 0, /*tp_as_number*/
1570 0, /*tp_as_sequence*/
1571 0, /*tp_as_mapping*/
1572 0, /*tp_hash */
1573};
1574
1575PyObject _Py_NotImplementedStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001576 _PyObject_EXTRA_INIT
1577 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001578};
1579
Guido van Rossumba21a492001-08-16 08:17:26 +00001580void
1581_Py_ReadyTypes(void)
1582{
1583 if (PyType_Ready(&PyType_Type) < 0)
1584 Py_FatalError("Can't initialize 'type'");
1585
Fred Drake0a4dd392004-07-02 18:57:45 +00001586 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1587 Py_FatalError("Can't initialize 'weakref'");
1588
Guido van Rossum77f6a652002-04-03 22:41:51 +00001589 if (PyType_Ready(&PyBool_Type) < 0)
1590 Py_FatalError("Can't initialize 'bool'");
1591
Christian Heimes9c4756e2008-05-26 13:22:05 +00001592 if (PyType_Ready(&PyByteArray_Type) < 0)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001593 Py_FatalError("Can't initialize 'bytes'");
1594
Christian Heimes72b710a2008-05-26 13:28:38 +00001595 if (PyType_Ready(&PyBytes_Type) < 0)
Guido van Rossumcacfc072002-05-24 19:01:59 +00001596 Py_FatalError("Can't initialize 'str'");
1597
Guido van Rossumba21a492001-08-16 08:17:26 +00001598 if (PyType_Ready(&PyList_Type) < 0)
1599 Py_FatalError("Can't initialize 'list'");
1600
1601 if (PyType_Ready(&PyNone_Type) < 0)
1602 Py_FatalError("Can't initialize type(None)");
1603
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001604 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1605 Py_FatalError("Can't initialize type(Ellipsis)");
1606
Guido van Rossumba21a492001-08-16 08:17:26 +00001607 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1608 Py_FatalError("Can't initialize type(NotImplemented)");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001609
1610 if (PyType_Ready(&PyCode_Type) < 0)
1611 Py_FatalError("Can't initialize 'code'");
Guido van Rossum826d8972007-10-30 18:34:07 +00001612
1613 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1614 Py_FatalError("Can't initialize StdPrinter");
Guido van Rossumba21a492001-08-16 08:17:26 +00001615}
1616
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001617
Guido van Rossum84a90321996-05-22 16:34:47 +00001618#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001619
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001620void
Fred Drake100814d2000-07-09 15:48:49 +00001621_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001622{
Tim Peters34592512002-07-11 06:23:50 +00001623 _Py_INC_REFTOTAL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001624 op->ob_refcnt = 1;
Tim Peters7571a0f2003-03-23 17:52:28 +00001625 _Py_AddToAllObjects(op, 1);
Tim Peters34592512002-07-11 06:23:50 +00001626 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001627}
1628
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001629void
Fred Drake100814d2000-07-09 15:48:49 +00001630_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001631{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001632#ifdef SLOW_UNREF_CHECK
Guido van Rossum4c08d552000-03-10 22:55:18 +00001633 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001634#endif
Guido van Rossumd7047b31995-01-02 19:07:15 +00001635 if (op->ob_refcnt < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001636 Py_FatalError("UNREF negative refcnt");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001637 if (op == &refchain ||
Christian Heimesc8967002007-11-30 10:18:26 +00001638 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1639 fprintf(stderr, "* ob\n");
1640 _PyObject_Dump(op);
1641 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1642 _PyObject_Dump(op->_ob_prev->_ob_next);
1643 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1644 _PyObject_Dump(op->_ob_next->_ob_prev);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001645 Py_FatalError("UNREF invalid object");
Christian Heimesc8967002007-11-30 10:18:26 +00001646 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001647#ifdef SLOW_UNREF_CHECK
Guido van Rossum3f5da241990-12-20 15:06:42 +00001648 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1649 if (p == op)
1650 break;
1651 }
Guido van Rossumd7047b31995-01-02 19:07:15 +00001652 if (p == &refchain) /* Not found */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001653 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001654#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001655 op->_ob_next->_ob_prev = op->_ob_prev;
1656 op->_ob_prev->_ob_next = op->_ob_next;
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001657 op->_ob_next = op->_ob_prev = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001658 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001659}
1660
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001661void
Fred Drake100814d2000-07-09 15:48:49 +00001662_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001663{
Christian Heimes90aa7642007-12-19 02:45:37 +00001664 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001665 _Py_ForgetReference(op);
Guido van Rossum9776adf1994-09-07 14:36:45 +00001666 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001667}
1668
Tim Peters269b2a62003-04-17 19:52:29 +00001669/* Print all live objects. Because PyObject_Print is called, the
1670 * interpreter must be in a healthy state.
1671 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001672void
Fred Drake100814d2000-07-09 15:48:49 +00001673_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001674{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001675 PyObject *op;
Guido van Rossume09fb551997-08-05 02:04:34 +00001676 fprintf(fp, "Remaining objects:\n");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001677 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001678 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001679 if (PyObject_Print(op, fp, 0) != 0)
1680 PyErr_Clear();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001681 putc('\n', fp);
1682 }
1683}
1684
Tim Peters269b2a62003-04-17 19:52:29 +00001685/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1686 * doesn't make any calls to the Python C API, so is always safe to call.
1687 */
1688void
1689_Py_PrintReferenceAddresses(FILE *fp)
1690{
1691 PyObject *op;
1692 fprintf(fp, "Remaining object addresses:\n");
1693 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001694 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
Christian Heimes90aa7642007-12-19 02:45:37 +00001695 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001696}
1697
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001698PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001699_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001700{
1701 int i, n;
1702 PyObject *t = NULL;
1703 PyObject *res, *op;
1704
1705 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1706 return NULL;
1707 op = refchain._ob_next;
1708 res = PyList_New(0);
1709 if (res == NULL)
1710 return NULL;
1711 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1712 while (op == self || op == args || op == res || op == t ||
Christian Heimes90aa7642007-12-19 02:45:37 +00001713 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001714 op = op->_ob_next;
1715 if (op == &refchain)
1716 return res;
1717 }
1718 if (PyList_Append(res, op) < 0) {
1719 Py_DECREF(res);
1720 return NULL;
1721 }
1722 op = op->_ob_next;
1723 }
1724 return res;
1725}
1726
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001727#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001728
1729
1730/* Hack to force loading of cobject.o */
Guido van Rossumda9c2711996-12-05 21:58:58 +00001731PyTypeObject *_Py_cobject_hack = &PyCObject_Type;
Guido van Rossum84a90321996-05-22 16:34:47 +00001732
1733
1734/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001735Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001736
1737
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001738/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001739
Thomas Wouters334fb892000-07-25 12:56:38 +00001740void *
Fred Drake100814d2000-07-09 15:48:49 +00001741PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001742{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001743 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001744}
1745
Thomas Wouters334fb892000-07-25 12:56:38 +00001746void *
1747PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001748{
Tim Petersaf3e8de2002-04-12 07:22:56 +00001749 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001750}
1751
1752void
Thomas Wouters334fb892000-07-25 12:56:38 +00001753PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001754{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001755 PyMem_FREE(p);
1756}
1757
1758
Guido van Rossum86610361998-04-10 22:32:46 +00001759/* These methods are used to control infinite recursion in repr, str, print,
1760 etc. Container objects that may recursively contain themselves,
1761 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1762 Py_ReprLeave() to avoid infinite recursion.
1763
1764 Py_ReprEnter() returns 0 the first time it is called for a particular
1765 object and 1 every time thereafter. It returns -1 if an exception
1766 occurred. Py_ReprLeave() has no return value.
1767
1768 See dictobject.c and listobject.c for examples of use.
1769*/
1770
1771#define KEY "Py_Repr"
1772
1773int
Fred Drake100814d2000-07-09 15:48:49 +00001774Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001775{
1776 PyObject *dict;
1777 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001778 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001779
1780 dict = PyThreadState_GetDict();
1781 if (dict == NULL)
Guido van Rossum0fc8f002003-04-15 15:12:39 +00001782 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001783 list = PyDict_GetItemString(dict, KEY);
1784 if (list == NULL) {
1785 list = PyList_New(0);
1786 if (list == NULL)
1787 return -1;
1788 if (PyDict_SetItemString(dict, KEY, list) < 0)
1789 return -1;
1790 Py_DECREF(list);
1791 }
1792 i = PyList_GET_SIZE(list);
1793 while (--i >= 0) {
1794 if (PyList_GET_ITEM(list, i) == obj)
1795 return 1;
1796 }
1797 PyList_Append(list, obj);
1798 return 0;
1799}
1800
1801void
Fred Drake100814d2000-07-09 15:48:49 +00001802Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001803{
1804 PyObject *dict;
1805 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001806 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001807
1808 dict = PyThreadState_GetDict();
Guido van Rossumeb909461998-04-11 15:17:34 +00001809 if (dict == NULL)
1810 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001811 list = PyDict_GetItemString(dict, KEY);
Guido van Rossumeb909461998-04-11 15:17:34 +00001812 if (list == NULL || !PyList_Check(list))
1813 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001814 i = PyList_GET_SIZE(list);
1815 /* Count backwards because we always expect obj to be list[-1] */
1816 while (--i >= 0) {
1817 if (PyList_GET_ITEM(list, i) == obj) {
1818 PyList_SetSlice(list, i, i + 1, NULL);
1819 break;
1820 }
1821 }
1822}
Guido van Rossumd724b232000-03-13 16:01:29 +00001823
Tim Peters803526b2002-07-07 05:13:56 +00001824/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001825
Tim Peters803526b2002-07-07 05:13:56 +00001826/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001827int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001828
Tim Peters803526b2002-07-07 05:13:56 +00001829/* List of objects that still need to be cleaned up, singly linked via their
1830 * gc headers' gc_prev pointers.
1831 */
1832PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001833
Tim Peters803526b2002-07-07 05:13:56 +00001834/* Add op to the _PyTrash_delete_later list. Called when the current
1835 * call-stack depth gets large. op must be a currently untracked gc'ed
1836 * object, with refcount 0. Py_DECREF must already have been called on it.
1837 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001838void
Fred Drake100814d2000-07-09 15:48:49 +00001839_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001840{
Tim Peters803526b2002-07-07 05:13:56 +00001841 assert(PyObject_IS_GC(op));
1842 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1843 assert(op->ob_refcnt == 0);
Neil Schemenauerf589c052002-03-29 03:05:54 +00001844 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
Guido van Rossume92e6102000-04-24 15:40:53 +00001845 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001846}
1847
Tim Peters803526b2002-07-07 05:13:56 +00001848/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1849 * the call-stack unwinds again.
1850 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001851void
Fred Drake100814d2000-07-09 15:48:49 +00001852_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001853{
1854 while (_PyTrash_delete_later) {
Tim Peters803526b2002-07-07 05:13:56 +00001855 PyObject *op = _PyTrash_delete_later;
Christian Heimes90aa7642007-12-19 02:45:37 +00001856 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001857
Neil Schemenauerf589c052002-03-29 03:05:54 +00001858 _PyTrash_delete_later =
Tim Peters803526b2002-07-07 05:13:56 +00001859 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001860
Tim Peters803526b2002-07-07 05:13:56 +00001861 /* Call the deallocator directly. This used to try to
1862 * fool Py_DECREF into calling it indirectly, but
1863 * Py_DECREF was already called on this object, and in
1864 * assorted non-release builds calling Py_DECREF again ends
1865 * up distorting allocation statistics.
1866 */
1867 assert(op->ob_refcnt == 0);
Guido van Rossumd724b232000-03-13 16:01:29 +00001868 ++_PyTrash_delete_nesting;
Tim Peters803526b2002-07-07 05:13:56 +00001869 (*dealloc)(op);
Guido van Rossumd724b232000-03-13 16:01:29 +00001870 --_PyTrash_delete_nesting;
1871 }
1872}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001873
1874#ifdef __cplusplus
1875}
1876#endif