remove old metaclass demos
[python/dscho.git] / Objects / object.c
blob57b4906089c81315e6c393f7520b91f5c683ec50
2 /* Generic object operations; and implementation of None (NoObject) */
4 #include "Python.h"
5 #include "sliceobject.h" /* For PyEllipsis_Type */
6 #include "frameobject.h"
8 #ifdef __cplusplus
9 extern "C" {
10 #endif
12 #ifdef Py_REF_DEBUG
13 Py_ssize_t _Py_RefTotal;
15 Py_ssize_t
16 _Py_GetRefTotal(void)
18 PyObject *o;
19 Py_ssize_t total = _Py_RefTotal;
20 /* ignore the references to the dummy object of the dicts and sets
21 because they are not reliable and not useful (now that the
22 hash table code is well-tested) */
23 o = _PyDict_Dummy();
24 if (o != NULL)
25 total -= o->ob_refcnt;
26 o = _PySet_Dummy();
27 if (o != NULL)
28 total -= o->ob_refcnt;
29 return total;
31 #endif /* Py_REF_DEBUG */
33 int Py_DivisionWarningFlag;
35 /* Object allocation routines used by NEWOBJ and NEWVAROBJ macros.
36 These are used by the individual routines for object creation.
37 Do not call them otherwise, they do not initialize the object! */
39 #ifdef Py_TRACE_REFS
40 /* Head of circular doubly-linked list of all objects. These are linked
41 * together via the _ob_prev and _ob_next members of a PyObject, which
42 * exist only in a Py_TRACE_REFS build.
44 static PyObject refchain = {&refchain, &refchain};
46 /* Insert op at the front of the list of all objects. If force is true,
47 * op is added even if _ob_prev and _ob_next are non-NULL already. If
48 * force is false amd _ob_prev or _ob_next are non-NULL, do nothing.
49 * force should be true if and only if op points to freshly allocated,
50 * uninitialized memory, or you've unlinked op from the list and are
51 * relinking it into the front.
52 * Note that objects are normally added to the list via _Py_NewReference,
53 * which is called by PyObject_Init. Not all objects are initialized that
54 * way, though; exceptions include statically allocated type objects, and
55 * statically allocated singletons (like Py_True and Py_None).
57 void
58 _Py_AddToAllObjects(PyObject *op, int force)
60 #ifdef Py_DEBUG
61 if (!force) {
62 /* If it's initialized memory, op must be in or out of
63 * the list unambiguously.
65 assert((op->_ob_prev == NULL) == (op->_ob_next == NULL));
67 #endif
68 if (force || op->_ob_prev == NULL) {
69 op->_ob_next = refchain._ob_next;
70 op->_ob_prev = &refchain;
71 refchain._ob_next->_ob_prev = op;
72 refchain._ob_next = op;
75 #endif /* Py_TRACE_REFS */
77 #ifdef COUNT_ALLOCS
78 static PyTypeObject *type_list;
79 /* All types are added to type_list, at least when
80 they get one object created. That makes them
81 immortal, which unfortunately contributes to
82 garbage itself. If unlist_types_without_objects
83 is set, they will be removed from the type_list
84 once the last object is deallocated. */
85 static int unlist_types_without_objects;
86 extern Py_ssize_t tuple_zero_allocs, fast_tuple_allocs;
87 extern Py_ssize_t quick_int_allocs, quick_neg_int_allocs;
88 extern Py_ssize_t null_strings, one_strings;
89 void
90 dump_counts(FILE* f)
92 PyTypeObject *tp;
94 for (tp = type_list; tp; tp = tp->tp_next)
95 fprintf(f, "%s alloc'd: %" PY_FORMAT_SIZE_T "d, "
96 "freed: %" PY_FORMAT_SIZE_T "d, "
97 "max in use: %" PY_FORMAT_SIZE_T "d\n",
98 tp->tp_name, tp->tp_allocs, tp->tp_frees,
99 tp->tp_maxalloc);
100 fprintf(f, "fast tuple allocs: %" PY_FORMAT_SIZE_T "d, "
101 "empty: %" PY_FORMAT_SIZE_T "d\n",
102 fast_tuple_allocs, tuple_zero_allocs);
103 fprintf(f, "fast int allocs: pos: %" PY_FORMAT_SIZE_T "d, "
104 "neg: %" PY_FORMAT_SIZE_T "d\n",
105 quick_int_allocs, quick_neg_int_allocs);
106 fprintf(f, "null strings: %" PY_FORMAT_SIZE_T "d, "
107 "1-strings: %" PY_FORMAT_SIZE_T "d\n",
108 null_strings, one_strings);
111 PyObject *
112 get_counts(void)
114 PyTypeObject *tp;
115 PyObject *result;
116 PyObject *v;
118 result = PyList_New(0);
119 if (result == NULL)
120 return NULL;
121 for (tp = type_list; tp; tp = tp->tp_next) {
122 v = Py_BuildValue("(snnn)", tp->tp_name, tp->tp_allocs,
123 tp->tp_frees, tp->tp_maxalloc);
124 if (v == NULL) {
125 Py_DECREF(result);
126 return NULL;
128 if (PyList_Append(result, v) < 0) {
129 Py_DECREF(v);
130 Py_DECREF(result);
131 return NULL;
133 Py_DECREF(v);
135 return result;
138 void
139 inc_count(PyTypeObject *tp)
141 if (tp->tp_next == NULL && tp->tp_prev == NULL) {
142 /* first time; insert in linked list */
143 if (tp->tp_next != NULL) /* sanity check */
144 Py_FatalError("XXX inc_count sanity check");
145 if (type_list)
146 type_list->tp_prev = tp;
147 tp->tp_next = type_list;
148 /* Note that as of Python 2.2, heap-allocated type objects
149 * can go away, but this code requires that they stay alive
150 * until program exit. That's why we're careful with
151 * refcounts here. type_list gets a new reference to tp,
152 * while ownership of the reference type_list used to hold
153 * (if any) was transferred to tp->tp_next in the line above.
154 * tp is thus effectively immortal after this.
156 Py_INCREF(tp);
157 type_list = tp;
158 #ifdef Py_TRACE_REFS
159 /* Also insert in the doubly-linked list of all objects,
160 * if not already there.
162 _Py_AddToAllObjects((PyObject *)tp, 0);
163 #endif
165 tp->tp_allocs++;
166 if (tp->tp_allocs - tp->tp_frees > tp->tp_maxalloc)
167 tp->tp_maxalloc = tp->tp_allocs - tp->tp_frees;
170 void dec_count(PyTypeObject *tp)
172 tp->tp_frees++;
173 if (unlist_types_without_objects &&
174 tp->tp_allocs == tp->tp_frees) {
175 /* unlink the type from type_list */
176 if (tp->tp_prev)
177 tp->tp_prev->tp_next = tp->tp_next;
178 else
179 type_list = tp->tp_next;
180 if (tp->tp_next)
181 tp->tp_next->tp_prev = tp->tp_prev;
182 tp->tp_next = tp->tp_prev = NULL;
183 Py_DECREF(tp);
187 #endif
189 #ifdef Py_REF_DEBUG
190 /* Log a fatal error; doesn't return. */
191 void
192 _Py_NegativeRefcount(const char *fname, int lineno, PyObject *op)
194 char buf[300];
196 PyOS_snprintf(buf, sizeof(buf),
197 "%s:%i object at %p has negative ref count "
198 "%" PY_FORMAT_SIZE_T "d",
199 fname, lineno, op, op->ob_refcnt);
200 Py_FatalError(buf);
203 #endif /* Py_REF_DEBUG */
205 void
206 Py_IncRef(PyObject *o)
208 Py_XINCREF(o);
211 void
212 Py_DecRef(PyObject *o)
214 Py_XDECREF(o);
217 PyObject *
218 PyObject_Init(PyObject *op, PyTypeObject *tp)
220 if (op == NULL)
221 return PyErr_NoMemory();
222 /* Any changes should be reflected in PyObject_INIT (objimpl.h) */
223 Py_TYPE(op) = tp;
224 _Py_NewReference(op);
225 return op;
228 PyVarObject *
229 PyObject_InitVar(PyVarObject *op, PyTypeObject *tp, Py_ssize_t size)
231 if (op == NULL)
232 return (PyVarObject *) PyErr_NoMemory();
233 /* Any changes should be reflected in PyObject_INIT_VAR */
234 op->ob_size = size;
235 Py_TYPE(op) = tp;
236 _Py_NewReference((PyObject *)op);
237 return op;
240 PyObject *
241 _PyObject_New(PyTypeObject *tp)
243 PyObject *op;
244 op = (PyObject *) PyObject_MALLOC(_PyObject_SIZE(tp));
245 if (op == NULL)
246 return PyErr_NoMemory();
247 return PyObject_INIT(op, tp);
250 PyVarObject *
251 _PyObject_NewVar(PyTypeObject *tp, Py_ssize_t nitems)
253 PyVarObject *op;
254 const size_t size = _PyObject_VAR_SIZE(tp, nitems);
255 op = (PyVarObject *) PyObject_MALLOC(size);
256 if (op == NULL)
257 return (PyVarObject *)PyErr_NoMemory();
258 return PyObject_INIT_VAR(op, tp, nitems);
261 /* Implementation of PyObject_Print with recursion checking */
262 static int
263 internal_print(PyObject *op, FILE *fp, int flags, int nesting)
265 int ret = 0;
266 if (nesting > 10) {
267 PyErr_SetString(PyExc_RuntimeError, "print recursion");
268 return -1;
270 if (PyErr_CheckSignals())
271 return -1;
272 #ifdef USE_STACKCHECK
273 if (PyOS_CheckStack()) {
274 PyErr_SetString(PyExc_MemoryError, "stack overflow");
275 return -1;
277 #endif
278 clearerr(fp); /* Clear any previous error condition */
279 if (op == NULL) {
280 Py_BEGIN_ALLOW_THREADS
281 fprintf(fp, "<nil>");
282 Py_END_ALLOW_THREADS
284 else {
285 if (op->ob_refcnt <= 0)
286 /* XXX(twouters) cast refcount to long until %zd is
287 universally available */
288 Py_BEGIN_ALLOW_THREADS
289 fprintf(fp, "<refcnt %ld at %p>",
290 (long)op->ob_refcnt, op);
291 Py_END_ALLOW_THREADS
292 else {
293 PyObject *s;
294 if (flags & Py_PRINT_RAW)
295 s = PyObject_Str(op);
296 else
297 s = PyObject_Repr(op);
298 if (s == NULL)
299 ret = -1;
300 else if (PyBytes_Check(s)) {
301 fwrite(PyBytes_AS_STRING(s), 1,
302 PyBytes_GET_SIZE(s), fp);
304 else if (PyUnicode_Check(s)) {
305 PyObject *t;
306 t = _PyUnicode_AsDefaultEncodedString(s, NULL);
307 if (t == NULL)
308 ret = 0;
309 else {
310 fwrite(PyBytes_AS_STRING(t), 1,
311 PyBytes_GET_SIZE(t), fp);
314 else {
315 PyErr_Format(PyExc_TypeError,
316 "str() or repr() returned '%.100s'",
317 s->ob_type->tp_name);
318 ret = -1;
320 Py_XDECREF(s);
323 if (ret == 0) {
324 if (ferror(fp)) {
325 PyErr_SetFromErrno(PyExc_IOError);
326 clearerr(fp);
327 ret = -1;
330 return ret;
334 PyObject_Print(PyObject *op, FILE *fp, int flags)
336 return internal_print(op, fp, flags, 0);
339 /* For debugging convenience. Set a breakpoint here and call it from your DLL */
340 void
341 _Py_BreakPoint(void)
346 /* For debugging convenience. See Misc/gdbinit for some useful gdb hooks */
347 void
348 _PyObject_Dump(PyObject* op)
350 if (op == NULL)
351 fprintf(stderr, "NULL\n");
352 else {
353 #ifdef WITH_THREAD
354 PyGILState_STATE gil;
355 #endif
356 fprintf(stderr, "object : ");
357 #ifdef WITH_THREAD
358 gil = PyGILState_Ensure();
359 #endif
360 (void)PyObject_Print(op, stderr, 0);
361 #ifdef WITH_THREAD
362 PyGILState_Release(gil);
363 #endif
364 /* XXX(twouters) cast refcount to long until %zd is
365 universally available */
366 fprintf(stderr, "\n"
367 "type : %s\n"
368 "refcount: %ld\n"
369 "address : %p\n",
370 Py_TYPE(op)==NULL ? "NULL" : Py_TYPE(op)->tp_name,
371 (long)op->ob_refcnt,
372 op);
376 PyObject *
377 PyObject_Repr(PyObject *v)
379 PyObject *res;
380 if (PyErr_CheckSignals())
381 return NULL;
382 #ifdef USE_STACKCHECK
383 if (PyOS_CheckStack()) {
384 PyErr_SetString(PyExc_MemoryError, "stack overflow");
385 return NULL;
387 #endif
388 if (v == NULL)
389 return PyUnicode_FromString("<NULL>");
390 if (Py_TYPE(v)->tp_repr == NULL)
391 return PyUnicode_FromFormat("<%s object at %p>",
392 v->ob_type->tp_name, v);
393 res = (*v->ob_type->tp_repr)(v);
394 if (res != NULL && !PyUnicode_Check(res)) {
395 PyErr_Format(PyExc_TypeError,
396 "__repr__ returned non-string (type %.200s)",
397 res->ob_type->tp_name);
398 Py_DECREF(res);
399 return NULL;
401 return res;
404 PyObject *
405 PyObject_Str(PyObject *v)
407 PyObject *res;
408 if (PyErr_CheckSignals())
409 return NULL;
410 #ifdef USE_STACKCHECK
411 if (PyOS_CheckStack()) {
412 PyErr_SetString(PyExc_MemoryError, "stack overflow");
413 return NULL;
415 #endif
416 if (v == NULL)
417 return PyUnicode_FromString("<NULL>");
418 if (PyUnicode_CheckExact(v)) {
419 Py_INCREF(v);
420 return v;
422 if (Py_TYPE(v)->tp_str == NULL)
423 return PyObject_Repr(v);
425 /* It is possible for a type to have a tp_str representation that loops
426 infinitely. */
427 if (Py_EnterRecursiveCall(" while getting the str of an object"))
428 return NULL;
429 res = (*Py_TYPE(v)->tp_str)(v);
430 Py_LeaveRecursiveCall();
431 if (res == NULL)
432 return NULL;
433 if (!PyUnicode_Check(res)) {
434 PyErr_Format(PyExc_TypeError,
435 "__str__ returned non-string (type %.200s)",
436 Py_TYPE(res)->tp_name);
437 Py_DECREF(res);
438 return NULL;
440 return res;
443 PyObject *
444 PyObject_ASCII(PyObject *v)
446 PyObject *repr, *ascii, *res;
448 repr = PyObject_Repr(v);
449 if (repr == NULL)
450 return NULL;
452 /* repr is guaranteed to be a PyUnicode object by PyObject_Repr */
453 ascii = PyUnicode_EncodeASCII(
454 PyUnicode_AS_UNICODE(repr),
455 PyUnicode_GET_SIZE(repr),
456 "backslashreplace");
458 Py_DECREF(repr);
459 if (ascii == NULL)
460 return NULL;
462 res = PyUnicode_DecodeASCII(
463 PyBytes_AS_STRING(ascii),
464 PyBytes_GET_SIZE(ascii),
465 NULL);
467 Py_DECREF(ascii);
468 return res;
471 PyObject *
472 PyObject_Bytes(PyObject *v)
474 PyObject *result, *func;
475 static PyObject *bytesstring = NULL;
477 if (bytesstring == NULL) {
478 bytesstring = PyUnicode_InternFromString("__bytes__");
479 if (bytesstring == NULL)
480 return NULL;
483 if (v == NULL)
484 return PyBytes_FromString("<NULL>");
486 if (PyBytes_CheckExact(v)) {
487 Py_INCREF(v);
488 return v;
491 /* Doesn't create a reference */
492 func = _PyType_Lookup(Py_TYPE(v), bytesstring);
493 if (func != NULL) {
494 result = PyObject_CallFunctionObjArgs(func, v, NULL);
495 if (result == NULL)
496 return NULL;
497 if (!PyBytes_Check(result)) {
498 PyErr_Format(PyExc_TypeError,
499 "__bytes__ returned non-bytes (type %.200s)",
500 Py_TYPE(result)->tp_name);
501 Py_DECREF(result);
502 return NULL;
504 return result;
506 PyErr_Clear();
507 return PyBytes_FromObject(v);
510 /* For Python 3.0.1 and later, the old three-way comparison has been
511 completely removed in favour of rich comparisons. PyObject_Compare() and
512 PyObject_Cmp() are gone, and the builtin cmp function no longer exists.
513 The old tp_compare slot has been renamed to tp_reserved, and should no
514 longer be used. Use tp_richcompare instead.
516 See (*) below for practical amendments.
518 tp_richcompare gets called with a first argument of the appropriate type
519 and a second object of an arbitrary type. We never do any kind of
520 coercion.
522 The tp_richcompare slot should return an object, as follows:
524 NULL if an exception occurred
525 NotImplemented if the requested comparison is not implemented
526 any other false value if the requested comparison is false
527 any other true value if the requested comparison is true
529 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
530 NotImplemented.
532 (*) Practical amendments:
534 - If rich comparison returns NotImplemented, == and != are decided by
535 comparing the object pointer (i.e. falling back to the base object
536 implementation).
540 /* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
541 int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
543 static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
545 /* Perform a rich comparison, raising TypeError when the requested comparison
546 operator is not supported. */
547 static PyObject *
548 do_richcompare(PyObject *v, PyObject *w, int op)
550 richcmpfunc f;
551 PyObject *res;
553 if (v->ob_type != w->ob_type &&
554 PyType_IsSubtype(w->ob_type, v->ob_type) &&
555 (f = w->ob_type->tp_richcompare) != NULL) {
556 res = (*f)(w, v, _Py_SwappedOp[op]);
557 if (res != Py_NotImplemented)
558 return res;
559 Py_DECREF(res);
561 if ((f = v->ob_type->tp_richcompare) != NULL) {
562 res = (*f)(v, w, op);
563 if (res != Py_NotImplemented)
564 return res;
565 Py_DECREF(res);
567 if ((f = w->ob_type->tp_richcompare) != NULL) {
568 res = (*f)(w, v, _Py_SwappedOp[op]);
569 if (res != Py_NotImplemented)
570 return res;
571 Py_DECREF(res);
573 /* If neither object implements it, provide a sensible default
574 for == and !=, but raise an exception for ordering. */
575 switch (op) {
576 case Py_EQ:
577 res = (v == w) ? Py_True : Py_False;
578 break;
579 case Py_NE:
580 res = (v != w) ? Py_True : Py_False;
581 break;
582 default:
583 /* XXX Special-case None so it doesn't show as NoneType() */
584 PyErr_Format(PyExc_TypeError,
585 "unorderable types: %.100s() %s %.100s()",
586 v->ob_type->tp_name,
587 opstrings[op],
588 w->ob_type->tp_name);
589 return NULL;
591 Py_INCREF(res);
592 return res;
595 /* Perform a rich comparison with object result. This wraps do_richcompare()
596 with a check for NULL arguments and a recursion check. */
598 PyObject *
599 PyObject_RichCompare(PyObject *v, PyObject *w, int op)
601 PyObject *res;
603 assert(Py_LT <= op && op <= Py_GE);
604 if (v == NULL || w == NULL) {
605 if (!PyErr_Occurred())
606 PyErr_BadInternalCall();
607 return NULL;
609 if (Py_EnterRecursiveCall(" in cmp"))
610 return NULL;
611 res = do_richcompare(v, w, op);
612 Py_LeaveRecursiveCall();
613 return res;
616 /* Perform a rich comparison with integer result. This wraps
617 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
619 PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
621 PyObject *res;
622 int ok;
624 /* Quick result when objects are the same.
625 Guarantees that identity implies equality. */
626 if (v == w) {
627 if (op == Py_EQ)
628 return 1;
629 else if (op == Py_NE)
630 return 0;
633 res = PyObject_RichCompare(v, w, op);
634 if (res == NULL)
635 return -1;
636 if (PyBool_Check(res))
637 ok = (res == Py_True);
638 else
639 ok = PyObject_IsTrue(res);
640 Py_DECREF(res);
641 return ok;
644 /* Set of hash utility functions to help maintaining the invariant that
645 if a==b then hash(a)==hash(b)
647 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
650 long
651 _Py_HashDouble(double v)
653 double intpart, fractpart;
654 int expo;
655 long hipart;
656 long x; /* the final hash value */
657 /* This is designed so that Python numbers of different types
658 * that compare equal hash to the same value; otherwise comparisons
659 * of mapping keys will turn out weird.
662 fractpart = modf(v, &intpart);
663 if (fractpart == 0.0) {
664 /* This must return the same hash as an equal int or long. */
665 if (intpart > LONG_MAX/2 || -intpart > LONG_MAX/2) {
666 /* Convert to long and use its hash. */
667 PyObject *plong; /* converted to Python long */
668 if (Py_IS_INFINITY(intpart))
669 /* can't convert to long int -- arbitrary */
670 v = v < 0 ? -271828.0 : 314159.0;
671 plong = PyLong_FromDouble(v);
672 if (plong == NULL)
673 return -1;
674 x = PyObject_Hash(plong);
675 Py_DECREF(plong);
676 return x;
678 /* Fits in a C long == a Python int, so is its own hash. */
679 x = (long)intpart;
680 if (x == -1)
681 x = -2;
682 return x;
684 /* The fractional part is non-zero, so we don't have to worry about
685 * making this match the hash of some other type.
686 * Use frexp to get at the bits in the double.
687 * Since the VAX D double format has 56 mantissa bits, which is the
688 * most of any double format in use, each of these parts may have as
689 * many as (but no more than) 56 significant bits.
690 * So, assuming sizeof(long) >= 4, each part can be broken into two
691 * longs; frexp and multiplication are used to do that.
692 * Also, since the Cray double format has 15 exponent bits, which is
693 * the most of any double format in use, shifting the exponent field
694 * left by 15 won't overflow a long (again assuming sizeof(long) >= 4).
696 v = frexp(v, &expo);
697 v *= 2147483648.0; /* 2**31 */
698 hipart = (long)v; /* take the top 32 bits */
699 v = (v - (double)hipart) * 2147483648.0; /* get the next 32 bits */
700 x = hipart + (long)v + (expo << 15);
701 if (x == -1)
702 x = -2;
703 return x;
706 long
707 _Py_HashPointer(void *p)
709 long x;
710 size_t y = (size_t)p;
711 /* bottom 3 or 4 bits are likely to be 0; rotate y by 4 to avoid
712 excessive hash collisions for dicts and sets */
713 y = (y >> 4) | (y << (8 * SIZEOF_VOID_P - 4));
714 x = (long)y;
715 if (x == -1)
716 x = -2;
717 return x;
720 long
721 PyObject_HashNotImplemented(PyObject *v)
723 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
724 Py_TYPE(v)->tp_name);
725 return -1;
728 long
729 PyObject_Hash(PyObject *v)
731 PyTypeObject *tp = Py_TYPE(v);
732 if (tp->tp_hash != NULL)
733 return (*tp->tp_hash)(v);
734 /* To keep to the general practice that inheriting
735 * solely from object in C code should work without
736 * an explicit call to PyType_Ready, we implicitly call
737 * PyType_Ready here and then check the tp_hash slot again
739 if (tp->tp_dict == NULL) {
740 if (PyType_Ready(tp) < 0)
741 return -1;
742 if (tp->tp_hash != NULL)
743 return (*tp->tp_hash)(v);
745 /* Otherwise, the object can't be hashed */
746 return PyObject_HashNotImplemented(v);
749 PyObject *
750 PyObject_GetAttrString(PyObject *v, const char *name)
752 PyObject *w, *res;
754 if (Py_TYPE(v)->tp_getattr != NULL)
755 return (*Py_TYPE(v)->tp_getattr)(v, (char*)name);
756 w = PyUnicode_InternFromString(name);
757 if (w == NULL)
758 return NULL;
759 res = PyObject_GetAttr(v, w);
760 Py_XDECREF(w);
761 return res;
765 PyObject_HasAttrString(PyObject *v, const char *name)
767 PyObject *res = PyObject_GetAttrString(v, name);
768 if (res != NULL) {
769 Py_DECREF(res);
770 return 1;
772 PyErr_Clear();
773 return 0;
777 PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
779 PyObject *s;
780 int res;
782 if (Py_TYPE(v)->tp_setattr != NULL)
783 return (*Py_TYPE(v)->tp_setattr)(v, (char*)name, w);
784 s = PyUnicode_InternFromString(name);
785 if (s == NULL)
786 return -1;
787 res = PyObject_SetAttr(v, s, w);
788 Py_XDECREF(s);
789 return res;
792 PyObject *
793 PyObject_GetAttr(PyObject *v, PyObject *name)
795 PyTypeObject *tp = Py_TYPE(v);
797 if (!PyUnicode_Check(name)) {
798 PyErr_Format(PyExc_TypeError,
799 "attribute name must be string, not '%.200s'",
800 name->ob_type->tp_name);
801 return NULL;
803 if (tp->tp_getattro != NULL)
804 return (*tp->tp_getattro)(v, name);
805 if (tp->tp_getattr != NULL)
806 return (*tp->tp_getattr)(v, _PyUnicode_AsString(name));
807 PyErr_Format(PyExc_AttributeError,
808 "'%.50s' object has no attribute '%U'",
809 tp->tp_name, name);
810 return NULL;
814 PyObject_HasAttr(PyObject *v, PyObject *name)
816 PyObject *res = PyObject_GetAttr(v, name);
817 if (res != NULL) {
818 Py_DECREF(res);
819 return 1;
821 PyErr_Clear();
822 return 0;
826 PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
828 PyTypeObject *tp = Py_TYPE(v);
829 int err;
831 if (!PyUnicode_Check(name)) {
832 PyErr_Format(PyExc_TypeError,
833 "attribute name must be string, not '%.200s'",
834 name->ob_type->tp_name);
835 return -1;
837 Py_INCREF(name);
839 PyUnicode_InternInPlace(&name);
840 if (tp->tp_setattro != NULL) {
841 err = (*tp->tp_setattro)(v, name, value);
842 Py_DECREF(name);
843 return err;
845 if (tp->tp_setattr != NULL) {
846 err = (*tp->tp_setattr)(v, _PyUnicode_AsString(name), value);
847 Py_DECREF(name);
848 return err;
850 Py_DECREF(name);
851 assert(name->ob_refcnt >= 1);
852 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
853 PyErr_Format(PyExc_TypeError,
854 "'%.100s' object has no attributes "
855 "(%s .%U)",
856 tp->tp_name,
857 value==NULL ? "del" : "assign to",
858 name);
859 else
860 PyErr_Format(PyExc_TypeError,
861 "'%.100s' object has only read-only attributes "
862 "(%s .%U)",
863 tp->tp_name,
864 value==NULL ? "del" : "assign to",
865 name);
866 return -1;
869 /* Helper to get a pointer to an object's __dict__ slot, if any */
871 PyObject **
872 _PyObject_GetDictPtr(PyObject *obj)
874 Py_ssize_t dictoffset;
875 PyTypeObject *tp = Py_TYPE(obj);
877 dictoffset = tp->tp_dictoffset;
878 if (dictoffset == 0)
879 return NULL;
880 if (dictoffset < 0) {
881 Py_ssize_t tsize;
882 size_t size;
884 tsize = ((PyVarObject *)obj)->ob_size;
885 if (tsize < 0)
886 tsize = -tsize;
887 size = _PyObject_VAR_SIZE(tp, tsize);
889 dictoffset += (long)size;
890 assert(dictoffset > 0);
891 assert(dictoffset % SIZEOF_VOID_P == 0);
893 return (PyObject **) ((char *)obj + dictoffset);
896 PyObject *
897 PyObject_SelfIter(PyObject *obj)
899 Py_INCREF(obj);
900 return obj;
903 /* Helper used when the __next__ method is removed from a type:
904 tp_iternext is never NULL and can be safely called without checking
905 on every iteration.
908 PyObject *
909 _PyObject_NextNotImplemented(PyObject *self)
911 PyErr_Format(PyExc_TypeError,
912 "'%.200s' object is not iterable",
913 Py_TYPE(self)->tp_name);
914 return NULL;
917 /* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
919 PyObject *
920 PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
922 PyTypeObject *tp = Py_TYPE(obj);
923 PyObject *descr = NULL;
924 PyObject *res = NULL;
925 descrgetfunc f;
926 Py_ssize_t dictoffset;
927 PyObject **dictptr;
929 if (!PyUnicode_Check(name)){
930 PyErr_Format(PyExc_TypeError,
931 "attribute name must be string, not '%.200s'",
932 name->ob_type->tp_name);
933 return NULL;
935 else
936 Py_INCREF(name);
938 if (tp->tp_dict == NULL) {
939 if (PyType_Ready(tp) < 0)
940 goto done;
943 #if 0 /* XXX this is not quite _PyType_Lookup anymore */
944 /* Inline _PyType_Lookup */
946 Py_ssize_t i, n;
947 PyObject *mro, *base, *dict;
949 /* Look in tp_dict of types in MRO */
950 mro = tp->tp_mro;
951 assert(mro != NULL);
952 assert(PyTuple_Check(mro));
953 n = PyTuple_GET_SIZE(mro);
954 for (i = 0; i < n; i++) {
955 base = PyTuple_GET_ITEM(mro, i);
956 assert(PyType_Check(base));
957 dict = ((PyTypeObject *)base)->tp_dict;
958 assert(dict && PyDict_Check(dict));
959 descr = PyDict_GetItem(dict, name);
960 if (descr != NULL)
961 break;
964 #else
965 descr = _PyType_Lookup(tp, name);
966 #endif
968 Py_XINCREF(descr);
970 f = NULL;
971 if (descr != NULL) {
972 f = descr->ob_type->tp_descr_get;
973 if (f != NULL && PyDescr_IsData(descr)) {
974 res = f(descr, obj, (PyObject *)obj->ob_type);
975 Py_DECREF(descr);
976 goto done;
980 /* Inline _PyObject_GetDictPtr */
981 dictoffset = tp->tp_dictoffset;
982 if (dictoffset != 0) {
983 PyObject *dict;
984 if (dictoffset < 0) {
985 Py_ssize_t tsize;
986 size_t size;
988 tsize = ((PyVarObject *)obj)->ob_size;
989 if (tsize < 0)
990 tsize = -tsize;
991 size = _PyObject_VAR_SIZE(tp, tsize);
993 dictoffset += (long)size;
994 assert(dictoffset > 0);
995 assert(dictoffset % SIZEOF_VOID_P == 0);
997 dictptr = (PyObject **) ((char *)obj + dictoffset);
998 dict = *dictptr;
999 if (dict != NULL) {
1000 Py_INCREF(dict);
1001 res = PyDict_GetItem(dict, name);
1002 if (res != NULL) {
1003 Py_INCREF(res);
1004 Py_XDECREF(descr);
1005 Py_DECREF(dict);
1006 goto done;
1008 Py_DECREF(dict);
1012 if (f != NULL) {
1013 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
1014 Py_DECREF(descr);
1015 goto done;
1018 if (descr != NULL) {
1019 res = descr;
1020 /* descr was already increfed above */
1021 goto done;
1024 PyErr_Format(PyExc_AttributeError,
1025 "'%.50s' object has no attribute '%.400s'",
1026 tp->tp_name, _PyUnicode_AsString(name));
1027 done:
1028 Py_DECREF(name);
1029 return res;
1033 PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1035 PyTypeObject *tp = Py_TYPE(obj);
1036 PyObject *descr;
1037 descrsetfunc f;
1038 PyObject **dictptr;
1039 int res = -1;
1041 if (!PyUnicode_Check(name)){
1042 PyErr_Format(PyExc_TypeError,
1043 "attribute name must be string, not '%.200s'",
1044 name->ob_type->tp_name);
1045 return -1;
1047 else
1048 Py_INCREF(name);
1050 if (tp->tp_dict == NULL) {
1051 if (PyType_Ready(tp) < 0)
1052 goto done;
1055 descr = _PyType_Lookup(tp, name);
1056 f = NULL;
1057 if (descr != NULL) {
1058 f = descr->ob_type->tp_descr_set;
1059 if (f != NULL && PyDescr_IsData(descr)) {
1060 res = f(descr, obj, value);
1061 goto done;
1065 dictptr = _PyObject_GetDictPtr(obj);
1066 if (dictptr != NULL) {
1067 PyObject *dict = *dictptr;
1068 if (dict == NULL && value != NULL) {
1069 dict = PyDict_New();
1070 if (dict == NULL)
1071 goto done;
1072 *dictptr = dict;
1074 if (dict != NULL) {
1075 Py_INCREF(dict);
1076 if (value == NULL)
1077 res = PyDict_DelItem(dict, name);
1078 else
1079 res = PyDict_SetItem(dict, name, value);
1080 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1081 PyErr_SetObject(PyExc_AttributeError, name);
1082 Py_DECREF(dict);
1083 goto done;
1087 if (f != NULL) {
1088 res = f(descr, obj, value);
1089 goto done;
1092 if (descr == NULL) {
1093 PyErr_Format(PyExc_AttributeError,
1094 "'%.100s' object has no attribute '%U'",
1095 tp->tp_name, name);
1096 goto done;
1099 PyErr_Format(PyExc_AttributeError,
1100 "'%.50s' object attribute '%U' is read-only",
1101 tp->tp_name, name);
1102 done:
1103 Py_DECREF(name);
1104 return res;
1107 /* Test a value used as condition, e.g., in a for or if statement.
1108 Return -1 if an error occurred */
1111 PyObject_IsTrue(PyObject *v)
1113 Py_ssize_t res;
1114 if (v == Py_True)
1115 return 1;
1116 if (v == Py_False)
1117 return 0;
1118 if (v == Py_None)
1119 return 0;
1120 else if (v->ob_type->tp_as_number != NULL &&
1121 v->ob_type->tp_as_number->nb_bool != NULL)
1122 res = (*v->ob_type->tp_as_number->nb_bool)(v);
1123 else if (v->ob_type->tp_as_mapping != NULL &&
1124 v->ob_type->tp_as_mapping->mp_length != NULL)
1125 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
1126 else if (v->ob_type->tp_as_sequence != NULL &&
1127 v->ob_type->tp_as_sequence->sq_length != NULL)
1128 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1129 else
1130 return 1;
1131 /* if it is negative, it should be either -1 or -2 */
1132 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
1135 /* equivalent of 'not v'
1136 Return -1 if an error occurred */
1139 PyObject_Not(PyObject *v)
1141 int res;
1142 res = PyObject_IsTrue(v);
1143 if (res < 0)
1144 return res;
1145 return res == 0;
1148 /* Test whether an object can be called */
1151 PyCallable_Check(PyObject *x)
1153 if (x == NULL)
1154 return 0;
1155 return x->ob_type->tp_call != NULL;
1158 /* ------------------------- PyObject_Dir() helpers ------------------------- */
1160 /* Helper for PyObject_Dir.
1161 Merge the __dict__ of aclass into dict, and recursively also all
1162 the __dict__s of aclass's base classes. The order of merging isn't
1163 defined, as it's expected that only the final set of dict keys is
1164 interesting.
1165 Return 0 on success, -1 on error.
1168 static int
1169 merge_class_dict(PyObject* dict, PyObject* aclass)
1171 PyObject *classdict;
1172 PyObject *bases;
1174 assert(PyDict_Check(dict));
1175 assert(aclass);
1177 /* Merge in the type's dict (if any). */
1178 classdict = PyObject_GetAttrString(aclass, "__dict__");
1179 if (classdict == NULL)
1180 PyErr_Clear();
1181 else {
1182 int status = PyDict_Update(dict, classdict);
1183 Py_DECREF(classdict);
1184 if (status < 0)
1185 return -1;
1188 /* Recursively merge in the base types' (if any) dicts. */
1189 bases = PyObject_GetAttrString(aclass, "__bases__");
1190 if (bases == NULL)
1191 PyErr_Clear();
1192 else {
1193 /* We have no guarantee that bases is a real tuple */
1194 Py_ssize_t i, n;
1195 n = PySequence_Size(bases); /* This better be right */
1196 if (n < 0)
1197 PyErr_Clear();
1198 else {
1199 for (i = 0; i < n; i++) {
1200 int status;
1201 PyObject *base = PySequence_GetItem(bases, i);
1202 if (base == NULL) {
1203 Py_DECREF(bases);
1204 return -1;
1206 status = merge_class_dict(dict, base);
1207 Py_DECREF(base);
1208 if (status < 0) {
1209 Py_DECREF(bases);
1210 return -1;
1214 Py_DECREF(bases);
1216 return 0;
1219 /* Helper for PyObject_Dir without arguments: returns the local scope. */
1220 static PyObject *
1221 _dir_locals(void)
1223 PyObject *names;
1224 PyObject *locals = PyEval_GetLocals();
1226 if (locals == NULL) {
1227 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1228 return NULL;
1231 names = PyMapping_Keys(locals);
1232 if (!names)
1233 return NULL;
1234 if (!PyList_Check(names)) {
1235 PyErr_Format(PyExc_TypeError,
1236 "dir(): expected keys() of locals to be a list, "
1237 "not '%.200s'", Py_TYPE(names)->tp_name);
1238 Py_DECREF(names);
1239 return NULL;
1241 /* the locals don't need to be DECREF'd */
1242 return names;
1245 /* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
1246 We deliberately don't suck up its __class__, as methods belonging to the
1247 metaclass would probably be more confusing than helpful.
1249 static PyObject *
1250 _specialized_dir_type(PyObject *obj)
1252 PyObject *result = NULL;
1253 PyObject *dict = PyDict_New();
1255 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1256 result = PyDict_Keys(dict);
1258 Py_XDECREF(dict);
1259 return result;
1262 /* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1263 static PyObject *
1264 _specialized_dir_module(PyObject *obj)
1266 PyObject *result = NULL;
1267 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
1269 if (dict != NULL) {
1270 if (PyDict_Check(dict))
1271 result = PyDict_Keys(dict);
1272 else {
1273 PyErr_Format(PyExc_TypeError,
1274 "%.200s.__dict__ is not a dictionary",
1275 PyModule_GetName(obj));
1279 Py_XDECREF(dict);
1280 return result;
1283 /* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1284 and recursively up the __class__.__bases__ chain.
1286 static PyObject *
1287 _generic_dir(PyObject *obj)
1289 PyObject *result = NULL;
1290 PyObject *dict = NULL;
1291 PyObject *itsclass = NULL;
1293 /* Get __dict__ (which may or may not be a real dict...) */
1294 dict = PyObject_GetAttrString(obj, "__dict__");
1295 if (dict == NULL) {
1296 PyErr_Clear();
1297 dict = PyDict_New();
1299 else if (!PyDict_Check(dict)) {
1300 Py_DECREF(dict);
1301 dict = PyDict_New();
1303 else {
1304 /* Copy __dict__ to avoid mutating it. */
1305 PyObject *temp = PyDict_Copy(dict);
1306 Py_DECREF(dict);
1307 dict = temp;
1310 if (dict == NULL)
1311 goto error;
1313 /* Merge in attrs reachable from its class. */
1314 itsclass = PyObject_GetAttrString(obj, "__class__");
1315 if (itsclass == NULL)
1316 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1317 __class__ exists? */
1318 PyErr_Clear();
1319 else {
1320 if (merge_class_dict(dict, itsclass) != 0)
1321 goto error;
1324 result = PyDict_Keys(dict);
1325 /* fall through */
1326 error:
1327 Py_XDECREF(itsclass);
1328 Py_XDECREF(dict);
1329 return result;
1332 /* Helper for PyObject_Dir: object introspection.
1333 This calls one of the above specialized versions if no __dir__ method
1334 exists. */
1335 static PyObject *
1336 _dir_object(PyObject *obj)
1338 PyObject * result = NULL;
1339 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1340 "__dir__");
1342 assert(obj);
1343 if (dirfunc == NULL) {
1344 /* use default implementation */
1345 PyErr_Clear();
1346 if (PyModule_Check(obj))
1347 result = _specialized_dir_module(obj);
1348 else if (PyType_Check(obj))
1349 result = _specialized_dir_type(obj);
1350 else
1351 result = _generic_dir(obj);
1353 else {
1354 /* use __dir__ */
1355 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1356 Py_DECREF(dirfunc);
1357 if (result == NULL)
1358 return NULL;
1360 /* result must be a list */
1361 /* XXX(gbrandl): could also check if all items are strings */
1362 if (!PyList_Check(result)) {
1363 PyErr_Format(PyExc_TypeError,
1364 "__dir__() must return a list, not %.200s",
1365 Py_TYPE(result)->tp_name);
1366 Py_DECREF(result);
1367 result = NULL;
1371 return result;
1374 /* Implementation of dir() -- if obj is NULL, returns the names in the current
1375 (local) scope. Otherwise, performs introspection of the object: returns a
1376 sorted list of attribute names (supposedly) accessible from the object
1378 PyObject *
1379 PyObject_Dir(PyObject *obj)
1381 PyObject * result;
1383 if (obj == NULL)
1384 /* no object -- introspect the locals */
1385 result = _dir_locals();
1386 else
1387 /* object -- introspect the object */
1388 result = _dir_object(obj);
1390 assert(result == NULL || PyList_Check(result));
1392 if (result != NULL && PyList_Sort(result) != 0) {
1393 /* sorting the list failed */
1394 Py_DECREF(result);
1395 result = NULL;
1398 return result;
1402 NoObject is usable as a non-NULL undefined value, used by the macro None.
1403 There is (and should be!) no way to create other objects of this type,
1404 so there is exactly one (which is indestructible, by the way).
1405 (XXX This type and the type of NotImplemented below should be unified.)
1408 /* ARGSUSED */
1409 static PyObject *
1410 none_repr(PyObject *op)
1412 return PyUnicode_FromString("None");
1415 /* ARGUSED */
1416 static void
1417 none_dealloc(PyObject* ignore)
1419 /* This should never get called, but we also don't want to SEGV if
1420 * we accidentally decref None out of existence.
1422 Py_FatalError("deallocating None");
1426 static PyTypeObject PyNone_Type = {
1427 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1428 "NoneType",
1431 none_dealloc, /*tp_dealloc*/ /*never called*/
1432 0, /*tp_print*/
1433 0, /*tp_getattr*/
1434 0, /*tp_setattr*/
1435 0, /*tp_reserved*/
1436 none_repr, /*tp_repr*/
1437 0, /*tp_as_number*/
1438 0, /*tp_as_sequence*/
1439 0, /*tp_as_mapping*/
1440 0, /*tp_hash */
1443 PyObject _Py_NoneStruct = {
1444 _PyObject_EXTRA_INIT
1445 1, &PyNone_Type
1448 /* NotImplemented is an object that can be used to signal that an
1449 operation is not implemented for the given type combination. */
1451 static PyObject *
1452 NotImplemented_repr(PyObject *op)
1454 return PyUnicode_FromString("NotImplemented");
1457 static PyTypeObject PyNotImplemented_Type = {
1458 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1459 "NotImplementedType",
1462 none_dealloc, /*tp_dealloc*/ /*never called*/
1463 0, /*tp_print*/
1464 0, /*tp_getattr*/
1465 0, /*tp_setattr*/
1466 0, /*tp_reserved*/
1467 NotImplemented_repr, /*tp_repr*/
1468 0, /*tp_as_number*/
1469 0, /*tp_as_sequence*/
1470 0, /*tp_as_mapping*/
1471 0, /*tp_hash */
1474 PyObject _Py_NotImplementedStruct = {
1475 _PyObject_EXTRA_INIT
1476 1, &PyNotImplemented_Type
1479 void
1480 _Py_ReadyTypes(void)
1482 if (PyType_Ready(&PyType_Type) < 0)
1483 Py_FatalError("Can't initialize type type");
1485 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1486 Py_FatalError("Can't initialize weakref type");
1488 if (PyType_Ready(&_PyWeakref_CallableProxyType) < 0)
1489 Py_FatalError("Can't initialize callable weakref proxy type");
1491 if (PyType_Ready(&_PyWeakref_ProxyType) < 0)
1492 Py_FatalError("Can't initialize weakref proxy type");
1494 if (PyType_Ready(&PyBool_Type) < 0)
1495 Py_FatalError("Can't initialize bool type");
1497 if (PyType_Ready(&PyByteArray_Type) < 0)
1498 Py_FatalError("Can't initialize bytearray type");
1500 if (PyType_Ready(&PyBytes_Type) < 0)
1501 Py_FatalError("Can't initialize 'str'");
1503 if (PyType_Ready(&PyList_Type) < 0)
1504 Py_FatalError("Can't initialize list type");
1506 if (PyType_Ready(&PyNone_Type) < 0)
1507 Py_FatalError("Can't initialize None type");
1509 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1510 Py_FatalError("Can't initialize type(Ellipsis)");
1512 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1513 Py_FatalError("Can't initialize NotImplemented type");
1515 if (PyType_Ready(&PyTraceBack_Type) < 0)
1516 Py_FatalError("Can't initialize traceback type");
1518 if (PyType_Ready(&PySuper_Type) < 0)
1519 Py_FatalError("Can't initialize super type");
1521 if (PyType_Ready(&PyBaseObject_Type) < 0)
1522 Py_FatalError("Can't initialize object type");
1524 if (PyType_Ready(&PyRange_Type) < 0)
1525 Py_FatalError("Can't initialize range type");
1527 if (PyType_Ready(&PyDict_Type) < 0)
1528 Py_FatalError("Can't initialize dict type");
1530 if (PyType_Ready(&PySet_Type) < 0)
1531 Py_FatalError("Can't initialize set type");
1533 if (PyType_Ready(&PyUnicode_Type) < 0)
1534 Py_FatalError("Can't initialize str type");
1536 if (PyType_Ready(&PySlice_Type) < 0)
1537 Py_FatalError("Can't initialize slice type");
1539 if (PyType_Ready(&PyStaticMethod_Type) < 0)
1540 Py_FatalError("Can't initialize static method type");
1542 #ifndef WITHOUT_COMPLEX
1543 if (PyType_Ready(&PyComplex_Type) < 0)
1544 Py_FatalError("Can't initialize complex type");
1545 #endif
1546 if (PyType_Ready(&PyFloat_Type) < 0)
1547 Py_FatalError("Can't initialize float type");
1549 if (PyType_Ready(&PyLong_Type) < 0)
1550 Py_FatalError("Can't initialize int type");
1552 if (PyType_Ready(&PyFrozenSet_Type) < 0)
1553 Py_FatalError("Can't initialize frozenset type");
1555 if (PyType_Ready(&PyProperty_Type) < 0)
1556 Py_FatalError("Can't initialize property type");
1558 if (PyType_Ready(&PyMemoryView_Type) < 0)
1559 Py_FatalError("Can't initialize memoryview type");
1561 if (PyType_Ready(&PyTuple_Type) < 0)
1562 Py_FatalError("Can't initialize tuple type");
1564 if (PyType_Ready(&PyEnum_Type) < 0)
1565 Py_FatalError("Can't initialize enumerate type");
1567 if (PyType_Ready(&PyReversed_Type) < 0)
1568 Py_FatalError("Can't initialize reversed type");
1570 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1571 Py_FatalError("Can't initialize StdPrinter");
1573 if (PyType_Ready(&PyCode_Type) < 0)
1574 Py_FatalError("Can't initialize code type");
1576 if (PyType_Ready(&PyFrame_Type) < 0)
1577 Py_FatalError("Can't initialize frame type");
1579 if (PyType_Ready(&PyCFunction_Type) < 0)
1580 Py_FatalError("Can't initialize builtin function type");
1582 if (PyType_Ready(&PyMethod_Type) < 0)
1583 Py_FatalError("Can't initialize method type");
1585 if (PyType_Ready(&PyFunction_Type) < 0)
1586 Py_FatalError("Can't initialize function type");
1588 if (PyType_Ready(&PyDictProxy_Type) < 0)
1589 Py_FatalError("Can't initialize dict proxy type");
1591 if (PyType_Ready(&PyGen_Type) < 0)
1592 Py_FatalError("Can't initialize generator type");
1594 if (PyType_Ready(&PyGetSetDescr_Type) < 0)
1595 Py_FatalError("Can't initialize get-set descriptor type");
1597 if (PyType_Ready(&PyWrapperDescr_Type) < 0)
1598 Py_FatalError("Can't initialize wrapper type");
1600 if (PyType_Ready(&PyEllipsis_Type) < 0)
1601 Py_FatalError("Can't initialize ellipsis type");
1603 if (PyType_Ready(&PyMemberDescr_Type) < 0)
1604 Py_FatalError("Can't initialize member descriptor type");
1608 #ifdef Py_TRACE_REFS
1610 void
1611 _Py_NewReference(PyObject *op)
1613 _Py_INC_REFTOTAL;
1614 op->ob_refcnt = 1;
1615 _Py_AddToAllObjects(op, 1);
1616 _Py_INC_TPALLOCS(op);
1619 void
1620 _Py_ForgetReference(register PyObject *op)
1622 #ifdef SLOW_UNREF_CHECK
1623 register PyObject *p;
1624 #endif
1625 if (op->ob_refcnt < 0)
1626 Py_FatalError("UNREF negative refcnt");
1627 if (op == &refchain ||
1628 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1629 fprintf(stderr, "* ob\n");
1630 _PyObject_Dump(op);
1631 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1632 _PyObject_Dump(op->_ob_prev->_ob_next);
1633 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1634 _PyObject_Dump(op->_ob_next->_ob_prev);
1635 Py_FatalError("UNREF invalid object");
1637 #ifdef SLOW_UNREF_CHECK
1638 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1639 if (p == op)
1640 break;
1642 if (p == &refchain) /* Not found */
1643 Py_FatalError("UNREF unknown object");
1644 #endif
1645 op->_ob_next->_ob_prev = op->_ob_prev;
1646 op->_ob_prev->_ob_next = op->_ob_next;
1647 op->_ob_next = op->_ob_prev = NULL;
1648 _Py_INC_TPFREES(op);
1651 void
1652 _Py_Dealloc(PyObject *op)
1654 destructor dealloc = Py_TYPE(op)->tp_dealloc;
1655 _Py_ForgetReference(op);
1656 (*dealloc)(op);
1659 /* Print all live objects. Because PyObject_Print is called, the
1660 * interpreter must be in a healthy state.
1662 void
1663 _Py_PrintReferences(FILE *fp)
1665 PyObject *op;
1666 fprintf(fp, "Remaining objects:\n");
1667 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
1668 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
1669 if (PyObject_Print(op, fp, 0) != 0)
1670 PyErr_Clear();
1671 putc('\n', fp);
1675 /* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1676 * doesn't make any calls to the Python C API, so is always safe to call.
1678 void
1679 _Py_PrintReferenceAddresses(FILE *fp)
1681 PyObject *op;
1682 fprintf(fp, "Remaining object addresses:\n");
1683 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
1684 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
1685 op->ob_refcnt, Py_TYPE(op)->tp_name);
1688 PyObject *
1689 _Py_GetObjects(PyObject *self, PyObject *args)
1691 int i, n;
1692 PyObject *t = NULL;
1693 PyObject *res, *op;
1695 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1696 return NULL;
1697 op = refchain._ob_next;
1698 res = PyList_New(0);
1699 if (res == NULL)
1700 return NULL;
1701 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1702 while (op == self || op == args || op == res || op == t ||
1703 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
1704 op = op->_ob_next;
1705 if (op == &refchain)
1706 return res;
1708 if (PyList_Append(res, op) < 0) {
1709 Py_DECREF(res);
1710 return NULL;
1712 op = op->_ob_next;
1714 return res;
1717 #endif
1719 /* Hack to force loading of cobject.o */
1720 PyTypeObject *_Py_cobject_hack = &PyCObject_Type;
1723 /* Hack to force loading of pycapsule.o */
1724 PyTypeObject *_PyCapsule_hack = &PyCapsule_Type;
1727 /* Hack to force loading of abstract.o */
1728 Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
1731 /* Python's malloc wrappers (see pymem.h) */
1733 void *
1734 PyMem_Malloc(size_t nbytes)
1736 return PyMem_MALLOC(nbytes);
1739 void *
1740 PyMem_Realloc(void *p, size_t nbytes)
1742 return PyMem_REALLOC(p, nbytes);
1745 void
1746 PyMem_Free(void *p)
1748 PyMem_FREE(p);
1752 /* These methods are used to control infinite recursion in repr, str, print,
1753 etc. Container objects that may recursively contain themselves,
1754 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1755 Py_ReprLeave() to avoid infinite recursion.
1757 Py_ReprEnter() returns 0 the first time it is called for a particular
1758 object and 1 every time thereafter. It returns -1 if an exception
1759 occurred. Py_ReprLeave() has no return value.
1761 See dictobject.c and listobject.c for examples of use.
1764 #define KEY "Py_Repr"
1767 Py_ReprEnter(PyObject *obj)
1769 PyObject *dict;
1770 PyObject *list;
1771 Py_ssize_t i;
1773 dict = PyThreadState_GetDict();
1774 if (dict == NULL)
1775 return 0;
1776 list = PyDict_GetItemString(dict, KEY);
1777 if (list == NULL) {
1778 list = PyList_New(0);
1779 if (list == NULL)
1780 return -1;
1781 if (PyDict_SetItemString(dict, KEY, list) < 0)
1782 return -1;
1783 Py_DECREF(list);
1785 i = PyList_GET_SIZE(list);
1786 while (--i >= 0) {
1787 if (PyList_GET_ITEM(list, i) == obj)
1788 return 1;
1790 PyList_Append(list, obj);
1791 return 0;
1794 void
1795 Py_ReprLeave(PyObject *obj)
1797 PyObject *dict;
1798 PyObject *list;
1799 Py_ssize_t i;
1801 dict = PyThreadState_GetDict();
1802 if (dict == NULL)
1803 return;
1804 list = PyDict_GetItemString(dict, KEY);
1805 if (list == NULL || !PyList_Check(list))
1806 return;
1807 i = PyList_GET_SIZE(list);
1808 /* Count backwards because we always expect obj to be list[-1] */
1809 while (--i >= 0) {
1810 if (PyList_GET_ITEM(list, i) == obj) {
1811 PyList_SetSlice(list, i, i + 1, NULL);
1812 break;
1817 /* Trashcan support. */
1819 /* Current call-stack depth of tp_dealloc calls. */
1820 int _PyTrash_delete_nesting = 0;
1822 /* List of objects that still need to be cleaned up, singly linked via their
1823 * gc headers' gc_prev pointers.
1825 PyObject *_PyTrash_delete_later = NULL;
1827 /* Add op to the _PyTrash_delete_later list. Called when the current
1828 * call-stack depth gets large. op must be a currently untracked gc'ed
1829 * object, with refcount 0. Py_DECREF must already have been called on it.
1831 void
1832 _PyTrash_deposit_object(PyObject *op)
1834 assert(PyObject_IS_GC(op));
1835 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1836 assert(op->ob_refcnt == 0);
1837 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
1838 _PyTrash_delete_later = op;
1841 /* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1842 * the call-stack unwinds again.
1844 void
1845 _PyTrash_destroy_chain(void)
1847 while (_PyTrash_delete_later) {
1848 PyObject *op = _PyTrash_delete_later;
1849 destructor dealloc = Py_TYPE(op)->tp_dealloc;
1851 _PyTrash_delete_later =
1852 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
1854 /* Call the deallocator directly. This used to try to
1855 * fool Py_DECREF into calling it indirectly, but
1856 * Py_DECREF was already called on this object, and in
1857 * assorted non-release builds calling Py_DECREF again ends
1858 * up distorting allocation statistics.
1860 assert(op->ob_refcnt == 0);
1861 ++_PyTrash_delete_nesting;
1862 (*dealloc)(op);
1863 --_PyTrash_delete_nesting;
1867 #ifdef __cplusplus
1869 #endif