blob: c8c1861a4dfd2366a6e31e24203de07686509420 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Benjamin Peterson722954a2011-06-11 16:33:35 -05002/* Generic object operations; and implementation of None */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004#include "Python.h"
Benjamin Petersonfd838e62009-04-20 02:09:13 +00005#include "frameobject.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00006
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007#ifdef __cplusplus
8extern "C" {
9#endif
10
Tim Peters34592512002-07-11 06:23:50 +000011#ifdef Py_REF_DEBUG
Neal Norwitz84632ee2006-03-04 20:00:59 +000012Py_ssize_t _Py_RefTotal;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000013
14Py_ssize_t
15_Py_GetRefTotal(void)
16{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000017 PyObject *o;
18 Py_ssize_t total = _Py_RefTotal;
19 /* ignore the references to the dummy object of the dicts and sets
20 because they are not reliable and not useful (now that the
21 hash table code is well-tested) */
22 o = _PyDict_Dummy();
23 if (o != NULL)
24 total -= o->ob_refcnt;
25 o = _PySet_Dummy();
26 if (o != NULL)
27 total -= o->ob_refcnt;
28 return total;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000029}
30#endif /* Py_REF_DEBUG */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000031
Guido van Rossum3f5da241990-12-20 15:06:42 +000032/* Object allocation routines used by NEWOBJ and NEWVAROBJ macros.
33 These are used by the individual routines for object creation.
34 Do not call them otherwise, they do not initialize the object! */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000035
Tim Peters78be7992003-03-23 02:51:01 +000036#ifdef Py_TRACE_REFS
Tim Peters7571a0f2003-03-23 17:52:28 +000037/* Head of circular doubly-linked list of all objects. These are linked
38 * together via the _ob_prev and _ob_next members of a PyObject, which
39 * exist only in a Py_TRACE_REFS build.
40 */
Tim Peters78be7992003-03-23 02:51:01 +000041static PyObject refchain = {&refchain, &refchain};
Tim Peters36eb4df2003-03-23 03:33:13 +000042
Tim Peters7571a0f2003-03-23 17:52:28 +000043/* Insert op at the front of the list of all objects. If force is true,
44 * op is added even if _ob_prev and _ob_next are non-NULL already. If
45 * force is false amd _ob_prev or _ob_next are non-NULL, do nothing.
46 * force should be true if and only if op points to freshly allocated,
47 * uninitialized memory, or you've unlinked op from the list and are
Tim Peters51f8d382003-03-23 18:06:08 +000048 * relinking it into the front.
Tim Peters7571a0f2003-03-23 17:52:28 +000049 * Note that objects are normally added to the list via _Py_NewReference,
50 * which is called by PyObject_Init. Not all objects are initialized that
51 * way, though; exceptions include statically allocated type objects, and
52 * statically allocated singletons (like Py_True and Py_None).
53 */
Tim Peters36eb4df2003-03-23 03:33:13 +000054void
Tim Peters7571a0f2003-03-23 17:52:28 +000055_Py_AddToAllObjects(PyObject *op, int force)
Tim Peters36eb4df2003-03-23 03:33:13 +000056{
Tim Peters7571a0f2003-03-23 17:52:28 +000057#ifdef Py_DEBUG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000058 if (!force) {
59 /* If it's initialized memory, op must be in or out of
60 * the list unambiguously.
61 */
62 assert((op->_ob_prev == NULL) == (op->_ob_next == NULL));
63 }
Tim Peters78be7992003-03-23 02:51:01 +000064#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000065 if (force || op->_ob_prev == NULL) {
66 op->_ob_next = refchain._ob_next;
67 op->_ob_prev = &refchain;
68 refchain._ob_next->_ob_prev = op;
69 refchain._ob_next = op;
70 }
Tim Peters7571a0f2003-03-23 17:52:28 +000071}
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000072#endif /* Py_TRACE_REFS */
Tim Peters78be7992003-03-23 02:51:01 +000073
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000074#ifdef COUNT_ALLOCS
Guido van Rossumc0b618a1997-05-02 03:12:38 +000075static PyTypeObject *type_list;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000076/* All types are added to type_list, at least when
77 they get one object created. That makes them
78 immortal, which unfortunately contributes to
79 garbage itself. If unlist_types_without_objects
80 is set, they will be removed from the type_list
81 once the last object is deallocated. */
Benjamin Petersona4a37fe2009-01-11 17:13:55 +000082static int unlist_types_without_objects;
83extern Py_ssize_t tuple_zero_allocs, fast_tuple_allocs;
84extern Py_ssize_t quick_int_allocs, quick_neg_int_allocs;
85extern Py_ssize_t null_strings, one_strings;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000086void
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000087dump_counts(FILE* f)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000088{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000089 PyTypeObject *tp;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000090
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000091 for (tp = type_list; tp; tp = tp->tp_next)
92 fprintf(f, "%s alloc'd: %" PY_FORMAT_SIZE_T "d, "
93 "freed: %" PY_FORMAT_SIZE_T "d, "
94 "max in use: %" PY_FORMAT_SIZE_T "d\n",
95 tp->tp_name, tp->tp_allocs, tp->tp_frees,
96 tp->tp_maxalloc);
97 fprintf(f, "fast tuple allocs: %" PY_FORMAT_SIZE_T "d, "
98 "empty: %" PY_FORMAT_SIZE_T "d\n",
99 fast_tuple_allocs, tuple_zero_allocs);
100 fprintf(f, "fast int allocs: pos: %" PY_FORMAT_SIZE_T "d, "
101 "neg: %" PY_FORMAT_SIZE_T "d\n",
102 quick_int_allocs, quick_neg_int_allocs);
103 fprintf(f, "null strings: %" PY_FORMAT_SIZE_T "d, "
104 "1-strings: %" PY_FORMAT_SIZE_T "d\n",
105 null_strings, one_strings);
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000106}
107
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000108PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000109get_counts(void)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000110{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000111 PyTypeObject *tp;
112 PyObject *result;
113 PyObject *v;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000114
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000115 result = PyList_New(0);
116 if (result == NULL)
117 return NULL;
118 for (tp = type_list; tp; tp = tp->tp_next) {
119 v = Py_BuildValue("(snnn)", tp->tp_name, tp->tp_allocs,
120 tp->tp_frees, tp->tp_maxalloc);
121 if (v == NULL) {
122 Py_DECREF(result);
123 return NULL;
124 }
125 if (PyList_Append(result, v) < 0) {
126 Py_DECREF(v);
127 Py_DECREF(result);
128 return NULL;
129 }
130 Py_DECREF(v);
131 }
132 return result;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000133}
134
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000135void
Fred Drake100814d2000-07-09 15:48:49 +0000136inc_count(PyTypeObject *tp)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000137{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000138 if (tp->tp_next == NULL && tp->tp_prev == NULL) {
139 /* first time; insert in linked list */
140 if (tp->tp_next != NULL) /* sanity check */
141 Py_FatalError("XXX inc_count sanity check");
142 if (type_list)
143 type_list->tp_prev = tp;
144 tp->tp_next = type_list;
145 /* Note that as of Python 2.2, heap-allocated type objects
146 * can go away, but this code requires that they stay alive
147 * until program exit. That's why we're careful with
148 * refcounts here. type_list gets a new reference to tp,
149 * while ownership of the reference type_list used to hold
150 * (if any) was transferred to tp->tp_next in the line above.
151 * tp is thus effectively immortal after this.
152 */
153 Py_INCREF(tp);
154 type_list = tp;
Tim Peters3e40c7f2003-03-23 03:04:32 +0000155#ifdef Py_TRACE_REFS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000156 /* Also insert in the doubly-linked list of all objects,
157 * if not already there.
158 */
159 _Py_AddToAllObjects((PyObject *)tp, 0);
Tim Peters78be7992003-03-23 02:51:01 +0000160#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000161 }
162 tp->tp_allocs++;
163 if (tp->tp_allocs - tp->tp_frees > tp->tp_maxalloc)
164 tp->tp_maxalloc = tp->tp_allocs - tp->tp_frees;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000165}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000166
167void dec_count(PyTypeObject *tp)
168{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000169 tp->tp_frees++;
170 if (unlist_types_without_objects &&
171 tp->tp_allocs == tp->tp_frees) {
172 /* unlink the type from type_list */
173 if (tp->tp_prev)
174 tp->tp_prev->tp_next = tp->tp_next;
175 else
176 type_list = tp->tp_next;
177 if (tp->tp_next)
178 tp->tp_next->tp_prev = tp->tp_prev;
179 tp->tp_next = tp->tp_prev = NULL;
180 Py_DECREF(tp);
181 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000182}
183
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000184#endif
185
Tim Peters7c321a82002-07-09 02:57:01 +0000186#ifdef Py_REF_DEBUG
187/* Log a fatal error; doesn't return. */
188void
189_Py_NegativeRefcount(const char *fname, int lineno, PyObject *op)
190{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000191 char buf[300];
Tim Peters7c321a82002-07-09 02:57:01 +0000192
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000193 PyOS_snprintf(buf, sizeof(buf),
194 "%s:%i object at %p has negative ref count "
195 "%" PY_FORMAT_SIZE_T "d",
196 fname, lineno, op, op->ob_refcnt);
197 Py_FatalError(buf);
Tim Peters7c321a82002-07-09 02:57:01 +0000198}
199
200#endif /* Py_REF_DEBUG */
201
Thomas Heller1328b522004-04-22 17:23:49 +0000202void
203Py_IncRef(PyObject *o)
204{
205 Py_XINCREF(o);
206}
207
208void
209Py_DecRef(PyObject *o)
210{
211 Py_XDECREF(o);
212}
213
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000214PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000215PyObject_Init(PyObject *op, PyTypeObject *tp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000216{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000217 if (op == NULL)
218 return PyErr_NoMemory();
219 /* Any changes should be reflected in PyObject_INIT (objimpl.h) */
220 Py_TYPE(op) = tp;
221 _Py_NewReference(op);
222 return op;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000223}
224
Guido van Rossumb18618d2000-05-03 23:44:39 +0000225PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000226PyObject_InitVar(PyVarObject *op, PyTypeObject *tp, Py_ssize_t size)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000227{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000228 if (op == NULL)
229 return (PyVarObject *) PyErr_NoMemory();
230 /* Any changes should be reflected in PyObject_INIT_VAR */
231 op->ob_size = size;
232 Py_TYPE(op) = tp;
233 _Py_NewReference((PyObject *)op);
234 return op;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000235}
236
237PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000238_PyObject_New(PyTypeObject *tp)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000239{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000240 PyObject *op;
241 op = (PyObject *) PyObject_MALLOC(_PyObject_SIZE(tp));
242 if (op == NULL)
243 return PyErr_NoMemory();
244 return PyObject_INIT(op, tp);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000245}
246
Guido van Rossumd0c87ee1997-05-15 21:31:03 +0000247PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000248_PyObject_NewVar(PyTypeObject *tp, Py_ssize_t nitems)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000249{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000250 PyVarObject *op;
251 const size_t size = _PyObject_VAR_SIZE(tp, nitems);
252 op = (PyVarObject *) PyObject_MALLOC(size);
253 if (op == NULL)
254 return (PyVarObject *)PyErr_NoMemory();
255 return PyObject_INIT_VAR(op, tp, nitems);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000256}
257
Antoine Pitrouc47bd4a2010-07-27 22:08:27 +0000258int
259PyObject_Print(PyObject *op, FILE *fp, int flags)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000260{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000261 int ret = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000262 if (PyErr_CheckSignals())
263 return -1;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000264#ifdef USE_STACKCHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000265 if (PyOS_CheckStack()) {
266 PyErr_SetString(PyExc_MemoryError, "stack overflow");
267 return -1;
268 }
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000269#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000270 clearerr(fp); /* Clear any previous error condition */
271 if (op == NULL) {
272 Py_BEGIN_ALLOW_THREADS
273 fprintf(fp, "<nil>");
274 Py_END_ALLOW_THREADS
275 }
276 else {
277 if (op->ob_refcnt <= 0)
278 /* XXX(twouters) cast refcount to long until %zd is
279 universally available */
280 Py_BEGIN_ALLOW_THREADS
281 fprintf(fp, "<refcnt %ld at %p>",
282 (long)op->ob_refcnt, op);
283 Py_END_ALLOW_THREADS
284 else {
285 PyObject *s;
286 if (flags & Py_PRINT_RAW)
287 s = PyObject_Str(op);
288 else
289 s = PyObject_Repr(op);
290 if (s == NULL)
291 ret = -1;
292 else if (PyBytes_Check(s)) {
293 fwrite(PyBytes_AS_STRING(s), 1,
294 PyBytes_GET_SIZE(s), fp);
295 }
296 else if (PyUnicode_Check(s)) {
297 PyObject *t;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200298 t = PyUnicode_AsEncodedString(s, "utf-8", "backslashreplace");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000299 if (t == NULL)
300 ret = 0;
301 else {
302 fwrite(PyBytes_AS_STRING(t), 1,
303 PyBytes_GET_SIZE(t), fp);
Victor Stinnerba6b4302010-05-17 09:33:42 +0000304 Py_DECREF(t);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000305 }
306 }
307 else {
308 PyErr_Format(PyExc_TypeError,
309 "str() or repr() returned '%.100s'",
310 s->ob_type->tp_name);
311 ret = -1;
312 }
313 Py_XDECREF(s);
314 }
315 }
316 if (ret == 0) {
317 if (ferror(fp)) {
318 PyErr_SetFromErrno(PyExc_IOError);
319 clearerr(fp);
320 ret = -1;
321 }
322 }
323 return ret;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000324}
325
Guido van Rossum38938152006-08-21 23:36:26 +0000326/* For debugging convenience. Set a breakpoint here and call it from your DLL */
327void
Thomas Woutersb2137042007-02-01 18:02:27 +0000328_Py_BreakPoint(void)
Guido van Rossum38938152006-08-21 23:36:26 +0000329{
330}
331
Neal Norwitz1a997502003-01-13 20:13:12 +0000332
Barry Warsaw9bf16442001-01-23 16:24:35 +0000333/* For debugging convenience. See Misc/gdbinit for some useful gdb hooks */
Guido van Rossum38938152006-08-21 23:36:26 +0000334void
335_PyObject_Dump(PyObject* op)
Barry Warsaw9bf16442001-01-23 16:24:35 +0000336{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000337 if (op == NULL)
338 fprintf(stderr, "NULL\n");
339 else {
Georg Brandldfd73442009-04-05 11:47:34 +0000340#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000341 PyGILState_STATE gil;
Georg Brandldfd73442009-04-05 11:47:34 +0000342#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000343 fprintf(stderr, "object : ");
Georg Brandldfd73442009-04-05 11:47:34 +0000344#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000345 gil = PyGILState_Ensure();
Georg Brandldfd73442009-04-05 11:47:34 +0000346#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000347 (void)PyObject_Print(op, stderr, 0);
Georg Brandldfd73442009-04-05 11:47:34 +0000348#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000349 PyGILState_Release(gil);
Georg Brandldfd73442009-04-05 11:47:34 +0000350#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000351 /* XXX(twouters) cast refcount to long until %zd is
352 universally available */
353 fprintf(stderr, "\n"
354 "type : %s\n"
355 "refcount: %ld\n"
356 "address : %p\n",
357 Py_TYPE(op)==NULL ? "NULL" : Py_TYPE(op)->tp_name,
358 (long)op->ob_refcnt,
359 op);
360 }
Barry Warsaw9bf16442001-01-23 16:24:35 +0000361}
Barry Warsaw903138f2001-01-23 16:33:18 +0000362
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000363PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000364PyObject_Repr(PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000365{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000366 PyObject *res;
367 if (PyErr_CheckSignals())
368 return NULL;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000369#ifdef USE_STACKCHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000370 if (PyOS_CheckStack()) {
371 PyErr_SetString(PyExc_MemoryError, "stack overflow");
372 return NULL;
373 }
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000374#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000375 if (v == NULL)
376 return PyUnicode_FromString("<NULL>");
377 if (Py_TYPE(v)->tp_repr == NULL)
378 return PyUnicode_FromFormat("<%s object at %p>",
379 v->ob_type->tp_name, v);
380 res = (*v->ob_type->tp_repr)(v);
Victor Stinner0a54cf12011-12-01 03:22:44 +0100381 if (res == NULL)
382 return NULL;
383 if (!PyUnicode_Check(res)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000384 PyErr_Format(PyExc_TypeError,
385 "__repr__ returned non-string (type %.200s)",
386 res->ob_type->tp_name);
387 Py_DECREF(res);
388 return NULL;
389 }
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100390#ifndef Py_DEBUG
391 if (PyUnicode_READY(res) < 0)
392 return NULL;
393#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000394 return res;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000395}
396
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000397PyObject *
Guido van Rossum98297ee2007-11-06 21:34:58 +0000398PyObject_Str(PyObject *v)
Guido van Rossumc6004111993-11-05 10:22:19 +0000399{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000400 PyObject *res;
401 if (PyErr_CheckSignals())
402 return NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000403#ifdef USE_STACKCHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000404 if (PyOS_CheckStack()) {
405 PyErr_SetString(PyExc_MemoryError, "stack overflow");
406 return NULL;
407 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000408#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000409 if (v == NULL)
410 return PyUnicode_FromString("<NULL>");
411 if (PyUnicode_CheckExact(v)) {
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100412#ifndef Py_DEBUG
Victor Stinner4ead7c72011-11-20 19:48:36 +0100413 if (PyUnicode_READY(v) < 0)
414 return NULL;
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100415#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000416 Py_INCREF(v);
417 return v;
418 }
419 if (Py_TYPE(v)->tp_str == NULL)
420 return PyObject_Repr(v);
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000421
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000422 /* It is possible for a type to have a tp_str representation that loops
423 infinitely. */
424 if (Py_EnterRecursiveCall(" while getting the str of an object"))
425 return NULL;
426 res = (*Py_TYPE(v)->tp_str)(v);
427 Py_LeaveRecursiveCall();
428 if (res == NULL)
429 return NULL;
430 if (!PyUnicode_Check(res)) {
431 PyErr_Format(PyExc_TypeError,
432 "__str__ returned non-string (type %.200s)",
433 Py_TYPE(res)->tp_name);
434 Py_DECREF(res);
435 return NULL;
436 }
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100437#ifndef Py_DEBUG
Victor Stinner4ead7c72011-11-20 19:48:36 +0100438 if (PyUnicode_READY(res) < 0)
439 return NULL;
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100440#endif
Victor Stinner4ead7c72011-11-20 19:48:36 +0100441 assert(_PyUnicode_CheckConsistency(res, 1));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000442 return res;
Neil Schemenauercf52c072005-08-12 17:34:58 +0000443}
444
Georg Brandl559e5d72008-06-11 18:37:52 +0000445PyObject *
446PyObject_ASCII(PyObject *v)
447{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000448 PyObject *repr, *ascii, *res;
Georg Brandl559e5d72008-06-11 18:37:52 +0000449
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000450 repr = PyObject_Repr(v);
451 if (repr == NULL)
452 return NULL;
Georg Brandl559e5d72008-06-11 18:37:52 +0000453
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000454 /* repr is guaranteed to be a PyUnicode object by PyObject_Repr */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200455 ascii = _PyUnicode_AsASCIIString(repr, "backslashreplace");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000456 Py_DECREF(repr);
457 if (ascii == NULL)
458 return NULL;
Georg Brandl559e5d72008-06-11 18:37:52 +0000459
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000460 res = PyUnicode_DecodeASCII(
461 PyBytes_AS_STRING(ascii),
462 PyBytes_GET_SIZE(ascii),
463 NULL);
464
465 Py_DECREF(ascii);
466 return res;
Georg Brandl559e5d72008-06-11 18:37:52 +0000467}
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000468
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000469PyObject *
470PyObject_Bytes(PyObject *v)
471{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000472 PyObject *result, *func;
Benjamin Petersonce798522012-01-22 11:24:29 -0500473 _Py_IDENTIFIER(__bytes__);
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000474
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000475 if (v == NULL)
476 return PyBytes_FromString("<NULL>");
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000477
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000478 if (PyBytes_CheckExact(v)) {
479 Py_INCREF(v);
480 return v;
481 }
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000482
Benjamin Petersonce798522012-01-22 11:24:29 -0500483 func = _PyObject_LookupSpecial(v, &PyId___bytes__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000484 if (func != NULL) {
485 result = PyObject_CallFunctionObjArgs(func, NULL);
486 Py_DECREF(func);
487 if (result == NULL)
Benjamin Peterson41ece392010-09-11 16:39:57 +0000488 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000489 if (!PyBytes_Check(result)) {
Benjamin Peterson41ece392010-09-11 16:39:57 +0000490 PyErr_Format(PyExc_TypeError,
491 "__bytes__ returned non-bytes (type %.200s)",
492 Py_TYPE(result)->tp_name);
493 Py_DECREF(result);
494 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000495 }
496 return result;
497 }
498 else if (PyErr_Occurred())
499 return NULL;
500 return PyBytes_FromObject(v);
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000501}
502
Mark Dickinsonc008a172009-02-01 13:59:22 +0000503/* For Python 3.0.1 and later, the old three-way comparison has been
504 completely removed in favour of rich comparisons. PyObject_Compare() and
505 PyObject_Cmp() are gone, and the builtin cmp function no longer exists.
Mark Dickinsone94c6792009-02-02 20:36:42 +0000506 The old tp_compare slot has been renamed to tp_reserved, and should no
Mark Dickinsonc008a172009-02-01 13:59:22 +0000507 longer be used. Use tp_richcompare instead.
Guido van Rossum98297ee2007-11-06 21:34:58 +0000508
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000509 See (*) below for practical amendments.
510
Mark Dickinsonc008a172009-02-01 13:59:22 +0000511 tp_richcompare gets called with a first argument of the appropriate type
512 and a second object of an arbitrary type. We never do any kind of
513 coercion.
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000514
Mark Dickinsonc008a172009-02-01 13:59:22 +0000515 The tp_richcompare slot should return an object, as follows:
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000516
517 NULL if an exception occurred
518 NotImplemented if the requested comparison is not implemented
519 any other false value if the requested comparison is false
520 any other true value if the requested comparison is true
521
522 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
523 NotImplemented.
524
525 (*) Practical amendments:
526
527 - If rich comparison returns NotImplemented, == and != are decided by
528 comparing the object pointer (i.e. falling back to the base object
529 implementation).
530
Guido van Rossuma4073002002-05-31 20:03:54 +0000531*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000532
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000533/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000534int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000535
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000536static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000537
538/* Perform a rich comparison, raising TypeError when the requested comparison
539 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000540static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000541do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000542{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000543 richcmpfunc f;
544 PyObject *res;
545 int checked_reverse_op = 0;
Guido van Rossume797ec12001-01-17 15:24:28 +0000546
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000547 if (v->ob_type != w->ob_type &&
548 PyType_IsSubtype(w->ob_type, v->ob_type) &&
549 (f = w->ob_type->tp_richcompare) != NULL) {
550 checked_reverse_op = 1;
551 res = (*f)(w, v, _Py_SwappedOp[op]);
552 if (res != Py_NotImplemented)
553 return res;
554 Py_DECREF(res);
555 }
556 if ((f = v->ob_type->tp_richcompare) != NULL) {
557 res = (*f)(v, w, op);
558 if (res != Py_NotImplemented)
559 return res;
560 Py_DECREF(res);
561 }
562 if (!checked_reverse_op && (f = w->ob_type->tp_richcompare) != NULL) {
563 res = (*f)(w, v, _Py_SwappedOp[op]);
564 if (res != Py_NotImplemented)
565 return res;
566 Py_DECREF(res);
567 }
568 /* If neither object implements it, provide a sensible default
569 for == and !=, but raise an exception for ordering. */
570 switch (op) {
571 case Py_EQ:
572 res = (v == w) ? Py_True : Py_False;
573 break;
574 case Py_NE:
575 res = (v != w) ? Py_True : Py_False;
576 break;
577 default:
578 /* XXX Special-case None so it doesn't show as NoneType() */
579 PyErr_Format(PyExc_TypeError,
580 "unorderable types: %.100s() %s %.100s()",
581 v->ob_type->tp_name,
582 opstrings[op],
583 w->ob_type->tp_name);
584 return NULL;
585 }
586 Py_INCREF(res);
587 return res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000588}
589
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000590/* Perform a rich comparison with object result. This wraps do_richcompare()
591 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000592
Guido van Rossume797ec12001-01-17 15:24:28 +0000593PyObject *
594PyObject_RichCompare(PyObject *v, PyObject *w, int op)
595{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000596 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000597
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000598 assert(Py_LT <= op && op <= Py_GE);
599 if (v == NULL || w == NULL) {
600 if (!PyErr_Occurred())
601 PyErr_BadInternalCall();
602 return NULL;
603 }
604 if (Py_EnterRecursiveCall(" in comparison"))
605 return NULL;
606 res = do_richcompare(v, w, op);
607 Py_LeaveRecursiveCall();
608 return res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000609}
610
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000611/* Perform a rich comparison with integer result. This wraps
612 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000613int
614PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
615{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000616 PyObject *res;
617 int ok;
Guido van Rossume797ec12001-01-17 15:24:28 +0000618
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000619 /* Quick result when objects are the same.
620 Guarantees that identity implies equality. */
621 if (v == w) {
622 if (op == Py_EQ)
623 return 1;
624 else if (op == Py_NE)
625 return 0;
626 }
Mark Dickinson4a1f5932008-11-12 23:23:36 +0000627
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000628 res = PyObject_RichCompare(v, w, op);
629 if (res == NULL)
630 return -1;
631 if (PyBool_Check(res))
632 ok = (res == Py_True);
633 else
634 ok = PyObject_IsTrue(res);
635 Py_DECREF(res);
636 return ok;
Guido van Rossume797ec12001-01-17 15:24:28 +0000637}
Fred Drake13634cf2000-06-29 19:17:04 +0000638
639/* Set of hash utility functions to help maintaining the invariant that
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000640 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000641
642 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
643*/
644
Mark Dickinsondc787d22010-05-23 13:33:13 +0000645/* For numeric types, the hash of a number x is based on the reduction
646 of x modulo the prime P = 2**_PyHASH_BITS - 1. It's designed so that
647 hash(x) == hash(y) whenever x and y are numerically equal, even if
648 x and y have different types.
649
650 A quick summary of the hashing strategy:
651
652 (1) First define the 'reduction of x modulo P' for any rational
653 number x; this is a standard extension of the usual notion of
654 reduction modulo P for integers. If x == p/q (written in lowest
655 terms), the reduction is interpreted as the reduction of p times
656 the inverse of the reduction of q, all modulo P; if q is exactly
657 divisible by P then define the reduction to be infinity. So we've
658 got a well-defined map
659
660 reduce : { rational numbers } -> { 0, 1, 2, ..., P-1, infinity }.
661
662 (2) Now for a rational number x, define hash(x) by:
663
664 reduce(x) if x >= 0
665 -reduce(-x) if x < 0
666
667 If the result of the reduction is infinity (this is impossible for
668 integers, floats and Decimals) then use the predefined hash value
669 _PyHASH_INF for x >= 0, or -_PyHASH_INF for x < 0, instead.
670 _PyHASH_INF, -_PyHASH_INF and _PyHASH_NAN are also used for the
671 hashes of float and Decimal infinities and nans.
672
673 A selling point for the above strategy is that it makes it possible
674 to compute hashes of decimal and binary floating-point numbers
675 efficiently, even if the exponent of the binary or decimal number
676 is large. The key point is that
677
678 reduce(x * y) == reduce(x) * reduce(y) (modulo _PyHASH_MODULUS)
679
680 provided that {reduce(x), reduce(y)} != {0, infinity}. The reduction of a
681 binary or decimal float is never infinity, since the denominator is a power
682 of 2 (for binary) or a divisor of a power of 10 (for decimal). So we have,
683 for nonnegative x,
684
685 reduce(x * 2**e) == reduce(x) * reduce(2**e) % _PyHASH_MODULUS
686
687 reduce(x * 10**e) == reduce(x) * reduce(10**e) % _PyHASH_MODULUS
688
689 and reduce(10**e) can be computed efficiently by the usual modular
690 exponentiation algorithm. For reduce(2**e) it's even better: since
691 P is of the form 2**n-1, reduce(2**e) is 2**(e mod n), and multiplication
692 by 2**(e mod n) modulo 2**n-1 just amounts to a rotation of bits.
693
694 */
695
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000696Py_hash_t
Fred Drake100814d2000-07-09 15:48:49 +0000697_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000698{
Mark Dickinsondc787d22010-05-23 13:33:13 +0000699 int e, sign;
700 double m;
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000701 Py_uhash_t x, y;
Tim Peters39dce292000-08-15 03:34:48 +0000702
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000703 if (!Py_IS_FINITE(v)) {
704 if (Py_IS_INFINITY(v))
Mark Dickinsondc787d22010-05-23 13:33:13 +0000705 return v > 0 ? _PyHASH_INF : -_PyHASH_INF;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000706 else
Mark Dickinsondc787d22010-05-23 13:33:13 +0000707 return _PyHASH_NAN;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000708 }
Mark Dickinsondc787d22010-05-23 13:33:13 +0000709
710 m = frexp(v, &e);
711
712 sign = 1;
713 if (m < 0) {
714 sign = -1;
715 m = -m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000716 }
Mark Dickinsondc787d22010-05-23 13:33:13 +0000717
718 /* process 28 bits at a time; this should work well both for binary
719 and hexadecimal floating point. */
720 x = 0;
721 while (m) {
722 x = ((x << 28) & _PyHASH_MODULUS) | x >> (_PyHASH_BITS - 28);
723 m *= 268435456.0; /* 2**28 */
724 e -= 28;
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000725 y = (Py_uhash_t)m; /* pull out integer part */
Mark Dickinsondc787d22010-05-23 13:33:13 +0000726 m -= y;
727 x += y;
728 if (x >= _PyHASH_MODULUS)
729 x -= _PyHASH_MODULUS;
730 }
731
732 /* adjust for the exponent; first reduce it modulo _PyHASH_BITS */
733 e = e >= 0 ? e % _PyHASH_BITS : _PyHASH_BITS-1-((-1-e) % _PyHASH_BITS);
734 x = ((x << e) & _PyHASH_MODULUS) | x >> (_PyHASH_BITS - e);
735
736 x = x * sign;
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000737 if (x == (Py_uhash_t)-1)
738 x = (Py_uhash_t)-2;
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000739 return (Py_hash_t)x;
Fred Drake13634cf2000-06-29 19:17:04 +0000740}
741
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000742Py_hash_t
Fred Drake100814d2000-07-09 15:48:49 +0000743_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000744{
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000745 Py_hash_t x;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000746 size_t y = (size_t)p;
747 /* bottom 3 or 4 bits are likely to be 0; rotate y by 4 to avoid
748 excessive hash collisions for dicts and sets */
749 y = (y >> 4) | (y << (8 * SIZEOF_VOID_P - 4));
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000750 x = (Py_hash_t)y;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000751 if (x == -1)
752 x = -2;
753 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000754}
755
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000756Py_hash_t
Antoine Pitrouce4a9da2011-11-21 20:46:33 +0100757_Py_HashBytes(unsigned char *p, Py_ssize_t len)
758{
759 Py_uhash_t x;
760 Py_ssize_t i;
761
Georg Brandl2fb477c2012-02-21 00:33:36 +0100762 /*
763 We make the hash of the empty string be 0, rather than using
764 (prefix ^ suffix), since this slightly obfuscates the hash secret
765 */
Benjamin Peterson64ed5762012-04-09 15:04:39 -0400766#ifdef Py_DEBUG
Benjamin Petersond9a35912012-02-21 11:12:14 -0500767 assert(_Py_HashSecret_Initialized);
Benjamin Peterson64ed5762012-04-09 15:04:39 -0400768#endif
Georg Brandl2fb477c2012-02-21 00:33:36 +0100769 if (len == 0) {
770 return 0;
771 }
772 x = (Py_uhash_t) _Py_HashSecret.prefix;
773 x ^= (Py_uhash_t) *p << 7;
Antoine Pitrouce4a9da2011-11-21 20:46:33 +0100774 for (i = 0; i < len; i++)
Gregory P. Smithf5b62a92012-01-14 15:45:13 -0800775 x = (_PyHASH_MULTIPLIER * x) ^ (Py_uhash_t) *p++;
Antoine Pitrouce4a9da2011-11-21 20:46:33 +0100776 x ^= (Py_uhash_t) len;
Georg Brandl2fb477c2012-02-21 00:33:36 +0100777 x ^= (Py_uhash_t) _Py_HashSecret.suffix;
Antoine Pitrouce4a9da2011-11-21 20:46:33 +0100778 if (x == -1)
779 x = -2;
780 return x;
781}
782
783Py_hash_t
Nick Coghland1abd252008-07-15 15:46:38 +0000784PyObject_HashNotImplemented(PyObject *v)
785{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000786 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
787 Py_TYPE(v)->tp_name);
788 return -1;
Nick Coghland1abd252008-07-15 15:46:38 +0000789}
Fred Drake13634cf2000-06-29 19:17:04 +0000790
Georg Brandl2daf6ae2012-02-20 19:54:16 +0100791_Py_HashSecret_t _Py_HashSecret;
792
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000793Py_hash_t
Fred Drake100814d2000-07-09 15:48:49 +0000794PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000795{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000796 PyTypeObject *tp = Py_TYPE(v);
797 if (tp->tp_hash != NULL)
798 return (*tp->tp_hash)(v);
799 /* To keep to the general practice that inheriting
800 * solely from object in C code should work without
801 * an explicit call to PyType_Ready, we implicitly call
802 * PyType_Ready here and then check the tp_hash slot again
803 */
804 if (tp->tp_dict == NULL) {
805 if (PyType_Ready(tp) < 0)
806 return -1;
807 if (tp->tp_hash != NULL)
808 return (*tp->tp_hash)(v);
809 }
810 /* Otherwise, the object can't be hashed */
811 return PyObject_HashNotImplemented(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000812}
813
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000814PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000815PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000816{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000817 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000818
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000819 if (Py_TYPE(v)->tp_getattr != NULL)
820 return (*Py_TYPE(v)->tp_getattr)(v, (char*)name);
821 w = PyUnicode_InternFromString(name);
822 if (w == NULL)
823 return NULL;
824 res = PyObject_GetAttr(v, w);
Victor Stinner59af08f2012-03-22 02:09:08 +0100825 Py_DECREF(w);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000826 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000827}
828
829int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000830PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000831{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000832 PyObject *res = PyObject_GetAttrString(v, name);
833 if (res != NULL) {
834 Py_DECREF(res);
835 return 1;
836 }
837 PyErr_Clear();
838 return 0;
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000839}
840
841int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000842PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000843{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000844 PyObject *s;
845 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000846
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000847 if (Py_TYPE(v)->tp_setattr != NULL)
848 return (*Py_TYPE(v)->tp_setattr)(v, (char*)name, w);
849 s = PyUnicode_InternFromString(name);
850 if (s == NULL)
851 return -1;
852 res = PyObject_SetAttr(v, s, w);
853 Py_XDECREF(s);
854 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000855}
856
Benjamin Petersonbfebb7b2011-12-15 15:34:02 -0500857int
858_PyObject_IsAbstract(PyObject *obj)
859{
860 int res;
861 PyObject* isabstract;
862 _Py_IDENTIFIER(__isabstractmethod__);
863
864 if (obj == NULL)
865 return 0;
866
867 isabstract = _PyObject_GetAttrId(obj, &PyId___isabstractmethod__);
868 if (isabstract == NULL) {
869 if (PyErr_ExceptionMatches(PyExc_AttributeError)) {
870 PyErr_Clear();
871 return 0;
872 }
873 return -1;
874 }
875 res = PyObject_IsTrue(isabstract);
876 Py_DECREF(isabstract);
877 return res;
878}
879
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000880PyObject *
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200881_PyObject_GetAttrId(PyObject *v, _Py_Identifier *name)
882{
883 PyObject *result;
Martin v. Löwisd10759f2011-11-07 13:00:05 +0100884 PyObject *oname = _PyUnicode_FromId(name); /* borrowed */
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200885 if (!oname)
886 return NULL;
887 result = PyObject_GetAttr(v, oname);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200888 return result;
889}
890
891int
892_PyObject_HasAttrId(PyObject *v, _Py_Identifier *name)
893{
894 int result;
Martin v. Löwisd10759f2011-11-07 13:00:05 +0100895 PyObject *oname = _PyUnicode_FromId(name); /* borrowed */
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200896 if (!oname)
897 return -1;
898 result = PyObject_HasAttr(v, oname);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200899 return result;
900}
901
902int
903_PyObject_SetAttrId(PyObject *v, _Py_Identifier *name, PyObject *w)
904{
905 int result;
Martin v. Löwisd10759f2011-11-07 13:00:05 +0100906 PyObject *oname = _PyUnicode_FromId(name); /* borrowed */
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200907 if (!oname)
908 return -1;
909 result = PyObject_SetAttr(v, oname, w);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200910 return result;
911}
912
913PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000914PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000915{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000916 PyTypeObject *tp = Py_TYPE(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000917
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000918 if (!PyUnicode_Check(name)) {
919 PyErr_Format(PyExc_TypeError,
920 "attribute name must be string, not '%.200s'",
921 name->ob_type->tp_name);
922 return NULL;
923 }
924 if (tp->tp_getattro != NULL)
925 return (*tp->tp_getattro)(v, name);
926 if (tp->tp_getattr != NULL) {
927 char *name_str = _PyUnicode_AsString(name);
928 if (name_str == NULL)
929 return NULL;
930 return (*tp->tp_getattr)(v, name_str);
931 }
932 PyErr_Format(PyExc_AttributeError,
933 "'%.50s' object has no attribute '%U'",
934 tp->tp_name, name);
935 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000936}
937
938int
Fred Drake100814d2000-07-09 15:48:49 +0000939PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000940{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000941 PyObject *res = PyObject_GetAttr(v, name);
942 if (res != NULL) {
943 Py_DECREF(res);
944 return 1;
945 }
946 PyErr_Clear();
947 return 0;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000948}
949
950int
Fred Drake100814d2000-07-09 15:48:49 +0000951PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000952{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000953 PyTypeObject *tp = Py_TYPE(v);
954 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000955
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000956 if (!PyUnicode_Check(name)) {
957 PyErr_Format(PyExc_TypeError,
958 "attribute name must be string, not '%.200s'",
959 name->ob_type->tp_name);
960 return -1;
961 }
962 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000963
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000964 PyUnicode_InternInPlace(&name);
965 if (tp->tp_setattro != NULL) {
966 err = (*tp->tp_setattro)(v, name, value);
967 Py_DECREF(name);
968 return err;
969 }
970 if (tp->tp_setattr != NULL) {
971 char *name_str = _PyUnicode_AsString(name);
972 if (name_str == NULL)
973 return -1;
974 err = (*tp->tp_setattr)(v, name_str, value);
975 Py_DECREF(name);
976 return err;
977 }
978 Py_DECREF(name);
979 assert(name->ob_refcnt >= 1);
980 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
981 PyErr_Format(PyExc_TypeError,
982 "'%.100s' object has no attributes "
983 "(%s .%U)",
984 tp->tp_name,
985 value==NULL ? "del" : "assign to",
986 name);
987 else
988 PyErr_Format(PyExc_TypeError,
989 "'%.100s' object has only read-only attributes "
990 "(%s .%U)",
991 tp->tp_name,
992 value==NULL ? "del" : "assign to",
993 name);
994 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000995}
996
997/* Helper to get a pointer to an object's __dict__ slot, if any */
998
999PyObject **
1000_PyObject_GetDictPtr(PyObject *obj)
1001{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001002 Py_ssize_t dictoffset;
1003 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001004
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001005 dictoffset = tp->tp_dictoffset;
1006 if (dictoffset == 0)
1007 return NULL;
1008 if (dictoffset < 0) {
1009 Py_ssize_t tsize;
1010 size_t size;
Guido van Rossum2eb0b872002-03-01 22:24:49 +00001011
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001012 tsize = ((PyVarObject *)obj)->ob_size;
1013 if (tsize < 0)
1014 tsize = -tsize;
1015 size = _PyObject_VAR_SIZE(tp, tsize);
Guido van Rossum2eb0b872002-03-01 22:24:49 +00001016
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001017 dictoffset += (long)size;
1018 assert(dictoffset > 0);
1019 assert(dictoffset % SIZEOF_VOID_P == 0);
1020 }
1021 return (PyObject **) ((char *)obj + dictoffset);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001022}
1023
Tim Peters6d6c1a32001-08-02 04:15:00 +00001024PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +00001025PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +00001026{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001027 Py_INCREF(obj);
1028 return obj;
Raymond Hettinger01538262003-03-17 08:24:35 +00001029}
1030
Antoine Pitroua7013882012-04-05 00:04:20 +02001031/* Convenience function to get a builtin from its name */
1032PyObject *
1033_PyObject_GetBuiltin(const char *name)
1034{
1035 PyObject *mod, *attr;
1036 mod = PyImport_ImportModule("builtins");
1037 if (mod == NULL)
1038 return NULL;
1039 attr = PyObject_GetAttrString(mod, name);
1040 Py_DECREF(mod);
1041 return attr;
1042}
1043
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +00001044/* Helper used when the __next__ method is removed from a type:
1045 tp_iternext is never NULL and can be safely called without checking
1046 on every iteration.
1047 */
1048
1049PyObject *
1050_PyObject_NextNotImplemented(PyObject *self)
1051{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001052 PyErr_Format(PyExc_TypeError,
1053 "'%.200s' object is not iterable",
1054 Py_TYPE(self)->tp_name);
1055 return NULL;
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +00001056}
1057
Michael W. Hudson1593f502004-09-14 17:09:47 +00001058/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
1059
Raymond Hettinger01538262003-03-17 08:24:35 +00001060PyObject *
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001061_PyObject_GenericGetAttrWithDict(PyObject *obj, PyObject *name, PyObject *dict)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001062{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001063 PyTypeObject *tp = Py_TYPE(obj);
1064 PyObject *descr = NULL;
1065 PyObject *res = NULL;
1066 descrgetfunc f;
1067 Py_ssize_t dictoffset;
1068 PyObject **dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001069
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001070 if (!PyUnicode_Check(name)){
1071 PyErr_Format(PyExc_TypeError,
1072 "attribute name must be string, not '%.200s'",
1073 name->ob_type->tp_name);
1074 return NULL;
1075 }
1076 else
1077 Py_INCREF(name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001078
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001079 if (tp->tp_dict == NULL) {
1080 if (PyType_Ready(tp) < 0)
1081 goto done;
1082 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001083
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001084 descr = _PyType_Lookup(tp, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001085 Py_XINCREF(descr);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001086
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001087 f = NULL;
1088 if (descr != NULL) {
1089 f = descr->ob_type->tp_descr_get;
1090 if (f != NULL && PyDescr_IsData(descr)) {
1091 res = f(descr, obj, (PyObject *)obj->ob_type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001092 goto done;
1093 }
1094 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001095
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001096 if (dict == NULL) {
1097 /* Inline _PyObject_GetDictPtr */
1098 dictoffset = tp->tp_dictoffset;
1099 if (dictoffset != 0) {
1100 if (dictoffset < 0) {
1101 Py_ssize_t tsize;
1102 size_t size;
Guido van Rossumc66ff442002-08-19 16:50:48 +00001103
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001104 tsize = ((PyVarObject *)obj)->ob_size;
1105 if (tsize < 0)
1106 tsize = -tsize;
1107 size = _PyObject_VAR_SIZE(tp, tsize);
Guido van Rossumc66ff442002-08-19 16:50:48 +00001108
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001109 dictoffset += (long)size;
1110 assert(dictoffset > 0);
1111 assert(dictoffset % SIZEOF_VOID_P == 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001112 }
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001113 dictptr = (PyObject **) ((char *)obj + dictoffset);
1114 dict = *dictptr;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001115 }
1116 }
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001117 if (dict != NULL) {
1118 Py_INCREF(dict);
1119 res = PyDict_GetItem(dict, name);
1120 if (res != NULL) {
1121 Py_INCREF(res);
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001122 Py_DECREF(dict);
1123 goto done;
1124 }
1125 Py_DECREF(dict);
1126 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001127
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001128 if (f != NULL) {
1129 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001130 goto done;
1131 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001132
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001133 if (descr != NULL) {
1134 res = descr;
Victor Stinner2d01dc02012-03-09 00:44:13 +01001135 descr = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001136 goto done;
1137 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001138
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001139 PyErr_Format(PyExc_AttributeError,
1140 "'%.50s' object has no attribute '%U'",
1141 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001142 done:
Victor Stinner2d01dc02012-03-09 00:44:13 +01001143 Py_XDECREF(descr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001144 Py_DECREF(name);
1145 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001146}
1147
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001148PyObject *
1149PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
1150{
1151 return _PyObject_GenericGetAttrWithDict(obj, name, NULL);
1152}
1153
Tim Peters6d6c1a32001-08-02 04:15:00 +00001154int
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001155_PyObject_GenericSetAttrWithDict(PyObject *obj, PyObject *name,
1156 PyObject *value, PyObject *dict)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001157{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001158 PyTypeObject *tp = Py_TYPE(obj);
1159 PyObject *descr;
1160 descrsetfunc f;
1161 PyObject **dictptr;
1162 int res = -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001163
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001164 if (!PyUnicode_Check(name)){
1165 PyErr_Format(PyExc_TypeError,
1166 "attribute name must be string, not '%.200s'",
1167 name->ob_type->tp_name);
1168 return -1;
1169 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001170
Benjamin Peterson74529ad2012-03-09 07:25:32 -08001171 if (tp->tp_dict == NULL && PyType_Ready(tp) < 0)
1172 return -1;
1173
1174 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001175
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001176 descr = _PyType_Lookup(tp, name);
Victor Stinner2d01dc02012-03-09 00:44:13 +01001177 Py_XINCREF(descr);
1178
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001179 f = NULL;
1180 if (descr != NULL) {
1181 f = descr->ob_type->tp_descr_set;
1182 if (f != NULL && PyDescr_IsData(descr)) {
1183 res = f(descr, obj, value);
1184 goto done;
1185 }
1186 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001187
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001188 if (dict == NULL) {
1189 dictptr = _PyObject_GetDictPtr(obj);
1190 if (dictptr != NULL) {
1191 dict = *dictptr;
1192 if (dict == NULL && value != NULL) {
1193 dict = PyDict_New();
1194 if (dict == NULL)
1195 goto done;
1196 *dictptr = dict;
1197 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001198 }
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001199 }
1200 if (dict != NULL) {
1201 Py_INCREF(dict);
1202 if (value == NULL)
1203 res = PyDict_DelItem(dict, name);
1204 else
1205 res = PyDict_SetItem(dict, name, value);
Benjamin Peterson74529ad2012-03-09 07:25:32 -08001206 Py_DECREF(dict);
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001207 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1208 PyErr_SetObject(PyExc_AttributeError, name);
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001209 goto done;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001210 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001211
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001212 if (f != NULL) {
1213 res = f(descr, obj, value);
1214 goto done;
1215 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001216
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001217 if (descr == NULL) {
1218 PyErr_Format(PyExc_AttributeError,
1219 "'%.100s' object has no attribute '%U'",
1220 tp->tp_name, name);
1221 goto done;
1222 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001223
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001224 PyErr_Format(PyExc_AttributeError,
1225 "'%.50s' object attribute '%U' is read-only",
1226 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001227 done:
Victor Stinner2d01dc02012-03-09 00:44:13 +01001228 Py_XDECREF(descr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001229 Py_DECREF(name);
1230 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001231}
1232
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001233int
1234PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1235{
1236 return _PyObject_GenericSetAttrWithDict(obj, name, value, NULL);
1237}
1238
Benjamin Peterson8eb12692012-02-19 19:59:10 -05001239PyObject *
1240PyObject_GenericGetDict(PyObject *obj, void *context)
1241{
1242 PyObject *dict, **dictptr = _PyObject_GetDictPtr(obj);
1243 if (dictptr == NULL) {
1244 PyErr_SetString(PyExc_AttributeError,
1245 "This object has no __dict__");
1246 return NULL;
1247 }
1248 dict = *dictptr;
1249 if (dict == NULL)
1250 *dictptr = dict = PyDict_New();
1251 Py_XINCREF(dict);
1252 return dict;
1253}
1254
1255int
1256PyObject_GenericSetDict(PyObject *obj, PyObject *value, void *context)
1257{
1258 PyObject *dict, **dictptr = _PyObject_GetDictPtr(obj);
1259 if (dictptr == NULL) {
1260 PyErr_SetString(PyExc_AttributeError,
1261 "This object has no __dict__");
1262 return -1;
1263 }
1264 if (value == NULL) {
1265 PyErr_SetString(PyExc_TypeError, "cannot delete __dict__");
1266 return -1;
1267 }
1268 if (!PyDict_Check(value)) {
1269 PyErr_Format(PyExc_TypeError,
1270 "__dict__ must be set to a dictionary, "
1271 "not a '%.200s'", Py_TYPE(value)->tp_name);
1272 return -1;
1273 }
1274 dict = *dictptr;
1275 Py_XINCREF(value);
1276 *dictptr = value;
1277 Py_XDECREF(dict);
1278 return 0;
1279}
1280
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001281
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001282/* Test a value used as condition, e.g., in a for or if statement.
1283 Return -1 if an error occurred */
1284
1285int
Fred Drake100814d2000-07-09 15:48:49 +00001286PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001287{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001288 Py_ssize_t res;
1289 if (v == Py_True)
1290 return 1;
1291 if (v == Py_False)
1292 return 0;
1293 if (v == Py_None)
1294 return 0;
1295 else if (v->ob_type->tp_as_number != NULL &&
1296 v->ob_type->tp_as_number->nb_bool != NULL)
1297 res = (*v->ob_type->tp_as_number->nb_bool)(v);
1298 else if (v->ob_type->tp_as_mapping != NULL &&
1299 v->ob_type->tp_as_mapping->mp_length != NULL)
1300 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
1301 else if (v->ob_type->tp_as_sequence != NULL &&
1302 v->ob_type->tp_as_sequence->sq_length != NULL)
1303 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1304 else
1305 return 1;
1306 /* if it is negative, it should be either -1 or -2 */
1307 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001308}
1309
Tim Peters803526b2002-07-07 05:13:56 +00001310/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001311 Return -1 if an error occurred */
1312
1313int
Fred Drake100814d2000-07-09 15:48:49 +00001314PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001315{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001316 int res;
1317 res = PyObject_IsTrue(v);
1318 if (res < 0)
1319 return res;
1320 return res == 0;
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001321}
1322
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001323/* Test whether an object can be called */
1324
1325int
Fred Drake100814d2000-07-09 15:48:49 +00001326PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001327{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001328 if (x == NULL)
1329 return 0;
1330 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001331}
1332
Tim Peters7eea37e2001-09-04 22:08:56 +00001333
Georg Brandle32b4222007-03-10 22:13:27 +00001334/* Helper for PyObject_Dir without arguments: returns the local scope. */
1335static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001336_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001337{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001338 PyObject *names;
1339 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001340
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001341 if (locals == NULL) {
1342 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1343 return NULL;
1344 }
Tim Peters305b5852001-09-17 02:38:46 +00001345
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001346 names = PyMapping_Keys(locals);
1347 if (!names)
1348 return NULL;
1349 if (!PyList_Check(names)) {
1350 PyErr_Format(PyExc_TypeError,
1351 "dir(): expected keys() of locals to be a list, "
1352 "not '%.200s'", Py_TYPE(names)->tp_name);
1353 Py_DECREF(names);
1354 return NULL;
1355 }
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001356 if (PyList_Sort(names)) {
1357 Py_DECREF(names);
1358 return NULL;
1359 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001360 /* the locals don't need to be DECREF'd */
1361 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001362}
1363
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001364/* Helper for PyObject_Dir: object introspection. */
Georg Brandle32b4222007-03-10 22:13:27 +00001365static PyObject *
1366_dir_object(PyObject *obj)
1367{
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001368 PyObject *result, *sorted;
Benjamin Petersonce798522012-01-22 11:24:29 -05001369 _Py_IDENTIFIER(__dir__);
1370 PyObject *dirfunc = _PyObject_LookupSpecial(obj, &PyId___dir__);
Georg Brandle32b4222007-03-10 22:13:27 +00001371
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001372 assert(obj);
1373 if (dirfunc == NULL) {
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001374 if (!PyErr_Occurred())
1375 PyErr_SetString(PyExc_TypeError, "object does not provide __dir__");
1376 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001377 }
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001378 /* use __dir__ */
1379 result = PyObject_CallFunctionObjArgs(dirfunc, NULL);
1380 Py_DECREF(dirfunc);
1381 if (result == NULL)
1382 return NULL;
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001383 /* return sorted(result) */
1384 sorted = PySequence_List(result);
1385 Py_DECREF(result);
1386 if (sorted == NULL)
1387 return NULL;
1388 if (PyList_Sort(sorted)) {
1389 Py_DECREF(sorted);
1390 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001391 }
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001392 return sorted;
Georg Brandle32b4222007-03-10 22:13:27 +00001393}
1394
1395/* Implementation of dir() -- if obj is NULL, returns the names in the current
1396 (local) scope. Otherwise, performs introspection of the object: returns a
1397 sorted list of attribute names (supposedly) accessible from the object
1398*/
1399PyObject *
1400PyObject_Dir(PyObject *obj)
1401{
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001402 return (obj == NULL) ? _dir_locals() : _dir_object(obj);
Tim Peters7eea37e2001-09-04 22:08:56 +00001403}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001404
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001405/*
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001406None is a non-NULL undefined value.
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001407There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001408so there is exactly one (which is indestructible, by the way).
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001409*/
1410
Guido van Rossum0c182a11992-03-27 17:26:13 +00001411/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001412static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001413none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001414{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001415 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001416}
1417
Barry Warsaw9bf16442001-01-23 16:24:35 +00001418/* ARGUSED */
1419static void
Tim Peters803526b2002-07-07 05:13:56 +00001420none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001421{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001422 /* This should never get called, but we also don't want to SEGV if
1423 * we accidentally decref None out of existence.
1424 */
1425 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001426}
1427
Benjamin Petersonc4607ae2011-07-29 18:19:43 -05001428static PyObject *
1429none_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1430{
1431 if (PyTuple_GET_SIZE(args) || (kwargs && PyDict_Size(kwargs))) {
1432 PyErr_SetString(PyExc_TypeError, "NoneType takes no arguments");
1433 return NULL;
1434 }
1435 Py_RETURN_NONE;
1436}
1437
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001438static int
1439none_bool(PyObject *v)
1440{
1441 return 0;
1442}
1443
1444static PyNumberMethods none_as_number = {
1445 0, /* nb_add */
1446 0, /* nb_subtract */
1447 0, /* nb_multiply */
1448 0, /* nb_remainder */
1449 0, /* nb_divmod */
1450 0, /* nb_power */
1451 0, /* nb_negative */
1452 0, /* nb_positive */
1453 0, /* nb_absolute */
1454 (inquiry)none_bool, /* nb_bool */
1455 0, /* nb_invert */
1456 0, /* nb_lshift */
1457 0, /* nb_rshift */
1458 0, /* nb_and */
1459 0, /* nb_xor */
1460 0, /* nb_or */
1461 0, /* nb_int */
1462 0, /* nb_reserved */
1463 0, /* nb_float */
1464 0, /* nb_inplace_add */
1465 0, /* nb_inplace_subtract */
1466 0, /* nb_inplace_multiply */
1467 0, /* nb_inplace_remainder */
1468 0, /* nb_inplace_power */
1469 0, /* nb_inplace_lshift */
1470 0, /* nb_inplace_rshift */
1471 0, /* nb_inplace_and */
1472 0, /* nb_inplace_xor */
1473 0, /* nb_inplace_or */
1474 0, /* nb_floor_divide */
1475 0, /* nb_true_divide */
1476 0, /* nb_inplace_floor_divide */
1477 0, /* nb_inplace_true_divide */
1478 0, /* nb_index */
1479};
Barry Warsaw9bf16442001-01-23 16:24:35 +00001480
Guido van Rossumba21a492001-08-16 08:17:26 +00001481static PyTypeObject PyNone_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001482 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1483 "NoneType",
1484 0,
1485 0,
1486 none_dealloc, /*tp_dealloc*/ /*never called*/
1487 0, /*tp_print*/
1488 0, /*tp_getattr*/
1489 0, /*tp_setattr*/
1490 0, /*tp_reserved*/
1491 none_repr, /*tp_repr*/
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001492 &none_as_number, /*tp_as_number*/
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001493 0, /*tp_as_sequence*/
1494 0, /*tp_as_mapping*/
1495 0, /*tp_hash */
Benjamin Petersonc4607ae2011-07-29 18:19:43 -05001496 0, /*tp_call */
1497 0, /*tp_str */
1498 0, /*tp_getattro */
1499 0, /*tp_setattro */
1500 0, /*tp_as_buffer */
1501 Py_TPFLAGS_DEFAULT, /*tp_flags */
1502 0, /*tp_doc */
1503 0, /*tp_traverse */
1504 0, /*tp_clear */
1505 0, /*tp_richcompare */
1506 0, /*tp_weaklistoffset */
1507 0, /*tp_iter */
1508 0, /*tp_iternext */
1509 0, /*tp_methods */
1510 0, /*tp_members */
1511 0, /*tp_getset */
1512 0, /*tp_base */
1513 0, /*tp_dict */
1514 0, /*tp_descr_get */
1515 0, /*tp_descr_set */
1516 0, /*tp_dictoffset */
1517 0, /*tp_init */
1518 0, /*tp_alloc */
1519 none_new, /*tp_new */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001520};
1521
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001522PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001523 _PyObject_EXTRA_INIT
1524 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001525};
1526
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001527/* NotImplemented is an object that can be used to signal that an
1528 operation is not implemented for the given type combination. */
1529
1530static PyObject *
1531NotImplemented_repr(PyObject *op)
1532{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001533 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001534}
1535
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001536static PyObject *
1537notimplemented_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1538{
1539 if (PyTuple_GET_SIZE(args) || (kwargs && PyDict_Size(kwargs))) {
1540 PyErr_SetString(PyExc_TypeError, "NotImplementedType takes no arguments");
1541 return NULL;
1542 }
Brian Curtindfc80e32011-08-10 20:28:54 -05001543 Py_RETURN_NOTIMPLEMENTED;
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001544}
1545
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001546static PyTypeObject PyNotImplemented_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001547 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1548 "NotImplementedType",
1549 0,
1550 0,
1551 none_dealloc, /*tp_dealloc*/ /*never called*/
1552 0, /*tp_print*/
1553 0, /*tp_getattr*/
1554 0, /*tp_setattr*/
1555 0, /*tp_reserved*/
1556 NotImplemented_repr, /*tp_repr*/
1557 0, /*tp_as_number*/
1558 0, /*tp_as_sequence*/
1559 0, /*tp_as_mapping*/
1560 0, /*tp_hash */
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001561 0, /*tp_call */
1562 0, /*tp_str */
1563 0, /*tp_getattro */
1564 0, /*tp_setattro */
1565 0, /*tp_as_buffer */
1566 Py_TPFLAGS_DEFAULT, /*tp_flags */
1567 0, /*tp_doc */
1568 0, /*tp_traverse */
1569 0, /*tp_clear */
1570 0, /*tp_richcompare */
1571 0, /*tp_weaklistoffset */
1572 0, /*tp_iter */
1573 0, /*tp_iternext */
1574 0, /*tp_methods */
1575 0, /*tp_members */
1576 0, /*tp_getset */
1577 0, /*tp_base */
1578 0, /*tp_dict */
1579 0, /*tp_descr_get */
1580 0, /*tp_descr_set */
1581 0, /*tp_dictoffset */
1582 0, /*tp_init */
1583 0, /*tp_alloc */
1584 notimplemented_new, /*tp_new */
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001585};
1586
1587PyObject _Py_NotImplementedStruct = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001588 _PyObject_EXTRA_INIT
1589 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001590};
1591
Guido van Rossumba21a492001-08-16 08:17:26 +00001592void
1593_Py_ReadyTypes(void)
1594{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001595 if (PyType_Ready(&PyType_Type) < 0)
1596 Py_FatalError("Can't initialize type type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001597
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001598 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1599 Py_FatalError("Can't initialize weakref type");
Fred Drake0a4dd392004-07-02 18:57:45 +00001600
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001601 if (PyType_Ready(&_PyWeakref_CallableProxyType) < 0)
1602 Py_FatalError("Can't initialize callable weakref proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001603
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001604 if (PyType_Ready(&_PyWeakref_ProxyType) < 0)
1605 Py_FatalError("Can't initialize weakref proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001606
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001607 if (PyType_Ready(&PyBool_Type) < 0)
1608 Py_FatalError("Can't initialize bool type");
Guido van Rossum77f6a652002-04-03 22:41:51 +00001609
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001610 if (PyType_Ready(&PyByteArray_Type) < 0)
1611 Py_FatalError("Can't initialize bytearray type");
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001612
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001613 if (PyType_Ready(&PyBytes_Type) < 0)
1614 Py_FatalError("Can't initialize 'str'");
Guido van Rossumcacfc072002-05-24 19:01:59 +00001615
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001616 if (PyType_Ready(&PyList_Type) < 0)
1617 Py_FatalError("Can't initialize list type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001618
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001619 if (PyType_Ready(&PyNone_Type) < 0)
1620 Py_FatalError("Can't initialize None type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001621
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001622 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1623 Py_FatalError("Can't initialize NotImplemented type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001624
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001625 if (PyType_Ready(&PyTraceBack_Type) < 0)
1626 Py_FatalError("Can't initialize traceback type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001627
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001628 if (PyType_Ready(&PySuper_Type) < 0)
1629 Py_FatalError("Can't initialize super type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001630
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001631 if (PyType_Ready(&PyBaseObject_Type) < 0)
1632 Py_FatalError("Can't initialize object type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001633
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001634 if (PyType_Ready(&PyRange_Type) < 0)
1635 Py_FatalError("Can't initialize range type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001636
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001637 if (PyType_Ready(&PyDict_Type) < 0)
1638 Py_FatalError("Can't initialize dict type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001639
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001640 if (PyType_Ready(&PySet_Type) < 0)
1641 Py_FatalError("Can't initialize set type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001642
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001643 if (PyType_Ready(&PyUnicode_Type) < 0)
1644 Py_FatalError("Can't initialize str type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001645
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001646 if (PyType_Ready(&PySlice_Type) < 0)
1647 Py_FatalError("Can't initialize slice type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001648
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001649 if (PyType_Ready(&PyStaticMethod_Type) < 0)
1650 Py_FatalError("Can't initialize static method type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001651
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001652 if (PyType_Ready(&PyComplex_Type) < 0)
1653 Py_FatalError("Can't initialize complex type");
Skip Montanaroba1e0f42009-10-18 14:25:35 +00001654
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001655 if (PyType_Ready(&PyFloat_Type) < 0)
1656 Py_FatalError("Can't initialize float type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001657
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001658 if (PyType_Ready(&PyLong_Type) < 0)
1659 Py_FatalError("Can't initialize int type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001660
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001661 if (PyType_Ready(&PyFrozenSet_Type) < 0)
1662 Py_FatalError("Can't initialize frozenset type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001663
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001664 if (PyType_Ready(&PyProperty_Type) < 0)
1665 Py_FatalError("Can't initialize property type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001666
Stefan Krah9a2d99e2012-02-25 12:24:21 +01001667 if (PyType_Ready(&_PyManagedBuffer_Type) < 0)
1668 Py_FatalError("Can't initialize managed buffer type");
1669
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001670 if (PyType_Ready(&PyMemoryView_Type) < 0)
1671 Py_FatalError("Can't initialize memoryview type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001672
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001673 if (PyType_Ready(&PyTuple_Type) < 0)
1674 Py_FatalError("Can't initialize tuple type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001675
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001676 if (PyType_Ready(&PyEnum_Type) < 0)
1677 Py_FatalError("Can't initialize enumerate type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001678
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001679 if (PyType_Ready(&PyReversed_Type) < 0)
1680 Py_FatalError("Can't initialize reversed type");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001681
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001682 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1683 Py_FatalError("Can't initialize StdPrinter");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001684
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001685 if (PyType_Ready(&PyCode_Type) < 0)
1686 Py_FatalError("Can't initialize code type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001687
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001688 if (PyType_Ready(&PyFrame_Type) < 0)
1689 Py_FatalError("Can't initialize frame type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001690
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001691 if (PyType_Ready(&PyCFunction_Type) < 0)
1692 Py_FatalError("Can't initialize builtin function type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001693
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001694 if (PyType_Ready(&PyMethod_Type) < 0)
1695 Py_FatalError("Can't initialize method type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001696
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001697 if (PyType_Ready(&PyFunction_Type) < 0)
1698 Py_FatalError("Can't initialize function type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001699
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001700 if (PyType_Ready(&PyDictProxy_Type) < 0)
1701 Py_FatalError("Can't initialize dict proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001702
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001703 if (PyType_Ready(&PyGen_Type) < 0)
1704 Py_FatalError("Can't initialize generator type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001705
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001706 if (PyType_Ready(&PyGetSetDescr_Type) < 0)
1707 Py_FatalError("Can't initialize get-set descriptor type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001708
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001709 if (PyType_Ready(&PyWrapperDescr_Type) < 0)
1710 Py_FatalError("Can't initialize wrapper type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001711
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001712 if (PyType_Ready(&_PyMethodWrapper_Type) < 0)
1713 Py_FatalError("Can't initialize method wrapper type");
1714
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001715 if (PyType_Ready(&PyEllipsis_Type) < 0)
1716 Py_FatalError("Can't initialize ellipsis type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001717
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001718 if (PyType_Ready(&PyMemberDescr_Type) < 0)
1719 Py_FatalError("Can't initialize member descriptor type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001720
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001721 if (PyType_Ready(&PyFilter_Type) < 0)
1722 Py_FatalError("Can't initialize filter type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001723
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001724 if (PyType_Ready(&PyMap_Type) < 0)
1725 Py_FatalError("Can't initialize map type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001726
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001727 if (PyType_Ready(&PyZip_Type) < 0)
1728 Py_FatalError("Can't initialize zip type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001729}
1730
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001731
Guido van Rossum84a90321996-05-22 16:34:47 +00001732#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001733
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001734void
Fred Drake100814d2000-07-09 15:48:49 +00001735_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001736{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001737 _Py_INC_REFTOTAL;
1738 op->ob_refcnt = 1;
1739 _Py_AddToAllObjects(op, 1);
1740 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001741}
1742
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001743void
Fred Drake100814d2000-07-09 15:48:49 +00001744_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001745{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001746#ifdef SLOW_UNREF_CHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001747 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001748#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001749 if (op->ob_refcnt < 0)
1750 Py_FatalError("UNREF negative refcnt");
1751 if (op == &refchain ||
1752 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1753 fprintf(stderr, "* ob\n");
1754 _PyObject_Dump(op);
1755 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1756 _PyObject_Dump(op->_ob_prev->_ob_next);
1757 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1758 _PyObject_Dump(op->_ob_next->_ob_prev);
1759 Py_FatalError("UNREF invalid object");
1760 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001761#ifdef SLOW_UNREF_CHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001762 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1763 if (p == op)
1764 break;
1765 }
1766 if (p == &refchain) /* Not found */
1767 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001768#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001769 op->_ob_next->_ob_prev = op->_ob_prev;
1770 op->_ob_prev->_ob_next = op->_ob_next;
1771 op->_ob_next = op->_ob_prev = NULL;
1772 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001773}
1774
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001775void
Fred Drake100814d2000-07-09 15:48:49 +00001776_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001777{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001778 destructor dealloc = Py_TYPE(op)->tp_dealloc;
1779 _Py_ForgetReference(op);
1780 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001781}
1782
Tim Peters269b2a62003-04-17 19:52:29 +00001783/* Print all live objects. Because PyObject_Print is called, the
1784 * interpreter must be in a healthy state.
1785 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001786void
Fred Drake100814d2000-07-09 15:48:49 +00001787_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001788{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001789 PyObject *op;
1790 fprintf(fp, "Remaining objects:\n");
1791 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
1792 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
1793 if (PyObject_Print(op, fp, 0) != 0)
1794 PyErr_Clear();
1795 putc('\n', fp);
1796 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001797}
1798
Tim Peters269b2a62003-04-17 19:52:29 +00001799/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1800 * doesn't make any calls to the Python C API, so is always safe to call.
1801 */
1802void
1803_Py_PrintReferenceAddresses(FILE *fp)
1804{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001805 PyObject *op;
1806 fprintf(fp, "Remaining object addresses:\n");
1807 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
1808 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
1809 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001810}
1811
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001812PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001813_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001814{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001815 int i, n;
1816 PyObject *t = NULL;
1817 PyObject *res, *op;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001818
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001819 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1820 return NULL;
1821 op = refchain._ob_next;
1822 res = PyList_New(0);
1823 if (res == NULL)
1824 return NULL;
1825 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1826 while (op == self || op == args || op == res || op == t ||
1827 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
1828 op = op->_ob_next;
1829 if (op == &refchain)
1830 return res;
1831 }
1832 if (PyList_Append(res, op) < 0) {
1833 Py_DECREF(res);
1834 return NULL;
1835 }
1836 op = op->_ob_next;
1837 }
1838 return res;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001839}
1840
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001841#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001842
Benjamin Petersonb173f782009-05-05 22:31:58 +00001843/* Hack to force loading of pycapsule.o */
1844PyTypeObject *_PyCapsule_hack = &PyCapsule_Type;
1845
1846
Guido van Rossum84a90321996-05-22 16:34:47 +00001847/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001848Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001849
1850
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001851/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001852
Thomas Wouters334fb892000-07-25 12:56:38 +00001853void *
Fred Drake100814d2000-07-09 15:48:49 +00001854PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001855{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001856 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001857}
1858
Thomas Wouters334fb892000-07-25 12:56:38 +00001859void *
1860PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001861{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001862 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001863}
1864
1865void
Thomas Wouters334fb892000-07-25 12:56:38 +00001866PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001867{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001868 PyMem_FREE(p);
Guido van Rossumb18618d2000-05-03 23:44:39 +00001869}
1870
1871
Guido van Rossum86610361998-04-10 22:32:46 +00001872/* These methods are used to control infinite recursion in repr, str, print,
1873 etc. Container objects that may recursively contain themselves,
1874 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1875 Py_ReprLeave() to avoid infinite recursion.
1876
1877 Py_ReprEnter() returns 0 the first time it is called for a particular
1878 object and 1 every time thereafter. It returns -1 if an exception
1879 occurred. Py_ReprLeave() has no return value.
1880
1881 See dictobject.c and listobject.c for examples of use.
1882*/
1883
1884#define KEY "Py_Repr"
1885
1886int
Fred Drake100814d2000-07-09 15:48:49 +00001887Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001888{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001889 PyObject *dict;
1890 PyObject *list;
1891 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001892
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001893 dict = PyThreadState_GetDict();
1894 if (dict == NULL)
1895 return 0;
1896 list = PyDict_GetItemString(dict, KEY);
1897 if (list == NULL) {
1898 list = PyList_New(0);
1899 if (list == NULL)
1900 return -1;
1901 if (PyDict_SetItemString(dict, KEY, list) < 0)
1902 return -1;
1903 Py_DECREF(list);
1904 }
1905 i = PyList_GET_SIZE(list);
1906 while (--i >= 0) {
1907 if (PyList_GET_ITEM(list, i) == obj)
1908 return 1;
1909 }
1910 PyList_Append(list, obj);
1911 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001912}
1913
1914void
Fred Drake100814d2000-07-09 15:48:49 +00001915Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001916{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001917 PyObject *dict;
1918 PyObject *list;
1919 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001920
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001921 dict = PyThreadState_GetDict();
1922 if (dict == NULL)
1923 return;
1924 list = PyDict_GetItemString(dict, KEY);
1925 if (list == NULL || !PyList_Check(list))
1926 return;
1927 i = PyList_GET_SIZE(list);
1928 /* Count backwards because we always expect obj to be list[-1] */
1929 while (--i >= 0) {
1930 if (PyList_GET_ITEM(list, i) == obj) {
1931 PyList_SetSlice(list, i, i + 1, NULL);
1932 break;
1933 }
1934 }
Guido van Rossum86610361998-04-10 22:32:46 +00001935}
Guido van Rossumd724b232000-03-13 16:01:29 +00001936
Tim Peters803526b2002-07-07 05:13:56 +00001937/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001938
Tim Peters803526b2002-07-07 05:13:56 +00001939/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001940int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001941
Tim Peters803526b2002-07-07 05:13:56 +00001942/* List of objects that still need to be cleaned up, singly linked via their
1943 * gc headers' gc_prev pointers.
1944 */
1945PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001946
Tim Peters803526b2002-07-07 05:13:56 +00001947/* Add op to the _PyTrash_delete_later list. Called when the current
1948 * call-stack depth gets large. op must be a currently untracked gc'ed
1949 * object, with refcount 0. Py_DECREF must already have been called on it.
1950 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001951void
Fred Drake100814d2000-07-09 15:48:49 +00001952_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001953{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001954 assert(PyObject_IS_GC(op));
1955 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1956 assert(op->ob_refcnt == 0);
1957 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
1958 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001959}
1960
Tim Peters803526b2002-07-07 05:13:56 +00001961/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1962 * the call-stack unwinds again.
1963 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001964void
Fred Drake100814d2000-07-09 15:48:49 +00001965_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001966{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001967 while (_PyTrash_delete_later) {
1968 PyObject *op = _PyTrash_delete_later;
1969 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001970
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001971 _PyTrash_delete_later =
1972 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001973
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001974 /* Call the deallocator directly. This used to try to
1975 * fool Py_DECREF into calling it indirectly, but
1976 * Py_DECREF was already called on this object, and in
1977 * assorted non-release builds calling Py_DECREF again ends
1978 * up distorting allocation statistics.
1979 */
1980 assert(op->ob_refcnt == 0);
1981 ++_PyTrash_delete_nesting;
1982 (*dealloc)(op);
1983 --_PyTrash_delete_nesting;
1984 }
Guido van Rossumd724b232000-03-13 16:01:29 +00001985}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001986
Martin v. Löwis4d0d4712010-12-03 20:14:31 +00001987#ifndef Py_TRACE_REFS
1988/* For Py_LIMITED_API, we need an out-of-line version of _Py_Dealloc.
1989 Define this here, so we can undefine the macro. */
1990#undef _Py_Dealloc
1991PyAPI_FUNC(void) _Py_Dealloc(PyObject *);
1992void
1993_Py_Dealloc(PyObject *op)
1994{
1995 _Py_INC_TPFREES(op) _Py_COUNT_ALLOCS_COMMA
1996 (*Py_TYPE(op)->tp_dealloc)(op);
1997}
1998#endif
1999
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002000#ifdef __cplusplus
2001}
2002#endif