blob: aeaa4b5fa438c1555fbda97219e51c8705a76a33 [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;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200298 t = PyUnicode_AsEncodedString(s, "utf-8", "backslashreplace");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000299 if (t == NULL)
300 ret = 0;
301 else {
302 fwrite(PyBytes_AS_STRING(t), 1,
303 PyBytes_GET_SIZE(t), fp);
Victor Stinnerba6b4302010-05-17 09:33:42 +0000304 Py_DECREF(t);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000305 }
306 }
307 else {
308 PyErr_Format(PyExc_TypeError,
309 "str() or repr() returned '%.100s'",
310 s->ob_type->tp_name);
311 ret = -1;
312 }
313 Py_XDECREF(s);
314 }
315 }
316 if (ret == 0) {
317 if (ferror(fp)) {
318 PyErr_SetFromErrno(PyExc_IOError);
319 clearerr(fp);
320 ret = -1;
321 }
322 }
323 return ret;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000324}
325
Guido van Rossum38938152006-08-21 23:36:26 +0000326/* For debugging convenience. Set a breakpoint here and call it from your DLL */
327void
Thomas Woutersb2137042007-02-01 18:02:27 +0000328_Py_BreakPoint(void)
Guido van Rossum38938152006-08-21 23:36:26 +0000329{
330}
331
Neal Norwitz1a997502003-01-13 20:13:12 +0000332
Barry Warsaw9bf16442001-01-23 16:24:35 +0000333/* For debugging convenience. See Misc/gdbinit for some useful gdb hooks */
Guido van Rossum38938152006-08-21 23:36:26 +0000334void
335_PyObject_Dump(PyObject* op)
Barry Warsaw9bf16442001-01-23 16:24:35 +0000336{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000337 if (op == NULL)
338 fprintf(stderr, "NULL\n");
339 else {
Georg Brandldfd73442009-04-05 11:47:34 +0000340#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000341 PyGILState_STATE gil;
Georg Brandldfd73442009-04-05 11:47:34 +0000342#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000343 fprintf(stderr, "object : ");
Georg Brandldfd73442009-04-05 11:47:34 +0000344#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000345 gil = PyGILState_Ensure();
Georg Brandldfd73442009-04-05 11:47:34 +0000346#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000347 (void)PyObject_Print(op, stderr, 0);
Georg Brandldfd73442009-04-05 11:47:34 +0000348#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000349 PyGILState_Release(gil);
Georg Brandldfd73442009-04-05 11:47:34 +0000350#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000351 /* XXX(twouters) cast refcount to long until %zd is
352 universally available */
353 fprintf(stderr, "\n"
354 "type : %s\n"
355 "refcount: %ld\n"
356 "address : %p\n",
357 Py_TYPE(op)==NULL ? "NULL" : Py_TYPE(op)->tp_name,
358 (long)op->ob_refcnt,
359 op);
360 }
Barry Warsaw9bf16442001-01-23 16:24:35 +0000361}
Barry Warsaw903138f2001-01-23 16:33:18 +0000362
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000363PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000364PyObject_Repr(PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000365{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000366 PyObject *res;
367 if (PyErr_CheckSignals())
368 return NULL;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000369#ifdef USE_STACKCHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000370 if (PyOS_CheckStack()) {
371 PyErr_SetString(PyExc_MemoryError, "stack overflow");
372 return NULL;
373 }
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000374#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000375 if (v == NULL)
376 return PyUnicode_FromString("<NULL>");
377 if (Py_TYPE(v)->tp_repr == NULL)
378 return PyUnicode_FromFormat("<%s object at %p>",
379 v->ob_type->tp_name, v);
380 res = (*v->ob_type->tp_repr)(v);
381 if (res != NULL && !PyUnicode_Check(res)) {
382 PyErr_Format(PyExc_TypeError,
383 "__repr__ returned non-string (type %.200s)",
384 res->ob_type->tp_name);
385 Py_DECREF(res);
386 return NULL;
387 }
388 return res;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000389}
390
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000391PyObject *
Guido van Rossum98297ee2007-11-06 21:34:58 +0000392PyObject_Str(PyObject *v)
Guido van Rossumc6004111993-11-05 10:22:19 +0000393{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000394 PyObject *res;
395 if (PyErr_CheckSignals())
396 return NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000397#ifdef USE_STACKCHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000398 if (PyOS_CheckStack()) {
399 PyErr_SetString(PyExc_MemoryError, "stack overflow");
400 return NULL;
401 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000402#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000403 if (v == NULL)
404 return PyUnicode_FromString("<NULL>");
405 if (PyUnicode_CheckExact(v)) {
406 Py_INCREF(v);
407 return v;
408 }
409 if (Py_TYPE(v)->tp_str == NULL)
410 return PyObject_Repr(v);
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000411
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000412 /* It is possible for a type to have a tp_str representation that loops
413 infinitely. */
414 if (Py_EnterRecursiveCall(" while getting the str of an object"))
415 return NULL;
416 res = (*Py_TYPE(v)->tp_str)(v);
417 Py_LeaveRecursiveCall();
418 if (res == NULL)
419 return NULL;
420 if (!PyUnicode_Check(res)) {
421 PyErr_Format(PyExc_TypeError,
422 "__str__ returned non-string (type %.200s)",
423 Py_TYPE(res)->tp_name);
424 Py_DECREF(res);
425 return NULL;
426 }
427 return res;
Neil Schemenauercf52c072005-08-12 17:34:58 +0000428}
429
Georg Brandl559e5d72008-06-11 18:37:52 +0000430PyObject *
431PyObject_ASCII(PyObject *v)
432{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000433 PyObject *repr, *ascii, *res;
Georg Brandl559e5d72008-06-11 18:37:52 +0000434
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000435 repr = PyObject_Repr(v);
436 if (repr == NULL)
437 return NULL;
Georg Brandl559e5d72008-06-11 18:37:52 +0000438
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000439 /* repr is guaranteed to be a PyUnicode object by PyObject_Repr */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200440 ascii = _PyUnicode_AsASCIIString(repr, "backslashreplace");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000441 Py_DECREF(repr);
442 if (ascii == NULL)
443 return NULL;
Georg Brandl559e5d72008-06-11 18:37:52 +0000444
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000445 res = PyUnicode_DecodeASCII(
446 PyBytes_AS_STRING(ascii),
447 PyBytes_GET_SIZE(ascii),
448 NULL);
449
450 Py_DECREF(ascii);
451 return res;
Georg Brandl559e5d72008-06-11 18:37:52 +0000452}
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000453
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000454PyObject *
455PyObject_Bytes(PyObject *v)
456{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000457 PyObject *result, *func;
458 static PyObject *bytesstring = NULL;
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000459
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000460 if (v == NULL)
461 return PyBytes_FromString("<NULL>");
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000462
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000463 if (PyBytes_CheckExact(v)) {
464 Py_INCREF(v);
465 return v;
466 }
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000467
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000468 func = _PyObject_LookupSpecial(v, "__bytes__", &bytesstring);
469 if (func != NULL) {
470 result = PyObject_CallFunctionObjArgs(func, NULL);
471 Py_DECREF(func);
472 if (result == NULL)
Benjamin Peterson41ece392010-09-11 16:39:57 +0000473 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000474 if (!PyBytes_Check(result)) {
Benjamin Peterson41ece392010-09-11 16:39:57 +0000475 PyErr_Format(PyExc_TypeError,
476 "__bytes__ returned non-bytes (type %.200s)",
477 Py_TYPE(result)->tp_name);
478 Py_DECREF(result);
479 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000480 }
481 return result;
482 }
483 else if (PyErr_Occurred())
484 return NULL;
485 return PyBytes_FromObject(v);
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000486}
487
Mark Dickinsonc008a172009-02-01 13:59:22 +0000488/* For Python 3.0.1 and later, the old three-way comparison has been
489 completely removed in favour of rich comparisons. PyObject_Compare() and
490 PyObject_Cmp() are gone, and the builtin cmp function no longer exists.
Mark Dickinsone94c6792009-02-02 20:36:42 +0000491 The old tp_compare slot has been renamed to tp_reserved, and should no
Mark Dickinsonc008a172009-02-01 13:59:22 +0000492 longer be used. Use tp_richcompare instead.
Guido van Rossum98297ee2007-11-06 21:34:58 +0000493
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000494 See (*) below for practical amendments.
495
Mark Dickinsonc008a172009-02-01 13:59:22 +0000496 tp_richcompare gets called with a first argument of the appropriate type
497 and a second object of an arbitrary type. We never do any kind of
498 coercion.
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000499
Mark Dickinsonc008a172009-02-01 13:59:22 +0000500 The tp_richcompare slot should return an object, as follows:
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000501
502 NULL if an exception occurred
503 NotImplemented if the requested comparison is not implemented
504 any other false value if the requested comparison is false
505 any other true value if the requested comparison is true
506
507 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
508 NotImplemented.
509
510 (*) Practical amendments:
511
512 - If rich comparison returns NotImplemented, == and != are decided by
513 comparing the object pointer (i.e. falling back to the base object
514 implementation).
515
Guido van Rossuma4073002002-05-31 20:03:54 +0000516*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000517
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000518/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000519int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000520
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000521static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000522
523/* Perform a rich comparison, raising TypeError when the requested comparison
524 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000525static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000526do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000527{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000528 richcmpfunc f;
529 PyObject *res;
530 int checked_reverse_op = 0;
Guido van Rossume797ec12001-01-17 15:24:28 +0000531
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000532 if (v->ob_type != w->ob_type &&
533 PyType_IsSubtype(w->ob_type, v->ob_type) &&
534 (f = w->ob_type->tp_richcompare) != NULL) {
535 checked_reverse_op = 1;
536 res = (*f)(w, v, _Py_SwappedOp[op]);
537 if (res != Py_NotImplemented)
538 return res;
539 Py_DECREF(res);
540 }
541 if ((f = v->ob_type->tp_richcompare) != NULL) {
542 res = (*f)(v, w, op);
543 if (res != Py_NotImplemented)
544 return res;
545 Py_DECREF(res);
546 }
547 if (!checked_reverse_op && (f = w->ob_type->tp_richcompare) != NULL) {
548 res = (*f)(w, v, _Py_SwappedOp[op]);
549 if (res != Py_NotImplemented)
550 return res;
551 Py_DECREF(res);
552 }
553 /* If neither object implements it, provide a sensible default
554 for == and !=, but raise an exception for ordering. */
555 switch (op) {
556 case Py_EQ:
557 res = (v == w) ? Py_True : Py_False;
558 break;
559 case Py_NE:
560 res = (v != w) ? Py_True : Py_False;
561 break;
562 default:
563 /* XXX Special-case None so it doesn't show as NoneType() */
564 PyErr_Format(PyExc_TypeError,
565 "unorderable types: %.100s() %s %.100s()",
566 v->ob_type->tp_name,
567 opstrings[op],
568 w->ob_type->tp_name);
569 return NULL;
570 }
571 Py_INCREF(res);
572 return res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000573}
574
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000575/* Perform a rich comparison with object result. This wraps do_richcompare()
576 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000577
Guido van Rossume797ec12001-01-17 15:24:28 +0000578PyObject *
579PyObject_RichCompare(PyObject *v, PyObject *w, int op)
580{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000581 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000582
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000583 assert(Py_LT <= op && op <= Py_GE);
584 if (v == NULL || w == NULL) {
585 if (!PyErr_Occurred())
586 PyErr_BadInternalCall();
587 return NULL;
588 }
589 if (Py_EnterRecursiveCall(" in comparison"))
590 return NULL;
591 res = do_richcompare(v, w, op);
592 Py_LeaveRecursiveCall();
593 return res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000594}
595
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000596/* Perform a rich comparison with integer result. This wraps
597 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000598int
599PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
600{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000601 PyObject *res;
602 int ok;
Guido van Rossume797ec12001-01-17 15:24:28 +0000603
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000604 /* Quick result when objects are the same.
605 Guarantees that identity implies equality. */
606 if (v == w) {
607 if (op == Py_EQ)
608 return 1;
609 else if (op == Py_NE)
610 return 0;
611 }
Mark Dickinson4a1f5932008-11-12 23:23:36 +0000612
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000613 res = PyObject_RichCompare(v, w, op);
614 if (res == NULL)
615 return -1;
616 if (PyBool_Check(res))
617 ok = (res == Py_True);
618 else
619 ok = PyObject_IsTrue(res);
620 Py_DECREF(res);
621 return ok;
Guido van Rossume797ec12001-01-17 15:24:28 +0000622}
Fred Drake13634cf2000-06-29 19:17:04 +0000623
624/* Set of hash utility functions to help maintaining the invariant that
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000625 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000626
627 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
628*/
629
Mark Dickinsondc787d22010-05-23 13:33:13 +0000630/* For numeric types, the hash of a number x is based on the reduction
631 of x modulo the prime P = 2**_PyHASH_BITS - 1. It's designed so that
632 hash(x) == hash(y) whenever x and y are numerically equal, even if
633 x and y have different types.
634
635 A quick summary of the hashing strategy:
636
637 (1) First define the 'reduction of x modulo P' for any rational
638 number x; this is a standard extension of the usual notion of
639 reduction modulo P for integers. If x == p/q (written in lowest
640 terms), the reduction is interpreted as the reduction of p times
641 the inverse of the reduction of q, all modulo P; if q is exactly
642 divisible by P then define the reduction to be infinity. So we've
643 got a well-defined map
644
645 reduce : { rational numbers } -> { 0, 1, 2, ..., P-1, infinity }.
646
647 (2) Now for a rational number x, define hash(x) by:
648
649 reduce(x) if x >= 0
650 -reduce(-x) if x < 0
651
652 If the result of the reduction is infinity (this is impossible for
653 integers, floats and Decimals) then use the predefined hash value
654 _PyHASH_INF for x >= 0, or -_PyHASH_INF for x < 0, instead.
655 _PyHASH_INF, -_PyHASH_INF and _PyHASH_NAN are also used for the
656 hashes of float and Decimal infinities and nans.
657
658 A selling point for the above strategy is that it makes it possible
659 to compute hashes of decimal and binary floating-point numbers
660 efficiently, even if the exponent of the binary or decimal number
661 is large. The key point is that
662
663 reduce(x * y) == reduce(x) * reduce(y) (modulo _PyHASH_MODULUS)
664
665 provided that {reduce(x), reduce(y)} != {0, infinity}. The reduction of a
666 binary or decimal float is never infinity, since the denominator is a power
667 of 2 (for binary) or a divisor of a power of 10 (for decimal). So we have,
668 for nonnegative x,
669
670 reduce(x * 2**e) == reduce(x) * reduce(2**e) % _PyHASH_MODULUS
671
672 reduce(x * 10**e) == reduce(x) * reduce(10**e) % _PyHASH_MODULUS
673
674 and reduce(10**e) can be computed efficiently by the usual modular
675 exponentiation algorithm. For reduce(2**e) it's even better: since
676 P is of the form 2**n-1, reduce(2**e) is 2**(e mod n), and multiplication
677 by 2**(e mod n) modulo 2**n-1 just amounts to a rotation of bits.
678
679 */
680
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000681Py_hash_t
Fred Drake100814d2000-07-09 15:48:49 +0000682_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000683{
Mark Dickinsondc787d22010-05-23 13:33:13 +0000684 int e, sign;
685 double m;
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000686 Py_uhash_t x, y;
Tim Peters39dce292000-08-15 03:34:48 +0000687
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000688 if (!Py_IS_FINITE(v)) {
689 if (Py_IS_INFINITY(v))
Mark Dickinsondc787d22010-05-23 13:33:13 +0000690 return v > 0 ? _PyHASH_INF : -_PyHASH_INF;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000691 else
Mark Dickinsondc787d22010-05-23 13:33:13 +0000692 return _PyHASH_NAN;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000693 }
Mark Dickinsondc787d22010-05-23 13:33:13 +0000694
695 m = frexp(v, &e);
696
697 sign = 1;
698 if (m < 0) {
699 sign = -1;
700 m = -m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000701 }
Mark Dickinsondc787d22010-05-23 13:33:13 +0000702
703 /* process 28 bits at a time; this should work well both for binary
704 and hexadecimal floating point. */
705 x = 0;
706 while (m) {
707 x = ((x << 28) & _PyHASH_MODULUS) | x >> (_PyHASH_BITS - 28);
708 m *= 268435456.0; /* 2**28 */
709 e -= 28;
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000710 y = (Py_uhash_t)m; /* pull out integer part */
Mark Dickinsondc787d22010-05-23 13:33:13 +0000711 m -= y;
712 x += y;
713 if (x >= _PyHASH_MODULUS)
714 x -= _PyHASH_MODULUS;
715 }
716
717 /* adjust for the exponent; first reduce it modulo _PyHASH_BITS */
718 e = e >= 0 ? e % _PyHASH_BITS : _PyHASH_BITS-1-((-1-e) % _PyHASH_BITS);
719 x = ((x << e) & _PyHASH_MODULUS) | x >> (_PyHASH_BITS - e);
720
721 x = x * sign;
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000722 if (x == (Py_uhash_t)-1)
723 x = (Py_uhash_t)-2;
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000724 return (Py_hash_t)x;
Fred Drake13634cf2000-06-29 19:17:04 +0000725}
726
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000727Py_hash_t
Fred Drake100814d2000-07-09 15:48:49 +0000728_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000729{
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000730 Py_hash_t x;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000731 size_t y = (size_t)p;
732 /* bottom 3 or 4 bits are likely to be 0; rotate y by 4 to avoid
733 excessive hash collisions for dicts and sets */
734 y = (y >> 4) | (y << (8 * SIZEOF_VOID_P - 4));
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000735 x = (Py_hash_t)y;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000736 if (x == -1)
737 x = -2;
738 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000739}
740
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000741Py_hash_t
Nick Coghland1abd252008-07-15 15:46:38 +0000742PyObject_HashNotImplemented(PyObject *v)
743{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000744 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
745 Py_TYPE(v)->tp_name);
746 return -1;
Nick Coghland1abd252008-07-15 15:46:38 +0000747}
Fred Drake13634cf2000-06-29 19:17:04 +0000748
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000749Py_hash_t
Fred Drake100814d2000-07-09 15:48:49 +0000750PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000751{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000752 PyTypeObject *tp = Py_TYPE(v);
753 if (tp->tp_hash != NULL)
754 return (*tp->tp_hash)(v);
755 /* To keep to the general practice that inheriting
756 * solely from object in C code should work without
757 * an explicit call to PyType_Ready, we implicitly call
758 * PyType_Ready here and then check the tp_hash slot again
759 */
760 if (tp->tp_dict == NULL) {
761 if (PyType_Ready(tp) < 0)
762 return -1;
763 if (tp->tp_hash != NULL)
764 return (*tp->tp_hash)(v);
765 }
766 /* Otherwise, the object can't be hashed */
767 return PyObject_HashNotImplemented(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000768}
769
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000770PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000771PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000772{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000773 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000774
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000775 if (Py_TYPE(v)->tp_getattr != NULL)
776 return (*Py_TYPE(v)->tp_getattr)(v, (char*)name);
777 w = PyUnicode_InternFromString(name);
778 if (w == NULL)
779 return NULL;
780 res = PyObject_GetAttr(v, w);
781 Py_XDECREF(w);
782 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000783}
784
785int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000786PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000787{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000788 PyObject *res = PyObject_GetAttrString(v, name);
789 if (res != NULL) {
790 Py_DECREF(res);
791 return 1;
792 }
793 PyErr_Clear();
794 return 0;
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000795}
796
797int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000798PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000799{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000800 PyObject *s;
801 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000802
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000803 if (Py_TYPE(v)->tp_setattr != NULL)
804 return (*Py_TYPE(v)->tp_setattr)(v, (char*)name, w);
805 s = PyUnicode_InternFromString(name);
806 if (s == NULL)
807 return -1;
808 res = PyObject_SetAttr(v, s, w);
809 Py_XDECREF(s);
810 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000811}
812
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000813PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000814PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000815{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000816 PyTypeObject *tp = Py_TYPE(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000817
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000818 if (!PyUnicode_Check(name)) {
819 PyErr_Format(PyExc_TypeError,
820 "attribute name must be string, not '%.200s'",
821 name->ob_type->tp_name);
822 return NULL;
823 }
824 if (tp->tp_getattro != NULL)
825 return (*tp->tp_getattro)(v, name);
826 if (tp->tp_getattr != NULL) {
827 char *name_str = _PyUnicode_AsString(name);
828 if (name_str == NULL)
829 return NULL;
830 return (*tp->tp_getattr)(v, name_str);
831 }
832 PyErr_Format(PyExc_AttributeError,
833 "'%.50s' object has no attribute '%U'",
834 tp->tp_name, name);
835 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000836}
837
838int
Fred Drake100814d2000-07-09 15:48:49 +0000839PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000840{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000841 PyObject *res = PyObject_GetAttr(v, name);
842 if (res != NULL) {
843 Py_DECREF(res);
844 return 1;
845 }
846 PyErr_Clear();
847 return 0;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000848}
849
850int
Fred Drake100814d2000-07-09 15:48:49 +0000851PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000852{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000853 PyTypeObject *tp = Py_TYPE(v);
854 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000855
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000856 if (!PyUnicode_Check(name)) {
857 PyErr_Format(PyExc_TypeError,
858 "attribute name must be string, not '%.200s'",
859 name->ob_type->tp_name);
860 return -1;
861 }
862 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000863
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000864 PyUnicode_InternInPlace(&name);
865 if (tp->tp_setattro != NULL) {
866 err = (*tp->tp_setattro)(v, name, value);
867 Py_DECREF(name);
868 return err;
869 }
870 if (tp->tp_setattr != NULL) {
871 char *name_str = _PyUnicode_AsString(name);
872 if (name_str == NULL)
873 return -1;
874 err = (*tp->tp_setattr)(v, name_str, value);
875 Py_DECREF(name);
876 return err;
877 }
878 Py_DECREF(name);
879 assert(name->ob_refcnt >= 1);
880 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
881 PyErr_Format(PyExc_TypeError,
882 "'%.100s' object has no attributes "
883 "(%s .%U)",
884 tp->tp_name,
885 value==NULL ? "del" : "assign to",
886 name);
887 else
888 PyErr_Format(PyExc_TypeError,
889 "'%.100s' object has only read-only attributes "
890 "(%s .%U)",
891 tp->tp_name,
892 value==NULL ? "del" : "assign to",
893 name);
894 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000895}
896
897/* Helper to get a pointer to an object's __dict__ slot, if any */
898
899PyObject **
900_PyObject_GetDictPtr(PyObject *obj)
901{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000902 Py_ssize_t dictoffset;
903 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000904
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000905 dictoffset = tp->tp_dictoffset;
906 if (dictoffset == 0)
907 return NULL;
908 if (dictoffset < 0) {
909 Py_ssize_t tsize;
910 size_t size;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000911
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000912 tsize = ((PyVarObject *)obj)->ob_size;
913 if (tsize < 0)
914 tsize = -tsize;
915 size = _PyObject_VAR_SIZE(tp, tsize);
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000916
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000917 dictoffset += (long)size;
918 assert(dictoffset > 0);
919 assert(dictoffset % SIZEOF_VOID_P == 0);
920 }
921 return (PyObject **) ((char *)obj + dictoffset);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000922}
923
Tim Peters6d6c1a32001-08-02 04:15:00 +0000924PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000925PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +0000926{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000927 Py_INCREF(obj);
928 return obj;
Raymond Hettinger01538262003-03-17 08:24:35 +0000929}
930
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +0000931/* Helper used when the __next__ method is removed from a type:
932 tp_iternext is never NULL and can be safely called without checking
933 on every iteration.
934 */
935
936PyObject *
937_PyObject_NextNotImplemented(PyObject *self)
938{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000939 PyErr_Format(PyExc_TypeError,
940 "'%.200s' object is not iterable",
941 Py_TYPE(self)->tp_name);
942 return NULL;
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +0000943}
944
Michael W. Hudson1593f502004-09-14 17:09:47 +0000945/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
946
Raymond Hettinger01538262003-03-17 08:24:35 +0000947PyObject *
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +0000948_PyObject_GenericGetAttrWithDict(PyObject *obj, PyObject *name, PyObject *dict)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000949{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000950 PyTypeObject *tp = Py_TYPE(obj);
951 PyObject *descr = NULL;
952 PyObject *res = NULL;
953 descrgetfunc f;
954 Py_ssize_t dictoffset;
955 PyObject **dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000956
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000957 if (!PyUnicode_Check(name)){
958 PyErr_Format(PyExc_TypeError,
959 "attribute name must be string, not '%.200s'",
960 name->ob_type->tp_name);
961 return NULL;
962 }
963 else
964 Py_INCREF(name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000965
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000966 if (tp->tp_dict == NULL) {
967 if (PyType_Ready(tp) < 0)
968 goto done;
969 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000970
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000971 descr = _PyType_Lookup(tp, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000972 Py_XINCREF(descr);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000973
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000974 f = NULL;
975 if (descr != NULL) {
976 f = descr->ob_type->tp_descr_get;
977 if (f != NULL && PyDescr_IsData(descr)) {
978 res = f(descr, obj, (PyObject *)obj->ob_type);
979 Py_DECREF(descr);
980 goto done;
981 }
982 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000983
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +0000984 if (dict == NULL) {
985 /* Inline _PyObject_GetDictPtr */
986 dictoffset = tp->tp_dictoffset;
987 if (dictoffset != 0) {
988 if (dictoffset < 0) {
989 Py_ssize_t tsize;
990 size_t size;
Guido van Rossumc66ff442002-08-19 16:50:48 +0000991
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +0000992 tsize = ((PyVarObject *)obj)->ob_size;
993 if (tsize < 0)
994 tsize = -tsize;
995 size = _PyObject_VAR_SIZE(tp, tsize);
Guido van Rossumc66ff442002-08-19 16:50:48 +0000996
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +0000997 dictoffset += (long)size;
998 assert(dictoffset > 0);
999 assert(dictoffset % SIZEOF_VOID_P == 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001000 }
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001001 dictptr = (PyObject **) ((char *)obj + dictoffset);
1002 dict = *dictptr;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001003 }
1004 }
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001005 if (dict != NULL) {
1006 Py_INCREF(dict);
1007 res = PyDict_GetItem(dict, name);
1008 if (res != NULL) {
1009 Py_INCREF(res);
1010 Py_XDECREF(descr);
1011 Py_DECREF(dict);
1012 goto done;
1013 }
1014 Py_DECREF(dict);
1015 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001016
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001017 if (f != NULL) {
1018 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
1019 Py_DECREF(descr);
1020 goto done;
1021 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001022
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001023 if (descr != NULL) {
1024 res = descr;
1025 /* descr was already increfed above */
1026 goto done;
1027 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001028
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001029 PyErr_Format(PyExc_AttributeError,
1030 "'%.50s' object has no attribute '%U'",
1031 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001032 done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001033 Py_DECREF(name);
1034 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001035}
1036
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001037PyObject *
1038PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
1039{
1040 return _PyObject_GenericGetAttrWithDict(obj, name, NULL);
1041}
1042
Tim Peters6d6c1a32001-08-02 04:15:00 +00001043int
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001044_PyObject_GenericSetAttrWithDict(PyObject *obj, PyObject *name,
1045 PyObject *value, PyObject *dict)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001046{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001047 PyTypeObject *tp = Py_TYPE(obj);
1048 PyObject *descr;
1049 descrsetfunc f;
1050 PyObject **dictptr;
1051 int res = -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001052
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001053 if (!PyUnicode_Check(name)){
1054 PyErr_Format(PyExc_TypeError,
1055 "attribute name must be string, not '%.200s'",
1056 name->ob_type->tp_name);
1057 return -1;
1058 }
1059 else
1060 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001061
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001062 if (tp->tp_dict == NULL) {
1063 if (PyType_Ready(tp) < 0)
1064 goto done;
1065 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001066
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001067 descr = _PyType_Lookup(tp, name);
1068 f = NULL;
1069 if (descr != NULL) {
1070 f = descr->ob_type->tp_descr_set;
1071 if (f != NULL && PyDescr_IsData(descr)) {
1072 res = f(descr, obj, value);
1073 goto done;
1074 }
1075 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001076
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001077 if (dict == NULL) {
1078 dictptr = _PyObject_GetDictPtr(obj);
1079 if (dictptr != NULL) {
1080 dict = *dictptr;
1081 if (dict == NULL && value != NULL) {
1082 dict = PyDict_New();
1083 if (dict == NULL)
1084 goto done;
1085 *dictptr = dict;
1086 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001087 }
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001088 }
1089 if (dict != NULL) {
1090 Py_INCREF(dict);
1091 if (value == NULL)
1092 res = PyDict_DelItem(dict, name);
1093 else
1094 res = PyDict_SetItem(dict, name, value);
1095 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1096 PyErr_SetObject(PyExc_AttributeError, name);
1097 Py_DECREF(dict);
1098 goto done;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001099 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001100
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001101 if (f != NULL) {
1102 res = f(descr, obj, value);
1103 goto done;
1104 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001105
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001106 if (descr == NULL) {
1107 PyErr_Format(PyExc_AttributeError,
1108 "'%.100s' object has no attribute '%U'",
1109 tp->tp_name, name);
1110 goto done;
1111 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001112
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001113 PyErr_Format(PyExc_AttributeError,
1114 "'%.50s' object attribute '%U' is read-only",
1115 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001116 done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001117 Py_DECREF(name);
1118 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001119}
1120
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001121int
1122PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1123{
1124 return _PyObject_GenericSetAttrWithDict(obj, name, value, NULL);
1125}
1126
1127
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001128/* Test a value used as condition, e.g., in a for or if statement.
1129 Return -1 if an error occurred */
1130
1131int
Fred Drake100814d2000-07-09 15:48:49 +00001132PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001133{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001134 Py_ssize_t res;
1135 if (v == Py_True)
1136 return 1;
1137 if (v == Py_False)
1138 return 0;
1139 if (v == Py_None)
1140 return 0;
1141 else if (v->ob_type->tp_as_number != NULL &&
1142 v->ob_type->tp_as_number->nb_bool != NULL)
1143 res = (*v->ob_type->tp_as_number->nb_bool)(v);
1144 else if (v->ob_type->tp_as_mapping != NULL &&
1145 v->ob_type->tp_as_mapping->mp_length != NULL)
1146 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
1147 else if (v->ob_type->tp_as_sequence != NULL &&
1148 v->ob_type->tp_as_sequence->sq_length != NULL)
1149 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1150 else
1151 return 1;
1152 /* if it is negative, it should be either -1 or -2 */
1153 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001154}
1155
Tim Peters803526b2002-07-07 05:13:56 +00001156/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001157 Return -1 if an error occurred */
1158
1159int
Fred Drake100814d2000-07-09 15:48:49 +00001160PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001161{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001162 int res;
1163 res = PyObject_IsTrue(v);
1164 if (res < 0)
1165 return res;
1166 return res == 0;
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001167}
1168
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001169/* Test whether an object can be called */
1170
1171int
Fred Drake100814d2000-07-09 15:48:49 +00001172PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001173{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001174 if (x == NULL)
1175 return 0;
1176 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001177}
1178
Tim Peters7eea37e2001-09-04 22:08:56 +00001179
Georg Brandle32b4222007-03-10 22:13:27 +00001180/* Helper for PyObject_Dir without arguments: returns the local scope. */
1181static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001182_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001183{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001184 PyObject *names;
1185 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001186
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001187 if (locals == NULL) {
1188 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1189 return NULL;
1190 }
Tim Peters305b5852001-09-17 02:38:46 +00001191
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001192 names = PyMapping_Keys(locals);
1193 if (!names)
1194 return NULL;
1195 if (!PyList_Check(names)) {
1196 PyErr_Format(PyExc_TypeError,
1197 "dir(): expected keys() of locals to be a list, "
1198 "not '%.200s'", Py_TYPE(names)->tp_name);
1199 Py_DECREF(names);
1200 return NULL;
1201 }
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001202 if (PyList_Sort(names)) {
1203 Py_DECREF(names);
1204 return NULL;
1205 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001206 /* the locals don't need to be DECREF'd */
1207 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001208}
1209
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001210/* Helper for PyObject_Dir: object introspection. */
Georg Brandle32b4222007-03-10 22:13:27 +00001211static PyObject *
1212_dir_object(PyObject *obj)
1213{
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001214 PyObject *result, *sorted;
Benjamin Peterson7963a352011-05-23 16:11:05 -05001215 static PyObject *dir_str = NULL;
1216 PyObject *dirfunc = _PyObject_LookupSpecial(obj, "__dir__", &dir_str);
Georg Brandle32b4222007-03-10 22:13:27 +00001217
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001218 assert(obj);
1219 if (dirfunc == NULL) {
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001220 if (!PyErr_Occurred())
1221 PyErr_SetString(PyExc_TypeError, "object does not provide __dir__");
1222 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001223 }
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001224 /* use __dir__ */
1225 result = PyObject_CallFunctionObjArgs(dirfunc, NULL);
1226 Py_DECREF(dirfunc);
1227 if (result == NULL)
1228 return NULL;
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001229 /* return sorted(result) */
1230 sorted = PySequence_List(result);
1231 Py_DECREF(result);
1232 if (sorted == NULL)
1233 return NULL;
1234 if (PyList_Sort(sorted)) {
1235 Py_DECREF(sorted);
1236 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001237 }
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001238 return sorted;
Georg Brandle32b4222007-03-10 22:13:27 +00001239}
1240
1241/* Implementation of dir() -- if obj is NULL, returns the names in the current
1242 (local) scope. Otherwise, performs introspection of the object: returns a
1243 sorted list of attribute names (supposedly) accessible from the object
1244*/
1245PyObject *
1246PyObject_Dir(PyObject *obj)
1247{
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001248 return (obj == NULL) ? _dir_locals() : _dir_object(obj);
Tim Peters7eea37e2001-09-04 22:08:56 +00001249}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001250
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001251/*
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001252None is a non-NULL undefined value.
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001253There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001254so there is exactly one (which is indestructible, by the way).
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001255*/
1256
Guido van Rossum0c182a11992-03-27 17:26:13 +00001257/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001258static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001259none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001260{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001261 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001262}
1263
Barry Warsaw9bf16442001-01-23 16:24:35 +00001264/* ARGUSED */
1265static void
Tim Peters803526b2002-07-07 05:13:56 +00001266none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001267{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001268 /* This should never get called, but we also don't want to SEGV if
1269 * we accidentally decref None out of existence.
1270 */
1271 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001272}
1273
Benjamin Petersonc4607ae2011-07-29 18:19:43 -05001274static PyObject *
1275none_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1276{
1277 if (PyTuple_GET_SIZE(args) || (kwargs && PyDict_Size(kwargs))) {
1278 PyErr_SetString(PyExc_TypeError, "NoneType takes no arguments");
1279 return NULL;
1280 }
1281 Py_RETURN_NONE;
1282}
1283
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001284static int
1285none_bool(PyObject *v)
1286{
1287 return 0;
1288}
1289
1290static PyNumberMethods none_as_number = {
1291 0, /* nb_add */
1292 0, /* nb_subtract */
1293 0, /* nb_multiply */
1294 0, /* nb_remainder */
1295 0, /* nb_divmod */
1296 0, /* nb_power */
1297 0, /* nb_negative */
1298 0, /* nb_positive */
1299 0, /* nb_absolute */
1300 (inquiry)none_bool, /* nb_bool */
1301 0, /* nb_invert */
1302 0, /* nb_lshift */
1303 0, /* nb_rshift */
1304 0, /* nb_and */
1305 0, /* nb_xor */
1306 0, /* nb_or */
1307 0, /* nb_int */
1308 0, /* nb_reserved */
1309 0, /* nb_float */
1310 0, /* nb_inplace_add */
1311 0, /* nb_inplace_subtract */
1312 0, /* nb_inplace_multiply */
1313 0, /* nb_inplace_remainder */
1314 0, /* nb_inplace_power */
1315 0, /* nb_inplace_lshift */
1316 0, /* nb_inplace_rshift */
1317 0, /* nb_inplace_and */
1318 0, /* nb_inplace_xor */
1319 0, /* nb_inplace_or */
1320 0, /* nb_floor_divide */
1321 0, /* nb_true_divide */
1322 0, /* nb_inplace_floor_divide */
1323 0, /* nb_inplace_true_divide */
1324 0, /* nb_index */
1325};
Barry Warsaw9bf16442001-01-23 16:24:35 +00001326
Guido van Rossumba21a492001-08-16 08:17:26 +00001327static PyTypeObject PyNone_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001328 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1329 "NoneType",
1330 0,
1331 0,
1332 none_dealloc, /*tp_dealloc*/ /*never called*/
1333 0, /*tp_print*/
1334 0, /*tp_getattr*/
1335 0, /*tp_setattr*/
1336 0, /*tp_reserved*/
1337 none_repr, /*tp_repr*/
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001338 &none_as_number, /*tp_as_number*/
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001339 0, /*tp_as_sequence*/
1340 0, /*tp_as_mapping*/
1341 0, /*tp_hash */
Benjamin Petersonc4607ae2011-07-29 18:19:43 -05001342 0, /*tp_call */
1343 0, /*tp_str */
1344 0, /*tp_getattro */
1345 0, /*tp_setattro */
1346 0, /*tp_as_buffer */
1347 Py_TPFLAGS_DEFAULT, /*tp_flags */
1348 0, /*tp_doc */
1349 0, /*tp_traverse */
1350 0, /*tp_clear */
1351 0, /*tp_richcompare */
1352 0, /*tp_weaklistoffset */
1353 0, /*tp_iter */
1354 0, /*tp_iternext */
1355 0, /*tp_methods */
1356 0, /*tp_members */
1357 0, /*tp_getset */
1358 0, /*tp_base */
1359 0, /*tp_dict */
1360 0, /*tp_descr_get */
1361 0, /*tp_descr_set */
1362 0, /*tp_dictoffset */
1363 0, /*tp_init */
1364 0, /*tp_alloc */
1365 none_new, /*tp_new */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001366};
1367
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001368PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001369 _PyObject_EXTRA_INIT
1370 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001371};
1372
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001373/* NotImplemented is an object that can be used to signal that an
1374 operation is not implemented for the given type combination. */
1375
1376static PyObject *
1377NotImplemented_repr(PyObject *op)
1378{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001379 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001380}
1381
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001382static PyObject *
1383notimplemented_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1384{
1385 if (PyTuple_GET_SIZE(args) || (kwargs && PyDict_Size(kwargs))) {
1386 PyErr_SetString(PyExc_TypeError, "NotImplementedType takes no arguments");
1387 return NULL;
1388 }
Brian Curtindfc80e32011-08-10 20:28:54 -05001389 Py_RETURN_NOTIMPLEMENTED;
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001390}
1391
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001392static PyTypeObject PyNotImplemented_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001393 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1394 "NotImplementedType",
1395 0,
1396 0,
1397 none_dealloc, /*tp_dealloc*/ /*never called*/
1398 0, /*tp_print*/
1399 0, /*tp_getattr*/
1400 0, /*tp_setattr*/
1401 0, /*tp_reserved*/
1402 NotImplemented_repr, /*tp_repr*/
1403 0, /*tp_as_number*/
1404 0, /*tp_as_sequence*/
1405 0, /*tp_as_mapping*/
1406 0, /*tp_hash */
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001407 0, /*tp_call */
1408 0, /*tp_str */
1409 0, /*tp_getattro */
1410 0, /*tp_setattro */
1411 0, /*tp_as_buffer */
1412 Py_TPFLAGS_DEFAULT, /*tp_flags */
1413 0, /*tp_doc */
1414 0, /*tp_traverse */
1415 0, /*tp_clear */
1416 0, /*tp_richcompare */
1417 0, /*tp_weaklistoffset */
1418 0, /*tp_iter */
1419 0, /*tp_iternext */
1420 0, /*tp_methods */
1421 0, /*tp_members */
1422 0, /*tp_getset */
1423 0, /*tp_base */
1424 0, /*tp_dict */
1425 0, /*tp_descr_get */
1426 0, /*tp_descr_set */
1427 0, /*tp_dictoffset */
1428 0, /*tp_init */
1429 0, /*tp_alloc */
1430 notimplemented_new, /*tp_new */
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001431};
1432
1433PyObject _Py_NotImplementedStruct = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001434 _PyObject_EXTRA_INIT
1435 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001436};
1437
Guido van Rossumba21a492001-08-16 08:17:26 +00001438void
1439_Py_ReadyTypes(void)
1440{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001441 if (PyType_Ready(&PyType_Type) < 0)
1442 Py_FatalError("Can't initialize type type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001443
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001444 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1445 Py_FatalError("Can't initialize weakref type");
Fred Drake0a4dd392004-07-02 18:57:45 +00001446
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001447 if (PyType_Ready(&_PyWeakref_CallableProxyType) < 0)
1448 Py_FatalError("Can't initialize callable weakref proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001449
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001450 if (PyType_Ready(&_PyWeakref_ProxyType) < 0)
1451 Py_FatalError("Can't initialize weakref proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001452
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001453 if (PyType_Ready(&PyBool_Type) < 0)
1454 Py_FatalError("Can't initialize bool type");
Guido van Rossum77f6a652002-04-03 22:41:51 +00001455
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001456 if (PyType_Ready(&PyByteArray_Type) < 0)
1457 Py_FatalError("Can't initialize bytearray type");
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001458
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001459 if (PyType_Ready(&PyBytes_Type) < 0)
1460 Py_FatalError("Can't initialize 'str'");
Guido van Rossumcacfc072002-05-24 19:01:59 +00001461
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001462 if (PyType_Ready(&PyList_Type) < 0)
1463 Py_FatalError("Can't initialize list type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001464
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001465 if (PyType_Ready(&PyNone_Type) < 0)
1466 Py_FatalError("Can't initialize None type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001467
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001468 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1469 Py_FatalError("Can't initialize NotImplemented type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001470
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001471 if (PyType_Ready(&PyTraceBack_Type) < 0)
1472 Py_FatalError("Can't initialize traceback type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001473
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001474 if (PyType_Ready(&PySuper_Type) < 0)
1475 Py_FatalError("Can't initialize super type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001476
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001477 if (PyType_Ready(&PyBaseObject_Type) < 0)
1478 Py_FatalError("Can't initialize object type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001479
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001480 if (PyType_Ready(&PyRange_Type) < 0)
1481 Py_FatalError("Can't initialize range type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001482
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001483 if (PyType_Ready(&PyDict_Type) < 0)
1484 Py_FatalError("Can't initialize dict type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001485
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001486 if (PyType_Ready(&PySet_Type) < 0)
1487 Py_FatalError("Can't initialize set type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001488
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001489 if (PyType_Ready(&PyUnicode_Type) < 0)
1490 Py_FatalError("Can't initialize str type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001491
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001492 if (PyType_Ready(&PySlice_Type) < 0)
1493 Py_FatalError("Can't initialize slice type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001494
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001495 if (PyType_Ready(&PyStaticMethod_Type) < 0)
1496 Py_FatalError("Can't initialize static method type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001497
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001498 if (PyType_Ready(&PyComplex_Type) < 0)
1499 Py_FatalError("Can't initialize complex type");
Skip Montanaroba1e0f42009-10-18 14:25:35 +00001500
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001501 if (PyType_Ready(&PyFloat_Type) < 0)
1502 Py_FatalError("Can't initialize float type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001503
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001504 if (PyType_Ready(&PyLong_Type) < 0)
1505 Py_FatalError("Can't initialize int type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001506
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001507 if (PyType_Ready(&PyFrozenSet_Type) < 0)
1508 Py_FatalError("Can't initialize frozenset type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001510 if (PyType_Ready(&PyProperty_Type) < 0)
1511 Py_FatalError("Can't initialize property type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001512
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001513 if (PyType_Ready(&PyMemoryView_Type) < 0)
1514 Py_FatalError("Can't initialize memoryview type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001515
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001516 if (PyType_Ready(&PyTuple_Type) < 0)
1517 Py_FatalError("Can't initialize tuple type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001518
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001519 if (PyType_Ready(&PyEnum_Type) < 0)
1520 Py_FatalError("Can't initialize enumerate type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001521
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001522 if (PyType_Ready(&PyReversed_Type) < 0)
1523 Py_FatalError("Can't initialize reversed type");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001524
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001525 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1526 Py_FatalError("Can't initialize StdPrinter");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001527
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001528 if (PyType_Ready(&PyCode_Type) < 0)
1529 Py_FatalError("Can't initialize code type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001530
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001531 if (PyType_Ready(&PyFrame_Type) < 0)
1532 Py_FatalError("Can't initialize frame type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001533
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001534 if (PyType_Ready(&PyCFunction_Type) < 0)
1535 Py_FatalError("Can't initialize builtin function type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001536
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001537 if (PyType_Ready(&PyMethod_Type) < 0)
1538 Py_FatalError("Can't initialize method type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001539
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001540 if (PyType_Ready(&PyFunction_Type) < 0)
1541 Py_FatalError("Can't initialize function type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001542
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001543 if (PyType_Ready(&PyDictProxy_Type) < 0)
1544 Py_FatalError("Can't initialize dict proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001545
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001546 if (PyType_Ready(&PyGen_Type) < 0)
1547 Py_FatalError("Can't initialize generator type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001548
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001549 if (PyType_Ready(&PyGetSetDescr_Type) < 0)
1550 Py_FatalError("Can't initialize get-set descriptor type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001551
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001552 if (PyType_Ready(&PyWrapperDescr_Type) < 0)
1553 Py_FatalError("Can't initialize wrapper type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001554
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001555 if (PyType_Ready(&_PyMethodWrapper_Type) < 0)
1556 Py_FatalError("Can't initialize method wrapper type");
1557
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001558 if (PyType_Ready(&PyEllipsis_Type) < 0)
1559 Py_FatalError("Can't initialize ellipsis type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001560
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001561 if (PyType_Ready(&PyMemberDescr_Type) < 0)
1562 Py_FatalError("Can't initialize member descriptor type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001563
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001564 if (PyType_Ready(&PyFilter_Type) < 0)
1565 Py_FatalError("Can't initialize filter type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001566
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001567 if (PyType_Ready(&PyMap_Type) < 0)
1568 Py_FatalError("Can't initialize map type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001569
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001570 if (PyType_Ready(&PyZip_Type) < 0)
1571 Py_FatalError("Can't initialize zip type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001572}
1573
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001574
Guido van Rossum84a90321996-05-22 16:34:47 +00001575#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001576
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001577void
Fred Drake100814d2000-07-09 15:48:49 +00001578_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001579{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001580 _Py_INC_REFTOTAL;
1581 op->ob_refcnt = 1;
1582 _Py_AddToAllObjects(op, 1);
1583 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001584}
1585
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001586void
Fred Drake100814d2000-07-09 15:48:49 +00001587_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001588{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001589#ifdef SLOW_UNREF_CHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001590 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001591#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001592 if (op->ob_refcnt < 0)
1593 Py_FatalError("UNREF negative refcnt");
1594 if (op == &refchain ||
1595 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1596 fprintf(stderr, "* ob\n");
1597 _PyObject_Dump(op);
1598 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1599 _PyObject_Dump(op->_ob_prev->_ob_next);
1600 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1601 _PyObject_Dump(op->_ob_next->_ob_prev);
1602 Py_FatalError("UNREF invalid object");
1603 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001604#ifdef SLOW_UNREF_CHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001605 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1606 if (p == op)
1607 break;
1608 }
1609 if (p == &refchain) /* Not found */
1610 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001611#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001612 op->_ob_next->_ob_prev = op->_ob_prev;
1613 op->_ob_prev->_ob_next = op->_ob_next;
1614 op->_ob_next = op->_ob_prev = NULL;
1615 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001616}
1617
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001618void
Fred Drake100814d2000-07-09 15:48:49 +00001619_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001620{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001621 destructor dealloc = Py_TYPE(op)->tp_dealloc;
1622 _Py_ForgetReference(op);
1623 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001624}
1625
Tim Peters269b2a62003-04-17 19:52:29 +00001626/* Print all live objects. Because PyObject_Print is called, the
1627 * interpreter must be in a healthy state.
1628 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001629void
Fred Drake100814d2000-07-09 15:48:49 +00001630_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001631{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001632 PyObject *op;
1633 fprintf(fp, "Remaining objects:\n");
1634 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
1635 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
1636 if (PyObject_Print(op, fp, 0) != 0)
1637 PyErr_Clear();
1638 putc('\n', fp);
1639 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001640}
1641
Tim Peters269b2a62003-04-17 19:52:29 +00001642/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1643 * doesn't make any calls to the Python C API, so is always safe to call.
1644 */
1645void
1646_Py_PrintReferenceAddresses(FILE *fp)
1647{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001648 PyObject *op;
1649 fprintf(fp, "Remaining object addresses:\n");
1650 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
1651 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
1652 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001653}
1654
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001655PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001656_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001657{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001658 int i, n;
1659 PyObject *t = NULL;
1660 PyObject *res, *op;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001661
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001662 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1663 return NULL;
1664 op = refchain._ob_next;
1665 res = PyList_New(0);
1666 if (res == NULL)
1667 return NULL;
1668 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1669 while (op == self || op == args || op == res || op == t ||
1670 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
1671 op = op->_ob_next;
1672 if (op == &refchain)
1673 return res;
1674 }
1675 if (PyList_Append(res, op) < 0) {
1676 Py_DECREF(res);
1677 return NULL;
1678 }
1679 op = op->_ob_next;
1680 }
1681 return res;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001682}
1683
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001684#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001685
Benjamin Petersonb173f782009-05-05 22:31:58 +00001686/* Hack to force loading of pycapsule.o */
1687PyTypeObject *_PyCapsule_hack = &PyCapsule_Type;
1688
1689
Guido van Rossum84a90321996-05-22 16:34:47 +00001690/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001691Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001692
1693
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001694/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001695
Thomas Wouters334fb892000-07-25 12:56:38 +00001696void *
Fred Drake100814d2000-07-09 15:48:49 +00001697PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001698{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001699 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001700}
1701
Thomas Wouters334fb892000-07-25 12:56:38 +00001702void *
1703PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001704{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001705 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001706}
1707
1708void
Thomas Wouters334fb892000-07-25 12:56:38 +00001709PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001710{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001711 PyMem_FREE(p);
Guido van Rossumb18618d2000-05-03 23:44:39 +00001712}
1713
1714
Guido van Rossum86610361998-04-10 22:32:46 +00001715/* These methods are used to control infinite recursion in repr, str, print,
1716 etc. Container objects that may recursively contain themselves,
1717 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1718 Py_ReprLeave() to avoid infinite recursion.
1719
1720 Py_ReprEnter() returns 0 the first time it is called for a particular
1721 object and 1 every time thereafter. It returns -1 if an exception
1722 occurred. Py_ReprLeave() has no return value.
1723
1724 See dictobject.c and listobject.c for examples of use.
1725*/
1726
1727#define KEY "Py_Repr"
1728
1729int
Fred Drake100814d2000-07-09 15:48:49 +00001730Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001731{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001732 PyObject *dict;
1733 PyObject *list;
1734 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001735
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001736 dict = PyThreadState_GetDict();
1737 if (dict == NULL)
1738 return 0;
1739 list = PyDict_GetItemString(dict, KEY);
1740 if (list == NULL) {
1741 list = PyList_New(0);
1742 if (list == NULL)
1743 return -1;
1744 if (PyDict_SetItemString(dict, KEY, list) < 0)
1745 return -1;
1746 Py_DECREF(list);
1747 }
1748 i = PyList_GET_SIZE(list);
1749 while (--i >= 0) {
1750 if (PyList_GET_ITEM(list, i) == obj)
1751 return 1;
1752 }
1753 PyList_Append(list, obj);
1754 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001755}
1756
1757void
Fred Drake100814d2000-07-09 15:48:49 +00001758Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001759{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001760 PyObject *dict;
1761 PyObject *list;
1762 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001763
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001764 dict = PyThreadState_GetDict();
1765 if (dict == NULL)
1766 return;
1767 list = PyDict_GetItemString(dict, KEY);
1768 if (list == NULL || !PyList_Check(list))
1769 return;
1770 i = PyList_GET_SIZE(list);
1771 /* Count backwards because we always expect obj to be list[-1] */
1772 while (--i >= 0) {
1773 if (PyList_GET_ITEM(list, i) == obj) {
1774 PyList_SetSlice(list, i, i + 1, NULL);
1775 break;
1776 }
1777 }
Guido van Rossum86610361998-04-10 22:32:46 +00001778}
Guido van Rossumd724b232000-03-13 16:01:29 +00001779
Tim Peters803526b2002-07-07 05:13:56 +00001780/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001781
Tim Peters803526b2002-07-07 05:13:56 +00001782/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001783int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001784
Tim Peters803526b2002-07-07 05:13:56 +00001785/* List of objects that still need to be cleaned up, singly linked via their
1786 * gc headers' gc_prev pointers.
1787 */
1788PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001789
Tim Peters803526b2002-07-07 05:13:56 +00001790/* Add op to the _PyTrash_delete_later list. Called when the current
1791 * call-stack depth gets large. op must be a currently untracked gc'ed
1792 * object, with refcount 0. Py_DECREF must already have been called on it.
1793 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001794void
Fred Drake100814d2000-07-09 15:48:49 +00001795_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001796{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001797 assert(PyObject_IS_GC(op));
1798 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1799 assert(op->ob_refcnt == 0);
1800 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
1801 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001802}
1803
Tim Peters803526b2002-07-07 05:13:56 +00001804/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1805 * the call-stack unwinds again.
1806 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001807void
Fred Drake100814d2000-07-09 15:48:49 +00001808_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001809{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001810 while (_PyTrash_delete_later) {
1811 PyObject *op = _PyTrash_delete_later;
1812 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001813
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001814 _PyTrash_delete_later =
1815 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001816
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001817 /* Call the deallocator directly. This used to try to
1818 * fool Py_DECREF into calling it indirectly, but
1819 * Py_DECREF was already called on this object, and in
1820 * assorted non-release builds calling Py_DECREF again ends
1821 * up distorting allocation statistics.
1822 */
1823 assert(op->ob_refcnt == 0);
1824 ++_PyTrash_delete_nesting;
1825 (*dealloc)(op);
1826 --_PyTrash_delete_nesting;
1827 }
Guido van Rossumd724b232000-03-13 16:01:29 +00001828}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001829
Martin v. Löwis4d0d4712010-12-03 20:14:31 +00001830#ifndef Py_TRACE_REFS
1831/* For Py_LIMITED_API, we need an out-of-line version of _Py_Dealloc.
1832 Define this here, so we can undefine the macro. */
1833#undef _Py_Dealloc
1834PyAPI_FUNC(void) _Py_Dealloc(PyObject *);
1835void
1836_Py_Dealloc(PyObject *op)
1837{
1838 _Py_INC_TPFREES(op) _Py_COUNT_ALLOCS_COMMA
1839 (*Py_TYPE(op)->tp_dealloc)(op);
1840}
1841#endif
1842
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001843#ifdef __cplusplus
1844}
1845#endif