blob: eea55318ebcc379f75dea08d509486e9557ab40d [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 }
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100388#ifndef Py_DEBUG
389 if (PyUnicode_READY(res) < 0)
390 return NULL;
391#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000392 return res;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000393}
394
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000395PyObject *
Guido van Rossum98297ee2007-11-06 21:34:58 +0000396PyObject_Str(PyObject *v)
Guido van Rossumc6004111993-11-05 10:22:19 +0000397{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000398 PyObject *res;
399 if (PyErr_CheckSignals())
400 return NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000401#ifdef USE_STACKCHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000402 if (PyOS_CheckStack()) {
403 PyErr_SetString(PyExc_MemoryError, "stack overflow");
404 return NULL;
405 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000406#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000407 if (v == NULL)
408 return PyUnicode_FromString("<NULL>");
409 if (PyUnicode_CheckExact(v)) {
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100410#ifndef Py_DEBUG
Victor Stinner4ead7c72011-11-20 19:48:36 +0100411 if (PyUnicode_READY(v) < 0)
412 return NULL;
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100413#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000414 Py_INCREF(v);
415 return v;
416 }
417 if (Py_TYPE(v)->tp_str == NULL)
418 return PyObject_Repr(v);
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000419
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000420 /* It is possible for a type to have a tp_str representation that loops
421 infinitely. */
422 if (Py_EnterRecursiveCall(" while getting the str of an object"))
423 return NULL;
424 res = (*Py_TYPE(v)->tp_str)(v);
425 Py_LeaveRecursiveCall();
426 if (res == NULL)
427 return NULL;
428 if (!PyUnicode_Check(res)) {
429 PyErr_Format(PyExc_TypeError,
430 "__str__ returned non-string (type %.200s)",
431 Py_TYPE(res)->tp_name);
432 Py_DECREF(res);
433 return NULL;
434 }
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100435#ifndef Py_DEBUG
Victor Stinner4ead7c72011-11-20 19:48:36 +0100436 if (PyUnicode_READY(res) < 0)
437 return NULL;
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100438#endif
Victor Stinner4ead7c72011-11-20 19:48:36 +0100439 assert(_PyUnicode_CheckConsistency(res, 1));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000440 return res;
Neil Schemenauercf52c072005-08-12 17:34:58 +0000441}
442
Georg Brandl559e5d72008-06-11 18:37:52 +0000443PyObject *
444PyObject_ASCII(PyObject *v)
445{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000446 PyObject *repr, *ascii, *res;
Georg Brandl559e5d72008-06-11 18:37:52 +0000447
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000448 repr = PyObject_Repr(v);
449 if (repr == NULL)
450 return NULL;
Georg Brandl559e5d72008-06-11 18:37:52 +0000451
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000452 /* repr is guaranteed to be a PyUnicode object by PyObject_Repr */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200453 ascii = _PyUnicode_AsASCIIString(repr, "backslashreplace");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000454 Py_DECREF(repr);
455 if (ascii == NULL)
456 return NULL;
Georg Brandl559e5d72008-06-11 18:37:52 +0000457
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000458 res = PyUnicode_DecodeASCII(
459 PyBytes_AS_STRING(ascii),
460 PyBytes_GET_SIZE(ascii),
461 NULL);
462
463 Py_DECREF(ascii);
464 return res;
Georg Brandl559e5d72008-06-11 18:37:52 +0000465}
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000466
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000467PyObject *
468PyObject_Bytes(PyObject *v)
469{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000470 PyObject *result, *func;
471 static PyObject *bytesstring = NULL;
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000472
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000473 if (v == NULL)
474 return PyBytes_FromString("<NULL>");
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000475
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000476 if (PyBytes_CheckExact(v)) {
477 Py_INCREF(v);
478 return v;
479 }
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000480
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000481 func = _PyObject_LookupSpecial(v, "__bytes__", &bytesstring);
482 if (func != NULL) {
483 result = PyObject_CallFunctionObjArgs(func, NULL);
484 Py_DECREF(func);
485 if (result == NULL)
Benjamin Peterson41ece392010-09-11 16:39:57 +0000486 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000487 if (!PyBytes_Check(result)) {
Benjamin Peterson41ece392010-09-11 16:39:57 +0000488 PyErr_Format(PyExc_TypeError,
489 "__bytes__ returned non-bytes (type %.200s)",
490 Py_TYPE(result)->tp_name);
491 Py_DECREF(result);
492 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000493 }
494 return result;
495 }
496 else if (PyErr_Occurred())
497 return NULL;
498 return PyBytes_FromObject(v);
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000499}
500
Mark Dickinsonc008a172009-02-01 13:59:22 +0000501/* For Python 3.0.1 and later, the old three-way comparison has been
502 completely removed in favour of rich comparisons. PyObject_Compare() and
503 PyObject_Cmp() are gone, and the builtin cmp function no longer exists.
Mark Dickinsone94c6792009-02-02 20:36:42 +0000504 The old tp_compare slot has been renamed to tp_reserved, and should no
Mark Dickinsonc008a172009-02-01 13:59:22 +0000505 longer be used. Use tp_richcompare instead.
Guido van Rossum98297ee2007-11-06 21:34:58 +0000506
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000507 See (*) below for practical amendments.
508
Mark Dickinsonc008a172009-02-01 13:59:22 +0000509 tp_richcompare gets called with a first argument of the appropriate type
510 and a second object of an arbitrary type. We never do any kind of
511 coercion.
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000512
Mark Dickinsonc008a172009-02-01 13:59:22 +0000513 The tp_richcompare slot should return an object, as follows:
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000514
515 NULL if an exception occurred
516 NotImplemented if the requested comparison is not implemented
517 any other false value if the requested comparison is false
518 any other true value if the requested comparison is true
519
520 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
521 NotImplemented.
522
523 (*) Practical amendments:
524
525 - If rich comparison returns NotImplemented, == and != are decided by
526 comparing the object pointer (i.e. falling back to the base object
527 implementation).
528
Guido van Rossuma4073002002-05-31 20:03:54 +0000529*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000530
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000531/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000532int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000533
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000534static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000535
536/* Perform a rich comparison, raising TypeError when the requested comparison
537 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000538static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000539do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000540{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000541 richcmpfunc f;
542 PyObject *res;
543 int checked_reverse_op = 0;
Guido van Rossume797ec12001-01-17 15:24:28 +0000544
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000545 if (v->ob_type != w->ob_type &&
546 PyType_IsSubtype(w->ob_type, v->ob_type) &&
547 (f = w->ob_type->tp_richcompare) != NULL) {
548 checked_reverse_op = 1;
549 res = (*f)(w, v, _Py_SwappedOp[op]);
550 if (res != Py_NotImplemented)
551 return res;
552 Py_DECREF(res);
553 }
554 if ((f = v->ob_type->tp_richcompare) != NULL) {
555 res = (*f)(v, w, op);
556 if (res != Py_NotImplemented)
557 return res;
558 Py_DECREF(res);
559 }
560 if (!checked_reverse_op && (f = w->ob_type->tp_richcompare) != NULL) {
561 res = (*f)(w, v, _Py_SwappedOp[op]);
562 if (res != Py_NotImplemented)
563 return res;
564 Py_DECREF(res);
565 }
566 /* If neither object implements it, provide a sensible default
567 for == and !=, but raise an exception for ordering. */
568 switch (op) {
569 case Py_EQ:
570 res = (v == w) ? Py_True : Py_False;
571 break;
572 case Py_NE:
573 res = (v != w) ? Py_True : Py_False;
574 break;
575 default:
576 /* XXX Special-case None so it doesn't show as NoneType() */
577 PyErr_Format(PyExc_TypeError,
578 "unorderable types: %.100s() %s %.100s()",
579 v->ob_type->tp_name,
580 opstrings[op],
581 w->ob_type->tp_name);
582 return NULL;
583 }
584 Py_INCREF(res);
585 return res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000586}
587
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000588/* Perform a rich comparison with object result. This wraps do_richcompare()
589 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000590
Guido van Rossume797ec12001-01-17 15:24:28 +0000591PyObject *
592PyObject_RichCompare(PyObject *v, PyObject *w, int op)
593{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000594 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000595
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000596 assert(Py_LT <= op && op <= Py_GE);
597 if (v == NULL || w == NULL) {
598 if (!PyErr_Occurred())
599 PyErr_BadInternalCall();
600 return NULL;
601 }
602 if (Py_EnterRecursiveCall(" in comparison"))
603 return NULL;
604 res = do_richcompare(v, w, op);
605 Py_LeaveRecursiveCall();
606 return res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000607}
608
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000609/* Perform a rich comparison with integer result. This wraps
610 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000611int
612PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
613{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000614 PyObject *res;
615 int ok;
Guido van Rossume797ec12001-01-17 15:24:28 +0000616
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000617 /* Quick result when objects are the same.
618 Guarantees that identity implies equality. */
619 if (v == w) {
620 if (op == Py_EQ)
621 return 1;
622 else if (op == Py_NE)
623 return 0;
624 }
Mark Dickinson4a1f5932008-11-12 23:23:36 +0000625
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000626 res = PyObject_RichCompare(v, w, op);
627 if (res == NULL)
628 return -1;
629 if (PyBool_Check(res))
630 ok = (res == Py_True);
631 else
632 ok = PyObject_IsTrue(res);
633 Py_DECREF(res);
634 return ok;
Guido van Rossume797ec12001-01-17 15:24:28 +0000635}
Fred Drake13634cf2000-06-29 19:17:04 +0000636
637/* Set of hash utility functions to help maintaining the invariant that
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000638 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000639
640 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
641*/
642
Mark Dickinsondc787d22010-05-23 13:33:13 +0000643/* For numeric types, the hash of a number x is based on the reduction
644 of x modulo the prime P = 2**_PyHASH_BITS - 1. It's designed so that
645 hash(x) == hash(y) whenever x and y are numerically equal, even if
646 x and y have different types.
647
648 A quick summary of the hashing strategy:
649
650 (1) First define the 'reduction of x modulo P' for any rational
651 number x; this is a standard extension of the usual notion of
652 reduction modulo P for integers. If x == p/q (written in lowest
653 terms), the reduction is interpreted as the reduction of p times
654 the inverse of the reduction of q, all modulo P; if q is exactly
655 divisible by P then define the reduction to be infinity. So we've
656 got a well-defined map
657
658 reduce : { rational numbers } -> { 0, 1, 2, ..., P-1, infinity }.
659
660 (2) Now for a rational number x, define hash(x) by:
661
662 reduce(x) if x >= 0
663 -reduce(-x) if x < 0
664
665 If the result of the reduction is infinity (this is impossible for
666 integers, floats and Decimals) then use the predefined hash value
667 _PyHASH_INF for x >= 0, or -_PyHASH_INF for x < 0, instead.
668 _PyHASH_INF, -_PyHASH_INF and _PyHASH_NAN are also used for the
669 hashes of float and Decimal infinities and nans.
670
671 A selling point for the above strategy is that it makes it possible
672 to compute hashes of decimal and binary floating-point numbers
673 efficiently, even if the exponent of the binary or decimal number
674 is large. The key point is that
675
676 reduce(x * y) == reduce(x) * reduce(y) (modulo _PyHASH_MODULUS)
677
678 provided that {reduce(x), reduce(y)} != {0, infinity}. The reduction of a
679 binary or decimal float is never infinity, since the denominator is a power
680 of 2 (for binary) or a divisor of a power of 10 (for decimal). So we have,
681 for nonnegative x,
682
683 reduce(x * 2**e) == reduce(x) * reduce(2**e) % _PyHASH_MODULUS
684
685 reduce(x * 10**e) == reduce(x) * reduce(10**e) % _PyHASH_MODULUS
686
687 and reduce(10**e) can be computed efficiently by the usual modular
688 exponentiation algorithm. For reduce(2**e) it's even better: since
689 P is of the form 2**n-1, reduce(2**e) is 2**(e mod n), and multiplication
690 by 2**(e mod n) modulo 2**n-1 just amounts to a rotation of bits.
691
692 */
693
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000694Py_hash_t
Fred Drake100814d2000-07-09 15:48:49 +0000695_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000696{
Mark Dickinsondc787d22010-05-23 13:33:13 +0000697 int e, sign;
698 double m;
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000699 Py_uhash_t x, y;
Tim Peters39dce292000-08-15 03:34:48 +0000700
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000701 if (!Py_IS_FINITE(v)) {
702 if (Py_IS_INFINITY(v))
Mark Dickinsondc787d22010-05-23 13:33:13 +0000703 return v > 0 ? _PyHASH_INF : -_PyHASH_INF;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000704 else
Mark Dickinsondc787d22010-05-23 13:33:13 +0000705 return _PyHASH_NAN;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000706 }
Mark Dickinsondc787d22010-05-23 13:33:13 +0000707
708 m = frexp(v, &e);
709
710 sign = 1;
711 if (m < 0) {
712 sign = -1;
713 m = -m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000714 }
Mark Dickinsondc787d22010-05-23 13:33:13 +0000715
716 /* process 28 bits at a time; this should work well both for binary
717 and hexadecimal floating point. */
718 x = 0;
719 while (m) {
720 x = ((x << 28) & _PyHASH_MODULUS) | x >> (_PyHASH_BITS - 28);
721 m *= 268435456.0; /* 2**28 */
722 e -= 28;
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000723 y = (Py_uhash_t)m; /* pull out integer part */
Mark Dickinsondc787d22010-05-23 13:33:13 +0000724 m -= y;
725 x += y;
726 if (x >= _PyHASH_MODULUS)
727 x -= _PyHASH_MODULUS;
728 }
729
730 /* adjust for the exponent; first reduce it modulo _PyHASH_BITS */
731 e = e >= 0 ? e % _PyHASH_BITS : _PyHASH_BITS-1-((-1-e) % _PyHASH_BITS);
732 x = ((x << e) & _PyHASH_MODULUS) | x >> (_PyHASH_BITS - e);
733
734 x = x * sign;
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000735 if (x == (Py_uhash_t)-1)
736 x = (Py_uhash_t)-2;
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000737 return (Py_hash_t)x;
Fred Drake13634cf2000-06-29 19:17:04 +0000738}
739
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000740Py_hash_t
Fred Drake100814d2000-07-09 15:48:49 +0000741_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000742{
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000743 Py_hash_t x;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000744 size_t y = (size_t)p;
745 /* bottom 3 or 4 bits are likely to be 0; rotate y by 4 to avoid
746 excessive hash collisions for dicts and sets */
747 y = (y >> 4) | (y << (8 * SIZEOF_VOID_P - 4));
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000748 x = (Py_hash_t)y;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000749 if (x == -1)
750 x = -2;
751 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000752}
753
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000754Py_hash_t
Antoine Pitrouce4a9da2011-11-21 20:46:33 +0100755_Py_HashBytes(unsigned char *p, Py_ssize_t len)
756{
757 Py_uhash_t x;
758 Py_ssize_t i;
759
760 x = (Py_uhash_t) *p << 7;
761 for (i = 0; i < len; i++)
762 x = (1000003U * x) ^ (Py_uhash_t) *p++;
763 x ^= (Py_uhash_t) len;
764 if (x == -1)
765 x = -2;
766 return x;
767}
768
769Py_hash_t
Nick Coghland1abd252008-07-15 15:46:38 +0000770PyObject_HashNotImplemented(PyObject *v)
771{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000772 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
773 Py_TYPE(v)->tp_name);
774 return -1;
Nick Coghland1abd252008-07-15 15:46:38 +0000775}
Fred Drake13634cf2000-06-29 19:17:04 +0000776
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000777Py_hash_t
Fred Drake100814d2000-07-09 15:48:49 +0000778PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000779{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000780 PyTypeObject *tp = Py_TYPE(v);
781 if (tp->tp_hash != NULL)
782 return (*tp->tp_hash)(v);
783 /* To keep to the general practice that inheriting
784 * solely from object in C code should work without
785 * an explicit call to PyType_Ready, we implicitly call
786 * PyType_Ready here and then check the tp_hash slot again
787 */
788 if (tp->tp_dict == NULL) {
789 if (PyType_Ready(tp) < 0)
790 return -1;
791 if (tp->tp_hash != NULL)
792 return (*tp->tp_hash)(v);
793 }
794 /* Otherwise, the object can't be hashed */
795 return PyObject_HashNotImplemented(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000796}
797
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000798PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000799PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000800{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000801 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000802
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000803 if (Py_TYPE(v)->tp_getattr != NULL)
804 return (*Py_TYPE(v)->tp_getattr)(v, (char*)name);
805 w = PyUnicode_InternFromString(name);
806 if (w == NULL)
807 return NULL;
808 res = PyObject_GetAttr(v, w);
809 Py_XDECREF(w);
810 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000811}
812
813int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000814PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000815{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000816 PyObject *res = PyObject_GetAttrString(v, name);
817 if (res != NULL) {
818 Py_DECREF(res);
819 return 1;
820 }
821 PyErr_Clear();
822 return 0;
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000823}
824
825int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000826PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000827{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000828 PyObject *s;
829 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000830
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000831 if (Py_TYPE(v)->tp_setattr != NULL)
832 return (*Py_TYPE(v)->tp_setattr)(v, (char*)name, w);
833 s = PyUnicode_InternFromString(name);
834 if (s == NULL)
835 return -1;
836 res = PyObject_SetAttr(v, s, w);
837 Py_XDECREF(s);
838 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000839}
840
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000841PyObject *
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200842_PyObject_GetAttrId(PyObject *v, _Py_Identifier *name)
843{
844 PyObject *result;
Martin v. Löwisd10759f2011-11-07 13:00:05 +0100845 PyObject *oname = _PyUnicode_FromId(name); /* borrowed */
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200846 if (!oname)
847 return NULL;
848 result = PyObject_GetAttr(v, oname);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200849 return result;
850}
851
852int
853_PyObject_HasAttrId(PyObject *v, _Py_Identifier *name)
854{
855 int result;
Martin v. Löwisd10759f2011-11-07 13:00:05 +0100856 PyObject *oname = _PyUnicode_FromId(name); /* borrowed */
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200857 if (!oname)
858 return -1;
859 result = PyObject_HasAttr(v, oname);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200860 return result;
861}
862
863int
864_PyObject_SetAttrId(PyObject *v, _Py_Identifier *name, PyObject *w)
865{
866 int result;
Martin v. Löwisd10759f2011-11-07 13:00:05 +0100867 PyObject *oname = _PyUnicode_FromId(name); /* borrowed */
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200868 if (!oname)
869 return -1;
870 result = PyObject_SetAttr(v, oname, w);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200871 return result;
872}
873
874PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000875PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000876{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000877 PyTypeObject *tp = Py_TYPE(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000878
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000879 if (!PyUnicode_Check(name)) {
880 PyErr_Format(PyExc_TypeError,
881 "attribute name must be string, not '%.200s'",
882 name->ob_type->tp_name);
883 return NULL;
884 }
885 if (tp->tp_getattro != NULL)
886 return (*tp->tp_getattro)(v, name);
887 if (tp->tp_getattr != NULL) {
888 char *name_str = _PyUnicode_AsString(name);
889 if (name_str == NULL)
890 return NULL;
891 return (*tp->tp_getattr)(v, name_str);
892 }
893 PyErr_Format(PyExc_AttributeError,
894 "'%.50s' object has no attribute '%U'",
895 tp->tp_name, name);
896 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000897}
898
899int
Fred Drake100814d2000-07-09 15:48:49 +0000900PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000901{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000902 PyObject *res = PyObject_GetAttr(v, name);
903 if (res != NULL) {
904 Py_DECREF(res);
905 return 1;
906 }
907 PyErr_Clear();
908 return 0;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000909}
910
911int
Fred Drake100814d2000-07-09 15:48:49 +0000912PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000913{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000914 PyTypeObject *tp = Py_TYPE(v);
915 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000916
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000917 if (!PyUnicode_Check(name)) {
918 PyErr_Format(PyExc_TypeError,
919 "attribute name must be string, not '%.200s'",
920 name->ob_type->tp_name);
921 return -1;
922 }
923 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000924
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000925 PyUnicode_InternInPlace(&name);
926 if (tp->tp_setattro != NULL) {
927 err = (*tp->tp_setattro)(v, name, value);
928 Py_DECREF(name);
929 return err;
930 }
931 if (tp->tp_setattr != NULL) {
932 char *name_str = _PyUnicode_AsString(name);
933 if (name_str == NULL)
934 return -1;
935 err = (*tp->tp_setattr)(v, name_str, value);
936 Py_DECREF(name);
937 return err;
938 }
939 Py_DECREF(name);
940 assert(name->ob_refcnt >= 1);
941 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
942 PyErr_Format(PyExc_TypeError,
943 "'%.100s' object has no attributes "
944 "(%s .%U)",
945 tp->tp_name,
946 value==NULL ? "del" : "assign to",
947 name);
948 else
949 PyErr_Format(PyExc_TypeError,
950 "'%.100s' object has only read-only attributes "
951 "(%s .%U)",
952 tp->tp_name,
953 value==NULL ? "del" : "assign to",
954 name);
955 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000956}
957
958/* Helper to get a pointer to an object's __dict__ slot, if any */
959
960PyObject **
961_PyObject_GetDictPtr(PyObject *obj)
962{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000963 Py_ssize_t dictoffset;
964 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000965
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000966 dictoffset = tp->tp_dictoffset;
967 if (dictoffset == 0)
968 return NULL;
969 if (dictoffset < 0) {
970 Py_ssize_t tsize;
971 size_t size;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000972
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000973 tsize = ((PyVarObject *)obj)->ob_size;
974 if (tsize < 0)
975 tsize = -tsize;
976 size = _PyObject_VAR_SIZE(tp, tsize);
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000977
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000978 dictoffset += (long)size;
979 assert(dictoffset > 0);
980 assert(dictoffset % SIZEOF_VOID_P == 0);
981 }
982 return (PyObject **) ((char *)obj + dictoffset);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000983}
984
Tim Peters6d6c1a32001-08-02 04:15:00 +0000985PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000986PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +0000987{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000988 Py_INCREF(obj);
989 return obj;
Raymond Hettinger01538262003-03-17 08:24:35 +0000990}
991
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +0000992/* Helper used when the __next__ method is removed from a type:
993 tp_iternext is never NULL and can be safely called without checking
994 on every iteration.
995 */
996
997PyObject *
998_PyObject_NextNotImplemented(PyObject *self)
999{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001000 PyErr_Format(PyExc_TypeError,
1001 "'%.200s' object is not iterable",
1002 Py_TYPE(self)->tp_name);
1003 return NULL;
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +00001004}
1005
Michael W. Hudson1593f502004-09-14 17:09:47 +00001006/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
1007
Raymond Hettinger01538262003-03-17 08:24:35 +00001008PyObject *
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001009_PyObject_GenericGetAttrWithDict(PyObject *obj, PyObject *name, PyObject *dict)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001010{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001011 PyTypeObject *tp = Py_TYPE(obj);
1012 PyObject *descr = NULL;
1013 PyObject *res = NULL;
1014 descrgetfunc f;
1015 Py_ssize_t dictoffset;
1016 PyObject **dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001017
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001018 if (!PyUnicode_Check(name)){
1019 PyErr_Format(PyExc_TypeError,
1020 "attribute name must be string, not '%.200s'",
1021 name->ob_type->tp_name);
1022 return NULL;
1023 }
1024 else
1025 Py_INCREF(name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001026
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001027 if (tp->tp_dict == NULL) {
1028 if (PyType_Ready(tp) < 0)
1029 goto done;
1030 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001031
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001032 descr = _PyType_Lookup(tp, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001033 Py_XINCREF(descr);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001034
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001035 f = NULL;
1036 if (descr != NULL) {
1037 f = descr->ob_type->tp_descr_get;
1038 if (f != NULL && PyDescr_IsData(descr)) {
1039 res = f(descr, obj, (PyObject *)obj->ob_type);
1040 Py_DECREF(descr);
1041 goto done;
1042 }
1043 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001044
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001045 if (dict == NULL) {
1046 /* Inline _PyObject_GetDictPtr */
1047 dictoffset = tp->tp_dictoffset;
1048 if (dictoffset != 0) {
1049 if (dictoffset < 0) {
1050 Py_ssize_t tsize;
1051 size_t size;
Guido van Rossumc66ff442002-08-19 16:50:48 +00001052
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001053 tsize = ((PyVarObject *)obj)->ob_size;
1054 if (tsize < 0)
1055 tsize = -tsize;
1056 size = _PyObject_VAR_SIZE(tp, tsize);
Guido van Rossumc66ff442002-08-19 16:50:48 +00001057
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001058 dictoffset += (long)size;
1059 assert(dictoffset > 0);
1060 assert(dictoffset % SIZEOF_VOID_P == 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001061 }
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001062 dictptr = (PyObject **) ((char *)obj + dictoffset);
1063 dict = *dictptr;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001064 }
1065 }
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001066 if (dict != NULL) {
1067 Py_INCREF(dict);
1068 res = PyDict_GetItem(dict, name);
1069 if (res != NULL) {
1070 Py_INCREF(res);
1071 Py_XDECREF(descr);
1072 Py_DECREF(dict);
1073 goto done;
1074 }
1075 Py_DECREF(dict);
1076 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001077
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001078 if (f != NULL) {
1079 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
1080 Py_DECREF(descr);
1081 goto done;
1082 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001083
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001084 if (descr != NULL) {
1085 res = descr;
1086 /* descr was already increfed above */
1087 goto done;
1088 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001089
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001090 PyErr_Format(PyExc_AttributeError,
1091 "'%.50s' object has no attribute '%U'",
1092 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001093 done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001094 Py_DECREF(name);
1095 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001096}
1097
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001098PyObject *
1099PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
1100{
1101 return _PyObject_GenericGetAttrWithDict(obj, name, NULL);
1102}
1103
Tim Peters6d6c1a32001-08-02 04:15:00 +00001104int
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001105_PyObject_GenericSetAttrWithDict(PyObject *obj, PyObject *name,
1106 PyObject *value, PyObject *dict)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001107{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001108 PyTypeObject *tp = Py_TYPE(obj);
1109 PyObject *descr;
1110 descrsetfunc f;
1111 PyObject **dictptr;
1112 int res = -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001113
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001114 if (!PyUnicode_Check(name)){
1115 PyErr_Format(PyExc_TypeError,
1116 "attribute name must be string, not '%.200s'",
1117 name->ob_type->tp_name);
1118 return -1;
1119 }
1120 else
1121 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001122
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001123 if (tp->tp_dict == NULL) {
1124 if (PyType_Ready(tp) < 0)
1125 goto done;
1126 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001127
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001128 descr = _PyType_Lookup(tp, name);
1129 f = NULL;
1130 if (descr != NULL) {
1131 f = descr->ob_type->tp_descr_set;
1132 if (f != NULL && PyDescr_IsData(descr)) {
1133 res = f(descr, obj, value);
1134 goto done;
1135 }
1136 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001137
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001138 if (dict == NULL) {
1139 dictptr = _PyObject_GetDictPtr(obj);
1140 if (dictptr != NULL) {
1141 dict = *dictptr;
1142 if (dict == NULL && value != NULL) {
1143 dict = PyDict_New();
1144 if (dict == NULL)
1145 goto done;
1146 *dictptr = dict;
1147 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001148 }
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001149 }
1150 if (dict != NULL) {
1151 Py_INCREF(dict);
1152 if (value == NULL)
1153 res = PyDict_DelItem(dict, name);
1154 else
1155 res = PyDict_SetItem(dict, name, value);
1156 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1157 PyErr_SetObject(PyExc_AttributeError, name);
1158 Py_DECREF(dict);
1159 goto done;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001160 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001161
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001162 if (f != NULL) {
1163 res = f(descr, obj, value);
1164 goto done;
1165 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001166
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001167 if (descr == NULL) {
1168 PyErr_Format(PyExc_AttributeError,
1169 "'%.100s' object has no attribute '%U'",
1170 tp->tp_name, name);
1171 goto done;
1172 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001173
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001174 PyErr_Format(PyExc_AttributeError,
1175 "'%.50s' object attribute '%U' is read-only",
1176 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001177 done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001178 Py_DECREF(name);
1179 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001180}
1181
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001182int
1183PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1184{
1185 return _PyObject_GenericSetAttrWithDict(obj, name, value, NULL);
1186}
1187
1188
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001189/* Test a value used as condition, e.g., in a for or if statement.
1190 Return -1 if an error occurred */
1191
1192int
Fred Drake100814d2000-07-09 15:48:49 +00001193PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001194{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001195 Py_ssize_t res;
1196 if (v == Py_True)
1197 return 1;
1198 if (v == Py_False)
1199 return 0;
1200 if (v == Py_None)
1201 return 0;
1202 else if (v->ob_type->tp_as_number != NULL &&
1203 v->ob_type->tp_as_number->nb_bool != NULL)
1204 res = (*v->ob_type->tp_as_number->nb_bool)(v);
1205 else if (v->ob_type->tp_as_mapping != NULL &&
1206 v->ob_type->tp_as_mapping->mp_length != NULL)
1207 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
1208 else if (v->ob_type->tp_as_sequence != NULL &&
1209 v->ob_type->tp_as_sequence->sq_length != NULL)
1210 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1211 else
1212 return 1;
1213 /* if it is negative, it should be either -1 or -2 */
1214 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001215}
1216
Tim Peters803526b2002-07-07 05:13:56 +00001217/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001218 Return -1 if an error occurred */
1219
1220int
Fred Drake100814d2000-07-09 15:48:49 +00001221PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001222{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001223 int res;
1224 res = PyObject_IsTrue(v);
1225 if (res < 0)
1226 return res;
1227 return res == 0;
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001228}
1229
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001230/* Test whether an object can be called */
1231
1232int
Fred Drake100814d2000-07-09 15:48:49 +00001233PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001234{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001235 if (x == NULL)
1236 return 0;
1237 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001238}
1239
Tim Peters7eea37e2001-09-04 22:08:56 +00001240
Georg Brandle32b4222007-03-10 22:13:27 +00001241/* Helper for PyObject_Dir without arguments: returns the local scope. */
1242static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001243_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001244{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001245 PyObject *names;
1246 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001247
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001248 if (locals == NULL) {
1249 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1250 return NULL;
1251 }
Tim Peters305b5852001-09-17 02:38:46 +00001252
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001253 names = PyMapping_Keys(locals);
1254 if (!names)
1255 return NULL;
1256 if (!PyList_Check(names)) {
1257 PyErr_Format(PyExc_TypeError,
1258 "dir(): expected keys() of locals to be a list, "
1259 "not '%.200s'", Py_TYPE(names)->tp_name);
1260 Py_DECREF(names);
1261 return NULL;
1262 }
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001263 if (PyList_Sort(names)) {
1264 Py_DECREF(names);
1265 return NULL;
1266 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001267 /* the locals don't need to be DECREF'd */
1268 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001269}
1270
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001271/* Helper for PyObject_Dir: object introspection. */
Georg Brandle32b4222007-03-10 22:13:27 +00001272static PyObject *
1273_dir_object(PyObject *obj)
1274{
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001275 PyObject *result, *sorted;
Benjamin Peterson7963a352011-05-23 16:11:05 -05001276 static PyObject *dir_str = NULL;
1277 PyObject *dirfunc = _PyObject_LookupSpecial(obj, "__dir__", &dir_str);
Georg Brandle32b4222007-03-10 22:13:27 +00001278
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001279 assert(obj);
1280 if (dirfunc == NULL) {
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001281 if (!PyErr_Occurred())
1282 PyErr_SetString(PyExc_TypeError, "object does not provide __dir__");
1283 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001284 }
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001285 /* use __dir__ */
1286 result = PyObject_CallFunctionObjArgs(dirfunc, NULL);
1287 Py_DECREF(dirfunc);
1288 if (result == NULL)
1289 return NULL;
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001290 /* return sorted(result) */
1291 sorted = PySequence_List(result);
1292 Py_DECREF(result);
1293 if (sorted == NULL)
1294 return NULL;
1295 if (PyList_Sort(sorted)) {
1296 Py_DECREF(sorted);
1297 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001298 }
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001299 return sorted;
Georg Brandle32b4222007-03-10 22:13:27 +00001300}
1301
1302/* Implementation of dir() -- if obj is NULL, returns the names in the current
1303 (local) scope. Otherwise, performs introspection of the object: returns a
1304 sorted list of attribute names (supposedly) accessible from the object
1305*/
1306PyObject *
1307PyObject_Dir(PyObject *obj)
1308{
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001309 return (obj == NULL) ? _dir_locals() : _dir_object(obj);
Tim Peters7eea37e2001-09-04 22:08:56 +00001310}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001311
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001312/*
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001313None is a non-NULL undefined value.
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001314There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001315so there is exactly one (which is indestructible, by the way).
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001316*/
1317
Guido van Rossum0c182a11992-03-27 17:26:13 +00001318/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001319static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001320none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001321{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001322 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001323}
1324
Barry Warsaw9bf16442001-01-23 16:24:35 +00001325/* ARGUSED */
1326static void
Tim Peters803526b2002-07-07 05:13:56 +00001327none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001328{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001329 /* This should never get called, but we also don't want to SEGV if
1330 * we accidentally decref None out of existence.
1331 */
1332 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001333}
1334
Benjamin Petersonc4607ae2011-07-29 18:19:43 -05001335static PyObject *
1336none_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1337{
1338 if (PyTuple_GET_SIZE(args) || (kwargs && PyDict_Size(kwargs))) {
1339 PyErr_SetString(PyExc_TypeError, "NoneType takes no arguments");
1340 return NULL;
1341 }
1342 Py_RETURN_NONE;
1343}
1344
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001345static int
1346none_bool(PyObject *v)
1347{
1348 return 0;
1349}
1350
1351static PyNumberMethods none_as_number = {
1352 0, /* nb_add */
1353 0, /* nb_subtract */
1354 0, /* nb_multiply */
1355 0, /* nb_remainder */
1356 0, /* nb_divmod */
1357 0, /* nb_power */
1358 0, /* nb_negative */
1359 0, /* nb_positive */
1360 0, /* nb_absolute */
1361 (inquiry)none_bool, /* nb_bool */
1362 0, /* nb_invert */
1363 0, /* nb_lshift */
1364 0, /* nb_rshift */
1365 0, /* nb_and */
1366 0, /* nb_xor */
1367 0, /* nb_or */
1368 0, /* nb_int */
1369 0, /* nb_reserved */
1370 0, /* nb_float */
1371 0, /* nb_inplace_add */
1372 0, /* nb_inplace_subtract */
1373 0, /* nb_inplace_multiply */
1374 0, /* nb_inplace_remainder */
1375 0, /* nb_inplace_power */
1376 0, /* nb_inplace_lshift */
1377 0, /* nb_inplace_rshift */
1378 0, /* nb_inplace_and */
1379 0, /* nb_inplace_xor */
1380 0, /* nb_inplace_or */
1381 0, /* nb_floor_divide */
1382 0, /* nb_true_divide */
1383 0, /* nb_inplace_floor_divide */
1384 0, /* nb_inplace_true_divide */
1385 0, /* nb_index */
1386};
Barry Warsaw9bf16442001-01-23 16:24:35 +00001387
Guido van Rossumba21a492001-08-16 08:17:26 +00001388static PyTypeObject PyNone_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001389 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1390 "NoneType",
1391 0,
1392 0,
1393 none_dealloc, /*tp_dealloc*/ /*never called*/
1394 0, /*tp_print*/
1395 0, /*tp_getattr*/
1396 0, /*tp_setattr*/
1397 0, /*tp_reserved*/
1398 none_repr, /*tp_repr*/
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001399 &none_as_number, /*tp_as_number*/
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001400 0, /*tp_as_sequence*/
1401 0, /*tp_as_mapping*/
1402 0, /*tp_hash */
Benjamin Petersonc4607ae2011-07-29 18:19:43 -05001403 0, /*tp_call */
1404 0, /*tp_str */
1405 0, /*tp_getattro */
1406 0, /*tp_setattro */
1407 0, /*tp_as_buffer */
1408 Py_TPFLAGS_DEFAULT, /*tp_flags */
1409 0, /*tp_doc */
1410 0, /*tp_traverse */
1411 0, /*tp_clear */
1412 0, /*tp_richcompare */
1413 0, /*tp_weaklistoffset */
1414 0, /*tp_iter */
1415 0, /*tp_iternext */
1416 0, /*tp_methods */
1417 0, /*tp_members */
1418 0, /*tp_getset */
1419 0, /*tp_base */
1420 0, /*tp_dict */
1421 0, /*tp_descr_get */
1422 0, /*tp_descr_set */
1423 0, /*tp_dictoffset */
1424 0, /*tp_init */
1425 0, /*tp_alloc */
1426 none_new, /*tp_new */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001427};
1428
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001429PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001430 _PyObject_EXTRA_INIT
1431 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001432};
1433
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001434/* NotImplemented is an object that can be used to signal that an
1435 operation is not implemented for the given type combination. */
1436
1437static PyObject *
1438NotImplemented_repr(PyObject *op)
1439{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001440 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001441}
1442
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001443static PyObject *
1444notimplemented_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1445{
1446 if (PyTuple_GET_SIZE(args) || (kwargs && PyDict_Size(kwargs))) {
1447 PyErr_SetString(PyExc_TypeError, "NotImplementedType takes no arguments");
1448 return NULL;
1449 }
Brian Curtindfc80e32011-08-10 20:28:54 -05001450 Py_RETURN_NOTIMPLEMENTED;
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001451}
1452
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001453static PyTypeObject PyNotImplemented_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001454 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1455 "NotImplementedType",
1456 0,
1457 0,
1458 none_dealloc, /*tp_dealloc*/ /*never called*/
1459 0, /*tp_print*/
1460 0, /*tp_getattr*/
1461 0, /*tp_setattr*/
1462 0, /*tp_reserved*/
1463 NotImplemented_repr, /*tp_repr*/
1464 0, /*tp_as_number*/
1465 0, /*tp_as_sequence*/
1466 0, /*tp_as_mapping*/
1467 0, /*tp_hash */
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001468 0, /*tp_call */
1469 0, /*tp_str */
1470 0, /*tp_getattro */
1471 0, /*tp_setattro */
1472 0, /*tp_as_buffer */
1473 Py_TPFLAGS_DEFAULT, /*tp_flags */
1474 0, /*tp_doc */
1475 0, /*tp_traverse */
1476 0, /*tp_clear */
1477 0, /*tp_richcompare */
1478 0, /*tp_weaklistoffset */
1479 0, /*tp_iter */
1480 0, /*tp_iternext */
1481 0, /*tp_methods */
1482 0, /*tp_members */
1483 0, /*tp_getset */
1484 0, /*tp_base */
1485 0, /*tp_dict */
1486 0, /*tp_descr_get */
1487 0, /*tp_descr_set */
1488 0, /*tp_dictoffset */
1489 0, /*tp_init */
1490 0, /*tp_alloc */
1491 notimplemented_new, /*tp_new */
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001492};
1493
1494PyObject _Py_NotImplementedStruct = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001495 _PyObject_EXTRA_INIT
1496 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001497};
1498
Guido van Rossumba21a492001-08-16 08:17:26 +00001499void
1500_Py_ReadyTypes(void)
1501{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001502 if (PyType_Ready(&PyType_Type) < 0)
1503 Py_FatalError("Can't initialize type type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001504
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001505 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1506 Py_FatalError("Can't initialize weakref type");
Fred Drake0a4dd392004-07-02 18:57:45 +00001507
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001508 if (PyType_Ready(&_PyWeakref_CallableProxyType) < 0)
1509 Py_FatalError("Can't initialize callable weakref proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001510
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001511 if (PyType_Ready(&_PyWeakref_ProxyType) < 0)
1512 Py_FatalError("Can't initialize weakref proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001513
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001514 if (PyType_Ready(&PyBool_Type) < 0)
1515 Py_FatalError("Can't initialize bool type");
Guido van Rossum77f6a652002-04-03 22:41:51 +00001516
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001517 if (PyType_Ready(&PyByteArray_Type) < 0)
1518 Py_FatalError("Can't initialize bytearray type");
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001519
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001520 if (PyType_Ready(&PyBytes_Type) < 0)
1521 Py_FatalError("Can't initialize 'str'");
Guido van Rossumcacfc072002-05-24 19:01:59 +00001522
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001523 if (PyType_Ready(&PyList_Type) < 0)
1524 Py_FatalError("Can't initialize list type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001525
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001526 if (PyType_Ready(&PyNone_Type) < 0)
1527 Py_FatalError("Can't initialize None type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001528
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001529 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1530 Py_FatalError("Can't initialize NotImplemented type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001531
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001532 if (PyType_Ready(&PyTraceBack_Type) < 0)
1533 Py_FatalError("Can't initialize traceback type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001534
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001535 if (PyType_Ready(&PySuper_Type) < 0)
1536 Py_FatalError("Can't initialize super type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001537
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001538 if (PyType_Ready(&PyBaseObject_Type) < 0)
1539 Py_FatalError("Can't initialize object type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001540
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001541 if (PyType_Ready(&PyRange_Type) < 0)
1542 Py_FatalError("Can't initialize range type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001543
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001544 if (PyType_Ready(&PyDict_Type) < 0)
1545 Py_FatalError("Can't initialize dict type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001546
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001547 if (PyType_Ready(&PySet_Type) < 0)
1548 Py_FatalError("Can't initialize set type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001549
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001550 if (PyType_Ready(&PyUnicode_Type) < 0)
1551 Py_FatalError("Can't initialize str type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001552
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001553 if (PyType_Ready(&PySlice_Type) < 0)
1554 Py_FatalError("Can't initialize slice type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001555
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001556 if (PyType_Ready(&PyStaticMethod_Type) < 0)
1557 Py_FatalError("Can't initialize static method type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001558
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001559 if (PyType_Ready(&PyComplex_Type) < 0)
1560 Py_FatalError("Can't initialize complex type");
Skip Montanaroba1e0f42009-10-18 14:25:35 +00001561
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001562 if (PyType_Ready(&PyFloat_Type) < 0)
1563 Py_FatalError("Can't initialize float type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001564
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001565 if (PyType_Ready(&PyLong_Type) < 0)
1566 Py_FatalError("Can't initialize int type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001567
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001568 if (PyType_Ready(&PyFrozenSet_Type) < 0)
1569 Py_FatalError("Can't initialize frozenset type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001570
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001571 if (PyType_Ready(&PyProperty_Type) < 0)
1572 Py_FatalError("Can't initialize property type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001573
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001574 if (PyType_Ready(&PyMemoryView_Type) < 0)
1575 Py_FatalError("Can't initialize memoryview type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001576
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001577 if (PyType_Ready(&PyTuple_Type) < 0)
1578 Py_FatalError("Can't initialize tuple type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001579
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001580 if (PyType_Ready(&PyEnum_Type) < 0)
1581 Py_FatalError("Can't initialize enumerate type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001582
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001583 if (PyType_Ready(&PyReversed_Type) < 0)
1584 Py_FatalError("Can't initialize reversed type");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001585
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001586 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1587 Py_FatalError("Can't initialize StdPrinter");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001588
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001589 if (PyType_Ready(&PyCode_Type) < 0)
1590 Py_FatalError("Can't initialize code type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001591
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001592 if (PyType_Ready(&PyFrame_Type) < 0)
1593 Py_FatalError("Can't initialize frame type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001594
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001595 if (PyType_Ready(&PyCFunction_Type) < 0)
1596 Py_FatalError("Can't initialize builtin function type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001597
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001598 if (PyType_Ready(&PyMethod_Type) < 0)
1599 Py_FatalError("Can't initialize method type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001600
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001601 if (PyType_Ready(&PyFunction_Type) < 0)
1602 Py_FatalError("Can't initialize function type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001603
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001604 if (PyType_Ready(&PyDictProxy_Type) < 0)
1605 Py_FatalError("Can't initialize dict proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001606
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001607 if (PyType_Ready(&PyGen_Type) < 0)
1608 Py_FatalError("Can't initialize generator type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001609
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001610 if (PyType_Ready(&PyGetSetDescr_Type) < 0)
1611 Py_FatalError("Can't initialize get-set descriptor type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001612
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001613 if (PyType_Ready(&PyWrapperDescr_Type) < 0)
1614 Py_FatalError("Can't initialize wrapper type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001615
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001616 if (PyType_Ready(&_PyMethodWrapper_Type) < 0)
1617 Py_FatalError("Can't initialize method wrapper type");
1618
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001619 if (PyType_Ready(&PyEllipsis_Type) < 0)
1620 Py_FatalError("Can't initialize ellipsis type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001621
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001622 if (PyType_Ready(&PyMemberDescr_Type) < 0)
1623 Py_FatalError("Can't initialize member descriptor type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001624
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001625 if (PyType_Ready(&PyFilter_Type) < 0)
1626 Py_FatalError("Can't initialize filter type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001627
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001628 if (PyType_Ready(&PyMap_Type) < 0)
1629 Py_FatalError("Can't initialize map type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001630
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001631 if (PyType_Ready(&PyZip_Type) < 0)
1632 Py_FatalError("Can't initialize zip type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001633}
1634
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001635
Guido van Rossum84a90321996-05-22 16:34:47 +00001636#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001637
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001638void
Fred Drake100814d2000-07-09 15:48:49 +00001639_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001640{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001641 _Py_INC_REFTOTAL;
1642 op->ob_refcnt = 1;
1643 _Py_AddToAllObjects(op, 1);
1644 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001645}
1646
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001647void
Fred Drake100814d2000-07-09 15:48:49 +00001648_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001649{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001650#ifdef SLOW_UNREF_CHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001651 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001652#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001653 if (op->ob_refcnt < 0)
1654 Py_FatalError("UNREF negative refcnt");
1655 if (op == &refchain ||
1656 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1657 fprintf(stderr, "* ob\n");
1658 _PyObject_Dump(op);
1659 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1660 _PyObject_Dump(op->_ob_prev->_ob_next);
1661 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1662 _PyObject_Dump(op->_ob_next->_ob_prev);
1663 Py_FatalError("UNREF invalid object");
1664 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001665#ifdef SLOW_UNREF_CHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001666 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1667 if (p == op)
1668 break;
1669 }
1670 if (p == &refchain) /* Not found */
1671 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001672#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001673 op->_ob_next->_ob_prev = op->_ob_prev;
1674 op->_ob_prev->_ob_next = op->_ob_next;
1675 op->_ob_next = op->_ob_prev = NULL;
1676 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001677}
1678
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001679void
Fred Drake100814d2000-07-09 15:48:49 +00001680_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001681{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001682 destructor dealloc = Py_TYPE(op)->tp_dealloc;
1683 _Py_ForgetReference(op);
1684 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001685}
1686
Tim Peters269b2a62003-04-17 19:52:29 +00001687/* Print all live objects. Because PyObject_Print is called, the
1688 * interpreter must be in a healthy state.
1689 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001690void
Fred Drake100814d2000-07-09 15:48:49 +00001691_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001692{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001693 PyObject *op;
1694 fprintf(fp, "Remaining objects:\n");
1695 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
1696 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
1697 if (PyObject_Print(op, fp, 0) != 0)
1698 PyErr_Clear();
1699 putc('\n', fp);
1700 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001701}
1702
Tim Peters269b2a62003-04-17 19:52:29 +00001703/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1704 * doesn't make any calls to the Python C API, so is always safe to call.
1705 */
1706void
1707_Py_PrintReferenceAddresses(FILE *fp)
1708{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001709 PyObject *op;
1710 fprintf(fp, "Remaining object addresses:\n");
1711 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
1712 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
1713 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001714}
1715
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001716PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001717_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001718{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001719 int i, n;
1720 PyObject *t = NULL;
1721 PyObject *res, *op;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001722
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001723 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1724 return NULL;
1725 op = refchain._ob_next;
1726 res = PyList_New(0);
1727 if (res == NULL)
1728 return NULL;
1729 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1730 while (op == self || op == args || op == res || op == t ||
1731 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
1732 op = op->_ob_next;
1733 if (op == &refchain)
1734 return res;
1735 }
1736 if (PyList_Append(res, op) < 0) {
1737 Py_DECREF(res);
1738 return NULL;
1739 }
1740 op = op->_ob_next;
1741 }
1742 return res;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001743}
1744
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001745#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001746
Benjamin Petersonb173f782009-05-05 22:31:58 +00001747/* Hack to force loading of pycapsule.o */
1748PyTypeObject *_PyCapsule_hack = &PyCapsule_Type;
1749
1750
Guido van Rossum84a90321996-05-22 16:34:47 +00001751/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001752Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001753
1754
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001755/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001756
Thomas Wouters334fb892000-07-25 12:56:38 +00001757void *
Fred Drake100814d2000-07-09 15:48:49 +00001758PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001759{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001760 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001761}
1762
Thomas Wouters334fb892000-07-25 12:56:38 +00001763void *
1764PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001765{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001766 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001767}
1768
1769void
Thomas Wouters334fb892000-07-25 12:56:38 +00001770PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001771{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001772 PyMem_FREE(p);
Guido van Rossumb18618d2000-05-03 23:44:39 +00001773}
1774
1775
Guido van Rossum86610361998-04-10 22:32:46 +00001776/* These methods are used to control infinite recursion in repr, str, print,
1777 etc. Container objects that may recursively contain themselves,
1778 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1779 Py_ReprLeave() to avoid infinite recursion.
1780
1781 Py_ReprEnter() returns 0 the first time it is called for a particular
1782 object and 1 every time thereafter. It returns -1 if an exception
1783 occurred. Py_ReprLeave() has no return value.
1784
1785 See dictobject.c and listobject.c for examples of use.
1786*/
1787
1788#define KEY "Py_Repr"
1789
1790int
Fred Drake100814d2000-07-09 15:48:49 +00001791Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001792{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001793 PyObject *dict;
1794 PyObject *list;
1795 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001796
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001797 dict = PyThreadState_GetDict();
1798 if (dict == NULL)
1799 return 0;
1800 list = PyDict_GetItemString(dict, KEY);
1801 if (list == NULL) {
1802 list = PyList_New(0);
1803 if (list == NULL)
1804 return -1;
1805 if (PyDict_SetItemString(dict, KEY, list) < 0)
1806 return -1;
1807 Py_DECREF(list);
1808 }
1809 i = PyList_GET_SIZE(list);
1810 while (--i >= 0) {
1811 if (PyList_GET_ITEM(list, i) == obj)
1812 return 1;
1813 }
1814 PyList_Append(list, obj);
1815 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001816}
1817
1818void
Fred Drake100814d2000-07-09 15:48:49 +00001819Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001820{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001821 PyObject *dict;
1822 PyObject *list;
1823 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001824
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001825 dict = PyThreadState_GetDict();
1826 if (dict == NULL)
1827 return;
1828 list = PyDict_GetItemString(dict, KEY);
1829 if (list == NULL || !PyList_Check(list))
1830 return;
1831 i = PyList_GET_SIZE(list);
1832 /* Count backwards because we always expect obj to be list[-1] */
1833 while (--i >= 0) {
1834 if (PyList_GET_ITEM(list, i) == obj) {
1835 PyList_SetSlice(list, i, i + 1, NULL);
1836 break;
1837 }
1838 }
Guido van Rossum86610361998-04-10 22:32:46 +00001839}
Guido van Rossumd724b232000-03-13 16:01:29 +00001840
Tim Peters803526b2002-07-07 05:13:56 +00001841/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001842
Tim Peters803526b2002-07-07 05:13:56 +00001843/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001844int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001845
Tim Peters803526b2002-07-07 05:13:56 +00001846/* List of objects that still need to be cleaned up, singly linked via their
1847 * gc headers' gc_prev pointers.
1848 */
1849PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001850
Tim Peters803526b2002-07-07 05:13:56 +00001851/* Add op to the _PyTrash_delete_later list. Called when the current
1852 * call-stack depth gets large. op must be a currently untracked gc'ed
1853 * object, with refcount 0. Py_DECREF must already have been called on it.
1854 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001855void
Fred Drake100814d2000-07-09 15:48:49 +00001856_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001857{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001858 assert(PyObject_IS_GC(op));
1859 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1860 assert(op->ob_refcnt == 0);
1861 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
1862 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001863}
1864
Tim Peters803526b2002-07-07 05:13:56 +00001865/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1866 * the call-stack unwinds again.
1867 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001868void
Fred Drake100814d2000-07-09 15:48:49 +00001869_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001870{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001871 while (_PyTrash_delete_later) {
1872 PyObject *op = _PyTrash_delete_later;
1873 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001874
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001875 _PyTrash_delete_later =
1876 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001877
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001878 /* Call the deallocator directly. This used to try to
1879 * fool Py_DECREF into calling it indirectly, but
1880 * Py_DECREF was already called on this object, and in
1881 * assorted non-release builds calling Py_DECREF again ends
1882 * up distorting allocation statistics.
1883 */
1884 assert(op->ob_refcnt == 0);
1885 ++_PyTrash_delete_nesting;
1886 (*dealloc)(op);
1887 --_PyTrash_delete_nesting;
1888 }
Guido van Rossumd724b232000-03-13 16:01:29 +00001889}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001890
Martin v. Löwis4d0d4712010-12-03 20:14:31 +00001891#ifndef Py_TRACE_REFS
1892/* For Py_LIMITED_API, we need an out-of-line version of _Py_Dealloc.
1893 Define this here, so we can undefine the macro. */
1894#undef _Py_Dealloc
1895PyAPI_FUNC(void) _Py_Dealloc(PyObject *);
1896void
1897_Py_Dealloc(PyObject *op)
1898{
1899 _Py_INC_TPFREES(op) _Py_COUNT_ALLOCS_COMMA
1900 (*Py_TYPE(op)->tp_dealloc)(op);
1901}
1902#endif
1903
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001904#ifdef __cplusplus
1905}
1906#endif