blob: 2c43221a1e31f71513b631a1ca5b2b2a97cba255 [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 {
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000347 fprintf(stderr, "object : ");
Barry Warsaweefb1072001-02-22 22:39:18 +0000348 (void)PyObject_Print(op, stderr, 0);
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000349 /* XXX(twouters) cast refcount to long until %zd is
350 universally available */
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000351 fprintf(stderr, "\n"
352 "type : %s\n"
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000353 "refcount: %ld\n"
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000354 "address : %p\n",
Christian Heimes90aa7642007-12-19 02:45:37 +0000355 Py_TYPE(op)==NULL ? "NULL" : Py_TYPE(op)->tp_name,
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000356 (long)op->ob_refcnt,
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000357 op);
Barry Warsaweefb1072001-02-22 22:39:18 +0000358 }
Barry Warsaw9bf16442001-01-23 16:24:35 +0000359}
Barry Warsaw903138f2001-01-23 16:33:18 +0000360
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000361PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000362PyObject_Repr(PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000363{
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000364 PyObject *res;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000365 if (PyErr_CheckSignals())
Guido van Rossum90933611991-06-07 16:10:43 +0000366 return NULL;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000367#ifdef USE_STACKCHECK
368 if (PyOS_CheckStack()) {
Fred Drake661ea262000-10-24 19:57:45 +0000369 PyErr_SetString(PyExc_MemoryError, "stack overflow");
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000370 return NULL;
371 }
372#endif
Guido van Rossum90933611991-06-07 16:10:43 +0000373 if (v == NULL)
Walter Dörwald1ab83302007-05-18 17:15:44 +0000374 return PyUnicode_FromString("<NULL>");
Christian Heimes90aa7642007-12-19 02:45:37 +0000375 if (Py_TYPE(v)->tp_repr == NULL)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000376 return PyUnicode_FromFormat("<%s object at %p>",
377 v->ob_type->tp_name, v);
378 res = (*v->ob_type->tp_repr)(v);
379 if (res != NULL && !PyUnicode_Check(res)) {
380 PyErr_Format(PyExc_TypeError,
381 "__repr__ returned non-string (type %.200s)",
382 res->ob_type->tp_name);
383 Py_DECREF(res);
384 return NULL;
385 }
386 return res;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000387}
388
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000389PyObject *
Guido van Rossum98297ee2007-11-06 21:34:58 +0000390PyObject_Str(PyObject *v)
Guido van Rossumc6004111993-11-05 10:22:19 +0000391{
Guido van Rossum4c08d552000-03-10 22:55:18 +0000392 PyObject *res;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000393 if (PyErr_CheckSignals())
394 return NULL;
395#ifdef USE_STACKCHECK
396 if (PyOS_CheckStack()) {
397 PyErr_SetString(PyExc_MemoryError, "stack overflow");
398 return NULL;
399 }
400#endif
Guido van Rossumc6004111993-11-05 10:22:19 +0000401 if (v == NULL)
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000402 return PyUnicode_FromString("<NULL>");
Neil Schemenauercf52c072005-08-12 17:34:58 +0000403 if (PyUnicode_CheckExact(v)) {
404 Py_INCREF(v);
405 return v;
406 }
Christian Heimes90aa7642007-12-19 02:45:37 +0000407 if (Py_TYPE(v)->tp_str == NULL)
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000408 return PyObject_Repr(v);
409
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000410 /* It is possible for a type to have a tp_str representation that loops
411 infinitely. */
412 if (Py_EnterRecursiveCall(" while getting the str of an object"))
413 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +0000414 res = (*Py_TYPE(v)->tp_str)(v);
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000415 Py_LeaveRecursiveCall();
Guido van Rossum4c08d552000-03-10 22:55:18 +0000416 if (res == NULL)
417 return NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000418 if (!PyUnicode_Check(res)) {
Neil Schemenauercf52c072005-08-12 17:34:58 +0000419 PyErr_Format(PyExc_TypeError,
420 "__str__ returned non-string (type %.200s)",
Christian Heimes90aa7642007-12-19 02:45:37 +0000421 Py_TYPE(res)->tp_name);
Neil Schemenauercf52c072005-08-12 17:34:58 +0000422 Py_DECREF(res);
423 return NULL;
424 }
425 return res;
426}
427
Georg Brandl559e5d72008-06-11 18:37:52 +0000428PyObject *
429PyObject_ASCII(PyObject *v)
430{
431 PyObject *repr, *ascii, *res;
432
433 repr = PyObject_Repr(v);
434 if (repr == NULL)
435 return NULL;
436
437 /* repr is guaranteed to be a PyUnicode object by PyObject_Repr */
438 ascii = PyUnicode_EncodeASCII(
439 PyUnicode_AS_UNICODE(repr),
440 PyUnicode_GET_SIZE(repr),
441 "backslashreplace");
442
443 Py_DECREF(repr);
444 if (ascii == NULL)
445 return NULL;
446
447 res = PyUnicode_DecodeASCII(
448 PyBytes_AS_STRING(ascii),
449 PyBytes_GET_SIZE(ascii),
450 NULL);
451
452 Py_DECREF(ascii);
453 return res;
454}
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000455
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000456PyObject *
457PyObject_Bytes(PyObject *v)
458{
Christian Heimesff869fa2008-08-28 11:28:26 +0000459 PyObject *result, *func;
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000460 static PyObject *bytesstring = NULL;
461
462 if (bytesstring == NULL) {
463 bytesstring = PyUnicode_InternFromString("__bytes__");
464 if (bytesstring == NULL)
465 return NULL;
466 }
467
468 if (v == NULL)
469 return PyBytes_FromString("<NULL>");
470
471 if (PyBytes_CheckExact(v)) {
472 Py_INCREF(v);
473 return v;
474 }
475
476 /* Doesn't create a reference */
477 func = _PyType_Lookup(Py_TYPE(v), bytesstring);
478 if (func != NULL) {
479 result = PyObject_CallFunctionObjArgs(func, v, NULL);
480 if (result == NULL)
481 return NULL;
482 if (!PyBytes_Check(result)) {
483 PyErr_Format(PyExc_TypeError,
484 "__bytes__ returned non-bytes (type %.200s)",
485 Py_TYPE(result)->tp_name);
486 Py_DECREF(result);
487 return NULL;
488 }
489 return result;
490 }
491 PyErr_Clear();
492 return PyBytes_FromObject(v);
493}
494
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000495/* The new comparison philosophy is: we completely separate three-way
496 comparison from rich comparison. That is, PyObject_Compare() and
497 PyObject_Cmp() *just* use the tp_compare slot. And PyObject_RichCompare()
498 and PyObject_RichCompareBool() *just* use the tp_richcompare slot.
Guido van Rossum98297ee2007-11-06 21:34:58 +0000499
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000500 See (*) below for practical amendments.
501
502 IOW, only cmp() uses tp_compare; the comparison operators (==, !=, <=, <,
503 >=, >) only use tp_richcompare. Note that list.sort() only uses <.
504
505 (And yes, eventually we'll rip out cmp() and tp_compare.)
506
507 The calling conventions are different: tp_compare only gets called with two
508 objects of the appropriate type; tp_richcompare gets called with a first
509 argument of the appropriate type and a second object of an arbitrary type.
510 We never do any kind of coercion.
511
512 The return conventions are also different.
513
514 The tp_compare slot should return a C int, as follows:
515
516 -1 if a < b or if an exception occurred
517 0 if a == b
518 +1 if a > b
519
520 No other return values are allowed. PyObject_Compare() has the same
521 calling convention.
522
523 The tp_richcompare slot should return an object, as follows:
524
525 NULL if an exception occurred
526 NotImplemented if the requested comparison is not implemented
527 any other false value if the requested comparison is false
528 any other true value if the requested comparison is true
529
530 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
531 NotImplemented.
532
533 (*) Practical amendments:
534
535 - If rich comparison returns NotImplemented, == and != are decided by
536 comparing the object pointer (i.e. falling back to the base object
537 implementation).
538
539 - If three-way comparison is not implemented, it falls back on rich
540 comparison (but not the other way around!).
541
Guido van Rossuma4073002002-05-31 20:03:54 +0000542*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000543
544/* Forward */
545static PyObject *do_richcompare(PyObject *v, PyObject *w, int op);
546
547/* Perform a three-way comparison, raising TypeError if three-way comparison
548 is not supported. */
Guido van Rossuma4073002002-05-31 20:03:54 +0000549static int
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000550do_compare(PyObject *v, PyObject *w)
Guido van Rossuma4073002002-05-31 20:03:54 +0000551{
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000552 cmpfunc f;
553 int ok;
554
Guido van Rossum98297ee2007-11-06 21:34:58 +0000555 if (v->ob_type == w->ob_type &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000556 (f = v->ob_type->tp_compare) != NULL) {
557 return (*f)(v, w);
Guido van Rossuma4073002002-05-31 20:03:54 +0000558 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000559
560 /* Now try three-way compare before giving up. This is intentionally
561 elaborate; if you have a it will raise TypeError if it detects two
562 objects that aren't ordered with respect to each other. */
563 ok = PyObject_RichCompareBool(v, w, Py_LT);
564 if (ok < 0)
565 return -1; /* Error */
566 if (ok)
567 return -1; /* Less than */
568 ok = PyObject_RichCompareBool(v, w, Py_GT);
569 if (ok < 0)
570 return -1; /* Error */
571 if (ok)
572 return 1; /* Greater than */
573 ok = PyObject_RichCompareBool(v, w, Py_EQ);
574 if (ok < 0)
575 return -1; /* Error */
576 if (ok)
577 return 0; /* Equal */
578
579 /* Give up */
580 PyErr_Format(PyExc_TypeError,
Neal Norwitz3bd844e2006-08-29 04:39:12 +0000581 "unorderable types: '%.100s' != '%.100s'",
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000582 v->ob_type->tp_name,
583 w->ob_type->tp_name);
584 return -1;
Guido van Rossuma4073002002-05-31 20:03:54 +0000585}
586
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000587/* Perform a three-way comparison. This wraps do_compare() with a check for
588 NULL arguments and a recursion check. */
589int
590PyObject_Compare(PyObject *v, PyObject *w)
591{
592 int res;
Guido van Rossuma4073002002-05-31 20:03:54 +0000593
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000594 if (v == NULL || w == NULL) {
595 if (!PyErr_Occurred())
596 PyErr_BadInternalCall();
597 return -1;
598 }
599 if (Py_EnterRecursiveCall(" in cmp"))
600 return -1;
601 res = do_compare(v, w);
602 Py_LeaveRecursiveCall();
603 return res < 0 ? -1 : res;
604}
Guido van Rossumd1f06b92001-01-24 22:14:43 +0000605
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000606/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000607int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000608
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000609static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000610
611/* Perform a rich comparison, raising TypeError when the requested comparison
612 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000613static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000614do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000615{
616 richcmpfunc f;
617 PyObject *res;
618
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000619 if (v->ob_type != w->ob_type &&
620 PyType_IsSubtype(w->ob_type, v->ob_type) &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000621 (f = w->ob_type->tp_richcompare) != NULL) {
Tim Petersf4aca752004-09-23 02:39:37 +0000622 res = (*f)(w, v, _Py_SwappedOp[op]);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000623 if (res != Py_NotImplemented)
624 return res;
625 Py_DECREF(res);
626 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000627 if ((f = v->ob_type->tp_richcompare) != NULL) {
Guido van Rossume797ec12001-01-17 15:24:28 +0000628 res = (*f)(v, w, op);
629 if (res != Py_NotImplemented)
630 return res;
631 Py_DECREF(res);
632 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000633 if ((f = w->ob_type->tp_richcompare) != NULL) {
634 res = (*f)(w, v, _Py_SwappedOp[op]);
635 if (res != Py_NotImplemented)
636 return res;
637 Py_DECREF(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000638 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000639 /* If neither object implements it, provide a sensible default
640 for == and !=, but raise an exception for ordering. */
641 switch (op) {
642 case Py_EQ:
643 res = (v == w) ? Py_True : Py_False;
644 break;
645 case Py_NE:
646 res = (v != w) ? Py_True : Py_False;
647 break;
648 default:
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000649 /* XXX Special-case None so it doesn't show as NoneType() */
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000650 PyErr_Format(PyExc_TypeError,
651 "unorderable types: %.100s() %s %.100s()",
652 v->ob_type->tp_name,
653 opstrings[op],
654 w->ob_type->tp_name);
655 return NULL;
656 }
Guido van Rossume797ec12001-01-17 15:24:28 +0000657 Py_INCREF(res);
658 return res;
659}
660
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000661/* Perform a rich comparison with object result. This wraps do_richcompare()
662 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000663
Guido van Rossume797ec12001-01-17 15:24:28 +0000664PyObject *
665PyObject_RichCompare(PyObject *v, PyObject *w, int op)
666{
667 PyObject *res;
668
669 assert(Py_LT <= op && op <= Py_GE);
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000670 if (v == NULL || w == NULL) {
671 if (!PyErr_Occurred())
672 PyErr_BadInternalCall();
673 return NULL;
674 }
Armin Rigo2b3eb402003-10-28 12:05:48 +0000675 if (Py_EnterRecursiveCall(" in cmp"))
676 return NULL;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000677 res = do_richcompare(v, w, op);
Armin Rigo2b3eb402003-10-28 12:05:48 +0000678 Py_LeaveRecursiveCall();
Guido van Rossume797ec12001-01-17 15:24:28 +0000679 return res;
680}
681
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000682/* Perform a rich comparison with integer result. This wraps
683 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000684int
685PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
686{
Raymond Hettinger93d44812004-03-21 17:01:44 +0000687 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000688 int ok;
689
Mark Dickinson4a1f5932008-11-12 23:23:36 +0000690 /* Quick result when objects are the same.
691 Guarantees that identity implies equality. */
692 if (v == w) {
693 if (op == Py_EQ)
694 return 1;
695 else if (op == Py_NE)
696 return 0;
697 }
698
Raymond Hettinger93d44812004-03-21 17:01:44 +0000699 res = PyObject_RichCompare(v, w, op);
Guido van Rossume797ec12001-01-17 15:24:28 +0000700 if (res == NULL)
701 return -1;
Guido van Rossum81912d42002-08-24 05:33:28 +0000702 if (PyBool_Check(res))
703 ok = (res == Py_True);
704 else
705 ok = PyObject_IsTrue(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000706 Py_DECREF(res);
707 return ok;
708}
Fred Drake13634cf2000-06-29 19:17:04 +0000709
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000710/* Turn the result of a three-way comparison into the result expected by a
711 rich comparison. */
712PyObject *
713Py_CmpToRich(int op, int cmp)
714{
715 PyObject *res;
716 int ok;
717
718 if (PyErr_Occurred())
719 return NULL;
720 switch (op) {
721 case Py_LT:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000722 ok = cmp < 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000723 break;
724 case Py_LE:
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_EQ:
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_NE:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000731 ok = cmp != 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000732 break;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000733 case Py_GT:
734 ok = cmp > 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000735 break;
736 case Py_GE:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000737 ok = cmp >= 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000738 break;
739 default:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000740 PyErr_BadArgument();
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000741 return NULL;
742 }
743 res = ok ? Py_True : Py_False;
744 Py_INCREF(res);
745 return res;
746}
747
Fred Drake13634cf2000-06-29 19:17:04 +0000748/* Set of hash utility functions to help maintaining the invariant that
Raymond Hettinger8183fa42004-03-21 17:35:06 +0000749 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000750
751 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
752*/
753
754long
Fred Drake100814d2000-07-09 15:48:49 +0000755_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000756{
Tim Peters39dce292000-08-15 03:34:48 +0000757 double intpart, fractpart;
758 int expo;
759 long hipart;
760 long x; /* the final hash value */
761 /* This is designed so that Python numbers of different types
762 * that compare equal hash to the same value; otherwise comparisons
763 * of mapping keys will turn out weird.
764 */
765
Tim Peters39dce292000-08-15 03:34:48 +0000766 fractpart = modf(v, &intpart);
Tim Peters39dce292000-08-15 03:34:48 +0000767 if (fractpart == 0.0) {
768 /* This must return the same hash as an equal int or long. */
769 if (intpart > LONG_MAX || -intpart > LONG_MAX) {
770 /* Convert to long and use its hash. */
771 PyObject *plong; /* converted to Python long */
772 if (Py_IS_INFINITY(intpart))
773 /* can't convert to long int -- arbitrary */
774 v = v < 0 ? -271828.0 : 314159.0;
775 plong = PyLong_FromDouble(v);
776 if (plong == NULL)
777 return -1;
778 x = PyObject_Hash(plong);
779 Py_DECREF(plong);
780 return x;
781 }
782 /* Fits in a C long == a Python int, so is its own hash. */
783 x = (long)intpart;
784 if (x == -1)
785 x = -2;
786 return x;
787 }
788 /* The fractional part is non-zero, so we don't have to worry about
789 * making this match the hash of some other type.
790 * Use frexp to get at the bits in the double.
Fred Drake13634cf2000-06-29 19:17:04 +0000791 * Since the VAX D double format has 56 mantissa bits, which is the
792 * most of any double format in use, each of these parts may have as
793 * many as (but no more than) 56 significant bits.
Tim Peters39dce292000-08-15 03:34:48 +0000794 * So, assuming sizeof(long) >= 4, each part can be broken into two
795 * longs; frexp and multiplication are used to do that.
796 * Also, since the Cray double format has 15 exponent bits, which is
797 * the most of any double format in use, shifting the exponent field
798 * left by 15 won't overflow a long (again assuming sizeof(long) >= 4).
Fred Drake13634cf2000-06-29 19:17:04 +0000799 */
Tim Peters39dce292000-08-15 03:34:48 +0000800 v = frexp(v, &expo);
801 v *= 2147483648.0; /* 2**31 */
802 hipart = (long)v; /* take the top 32 bits */
803 v = (v - (double)hipart) * 2147483648.0; /* get the next 32 bits */
804 x = hipart + (long)v + (expo << 15);
805 if (x == -1)
806 x = -2;
807 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000808}
809
810long
Fred Drake100814d2000-07-09 15:48:49 +0000811_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000812{
813#if SIZEOF_LONG >= SIZEOF_VOID_P
814 return (long)p;
815#else
816 /* convert to a Python long and hash that */
817 PyObject* longobj;
818 long x;
Tim Peters803526b2002-07-07 05:13:56 +0000819
Fred Drake13634cf2000-06-29 19:17:04 +0000820 if ((longobj = PyLong_FromVoidPtr(p)) == NULL) {
821 x = -1;
822 goto finally;
823 }
824 x = PyObject_Hash(longobj);
Tim Peters803526b2002-07-07 05:13:56 +0000825
Fred Drake13634cf2000-06-29 19:17:04 +0000826finally:
827 Py_XDECREF(longobj);
828 return x;
829#endif
830}
831
Nick Coghland1abd252008-07-15 15:46:38 +0000832long
833PyObject_HashNotImplemented(PyObject *v)
834{
835 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
836 Py_TYPE(v)->tp_name);
837 return -1;
838}
Fred Drake13634cf2000-06-29 19:17:04 +0000839
Guido van Rossum9bfef441993-03-29 10:43:31 +0000840long
Fred Drake100814d2000-07-09 15:48:49 +0000841PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000842{
Nick Coghland1abd252008-07-15 15:46:38 +0000843 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000844 if (tp->tp_hash != NULL)
845 return (*tp->tp_hash)(v);
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000846 /* Otherwise, the object can't be hashed */
Nick Coghland1abd252008-07-15 15:46:38 +0000847 return PyObject_HashNotImplemented(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000848}
849
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000850PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000851PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000852{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000853 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000854
Christian Heimes90aa7642007-12-19 02:45:37 +0000855 if (Py_TYPE(v)->tp_getattr != NULL)
856 return (*Py_TYPE(v)->tp_getattr)(v, (char*)name);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000857 w = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000858 if (w == NULL)
859 return NULL;
860 res = PyObject_GetAttr(v, w);
861 Py_XDECREF(w);
862 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000863}
864
865int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000866PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000867{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000868 PyObject *res = PyObject_GetAttrString(v, name);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000869 if (res != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000870 Py_DECREF(res);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000871 return 1;
872 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000873 PyErr_Clear();
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000874 return 0;
875}
876
877int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000878PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000879{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000880 PyObject *s;
881 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000882
Christian Heimes90aa7642007-12-19 02:45:37 +0000883 if (Py_TYPE(v)->tp_setattr != NULL)
884 return (*Py_TYPE(v)->tp_setattr)(v, (char*)name, w);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000885 s = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000886 if (s == NULL)
887 return -1;
888 res = PyObject_SetAttr(v, s, w);
889 Py_XDECREF(s);
890 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000891}
892
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000893PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000894PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000895{
Christian Heimes90aa7642007-12-19 02:45:37 +0000896 PyTypeObject *tp = Py_TYPE(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000897
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000898 if (!PyUnicode_Check(name)) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000899 PyErr_Format(PyExc_TypeError,
900 "attribute name must be string, not '%.200s'",
901 name->ob_type->tp_name);
902 return NULL;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000903 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000904 if (tp->tp_getattro != NULL)
905 return (*tp->tp_getattro)(v, name);
906 if (tp->tp_getattr != NULL)
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000907 return (*tp->tp_getattr)(v, _PyUnicode_AsString(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +0000908 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000909 "'%.50s' object has no attribute '%U'",
910 tp->tp_name, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000911 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000912}
913
914int
Fred Drake100814d2000-07-09 15:48:49 +0000915PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000916{
917 PyObject *res = PyObject_GetAttr(v, name);
918 if (res != NULL) {
919 Py_DECREF(res);
920 return 1;
921 }
922 PyErr_Clear();
923 return 0;
924}
925
926int
Fred Drake100814d2000-07-09 15:48:49 +0000927PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000928{
Christian Heimes90aa7642007-12-19 02:45:37 +0000929 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000930 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000931
Martin v. Löwis5b222132007-06-10 09:51:05 +0000932 if (!PyUnicode_Check(name)) {
933 PyErr_Format(PyExc_TypeError,
934 "attribute name must be string, not '%.200s'",
935 name->ob_type->tp_name);
936 return -1;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000937 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000938 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000939
Martin v. Löwis5b222132007-06-10 09:51:05 +0000940 PyUnicode_InternInPlace(&name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000941 if (tp->tp_setattro != NULL) {
942 err = (*tp->tp_setattro)(v, name, value);
943 Py_DECREF(name);
944 return err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000945 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000946 if (tp->tp_setattr != NULL) {
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000947 err = (*tp->tp_setattr)(v, _PyUnicode_AsString(name), value);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000948 Py_DECREF(name);
949 return err;
950 }
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000951 Py_DECREF(name);
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000952 assert(name->ob_refcnt >= 1);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000953 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
954 PyErr_Format(PyExc_TypeError,
955 "'%.100s' object has no attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000956 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000957 tp->tp_name,
958 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000959 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000960 else
961 PyErr_Format(PyExc_TypeError,
962 "'%.100s' object has only read-only attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000963 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000964 tp->tp_name,
965 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000966 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000967 return -1;
968}
969
970/* Helper to get a pointer to an object's __dict__ slot, if any */
971
972PyObject **
973_PyObject_GetDictPtr(PyObject *obj)
974{
Martin v. Löwis725507b2006-03-07 12:08:51 +0000975 Py_ssize_t dictoffset;
Christian Heimes90aa7642007-12-19 02:45:37 +0000976 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000977
Tim Peters6d6c1a32001-08-02 04:15:00 +0000978 dictoffset = tp->tp_dictoffset;
979 if (dictoffset == 0)
980 return NULL;
981 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000982 Py_ssize_t tsize;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000983 size_t size;
984
985 tsize = ((PyVarObject *)obj)->ob_size;
986 if (tsize < 0)
987 tsize = -tsize;
988 size = _PyObject_VAR_SIZE(tp, tsize);
989
Tim Peters6d483d32001-10-06 21:27:34 +0000990 dictoffset += (long)size;
991 assert(dictoffset > 0);
992 assert(dictoffset % SIZEOF_VOID_P == 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000993 }
994 return (PyObject **) ((char *)obj + dictoffset);
995}
996
Tim Peters6d6c1a32001-08-02 04:15:00 +0000997PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000998PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +0000999{
1000 Py_INCREF(obj);
1001 return obj;
1002}
1003
Michael W. Hudson1593f502004-09-14 17:09:47 +00001004/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
1005
Raymond Hettinger01538262003-03-17 08:24:35 +00001006PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001007PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
1008{
Christian Heimes90aa7642007-12-19 02:45:37 +00001009 PyTypeObject *tp = Py_TYPE(obj);
Guido van Rossum056fbf42002-08-19 19:22:50 +00001010 PyObject *descr = NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001011 PyObject *res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001012 descrgetfunc f;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001013 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001014 PyObject **dictptr;
1015
Martin v. Löwis5b222132007-06-10 09:51:05 +00001016 if (!PyUnicode_Check(name)){
1017 PyErr_Format(PyExc_TypeError,
1018 "attribute name must be string, not '%.200s'",
1019 name->ob_type->tp_name);
1020 return NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001021 }
1022 else
1023 Py_INCREF(name);
1024
Tim Peters6d6c1a32001-08-02 04:15:00 +00001025 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001026 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001027 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001028 }
1029
Christian Heimesa62da1d2008-01-12 19:39:10 +00001030#if 0 /* XXX this is not quite _PyType_Lookup anymore */
Guido van Rossum056fbf42002-08-19 19:22:50 +00001031 /* Inline _PyType_Lookup */
1032 {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001033 Py_ssize_t i, n;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001034 PyObject *mro, *base, *dict;
1035
1036 /* Look in tp_dict of types in MRO */
1037 mro = tp->tp_mro;
1038 assert(mro != NULL);
1039 assert(PyTuple_Check(mro));
1040 n = PyTuple_GET_SIZE(mro);
1041 for (i = 0; i < n; i++) {
1042 base = PyTuple_GET_ITEM(mro, i);
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001043 assert(PyType_Check(base));
1044 dict = ((PyTypeObject *)base)->tp_dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001045 assert(dict && PyDict_Check(dict));
1046 descr = PyDict_GetItem(dict, name);
1047 if (descr != NULL)
1048 break;
1049 }
1050 }
Christian Heimesa62da1d2008-01-12 19:39:10 +00001051#else
1052 descr = _PyType_Lookup(tp, name);
1053#endif
Guido van Rossum056fbf42002-08-19 19:22:50 +00001054
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001055 Py_XINCREF(descr);
1056
Tim Peters6d6c1a32001-08-02 04:15:00 +00001057 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001058 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001059 f = descr->ob_type->tp_descr_get;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001060 if (f != NULL && PyDescr_IsData(descr)) {
1061 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001062 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001063 goto done;
1064 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001065 }
1066
Guido van Rossumc66ff442002-08-19 16:50:48 +00001067 /* Inline _PyObject_GetDictPtr */
1068 dictoffset = tp->tp_dictoffset;
1069 if (dictoffset != 0) {
1070 PyObject *dict;
1071 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001072 Py_ssize_t tsize;
Guido van Rossumc66ff442002-08-19 16:50:48 +00001073 size_t size;
1074
1075 tsize = ((PyVarObject *)obj)->ob_size;
1076 if (tsize < 0)
1077 tsize = -tsize;
1078 size = _PyObject_VAR_SIZE(tp, tsize);
1079
1080 dictoffset += (long)size;
1081 assert(dictoffset > 0);
1082 assert(dictoffset % SIZEOF_VOID_P == 0);
1083 }
1084 dictptr = (PyObject **) ((char *)obj + dictoffset);
1085 dict = *dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001086 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +00001087 Py_INCREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001088 res = PyDict_GetItem(dict, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001089 if (res != NULL) {
1090 Py_INCREF(res);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001091 Py_XDECREF(descr);
Christian Heimes969fe572008-01-25 11:23:10 +00001092 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001093 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001094 }
Christian Heimes969fe572008-01-25 11:23:10 +00001095 Py_DECREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001096 }
1097 }
1098
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001099 if (f != NULL) {
Christian Heimes90aa7642007-12-19 02:45:37 +00001100 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001101 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001102 goto done;
1103 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001104
1105 if (descr != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001106 res = descr;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001107 /* descr was already increfed above */
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001108 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001109 }
1110
1111 PyErr_Format(PyExc_AttributeError,
1112 "'%.50s' object has no attribute '%.400s'",
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +00001113 tp->tp_name, _PyUnicode_AsString(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001114 done:
1115 Py_DECREF(name);
1116 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001117}
1118
1119int
1120PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1121{
Christian Heimes90aa7642007-12-19 02:45:37 +00001122 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001123 PyObject *descr;
1124 descrsetfunc f;
1125 PyObject **dictptr;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001126 int res = -1;
1127
Martin v. Löwis5b222132007-06-10 09:51:05 +00001128 if (!PyUnicode_Check(name)){
1129 PyErr_Format(PyExc_TypeError,
1130 "attribute name must be string, not '%.200s'",
1131 name->ob_type->tp_name);
1132 return -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001133 }
1134 else
1135 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001136
1137 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001138 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001139 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001140 }
1141
1142 descr = _PyType_Lookup(tp, name);
1143 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001144 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001145 f = descr->ob_type->tp_descr_set;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001146 if (f != NULL && PyDescr_IsData(descr)) {
1147 res = f(descr, obj, value);
1148 goto done;
1149 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001150 }
1151
1152 dictptr = _PyObject_GetDictPtr(obj);
1153 if (dictptr != NULL) {
1154 PyObject *dict = *dictptr;
1155 if (dict == NULL && value != NULL) {
1156 dict = PyDict_New();
1157 if (dict == NULL)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001158 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001159 *dictptr = dict;
1160 }
1161 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +00001162 Py_INCREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001163 if (value == NULL)
1164 res = PyDict_DelItem(dict, name);
1165 else
1166 res = PyDict_SetItem(dict, name, value);
1167 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1168 PyErr_SetObject(PyExc_AttributeError, name);
Christian Heimes969fe572008-01-25 11:23:10 +00001169 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001170 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001171 }
1172 }
1173
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001174 if (f != NULL) {
1175 res = f(descr, obj, value);
1176 goto done;
1177 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001178
1179 if (descr == NULL) {
1180 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001181 "'%.100s' object has no attribute '%U'",
1182 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001183 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001184 }
1185
1186 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001187 "'%.50s' object attribute '%U' is read-only",
1188 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001189 done:
1190 Py_DECREF(name);
1191 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001192}
1193
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001194/* Test a value used as condition, e.g., in a for or if statement.
1195 Return -1 if an error occurred */
1196
1197int
Fred Drake100814d2000-07-09 15:48:49 +00001198PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001199{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001200 Py_ssize_t res;
Guido van Rossum6248f442002-08-24 06:31:34 +00001201 if (v == Py_True)
1202 return 1;
1203 if (v == Py_False)
1204 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001205 if (v == Py_None)
Neal Norwitz51290d32002-06-13 21:32:44 +00001206 return 0;
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001207 else if (v->ob_type->tp_as_number != NULL &&
Jack Diederich4dafcc42006-11-28 19:15:13 +00001208 v->ob_type->tp_as_number->nb_bool != NULL)
1209 res = (*v->ob_type->tp_as_number->nb_bool)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001210 else if (v->ob_type->tp_as_mapping != NULL &&
1211 v->ob_type->tp_as_mapping->mp_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001212 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001213 else if (v->ob_type->tp_as_sequence != NULL &&
1214 v->ob_type->tp_as_sequence->sq_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001215 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1216 else
Neal Norwitz51290d32002-06-13 21:32:44 +00001217 return 1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001218 /* if it is negative, it should be either -1 or -2 */
1219 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001220}
1221
Tim Peters803526b2002-07-07 05:13:56 +00001222/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001223 Return -1 if an error occurred */
1224
1225int
Fred Drake100814d2000-07-09 15:48:49 +00001226PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001227{
1228 int res;
1229 res = PyObject_IsTrue(v);
1230 if (res < 0)
1231 return res;
1232 return res == 0;
1233}
1234
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001235/* Test whether an object can be called */
1236
1237int
Fred Drake100814d2000-07-09 15:48:49 +00001238PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001239{
1240 if (x == NULL)
1241 return 0;
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001242 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001243}
1244
Georg Brandle32b4222007-03-10 22:13:27 +00001245/* ------------------------- PyObject_Dir() helpers ------------------------- */
1246
Tim Peters7eea37e2001-09-04 22:08:56 +00001247/* Helper for PyObject_Dir.
1248 Merge the __dict__ of aclass into dict, and recursively also all
1249 the __dict__s of aclass's base classes. The order of merging isn't
1250 defined, as it's expected that only the final set of dict keys is
1251 interesting.
1252 Return 0 on success, -1 on error.
1253*/
1254
1255static int
1256merge_class_dict(PyObject* dict, PyObject* aclass)
1257{
1258 PyObject *classdict;
1259 PyObject *bases;
1260
1261 assert(PyDict_Check(dict));
1262 assert(aclass);
1263
1264 /* Merge in the type's dict (if any). */
1265 classdict = PyObject_GetAttrString(aclass, "__dict__");
1266 if (classdict == NULL)
1267 PyErr_Clear();
1268 else {
1269 int status = PyDict_Update(dict, classdict);
1270 Py_DECREF(classdict);
1271 if (status < 0)
1272 return -1;
1273 }
1274
1275 /* Recursively merge in the base types' (if any) dicts. */
1276 bases = PyObject_GetAttrString(aclass, "__bases__");
Tim Petersbc7e8632001-09-16 20:33:22 +00001277 if (bases == NULL)
1278 PyErr_Clear();
1279 else {
Guido van Rossum44022412002-05-13 18:29:46 +00001280 /* We have no guarantee that bases is a real tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001281 Py_ssize_t i, n;
Guido van Rossum44022412002-05-13 18:29:46 +00001282 n = PySequence_Size(bases); /* This better be right */
1283 if (n < 0)
1284 PyErr_Clear();
1285 else {
1286 for (i = 0; i < n; i++) {
Tim Peters18e70832003-02-05 19:35:19 +00001287 int status;
Guido van Rossum44022412002-05-13 18:29:46 +00001288 PyObject *base = PySequence_GetItem(bases, i);
1289 if (base == NULL) {
1290 Py_DECREF(bases);
1291 return -1;
1292 }
Tim Peters18e70832003-02-05 19:35:19 +00001293 status = merge_class_dict(dict, base);
1294 Py_DECREF(base);
1295 if (status < 0) {
Guido van Rossum44022412002-05-13 18:29:46 +00001296 Py_DECREF(bases);
1297 return -1;
1298 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001299 }
1300 }
1301 Py_DECREF(bases);
1302 }
1303 return 0;
1304}
1305
Georg Brandle32b4222007-03-10 22:13:27 +00001306/* Helper for PyObject_Dir without arguments: returns the local scope. */
1307static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001308_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001309{
Georg Brandled3b8382007-03-12 13:15:14 +00001310 PyObject *names;
Georg Brandle32b4222007-03-10 22:13:27 +00001311 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001312
Georg Brandle32b4222007-03-10 22:13:27 +00001313 if (locals == NULL) {
1314 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1315 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001316 }
1317
Georg Brandled3b8382007-03-12 13:15:14 +00001318 names = PyMapping_Keys(locals);
1319 if (!names)
1320 return NULL;
1321 if (!PyList_Check(names)) {
1322 PyErr_Format(PyExc_TypeError,
1323 "dir(): expected keys() of locals to be a list, "
Christian Heimes90aa7642007-12-19 02:45:37 +00001324 "not '%.200s'", Py_TYPE(names)->tp_name);
Georg Brandled3b8382007-03-12 13:15:14 +00001325 Py_DECREF(names);
1326 return NULL;
1327 }
Georg Brandle32b4222007-03-10 22:13:27 +00001328 /* the locals don't need to be DECREF'd */
Georg Brandled3b8382007-03-12 13:15:14 +00001329 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001330}
1331
1332/* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
Guido van Rossum98297ee2007-11-06 21:34:58 +00001333 We deliberately don't suck up its __class__, as methods belonging to the
1334 metaclass would probably be more confusing than helpful.
Georg Brandle32b4222007-03-10 22:13:27 +00001335*/
Guido van Rossum98297ee2007-11-06 21:34:58 +00001336static PyObject *
Georg Brandle32b4222007-03-10 22:13:27 +00001337_specialized_dir_type(PyObject *obj)
1338{
1339 PyObject *result = NULL;
1340 PyObject *dict = PyDict_New();
1341
1342 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1343 result = PyDict_Keys(dict);
1344
1345 Py_XDECREF(dict);
Tim Peters305b5852001-09-17 02:38:46 +00001346 return result;
1347}
1348
Georg Brandle32b4222007-03-10 22:13:27 +00001349/* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1350static PyObject *
1351_specialized_dir_module(PyObject *obj)
Tim Peters7eea37e2001-09-04 22:08:56 +00001352{
Georg Brandle32b4222007-03-10 22:13:27 +00001353 PyObject *result = NULL;
1354 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
Tim Peters7eea37e2001-09-04 22:08:56 +00001355
Georg Brandle32b4222007-03-10 22:13:27 +00001356 if (dict != NULL) {
1357 if (PyDict_Check(dict))
1358 result = PyDict_Keys(dict);
1359 else {
1360 PyErr_Format(PyExc_TypeError,
1361 "%.200s.__dict__ is not a dictionary",
1362 PyModule_GetName(obj));
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001363 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001364 }
1365
Georg Brandle32b4222007-03-10 22:13:27 +00001366 Py_XDECREF(dict);
1367 return result;
1368}
Tim Peters7eea37e2001-09-04 22:08:56 +00001369
Georg Brandle32b4222007-03-10 22:13:27 +00001370/* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1371 and recursively up the __class__.__bases__ chain.
1372*/
1373static PyObject *
1374_generic_dir(PyObject *obj)
1375{
1376 PyObject *result = NULL;
1377 PyObject *dict = NULL;
1378 PyObject *itsclass = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001379
Georg Brandle32b4222007-03-10 22:13:27 +00001380 /* Get __dict__ (which may or may not be a real dict...) */
1381 dict = PyObject_GetAttrString(obj, "__dict__");
1382 if (dict == NULL) {
1383 PyErr_Clear();
1384 dict = PyDict_New();
1385 }
1386 else if (!PyDict_Check(dict)) {
1387 Py_DECREF(dict);
1388 dict = PyDict_New();
1389 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001390 else {
Georg Brandle32b4222007-03-10 22:13:27 +00001391 /* Copy __dict__ to avoid mutating it. */
1392 PyObject *temp = PyDict_Copy(dict);
1393 Py_DECREF(dict);
1394 dict = temp;
Tim Peters7eea37e2001-09-04 22:08:56 +00001395 }
1396
Georg Brandle32b4222007-03-10 22:13:27 +00001397 if (dict == NULL)
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001398 goto error;
Tim Peters7eea37e2001-09-04 22:08:56 +00001399
Georg Brandle32b4222007-03-10 22:13:27 +00001400 /* Merge in attrs reachable from its class. */
1401 itsclass = PyObject_GetAttrString(obj, "__class__");
1402 if (itsclass == NULL)
1403 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1404 __class__ exists? */
1405 PyErr_Clear();
1406 else {
1407 if (merge_class_dict(dict, itsclass) != 0)
1408 goto error;
1409 }
1410
1411 result = PyDict_Keys(dict);
Tim Peters7eea37e2001-09-04 22:08:56 +00001412 /* fall through */
Georg Brandle32b4222007-03-10 22:13:27 +00001413error:
1414 Py_XDECREF(itsclass);
1415 Py_XDECREF(dict);
1416 return result;
1417}
1418
1419/* Helper for PyObject_Dir: object introspection.
1420 This calls one of the above specialized versions if no __dir__ method
1421 exists. */
1422static PyObject *
1423_dir_object(PyObject *obj)
1424{
1425 PyObject * result = NULL;
1426 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1427 "__dir__");
1428
1429 assert(obj);
1430 if (dirfunc == NULL) {
1431 /* use default implementation */
1432 PyErr_Clear();
1433 if (PyModule_Check(obj))
1434 result = _specialized_dir_module(obj);
1435 else if (PyType_Check(obj))
1436 result = _specialized_dir_type(obj);
1437 else
1438 result = _generic_dir(obj);
1439 }
1440 else {
1441 /* use __dir__ */
1442 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1443 Py_DECREF(dirfunc);
1444 if (result == NULL)
1445 return NULL;
1446
1447 /* result must be a list */
1448 /* XXX(gbrandl): could also check if all items are strings */
1449 if (!PyList_Check(result)) {
1450 PyErr_Format(PyExc_TypeError,
1451 "__dir__() must return a list, not %.200s",
Christian Heimes90aa7642007-12-19 02:45:37 +00001452 Py_TYPE(result)->tp_name);
Georg Brandle32b4222007-03-10 22:13:27 +00001453 Py_DECREF(result);
1454 result = NULL;
1455 }
1456 }
1457
1458 return result;
1459}
1460
1461/* Implementation of dir() -- if obj is NULL, returns the names in the current
1462 (local) scope. Otherwise, performs introspection of the object: returns a
1463 sorted list of attribute names (supposedly) accessible from the object
1464*/
1465PyObject *
1466PyObject_Dir(PyObject *obj)
1467{
1468 PyObject * result;
1469
1470 if (obj == NULL)
1471 /* no object -- introspect the locals */
1472 result = _dir_locals();
1473 else
1474 /* object -- introspect the object */
1475 result = _dir_object(obj);
1476
1477 assert(result == NULL || PyList_Check(result));
1478
1479 if (result != NULL && PyList_Sort(result) != 0) {
1480 /* sorting the list failed */
1481 Py_DECREF(result);
1482 result = NULL;
1483 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001484
Tim Peters7eea37e2001-09-04 22:08:56 +00001485 return result;
1486}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001487
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001488/*
1489NoObject is usable as a non-NULL undefined value, used by the macro None.
1490There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001491so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001492(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001493*/
1494
Guido van Rossum0c182a11992-03-27 17:26:13 +00001495/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001496static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001497none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001498{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001499 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001500}
1501
Barry Warsaw9bf16442001-01-23 16:24:35 +00001502/* ARGUSED */
1503static void
Tim Peters803526b2002-07-07 05:13:56 +00001504none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001505{
1506 /* This should never get called, but we also don't want to SEGV if
1507 * we accidently decref None out of existance.
1508 */
Martin v. Löwis3f19b102002-08-07 16:21:51 +00001509 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001510}
1511
1512
Guido van Rossumba21a492001-08-16 08:17:26 +00001513static PyTypeObject PyNone_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001514 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001515 "NoneType",
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001516 0,
1517 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001518 none_dealloc, /*tp_dealloc*/ /*never called*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001519 0, /*tp_print*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001520 0, /*tp_getattr*/
1521 0, /*tp_setattr*/
1522 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001523 none_repr, /*tp_repr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001524 0, /*tp_as_number*/
1525 0, /*tp_as_sequence*/
1526 0, /*tp_as_mapping*/
Guido van Rossum9bfef441993-03-29 10:43:31 +00001527 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001528};
1529
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001530PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001531 _PyObject_EXTRA_INIT
1532 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001533};
1534
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001535/* NotImplemented is an object that can be used to signal that an
1536 operation is not implemented for the given type combination. */
1537
1538static PyObject *
1539NotImplemented_repr(PyObject *op)
1540{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001541 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001542}
1543
1544static PyTypeObject PyNotImplemented_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001545 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001546 "NotImplementedType",
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001547 0,
1548 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001549 none_dealloc, /*tp_dealloc*/ /*never called*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001550 0, /*tp_print*/
1551 0, /*tp_getattr*/
1552 0, /*tp_setattr*/
1553 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001554 NotImplemented_repr, /*tp_repr*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001555 0, /*tp_as_number*/
1556 0, /*tp_as_sequence*/
1557 0, /*tp_as_mapping*/
1558 0, /*tp_hash */
1559};
1560
1561PyObject _Py_NotImplementedStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001562 _PyObject_EXTRA_INIT
1563 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001564};
1565
Guido van Rossumba21a492001-08-16 08:17:26 +00001566void
1567_Py_ReadyTypes(void)
1568{
1569 if (PyType_Ready(&PyType_Type) < 0)
1570 Py_FatalError("Can't initialize 'type'");
1571
Fred Drake0a4dd392004-07-02 18:57:45 +00001572 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1573 Py_FatalError("Can't initialize 'weakref'");
1574
Guido van Rossum77f6a652002-04-03 22:41:51 +00001575 if (PyType_Ready(&PyBool_Type) < 0)
1576 Py_FatalError("Can't initialize 'bool'");
1577
Christian Heimes9c4756e2008-05-26 13:22:05 +00001578 if (PyType_Ready(&PyByteArray_Type) < 0)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001579 Py_FatalError("Can't initialize 'bytes'");
1580
Christian Heimes72b710a2008-05-26 13:28:38 +00001581 if (PyType_Ready(&PyBytes_Type) < 0)
Guido van Rossumcacfc072002-05-24 19:01:59 +00001582 Py_FatalError("Can't initialize 'str'");
1583
Guido van Rossumba21a492001-08-16 08:17:26 +00001584 if (PyType_Ready(&PyList_Type) < 0)
1585 Py_FatalError("Can't initialize 'list'");
1586
1587 if (PyType_Ready(&PyNone_Type) < 0)
1588 Py_FatalError("Can't initialize type(None)");
1589
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001590 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1591 Py_FatalError("Can't initialize type(Ellipsis)");
1592
Guido van Rossumba21a492001-08-16 08:17:26 +00001593 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1594 Py_FatalError("Can't initialize type(NotImplemented)");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001595
1596 if (PyType_Ready(&PyCode_Type) < 0)
1597 Py_FatalError("Can't initialize 'code'");
Guido van Rossum826d8972007-10-30 18:34:07 +00001598
1599 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1600 Py_FatalError("Can't initialize StdPrinter");
Guido van Rossumba21a492001-08-16 08:17:26 +00001601}
1602
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001603
Guido van Rossum84a90321996-05-22 16:34:47 +00001604#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001605
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001606void
Fred Drake100814d2000-07-09 15:48:49 +00001607_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001608{
Tim Peters34592512002-07-11 06:23:50 +00001609 _Py_INC_REFTOTAL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001610 op->ob_refcnt = 1;
Tim Peters7571a0f2003-03-23 17:52:28 +00001611 _Py_AddToAllObjects(op, 1);
Tim Peters34592512002-07-11 06:23:50 +00001612 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001613}
1614
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001615void
Fred Drake100814d2000-07-09 15:48:49 +00001616_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001617{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001618#ifdef SLOW_UNREF_CHECK
Guido van Rossum4c08d552000-03-10 22:55:18 +00001619 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001620#endif
Guido van Rossumd7047b31995-01-02 19:07:15 +00001621 if (op->ob_refcnt < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001622 Py_FatalError("UNREF negative refcnt");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001623 if (op == &refchain ||
Christian Heimesc8967002007-11-30 10:18:26 +00001624 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1625 fprintf(stderr, "* ob\n");
1626 _PyObject_Dump(op);
1627 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1628 _PyObject_Dump(op->_ob_prev->_ob_next);
1629 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1630 _PyObject_Dump(op->_ob_next->_ob_prev);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001631 Py_FatalError("UNREF invalid object");
Christian Heimesc8967002007-11-30 10:18:26 +00001632 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001633#ifdef SLOW_UNREF_CHECK
Guido van Rossum3f5da241990-12-20 15:06:42 +00001634 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1635 if (p == op)
1636 break;
1637 }
Guido van Rossumd7047b31995-01-02 19:07:15 +00001638 if (p == &refchain) /* Not found */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001639 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001640#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001641 op->_ob_next->_ob_prev = op->_ob_prev;
1642 op->_ob_prev->_ob_next = op->_ob_next;
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001643 op->_ob_next = op->_ob_prev = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001644 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001645}
1646
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001647void
Fred Drake100814d2000-07-09 15:48:49 +00001648_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001649{
Christian Heimes90aa7642007-12-19 02:45:37 +00001650 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001651 _Py_ForgetReference(op);
Guido van Rossum9776adf1994-09-07 14:36:45 +00001652 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001653}
1654
Tim Peters269b2a62003-04-17 19:52:29 +00001655/* Print all live objects. Because PyObject_Print is called, the
1656 * interpreter must be in a healthy state.
1657 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001658void
Fred Drake100814d2000-07-09 15:48:49 +00001659_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001660{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001661 PyObject *op;
Guido van Rossume09fb551997-08-05 02:04:34 +00001662 fprintf(fp, "Remaining objects:\n");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001663 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001664 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001665 if (PyObject_Print(op, fp, 0) != 0)
1666 PyErr_Clear();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001667 putc('\n', fp);
1668 }
1669}
1670
Tim Peters269b2a62003-04-17 19:52:29 +00001671/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1672 * doesn't make any calls to the Python C API, so is always safe to call.
1673 */
1674void
1675_Py_PrintReferenceAddresses(FILE *fp)
1676{
1677 PyObject *op;
1678 fprintf(fp, "Remaining object addresses:\n");
1679 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001680 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
Christian Heimes90aa7642007-12-19 02:45:37 +00001681 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001682}
1683
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001684PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001685_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001686{
1687 int i, n;
1688 PyObject *t = NULL;
1689 PyObject *res, *op;
1690
1691 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1692 return NULL;
1693 op = refchain._ob_next;
1694 res = PyList_New(0);
1695 if (res == NULL)
1696 return NULL;
1697 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1698 while (op == self || op == args || op == res || op == t ||
Christian Heimes90aa7642007-12-19 02:45:37 +00001699 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001700 op = op->_ob_next;
1701 if (op == &refchain)
1702 return res;
1703 }
1704 if (PyList_Append(res, op) < 0) {
1705 Py_DECREF(res);
1706 return NULL;
1707 }
1708 op = op->_ob_next;
1709 }
1710 return res;
1711}
1712
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001713#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001714
1715
1716/* Hack to force loading of cobject.o */
Guido van Rossumda9c2711996-12-05 21:58:58 +00001717PyTypeObject *_Py_cobject_hack = &PyCObject_Type;
Guido van Rossum84a90321996-05-22 16:34:47 +00001718
1719
1720/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001721Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001722
1723
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001724/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001725
Thomas Wouters334fb892000-07-25 12:56:38 +00001726void *
Fred Drake100814d2000-07-09 15:48:49 +00001727PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001728{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001729 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001730}
1731
Thomas Wouters334fb892000-07-25 12:56:38 +00001732void *
1733PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001734{
Tim Petersaf3e8de2002-04-12 07:22:56 +00001735 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001736}
1737
1738void
Thomas Wouters334fb892000-07-25 12:56:38 +00001739PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001740{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001741 PyMem_FREE(p);
1742}
1743
1744
Guido van Rossum86610361998-04-10 22:32:46 +00001745/* These methods are used to control infinite recursion in repr, str, print,
1746 etc. Container objects that may recursively contain themselves,
1747 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1748 Py_ReprLeave() to avoid infinite recursion.
1749
1750 Py_ReprEnter() returns 0 the first time it is called for a particular
1751 object and 1 every time thereafter. It returns -1 if an exception
1752 occurred. Py_ReprLeave() has no return value.
1753
1754 See dictobject.c and listobject.c for examples of use.
1755*/
1756
1757#define KEY "Py_Repr"
1758
1759int
Fred Drake100814d2000-07-09 15:48:49 +00001760Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001761{
1762 PyObject *dict;
1763 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001764 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001765
1766 dict = PyThreadState_GetDict();
1767 if (dict == NULL)
Guido van Rossum0fc8f002003-04-15 15:12:39 +00001768 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001769 list = PyDict_GetItemString(dict, KEY);
1770 if (list == NULL) {
1771 list = PyList_New(0);
1772 if (list == NULL)
1773 return -1;
1774 if (PyDict_SetItemString(dict, KEY, list) < 0)
1775 return -1;
1776 Py_DECREF(list);
1777 }
1778 i = PyList_GET_SIZE(list);
1779 while (--i >= 0) {
1780 if (PyList_GET_ITEM(list, i) == obj)
1781 return 1;
1782 }
1783 PyList_Append(list, obj);
1784 return 0;
1785}
1786
1787void
Fred Drake100814d2000-07-09 15:48:49 +00001788Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001789{
1790 PyObject *dict;
1791 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001792 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001793
1794 dict = PyThreadState_GetDict();
Guido van Rossumeb909461998-04-11 15:17:34 +00001795 if (dict == NULL)
1796 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001797 list = PyDict_GetItemString(dict, KEY);
Guido van Rossumeb909461998-04-11 15:17:34 +00001798 if (list == NULL || !PyList_Check(list))
1799 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001800 i = PyList_GET_SIZE(list);
1801 /* Count backwards because we always expect obj to be list[-1] */
1802 while (--i >= 0) {
1803 if (PyList_GET_ITEM(list, i) == obj) {
1804 PyList_SetSlice(list, i, i + 1, NULL);
1805 break;
1806 }
1807 }
1808}
Guido van Rossumd724b232000-03-13 16:01:29 +00001809
Tim Peters803526b2002-07-07 05:13:56 +00001810/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001811
Tim Peters803526b2002-07-07 05:13:56 +00001812/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001813int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001814
Tim Peters803526b2002-07-07 05:13:56 +00001815/* List of objects that still need to be cleaned up, singly linked via their
1816 * gc headers' gc_prev pointers.
1817 */
1818PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001819
Tim Peters803526b2002-07-07 05:13:56 +00001820/* Add op to the _PyTrash_delete_later list. Called when the current
1821 * call-stack depth gets large. op must be a currently untracked gc'ed
1822 * object, with refcount 0. Py_DECREF must already have been called on it.
1823 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001824void
Fred Drake100814d2000-07-09 15:48:49 +00001825_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001826{
Tim Peters803526b2002-07-07 05:13:56 +00001827 assert(PyObject_IS_GC(op));
1828 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1829 assert(op->ob_refcnt == 0);
Neil Schemenauerf589c052002-03-29 03:05:54 +00001830 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
Guido van Rossume92e6102000-04-24 15:40:53 +00001831 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001832}
1833
Tim Peters803526b2002-07-07 05:13:56 +00001834/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1835 * the call-stack unwinds again.
1836 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001837void
Fred Drake100814d2000-07-09 15:48:49 +00001838_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001839{
1840 while (_PyTrash_delete_later) {
Tim Peters803526b2002-07-07 05:13:56 +00001841 PyObject *op = _PyTrash_delete_later;
Christian Heimes90aa7642007-12-19 02:45:37 +00001842 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001843
Neil Schemenauerf589c052002-03-29 03:05:54 +00001844 _PyTrash_delete_later =
Tim Peters803526b2002-07-07 05:13:56 +00001845 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001846
Tim Peters803526b2002-07-07 05:13:56 +00001847 /* Call the deallocator directly. This used to try to
1848 * fool Py_DECREF into calling it indirectly, but
1849 * Py_DECREF was already called on this object, and in
1850 * assorted non-release builds calling Py_DECREF again ends
1851 * up distorting allocation statistics.
1852 */
1853 assert(op->ob_refcnt == 0);
Guido van Rossumd724b232000-03-13 16:01:29 +00001854 ++_PyTrash_delete_nesting;
Tim Peters803526b2002-07-07 05:13:56 +00001855 (*dealloc)(op);
Guido van Rossumd724b232000-03-13 16:01:29 +00001856 --_PyTrash_delete_nesting;
1857 }
1858}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001859
1860#ifdef __cplusplus
1861}
1862#endif