blob: 00f171633d4c788947a37bb31aeb042cf10c4729 [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)) {
Victor Stinner4ead7c72011-11-20 19:48:36 +0100406 if (PyUnicode_READY(v) < 0)
407 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000408 Py_INCREF(v);
409 return v;
410 }
411 if (Py_TYPE(v)->tp_str == NULL)
412 return PyObject_Repr(v);
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000413
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000414 /* It is possible for a type to have a tp_str representation that loops
415 infinitely. */
416 if (Py_EnterRecursiveCall(" while getting the str of an object"))
417 return NULL;
418 res = (*Py_TYPE(v)->tp_str)(v);
419 Py_LeaveRecursiveCall();
420 if (res == NULL)
421 return NULL;
422 if (!PyUnicode_Check(res)) {
423 PyErr_Format(PyExc_TypeError,
424 "__str__ returned non-string (type %.200s)",
425 Py_TYPE(res)->tp_name);
426 Py_DECREF(res);
427 return NULL;
428 }
Victor Stinner4ead7c72011-11-20 19:48:36 +0100429 if (PyUnicode_READY(res) < 0)
430 return NULL;
431 assert(_PyUnicode_CheckConsistency(res, 1));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000432 return res;
Neil Schemenauercf52c072005-08-12 17:34:58 +0000433}
434
Georg Brandl559e5d72008-06-11 18:37:52 +0000435PyObject *
436PyObject_ASCII(PyObject *v)
437{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000438 PyObject *repr, *ascii, *res;
Georg Brandl559e5d72008-06-11 18:37:52 +0000439
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000440 repr = PyObject_Repr(v);
441 if (repr == NULL)
442 return NULL;
Georg Brandl559e5d72008-06-11 18:37:52 +0000443
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000444 /* repr is guaranteed to be a PyUnicode object by PyObject_Repr */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200445 ascii = _PyUnicode_AsASCIIString(repr, "backslashreplace");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000446 Py_DECREF(repr);
447 if (ascii == NULL)
448 return NULL;
Georg Brandl559e5d72008-06-11 18:37:52 +0000449
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000450 res = PyUnicode_DecodeASCII(
451 PyBytes_AS_STRING(ascii),
452 PyBytes_GET_SIZE(ascii),
453 NULL);
454
455 Py_DECREF(ascii);
456 return res;
Georg Brandl559e5d72008-06-11 18:37:52 +0000457}
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000458
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000459PyObject *
460PyObject_Bytes(PyObject *v)
461{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000462 PyObject *result, *func;
463 static PyObject *bytesstring = NULL;
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000464
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000465 if (v == NULL)
466 return PyBytes_FromString("<NULL>");
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000467
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000468 if (PyBytes_CheckExact(v)) {
469 Py_INCREF(v);
470 return v;
471 }
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000472
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000473 func = _PyObject_LookupSpecial(v, "__bytes__", &bytesstring);
474 if (func != NULL) {
475 result = PyObject_CallFunctionObjArgs(func, NULL);
476 Py_DECREF(func);
477 if (result == NULL)
Benjamin Peterson41ece392010-09-11 16:39:57 +0000478 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000479 if (!PyBytes_Check(result)) {
Benjamin Peterson41ece392010-09-11 16:39:57 +0000480 PyErr_Format(PyExc_TypeError,
481 "__bytes__ returned non-bytes (type %.200s)",
482 Py_TYPE(result)->tp_name);
483 Py_DECREF(result);
484 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000485 }
486 return result;
487 }
488 else if (PyErr_Occurred())
489 return NULL;
490 return PyBytes_FromObject(v);
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000491}
492
Mark Dickinsonc008a172009-02-01 13:59:22 +0000493/* For Python 3.0.1 and later, the old three-way comparison has been
494 completely removed in favour of rich comparisons. PyObject_Compare() and
495 PyObject_Cmp() are gone, and the builtin cmp function no longer exists.
Mark Dickinsone94c6792009-02-02 20:36:42 +0000496 The old tp_compare slot has been renamed to tp_reserved, and should no
Mark Dickinsonc008a172009-02-01 13:59:22 +0000497 longer be used. Use tp_richcompare instead.
Guido van Rossum98297ee2007-11-06 21:34:58 +0000498
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000499 See (*) below for practical amendments.
500
Mark Dickinsonc008a172009-02-01 13:59:22 +0000501 tp_richcompare gets called with a first argument of the appropriate type
502 and a second object of an arbitrary type. We never do any kind of
503 coercion.
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000504
Mark Dickinsonc008a172009-02-01 13:59:22 +0000505 The tp_richcompare slot should return an object, as follows:
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000506
507 NULL if an exception occurred
508 NotImplemented if the requested comparison is not implemented
509 any other false value if the requested comparison is false
510 any other true value if the requested comparison is true
511
512 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
513 NotImplemented.
514
515 (*) Practical amendments:
516
517 - If rich comparison returns NotImplemented, == and != are decided by
518 comparing the object pointer (i.e. falling back to the base object
519 implementation).
520
Guido van Rossuma4073002002-05-31 20:03:54 +0000521*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000522
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000523/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000524int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000525
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000526static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000527
528/* Perform a rich comparison, raising TypeError when the requested comparison
529 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000530static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000531do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000532{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000533 richcmpfunc f;
534 PyObject *res;
535 int checked_reverse_op = 0;
Guido van Rossume797ec12001-01-17 15:24:28 +0000536
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000537 if (v->ob_type != w->ob_type &&
538 PyType_IsSubtype(w->ob_type, v->ob_type) &&
539 (f = w->ob_type->tp_richcompare) != NULL) {
540 checked_reverse_op = 1;
541 res = (*f)(w, v, _Py_SwappedOp[op]);
542 if (res != Py_NotImplemented)
543 return res;
544 Py_DECREF(res);
545 }
546 if ((f = v->ob_type->tp_richcompare) != NULL) {
547 res = (*f)(v, w, op);
548 if (res != Py_NotImplemented)
549 return res;
550 Py_DECREF(res);
551 }
552 if (!checked_reverse_op && (f = w->ob_type->tp_richcompare) != NULL) {
553 res = (*f)(w, v, _Py_SwappedOp[op]);
554 if (res != Py_NotImplemented)
555 return res;
556 Py_DECREF(res);
557 }
558 /* If neither object implements it, provide a sensible default
559 for == and !=, but raise an exception for ordering. */
560 switch (op) {
561 case Py_EQ:
562 res = (v == w) ? Py_True : Py_False;
563 break;
564 case Py_NE:
565 res = (v != w) ? Py_True : Py_False;
566 break;
567 default:
568 /* XXX Special-case None so it doesn't show as NoneType() */
569 PyErr_Format(PyExc_TypeError,
570 "unorderable types: %.100s() %s %.100s()",
571 v->ob_type->tp_name,
572 opstrings[op],
573 w->ob_type->tp_name);
574 return NULL;
575 }
576 Py_INCREF(res);
577 return res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000578}
579
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000580/* Perform a rich comparison with object result. This wraps do_richcompare()
581 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000582
Guido van Rossume797ec12001-01-17 15:24:28 +0000583PyObject *
584PyObject_RichCompare(PyObject *v, PyObject *w, int op)
585{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000586 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000587
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000588 assert(Py_LT <= op && op <= Py_GE);
589 if (v == NULL || w == NULL) {
590 if (!PyErr_Occurred())
591 PyErr_BadInternalCall();
592 return NULL;
593 }
594 if (Py_EnterRecursiveCall(" in comparison"))
595 return NULL;
596 res = do_richcompare(v, w, op);
597 Py_LeaveRecursiveCall();
598 return res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000599}
600
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000601/* Perform a rich comparison with integer result. This wraps
602 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000603int
604PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
605{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000606 PyObject *res;
607 int ok;
Guido van Rossume797ec12001-01-17 15:24:28 +0000608
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000609 /* Quick result when objects are the same.
610 Guarantees that identity implies equality. */
611 if (v == w) {
612 if (op == Py_EQ)
613 return 1;
614 else if (op == Py_NE)
615 return 0;
616 }
Mark Dickinson4a1f5932008-11-12 23:23:36 +0000617
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000618 res = PyObject_RichCompare(v, w, op);
619 if (res == NULL)
620 return -1;
621 if (PyBool_Check(res))
622 ok = (res == Py_True);
623 else
624 ok = PyObject_IsTrue(res);
625 Py_DECREF(res);
626 return ok;
Guido van Rossume797ec12001-01-17 15:24:28 +0000627}
Fred Drake13634cf2000-06-29 19:17:04 +0000628
629/* Set of hash utility functions to help maintaining the invariant that
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000630 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000631
632 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
633*/
634
Mark Dickinsondc787d22010-05-23 13:33:13 +0000635/* For numeric types, the hash of a number x is based on the reduction
636 of x modulo the prime P = 2**_PyHASH_BITS - 1. It's designed so that
637 hash(x) == hash(y) whenever x and y are numerically equal, even if
638 x and y have different types.
639
640 A quick summary of the hashing strategy:
641
642 (1) First define the 'reduction of x modulo P' for any rational
643 number x; this is a standard extension of the usual notion of
644 reduction modulo P for integers. If x == p/q (written in lowest
645 terms), the reduction is interpreted as the reduction of p times
646 the inverse of the reduction of q, all modulo P; if q is exactly
647 divisible by P then define the reduction to be infinity. So we've
648 got a well-defined map
649
650 reduce : { rational numbers } -> { 0, 1, 2, ..., P-1, infinity }.
651
652 (2) Now for a rational number x, define hash(x) by:
653
654 reduce(x) if x >= 0
655 -reduce(-x) if x < 0
656
657 If the result of the reduction is infinity (this is impossible for
658 integers, floats and Decimals) then use the predefined hash value
659 _PyHASH_INF for x >= 0, or -_PyHASH_INF for x < 0, instead.
660 _PyHASH_INF, -_PyHASH_INF and _PyHASH_NAN are also used for the
661 hashes of float and Decimal infinities and nans.
662
663 A selling point for the above strategy is that it makes it possible
664 to compute hashes of decimal and binary floating-point numbers
665 efficiently, even if the exponent of the binary or decimal number
666 is large. The key point is that
667
668 reduce(x * y) == reduce(x) * reduce(y) (modulo _PyHASH_MODULUS)
669
670 provided that {reduce(x), reduce(y)} != {0, infinity}. The reduction of a
671 binary or decimal float is never infinity, since the denominator is a power
672 of 2 (for binary) or a divisor of a power of 10 (for decimal). So we have,
673 for nonnegative x,
674
675 reduce(x * 2**e) == reduce(x) * reduce(2**e) % _PyHASH_MODULUS
676
677 reduce(x * 10**e) == reduce(x) * reduce(10**e) % _PyHASH_MODULUS
678
679 and reduce(10**e) can be computed efficiently by the usual modular
680 exponentiation algorithm. For reduce(2**e) it's even better: since
681 P is of the form 2**n-1, reduce(2**e) is 2**(e mod n), and multiplication
682 by 2**(e mod n) modulo 2**n-1 just amounts to a rotation of bits.
683
684 */
685
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000686Py_hash_t
Fred Drake100814d2000-07-09 15:48:49 +0000687_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000688{
Mark Dickinsondc787d22010-05-23 13:33:13 +0000689 int e, sign;
690 double m;
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000691 Py_uhash_t x, y;
Tim Peters39dce292000-08-15 03:34:48 +0000692
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000693 if (!Py_IS_FINITE(v)) {
694 if (Py_IS_INFINITY(v))
Mark Dickinsondc787d22010-05-23 13:33:13 +0000695 return v > 0 ? _PyHASH_INF : -_PyHASH_INF;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000696 else
Mark Dickinsondc787d22010-05-23 13:33:13 +0000697 return _PyHASH_NAN;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000698 }
Mark Dickinsondc787d22010-05-23 13:33:13 +0000699
700 m = frexp(v, &e);
701
702 sign = 1;
703 if (m < 0) {
704 sign = -1;
705 m = -m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000706 }
Mark Dickinsondc787d22010-05-23 13:33:13 +0000707
708 /* process 28 bits at a time; this should work well both for binary
709 and hexadecimal floating point. */
710 x = 0;
711 while (m) {
712 x = ((x << 28) & _PyHASH_MODULUS) | x >> (_PyHASH_BITS - 28);
713 m *= 268435456.0; /* 2**28 */
714 e -= 28;
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000715 y = (Py_uhash_t)m; /* pull out integer part */
Mark Dickinsondc787d22010-05-23 13:33:13 +0000716 m -= y;
717 x += y;
718 if (x >= _PyHASH_MODULUS)
719 x -= _PyHASH_MODULUS;
720 }
721
722 /* adjust for the exponent; first reduce it modulo _PyHASH_BITS */
723 e = e >= 0 ? e % _PyHASH_BITS : _PyHASH_BITS-1-((-1-e) % _PyHASH_BITS);
724 x = ((x << e) & _PyHASH_MODULUS) | x >> (_PyHASH_BITS - e);
725
726 x = x * sign;
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000727 if (x == (Py_uhash_t)-1)
728 x = (Py_uhash_t)-2;
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000729 return (Py_hash_t)x;
Fred Drake13634cf2000-06-29 19:17:04 +0000730}
731
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000732Py_hash_t
Fred Drake100814d2000-07-09 15:48:49 +0000733_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000734{
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000735 Py_hash_t x;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000736 size_t y = (size_t)p;
737 /* bottom 3 or 4 bits are likely to be 0; rotate y by 4 to avoid
738 excessive hash collisions for dicts and sets */
739 y = (y >> 4) | (y << (8 * SIZEOF_VOID_P - 4));
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000740 x = (Py_hash_t)y;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000741 if (x == -1)
742 x = -2;
743 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000744}
745
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000746Py_hash_t
Antoine Pitrouce4a9da2011-11-21 20:46:33 +0100747_Py_HashBytes(unsigned char *p, Py_ssize_t len)
748{
749 Py_uhash_t x;
750 Py_ssize_t i;
751
752 x = (Py_uhash_t) *p << 7;
753 for (i = 0; i < len; i++)
754 x = (1000003U * x) ^ (Py_uhash_t) *p++;
755 x ^= (Py_uhash_t) len;
756 if (x == -1)
757 x = -2;
758 return x;
759}
760
761Py_hash_t
Nick Coghland1abd252008-07-15 15:46:38 +0000762PyObject_HashNotImplemented(PyObject *v)
763{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000764 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
765 Py_TYPE(v)->tp_name);
766 return -1;
Nick Coghland1abd252008-07-15 15:46:38 +0000767}
Fred Drake13634cf2000-06-29 19:17:04 +0000768
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000769Py_hash_t
Fred Drake100814d2000-07-09 15:48:49 +0000770PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000771{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000772 PyTypeObject *tp = Py_TYPE(v);
773 if (tp->tp_hash != NULL)
774 return (*tp->tp_hash)(v);
775 /* To keep to the general practice that inheriting
776 * solely from object in C code should work without
777 * an explicit call to PyType_Ready, we implicitly call
778 * PyType_Ready here and then check the tp_hash slot again
779 */
780 if (tp->tp_dict == NULL) {
781 if (PyType_Ready(tp) < 0)
782 return -1;
783 if (tp->tp_hash != NULL)
784 return (*tp->tp_hash)(v);
785 }
786 /* Otherwise, the object can't be hashed */
787 return PyObject_HashNotImplemented(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000788}
789
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000790PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000791PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000792{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000793 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000794
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000795 if (Py_TYPE(v)->tp_getattr != NULL)
796 return (*Py_TYPE(v)->tp_getattr)(v, (char*)name);
797 w = PyUnicode_InternFromString(name);
798 if (w == NULL)
799 return NULL;
800 res = PyObject_GetAttr(v, w);
801 Py_XDECREF(w);
802 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000803}
804
805int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000806PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000807{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000808 PyObject *res = PyObject_GetAttrString(v, name);
809 if (res != NULL) {
810 Py_DECREF(res);
811 return 1;
812 }
813 PyErr_Clear();
814 return 0;
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000815}
816
817int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000818PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000819{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000820 PyObject *s;
821 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000822
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000823 if (Py_TYPE(v)->tp_setattr != NULL)
824 return (*Py_TYPE(v)->tp_setattr)(v, (char*)name, w);
825 s = PyUnicode_InternFromString(name);
826 if (s == NULL)
827 return -1;
828 res = PyObject_SetAttr(v, s, w);
829 Py_XDECREF(s);
830 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000831}
832
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000833PyObject *
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200834_PyObject_GetAttrId(PyObject *v, _Py_Identifier *name)
835{
836 PyObject *result;
Martin v. Löwisd10759f2011-11-07 13:00:05 +0100837 PyObject *oname = _PyUnicode_FromId(name); /* borrowed */
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200838 if (!oname)
839 return NULL;
840 result = PyObject_GetAttr(v, oname);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200841 return result;
842}
843
844int
845_PyObject_HasAttrId(PyObject *v, _Py_Identifier *name)
846{
847 int result;
Martin v. Löwisd10759f2011-11-07 13:00:05 +0100848 PyObject *oname = _PyUnicode_FromId(name); /* borrowed */
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200849 if (!oname)
850 return -1;
851 result = PyObject_HasAttr(v, oname);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200852 return result;
853}
854
855int
856_PyObject_SetAttrId(PyObject *v, _Py_Identifier *name, PyObject *w)
857{
858 int result;
Martin v. Löwisd10759f2011-11-07 13:00:05 +0100859 PyObject *oname = _PyUnicode_FromId(name); /* borrowed */
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200860 if (!oname)
861 return -1;
862 result = PyObject_SetAttr(v, oname, w);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200863 return result;
864}
865
866PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000867PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000868{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000869 PyTypeObject *tp = Py_TYPE(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000870
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000871 if (!PyUnicode_Check(name)) {
872 PyErr_Format(PyExc_TypeError,
873 "attribute name must be string, not '%.200s'",
874 name->ob_type->tp_name);
875 return NULL;
876 }
877 if (tp->tp_getattro != NULL)
878 return (*tp->tp_getattro)(v, name);
879 if (tp->tp_getattr != NULL) {
880 char *name_str = _PyUnicode_AsString(name);
881 if (name_str == NULL)
882 return NULL;
883 return (*tp->tp_getattr)(v, name_str);
884 }
885 PyErr_Format(PyExc_AttributeError,
886 "'%.50s' object has no attribute '%U'",
887 tp->tp_name, name);
888 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000889}
890
891int
Fred Drake100814d2000-07-09 15:48:49 +0000892PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000893{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000894 PyObject *res = PyObject_GetAttr(v, name);
895 if (res != NULL) {
896 Py_DECREF(res);
897 return 1;
898 }
899 PyErr_Clear();
900 return 0;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000901}
902
903int
Fred Drake100814d2000-07-09 15:48:49 +0000904PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000905{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000906 PyTypeObject *tp = Py_TYPE(v);
907 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000908
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000909 if (!PyUnicode_Check(name)) {
910 PyErr_Format(PyExc_TypeError,
911 "attribute name must be string, not '%.200s'",
912 name->ob_type->tp_name);
913 return -1;
914 }
915 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000916
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000917 PyUnicode_InternInPlace(&name);
918 if (tp->tp_setattro != NULL) {
919 err = (*tp->tp_setattro)(v, name, value);
920 Py_DECREF(name);
921 return err;
922 }
923 if (tp->tp_setattr != NULL) {
924 char *name_str = _PyUnicode_AsString(name);
925 if (name_str == NULL)
926 return -1;
927 err = (*tp->tp_setattr)(v, name_str, value);
928 Py_DECREF(name);
929 return err;
930 }
931 Py_DECREF(name);
932 assert(name->ob_refcnt >= 1);
933 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
934 PyErr_Format(PyExc_TypeError,
935 "'%.100s' object has no attributes "
936 "(%s .%U)",
937 tp->tp_name,
938 value==NULL ? "del" : "assign to",
939 name);
940 else
941 PyErr_Format(PyExc_TypeError,
942 "'%.100s' object has only read-only attributes "
943 "(%s .%U)",
944 tp->tp_name,
945 value==NULL ? "del" : "assign to",
946 name);
947 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000948}
949
950/* Helper to get a pointer to an object's __dict__ slot, if any */
951
952PyObject **
953_PyObject_GetDictPtr(PyObject *obj)
954{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000955 Py_ssize_t dictoffset;
956 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000957
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 dictoffset = tp->tp_dictoffset;
959 if (dictoffset == 0)
960 return NULL;
961 if (dictoffset < 0) {
962 Py_ssize_t tsize;
963 size_t size;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000964
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000965 tsize = ((PyVarObject *)obj)->ob_size;
966 if (tsize < 0)
967 tsize = -tsize;
968 size = _PyObject_VAR_SIZE(tp, tsize);
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000969
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000970 dictoffset += (long)size;
971 assert(dictoffset > 0);
972 assert(dictoffset % SIZEOF_VOID_P == 0);
973 }
974 return (PyObject **) ((char *)obj + dictoffset);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000975}
976
Tim Peters6d6c1a32001-08-02 04:15:00 +0000977PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000978PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +0000979{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000980 Py_INCREF(obj);
981 return obj;
Raymond Hettinger01538262003-03-17 08:24:35 +0000982}
983
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +0000984/* Helper used when the __next__ method is removed from a type:
985 tp_iternext is never NULL and can be safely called without checking
986 on every iteration.
987 */
988
989PyObject *
990_PyObject_NextNotImplemented(PyObject *self)
991{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000992 PyErr_Format(PyExc_TypeError,
993 "'%.200s' object is not iterable",
994 Py_TYPE(self)->tp_name);
995 return NULL;
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +0000996}
997
Michael W. Hudson1593f502004-09-14 17:09:47 +0000998/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
999
Raymond Hettinger01538262003-03-17 08:24:35 +00001000PyObject *
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001001_PyObject_GenericGetAttrWithDict(PyObject *obj, PyObject *name, PyObject *dict)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001002{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001003 PyTypeObject *tp = Py_TYPE(obj);
1004 PyObject *descr = NULL;
1005 PyObject *res = NULL;
1006 descrgetfunc f;
1007 Py_ssize_t dictoffset;
1008 PyObject **dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001009
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001010 if (!PyUnicode_Check(name)){
1011 PyErr_Format(PyExc_TypeError,
1012 "attribute name must be string, not '%.200s'",
1013 name->ob_type->tp_name);
1014 return NULL;
1015 }
1016 else
1017 Py_INCREF(name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001018
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001019 if (tp->tp_dict == NULL) {
1020 if (PyType_Ready(tp) < 0)
1021 goto done;
1022 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001023
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001024 descr = _PyType_Lookup(tp, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001025 Py_XINCREF(descr);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001026
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001027 f = NULL;
1028 if (descr != NULL) {
1029 f = descr->ob_type->tp_descr_get;
1030 if (f != NULL && PyDescr_IsData(descr)) {
1031 res = f(descr, obj, (PyObject *)obj->ob_type);
1032 Py_DECREF(descr);
1033 goto done;
1034 }
1035 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001036
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001037 if (dict == NULL) {
1038 /* Inline _PyObject_GetDictPtr */
1039 dictoffset = tp->tp_dictoffset;
1040 if (dictoffset != 0) {
1041 if (dictoffset < 0) {
1042 Py_ssize_t tsize;
1043 size_t size;
Guido van Rossumc66ff442002-08-19 16:50:48 +00001044
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001045 tsize = ((PyVarObject *)obj)->ob_size;
1046 if (tsize < 0)
1047 tsize = -tsize;
1048 size = _PyObject_VAR_SIZE(tp, tsize);
Guido van Rossumc66ff442002-08-19 16:50:48 +00001049
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001050 dictoffset += (long)size;
1051 assert(dictoffset > 0);
1052 assert(dictoffset % SIZEOF_VOID_P == 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001053 }
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001054 dictptr = (PyObject **) ((char *)obj + dictoffset);
1055 dict = *dictptr;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001056 }
1057 }
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001058 if (dict != NULL) {
1059 Py_INCREF(dict);
1060 res = PyDict_GetItem(dict, name);
1061 if (res != NULL) {
1062 Py_INCREF(res);
1063 Py_XDECREF(descr);
1064 Py_DECREF(dict);
1065 goto done;
1066 }
1067 Py_DECREF(dict);
1068 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001069
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001070 if (f != NULL) {
1071 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
1072 Py_DECREF(descr);
1073 goto done;
1074 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001075
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001076 if (descr != NULL) {
1077 res = descr;
1078 /* descr was already increfed above */
1079 goto done;
1080 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001081
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001082 PyErr_Format(PyExc_AttributeError,
1083 "'%.50s' object has no attribute '%U'",
1084 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001085 done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001086 Py_DECREF(name);
1087 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001088}
1089
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001090PyObject *
1091PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
1092{
1093 return _PyObject_GenericGetAttrWithDict(obj, name, NULL);
1094}
1095
Tim Peters6d6c1a32001-08-02 04:15:00 +00001096int
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001097_PyObject_GenericSetAttrWithDict(PyObject *obj, PyObject *name,
1098 PyObject *value, PyObject *dict)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001099{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001100 PyTypeObject *tp = Py_TYPE(obj);
1101 PyObject *descr;
1102 descrsetfunc f;
1103 PyObject **dictptr;
1104 int res = -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001105
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001106 if (!PyUnicode_Check(name)){
1107 PyErr_Format(PyExc_TypeError,
1108 "attribute name must be string, not '%.200s'",
1109 name->ob_type->tp_name);
1110 return -1;
1111 }
1112 else
1113 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001114
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001115 if (tp->tp_dict == NULL) {
1116 if (PyType_Ready(tp) < 0)
1117 goto done;
1118 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001119
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001120 descr = _PyType_Lookup(tp, name);
1121 f = NULL;
1122 if (descr != NULL) {
1123 f = descr->ob_type->tp_descr_set;
1124 if (f != NULL && PyDescr_IsData(descr)) {
1125 res = f(descr, obj, value);
1126 goto done;
1127 }
1128 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001129
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001130 if (dict == NULL) {
1131 dictptr = _PyObject_GetDictPtr(obj);
1132 if (dictptr != NULL) {
1133 dict = *dictptr;
1134 if (dict == NULL && value != NULL) {
1135 dict = PyDict_New();
1136 if (dict == NULL)
1137 goto done;
1138 *dictptr = dict;
1139 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001140 }
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001141 }
1142 if (dict != NULL) {
1143 Py_INCREF(dict);
1144 if (value == NULL)
1145 res = PyDict_DelItem(dict, name);
1146 else
1147 res = PyDict_SetItem(dict, name, value);
1148 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1149 PyErr_SetObject(PyExc_AttributeError, name);
1150 Py_DECREF(dict);
1151 goto done;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001152 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001153
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001154 if (f != NULL) {
1155 res = f(descr, obj, value);
1156 goto done;
1157 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001158
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001159 if (descr == NULL) {
1160 PyErr_Format(PyExc_AttributeError,
1161 "'%.100s' object has no attribute '%U'",
1162 tp->tp_name, name);
1163 goto done;
1164 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001165
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001166 PyErr_Format(PyExc_AttributeError,
1167 "'%.50s' object attribute '%U' is read-only",
1168 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001169 done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001170 Py_DECREF(name);
1171 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001172}
1173
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001174int
1175PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1176{
1177 return _PyObject_GenericSetAttrWithDict(obj, name, value, NULL);
1178}
1179
1180
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001181/* Test a value used as condition, e.g., in a for or if statement.
1182 Return -1 if an error occurred */
1183
1184int
Fred Drake100814d2000-07-09 15:48:49 +00001185PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001186{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001187 Py_ssize_t res;
1188 if (v == Py_True)
1189 return 1;
1190 if (v == Py_False)
1191 return 0;
1192 if (v == Py_None)
1193 return 0;
1194 else if (v->ob_type->tp_as_number != NULL &&
1195 v->ob_type->tp_as_number->nb_bool != NULL)
1196 res = (*v->ob_type->tp_as_number->nb_bool)(v);
1197 else if (v->ob_type->tp_as_mapping != NULL &&
1198 v->ob_type->tp_as_mapping->mp_length != NULL)
1199 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
1200 else if (v->ob_type->tp_as_sequence != NULL &&
1201 v->ob_type->tp_as_sequence->sq_length != NULL)
1202 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1203 else
1204 return 1;
1205 /* if it is negative, it should be either -1 or -2 */
1206 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001207}
1208
Tim Peters803526b2002-07-07 05:13:56 +00001209/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001210 Return -1 if an error occurred */
1211
1212int
Fred Drake100814d2000-07-09 15:48:49 +00001213PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001214{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001215 int res;
1216 res = PyObject_IsTrue(v);
1217 if (res < 0)
1218 return res;
1219 return res == 0;
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001220}
1221
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001222/* Test whether an object can be called */
1223
1224int
Fred Drake100814d2000-07-09 15:48:49 +00001225PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001226{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001227 if (x == NULL)
1228 return 0;
1229 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001230}
1231
Tim Peters7eea37e2001-09-04 22:08:56 +00001232
Georg Brandle32b4222007-03-10 22:13:27 +00001233/* Helper for PyObject_Dir without arguments: returns the local scope. */
1234static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001235_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001236{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001237 PyObject *names;
1238 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001239
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001240 if (locals == NULL) {
1241 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1242 return NULL;
1243 }
Tim Peters305b5852001-09-17 02:38:46 +00001244
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001245 names = PyMapping_Keys(locals);
1246 if (!names)
1247 return NULL;
1248 if (!PyList_Check(names)) {
1249 PyErr_Format(PyExc_TypeError,
1250 "dir(): expected keys() of locals to be a list, "
1251 "not '%.200s'", Py_TYPE(names)->tp_name);
1252 Py_DECREF(names);
1253 return NULL;
1254 }
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001255 if (PyList_Sort(names)) {
1256 Py_DECREF(names);
1257 return NULL;
1258 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001259 /* the locals don't need to be DECREF'd */
1260 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001261}
1262
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001263/* Helper for PyObject_Dir: object introspection. */
Georg Brandle32b4222007-03-10 22:13:27 +00001264static PyObject *
1265_dir_object(PyObject *obj)
1266{
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001267 PyObject *result, *sorted;
Benjamin Peterson7963a352011-05-23 16:11:05 -05001268 static PyObject *dir_str = NULL;
1269 PyObject *dirfunc = _PyObject_LookupSpecial(obj, "__dir__", &dir_str);
Georg Brandle32b4222007-03-10 22:13:27 +00001270
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001271 assert(obj);
1272 if (dirfunc == NULL) {
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001273 if (!PyErr_Occurred())
1274 PyErr_SetString(PyExc_TypeError, "object does not provide __dir__");
1275 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001276 }
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001277 /* use __dir__ */
1278 result = PyObject_CallFunctionObjArgs(dirfunc, NULL);
1279 Py_DECREF(dirfunc);
1280 if (result == NULL)
1281 return NULL;
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001282 /* return sorted(result) */
1283 sorted = PySequence_List(result);
1284 Py_DECREF(result);
1285 if (sorted == NULL)
1286 return NULL;
1287 if (PyList_Sort(sorted)) {
1288 Py_DECREF(sorted);
1289 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001290 }
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001291 return sorted;
Georg Brandle32b4222007-03-10 22:13:27 +00001292}
1293
1294/* Implementation of dir() -- if obj is NULL, returns the names in the current
1295 (local) scope. Otherwise, performs introspection of the object: returns a
1296 sorted list of attribute names (supposedly) accessible from the object
1297*/
1298PyObject *
1299PyObject_Dir(PyObject *obj)
1300{
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001301 return (obj == NULL) ? _dir_locals() : _dir_object(obj);
Tim Peters7eea37e2001-09-04 22:08:56 +00001302}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001303
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001304/*
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001305None is a non-NULL undefined value.
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001306There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001307so there is exactly one (which is indestructible, by the way).
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001308*/
1309
Guido van Rossum0c182a11992-03-27 17:26:13 +00001310/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001311static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001312none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001313{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001314 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001315}
1316
Barry Warsaw9bf16442001-01-23 16:24:35 +00001317/* ARGUSED */
1318static void
Tim Peters803526b2002-07-07 05:13:56 +00001319none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001320{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001321 /* This should never get called, but we also don't want to SEGV if
1322 * we accidentally decref None out of existence.
1323 */
1324 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001325}
1326
Benjamin Petersonc4607ae2011-07-29 18:19:43 -05001327static PyObject *
1328none_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1329{
1330 if (PyTuple_GET_SIZE(args) || (kwargs && PyDict_Size(kwargs))) {
1331 PyErr_SetString(PyExc_TypeError, "NoneType takes no arguments");
1332 return NULL;
1333 }
1334 Py_RETURN_NONE;
1335}
1336
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001337static int
1338none_bool(PyObject *v)
1339{
1340 return 0;
1341}
1342
1343static PyNumberMethods none_as_number = {
1344 0, /* nb_add */
1345 0, /* nb_subtract */
1346 0, /* nb_multiply */
1347 0, /* nb_remainder */
1348 0, /* nb_divmod */
1349 0, /* nb_power */
1350 0, /* nb_negative */
1351 0, /* nb_positive */
1352 0, /* nb_absolute */
1353 (inquiry)none_bool, /* nb_bool */
1354 0, /* nb_invert */
1355 0, /* nb_lshift */
1356 0, /* nb_rshift */
1357 0, /* nb_and */
1358 0, /* nb_xor */
1359 0, /* nb_or */
1360 0, /* nb_int */
1361 0, /* nb_reserved */
1362 0, /* nb_float */
1363 0, /* nb_inplace_add */
1364 0, /* nb_inplace_subtract */
1365 0, /* nb_inplace_multiply */
1366 0, /* nb_inplace_remainder */
1367 0, /* nb_inplace_power */
1368 0, /* nb_inplace_lshift */
1369 0, /* nb_inplace_rshift */
1370 0, /* nb_inplace_and */
1371 0, /* nb_inplace_xor */
1372 0, /* nb_inplace_or */
1373 0, /* nb_floor_divide */
1374 0, /* nb_true_divide */
1375 0, /* nb_inplace_floor_divide */
1376 0, /* nb_inplace_true_divide */
1377 0, /* nb_index */
1378};
Barry Warsaw9bf16442001-01-23 16:24:35 +00001379
Guido van Rossumba21a492001-08-16 08:17:26 +00001380static PyTypeObject PyNone_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001381 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1382 "NoneType",
1383 0,
1384 0,
1385 none_dealloc, /*tp_dealloc*/ /*never called*/
1386 0, /*tp_print*/
1387 0, /*tp_getattr*/
1388 0, /*tp_setattr*/
1389 0, /*tp_reserved*/
1390 none_repr, /*tp_repr*/
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001391 &none_as_number, /*tp_as_number*/
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001392 0, /*tp_as_sequence*/
1393 0, /*tp_as_mapping*/
1394 0, /*tp_hash */
Benjamin Petersonc4607ae2011-07-29 18:19:43 -05001395 0, /*tp_call */
1396 0, /*tp_str */
1397 0, /*tp_getattro */
1398 0, /*tp_setattro */
1399 0, /*tp_as_buffer */
1400 Py_TPFLAGS_DEFAULT, /*tp_flags */
1401 0, /*tp_doc */
1402 0, /*tp_traverse */
1403 0, /*tp_clear */
1404 0, /*tp_richcompare */
1405 0, /*tp_weaklistoffset */
1406 0, /*tp_iter */
1407 0, /*tp_iternext */
1408 0, /*tp_methods */
1409 0, /*tp_members */
1410 0, /*tp_getset */
1411 0, /*tp_base */
1412 0, /*tp_dict */
1413 0, /*tp_descr_get */
1414 0, /*tp_descr_set */
1415 0, /*tp_dictoffset */
1416 0, /*tp_init */
1417 0, /*tp_alloc */
1418 none_new, /*tp_new */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001419};
1420
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001421PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001422 _PyObject_EXTRA_INIT
1423 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001424};
1425
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001426/* NotImplemented is an object that can be used to signal that an
1427 operation is not implemented for the given type combination. */
1428
1429static PyObject *
1430NotImplemented_repr(PyObject *op)
1431{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001432 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001433}
1434
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001435static PyObject *
1436notimplemented_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1437{
1438 if (PyTuple_GET_SIZE(args) || (kwargs && PyDict_Size(kwargs))) {
1439 PyErr_SetString(PyExc_TypeError, "NotImplementedType takes no arguments");
1440 return NULL;
1441 }
Brian Curtindfc80e32011-08-10 20:28:54 -05001442 Py_RETURN_NOTIMPLEMENTED;
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001443}
1444
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001445static PyTypeObject PyNotImplemented_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001446 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1447 "NotImplementedType",
1448 0,
1449 0,
1450 none_dealloc, /*tp_dealloc*/ /*never called*/
1451 0, /*tp_print*/
1452 0, /*tp_getattr*/
1453 0, /*tp_setattr*/
1454 0, /*tp_reserved*/
1455 NotImplemented_repr, /*tp_repr*/
1456 0, /*tp_as_number*/
1457 0, /*tp_as_sequence*/
1458 0, /*tp_as_mapping*/
1459 0, /*tp_hash */
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001460 0, /*tp_call */
1461 0, /*tp_str */
1462 0, /*tp_getattro */
1463 0, /*tp_setattro */
1464 0, /*tp_as_buffer */
1465 Py_TPFLAGS_DEFAULT, /*tp_flags */
1466 0, /*tp_doc */
1467 0, /*tp_traverse */
1468 0, /*tp_clear */
1469 0, /*tp_richcompare */
1470 0, /*tp_weaklistoffset */
1471 0, /*tp_iter */
1472 0, /*tp_iternext */
1473 0, /*tp_methods */
1474 0, /*tp_members */
1475 0, /*tp_getset */
1476 0, /*tp_base */
1477 0, /*tp_dict */
1478 0, /*tp_descr_get */
1479 0, /*tp_descr_set */
1480 0, /*tp_dictoffset */
1481 0, /*tp_init */
1482 0, /*tp_alloc */
1483 notimplemented_new, /*tp_new */
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001484};
1485
1486PyObject _Py_NotImplementedStruct = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001487 _PyObject_EXTRA_INIT
1488 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001489};
1490
Guido van Rossumba21a492001-08-16 08:17:26 +00001491void
1492_Py_ReadyTypes(void)
1493{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001494 if (PyType_Ready(&PyType_Type) < 0)
1495 Py_FatalError("Can't initialize type type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001496
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001497 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1498 Py_FatalError("Can't initialize weakref type");
Fred Drake0a4dd392004-07-02 18:57:45 +00001499
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001500 if (PyType_Ready(&_PyWeakref_CallableProxyType) < 0)
1501 Py_FatalError("Can't initialize callable weakref proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001502
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001503 if (PyType_Ready(&_PyWeakref_ProxyType) < 0)
1504 Py_FatalError("Can't initialize weakref proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001505
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001506 if (PyType_Ready(&PyBool_Type) < 0)
1507 Py_FatalError("Can't initialize bool type");
Guido van Rossum77f6a652002-04-03 22:41:51 +00001508
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001509 if (PyType_Ready(&PyByteArray_Type) < 0)
1510 Py_FatalError("Can't initialize bytearray type");
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001511
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001512 if (PyType_Ready(&PyBytes_Type) < 0)
1513 Py_FatalError("Can't initialize 'str'");
Guido van Rossumcacfc072002-05-24 19:01:59 +00001514
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001515 if (PyType_Ready(&PyList_Type) < 0)
1516 Py_FatalError("Can't initialize list type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001517
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001518 if (PyType_Ready(&PyNone_Type) < 0)
1519 Py_FatalError("Can't initialize None type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001520
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001521 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1522 Py_FatalError("Can't initialize NotImplemented type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001523
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001524 if (PyType_Ready(&PyTraceBack_Type) < 0)
1525 Py_FatalError("Can't initialize traceback type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001526
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001527 if (PyType_Ready(&PySuper_Type) < 0)
1528 Py_FatalError("Can't initialize super type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001529
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001530 if (PyType_Ready(&PyBaseObject_Type) < 0)
1531 Py_FatalError("Can't initialize object type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001532
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001533 if (PyType_Ready(&PyRange_Type) < 0)
1534 Py_FatalError("Can't initialize range type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001535
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001536 if (PyType_Ready(&PyDict_Type) < 0)
1537 Py_FatalError("Can't initialize dict type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001538
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001539 if (PyType_Ready(&PySet_Type) < 0)
1540 Py_FatalError("Can't initialize set type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001541
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001542 if (PyType_Ready(&PyUnicode_Type) < 0)
1543 Py_FatalError("Can't initialize str type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001544
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001545 if (PyType_Ready(&PySlice_Type) < 0)
1546 Py_FatalError("Can't initialize slice type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001547
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001548 if (PyType_Ready(&PyStaticMethod_Type) < 0)
1549 Py_FatalError("Can't initialize static method type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001550
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001551 if (PyType_Ready(&PyComplex_Type) < 0)
1552 Py_FatalError("Can't initialize complex type");
Skip Montanaroba1e0f42009-10-18 14:25:35 +00001553
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001554 if (PyType_Ready(&PyFloat_Type) < 0)
1555 Py_FatalError("Can't initialize float type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001556
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001557 if (PyType_Ready(&PyLong_Type) < 0)
1558 Py_FatalError("Can't initialize int type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001559
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001560 if (PyType_Ready(&PyFrozenSet_Type) < 0)
1561 Py_FatalError("Can't initialize frozenset type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001562
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001563 if (PyType_Ready(&PyProperty_Type) < 0)
1564 Py_FatalError("Can't initialize property type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001565
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001566 if (PyType_Ready(&PyMemoryView_Type) < 0)
1567 Py_FatalError("Can't initialize memoryview type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001568
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001569 if (PyType_Ready(&PyTuple_Type) < 0)
1570 Py_FatalError("Can't initialize tuple type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001571
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001572 if (PyType_Ready(&PyEnum_Type) < 0)
1573 Py_FatalError("Can't initialize enumerate type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001574
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001575 if (PyType_Ready(&PyReversed_Type) < 0)
1576 Py_FatalError("Can't initialize reversed type");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001577
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001578 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1579 Py_FatalError("Can't initialize StdPrinter");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001580
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001581 if (PyType_Ready(&PyCode_Type) < 0)
1582 Py_FatalError("Can't initialize code type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001583
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001584 if (PyType_Ready(&PyFrame_Type) < 0)
1585 Py_FatalError("Can't initialize frame type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001586
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001587 if (PyType_Ready(&PyCFunction_Type) < 0)
1588 Py_FatalError("Can't initialize builtin function type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001589
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001590 if (PyType_Ready(&PyMethod_Type) < 0)
1591 Py_FatalError("Can't initialize method type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001592
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001593 if (PyType_Ready(&PyFunction_Type) < 0)
1594 Py_FatalError("Can't initialize function type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001595
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001596 if (PyType_Ready(&PyDictProxy_Type) < 0)
1597 Py_FatalError("Can't initialize dict proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001598
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001599 if (PyType_Ready(&PyGen_Type) < 0)
1600 Py_FatalError("Can't initialize generator type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001601
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001602 if (PyType_Ready(&PyGetSetDescr_Type) < 0)
1603 Py_FatalError("Can't initialize get-set descriptor type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001604
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001605 if (PyType_Ready(&PyWrapperDescr_Type) < 0)
1606 Py_FatalError("Can't initialize wrapper type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001607
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001608 if (PyType_Ready(&_PyMethodWrapper_Type) < 0)
1609 Py_FatalError("Can't initialize method wrapper type");
1610
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001611 if (PyType_Ready(&PyEllipsis_Type) < 0)
1612 Py_FatalError("Can't initialize ellipsis type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001613
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001614 if (PyType_Ready(&PyMemberDescr_Type) < 0)
1615 Py_FatalError("Can't initialize member descriptor type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001616
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001617 if (PyType_Ready(&PyFilter_Type) < 0)
1618 Py_FatalError("Can't initialize filter type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001619
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001620 if (PyType_Ready(&PyMap_Type) < 0)
1621 Py_FatalError("Can't initialize map type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001622
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001623 if (PyType_Ready(&PyZip_Type) < 0)
1624 Py_FatalError("Can't initialize zip type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001625}
1626
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001627
Guido van Rossum84a90321996-05-22 16:34:47 +00001628#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001629
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001630void
Fred Drake100814d2000-07-09 15:48:49 +00001631_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001632{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001633 _Py_INC_REFTOTAL;
1634 op->ob_refcnt = 1;
1635 _Py_AddToAllObjects(op, 1);
1636 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001637}
1638
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001639void
Fred Drake100814d2000-07-09 15:48:49 +00001640_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001641{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001642#ifdef SLOW_UNREF_CHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001643 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001644#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001645 if (op->ob_refcnt < 0)
1646 Py_FatalError("UNREF negative refcnt");
1647 if (op == &refchain ||
1648 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1649 fprintf(stderr, "* ob\n");
1650 _PyObject_Dump(op);
1651 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1652 _PyObject_Dump(op->_ob_prev->_ob_next);
1653 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1654 _PyObject_Dump(op->_ob_next->_ob_prev);
1655 Py_FatalError("UNREF invalid object");
1656 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001657#ifdef SLOW_UNREF_CHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001658 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1659 if (p == op)
1660 break;
1661 }
1662 if (p == &refchain) /* Not found */
1663 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001664#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001665 op->_ob_next->_ob_prev = op->_ob_prev;
1666 op->_ob_prev->_ob_next = op->_ob_next;
1667 op->_ob_next = op->_ob_prev = NULL;
1668 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001669}
1670
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001671void
Fred Drake100814d2000-07-09 15:48:49 +00001672_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001673{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001674 destructor dealloc = Py_TYPE(op)->tp_dealloc;
1675 _Py_ForgetReference(op);
1676 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001677}
1678
Tim Peters269b2a62003-04-17 19:52:29 +00001679/* Print all live objects. Because PyObject_Print is called, the
1680 * interpreter must be in a healthy state.
1681 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001682void
Fred Drake100814d2000-07-09 15:48:49 +00001683_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001684{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001685 PyObject *op;
1686 fprintf(fp, "Remaining objects:\n");
1687 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
1688 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
1689 if (PyObject_Print(op, fp, 0) != 0)
1690 PyErr_Clear();
1691 putc('\n', fp);
1692 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001693}
1694
Tim Peters269b2a62003-04-17 19:52:29 +00001695/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1696 * doesn't make any calls to the Python C API, so is always safe to call.
1697 */
1698void
1699_Py_PrintReferenceAddresses(FILE *fp)
1700{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001701 PyObject *op;
1702 fprintf(fp, "Remaining object addresses:\n");
1703 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
1704 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
1705 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001706}
1707
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001708PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001709_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001710{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001711 int i, n;
1712 PyObject *t = NULL;
1713 PyObject *res, *op;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001714
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001715 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1716 return NULL;
1717 op = refchain._ob_next;
1718 res = PyList_New(0);
1719 if (res == NULL)
1720 return NULL;
1721 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1722 while (op == self || op == args || op == res || op == t ||
1723 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
1724 op = op->_ob_next;
1725 if (op == &refchain)
1726 return res;
1727 }
1728 if (PyList_Append(res, op) < 0) {
1729 Py_DECREF(res);
1730 return NULL;
1731 }
1732 op = op->_ob_next;
1733 }
1734 return res;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001735}
1736
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001737#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001738
Benjamin Petersonb173f782009-05-05 22:31:58 +00001739/* Hack to force loading of pycapsule.o */
1740PyTypeObject *_PyCapsule_hack = &PyCapsule_Type;
1741
1742
Guido van Rossum84a90321996-05-22 16:34:47 +00001743/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001744Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001745
1746
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001747/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001748
Thomas Wouters334fb892000-07-25 12:56:38 +00001749void *
Fred Drake100814d2000-07-09 15:48:49 +00001750PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001751{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001752 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001753}
1754
Thomas Wouters334fb892000-07-25 12:56:38 +00001755void *
1756PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001757{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001758 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001759}
1760
1761void
Thomas Wouters334fb892000-07-25 12:56:38 +00001762PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001763{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001764 PyMem_FREE(p);
Guido van Rossumb18618d2000-05-03 23:44:39 +00001765}
1766
1767
Guido van Rossum86610361998-04-10 22:32:46 +00001768/* These methods are used to control infinite recursion in repr, str, print,
1769 etc. Container objects that may recursively contain themselves,
1770 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1771 Py_ReprLeave() to avoid infinite recursion.
1772
1773 Py_ReprEnter() returns 0 the first time it is called for a particular
1774 object and 1 every time thereafter. It returns -1 if an exception
1775 occurred. Py_ReprLeave() has no return value.
1776
1777 See dictobject.c and listobject.c for examples of use.
1778*/
1779
1780#define KEY "Py_Repr"
1781
1782int
Fred Drake100814d2000-07-09 15:48:49 +00001783Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001784{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001785 PyObject *dict;
1786 PyObject *list;
1787 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001788
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001789 dict = PyThreadState_GetDict();
1790 if (dict == NULL)
1791 return 0;
1792 list = PyDict_GetItemString(dict, KEY);
1793 if (list == NULL) {
1794 list = PyList_New(0);
1795 if (list == NULL)
1796 return -1;
1797 if (PyDict_SetItemString(dict, KEY, list) < 0)
1798 return -1;
1799 Py_DECREF(list);
1800 }
1801 i = PyList_GET_SIZE(list);
1802 while (--i >= 0) {
1803 if (PyList_GET_ITEM(list, i) == obj)
1804 return 1;
1805 }
1806 PyList_Append(list, obj);
1807 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001808}
1809
1810void
Fred Drake100814d2000-07-09 15:48:49 +00001811Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001812{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001813 PyObject *dict;
1814 PyObject *list;
1815 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001816
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001817 dict = PyThreadState_GetDict();
1818 if (dict == NULL)
1819 return;
1820 list = PyDict_GetItemString(dict, KEY);
1821 if (list == NULL || !PyList_Check(list))
1822 return;
1823 i = PyList_GET_SIZE(list);
1824 /* Count backwards because we always expect obj to be list[-1] */
1825 while (--i >= 0) {
1826 if (PyList_GET_ITEM(list, i) == obj) {
1827 PyList_SetSlice(list, i, i + 1, NULL);
1828 break;
1829 }
1830 }
Guido van Rossum86610361998-04-10 22:32:46 +00001831}
Guido van Rossumd724b232000-03-13 16:01:29 +00001832
Tim Peters803526b2002-07-07 05:13:56 +00001833/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001834
Tim Peters803526b2002-07-07 05:13:56 +00001835/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001836int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001837
Tim Peters803526b2002-07-07 05:13:56 +00001838/* List of objects that still need to be cleaned up, singly linked via their
1839 * gc headers' gc_prev pointers.
1840 */
1841PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001842
Tim Peters803526b2002-07-07 05:13:56 +00001843/* Add op to the _PyTrash_delete_later list. Called when the current
1844 * call-stack depth gets large. op must be a currently untracked gc'ed
1845 * object, with refcount 0. Py_DECREF must already have been called on it.
1846 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001847void
Fred Drake100814d2000-07-09 15:48:49 +00001848_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001849{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001850 assert(PyObject_IS_GC(op));
1851 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1852 assert(op->ob_refcnt == 0);
1853 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
1854 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001855}
1856
Tim Peters803526b2002-07-07 05:13:56 +00001857/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1858 * the call-stack unwinds again.
1859 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001860void
Fred Drake100814d2000-07-09 15:48:49 +00001861_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001862{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001863 while (_PyTrash_delete_later) {
1864 PyObject *op = _PyTrash_delete_later;
1865 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001866
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001867 _PyTrash_delete_later =
1868 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001869
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001870 /* Call the deallocator directly. This used to try to
1871 * fool Py_DECREF into calling it indirectly, but
1872 * Py_DECREF was already called on this object, and in
1873 * assorted non-release builds calling Py_DECREF again ends
1874 * up distorting allocation statistics.
1875 */
1876 assert(op->ob_refcnt == 0);
1877 ++_PyTrash_delete_nesting;
1878 (*dealloc)(op);
1879 --_PyTrash_delete_nesting;
1880 }
Guido van Rossumd724b232000-03-13 16:01:29 +00001881}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001882
Martin v. Löwis4d0d4712010-12-03 20:14:31 +00001883#ifndef Py_TRACE_REFS
1884/* For Py_LIMITED_API, we need an out-of-line version of _Py_Dealloc.
1885 Define this here, so we can undefine the macro. */
1886#undef _Py_Dealloc
1887PyAPI_FUNC(void) _Py_Dealloc(PyObject *);
1888void
1889_Py_Dealloc(PyObject *op)
1890{
1891 _Py_INC_TPFREES(op) _Py_COUNT_ALLOCS_COMMA
1892 (*Py_TYPE(op)->tp_dealloc)(op);
1893}
1894#endif
1895
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001896#ifdef __cplusplus
1897}
1898#endif