blob: ad31738d49d927757624ac0e330cfa20b8c7e37a [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);
Victor Stinner0a54cf12011-12-01 03:22:44 +0100381 if (res == NULL)
382 return NULL;
383 if (!PyUnicode_Check(res)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000384 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 }
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100390#ifndef Py_DEBUG
391 if (PyUnicode_READY(res) < 0)
392 return NULL;
393#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000394 return res;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000395}
396
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000397PyObject *
Guido van Rossum98297ee2007-11-06 21:34:58 +0000398PyObject_Str(PyObject *v)
Guido van Rossumc6004111993-11-05 10:22:19 +0000399{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000400 PyObject *res;
401 if (PyErr_CheckSignals())
402 return NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000403#ifdef USE_STACKCHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000404 if (PyOS_CheckStack()) {
405 PyErr_SetString(PyExc_MemoryError, "stack overflow");
406 return NULL;
407 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000408#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000409 if (v == NULL)
410 return PyUnicode_FromString("<NULL>");
411 if (PyUnicode_CheckExact(v)) {
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100412#ifndef Py_DEBUG
Victor Stinner4ead7c72011-11-20 19:48:36 +0100413 if (PyUnicode_READY(v) < 0)
414 return NULL;
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100415#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000416 Py_INCREF(v);
417 return v;
418 }
419 if (Py_TYPE(v)->tp_str == NULL)
420 return PyObject_Repr(v);
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000421
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000422 /* It is possible for a type to have a tp_str representation that loops
423 infinitely. */
424 if (Py_EnterRecursiveCall(" while getting the str of an object"))
425 return NULL;
426 res = (*Py_TYPE(v)->tp_str)(v);
427 Py_LeaveRecursiveCall();
428 if (res == NULL)
429 return NULL;
430 if (!PyUnicode_Check(res)) {
431 PyErr_Format(PyExc_TypeError,
432 "__str__ returned non-string (type %.200s)",
433 Py_TYPE(res)->tp_name);
434 Py_DECREF(res);
435 return NULL;
436 }
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100437#ifndef Py_DEBUG
Victor Stinner4ead7c72011-11-20 19:48:36 +0100438 if (PyUnicode_READY(res) < 0)
439 return NULL;
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100440#endif
Victor Stinner4ead7c72011-11-20 19:48:36 +0100441 assert(_PyUnicode_CheckConsistency(res, 1));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000442 return res;
Neil Schemenauercf52c072005-08-12 17:34:58 +0000443}
444
Georg Brandl559e5d72008-06-11 18:37:52 +0000445PyObject *
446PyObject_ASCII(PyObject *v)
447{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000448 PyObject *repr, *ascii, *res;
Georg Brandl559e5d72008-06-11 18:37:52 +0000449
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000450 repr = PyObject_Repr(v);
451 if (repr == NULL)
452 return NULL;
Georg Brandl559e5d72008-06-11 18:37:52 +0000453
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000454 /* repr is guaranteed to be a PyUnicode object by PyObject_Repr */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200455 ascii = _PyUnicode_AsASCIIString(repr, "backslashreplace");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000456 Py_DECREF(repr);
457 if (ascii == NULL)
458 return NULL;
Georg Brandl559e5d72008-06-11 18:37:52 +0000459
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000460 res = PyUnicode_DecodeASCII(
461 PyBytes_AS_STRING(ascii),
462 PyBytes_GET_SIZE(ascii),
463 NULL);
464
465 Py_DECREF(ascii);
466 return res;
Georg Brandl559e5d72008-06-11 18:37:52 +0000467}
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000468
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000469PyObject *
470PyObject_Bytes(PyObject *v)
471{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000472 PyObject *result, *func;
473 static PyObject *bytesstring = NULL;
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000474
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000475 if (v == NULL)
476 return PyBytes_FromString("<NULL>");
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000477
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000478 if (PyBytes_CheckExact(v)) {
479 Py_INCREF(v);
480 return v;
481 }
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000482
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000483 func = _PyObject_LookupSpecial(v, "__bytes__", &bytesstring);
484 if (func != NULL) {
485 result = PyObject_CallFunctionObjArgs(func, NULL);
486 Py_DECREF(func);
487 if (result == NULL)
Benjamin Peterson41ece392010-09-11 16:39:57 +0000488 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000489 if (!PyBytes_Check(result)) {
Benjamin Peterson41ece392010-09-11 16:39:57 +0000490 PyErr_Format(PyExc_TypeError,
491 "__bytes__ returned non-bytes (type %.200s)",
492 Py_TYPE(result)->tp_name);
493 Py_DECREF(result);
494 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000495 }
496 return result;
497 }
498 else if (PyErr_Occurred())
499 return NULL;
500 return PyBytes_FromObject(v);
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000501}
502
Mark Dickinsonc008a172009-02-01 13:59:22 +0000503/* For Python 3.0.1 and later, the old three-way comparison has been
504 completely removed in favour of rich comparisons. PyObject_Compare() and
505 PyObject_Cmp() are gone, and the builtin cmp function no longer exists.
Mark Dickinsone94c6792009-02-02 20:36:42 +0000506 The old tp_compare slot has been renamed to tp_reserved, and should no
Mark Dickinsonc008a172009-02-01 13:59:22 +0000507 longer be used. Use tp_richcompare instead.
Guido van Rossum98297ee2007-11-06 21:34:58 +0000508
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000509 See (*) below for practical amendments.
510
Mark Dickinsonc008a172009-02-01 13:59:22 +0000511 tp_richcompare gets called with a first argument of the appropriate type
512 and a second object of an arbitrary type. We never do any kind of
513 coercion.
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000514
Mark Dickinsonc008a172009-02-01 13:59:22 +0000515 The tp_richcompare slot should return an object, as follows:
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000516
517 NULL if an exception occurred
518 NotImplemented if the requested comparison is not implemented
519 any other false value if the requested comparison is false
520 any other true value if the requested comparison is true
521
522 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
523 NotImplemented.
524
525 (*) Practical amendments:
526
527 - If rich comparison returns NotImplemented, == and != are decided by
528 comparing the object pointer (i.e. falling back to the base object
529 implementation).
530
Guido van Rossuma4073002002-05-31 20:03:54 +0000531*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000532
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000533/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000534int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000535
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000536static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000537
538/* Perform a rich comparison, raising TypeError when the requested comparison
539 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000540static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000541do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000542{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000543 richcmpfunc f;
544 PyObject *res;
545 int checked_reverse_op = 0;
Guido van Rossume797ec12001-01-17 15:24:28 +0000546
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000547 if (v->ob_type != w->ob_type &&
548 PyType_IsSubtype(w->ob_type, v->ob_type) &&
549 (f = w->ob_type->tp_richcompare) != NULL) {
550 checked_reverse_op = 1;
551 res = (*f)(w, v, _Py_SwappedOp[op]);
552 if (res != Py_NotImplemented)
553 return res;
554 Py_DECREF(res);
555 }
556 if ((f = v->ob_type->tp_richcompare) != NULL) {
557 res = (*f)(v, w, op);
558 if (res != Py_NotImplemented)
559 return res;
560 Py_DECREF(res);
561 }
562 if (!checked_reverse_op && (f = w->ob_type->tp_richcompare) != NULL) {
563 res = (*f)(w, v, _Py_SwappedOp[op]);
564 if (res != Py_NotImplemented)
565 return res;
566 Py_DECREF(res);
567 }
568 /* If neither object implements it, provide a sensible default
569 for == and !=, but raise an exception for ordering. */
570 switch (op) {
571 case Py_EQ:
572 res = (v == w) ? Py_True : Py_False;
573 break;
574 case Py_NE:
575 res = (v != w) ? Py_True : Py_False;
576 break;
577 default:
578 /* XXX Special-case None so it doesn't show as NoneType() */
579 PyErr_Format(PyExc_TypeError,
580 "unorderable types: %.100s() %s %.100s()",
581 v->ob_type->tp_name,
582 opstrings[op],
583 w->ob_type->tp_name);
584 return NULL;
585 }
586 Py_INCREF(res);
587 return res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000588}
589
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000590/* Perform a rich comparison with object result. This wraps do_richcompare()
591 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000592
Guido van Rossume797ec12001-01-17 15:24:28 +0000593PyObject *
594PyObject_RichCompare(PyObject *v, PyObject *w, int op)
595{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000596 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000597
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000598 assert(Py_LT <= op && op <= Py_GE);
599 if (v == NULL || w == NULL) {
600 if (!PyErr_Occurred())
601 PyErr_BadInternalCall();
602 return NULL;
603 }
604 if (Py_EnterRecursiveCall(" in comparison"))
605 return NULL;
606 res = do_richcompare(v, w, op);
607 Py_LeaveRecursiveCall();
608 return res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000609}
610
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000611/* Perform a rich comparison with integer result. This wraps
612 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000613int
614PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
615{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000616 PyObject *res;
617 int ok;
Guido van Rossume797ec12001-01-17 15:24:28 +0000618
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000619 /* Quick result when objects are the same.
620 Guarantees that identity implies equality. */
621 if (v == w) {
622 if (op == Py_EQ)
623 return 1;
624 else if (op == Py_NE)
625 return 0;
626 }
Mark Dickinson4a1f5932008-11-12 23:23:36 +0000627
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000628 res = PyObject_RichCompare(v, w, op);
629 if (res == NULL)
630 return -1;
631 if (PyBool_Check(res))
632 ok = (res == Py_True);
633 else
634 ok = PyObject_IsTrue(res);
635 Py_DECREF(res);
636 return ok;
Guido van Rossume797ec12001-01-17 15:24:28 +0000637}
Fred Drake13634cf2000-06-29 19:17:04 +0000638
639/* Set of hash utility functions to help maintaining the invariant that
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000640 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000641
642 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
643*/
644
Mark Dickinsondc787d22010-05-23 13:33:13 +0000645/* For numeric types, the hash of a number x is based on the reduction
646 of x modulo the prime P = 2**_PyHASH_BITS - 1. It's designed so that
647 hash(x) == hash(y) whenever x and y are numerically equal, even if
648 x and y have different types.
649
650 A quick summary of the hashing strategy:
651
652 (1) First define the 'reduction of x modulo P' for any rational
653 number x; this is a standard extension of the usual notion of
654 reduction modulo P for integers. If x == p/q (written in lowest
655 terms), the reduction is interpreted as the reduction of p times
656 the inverse of the reduction of q, all modulo P; if q is exactly
657 divisible by P then define the reduction to be infinity. So we've
658 got a well-defined map
659
660 reduce : { rational numbers } -> { 0, 1, 2, ..., P-1, infinity }.
661
662 (2) Now for a rational number x, define hash(x) by:
663
664 reduce(x) if x >= 0
665 -reduce(-x) if x < 0
666
667 If the result of the reduction is infinity (this is impossible for
668 integers, floats and Decimals) then use the predefined hash value
669 _PyHASH_INF for x >= 0, or -_PyHASH_INF for x < 0, instead.
670 _PyHASH_INF, -_PyHASH_INF and _PyHASH_NAN are also used for the
671 hashes of float and Decimal infinities and nans.
672
673 A selling point for the above strategy is that it makes it possible
674 to compute hashes of decimal and binary floating-point numbers
675 efficiently, even if the exponent of the binary or decimal number
676 is large. The key point is that
677
678 reduce(x * y) == reduce(x) * reduce(y) (modulo _PyHASH_MODULUS)
679
680 provided that {reduce(x), reduce(y)} != {0, infinity}. The reduction of a
681 binary or decimal float is never infinity, since the denominator is a power
682 of 2 (for binary) or a divisor of a power of 10 (for decimal). So we have,
683 for nonnegative x,
684
685 reduce(x * 2**e) == reduce(x) * reduce(2**e) % _PyHASH_MODULUS
686
687 reduce(x * 10**e) == reduce(x) * reduce(10**e) % _PyHASH_MODULUS
688
689 and reduce(10**e) can be computed efficiently by the usual modular
690 exponentiation algorithm. For reduce(2**e) it's even better: since
691 P is of the form 2**n-1, reduce(2**e) is 2**(e mod n), and multiplication
692 by 2**(e mod n) modulo 2**n-1 just amounts to a rotation of bits.
693
694 */
695
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000696Py_hash_t
Fred Drake100814d2000-07-09 15:48:49 +0000697_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000698{
Mark Dickinsondc787d22010-05-23 13:33:13 +0000699 int e, sign;
700 double m;
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000701 Py_uhash_t x, y;
Tim Peters39dce292000-08-15 03:34:48 +0000702
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000703 if (!Py_IS_FINITE(v)) {
704 if (Py_IS_INFINITY(v))
Mark Dickinsondc787d22010-05-23 13:33:13 +0000705 return v > 0 ? _PyHASH_INF : -_PyHASH_INF;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000706 else
Mark Dickinsondc787d22010-05-23 13:33:13 +0000707 return _PyHASH_NAN;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000708 }
Mark Dickinsondc787d22010-05-23 13:33:13 +0000709
710 m = frexp(v, &e);
711
712 sign = 1;
713 if (m < 0) {
714 sign = -1;
715 m = -m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000716 }
Mark Dickinsondc787d22010-05-23 13:33:13 +0000717
718 /* process 28 bits at a time; this should work well both for binary
719 and hexadecimal floating point. */
720 x = 0;
721 while (m) {
722 x = ((x << 28) & _PyHASH_MODULUS) | x >> (_PyHASH_BITS - 28);
723 m *= 268435456.0; /* 2**28 */
724 e -= 28;
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000725 y = (Py_uhash_t)m; /* pull out integer part */
Mark Dickinsondc787d22010-05-23 13:33:13 +0000726 m -= y;
727 x += y;
728 if (x >= _PyHASH_MODULUS)
729 x -= _PyHASH_MODULUS;
730 }
731
732 /* adjust for the exponent; first reduce it modulo _PyHASH_BITS */
733 e = e >= 0 ? e % _PyHASH_BITS : _PyHASH_BITS-1-((-1-e) % _PyHASH_BITS);
734 x = ((x << e) & _PyHASH_MODULUS) | x >> (_PyHASH_BITS - e);
735
736 x = x * sign;
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000737 if (x == (Py_uhash_t)-1)
738 x = (Py_uhash_t)-2;
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000739 return (Py_hash_t)x;
Fred Drake13634cf2000-06-29 19:17:04 +0000740}
741
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000742Py_hash_t
Fred Drake100814d2000-07-09 15:48:49 +0000743_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000744{
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000745 Py_hash_t x;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000746 size_t y = (size_t)p;
747 /* bottom 3 or 4 bits are likely to be 0; rotate y by 4 to avoid
748 excessive hash collisions for dicts and sets */
749 y = (y >> 4) | (y << (8 * SIZEOF_VOID_P - 4));
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000750 x = (Py_hash_t)y;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000751 if (x == -1)
752 x = -2;
753 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000754}
755
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000756Py_hash_t
Antoine Pitrouce4a9da2011-11-21 20:46:33 +0100757_Py_HashBytes(unsigned char *p, Py_ssize_t len)
758{
759 Py_uhash_t x;
760 Py_ssize_t i;
761
762 x = (Py_uhash_t) *p << 7;
763 for (i = 0; i < len; i++)
764 x = (1000003U * x) ^ (Py_uhash_t) *p++;
765 x ^= (Py_uhash_t) len;
766 if (x == -1)
767 x = -2;
768 return x;
769}
770
771Py_hash_t
Nick Coghland1abd252008-07-15 15:46:38 +0000772PyObject_HashNotImplemented(PyObject *v)
773{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000774 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
775 Py_TYPE(v)->tp_name);
776 return -1;
Nick Coghland1abd252008-07-15 15:46:38 +0000777}
Fred Drake13634cf2000-06-29 19:17:04 +0000778
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000779Py_hash_t
Fred Drake100814d2000-07-09 15:48:49 +0000780PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000781{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000782 PyTypeObject *tp = Py_TYPE(v);
783 if (tp->tp_hash != NULL)
784 return (*tp->tp_hash)(v);
785 /* To keep to the general practice that inheriting
786 * solely from object in C code should work without
787 * an explicit call to PyType_Ready, we implicitly call
788 * PyType_Ready here and then check the tp_hash slot again
789 */
790 if (tp->tp_dict == NULL) {
791 if (PyType_Ready(tp) < 0)
792 return -1;
793 if (tp->tp_hash != NULL)
794 return (*tp->tp_hash)(v);
795 }
796 /* Otherwise, the object can't be hashed */
797 return PyObject_HashNotImplemented(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000798}
799
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000800PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000801PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000802{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000803 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000804
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000805 if (Py_TYPE(v)->tp_getattr != NULL)
806 return (*Py_TYPE(v)->tp_getattr)(v, (char*)name);
807 w = PyUnicode_InternFromString(name);
808 if (w == NULL)
809 return NULL;
810 res = PyObject_GetAttr(v, w);
811 Py_XDECREF(w);
812 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000813}
814
815int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000816PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000817{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000818 PyObject *res = PyObject_GetAttrString(v, name);
819 if (res != NULL) {
820 Py_DECREF(res);
821 return 1;
822 }
823 PyErr_Clear();
824 return 0;
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000825}
826
827int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000828PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000829{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000830 PyObject *s;
831 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000832
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000833 if (Py_TYPE(v)->tp_setattr != NULL)
834 return (*Py_TYPE(v)->tp_setattr)(v, (char*)name, w);
835 s = PyUnicode_InternFromString(name);
836 if (s == NULL)
837 return -1;
838 res = PyObject_SetAttr(v, s, w);
839 Py_XDECREF(s);
840 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000841}
842
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000843PyObject *
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200844_PyObject_GetAttrId(PyObject *v, _Py_Identifier *name)
845{
846 PyObject *result;
Martin v. Löwisd10759f2011-11-07 13:00:05 +0100847 PyObject *oname = _PyUnicode_FromId(name); /* borrowed */
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200848 if (!oname)
849 return NULL;
850 result = PyObject_GetAttr(v, oname);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200851 return result;
852}
853
854int
855_PyObject_HasAttrId(PyObject *v, _Py_Identifier *name)
856{
857 int result;
Martin v. Löwisd10759f2011-11-07 13:00:05 +0100858 PyObject *oname = _PyUnicode_FromId(name); /* borrowed */
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200859 if (!oname)
860 return -1;
861 result = PyObject_HasAttr(v, oname);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200862 return result;
863}
864
865int
866_PyObject_SetAttrId(PyObject *v, _Py_Identifier *name, PyObject *w)
867{
868 int result;
Martin v. Löwisd10759f2011-11-07 13:00:05 +0100869 PyObject *oname = _PyUnicode_FromId(name); /* borrowed */
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200870 if (!oname)
871 return -1;
872 result = PyObject_SetAttr(v, oname, w);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200873 return result;
874}
875
876PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000877PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000878{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000879 PyTypeObject *tp = Py_TYPE(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000880
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000881 if (!PyUnicode_Check(name)) {
882 PyErr_Format(PyExc_TypeError,
883 "attribute name must be string, not '%.200s'",
884 name->ob_type->tp_name);
885 return NULL;
886 }
887 if (tp->tp_getattro != NULL)
888 return (*tp->tp_getattro)(v, name);
889 if (tp->tp_getattr != NULL) {
890 char *name_str = _PyUnicode_AsString(name);
891 if (name_str == NULL)
892 return NULL;
893 return (*tp->tp_getattr)(v, name_str);
894 }
895 PyErr_Format(PyExc_AttributeError,
896 "'%.50s' object has no attribute '%U'",
897 tp->tp_name, name);
898 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000899}
900
901int
Fred Drake100814d2000-07-09 15:48:49 +0000902PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000903{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000904 PyObject *res = PyObject_GetAttr(v, name);
905 if (res != NULL) {
906 Py_DECREF(res);
907 return 1;
908 }
909 PyErr_Clear();
910 return 0;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000911}
912
913int
Fred Drake100814d2000-07-09 15:48:49 +0000914PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000915{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000916 PyTypeObject *tp = Py_TYPE(v);
917 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000918
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000919 if (!PyUnicode_Check(name)) {
920 PyErr_Format(PyExc_TypeError,
921 "attribute name must be string, not '%.200s'",
922 name->ob_type->tp_name);
923 return -1;
924 }
925 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000926
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000927 PyUnicode_InternInPlace(&name);
928 if (tp->tp_setattro != NULL) {
929 err = (*tp->tp_setattro)(v, name, value);
930 Py_DECREF(name);
931 return err;
932 }
933 if (tp->tp_setattr != NULL) {
934 char *name_str = _PyUnicode_AsString(name);
935 if (name_str == NULL)
936 return -1;
937 err = (*tp->tp_setattr)(v, name_str, value);
938 Py_DECREF(name);
939 return err;
940 }
941 Py_DECREF(name);
942 assert(name->ob_refcnt >= 1);
943 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
944 PyErr_Format(PyExc_TypeError,
945 "'%.100s' object has no attributes "
946 "(%s .%U)",
947 tp->tp_name,
948 value==NULL ? "del" : "assign to",
949 name);
950 else
951 PyErr_Format(PyExc_TypeError,
952 "'%.100s' object has only read-only attributes "
953 "(%s .%U)",
954 tp->tp_name,
955 value==NULL ? "del" : "assign to",
956 name);
957 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000958}
959
960/* Helper to get a pointer to an object's __dict__ slot, if any */
961
962PyObject **
963_PyObject_GetDictPtr(PyObject *obj)
964{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000965 Py_ssize_t dictoffset;
966 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000967
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000968 dictoffset = tp->tp_dictoffset;
969 if (dictoffset == 0)
970 return NULL;
971 if (dictoffset < 0) {
972 Py_ssize_t tsize;
973 size_t size;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000974
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000975 tsize = ((PyVarObject *)obj)->ob_size;
976 if (tsize < 0)
977 tsize = -tsize;
978 size = _PyObject_VAR_SIZE(tp, tsize);
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000979
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000980 dictoffset += (long)size;
981 assert(dictoffset > 0);
982 assert(dictoffset % SIZEOF_VOID_P == 0);
983 }
984 return (PyObject **) ((char *)obj + dictoffset);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000985}
986
Tim Peters6d6c1a32001-08-02 04:15:00 +0000987PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000988PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +0000989{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000990 Py_INCREF(obj);
991 return obj;
Raymond Hettinger01538262003-03-17 08:24:35 +0000992}
993
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +0000994/* Helper used when the __next__ method is removed from a type:
995 tp_iternext is never NULL and can be safely called without checking
996 on every iteration.
997 */
998
999PyObject *
1000_PyObject_NextNotImplemented(PyObject *self)
1001{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001002 PyErr_Format(PyExc_TypeError,
1003 "'%.200s' object is not iterable",
1004 Py_TYPE(self)->tp_name);
1005 return NULL;
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +00001006}
1007
Michael W. Hudson1593f502004-09-14 17:09:47 +00001008/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
1009
Raymond Hettinger01538262003-03-17 08:24:35 +00001010PyObject *
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001011_PyObject_GenericGetAttrWithDict(PyObject *obj, PyObject *name, PyObject *dict)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001012{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001013 PyTypeObject *tp = Py_TYPE(obj);
1014 PyObject *descr = NULL;
1015 PyObject *res = NULL;
1016 descrgetfunc f;
1017 Py_ssize_t dictoffset;
1018 PyObject **dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001019
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001020 if (!PyUnicode_Check(name)){
1021 PyErr_Format(PyExc_TypeError,
1022 "attribute name must be string, not '%.200s'",
1023 name->ob_type->tp_name);
1024 return NULL;
1025 }
1026 else
1027 Py_INCREF(name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001028
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001029 if (tp->tp_dict == NULL) {
1030 if (PyType_Ready(tp) < 0)
1031 goto done;
1032 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001033
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001034 descr = _PyType_Lookup(tp, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001035 Py_XINCREF(descr);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001036
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001037 f = NULL;
1038 if (descr != NULL) {
1039 f = descr->ob_type->tp_descr_get;
1040 if (f != NULL && PyDescr_IsData(descr)) {
1041 res = f(descr, obj, (PyObject *)obj->ob_type);
1042 Py_DECREF(descr);
1043 goto done;
1044 }
1045 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001046
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001047 if (dict == NULL) {
1048 /* Inline _PyObject_GetDictPtr */
1049 dictoffset = tp->tp_dictoffset;
1050 if (dictoffset != 0) {
1051 if (dictoffset < 0) {
1052 Py_ssize_t tsize;
1053 size_t size;
Guido van Rossumc66ff442002-08-19 16:50:48 +00001054
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001055 tsize = ((PyVarObject *)obj)->ob_size;
1056 if (tsize < 0)
1057 tsize = -tsize;
1058 size = _PyObject_VAR_SIZE(tp, tsize);
Guido van Rossumc66ff442002-08-19 16:50:48 +00001059
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001060 dictoffset += (long)size;
1061 assert(dictoffset > 0);
1062 assert(dictoffset % SIZEOF_VOID_P == 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001063 }
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001064 dictptr = (PyObject **) ((char *)obj + dictoffset);
1065 dict = *dictptr;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001066 }
1067 }
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001068 if (dict != NULL) {
1069 Py_INCREF(dict);
1070 res = PyDict_GetItem(dict, name);
1071 if (res != NULL) {
1072 Py_INCREF(res);
1073 Py_XDECREF(descr);
1074 Py_DECREF(dict);
1075 goto done;
1076 }
1077 Py_DECREF(dict);
1078 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001079
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001080 if (f != NULL) {
1081 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
1082 Py_DECREF(descr);
1083 goto done;
1084 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001085
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001086 if (descr != NULL) {
1087 res = descr;
1088 /* descr was already increfed above */
1089 goto done;
1090 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001091
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001092 PyErr_Format(PyExc_AttributeError,
1093 "'%.50s' object has no attribute '%U'",
1094 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001095 done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001096 Py_DECREF(name);
1097 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001098}
1099
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001100PyObject *
1101PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
1102{
1103 return _PyObject_GenericGetAttrWithDict(obj, name, NULL);
1104}
1105
Tim Peters6d6c1a32001-08-02 04:15:00 +00001106int
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001107_PyObject_GenericSetAttrWithDict(PyObject *obj, PyObject *name,
1108 PyObject *value, PyObject *dict)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001109{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001110 PyTypeObject *tp = Py_TYPE(obj);
1111 PyObject *descr;
1112 descrsetfunc f;
1113 PyObject **dictptr;
1114 int res = -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001115
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001116 if (!PyUnicode_Check(name)){
1117 PyErr_Format(PyExc_TypeError,
1118 "attribute name must be string, not '%.200s'",
1119 name->ob_type->tp_name);
1120 return -1;
1121 }
1122 else
1123 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001124
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001125 if (tp->tp_dict == NULL) {
1126 if (PyType_Ready(tp) < 0)
1127 goto done;
1128 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001129
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001130 descr = _PyType_Lookup(tp, name);
1131 f = NULL;
1132 if (descr != NULL) {
1133 f = descr->ob_type->tp_descr_set;
1134 if (f != NULL && PyDescr_IsData(descr)) {
1135 res = f(descr, obj, value);
1136 goto done;
1137 }
1138 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001139
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001140 if (dict == NULL) {
1141 dictptr = _PyObject_GetDictPtr(obj);
1142 if (dictptr != NULL) {
1143 dict = *dictptr;
1144 if (dict == NULL && value != NULL) {
1145 dict = PyDict_New();
1146 if (dict == NULL)
1147 goto done;
1148 *dictptr = dict;
1149 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001150 }
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001151 }
1152 if (dict != NULL) {
1153 Py_INCREF(dict);
1154 if (value == NULL)
1155 res = PyDict_DelItem(dict, name);
1156 else
1157 res = PyDict_SetItem(dict, name, value);
1158 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1159 PyErr_SetObject(PyExc_AttributeError, name);
1160 Py_DECREF(dict);
1161 goto done;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001162 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001163
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001164 if (f != NULL) {
1165 res = f(descr, obj, value);
1166 goto done;
1167 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001168
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001169 if (descr == NULL) {
1170 PyErr_Format(PyExc_AttributeError,
1171 "'%.100s' object has no attribute '%U'",
1172 tp->tp_name, name);
1173 goto done;
1174 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001175
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001176 PyErr_Format(PyExc_AttributeError,
1177 "'%.50s' object attribute '%U' is read-only",
1178 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001179 done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001180 Py_DECREF(name);
1181 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001182}
1183
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001184int
1185PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1186{
1187 return _PyObject_GenericSetAttrWithDict(obj, name, value, NULL);
1188}
1189
1190
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001191/* Test a value used as condition, e.g., in a for or if statement.
1192 Return -1 if an error occurred */
1193
1194int
Fred Drake100814d2000-07-09 15:48:49 +00001195PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001196{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001197 Py_ssize_t res;
1198 if (v == Py_True)
1199 return 1;
1200 if (v == Py_False)
1201 return 0;
1202 if (v == Py_None)
1203 return 0;
1204 else if (v->ob_type->tp_as_number != NULL &&
1205 v->ob_type->tp_as_number->nb_bool != NULL)
1206 res = (*v->ob_type->tp_as_number->nb_bool)(v);
1207 else if (v->ob_type->tp_as_mapping != NULL &&
1208 v->ob_type->tp_as_mapping->mp_length != NULL)
1209 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
1210 else if (v->ob_type->tp_as_sequence != NULL &&
1211 v->ob_type->tp_as_sequence->sq_length != NULL)
1212 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1213 else
1214 return 1;
1215 /* if it is negative, it should be either -1 or -2 */
1216 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001217}
1218
Tim Peters803526b2002-07-07 05:13:56 +00001219/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001220 Return -1 if an error occurred */
1221
1222int
Fred Drake100814d2000-07-09 15:48:49 +00001223PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001224{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001225 int res;
1226 res = PyObject_IsTrue(v);
1227 if (res < 0)
1228 return res;
1229 return res == 0;
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001230}
1231
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001232/* Test whether an object can be called */
1233
1234int
Fred Drake100814d2000-07-09 15:48:49 +00001235PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001236{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001237 if (x == NULL)
1238 return 0;
1239 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001240}
1241
Tim Peters7eea37e2001-09-04 22:08:56 +00001242
Georg Brandle32b4222007-03-10 22:13:27 +00001243/* Helper for PyObject_Dir without arguments: returns the local scope. */
1244static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001245_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001246{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001247 PyObject *names;
1248 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001249
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001250 if (locals == NULL) {
1251 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1252 return NULL;
1253 }
Tim Peters305b5852001-09-17 02:38:46 +00001254
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001255 names = PyMapping_Keys(locals);
1256 if (!names)
1257 return NULL;
1258 if (!PyList_Check(names)) {
1259 PyErr_Format(PyExc_TypeError,
1260 "dir(): expected keys() of locals to be a list, "
1261 "not '%.200s'", Py_TYPE(names)->tp_name);
1262 Py_DECREF(names);
1263 return NULL;
1264 }
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001265 if (PyList_Sort(names)) {
1266 Py_DECREF(names);
1267 return NULL;
1268 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001269 /* the locals don't need to be DECREF'd */
1270 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001271}
1272
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001273/* Helper for PyObject_Dir: object introspection. */
Georg Brandle32b4222007-03-10 22:13:27 +00001274static PyObject *
1275_dir_object(PyObject *obj)
1276{
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001277 PyObject *result, *sorted;
Benjamin Peterson7963a352011-05-23 16:11:05 -05001278 static PyObject *dir_str = NULL;
1279 PyObject *dirfunc = _PyObject_LookupSpecial(obj, "__dir__", &dir_str);
Georg Brandle32b4222007-03-10 22:13:27 +00001280
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001281 assert(obj);
1282 if (dirfunc == NULL) {
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001283 if (!PyErr_Occurred())
1284 PyErr_SetString(PyExc_TypeError, "object does not provide __dir__");
1285 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001286 }
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001287 /* use __dir__ */
1288 result = PyObject_CallFunctionObjArgs(dirfunc, NULL);
1289 Py_DECREF(dirfunc);
1290 if (result == NULL)
1291 return NULL;
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001292 /* return sorted(result) */
1293 sorted = PySequence_List(result);
1294 Py_DECREF(result);
1295 if (sorted == NULL)
1296 return NULL;
1297 if (PyList_Sort(sorted)) {
1298 Py_DECREF(sorted);
1299 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001300 }
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001301 return sorted;
Georg Brandle32b4222007-03-10 22:13:27 +00001302}
1303
1304/* Implementation of dir() -- if obj is NULL, returns the names in the current
1305 (local) scope. Otherwise, performs introspection of the object: returns a
1306 sorted list of attribute names (supposedly) accessible from the object
1307*/
1308PyObject *
1309PyObject_Dir(PyObject *obj)
1310{
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001311 return (obj == NULL) ? _dir_locals() : _dir_object(obj);
Tim Peters7eea37e2001-09-04 22:08:56 +00001312}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001313
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001314/*
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001315None is a non-NULL undefined value.
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001316There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001317so there is exactly one (which is indestructible, by the way).
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001318*/
1319
Guido van Rossum0c182a11992-03-27 17:26:13 +00001320/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001321static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001322none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001323{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001324 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001325}
1326
Barry Warsaw9bf16442001-01-23 16:24:35 +00001327/* ARGUSED */
1328static void
Tim Peters803526b2002-07-07 05:13:56 +00001329none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001330{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001331 /* This should never get called, but we also don't want to SEGV if
1332 * we accidentally decref None out of existence.
1333 */
1334 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001335}
1336
Benjamin Petersonc4607ae2011-07-29 18:19:43 -05001337static PyObject *
1338none_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1339{
1340 if (PyTuple_GET_SIZE(args) || (kwargs && PyDict_Size(kwargs))) {
1341 PyErr_SetString(PyExc_TypeError, "NoneType takes no arguments");
1342 return NULL;
1343 }
1344 Py_RETURN_NONE;
1345}
1346
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001347static int
1348none_bool(PyObject *v)
1349{
1350 return 0;
1351}
1352
1353static PyNumberMethods none_as_number = {
1354 0, /* nb_add */
1355 0, /* nb_subtract */
1356 0, /* nb_multiply */
1357 0, /* nb_remainder */
1358 0, /* nb_divmod */
1359 0, /* nb_power */
1360 0, /* nb_negative */
1361 0, /* nb_positive */
1362 0, /* nb_absolute */
1363 (inquiry)none_bool, /* nb_bool */
1364 0, /* nb_invert */
1365 0, /* nb_lshift */
1366 0, /* nb_rshift */
1367 0, /* nb_and */
1368 0, /* nb_xor */
1369 0, /* nb_or */
1370 0, /* nb_int */
1371 0, /* nb_reserved */
1372 0, /* nb_float */
1373 0, /* nb_inplace_add */
1374 0, /* nb_inplace_subtract */
1375 0, /* nb_inplace_multiply */
1376 0, /* nb_inplace_remainder */
1377 0, /* nb_inplace_power */
1378 0, /* nb_inplace_lshift */
1379 0, /* nb_inplace_rshift */
1380 0, /* nb_inplace_and */
1381 0, /* nb_inplace_xor */
1382 0, /* nb_inplace_or */
1383 0, /* nb_floor_divide */
1384 0, /* nb_true_divide */
1385 0, /* nb_inplace_floor_divide */
1386 0, /* nb_inplace_true_divide */
1387 0, /* nb_index */
1388};
Barry Warsaw9bf16442001-01-23 16:24:35 +00001389
Guido van Rossumba21a492001-08-16 08:17:26 +00001390static PyTypeObject PyNone_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001391 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1392 "NoneType",
1393 0,
1394 0,
1395 none_dealloc, /*tp_dealloc*/ /*never called*/
1396 0, /*tp_print*/
1397 0, /*tp_getattr*/
1398 0, /*tp_setattr*/
1399 0, /*tp_reserved*/
1400 none_repr, /*tp_repr*/
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001401 &none_as_number, /*tp_as_number*/
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001402 0, /*tp_as_sequence*/
1403 0, /*tp_as_mapping*/
1404 0, /*tp_hash */
Benjamin Petersonc4607ae2011-07-29 18:19:43 -05001405 0, /*tp_call */
1406 0, /*tp_str */
1407 0, /*tp_getattro */
1408 0, /*tp_setattro */
1409 0, /*tp_as_buffer */
1410 Py_TPFLAGS_DEFAULT, /*tp_flags */
1411 0, /*tp_doc */
1412 0, /*tp_traverse */
1413 0, /*tp_clear */
1414 0, /*tp_richcompare */
1415 0, /*tp_weaklistoffset */
1416 0, /*tp_iter */
1417 0, /*tp_iternext */
1418 0, /*tp_methods */
1419 0, /*tp_members */
1420 0, /*tp_getset */
1421 0, /*tp_base */
1422 0, /*tp_dict */
1423 0, /*tp_descr_get */
1424 0, /*tp_descr_set */
1425 0, /*tp_dictoffset */
1426 0, /*tp_init */
1427 0, /*tp_alloc */
1428 none_new, /*tp_new */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001429};
1430
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001431PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001432 _PyObject_EXTRA_INIT
1433 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001434};
1435
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001436/* NotImplemented is an object that can be used to signal that an
1437 operation is not implemented for the given type combination. */
1438
1439static PyObject *
1440NotImplemented_repr(PyObject *op)
1441{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001442 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001443}
1444
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001445static PyObject *
1446notimplemented_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1447{
1448 if (PyTuple_GET_SIZE(args) || (kwargs && PyDict_Size(kwargs))) {
1449 PyErr_SetString(PyExc_TypeError, "NotImplementedType takes no arguments");
1450 return NULL;
1451 }
Brian Curtindfc80e32011-08-10 20:28:54 -05001452 Py_RETURN_NOTIMPLEMENTED;
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001453}
1454
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001455static PyTypeObject PyNotImplemented_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001456 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1457 "NotImplementedType",
1458 0,
1459 0,
1460 none_dealloc, /*tp_dealloc*/ /*never called*/
1461 0, /*tp_print*/
1462 0, /*tp_getattr*/
1463 0, /*tp_setattr*/
1464 0, /*tp_reserved*/
1465 NotImplemented_repr, /*tp_repr*/
1466 0, /*tp_as_number*/
1467 0, /*tp_as_sequence*/
1468 0, /*tp_as_mapping*/
1469 0, /*tp_hash */
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001470 0, /*tp_call */
1471 0, /*tp_str */
1472 0, /*tp_getattro */
1473 0, /*tp_setattro */
1474 0, /*tp_as_buffer */
1475 Py_TPFLAGS_DEFAULT, /*tp_flags */
1476 0, /*tp_doc */
1477 0, /*tp_traverse */
1478 0, /*tp_clear */
1479 0, /*tp_richcompare */
1480 0, /*tp_weaklistoffset */
1481 0, /*tp_iter */
1482 0, /*tp_iternext */
1483 0, /*tp_methods */
1484 0, /*tp_members */
1485 0, /*tp_getset */
1486 0, /*tp_base */
1487 0, /*tp_dict */
1488 0, /*tp_descr_get */
1489 0, /*tp_descr_set */
1490 0, /*tp_dictoffset */
1491 0, /*tp_init */
1492 0, /*tp_alloc */
1493 notimplemented_new, /*tp_new */
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001494};
1495
1496PyObject _Py_NotImplementedStruct = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001497 _PyObject_EXTRA_INIT
1498 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001499};
1500
Guido van Rossumba21a492001-08-16 08:17:26 +00001501void
1502_Py_ReadyTypes(void)
1503{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001504 if (PyType_Ready(&PyType_Type) < 0)
1505 Py_FatalError("Can't initialize type type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001506
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001507 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1508 Py_FatalError("Can't initialize weakref type");
Fred Drake0a4dd392004-07-02 18:57:45 +00001509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001510 if (PyType_Ready(&_PyWeakref_CallableProxyType) < 0)
1511 Py_FatalError("Can't initialize callable weakref proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001512
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001513 if (PyType_Ready(&_PyWeakref_ProxyType) < 0)
1514 Py_FatalError("Can't initialize weakref proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001515
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001516 if (PyType_Ready(&PyBool_Type) < 0)
1517 Py_FatalError("Can't initialize bool type");
Guido van Rossum77f6a652002-04-03 22:41:51 +00001518
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001519 if (PyType_Ready(&PyByteArray_Type) < 0)
1520 Py_FatalError("Can't initialize bytearray type");
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001521
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001522 if (PyType_Ready(&PyBytes_Type) < 0)
1523 Py_FatalError("Can't initialize 'str'");
Guido van Rossumcacfc072002-05-24 19:01:59 +00001524
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001525 if (PyType_Ready(&PyList_Type) < 0)
1526 Py_FatalError("Can't initialize list type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001527
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001528 if (PyType_Ready(&PyNone_Type) < 0)
1529 Py_FatalError("Can't initialize None type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001530
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001531 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1532 Py_FatalError("Can't initialize NotImplemented type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001533
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001534 if (PyType_Ready(&PyTraceBack_Type) < 0)
1535 Py_FatalError("Can't initialize traceback type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001536
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001537 if (PyType_Ready(&PySuper_Type) < 0)
1538 Py_FatalError("Can't initialize super type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001539
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001540 if (PyType_Ready(&PyBaseObject_Type) < 0)
1541 Py_FatalError("Can't initialize object type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001542
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001543 if (PyType_Ready(&PyRange_Type) < 0)
1544 Py_FatalError("Can't initialize range type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001545
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001546 if (PyType_Ready(&PyDict_Type) < 0)
1547 Py_FatalError("Can't initialize dict type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001548
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001549 if (PyType_Ready(&PySet_Type) < 0)
1550 Py_FatalError("Can't initialize set type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001551
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001552 if (PyType_Ready(&PyUnicode_Type) < 0)
1553 Py_FatalError("Can't initialize str type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001554
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001555 if (PyType_Ready(&PySlice_Type) < 0)
1556 Py_FatalError("Can't initialize slice type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001557
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001558 if (PyType_Ready(&PyStaticMethod_Type) < 0)
1559 Py_FatalError("Can't initialize static method type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001560
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001561 if (PyType_Ready(&PyComplex_Type) < 0)
1562 Py_FatalError("Can't initialize complex type");
Skip Montanaroba1e0f42009-10-18 14:25:35 +00001563
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001564 if (PyType_Ready(&PyFloat_Type) < 0)
1565 Py_FatalError("Can't initialize float type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001566
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001567 if (PyType_Ready(&PyLong_Type) < 0)
1568 Py_FatalError("Can't initialize int type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001569
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001570 if (PyType_Ready(&PyFrozenSet_Type) < 0)
1571 Py_FatalError("Can't initialize frozenset type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001572
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001573 if (PyType_Ready(&PyProperty_Type) < 0)
1574 Py_FatalError("Can't initialize property type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001575
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001576 if (PyType_Ready(&PyMemoryView_Type) < 0)
1577 Py_FatalError("Can't initialize memoryview type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001578
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001579 if (PyType_Ready(&PyTuple_Type) < 0)
1580 Py_FatalError("Can't initialize tuple type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001581
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001582 if (PyType_Ready(&PyEnum_Type) < 0)
1583 Py_FatalError("Can't initialize enumerate type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001584
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001585 if (PyType_Ready(&PyReversed_Type) < 0)
1586 Py_FatalError("Can't initialize reversed type");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001587
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001588 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1589 Py_FatalError("Can't initialize StdPrinter");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001590
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001591 if (PyType_Ready(&PyCode_Type) < 0)
1592 Py_FatalError("Can't initialize code type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001593
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001594 if (PyType_Ready(&PyFrame_Type) < 0)
1595 Py_FatalError("Can't initialize frame type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001596
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001597 if (PyType_Ready(&PyCFunction_Type) < 0)
1598 Py_FatalError("Can't initialize builtin function type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001599
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001600 if (PyType_Ready(&PyMethod_Type) < 0)
1601 Py_FatalError("Can't initialize method type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001602
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001603 if (PyType_Ready(&PyFunction_Type) < 0)
1604 Py_FatalError("Can't initialize function type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001605
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001606 if (PyType_Ready(&PyDictProxy_Type) < 0)
1607 Py_FatalError("Can't initialize dict proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001608
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001609 if (PyType_Ready(&PyGen_Type) < 0)
1610 Py_FatalError("Can't initialize generator type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001611
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001612 if (PyType_Ready(&PyGetSetDescr_Type) < 0)
1613 Py_FatalError("Can't initialize get-set descriptor type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001614
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001615 if (PyType_Ready(&PyWrapperDescr_Type) < 0)
1616 Py_FatalError("Can't initialize wrapper type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001617
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001618 if (PyType_Ready(&_PyMethodWrapper_Type) < 0)
1619 Py_FatalError("Can't initialize method wrapper type");
1620
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001621 if (PyType_Ready(&PyEllipsis_Type) < 0)
1622 Py_FatalError("Can't initialize ellipsis type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001623
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001624 if (PyType_Ready(&PyMemberDescr_Type) < 0)
1625 Py_FatalError("Can't initialize member descriptor type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001626
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001627 if (PyType_Ready(&PyFilter_Type) < 0)
1628 Py_FatalError("Can't initialize filter type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001629
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001630 if (PyType_Ready(&PyMap_Type) < 0)
1631 Py_FatalError("Can't initialize map type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001632
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001633 if (PyType_Ready(&PyZip_Type) < 0)
1634 Py_FatalError("Can't initialize zip type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001635}
1636
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001637
Guido van Rossum84a90321996-05-22 16:34:47 +00001638#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001639
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001640void
Fred Drake100814d2000-07-09 15:48:49 +00001641_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001642{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001643 _Py_INC_REFTOTAL;
1644 op->ob_refcnt = 1;
1645 _Py_AddToAllObjects(op, 1);
1646 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001647}
1648
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001649void
Fred Drake100814d2000-07-09 15:48:49 +00001650_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001651{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001652#ifdef SLOW_UNREF_CHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001653 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001654#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001655 if (op->ob_refcnt < 0)
1656 Py_FatalError("UNREF negative refcnt");
1657 if (op == &refchain ||
1658 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1659 fprintf(stderr, "* ob\n");
1660 _PyObject_Dump(op);
1661 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1662 _PyObject_Dump(op->_ob_prev->_ob_next);
1663 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1664 _PyObject_Dump(op->_ob_next->_ob_prev);
1665 Py_FatalError("UNREF invalid object");
1666 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001667#ifdef SLOW_UNREF_CHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001668 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1669 if (p == op)
1670 break;
1671 }
1672 if (p == &refchain) /* Not found */
1673 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001674#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001675 op->_ob_next->_ob_prev = op->_ob_prev;
1676 op->_ob_prev->_ob_next = op->_ob_next;
1677 op->_ob_next = op->_ob_prev = NULL;
1678 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001679}
1680
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001681void
Fred Drake100814d2000-07-09 15:48:49 +00001682_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001683{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001684 destructor dealloc = Py_TYPE(op)->tp_dealloc;
1685 _Py_ForgetReference(op);
1686 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001687}
1688
Tim Peters269b2a62003-04-17 19:52:29 +00001689/* Print all live objects. Because PyObject_Print is called, the
1690 * interpreter must be in a healthy state.
1691 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001692void
Fred Drake100814d2000-07-09 15:48:49 +00001693_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001694{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001695 PyObject *op;
1696 fprintf(fp, "Remaining objects:\n");
1697 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
1698 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
1699 if (PyObject_Print(op, fp, 0) != 0)
1700 PyErr_Clear();
1701 putc('\n', fp);
1702 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001703}
1704
Tim Peters269b2a62003-04-17 19:52:29 +00001705/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1706 * doesn't make any calls to the Python C API, so is always safe to call.
1707 */
1708void
1709_Py_PrintReferenceAddresses(FILE *fp)
1710{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001711 PyObject *op;
1712 fprintf(fp, "Remaining object addresses:\n");
1713 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
1714 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
1715 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001716}
1717
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001718PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001719_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001720{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001721 int i, n;
1722 PyObject *t = NULL;
1723 PyObject *res, *op;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001724
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001725 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1726 return NULL;
1727 op = refchain._ob_next;
1728 res = PyList_New(0);
1729 if (res == NULL)
1730 return NULL;
1731 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1732 while (op == self || op == args || op == res || op == t ||
1733 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
1734 op = op->_ob_next;
1735 if (op == &refchain)
1736 return res;
1737 }
1738 if (PyList_Append(res, op) < 0) {
1739 Py_DECREF(res);
1740 return NULL;
1741 }
1742 op = op->_ob_next;
1743 }
1744 return res;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001745}
1746
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001747#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001748
Benjamin Petersonb173f782009-05-05 22:31:58 +00001749/* Hack to force loading of pycapsule.o */
1750PyTypeObject *_PyCapsule_hack = &PyCapsule_Type;
1751
1752
Guido van Rossum84a90321996-05-22 16:34:47 +00001753/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001754Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001755
1756
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001757/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001758
Thomas Wouters334fb892000-07-25 12:56:38 +00001759void *
Fred Drake100814d2000-07-09 15:48:49 +00001760PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001761{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001762 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001763}
1764
Thomas Wouters334fb892000-07-25 12:56:38 +00001765void *
1766PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001767{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001768 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001769}
1770
1771void
Thomas Wouters334fb892000-07-25 12:56:38 +00001772PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001773{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001774 PyMem_FREE(p);
Guido van Rossumb18618d2000-05-03 23:44:39 +00001775}
1776
1777
Guido van Rossum86610361998-04-10 22:32:46 +00001778/* These methods are used to control infinite recursion in repr, str, print,
1779 etc. Container objects that may recursively contain themselves,
1780 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1781 Py_ReprLeave() to avoid infinite recursion.
1782
1783 Py_ReprEnter() returns 0 the first time it is called for a particular
1784 object and 1 every time thereafter. It returns -1 if an exception
1785 occurred. Py_ReprLeave() has no return value.
1786
1787 See dictobject.c and listobject.c for examples of use.
1788*/
1789
1790#define KEY "Py_Repr"
1791
1792int
Fred Drake100814d2000-07-09 15:48:49 +00001793Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001794{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001795 PyObject *dict;
1796 PyObject *list;
1797 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001798
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001799 dict = PyThreadState_GetDict();
1800 if (dict == NULL)
1801 return 0;
1802 list = PyDict_GetItemString(dict, KEY);
1803 if (list == NULL) {
1804 list = PyList_New(0);
1805 if (list == NULL)
1806 return -1;
1807 if (PyDict_SetItemString(dict, KEY, list) < 0)
1808 return -1;
1809 Py_DECREF(list);
1810 }
1811 i = PyList_GET_SIZE(list);
1812 while (--i >= 0) {
1813 if (PyList_GET_ITEM(list, i) == obj)
1814 return 1;
1815 }
1816 PyList_Append(list, obj);
1817 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001818}
1819
1820void
Fred Drake100814d2000-07-09 15:48:49 +00001821Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001822{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001823 PyObject *dict;
1824 PyObject *list;
1825 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001826
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001827 dict = PyThreadState_GetDict();
1828 if (dict == NULL)
1829 return;
1830 list = PyDict_GetItemString(dict, KEY);
1831 if (list == NULL || !PyList_Check(list))
1832 return;
1833 i = PyList_GET_SIZE(list);
1834 /* Count backwards because we always expect obj to be list[-1] */
1835 while (--i >= 0) {
1836 if (PyList_GET_ITEM(list, i) == obj) {
1837 PyList_SetSlice(list, i, i + 1, NULL);
1838 break;
1839 }
1840 }
Guido van Rossum86610361998-04-10 22:32:46 +00001841}
Guido van Rossumd724b232000-03-13 16:01:29 +00001842
Tim Peters803526b2002-07-07 05:13:56 +00001843/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001844
Tim Peters803526b2002-07-07 05:13:56 +00001845/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001846int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001847
Tim Peters803526b2002-07-07 05:13:56 +00001848/* List of objects that still need to be cleaned up, singly linked via their
1849 * gc headers' gc_prev pointers.
1850 */
1851PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001852
Tim Peters803526b2002-07-07 05:13:56 +00001853/* Add op to the _PyTrash_delete_later list. Called when the current
1854 * call-stack depth gets large. op must be a currently untracked gc'ed
1855 * object, with refcount 0. Py_DECREF must already have been called on it.
1856 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001857void
Fred Drake100814d2000-07-09 15:48:49 +00001858_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001859{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001860 assert(PyObject_IS_GC(op));
1861 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1862 assert(op->ob_refcnt == 0);
1863 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
1864 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001865}
1866
Tim Peters803526b2002-07-07 05:13:56 +00001867/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1868 * the call-stack unwinds again.
1869 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001870void
Fred Drake100814d2000-07-09 15:48:49 +00001871_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001872{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001873 while (_PyTrash_delete_later) {
1874 PyObject *op = _PyTrash_delete_later;
1875 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001876
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001877 _PyTrash_delete_later =
1878 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001879
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001880 /* Call the deallocator directly. This used to try to
1881 * fool Py_DECREF into calling it indirectly, but
1882 * Py_DECREF was already called on this object, and in
1883 * assorted non-release builds calling Py_DECREF again ends
1884 * up distorting allocation statistics.
1885 */
1886 assert(op->ob_refcnt == 0);
1887 ++_PyTrash_delete_nesting;
1888 (*dealloc)(op);
1889 --_PyTrash_delete_nesting;
1890 }
Guido van Rossumd724b232000-03-13 16:01:29 +00001891}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001892
Martin v. Löwis4d0d4712010-12-03 20:14:31 +00001893#ifndef Py_TRACE_REFS
1894/* For Py_LIMITED_API, we need an out-of-line version of _Py_Dealloc.
1895 Define this here, so we can undefine the macro. */
1896#undef _Py_Dealloc
1897PyAPI_FUNC(void) _Py_Dealloc(PyObject *);
1898void
1899_Py_Dealloc(PyObject *op)
1900{
1901 _Py_INC_TPFREES(op) _Py_COUNT_ALLOCS_COMMA
1902 (*Py_TYPE(op)->tp_dealloc)(op);
1903}
1904#endif
1905
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001906#ifdef __cplusplus
1907}
1908#endif