blob: 27d7089dcf826b380bef071879d5f738b653399f [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Benjamin Peterson722954a2011-06-11 16:33:35 -05002/* Generic object operations; and implementation of None */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004#include "Python.h"
Benjamin Petersonfd838e62009-04-20 02:09:13 +00005#include "frameobject.h"
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{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000017 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;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000029}
30#endif /* Py_REF_DEBUG */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000031
Guido van Rossum3f5da241990-12-20 15:06:42 +000032/* Object allocation routines used by NEWOBJ and NEWVAROBJ macros.
33 These are used by the individual routines for object creation.
34 Do not call them otherwise, they do not initialize the object! */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000035
Tim Peters78be7992003-03-23 02:51:01 +000036#ifdef Py_TRACE_REFS
Tim Peters7571a0f2003-03-23 17:52:28 +000037/* Head of circular doubly-linked list of all objects. These are linked
38 * together via the _ob_prev and _ob_next members of a PyObject, which
39 * exist only in a Py_TRACE_REFS build.
40 */
Tim Peters78be7992003-03-23 02:51:01 +000041static PyObject refchain = {&refchain, &refchain};
Tim Peters36eb4df2003-03-23 03:33:13 +000042
Tim Peters7571a0f2003-03-23 17:52:28 +000043/* Insert op at the front of the list of all objects. If force is true,
44 * op is added even if _ob_prev and _ob_next are non-NULL already. If
45 * force is false amd _ob_prev or _ob_next are non-NULL, do nothing.
46 * force should be true if and only if op points to freshly allocated,
47 * uninitialized memory, or you've unlinked op from the list and are
Tim Peters51f8d382003-03-23 18:06:08 +000048 * relinking it into the front.
Tim Peters7571a0f2003-03-23 17:52:28 +000049 * Note that objects are normally added to the list via _Py_NewReference,
50 * which is called by PyObject_Init. Not all objects are initialized that
51 * way, though; exceptions include statically allocated type objects, and
52 * statically allocated singletons (like Py_True and Py_None).
53 */
Tim Peters36eb4df2003-03-23 03:33:13 +000054void
Tim Peters7571a0f2003-03-23 17:52:28 +000055_Py_AddToAllObjects(PyObject *op, int force)
Tim Peters36eb4df2003-03-23 03:33:13 +000056{
Tim Peters7571a0f2003-03-23 17:52:28 +000057#ifdef Py_DEBUG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000058 if (!force) {
59 /* If it's initialized memory, op must be in or out of
60 * the list unambiguously.
61 */
62 assert((op->_ob_prev == NULL) == (op->_ob_next == NULL));
63 }
Tim Peters78be7992003-03-23 02:51:01 +000064#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000065 if (force || op->_ob_prev == NULL) {
66 op->_ob_next = refchain._ob_next;
67 op->_ob_prev = &refchain;
68 refchain._ob_next->_ob_prev = op;
69 refchain._ob_next = op;
70 }
Tim Peters7571a0f2003-03-23 17:52:28 +000071}
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000072#endif /* Py_TRACE_REFS */
Tim Peters78be7992003-03-23 02:51:01 +000073
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000074#ifdef COUNT_ALLOCS
Guido van Rossumc0b618a1997-05-02 03:12:38 +000075static PyTypeObject *type_list;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000076/* All types are added to type_list, at least when
77 they get one object created. That makes them
78 immortal, which unfortunately contributes to
79 garbage itself. If unlist_types_without_objects
80 is set, they will be removed from the type_list
81 once the last object is deallocated. */
Benjamin Petersona4a37fe2009-01-11 17:13:55 +000082static int unlist_types_without_objects;
83extern Py_ssize_t tuple_zero_allocs, fast_tuple_allocs;
84extern Py_ssize_t quick_int_allocs, quick_neg_int_allocs;
85extern Py_ssize_t null_strings, one_strings;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000086void
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000087dump_counts(FILE* f)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000088{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000089 PyTypeObject *tp;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000090
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000091 for (tp = type_list; tp; tp = tp->tp_next)
92 fprintf(f, "%s alloc'd: %" PY_FORMAT_SIZE_T "d, "
93 "freed: %" PY_FORMAT_SIZE_T "d, "
94 "max in use: %" PY_FORMAT_SIZE_T "d\n",
95 tp->tp_name, tp->tp_allocs, tp->tp_frees,
96 tp->tp_maxalloc);
97 fprintf(f, "fast tuple allocs: %" PY_FORMAT_SIZE_T "d, "
98 "empty: %" PY_FORMAT_SIZE_T "d\n",
99 fast_tuple_allocs, tuple_zero_allocs);
100 fprintf(f, "fast int allocs: pos: %" PY_FORMAT_SIZE_T "d, "
101 "neg: %" PY_FORMAT_SIZE_T "d\n",
102 quick_int_allocs, quick_neg_int_allocs);
103 fprintf(f, "null strings: %" PY_FORMAT_SIZE_T "d, "
104 "1-strings: %" PY_FORMAT_SIZE_T "d\n",
105 null_strings, one_strings);
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000106}
107
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000108PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000109get_counts(void)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000110{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000111 PyTypeObject *tp;
112 PyObject *result;
113 PyObject *v;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000114
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000115 result = PyList_New(0);
116 if (result == NULL)
117 return NULL;
118 for (tp = type_list; tp; tp = tp->tp_next) {
119 v = Py_BuildValue("(snnn)", tp->tp_name, tp->tp_allocs,
120 tp->tp_frees, tp->tp_maxalloc);
121 if (v == NULL) {
122 Py_DECREF(result);
123 return NULL;
124 }
125 if (PyList_Append(result, v) < 0) {
126 Py_DECREF(v);
127 Py_DECREF(result);
128 return NULL;
129 }
130 Py_DECREF(v);
131 }
132 return result;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000133}
134
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000135void
Fred Drake100814d2000-07-09 15:48:49 +0000136inc_count(PyTypeObject *tp)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000137{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000138 if (tp->tp_next == NULL && tp->tp_prev == NULL) {
139 /* first time; insert in linked list */
140 if (tp->tp_next != NULL) /* sanity check */
141 Py_FatalError("XXX inc_count sanity check");
142 if (type_list)
143 type_list->tp_prev = tp;
144 tp->tp_next = type_list;
145 /* Note that as of Python 2.2, heap-allocated type objects
146 * can go away, but this code requires that they stay alive
147 * until program exit. That's why we're careful with
148 * refcounts here. type_list gets a new reference to tp,
149 * while ownership of the reference type_list used to hold
150 * (if any) was transferred to tp->tp_next in the line above.
151 * tp is thus effectively immortal after this.
152 */
153 Py_INCREF(tp);
154 type_list = tp;
Tim Peters3e40c7f2003-03-23 03:04:32 +0000155#ifdef Py_TRACE_REFS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000156 /* Also insert in the doubly-linked list of all objects,
157 * if not already there.
158 */
159 _Py_AddToAllObjects((PyObject *)tp, 0);
Tim Peters78be7992003-03-23 02:51:01 +0000160#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000161 }
162 tp->tp_allocs++;
163 if (tp->tp_allocs - tp->tp_frees > tp->tp_maxalloc)
164 tp->tp_maxalloc = tp->tp_allocs - tp->tp_frees;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000165}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000166
167void dec_count(PyTypeObject *tp)
168{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000169 tp->tp_frees++;
170 if (unlist_types_without_objects &&
171 tp->tp_allocs == tp->tp_frees) {
172 /* unlink the type from type_list */
173 if (tp->tp_prev)
174 tp->tp_prev->tp_next = tp->tp_next;
175 else
176 type_list = tp->tp_next;
177 if (tp->tp_next)
178 tp->tp_next->tp_prev = tp->tp_prev;
179 tp->tp_next = tp->tp_prev = NULL;
180 Py_DECREF(tp);
181 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000182}
183
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000184#endif
185
Tim Peters7c321a82002-07-09 02:57:01 +0000186#ifdef Py_REF_DEBUG
187/* Log a fatal error; doesn't return. */
188void
189_Py_NegativeRefcount(const char *fname, int lineno, PyObject *op)
190{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000191 char buf[300];
Tim Peters7c321a82002-07-09 02:57:01 +0000192
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000193 PyOS_snprintf(buf, sizeof(buf),
194 "%s:%i object at %p has negative ref count "
195 "%" PY_FORMAT_SIZE_T "d",
196 fname, lineno, op, op->ob_refcnt);
197 Py_FatalError(buf);
Tim Peters7c321a82002-07-09 02:57:01 +0000198}
199
200#endif /* Py_REF_DEBUG */
201
Thomas Heller1328b522004-04-22 17:23:49 +0000202void
203Py_IncRef(PyObject *o)
204{
205 Py_XINCREF(o);
206}
207
208void
209Py_DecRef(PyObject *o)
210{
211 Py_XDECREF(o);
212}
213
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000214PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000215PyObject_Init(PyObject *op, PyTypeObject *tp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000216{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000217 if (op == NULL)
218 return PyErr_NoMemory();
219 /* Any changes should be reflected in PyObject_INIT (objimpl.h) */
220 Py_TYPE(op) = tp;
221 _Py_NewReference(op);
222 return op;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000223}
224
Guido van Rossumb18618d2000-05-03 23:44:39 +0000225PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000226PyObject_InitVar(PyVarObject *op, PyTypeObject *tp, Py_ssize_t size)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000227{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000228 if (op == NULL)
229 return (PyVarObject *) PyErr_NoMemory();
230 /* Any changes should be reflected in PyObject_INIT_VAR */
231 op->ob_size = size;
232 Py_TYPE(op) = tp;
233 _Py_NewReference((PyObject *)op);
234 return op;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000235}
236
237PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000238_PyObject_New(PyTypeObject *tp)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000239{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000240 PyObject *op;
241 op = (PyObject *) PyObject_MALLOC(_PyObject_SIZE(tp));
242 if (op == NULL)
243 return PyErr_NoMemory();
244 return PyObject_INIT(op, tp);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000245}
246
Guido van Rossumd0c87ee1997-05-15 21:31:03 +0000247PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000248_PyObject_NewVar(PyTypeObject *tp, Py_ssize_t nitems)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000249{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000250 PyVarObject *op;
251 const size_t size = _PyObject_VAR_SIZE(tp, nitems);
252 op = (PyVarObject *) PyObject_MALLOC(size);
253 if (op == NULL)
254 return (PyVarObject *)PyErr_NoMemory();
255 return PyObject_INIT_VAR(op, tp, nitems);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000256}
257
Antoine Pitrouc47bd4a2010-07-27 22:08:27 +0000258int
259PyObject_Print(PyObject *op, FILE *fp, int flags)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000260{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000261 int ret = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000262 if (PyErr_CheckSignals())
263 return -1;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000264#ifdef USE_STACKCHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000265 if (PyOS_CheckStack()) {
266 PyErr_SetString(PyExc_MemoryError, "stack overflow");
267 return -1;
268 }
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000269#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000270 clearerr(fp); /* Clear any previous error condition */
271 if (op == NULL) {
272 Py_BEGIN_ALLOW_THREADS
273 fprintf(fp, "<nil>");
274 Py_END_ALLOW_THREADS
275 }
276 else {
277 if (op->ob_refcnt <= 0)
278 /* XXX(twouters) cast refcount to long until %zd is
279 universally available */
280 Py_BEGIN_ALLOW_THREADS
281 fprintf(fp, "<refcnt %ld at %p>",
282 (long)op->ob_refcnt, op);
283 Py_END_ALLOW_THREADS
284 else {
285 PyObject *s;
286 if (flags & Py_PRINT_RAW)
287 s = PyObject_Str(op);
288 else
289 s = PyObject_Repr(op);
290 if (s == NULL)
291 ret = -1;
292 else if (PyBytes_Check(s)) {
293 fwrite(PyBytes_AS_STRING(s), 1,
294 PyBytes_GET_SIZE(s), fp);
295 }
296 else if (PyUnicode_Check(s)) {
297 PyObject *t;
Victor Stinner372ac5e2010-05-17 01:26:01 +0000298 t = PyUnicode_EncodeUTF8(PyUnicode_AS_UNICODE(s),
299 PyUnicode_GET_SIZE(s),
300 "backslashreplace");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000301 if (t == NULL)
302 ret = 0;
303 else {
304 fwrite(PyBytes_AS_STRING(t), 1,
305 PyBytes_GET_SIZE(t), fp);
Victor Stinnerba6b4302010-05-17 09:33:42 +0000306 Py_DECREF(t);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000307 }
308 }
309 else {
310 PyErr_Format(PyExc_TypeError,
311 "str() or repr() returned '%.100s'",
312 s->ob_type->tp_name);
313 ret = -1;
314 }
315 Py_XDECREF(s);
316 }
317 }
318 if (ret == 0) {
319 if (ferror(fp)) {
320 PyErr_SetFromErrno(PyExc_IOError);
321 clearerr(fp);
322 ret = -1;
323 }
324 }
325 return ret;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000326}
327
Guido van Rossum38938152006-08-21 23:36:26 +0000328/* For debugging convenience. Set a breakpoint here and call it from your DLL */
329void
Thomas Woutersb2137042007-02-01 18:02:27 +0000330_Py_BreakPoint(void)
Guido van Rossum38938152006-08-21 23:36:26 +0000331{
332}
333
Neal Norwitz1a997502003-01-13 20:13:12 +0000334
Barry Warsaw9bf16442001-01-23 16:24:35 +0000335/* For debugging convenience. See Misc/gdbinit for some useful gdb hooks */
Guido van Rossum38938152006-08-21 23:36:26 +0000336void
337_PyObject_Dump(PyObject* op)
Barry Warsaw9bf16442001-01-23 16:24:35 +0000338{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000339 if (op == NULL)
340 fprintf(stderr, "NULL\n");
341 else {
Georg Brandldfd73442009-04-05 11:47:34 +0000342#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000343 PyGILState_STATE gil;
Georg Brandldfd73442009-04-05 11:47:34 +0000344#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000345 fprintf(stderr, "object : ");
Georg Brandldfd73442009-04-05 11:47:34 +0000346#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000347 gil = PyGILState_Ensure();
Georg Brandldfd73442009-04-05 11:47:34 +0000348#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000349 (void)PyObject_Print(op, stderr, 0);
Georg Brandldfd73442009-04-05 11:47:34 +0000350#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000351 PyGILState_Release(gil);
Georg Brandldfd73442009-04-05 11:47:34 +0000352#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000353 /* XXX(twouters) cast refcount to long until %zd is
354 universally available */
355 fprintf(stderr, "\n"
356 "type : %s\n"
357 "refcount: %ld\n"
358 "address : %p\n",
359 Py_TYPE(op)==NULL ? "NULL" : Py_TYPE(op)->tp_name,
360 (long)op->ob_refcnt,
361 op);
362 }
Barry Warsaw9bf16442001-01-23 16:24:35 +0000363}
Barry Warsaw903138f2001-01-23 16:33:18 +0000364
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000365PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000366PyObject_Repr(PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000367{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000368 PyObject *res;
369 if (PyErr_CheckSignals())
370 return NULL;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000371#ifdef USE_STACKCHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000372 if (PyOS_CheckStack()) {
373 PyErr_SetString(PyExc_MemoryError, "stack overflow");
374 return NULL;
375 }
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000376#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000377 if (v == NULL)
378 return PyUnicode_FromString("<NULL>");
379 if (Py_TYPE(v)->tp_repr == NULL)
380 return PyUnicode_FromFormat("<%s object at %p>",
381 v->ob_type->tp_name, v);
382 res = (*v->ob_type->tp_repr)(v);
383 if (res != NULL && !PyUnicode_Check(res)) {
384 PyErr_Format(PyExc_TypeError,
385 "__repr__ returned non-string (type %.200s)",
386 res->ob_type->tp_name);
387 Py_DECREF(res);
388 return NULL;
389 }
390 return res;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000391}
392
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000393PyObject *
Guido van Rossum98297ee2007-11-06 21:34:58 +0000394PyObject_Str(PyObject *v)
Guido van Rossumc6004111993-11-05 10:22:19 +0000395{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000396 PyObject *res;
397 if (PyErr_CheckSignals())
398 return NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000399#ifdef USE_STACKCHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000400 if (PyOS_CheckStack()) {
401 PyErr_SetString(PyExc_MemoryError, "stack overflow");
402 return NULL;
403 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000404#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000405 if (v == NULL)
406 return PyUnicode_FromString("<NULL>");
407 if (PyUnicode_CheckExact(v)) {
408 Py_INCREF(v);
409 return v;
410 }
411 if (Py_TYPE(v)->tp_str == NULL)
412 return PyObject_Repr(v);
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000413
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000414 /* It is possible for a type to have a tp_str representation that loops
415 infinitely. */
416 if (Py_EnterRecursiveCall(" while getting the str of an object"))
417 return NULL;
418 res = (*Py_TYPE(v)->tp_str)(v);
419 Py_LeaveRecursiveCall();
420 if (res == NULL)
421 return NULL;
422 if (!PyUnicode_Check(res)) {
423 PyErr_Format(PyExc_TypeError,
424 "__str__ returned non-string (type %.200s)",
425 Py_TYPE(res)->tp_name);
426 Py_DECREF(res);
427 return NULL;
428 }
429 return res;
Neil Schemenauercf52c072005-08-12 17:34:58 +0000430}
431
Georg Brandl559e5d72008-06-11 18:37:52 +0000432PyObject *
433PyObject_ASCII(PyObject *v)
434{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000435 PyObject *repr, *ascii, *res;
Georg Brandl559e5d72008-06-11 18:37:52 +0000436
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000437 repr = PyObject_Repr(v);
438 if (repr == NULL)
439 return NULL;
Georg Brandl559e5d72008-06-11 18:37:52 +0000440
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000441 /* repr is guaranteed to be a PyUnicode object by PyObject_Repr */
442 ascii = PyUnicode_EncodeASCII(
443 PyUnicode_AS_UNICODE(repr),
444 PyUnicode_GET_SIZE(repr),
445 "backslashreplace");
Georg Brandl559e5d72008-06-11 18:37:52 +0000446
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000447 Py_DECREF(repr);
448 if (ascii == NULL)
449 return NULL;
Georg Brandl559e5d72008-06-11 18:37:52 +0000450
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000451 res = PyUnicode_DecodeASCII(
452 PyBytes_AS_STRING(ascii),
453 PyBytes_GET_SIZE(ascii),
454 NULL);
455
456 Py_DECREF(ascii);
457 return res;
Georg Brandl559e5d72008-06-11 18:37:52 +0000458}
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000459
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000460PyObject *
461PyObject_Bytes(PyObject *v)
462{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000463 PyObject *result, *func;
464 static PyObject *bytesstring = NULL;
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000465
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000466 if (v == NULL)
467 return PyBytes_FromString("<NULL>");
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000468
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000469 if (PyBytes_CheckExact(v)) {
470 Py_INCREF(v);
471 return v;
472 }
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000473
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000474 func = _PyObject_LookupSpecial(v, "__bytes__", &bytesstring);
475 if (func != NULL) {
476 result = PyObject_CallFunctionObjArgs(func, NULL);
477 Py_DECREF(func);
478 if (result == NULL)
Benjamin Peterson41ece392010-09-11 16:39:57 +0000479 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000480 if (!PyBytes_Check(result)) {
Benjamin Peterson41ece392010-09-11 16:39:57 +0000481 PyErr_Format(PyExc_TypeError,
482 "__bytes__ returned non-bytes (type %.200s)",
483 Py_TYPE(result)->tp_name);
484 Py_DECREF(result);
485 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000486 }
487 return result;
488 }
489 else if (PyErr_Occurred())
490 return NULL;
491 return PyBytes_FromObject(v);
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000492}
493
Mark Dickinsonc008a172009-02-01 13:59:22 +0000494/* For Python 3.0.1 and later, the old three-way comparison has been
495 completely removed in favour of rich comparisons. PyObject_Compare() and
496 PyObject_Cmp() are gone, and the builtin cmp function no longer exists.
Mark Dickinsone94c6792009-02-02 20:36:42 +0000497 The old tp_compare slot has been renamed to tp_reserved, and should no
Mark Dickinsonc008a172009-02-01 13:59:22 +0000498 longer be used. Use tp_richcompare instead.
Guido van Rossum98297ee2007-11-06 21:34:58 +0000499
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000500 See (*) below for practical amendments.
501
Mark Dickinsonc008a172009-02-01 13:59:22 +0000502 tp_richcompare gets called with a first argument of the appropriate type
503 and a second object of an arbitrary type. We never do any kind of
504 coercion.
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000505
Mark Dickinsonc008a172009-02-01 13:59:22 +0000506 The tp_richcompare slot should return an object, as follows:
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000507
508 NULL if an exception occurred
509 NotImplemented if the requested comparison is not implemented
510 any other false value if the requested comparison is false
511 any other true value if the requested comparison is true
512
513 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
514 NotImplemented.
515
516 (*) Practical amendments:
517
518 - If rich comparison returns NotImplemented, == and != are decided by
519 comparing the object pointer (i.e. falling back to the base object
520 implementation).
521
Guido van Rossuma4073002002-05-31 20:03:54 +0000522*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000523
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000524/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000525int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000526
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000527static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000528
529/* Perform a rich comparison, raising TypeError when the requested comparison
530 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000531static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000532do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000533{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000534 richcmpfunc f;
535 PyObject *res;
536 int checked_reverse_op = 0;
Guido van Rossume797ec12001-01-17 15:24:28 +0000537
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000538 if (v->ob_type != w->ob_type &&
539 PyType_IsSubtype(w->ob_type, v->ob_type) &&
540 (f = w->ob_type->tp_richcompare) != NULL) {
541 checked_reverse_op = 1;
542 res = (*f)(w, v, _Py_SwappedOp[op]);
543 if (res != Py_NotImplemented)
544 return res;
545 Py_DECREF(res);
546 }
547 if ((f = v->ob_type->tp_richcompare) != NULL) {
548 res = (*f)(v, w, op);
549 if (res != Py_NotImplemented)
550 return res;
551 Py_DECREF(res);
552 }
553 if (!checked_reverse_op && (f = w->ob_type->tp_richcompare) != NULL) {
554 res = (*f)(w, v, _Py_SwappedOp[op]);
555 if (res != Py_NotImplemented)
556 return res;
557 Py_DECREF(res);
558 }
559 /* If neither object implements it, provide a sensible default
560 for == and !=, but raise an exception for ordering. */
561 switch (op) {
562 case Py_EQ:
563 res = (v == w) ? Py_True : Py_False;
564 break;
565 case Py_NE:
566 res = (v != w) ? Py_True : Py_False;
567 break;
568 default:
569 /* XXX Special-case None so it doesn't show as NoneType() */
570 PyErr_Format(PyExc_TypeError,
571 "unorderable types: %.100s() %s %.100s()",
572 v->ob_type->tp_name,
573 opstrings[op],
574 w->ob_type->tp_name);
575 return NULL;
576 }
577 Py_INCREF(res);
578 return res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000579}
580
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000581/* Perform a rich comparison with object result. This wraps do_richcompare()
582 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000583
Guido van Rossume797ec12001-01-17 15:24:28 +0000584PyObject *
585PyObject_RichCompare(PyObject *v, PyObject *w, int op)
586{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000587 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000588
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000589 assert(Py_LT <= op && op <= Py_GE);
590 if (v == NULL || w == NULL) {
591 if (!PyErr_Occurred())
592 PyErr_BadInternalCall();
593 return NULL;
594 }
595 if (Py_EnterRecursiveCall(" in comparison"))
596 return NULL;
597 res = do_richcompare(v, w, op);
598 Py_LeaveRecursiveCall();
599 return res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000600}
601
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000602/* Perform a rich comparison with integer result. This wraps
603 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000604int
605PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
606{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000607 PyObject *res;
608 int ok;
Guido van Rossume797ec12001-01-17 15:24:28 +0000609
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000610 /* Quick result when objects are the same.
611 Guarantees that identity implies equality. */
612 if (v == w) {
613 if (op == Py_EQ)
614 return 1;
615 else if (op == Py_NE)
616 return 0;
617 }
Mark Dickinson4a1f5932008-11-12 23:23:36 +0000618
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000619 res = PyObject_RichCompare(v, w, op);
620 if (res == NULL)
621 return -1;
622 if (PyBool_Check(res))
623 ok = (res == Py_True);
624 else
625 ok = PyObject_IsTrue(res);
626 Py_DECREF(res);
627 return ok;
Guido van Rossume797ec12001-01-17 15:24:28 +0000628}
Fred Drake13634cf2000-06-29 19:17:04 +0000629
630/* Set of hash utility functions to help maintaining the invariant that
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000631 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000632
633 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
634*/
635
Mark Dickinsondc787d22010-05-23 13:33:13 +0000636/* For numeric types, the hash of a number x is based on the reduction
637 of x modulo the prime P = 2**_PyHASH_BITS - 1. It's designed so that
638 hash(x) == hash(y) whenever x and y are numerically equal, even if
639 x and y have different types.
640
641 A quick summary of the hashing strategy:
642
643 (1) First define the 'reduction of x modulo P' for any rational
644 number x; this is a standard extension of the usual notion of
645 reduction modulo P for integers. If x == p/q (written in lowest
646 terms), the reduction is interpreted as the reduction of p times
647 the inverse of the reduction of q, all modulo P; if q is exactly
648 divisible by P then define the reduction to be infinity. So we've
649 got a well-defined map
650
651 reduce : { rational numbers } -> { 0, 1, 2, ..., P-1, infinity }.
652
653 (2) Now for a rational number x, define hash(x) by:
654
655 reduce(x) if x >= 0
656 -reduce(-x) if x < 0
657
658 If the result of the reduction is infinity (this is impossible for
659 integers, floats and Decimals) then use the predefined hash value
660 _PyHASH_INF for x >= 0, or -_PyHASH_INF for x < 0, instead.
661 _PyHASH_INF, -_PyHASH_INF and _PyHASH_NAN are also used for the
662 hashes of float and Decimal infinities and nans.
663
664 A selling point for the above strategy is that it makes it possible
665 to compute hashes of decimal and binary floating-point numbers
666 efficiently, even if the exponent of the binary or decimal number
667 is large. The key point is that
668
669 reduce(x * y) == reduce(x) * reduce(y) (modulo _PyHASH_MODULUS)
670
671 provided that {reduce(x), reduce(y)} != {0, infinity}. The reduction of a
672 binary or decimal float is never infinity, since the denominator is a power
673 of 2 (for binary) or a divisor of a power of 10 (for decimal). So we have,
674 for nonnegative x,
675
676 reduce(x * 2**e) == reduce(x) * reduce(2**e) % _PyHASH_MODULUS
677
678 reduce(x * 10**e) == reduce(x) * reduce(10**e) % _PyHASH_MODULUS
679
680 and reduce(10**e) can be computed efficiently by the usual modular
681 exponentiation algorithm. For reduce(2**e) it's even better: since
682 P is of the form 2**n-1, reduce(2**e) is 2**(e mod n), and multiplication
683 by 2**(e mod n) modulo 2**n-1 just amounts to a rotation of bits.
684
685 */
686
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000687Py_hash_t
Fred Drake100814d2000-07-09 15:48:49 +0000688_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000689{
Mark Dickinsondc787d22010-05-23 13:33:13 +0000690 int e, sign;
691 double m;
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000692 Py_uhash_t x, y;
Tim Peters39dce292000-08-15 03:34:48 +0000693
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000694 if (!Py_IS_FINITE(v)) {
695 if (Py_IS_INFINITY(v))
Mark Dickinsondc787d22010-05-23 13:33:13 +0000696 return v > 0 ? _PyHASH_INF : -_PyHASH_INF;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000697 else
Mark Dickinsondc787d22010-05-23 13:33:13 +0000698 return _PyHASH_NAN;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000699 }
Mark Dickinsondc787d22010-05-23 13:33:13 +0000700
701 m = frexp(v, &e);
702
703 sign = 1;
704 if (m < 0) {
705 sign = -1;
706 m = -m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000707 }
Mark Dickinsondc787d22010-05-23 13:33:13 +0000708
709 /* process 28 bits at a time; this should work well both for binary
710 and hexadecimal floating point. */
711 x = 0;
712 while (m) {
713 x = ((x << 28) & _PyHASH_MODULUS) | x >> (_PyHASH_BITS - 28);
714 m *= 268435456.0; /* 2**28 */
715 e -= 28;
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000716 y = (Py_uhash_t)m; /* pull out integer part */
Mark Dickinsondc787d22010-05-23 13:33:13 +0000717 m -= y;
718 x += y;
719 if (x >= _PyHASH_MODULUS)
720 x -= _PyHASH_MODULUS;
721 }
722
723 /* adjust for the exponent; first reduce it modulo _PyHASH_BITS */
724 e = e >= 0 ? e % _PyHASH_BITS : _PyHASH_BITS-1-((-1-e) % _PyHASH_BITS);
725 x = ((x << e) & _PyHASH_MODULUS) | x >> (_PyHASH_BITS - e);
726
727 x = x * sign;
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000728 if (x == (Py_uhash_t)-1)
729 x = (Py_uhash_t)-2;
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000730 return (Py_hash_t)x;
Fred Drake13634cf2000-06-29 19:17:04 +0000731}
732
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000733Py_hash_t
Fred Drake100814d2000-07-09 15:48:49 +0000734_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000735{
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000736 Py_hash_t x;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000737 size_t y = (size_t)p;
738 /* bottom 3 or 4 bits are likely to be 0; rotate y by 4 to avoid
739 excessive hash collisions for dicts and sets */
740 y = (y >> 4) | (y << (8 * SIZEOF_VOID_P - 4));
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000741 x = (Py_hash_t)y;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000742 if (x == -1)
743 x = -2;
744 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000745}
746
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000747Py_hash_t
Nick Coghland1abd252008-07-15 15:46:38 +0000748PyObject_HashNotImplemented(PyObject *v)
749{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000750 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
751 Py_TYPE(v)->tp_name);
752 return -1;
Nick Coghland1abd252008-07-15 15:46:38 +0000753}
Fred Drake13634cf2000-06-29 19:17:04 +0000754
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000755Py_hash_t
Fred Drake100814d2000-07-09 15:48:49 +0000756PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000757{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000758 PyTypeObject *tp = Py_TYPE(v);
759 if (tp->tp_hash != NULL)
760 return (*tp->tp_hash)(v);
761 /* To keep to the general practice that inheriting
762 * solely from object in C code should work without
763 * an explicit call to PyType_Ready, we implicitly call
764 * PyType_Ready here and then check the tp_hash slot again
765 */
766 if (tp->tp_dict == NULL) {
767 if (PyType_Ready(tp) < 0)
768 return -1;
769 if (tp->tp_hash != NULL)
770 return (*tp->tp_hash)(v);
771 }
772 /* Otherwise, the object can't be hashed */
773 return PyObject_HashNotImplemented(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000774}
775
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000776PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000777PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000778{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000779 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000780
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000781 if (Py_TYPE(v)->tp_getattr != NULL)
782 return (*Py_TYPE(v)->tp_getattr)(v, (char*)name);
783 w = PyUnicode_InternFromString(name);
784 if (w == NULL)
785 return NULL;
786 res = PyObject_GetAttr(v, w);
787 Py_XDECREF(w);
788 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000789}
790
791int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000792PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000793{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000794 PyObject *res = PyObject_GetAttrString(v, name);
795 if (res != NULL) {
796 Py_DECREF(res);
797 return 1;
798 }
799 PyErr_Clear();
800 return 0;
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000801}
802
803int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000804PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000805{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000806 PyObject *s;
807 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000808
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000809 if (Py_TYPE(v)->tp_setattr != NULL)
810 return (*Py_TYPE(v)->tp_setattr)(v, (char*)name, w);
811 s = PyUnicode_InternFromString(name);
812 if (s == NULL)
813 return -1;
814 res = PyObject_SetAttr(v, s, w);
815 Py_XDECREF(s);
816 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000817}
818
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000819PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000820PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000821{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000822 PyTypeObject *tp = Py_TYPE(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000823
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000824 if (!PyUnicode_Check(name)) {
825 PyErr_Format(PyExc_TypeError,
826 "attribute name must be string, not '%.200s'",
827 name->ob_type->tp_name);
828 return NULL;
829 }
830 if (tp->tp_getattro != NULL)
831 return (*tp->tp_getattro)(v, name);
832 if (tp->tp_getattr != NULL) {
833 char *name_str = _PyUnicode_AsString(name);
834 if (name_str == NULL)
835 return NULL;
836 return (*tp->tp_getattr)(v, name_str);
837 }
838 PyErr_Format(PyExc_AttributeError,
839 "'%.50s' object has no attribute '%U'",
840 tp->tp_name, name);
841 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000842}
843
844int
Fred Drake100814d2000-07-09 15:48:49 +0000845PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000846{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000847 PyObject *res = PyObject_GetAttr(v, name);
848 if (res != NULL) {
849 Py_DECREF(res);
850 return 1;
851 }
852 PyErr_Clear();
853 return 0;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000854}
855
856int
Fred Drake100814d2000-07-09 15:48:49 +0000857PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000858{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000859 PyTypeObject *tp = Py_TYPE(v);
860 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000861
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000862 if (!PyUnicode_Check(name)) {
863 PyErr_Format(PyExc_TypeError,
864 "attribute name must be string, not '%.200s'",
865 name->ob_type->tp_name);
866 return -1;
867 }
868 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000869
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000870 PyUnicode_InternInPlace(&name);
871 if (tp->tp_setattro != NULL) {
872 err = (*tp->tp_setattro)(v, name, value);
873 Py_DECREF(name);
874 return err;
875 }
876 if (tp->tp_setattr != NULL) {
877 char *name_str = _PyUnicode_AsString(name);
878 if (name_str == NULL)
879 return -1;
880 err = (*tp->tp_setattr)(v, name_str, value);
881 Py_DECREF(name);
882 return err;
883 }
884 Py_DECREF(name);
885 assert(name->ob_refcnt >= 1);
886 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
887 PyErr_Format(PyExc_TypeError,
888 "'%.100s' object has no attributes "
889 "(%s .%U)",
890 tp->tp_name,
891 value==NULL ? "del" : "assign to",
892 name);
893 else
894 PyErr_Format(PyExc_TypeError,
895 "'%.100s' object has only read-only attributes "
896 "(%s .%U)",
897 tp->tp_name,
898 value==NULL ? "del" : "assign to",
899 name);
900 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000901}
902
903/* Helper to get a pointer to an object's __dict__ slot, if any */
904
905PyObject **
906_PyObject_GetDictPtr(PyObject *obj)
907{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000908 Py_ssize_t dictoffset;
909 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000910
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000911 dictoffset = tp->tp_dictoffset;
912 if (dictoffset == 0)
913 return NULL;
914 if (dictoffset < 0) {
915 Py_ssize_t tsize;
916 size_t size;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000917
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000918 tsize = ((PyVarObject *)obj)->ob_size;
919 if (tsize < 0)
920 tsize = -tsize;
921 size = _PyObject_VAR_SIZE(tp, tsize);
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000922
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000923 dictoffset += (long)size;
924 assert(dictoffset > 0);
925 assert(dictoffset % SIZEOF_VOID_P == 0);
926 }
927 return (PyObject **) ((char *)obj + dictoffset);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000928}
929
Tim Peters6d6c1a32001-08-02 04:15:00 +0000930PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000931PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +0000932{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000933 Py_INCREF(obj);
934 return obj;
Raymond Hettinger01538262003-03-17 08:24:35 +0000935}
936
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +0000937/* Helper used when the __next__ method is removed from a type:
938 tp_iternext is never NULL and can be safely called without checking
939 on every iteration.
940 */
941
942PyObject *
943_PyObject_NextNotImplemented(PyObject *self)
944{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000945 PyErr_Format(PyExc_TypeError,
946 "'%.200s' object is not iterable",
947 Py_TYPE(self)->tp_name);
948 return NULL;
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +0000949}
950
Michael W. Hudson1593f502004-09-14 17:09:47 +0000951/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
952
Raymond Hettinger01538262003-03-17 08:24:35 +0000953PyObject *
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +0000954_PyObject_GenericGetAttrWithDict(PyObject *obj, PyObject *name, PyObject *dict)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000955{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000956 PyTypeObject *tp = Py_TYPE(obj);
957 PyObject *descr = NULL;
958 PyObject *res = NULL;
959 descrgetfunc f;
960 Py_ssize_t dictoffset;
961 PyObject **dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000962
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000963 if (!PyUnicode_Check(name)){
964 PyErr_Format(PyExc_TypeError,
965 "attribute name must be string, not '%.200s'",
966 name->ob_type->tp_name);
967 return NULL;
968 }
969 else
970 Py_INCREF(name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000971
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000972 if (tp->tp_dict == NULL) {
973 if (PyType_Ready(tp) < 0)
974 goto done;
975 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000976
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000977 descr = _PyType_Lookup(tp, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000978 Py_XINCREF(descr);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000979
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000980 f = NULL;
981 if (descr != NULL) {
982 f = descr->ob_type->tp_descr_get;
983 if (f != NULL && PyDescr_IsData(descr)) {
984 res = f(descr, obj, (PyObject *)obj->ob_type);
985 Py_DECREF(descr);
986 goto done;
987 }
988 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000989
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +0000990 if (dict == NULL) {
991 /* Inline _PyObject_GetDictPtr */
992 dictoffset = tp->tp_dictoffset;
993 if (dictoffset != 0) {
994 if (dictoffset < 0) {
995 Py_ssize_t tsize;
996 size_t size;
Guido van Rossumc66ff442002-08-19 16:50:48 +0000997
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +0000998 tsize = ((PyVarObject *)obj)->ob_size;
999 if (tsize < 0)
1000 tsize = -tsize;
1001 size = _PyObject_VAR_SIZE(tp, tsize);
Guido van Rossumc66ff442002-08-19 16:50:48 +00001002
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001003 dictoffset += (long)size;
1004 assert(dictoffset > 0);
1005 assert(dictoffset % SIZEOF_VOID_P == 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001006 }
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001007 dictptr = (PyObject **) ((char *)obj + dictoffset);
1008 dict = *dictptr;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001009 }
1010 }
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001011 if (dict != NULL) {
1012 Py_INCREF(dict);
1013 res = PyDict_GetItem(dict, name);
1014 if (res != NULL) {
1015 Py_INCREF(res);
1016 Py_XDECREF(descr);
1017 Py_DECREF(dict);
1018 goto done;
1019 }
1020 Py_DECREF(dict);
1021 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001022
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001023 if (f != NULL) {
1024 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
1025 Py_DECREF(descr);
1026 goto done;
1027 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001028
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001029 if (descr != NULL) {
1030 res = descr;
1031 /* descr was already increfed above */
1032 goto done;
1033 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001034
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001035 PyErr_Format(PyExc_AttributeError,
1036 "'%.50s' object has no attribute '%U'",
1037 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001038 done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001039 Py_DECREF(name);
1040 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001041}
1042
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001043PyObject *
1044PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
1045{
1046 return _PyObject_GenericGetAttrWithDict(obj, name, NULL);
1047}
1048
Tim Peters6d6c1a32001-08-02 04:15:00 +00001049int
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001050_PyObject_GenericSetAttrWithDict(PyObject *obj, PyObject *name,
1051 PyObject *value, PyObject *dict)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001052{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001053 PyTypeObject *tp = Py_TYPE(obj);
1054 PyObject *descr;
1055 descrsetfunc f;
1056 PyObject **dictptr;
1057 int res = -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001058
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001059 if (!PyUnicode_Check(name)){
1060 PyErr_Format(PyExc_TypeError,
1061 "attribute name must be string, not '%.200s'",
1062 name->ob_type->tp_name);
1063 return -1;
1064 }
1065 else
1066 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001067
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001068 if (tp->tp_dict == NULL) {
1069 if (PyType_Ready(tp) < 0)
1070 goto done;
1071 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001072
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001073 descr = _PyType_Lookup(tp, name);
1074 f = NULL;
1075 if (descr != NULL) {
1076 f = descr->ob_type->tp_descr_set;
1077 if (f != NULL && PyDescr_IsData(descr)) {
1078 res = f(descr, obj, value);
1079 goto done;
1080 }
1081 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001082
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001083 if (dict == NULL) {
1084 dictptr = _PyObject_GetDictPtr(obj);
1085 if (dictptr != NULL) {
1086 dict = *dictptr;
1087 if (dict == NULL && value != NULL) {
1088 dict = PyDict_New();
1089 if (dict == NULL)
1090 goto done;
1091 *dictptr = dict;
1092 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001093 }
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001094 }
1095 if (dict != NULL) {
1096 Py_INCREF(dict);
1097 if (value == NULL)
1098 res = PyDict_DelItem(dict, name);
1099 else
1100 res = PyDict_SetItem(dict, name, value);
1101 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1102 PyErr_SetObject(PyExc_AttributeError, name);
1103 Py_DECREF(dict);
1104 goto done;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001105 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001106
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001107 if (f != NULL) {
1108 res = f(descr, obj, value);
1109 goto done;
1110 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001111
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001112 if (descr == NULL) {
1113 PyErr_Format(PyExc_AttributeError,
1114 "'%.100s' object has no attribute '%U'",
1115 tp->tp_name, name);
1116 goto done;
1117 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001118
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001119 PyErr_Format(PyExc_AttributeError,
1120 "'%.50s' object attribute '%U' is read-only",
1121 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001122 done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001123 Py_DECREF(name);
1124 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001125}
1126
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001127int
1128PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1129{
1130 return _PyObject_GenericSetAttrWithDict(obj, name, value, NULL);
1131}
1132
1133
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001134/* Test a value used as condition, e.g., in a for or if statement.
1135 Return -1 if an error occurred */
1136
1137int
Fred Drake100814d2000-07-09 15:48:49 +00001138PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001139{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001140 Py_ssize_t res;
1141 if (v == Py_True)
1142 return 1;
1143 if (v == Py_False)
1144 return 0;
1145 if (v == Py_None)
1146 return 0;
1147 else if (v->ob_type->tp_as_number != NULL &&
1148 v->ob_type->tp_as_number->nb_bool != NULL)
1149 res = (*v->ob_type->tp_as_number->nb_bool)(v);
1150 else if (v->ob_type->tp_as_mapping != NULL &&
1151 v->ob_type->tp_as_mapping->mp_length != NULL)
1152 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
1153 else if (v->ob_type->tp_as_sequence != NULL &&
1154 v->ob_type->tp_as_sequence->sq_length != NULL)
1155 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1156 else
1157 return 1;
1158 /* if it is negative, it should be either -1 or -2 */
1159 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001160}
1161
Tim Peters803526b2002-07-07 05:13:56 +00001162/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001163 Return -1 if an error occurred */
1164
1165int
Fred Drake100814d2000-07-09 15:48:49 +00001166PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001167{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001168 int res;
1169 res = PyObject_IsTrue(v);
1170 if (res < 0)
1171 return res;
1172 return res == 0;
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001173}
1174
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001175/* Test whether an object can be called */
1176
1177int
Fred Drake100814d2000-07-09 15:48:49 +00001178PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001179{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001180 if (x == NULL)
1181 return 0;
1182 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001183}
1184
Tim Peters7eea37e2001-09-04 22:08:56 +00001185
Georg Brandle32b4222007-03-10 22:13:27 +00001186/* Helper for PyObject_Dir without arguments: returns the local scope. */
1187static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001188_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001189{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001190 PyObject *names;
1191 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001192
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001193 if (locals == NULL) {
1194 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1195 return NULL;
1196 }
Tim Peters305b5852001-09-17 02:38:46 +00001197
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001198 names = PyMapping_Keys(locals);
1199 if (!names)
1200 return NULL;
1201 if (!PyList_Check(names)) {
1202 PyErr_Format(PyExc_TypeError,
1203 "dir(): expected keys() of locals to be a list, "
1204 "not '%.200s'", Py_TYPE(names)->tp_name);
1205 Py_DECREF(names);
1206 return NULL;
1207 }
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001208 if (PyList_Sort(names)) {
1209 Py_DECREF(names);
1210 return NULL;
1211 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001212 /* the locals don't need to be DECREF'd */
1213 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001214}
1215
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001216/* Helper for PyObject_Dir: object introspection. */
Georg Brandle32b4222007-03-10 22:13:27 +00001217static PyObject *
1218_dir_object(PyObject *obj)
1219{
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001220 PyObject *result, *sorted;
Benjamin Peterson7963a352011-05-23 16:11:05 -05001221 static PyObject *dir_str = NULL;
1222 PyObject *dirfunc = _PyObject_LookupSpecial(obj, "__dir__", &dir_str);
Georg Brandle32b4222007-03-10 22:13:27 +00001223
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001224 assert(obj);
1225 if (dirfunc == NULL) {
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001226 if (!PyErr_Occurred())
1227 PyErr_SetString(PyExc_TypeError, "object does not provide __dir__");
1228 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001229 }
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001230 /* use __dir__ */
1231 result = PyObject_CallFunctionObjArgs(dirfunc, NULL);
1232 Py_DECREF(dirfunc);
1233 if (result == NULL)
1234 return NULL;
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001235 /* return sorted(result) */
1236 sorted = PySequence_List(result);
1237 Py_DECREF(result);
1238 if (sorted == NULL)
1239 return NULL;
1240 if (PyList_Sort(sorted)) {
1241 Py_DECREF(sorted);
1242 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001243 }
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001244 return sorted;
Georg Brandle32b4222007-03-10 22:13:27 +00001245}
1246
1247/* Implementation of dir() -- if obj is NULL, returns the names in the current
1248 (local) scope. Otherwise, performs introspection of the object: returns a
1249 sorted list of attribute names (supposedly) accessible from the object
1250*/
1251PyObject *
1252PyObject_Dir(PyObject *obj)
1253{
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001254 return (obj == NULL) ? _dir_locals() : _dir_object(obj);
Tim Peters7eea37e2001-09-04 22:08:56 +00001255}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001256
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001257/*
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001258None is a non-NULL undefined value.
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001259There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001260so there is exactly one (which is indestructible, by the way).
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001261*/
1262
Guido van Rossum0c182a11992-03-27 17:26:13 +00001263/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001264static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001265none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001266{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001267 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001268}
1269
Barry Warsaw9bf16442001-01-23 16:24:35 +00001270/* ARGUSED */
1271static void
Tim Peters803526b2002-07-07 05:13:56 +00001272none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001273{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001274 /* This should never get called, but we also don't want to SEGV if
1275 * we accidentally decref None out of existence.
1276 */
1277 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001278}
1279
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001280static int
1281none_bool(PyObject *v)
1282{
1283 return 0;
1284}
1285
1286static PyNumberMethods none_as_number = {
1287 0, /* nb_add */
1288 0, /* nb_subtract */
1289 0, /* nb_multiply */
1290 0, /* nb_remainder */
1291 0, /* nb_divmod */
1292 0, /* nb_power */
1293 0, /* nb_negative */
1294 0, /* nb_positive */
1295 0, /* nb_absolute */
1296 (inquiry)none_bool, /* nb_bool */
1297 0, /* nb_invert */
1298 0, /* nb_lshift */
1299 0, /* nb_rshift */
1300 0, /* nb_and */
1301 0, /* nb_xor */
1302 0, /* nb_or */
1303 0, /* nb_int */
1304 0, /* nb_reserved */
1305 0, /* nb_float */
1306 0, /* nb_inplace_add */
1307 0, /* nb_inplace_subtract */
1308 0, /* nb_inplace_multiply */
1309 0, /* nb_inplace_remainder */
1310 0, /* nb_inplace_power */
1311 0, /* nb_inplace_lshift */
1312 0, /* nb_inplace_rshift */
1313 0, /* nb_inplace_and */
1314 0, /* nb_inplace_xor */
1315 0, /* nb_inplace_or */
1316 0, /* nb_floor_divide */
1317 0, /* nb_true_divide */
1318 0, /* nb_inplace_floor_divide */
1319 0, /* nb_inplace_true_divide */
1320 0, /* nb_index */
1321};
Barry Warsaw9bf16442001-01-23 16:24:35 +00001322
Guido van Rossumba21a492001-08-16 08:17:26 +00001323static PyTypeObject PyNone_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001324 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1325 "NoneType",
1326 0,
1327 0,
1328 none_dealloc, /*tp_dealloc*/ /*never called*/
1329 0, /*tp_print*/
1330 0, /*tp_getattr*/
1331 0, /*tp_setattr*/
1332 0, /*tp_reserved*/
1333 none_repr, /*tp_repr*/
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001334 &none_as_number, /*tp_as_number*/
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001335 0, /*tp_as_sequence*/
1336 0, /*tp_as_mapping*/
1337 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001338};
1339
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001340PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001341 _PyObject_EXTRA_INIT
1342 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001343};
1344
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001345/* NotImplemented is an object that can be used to signal that an
1346 operation is not implemented for the given type combination. */
1347
1348static PyObject *
1349NotImplemented_repr(PyObject *op)
1350{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001351 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001352}
1353
1354static PyTypeObject PyNotImplemented_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001355 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1356 "NotImplementedType",
1357 0,
1358 0,
1359 none_dealloc, /*tp_dealloc*/ /*never called*/
1360 0, /*tp_print*/
1361 0, /*tp_getattr*/
1362 0, /*tp_setattr*/
1363 0, /*tp_reserved*/
1364 NotImplemented_repr, /*tp_repr*/
1365 0, /*tp_as_number*/
1366 0, /*tp_as_sequence*/
1367 0, /*tp_as_mapping*/
1368 0, /*tp_hash */
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001369};
1370
1371PyObject _Py_NotImplementedStruct = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001372 _PyObject_EXTRA_INIT
1373 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001374};
1375
Guido van Rossumba21a492001-08-16 08:17:26 +00001376void
1377_Py_ReadyTypes(void)
1378{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001379 if (PyType_Ready(&PyType_Type) < 0)
1380 Py_FatalError("Can't initialize type type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001381
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001382 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1383 Py_FatalError("Can't initialize weakref type");
Fred Drake0a4dd392004-07-02 18:57:45 +00001384
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001385 if (PyType_Ready(&_PyWeakref_CallableProxyType) < 0)
1386 Py_FatalError("Can't initialize callable weakref proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001387
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001388 if (PyType_Ready(&_PyWeakref_ProxyType) < 0)
1389 Py_FatalError("Can't initialize weakref proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001390
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001391 if (PyType_Ready(&PyBool_Type) < 0)
1392 Py_FatalError("Can't initialize bool type");
Guido van Rossum77f6a652002-04-03 22:41:51 +00001393
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001394 if (PyType_Ready(&PyByteArray_Type) < 0)
1395 Py_FatalError("Can't initialize bytearray type");
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001396
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001397 if (PyType_Ready(&PyBytes_Type) < 0)
1398 Py_FatalError("Can't initialize 'str'");
Guido van Rossumcacfc072002-05-24 19:01:59 +00001399
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001400 if (PyType_Ready(&PyList_Type) < 0)
1401 Py_FatalError("Can't initialize list type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001402
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001403 if (PyType_Ready(&PyNone_Type) < 0)
1404 Py_FatalError("Can't initialize None type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001405
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001406 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1407 Py_FatalError("Can't initialize type(Ellipsis)");
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001408
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001409 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1410 Py_FatalError("Can't initialize NotImplemented type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001411
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001412 if (PyType_Ready(&PyTraceBack_Type) < 0)
1413 Py_FatalError("Can't initialize traceback type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001414
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001415 if (PyType_Ready(&PySuper_Type) < 0)
1416 Py_FatalError("Can't initialize super type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001417
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001418 if (PyType_Ready(&PyBaseObject_Type) < 0)
1419 Py_FatalError("Can't initialize object type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001420
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001421 if (PyType_Ready(&PyRange_Type) < 0)
1422 Py_FatalError("Can't initialize range type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001423
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001424 if (PyType_Ready(&PyDict_Type) < 0)
1425 Py_FatalError("Can't initialize dict type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001426
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001427 if (PyType_Ready(&PySet_Type) < 0)
1428 Py_FatalError("Can't initialize set type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001429
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001430 if (PyType_Ready(&PyUnicode_Type) < 0)
1431 Py_FatalError("Can't initialize str type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001432
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001433 if (PyType_Ready(&PySlice_Type) < 0)
1434 Py_FatalError("Can't initialize slice type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001435
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001436 if (PyType_Ready(&PyStaticMethod_Type) < 0)
1437 Py_FatalError("Can't initialize static method type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001438
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001439 if (PyType_Ready(&PyComplex_Type) < 0)
1440 Py_FatalError("Can't initialize complex type");
Skip Montanaroba1e0f42009-10-18 14:25:35 +00001441
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001442 if (PyType_Ready(&PyFloat_Type) < 0)
1443 Py_FatalError("Can't initialize float type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001444
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001445 if (PyType_Ready(&PyLong_Type) < 0)
1446 Py_FatalError("Can't initialize int type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001447
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001448 if (PyType_Ready(&PyFrozenSet_Type) < 0)
1449 Py_FatalError("Can't initialize frozenset type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001450
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001451 if (PyType_Ready(&PyProperty_Type) < 0)
1452 Py_FatalError("Can't initialize property type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001453
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001454 if (PyType_Ready(&PyMemoryView_Type) < 0)
1455 Py_FatalError("Can't initialize memoryview type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001456
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001457 if (PyType_Ready(&PyTuple_Type) < 0)
1458 Py_FatalError("Can't initialize tuple type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001459
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001460 if (PyType_Ready(&PyEnum_Type) < 0)
1461 Py_FatalError("Can't initialize enumerate type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001462
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001463 if (PyType_Ready(&PyReversed_Type) < 0)
1464 Py_FatalError("Can't initialize reversed type");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001465
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001466 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1467 Py_FatalError("Can't initialize StdPrinter");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001468
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001469 if (PyType_Ready(&PyCode_Type) < 0)
1470 Py_FatalError("Can't initialize code type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001471
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001472 if (PyType_Ready(&PyFrame_Type) < 0)
1473 Py_FatalError("Can't initialize frame type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001474
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001475 if (PyType_Ready(&PyCFunction_Type) < 0)
1476 Py_FatalError("Can't initialize builtin function type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001477
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001478 if (PyType_Ready(&PyMethod_Type) < 0)
1479 Py_FatalError("Can't initialize method type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001480
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001481 if (PyType_Ready(&PyFunction_Type) < 0)
1482 Py_FatalError("Can't initialize function type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001483
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001484 if (PyType_Ready(&PyDictProxy_Type) < 0)
1485 Py_FatalError("Can't initialize dict proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001486
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001487 if (PyType_Ready(&PyGen_Type) < 0)
1488 Py_FatalError("Can't initialize generator type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001489
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001490 if (PyType_Ready(&PyGetSetDescr_Type) < 0)
1491 Py_FatalError("Can't initialize get-set descriptor type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001492
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001493 if (PyType_Ready(&PyWrapperDescr_Type) < 0)
1494 Py_FatalError("Can't initialize wrapper type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001495
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001496 if (PyType_Ready(&PyEllipsis_Type) < 0)
1497 Py_FatalError("Can't initialize ellipsis type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001498
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001499 if (PyType_Ready(&PyMemberDescr_Type) < 0)
1500 Py_FatalError("Can't initialize member descriptor type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001501
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001502 if (PyType_Ready(&PyFilter_Type) < 0)
1503 Py_FatalError("Can't initialize filter type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001504
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001505 if (PyType_Ready(&PyMap_Type) < 0)
1506 Py_FatalError("Can't initialize map type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001507
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001508 if (PyType_Ready(&PyZip_Type) < 0)
1509 Py_FatalError("Can't initialize zip type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001510}
1511
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001512
Guido van Rossum84a90321996-05-22 16:34:47 +00001513#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001514
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001515void
Fred Drake100814d2000-07-09 15:48:49 +00001516_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001517{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001518 _Py_INC_REFTOTAL;
1519 op->ob_refcnt = 1;
1520 _Py_AddToAllObjects(op, 1);
1521 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001522}
1523
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001524void
Fred Drake100814d2000-07-09 15:48:49 +00001525_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001526{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001527#ifdef SLOW_UNREF_CHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001528 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001529#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001530 if (op->ob_refcnt < 0)
1531 Py_FatalError("UNREF negative refcnt");
1532 if (op == &refchain ||
1533 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1534 fprintf(stderr, "* ob\n");
1535 _PyObject_Dump(op);
1536 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1537 _PyObject_Dump(op->_ob_prev->_ob_next);
1538 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1539 _PyObject_Dump(op->_ob_next->_ob_prev);
1540 Py_FatalError("UNREF invalid object");
1541 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001542#ifdef SLOW_UNREF_CHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001543 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1544 if (p == op)
1545 break;
1546 }
1547 if (p == &refchain) /* Not found */
1548 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001549#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001550 op->_ob_next->_ob_prev = op->_ob_prev;
1551 op->_ob_prev->_ob_next = op->_ob_next;
1552 op->_ob_next = op->_ob_prev = NULL;
1553 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001554}
1555
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001556void
Fred Drake100814d2000-07-09 15:48:49 +00001557_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001558{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001559 destructor dealloc = Py_TYPE(op)->tp_dealloc;
1560 _Py_ForgetReference(op);
1561 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001562}
1563
Tim Peters269b2a62003-04-17 19:52:29 +00001564/* Print all live objects. Because PyObject_Print is called, the
1565 * interpreter must be in a healthy state.
1566 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001567void
Fred Drake100814d2000-07-09 15:48:49 +00001568_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001569{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001570 PyObject *op;
1571 fprintf(fp, "Remaining objects:\n");
1572 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
1573 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
1574 if (PyObject_Print(op, fp, 0) != 0)
1575 PyErr_Clear();
1576 putc('\n', fp);
1577 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001578}
1579
Tim Peters269b2a62003-04-17 19:52:29 +00001580/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1581 * doesn't make any calls to the Python C API, so is always safe to call.
1582 */
1583void
1584_Py_PrintReferenceAddresses(FILE *fp)
1585{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001586 PyObject *op;
1587 fprintf(fp, "Remaining object addresses:\n");
1588 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
1589 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
1590 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001591}
1592
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001593PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001594_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001595{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001596 int i, n;
1597 PyObject *t = NULL;
1598 PyObject *res, *op;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001599
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001600 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1601 return NULL;
1602 op = refchain._ob_next;
1603 res = PyList_New(0);
1604 if (res == NULL)
1605 return NULL;
1606 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1607 while (op == self || op == args || op == res || op == t ||
1608 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
1609 op = op->_ob_next;
1610 if (op == &refchain)
1611 return res;
1612 }
1613 if (PyList_Append(res, op) < 0) {
1614 Py_DECREF(res);
1615 return NULL;
1616 }
1617 op = op->_ob_next;
1618 }
1619 return res;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001620}
1621
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001622#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001623
Benjamin Petersonb173f782009-05-05 22:31:58 +00001624/* Hack to force loading of pycapsule.o */
1625PyTypeObject *_PyCapsule_hack = &PyCapsule_Type;
1626
1627
Guido van Rossum84a90321996-05-22 16:34:47 +00001628/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001629Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001630
1631
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001632/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001633
Thomas Wouters334fb892000-07-25 12:56:38 +00001634void *
Fred Drake100814d2000-07-09 15:48:49 +00001635PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001636{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001637 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001638}
1639
Thomas Wouters334fb892000-07-25 12:56:38 +00001640void *
1641PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001642{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001643 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001644}
1645
1646void
Thomas Wouters334fb892000-07-25 12:56:38 +00001647PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001648{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001649 PyMem_FREE(p);
Guido van Rossumb18618d2000-05-03 23:44:39 +00001650}
1651
1652
Guido van Rossum86610361998-04-10 22:32:46 +00001653/* These methods are used to control infinite recursion in repr, str, print,
1654 etc. Container objects that may recursively contain themselves,
1655 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1656 Py_ReprLeave() to avoid infinite recursion.
1657
1658 Py_ReprEnter() returns 0 the first time it is called for a particular
1659 object and 1 every time thereafter. It returns -1 if an exception
1660 occurred. Py_ReprLeave() has no return value.
1661
1662 See dictobject.c and listobject.c for examples of use.
1663*/
1664
1665#define KEY "Py_Repr"
1666
1667int
Fred Drake100814d2000-07-09 15:48:49 +00001668Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001669{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001670 PyObject *dict;
1671 PyObject *list;
1672 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001673
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001674 dict = PyThreadState_GetDict();
1675 if (dict == NULL)
1676 return 0;
1677 list = PyDict_GetItemString(dict, KEY);
1678 if (list == NULL) {
1679 list = PyList_New(0);
1680 if (list == NULL)
1681 return -1;
1682 if (PyDict_SetItemString(dict, KEY, list) < 0)
1683 return -1;
1684 Py_DECREF(list);
1685 }
1686 i = PyList_GET_SIZE(list);
1687 while (--i >= 0) {
1688 if (PyList_GET_ITEM(list, i) == obj)
1689 return 1;
1690 }
1691 PyList_Append(list, obj);
1692 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001693}
1694
1695void
Fred Drake100814d2000-07-09 15:48:49 +00001696Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001697{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001698 PyObject *dict;
1699 PyObject *list;
1700 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001701
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001702 dict = PyThreadState_GetDict();
1703 if (dict == NULL)
1704 return;
1705 list = PyDict_GetItemString(dict, KEY);
1706 if (list == NULL || !PyList_Check(list))
1707 return;
1708 i = PyList_GET_SIZE(list);
1709 /* Count backwards because we always expect obj to be list[-1] */
1710 while (--i >= 0) {
1711 if (PyList_GET_ITEM(list, i) == obj) {
1712 PyList_SetSlice(list, i, i + 1, NULL);
1713 break;
1714 }
1715 }
Guido van Rossum86610361998-04-10 22:32:46 +00001716}
Guido van Rossumd724b232000-03-13 16:01:29 +00001717
Tim Peters803526b2002-07-07 05:13:56 +00001718/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001719
Tim Peters803526b2002-07-07 05:13:56 +00001720/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001721int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001722
Tim Peters803526b2002-07-07 05:13:56 +00001723/* List of objects that still need to be cleaned up, singly linked via their
1724 * gc headers' gc_prev pointers.
1725 */
1726PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001727
Tim Peters803526b2002-07-07 05:13:56 +00001728/* Add op to the _PyTrash_delete_later list. Called when the current
1729 * call-stack depth gets large. op must be a currently untracked gc'ed
1730 * object, with refcount 0. Py_DECREF must already have been called on it.
1731 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001732void
Fred Drake100814d2000-07-09 15:48:49 +00001733_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001734{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001735 assert(PyObject_IS_GC(op));
1736 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1737 assert(op->ob_refcnt == 0);
1738 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
1739 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001740}
1741
Tim Peters803526b2002-07-07 05:13:56 +00001742/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1743 * the call-stack unwinds again.
1744 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001745void
Fred Drake100814d2000-07-09 15:48:49 +00001746_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001747{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001748 while (_PyTrash_delete_later) {
1749 PyObject *op = _PyTrash_delete_later;
1750 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001751
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001752 _PyTrash_delete_later =
1753 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001754
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001755 /* Call the deallocator directly. This used to try to
1756 * fool Py_DECREF into calling it indirectly, but
1757 * Py_DECREF was already called on this object, and in
1758 * assorted non-release builds calling Py_DECREF again ends
1759 * up distorting allocation statistics.
1760 */
1761 assert(op->ob_refcnt == 0);
1762 ++_PyTrash_delete_nesting;
1763 (*dealloc)(op);
1764 --_PyTrash_delete_nesting;
1765 }
Guido van Rossumd724b232000-03-13 16:01:29 +00001766}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001767
Martin v. Löwis4d0d4712010-12-03 20:14:31 +00001768#ifndef Py_TRACE_REFS
1769/* For Py_LIMITED_API, we need an out-of-line version of _Py_Dealloc.
1770 Define this here, so we can undefine the macro. */
1771#undef _Py_Dealloc
1772PyAPI_FUNC(void) _Py_Dealloc(PyObject *);
1773void
1774_Py_Dealloc(PyObject *op)
1775{
1776 _Py_INC_TPFREES(op) _Py_COUNT_ALLOCS_COMMA
1777 (*Py_TYPE(op)->tp_dealloc)(op);
1778}
1779#endif
1780
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001781#ifdef __cplusplus
1782}
1783#endif