blob: 3f790e88242253db508660018ffdcd574d4c233a [file] [log] [blame]
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001/* Type object implementation */
2
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003#include "Python.h"
Tim Peters6d6c1a32001-08-02 04:15:00 +00004#include "structmember.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00005
Guido van Rossum9923ffe2002-06-04 19:52:53 +00006#include <ctype.h>
7
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +00008
9/* Support type attribute cache */
10
11/* The cache can keep references to the names alive for longer than
12 they normally would. This is why the maximum size is limited to
13 MCACHE_MAX_ATTR_SIZE, since it might be a problem if very large
14 strings are used as attribute names. */
15#define MCACHE_MAX_ATTR_SIZE 100
16#define MCACHE_SIZE_EXP 10
17#define MCACHE_HASH(version, name_hash) \
18 (((unsigned int)(version) * (unsigned int)(name_hash)) \
19 >> (8*sizeof(unsigned int) - MCACHE_SIZE_EXP))
20#define MCACHE_HASH_METHOD(type, name) \
21 MCACHE_HASH((type)->tp_version_tag, \
Gregory P. Smithdd96db62008-06-09 04:58:54 +000022 ((PyStringObject *)(name))->ob_shash)
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +000023#define MCACHE_CACHEABLE_NAME(name) \
Gregory P. Smithdd96db62008-06-09 04:58:54 +000024 PyString_CheckExact(name) && \
25 PyString_GET_SIZE(name) <= MCACHE_MAX_ATTR_SIZE
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +000026
27struct method_cache_entry {
28 unsigned int version;
29 PyObject *name; /* reference to exactly a str or None */
30 PyObject *value; /* borrowed */
31};
32
33static struct method_cache_entry method_cache[1 << MCACHE_SIZE_EXP];
34static unsigned int next_version_tag = 0;
Christian Heimes908caac2008-01-27 23:34:59 +000035
36unsigned int
37PyType_ClearCache(void)
38{
39 Py_ssize_t i;
40 unsigned int cur_version_tag = next_version_tag - 1;
41
42 for (i = 0; i < (1 << MCACHE_SIZE_EXP); i++) {
43 method_cache[i].version = 0;
44 Py_CLEAR(method_cache[i].name);
45 method_cache[i].value = NULL;
46 }
47 next_version_tag = 0;
48 /* mark all version tags as invalid */
Georg Brandl74a1dea2008-05-28 11:21:39 +000049 PyType_Modified(&PyBaseObject_Type);
Christian Heimes908caac2008-01-27 23:34:59 +000050 return cur_version_tag;
51}
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +000052
Georg Brandl74a1dea2008-05-28 11:21:39 +000053void
54PyType_Modified(PyTypeObject *type)
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +000055{
56 /* Invalidate any cached data for the specified type and all
57 subclasses. This function is called after the base
58 classes, mro, or attributes of the type are altered.
59
60 Invariants:
61
62 - Py_TPFLAGS_VALID_VERSION_TAG is never set if
63 Py_TPFLAGS_HAVE_VERSION_TAG is not set (e.g. on type
64 objects coming from non-recompiled extension modules)
65
66 - before Py_TPFLAGS_VALID_VERSION_TAG can be set on a type,
67 it must first be set on all super types.
68
69 This function clears the Py_TPFLAGS_VALID_VERSION_TAG of a
70 type (so it must first clear it on all subclasses). The
71 tp_version_tag value is meaningless unless this flag is set.
72 We don't assign new version tags eagerly, but only as
73 needed.
74 */
75 PyObject *raw, *ref;
76 Py_ssize_t i, n;
77
Neal Norwitze7bb9182008-01-27 17:10:14 +000078 if (!PyType_HasFeature(type, Py_TPFLAGS_VALID_VERSION_TAG))
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +000079 return;
80
81 raw = type->tp_subclasses;
82 if (raw != NULL) {
83 n = PyList_GET_SIZE(raw);
84 for (i = 0; i < n; i++) {
85 ref = PyList_GET_ITEM(raw, i);
86 ref = PyWeakref_GET_OBJECT(ref);
87 if (ref != Py_None) {
Georg Brandl74a1dea2008-05-28 11:21:39 +000088 PyType_Modified((PyTypeObject *)ref);
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +000089 }
90 }
91 }
92 type->tp_flags &= ~Py_TPFLAGS_VALID_VERSION_TAG;
93}
94
95static void
96type_mro_modified(PyTypeObject *type, PyObject *bases) {
97 /*
98 Check that all base classes or elements of the mro of type are
99 able to be cached. This function is called after the base
100 classes or mro of the type are altered.
101
102 Unset HAVE_VERSION_TAG and VALID_VERSION_TAG if the type
103 inherits from an old-style class, either directly or if it
104 appears in the MRO of a new-style class. No support either for
105 custom MROs that include types that are not officially super
106 types.
107
108 Called from mro_internal, which will subsequently be called on
109 each subclass when their mro is recursively updated.
110 */
111 Py_ssize_t i, n;
112 int clear = 0;
113
Neal Norwitze7bb9182008-01-27 17:10:14 +0000114 if (!PyType_HasFeature(type, Py_TPFLAGS_HAVE_VERSION_TAG))
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +0000115 return;
116
117 n = PyTuple_GET_SIZE(bases);
118 for (i = 0; i < n; i++) {
119 PyObject *b = PyTuple_GET_ITEM(bases, i);
120 PyTypeObject *cls;
121
122 if (!PyType_Check(b) ) {
123 clear = 1;
124 break;
125 }
126
127 cls = (PyTypeObject *)b;
128
129 if (!PyType_HasFeature(cls, Py_TPFLAGS_HAVE_VERSION_TAG) ||
130 !PyType_IsSubtype(type, cls)) {
131 clear = 1;
132 break;
133 }
134 }
135
136 if (clear)
137 type->tp_flags &= ~(Py_TPFLAGS_HAVE_VERSION_TAG|
138 Py_TPFLAGS_VALID_VERSION_TAG);
139}
140
141static int
142assign_version_tag(PyTypeObject *type)
143{
144 /* Ensure that the tp_version_tag is valid and set
145 Py_TPFLAGS_VALID_VERSION_TAG. To respect the invariant, this
146 must first be done on all super classes. Return 0 if this
147 cannot be done, 1 if Py_TPFLAGS_VALID_VERSION_TAG.
148 */
149 Py_ssize_t i, n;
Georg Brandlf18a7072008-05-29 14:35:39 +0000150 PyObject *bases;
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +0000151
152 if (PyType_HasFeature(type, Py_TPFLAGS_VALID_VERSION_TAG))
153 return 1;
154 if (!PyType_HasFeature(type, Py_TPFLAGS_HAVE_VERSION_TAG))
155 return 0;
156 if (!PyType_HasFeature(type, Py_TPFLAGS_READY))
157 return 0;
158
159 type->tp_version_tag = next_version_tag++;
160 /* for stress-testing: next_version_tag &= 0xFF; */
161
162 if (type->tp_version_tag == 0) {
163 /* wrap-around or just starting Python - clear the whole
164 cache by filling names with references to Py_None.
165 Values are also set to NULL for added protection, as they
166 are borrowed reference */
167 for (i = 0; i < (1 << MCACHE_SIZE_EXP); i++) {
168 method_cache[i].value = NULL;
Georg Brandlf18a7072008-05-29 14:35:39 +0000169 Py_XDECREF(method_cache[i].name);
Georg Brandl5ec330c2008-05-28 15:41:36 +0000170 method_cache[i].name = Py_None;
Georg Brandlf18a7072008-05-29 14:35:39 +0000171 Py_INCREF(Py_None);
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +0000172 }
173 /* mark all version tags as invalid */
Georg Brandl74a1dea2008-05-28 11:21:39 +0000174 PyType_Modified(&PyBaseObject_Type);
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +0000175 return 1;
176 }
177 bases = type->tp_bases;
178 n = PyTuple_GET_SIZE(bases);
179 for (i = 0; i < n; i++) {
180 PyObject *b = PyTuple_GET_ITEM(bases, i);
181 assert(PyType_Check(b));
182 if (!assign_version_tag((PyTypeObject *)b))
183 return 0;
184 }
185 type->tp_flags |= Py_TPFLAGS_VALID_VERSION_TAG;
186 return 1;
187}
188
189
Guido van Rossum6f799372001-09-20 20:46:19 +0000190static PyMemberDef type_members[] = {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000191 {"__basicsize__", T_INT, offsetof(PyTypeObject,tp_basicsize),READONLY},
192 {"__itemsize__", T_INT, offsetof(PyTypeObject, tp_itemsize), READONLY},
193 {"__flags__", T_LONG, offsetof(PyTypeObject, tp_flags), READONLY},
Guido van Rossum9676b222001-08-17 20:32:36 +0000194 {"__weakrefoffset__", T_LONG,
Tim Peters6d6c1a32001-08-02 04:15:00 +0000195 offsetof(PyTypeObject, tp_weaklistoffset), READONLY},
196 {"__base__", T_OBJECT, offsetof(PyTypeObject, tp_base), READONLY},
197 {"__dictoffset__", T_LONG,
198 offsetof(PyTypeObject, tp_dictoffset), READONLY},
Tim Peters6d6c1a32001-08-02 04:15:00 +0000199 {"__mro__", T_OBJECT, offsetof(PyTypeObject, tp_mro), READONLY},
200 {0}
201};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000202
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000203static PyObject *
Guido van Rossumc3542212001-08-16 09:18:56 +0000204type_name(PyTypeObject *type, void *context)
205{
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000206 const char *s;
Guido van Rossumc3542212001-08-16 09:18:56 +0000207
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +0000208 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE) {
Guido van Rossume5c691a2003-03-07 15:13:17 +0000209 PyHeapTypeObject* et = (PyHeapTypeObject*)type;
Tim Petersea7f75d2002-12-07 21:39:16 +0000210
Georg Brandlc255c7b2006-02-20 22:27:28 +0000211 Py_INCREF(et->ht_name);
212 return et->ht_name;
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +0000213 }
214 else {
215 s = strrchr(type->tp_name, '.');
216 if (s == NULL)
217 s = type->tp_name;
218 else
219 s++;
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000220 return PyString_FromString(s);
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +0000221 }
Guido van Rossumc3542212001-08-16 09:18:56 +0000222}
223
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000224static int
225type_set_name(PyTypeObject *type, PyObject *value, void *context)
226{
Guido van Rossume5c691a2003-03-07 15:13:17 +0000227 PyHeapTypeObject* et;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000228
229 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
230 PyErr_Format(PyExc_TypeError,
231 "can't set %s.__name__", type->tp_name);
232 return -1;
233 }
234 if (!value) {
235 PyErr_Format(PyExc_TypeError,
236 "can't delete %s.__name__", type->tp_name);
237 return -1;
238 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000239 if (!PyString_Check(value)) {
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000240 PyErr_Format(PyExc_TypeError,
241 "can only assign string to %s.__name__, not '%s'",
Christian Heimese93237d2007-12-19 02:37:44 +0000242 type->tp_name, Py_TYPE(value)->tp_name);
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000243 return -1;
244 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000245 if (strlen(PyString_AS_STRING(value))
246 != (size_t)PyString_GET_SIZE(value)) {
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000247 PyErr_Format(PyExc_ValueError,
248 "__name__ must not contain null bytes");
249 return -1;
250 }
251
Guido van Rossume5c691a2003-03-07 15:13:17 +0000252 et = (PyHeapTypeObject*)type;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000253
254 Py_INCREF(value);
255
Georg Brandlc255c7b2006-02-20 22:27:28 +0000256 Py_DECREF(et->ht_name);
257 et->ht_name = value;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000258
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000259 type->tp_name = PyString_AS_STRING(value);
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000260
261 return 0;
262}
263
Guido van Rossumc3542212001-08-16 09:18:56 +0000264static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000265type_module(PyTypeObject *type, void *context)
Guido van Rossum29ca26e1995-01-07 11:58:15 +0000266{
Guido van Rossumc3542212001-08-16 09:18:56 +0000267 PyObject *mod;
268 char *s;
269
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +0000270 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE) {
271 mod = PyDict_GetItemString(type->tp_dict, "__module__");
Anthony Baxter3ecdb252004-06-11 14:41:18 +0000272 if (!mod) {
273 PyErr_Format(PyExc_AttributeError, "__module__");
274 return 0;
275 }
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +0000276 Py_XINCREF(mod);
Guido van Rossumc3542212001-08-16 09:18:56 +0000277 return mod;
278 }
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +0000279 else {
280 s = strrchr(type->tp_name, '.');
281 if (s != NULL)
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000282 return PyString_FromStringAndSize(
Armin Rigo7ccbca92006-10-04 12:17:45 +0000283 type->tp_name, (Py_ssize_t)(s - type->tp_name));
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000284 return PyString_FromString("__builtin__");
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +0000285 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000286}
287
Guido van Rossum3926a632001-09-25 16:25:58 +0000288static int
289type_set_module(PyTypeObject *type, PyObject *value, void *context)
290{
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000291 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
Guido van Rossum3926a632001-09-25 16:25:58 +0000292 PyErr_Format(PyExc_TypeError,
293 "can't set %s.__module__", type->tp_name);
294 return -1;
295 }
296 if (!value) {
297 PyErr_Format(PyExc_TypeError,
298 "can't delete %s.__module__", type->tp_name);
299 return -1;
300 }
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000301
Georg Brandl74a1dea2008-05-28 11:21:39 +0000302 PyType_Modified(type);
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +0000303
Guido van Rossum3926a632001-09-25 16:25:58 +0000304 return PyDict_SetItemString(type->tp_dict, "__module__", value);
305}
306
Tim Peters6d6c1a32001-08-02 04:15:00 +0000307static PyObject *
Jeffrey Yasskin960b9b72008-02-28 04:45:36 +0000308type_abstractmethods(PyTypeObject *type, void *context)
309{
310 PyObject *mod = PyDict_GetItemString(type->tp_dict,
311 "__abstractmethods__");
312 if (!mod) {
313 PyErr_Format(PyExc_AttributeError, "__abstractmethods__");
314 return NULL;
315 }
316 Py_XINCREF(mod);
317 return mod;
318}
319
320static int
321type_set_abstractmethods(PyTypeObject *type, PyObject *value, void *context)
322{
323 /* __abstractmethods__ should only be set once on a type, in
324 abc.ABCMeta.__new__, so this function doesn't do anything
325 special to update subclasses.
326 */
327 int res = PyDict_SetItemString(type->tp_dict,
328 "__abstractmethods__", value);
329 if (res == 0) {
Georg Brandl74a1dea2008-05-28 11:21:39 +0000330 PyType_Modified(type);
Jeffrey Yasskin960b9b72008-02-28 04:45:36 +0000331 if (value && PyObject_IsTrue(value)) {
332 type->tp_flags |= Py_TPFLAGS_IS_ABSTRACT;
333 }
334 else {
335 type->tp_flags &= ~Py_TPFLAGS_IS_ABSTRACT;
336 }
337 }
338 return res;
339}
340
341static PyObject *
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000342type_get_bases(PyTypeObject *type, void *context)
343{
344 Py_INCREF(type->tp_bases);
345 return type->tp_bases;
346}
347
348static PyTypeObject *best_base(PyObject *);
349static int mro_internal(PyTypeObject *);
350static int compatible_for_assignment(PyTypeObject *, PyTypeObject *, char *);
351static int add_subclass(PyTypeObject*, PyTypeObject*);
352static void remove_subclass(PyTypeObject *, PyTypeObject *);
353static void update_all_slots(PyTypeObject *);
354
Guido van Rossum8d24ee92003-03-24 23:49:49 +0000355typedef int (*update_callback)(PyTypeObject *, void *);
356static int update_subclasses(PyTypeObject *type, PyObject *name,
357 update_callback callback, void *data);
358static int recurse_down_subclasses(PyTypeObject *type, PyObject *name,
359 update_callback callback, void *data);
360
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000361static int
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000362mro_subclasses(PyTypeObject *type, PyObject* temp)
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000363{
364 PyTypeObject *subclass;
365 PyObject *ref, *subclasses, *old_mro;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000366 Py_ssize_t i, n;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000367
368 subclasses = type->tp_subclasses;
369 if (subclasses == NULL)
370 return 0;
371 assert(PyList_Check(subclasses));
372 n = PyList_GET_SIZE(subclasses);
373 for (i = 0; i < n; i++) {
374 ref = PyList_GET_ITEM(subclasses, i);
375 assert(PyWeakref_CheckRef(ref));
376 subclass = (PyTypeObject *)PyWeakref_GET_OBJECT(ref);
377 assert(subclass != NULL);
378 if ((PyObject *)subclass == Py_None)
379 continue;
380 assert(PyType_Check(subclass));
381 old_mro = subclass->tp_mro;
382 if (mro_internal(subclass) < 0) {
383 subclass->tp_mro = old_mro;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000384 return -1;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000385 }
386 else {
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000387 PyObject* tuple;
Raymond Hettinger8ae46892003-10-12 19:09:37 +0000388 tuple = PyTuple_Pack(2, subclass, old_mro);
Guido van Rossum19a02ba2003-04-15 22:09:45 +0000389 Py_DECREF(old_mro);
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000390 if (!tuple)
391 return -1;
392 if (PyList_Append(temp, tuple) < 0)
393 return -1;
Guido van Rossum19a02ba2003-04-15 22:09:45 +0000394 Py_DECREF(tuple);
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000395 }
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000396 if (mro_subclasses(subclass, temp) < 0)
397 return -1;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000398 }
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000399 return 0;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000400}
401
402static int
403type_set_bases(PyTypeObject *type, PyObject *value, void *context)
404{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000405 Py_ssize_t i;
406 int r = 0;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000407 PyObject *ob, *temp;
Armin Rigoc0ba52d2007-04-19 14:44:48 +0000408 PyTypeObject *new_base, *old_base;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000409 PyObject *old_bases, *old_mro;
410
411 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
412 PyErr_Format(PyExc_TypeError,
413 "can't set %s.__bases__", type->tp_name);
414 return -1;
415 }
416 if (!value) {
417 PyErr_Format(PyExc_TypeError,
418 "can't delete %s.__bases__", type->tp_name);
419 return -1;
420 }
421 if (!PyTuple_Check(value)) {
422 PyErr_Format(PyExc_TypeError,
423 "can only assign tuple to %s.__bases__, not %s",
Christian Heimese93237d2007-12-19 02:37:44 +0000424 type->tp_name, Py_TYPE(value)->tp_name);
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000425 return -1;
426 }
Guido van Rossum3bbc0ee2002-12-13 17:49:38 +0000427 if (PyTuple_GET_SIZE(value) == 0) {
428 PyErr_Format(PyExc_TypeError,
429 "can only assign non-empty tuple to %s.__bases__, not ()",
430 type->tp_name);
431 return -1;
432 }
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000433 for (i = 0; i < PyTuple_GET_SIZE(value); i++) {
434 ob = PyTuple_GET_ITEM(value, i);
435 if (!PyClass_Check(ob) && !PyType_Check(ob)) {
436 PyErr_Format(
437 PyExc_TypeError,
438 "%s.__bases__ must be tuple of old- or new-style classes, not '%s'",
Christian Heimese93237d2007-12-19 02:37:44 +0000439 type->tp_name, Py_TYPE(ob)->tp_name);
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000440 return -1;
441 }
Michael W. Hudsoncaf17be2002-11-27 10:24:44 +0000442 if (PyType_Check(ob)) {
443 if (PyType_IsSubtype((PyTypeObject*)ob, type)) {
444 PyErr_SetString(PyExc_TypeError,
445 "a __bases__ item causes an inheritance cycle");
446 return -1;
447 }
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000448 }
449 }
450
451 new_base = best_base(value);
452
453 if (!new_base) {
454 return -1;
455 }
456
457 if (!compatible_for_assignment(type->tp_base, new_base, "__bases__"))
458 return -1;
459
460 Py_INCREF(new_base);
461 Py_INCREF(value);
462
463 old_bases = type->tp_bases;
464 old_base = type->tp_base;
465 old_mro = type->tp_mro;
466
467 type->tp_bases = value;
468 type->tp_base = new_base;
469
470 if (mro_internal(type) < 0) {
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000471 goto bail;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000472 }
473
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000474 temp = PyList_New(0);
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000475 if (!temp)
476 goto bail;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000477
478 r = mro_subclasses(type, temp);
479
480 if (r < 0) {
481 for (i = 0; i < PyList_Size(temp); i++) {
482 PyTypeObject* cls;
483 PyObject* mro;
Raymond Hettinger8ae46892003-10-12 19:09:37 +0000484 PyArg_UnpackTuple(PyList_GET_ITEM(temp, i),
485 "", 2, 2, &cls, &mro);
Armin Rigo796fc992007-04-19 14:56:48 +0000486 Py_INCREF(mro);
487 ob = cls->tp_mro;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000488 cls->tp_mro = mro;
Armin Rigo796fc992007-04-19 14:56:48 +0000489 Py_DECREF(ob);
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000490 }
491 Py_DECREF(temp);
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000492 goto bail;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000493 }
494
495 Py_DECREF(temp);
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000496
497 /* any base that was in __bases__ but now isn't, we
Raymond Hettingera8285862002-12-14 17:17:56 +0000498 need to remove |type| from its tp_subclasses.
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000499 conversely, any class now in __bases__ that wasn't
Raymond Hettingera8285862002-12-14 17:17:56 +0000500 needs to have |type| added to its subclasses. */
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000501
502 /* for now, sod that: just remove from all old_bases,
503 add to all new_bases */
504
505 for (i = PyTuple_GET_SIZE(old_bases) - 1; i >= 0; i--) {
506 ob = PyTuple_GET_ITEM(old_bases, i);
507 if (PyType_Check(ob)) {
508 remove_subclass(
509 (PyTypeObject*)ob, type);
510 }
511 }
512
513 for (i = PyTuple_GET_SIZE(value) - 1; i >= 0; i--) {
514 ob = PyTuple_GET_ITEM(value, i);
515 if (PyType_Check(ob)) {
516 if (add_subclass((PyTypeObject*)ob, type) < 0)
517 r = -1;
518 }
519 }
520
521 update_all_slots(type);
522
523 Py_DECREF(old_bases);
524 Py_DECREF(old_base);
525 Py_DECREF(old_mro);
526
527 return r;
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000528
529 bail:
Michael W. Hudsone723e452003-08-07 14:58:10 +0000530 Py_DECREF(type->tp_bases);
531 Py_DECREF(type->tp_base);
532 if (type->tp_mro != old_mro) {
533 Py_DECREF(type->tp_mro);
534 }
535
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000536 type->tp_bases = old_bases;
537 type->tp_base = old_base;
538 type->tp_mro = old_mro;
Tim Petersea7f75d2002-12-07 21:39:16 +0000539
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000540 return -1;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000541}
542
543static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000544type_dict(PyTypeObject *type, void *context)
545{
546 if (type->tp_dict == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000547 Py_INCREF(Py_None);
548 return Py_None;
Guido van Rossum29ca26e1995-01-07 11:58:15 +0000549 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000550 return PyDictProxy_New(type->tp_dict);
Guido van Rossum29ca26e1995-01-07 11:58:15 +0000551}
552
Tim Peters24008312002-03-17 18:56:20 +0000553static PyObject *
554type_get_doc(PyTypeObject *type, void *context)
555{
556 PyObject *result;
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000557 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE) && type->tp_doc != NULL)
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000558 return PyString_FromString(type->tp_doc);
Tim Peters24008312002-03-17 18:56:20 +0000559 result = PyDict_GetItemString(type->tp_dict, "__doc__");
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000560 if (result == NULL) {
561 result = Py_None;
562 Py_INCREF(result);
563 }
Christian Heimese93237d2007-12-19 02:37:44 +0000564 else if (Py_TYPE(result)->tp_descr_get) {
565 result = Py_TYPE(result)->tp_descr_get(result, NULL,
Tim Peters2b858972002-04-18 04:12:28 +0000566 (PyObject *)type);
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000567 }
568 else {
569 Py_INCREF(result);
570 }
Tim Peters24008312002-03-17 18:56:20 +0000571 return result;
572}
573
Antoine Pitrou0668c622008-08-26 22:42:08 +0000574static PyObject *
575type___instancecheck__(PyObject *type, PyObject *inst)
576{
577 switch (_PyObject_RealIsInstance(inst, type)) {
578 case -1:
579 return NULL;
580 case 0:
581 Py_RETURN_FALSE;
582 default:
583 Py_RETURN_TRUE;
584 }
585}
586
587
588static PyObject *
589type_get_instancecheck(PyObject *type, void *context)
590{
591 static PyMethodDef ml = {"__instancecheck__",
592 type___instancecheck__, METH_O };
593 return PyCFunction_New(&ml, type);
594}
595
596static PyObject *
597type___subclasscheck__(PyObject *type, PyObject *inst)
598{
599 switch (_PyObject_RealIsSubclass(inst, type)) {
600 case -1:
601 return NULL;
602 case 0:
603 Py_RETURN_FALSE;
604 default:
605 Py_RETURN_TRUE;
606 }
607}
608
609static PyObject *
610type_get_subclasscheck(PyObject *type, void *context)
611{
612 static PyMethodDef ml = {"__subclasscheck__",
613 type___subclasscheck__, METH_O };
614 return PyCFunction_New(&ml, type);
615}
616
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000617static PyGetSetDef type_getsets[] = {
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000618 {"__name__", (getter)type_name, (setter)type_set_name, NULL},
619 {"__bases__", (getter)type_get_bases, (setter)type_set_bases, NULL},
Guido van Rossum3926a632001-09-25 16:25:58 +0000620 {"__module__", (getter)type_module, (setter)type_set_module, NULL},
Jeffrey Yasskin960b9b72008-02-28 04:45:36 +0000621 {"__abstractmethods__", (getter)type_abstractmethods,
622 (setter)type_set_abstractmethods, NULL},
Tim Peters6d6c1a32001-08-02 04:15:00 +0000623 {"__dict__", (getter)type_dict, NULL, NULL},
Tim Peters24008312002-03-17 18:56:20 +0000624 {"__doc__", (getter)type_get_doc, NULL, NULL},
Antoine Pitrou0668c622008-08-26 22:42:08 +0000625 {"__instancecheck__", (getter)type_get_instancecheck, NULL, NULL},
626 {"__subclasscheck__", (getter)type_get_subclasscheck, NULL, NULL},
Tim Peters6d6c1a32001-08-02 04:15:00 +0000627 {0}
628};
629
Martin v. Löwis0163d6d2001-06-09 07:34:05 +0000630static int
631type_compare(PyObject *v, PyObject *w)
632{
633 /* This is called with type objects only. So we
634 can just compare the addresses. */
635 Py_uintptr_t vv = (Py_uintptr_t)v;
636 Py_uintptr_t ww = (Py_uintptr_t)w;
637 return (vv < ww) ? -1 : (vv > ww) ? 1 : 0;
638}
639
Steven Bethardae42f332008-03-18 17:26:10 +0000640static PyObject*
641type_richcompare(PyObject *v, PyObject *w, int op)
642{
643 PyObject *result;
644 Py_uintptr_t vv, ww;
645 int c;
646
647 /* Make sure both arguments are types. */
648 if (!PyType_Check(v) || !PyType_Check(w)) {
649 result = Py_NotImplemented;
650 goto out;
651 }
652
653 /* Py3K warning if comparison isn't == or != */
654 if (Py_Py3kWarningFlag && op != Py_EQ && op != Py_NE &&
Benjamin Peterson9f4f4812008-04-27 03:01:45 +0000655 PyErr_WarnEx(PyExc_DeprecationWarning,
Georg Brandld5b635f2008-03-25 08:29:14 +0000656 "type inequality comparisons not supported "
Benjamin Peterson9f4f4812008-04-27 03:01:45 +0000657 "in 3.x", 1) < 0) {
Steven Bethardae42f332008-03-18 17:26:10 +0000658 return NULL;
659 }
660
661 /* Compare addresses */
662 vv = (Py_uintptr_t)v;
663 ww = (Py_uintptr_t)w;
664 switch (op) {
665 case Py_LT: c = vv < ww; break;
666 case Py_LE: c = vv <= ww; break;
667 case Py_EQ: c = vv == ww; break;
668 case Py_NE: c = vv != ww; break;
669 case Py_GT: c = vv > ww; break;
670 case Py_GE: c = vv >= ww; break;
671 default:
672 result = Py_NotImplemented;
673 goto out;
674 }
675 result = c ? Py_True : Py_False;
676
677 /* incref and return */
678 out:
679 Py_INCREF(result);
680 return result;
681}
682
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000683static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000684type_repr(PyTypeObject *type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000685{
Barry Warsaw7ce36942001-08-24 18:34:26 +0000686 PyObject *mod, *name, *rtn;
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000687 char *kind;
Guido van Rossumc3542212001-08-16 09:18:56 +0000688
689 mod = type_module(type, NULL);
690 if (mod == NULL)
691 PyErr_Clear();
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000692 else if (!PyString_Check(mod)) {
Guido van Rossumc3542212001-08-16 09:18:56 +0000693 Py_DECREF(mod);
694 mod = NULL;
695 }
696 name = type_name(type, NULL);
697 if (name == NULL)
698 return NULL;
Barry Warsaw7ce36942001-08-24 18:34:26 +0000699
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000700 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
701 kind = "class";
702 else
703 kind = "type";
704
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000705 if (mod != NULL && strcmp(PyString_AS_STRING(mod), "__builtin__")) {
706 rtn = PyString_FromFormat("<%s '%s.%s'>",
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000707 kind,
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000708 PyString_AS_STRING(mod),
709 PyString_AS_STRING(name));
Barry Warsaw7ce36942001-08-24 18:34:26 +0000710 }
Guido van Rossumc3542212001-08-16 09:18:56 +0000711 else
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000712 rtn = PyString_FromFormat("<%s '%s'>", kind, type->tp_name);
Barry Warsaw7ce36942001-08-24 18:34:26 +0000713
Guido van Rossumc3542212001-08-16 09:18:56 +0000714 Py_XDECREF(mod);
715 Py_DECREF(name);
Barry Warsaw7ce36942001-08-24 18:34:26 +0000716 return rtn;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000717}
718
Tim Peters6d6c1a32001-08-02 04:15:00 +0000719static PyObject *
720type_call(PyTypeObject *type, PyObject *args, PyObject *kwds)
721{
722 PyObject *obj;
723
724 if (type->tp_new == NULL) {
725 PyErr_Format(PyExc_TypeError,
726 "cannot create '%.100s' instances",
727 type->tp_name);
728 return NULL;
729 }
730
Tim Peters3f996e72001-09-13 19:18:27 +0000731 obj = type->tp_new(type, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000732 if (obj != NULL) {
Guido van Rossumf76de622001-10-18 15:49:21 +0000733 /* Ugly exception: when the call was type(something),
734 don't call tp_init on the result. */
735 if (type == &PyType_Type &&
736 PyTuple_Check(args) && PyTuple_GET_SIZE(args) == 1 &&
737 (kwds == NULL ||
738 (PyDict_Check(kwds) && PyDict_Size(kwds) == 0)))
739 return obj;
Guido van Rossum8ace1ab2002-04-06 01:05:01 +0000740 /* If the returned object is not an instance of type,
741 it won't be initialized. */
742 if (!PyType_IsSubtype(obj->ob_type, type))
743 return obj;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000744 type = obj->ob_type;
Jeremy Hylton719841e2002-07-16 19:39:38 +0000745 if (PyType_HasFeature(type, Py_TPFLAGS_HAVE_CLASS) &&
746 type->tp_init != NULL &&
Tim Peters6d6c1a32001-08-02 04:15:00 +0000747 type->tp_init(obj, args, kwds) < 0) {
748 Py_DECREF(obj);
749 obj = NULL;
750 }
751 }
752 return obj;
753}
754
755PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000756PyType_GenericAlloc(PyTypeObject *type, Py_ssize_t nitems)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000757{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000758 PyObject *obj;
Guido van Rossume5c691a2003-03-07 15:13:17 +0000759 const size_t size = _PyObject_VAR_SIZE(type, nitems+1);
760 /* note that we need to add one, for the sentinel */
Tim Peters406fe3b2001-10-06 19:04:01 +0000761
762 if (PyType_IS_GC(type))
Neil Schemenauer09a2ae52002-04-12 03:06:53 +0000763 obj = _PyObject_GC_Malloc(size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000764 else
Anthony Baxtera6286212006-04-11 07:42:36 +0000765 obj = (PyObject *)PyObject_MALLOC(size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000766
Neil Schemenauerc806c882001-08-29 23:54:54 +0000767 if (obj == NULL)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000768 return PyErr_NoMemory();
Tim Peters406fe3b2001-10-06 19:04:01 +0000769
Neil Schemenauerc806c882001-08-29 23:54:54 +0000770 memset(obj, '\0', size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000771
Tim Peters6d6c1a32001-08-02 04:15:00 +0000772 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
773 Py_INCREF(type);
Tim Peters406fe3b2001-10-06 19:04:01 +0000774
Tim Peters6d6c1a32001-08-02 04:15:00 +0000775 if (type->tp_itemsize == 0)
776 PyObject_INIT(obj, type);
777 else
778 (void) PyObject_INIT_VAR((PyVarObject *)obj, type, nitems);
Tim Peters406fe3b2001-10-06 19:04:01 +0000779
Tim Peters6d6c1a32001-08-02 04:15:00 +0000780 if (PyType_IS_GC(type))
Neil Schemenauerc806c882001-08-29 23:54:54 +0000781 _PyObject_GC_TRACK(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000782 return obj;
783}
784
785PyObject *
786PyType_GenericNew(PyTypeObject *type, PyObject *args, PyObject *kwds)
787{
788 return type->tp_alloc(type, 0);
789}
790
Guido van Rossum9475a232001-10-05 20:51:39 +0000791/* Helpers for subtyping */
792
793static int
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000794traverse_slots(PyTypeObject *type, PyObject *self, visitproc visit, void *arg)
795{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000796 Py_ssize_t i, n;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000797 PyMemberDef *mp;
798
Christian Heimese93237d2007-12-19 02:37:44 +0000799 n = Py_SIZE(type);
Guido van Rossume5c691a2003-03-07 15:13:17 +0000800 mp = PyHeapType_GET_MEMBERS((PyHeapTypeObject *)type);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000801 for (i = 0; i < n; i++, mp++) {
802 if (mp->type == T_OBJECT_EX) {
803 char *addr = (char *)self + mp->offset;
804 PyObject *obj = *(PyObject **)addr;
805 if (obj != NULL) {
806 int err = visit(obj, arg);
807 if (err)
808 return err;
809 }
810 }
811 }
812 return 0;
813}
814
815static int
Guido van Rossum9475a232001-10-05 20:51:39 +0000816subtype_traverse(PyObject *self, visitproc visit, void *arg)
817{
818 PyTypeObject *type, *base;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000819 traverseproc basetraverse;
Guido van Rossum9475a232001-10-05 20:51:39 +0000820
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000821 /* Find the nearest base with a different tp_traverse,
822 and traverse slots while we're at it */
Christian Heimese93237d2007-12-19 02:37:44 +0000823 type = Py_TYPE(self);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000824 base = type;
825 while ((basetraverse = base->tp_traverse) == subtype_traverse) {
Christian Heimese93237d2007-12-19 02:37:44 +0000826 if (Py_SIZE(base)) {
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000827 int err = traverse_slots(base, self, visit, arg);
828 if (err)
829 return err;
830 }
Guido van Rossum9475a232001-10-05 20:51:39 +0000831 base = base->tp_base;
832 assert(base);
833 }
834
835 if (type->tp_dictoffset != base->tp_dictoffset) {
836 PyObject **dictptr = _PyObject_GetDictPtr(self);
Thomas Woutersc6e55062006-04-15 21:47:09 +0000837 if (dictptr && *dictptr)
838 Py_VISIT(*dictptr);
Guido van Rossum9475a232001-10-05 20:51:39 +0000839 }
840
Thomas Woutersc6e55062006-04-15 21:47:09 +0000841 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
Guido van Rossuma3862092002-06-10 15:24:42 +0000842 /* For a heaptype, the instances count as references
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000843 to the type. Traverse the type so the collector
Guido van Rossuma3862092002-06-10 15:24:42 +0000844 can find cycles involving this link. */
Thomas Woutersc6e55062006-04-15 21:47:09 +0000845 Py_VISIT(type);
Guido van Rossuma3862092002-06-10 15:24:42 +0000846
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000847 if (basetraverse)
848 return basetraverse(self, visit, arg);
849 return 0;
850}
851
852static void
853clear_slots(PyTypeObject *type, PyObject *self)
854{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000855 Py_ssize_t i, n;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000856 PyMemberDef *mp;
857
Christian Heimese93237d2007-12-19 02:37:44 +0000858 n = Py_SIZE(type);
Guido van Rossume5c691a2003-03-07 15:13:17 +0000859 mp = PyHeapType_GET_MEMBERS((PyHeapTypeObject *)type);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000860 for (i = 0; i < n; i++, mp++) {
861 if (mp->type == T_OBJECT_EX && !(mp->flags & READONLY)) {
862 char *addr = (char *)self + mp->offset;
863 PyObject *obj = *(PyObject **)addr;
864 if (obj != NULL) {
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000865 *(PyObject **)addr = NULL;
Thomas Woutersedf17d82006-04-15 17:28:34 +0000866 Py_DECREF(obj);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000867 }
868 }
869 }
870}
871
872static int
873subtype_clear(PyObject *self)
874{
875 PyTypeObject *type, *base;
876 inquiry baseclear;
877
878 /* Find the nearest base with a different tp_clear
879 and clear slots while we're at it */
Christian Heimese93237d2007-12-19 02:37:44 +0000880 type = Py_TYPE(self);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000881 base = type;
882 while ((baseclear = base->tp_clear) == subtype_clear) {
Christian Heimese93237d2007-12-19 02:37:44 +0000883 if (Py_SIZE(base))
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000884 clear_slots(base, self);
885 base = base->tp_base;
886 assert(base);
887 }
888
Guido van Rossuma3862092002-06-10 15:24:42 +0000889 /* There's no need to clear the instance dict (if any);
890 the collector will call its tp_clear handler. */
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000891
892 if (baseclear)
893 return baseclear(self);
Guido van Rossum9475a232001-10-05 20:51:39 +0000894 return 0;
895}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000896
897static void
898subtype_dealloc(PyObject *self)
899{
Guido van Rossum14227b42001-12-06 02:35:58 +0000900 PyTypeObject *type, *base;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000901 destructor basedealloc;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000902
Guido van Rossum22b13872002-08-06 21:41:44 +0000903 /* Extract the type; we expect it to be a heap type */
Christian Heimese93237d2007-12-19 02:37:44 +0000904 type = Py_TYPE(self);
Guido van Rossum22b13872002-08-06 21:41:44 +0000905 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000906
Guido van Rossum22b13872002-08-06 21:41:44 +0000907 /* Test whether the type has GC exactly once */
908
909 if (!PyType_IS_GC(type)) {
910 /* It's really rare to find a dynamic type that doesn't have
911 GC; it can only happen when deriving from 'object' and not
912 adding any slots or instance variables. This allows
913 certain simplifications: there's no need to call
914 clear_slots(), or DECREF the dict, or clear weakrefs. */
915
916 /* Maybe call finalizer; exit early if resurrected */
Guido van Rossumfebd61d2002-08-08 20:55:20 +0000917 if (type->tp_del) {
918 type->tp_del(self);
919 if (self->ob_refcnt > 0)
920 return;
921 }
Guido van Rossum22b13872002-08-06 21:41:44 +0000922
923 /* Find the nearest base with a different tp_dealloc */
924 base = type;
925 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
Christian Heimese93237d2007-12-19 02:37:44 +0000926 assert(Py_SIZE(base) == 0);
Guido van Rossum22b13872002-08-06 21:41:44 +0000927 base = base->tp_base;
928 assert(base);
929 }
930
931 /* Call the base tp_dealloc() */
932 assert(basedealloc);
933 basedealloc(self);
934
935 /* Can't reference self beyond this point */
936 Py_DECREF(type);
937
938 /* Done */
939 return;
940 }
941
942 /* We get here only if the type has GC */
943
944 /* UnTrack and re-Track around the trashcan macro, alas */
Andrew M. Kuchlingc9172d32003-02-06 15:22:49 +0000945 /* See explanation at end of function for full disclosure */
Guido van Rossum0906e072002-08-07 20:42:09 +0000946 PyObject_GC_UnTrack(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000947 ++_PyTrash_delete_nesting;
Guido van Rossum22b13872002-08-06 21:41:44 +0000948 Py_TRASHCAN_SAFE_BEGIN(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000949 --_PyTrash_delete_nesting;
Tim Petersf7f9e992003-11-13 21:59:32 +0000950 /* DO NOT restore GC tracking at this point. weakref callbacks
951 * (if any, and whether directly here or indirectly in something we
952 * call) may trigger GC, and if self is tracked at that point, it
953 * will look like trash to GC and GC will try to delete self again.
Tim Petersadd09b42003-11-12 20:43:28 +0000954 */
Guido van Rossum22b13872002-08-06 21:41:44 +0000955
Guido van Rossum59195fd2003-06-13 20:54:40 +0000956 /* Find the nearest base with a different tp_dealloc */
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000957 base = type;
958 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000959 base = base->tp_base;
960 assert(base);
Guido van Rossum14227b42001-12-06 02:35:58 +0000961 }
962
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000963 /* If we added a weaklist, we clear it. Do this *before* calling
Guido van Rossum59195fd2003-06-13 20:54:40 +0000964 the finalizer (__del__), clearing slots, or clearing the instance
965 dict. */
966
Guido van Rossum1987c662003-05-29 14:29:23 +0000967 if (type->tp_weaklistoffset && !base->tp_weaklistoffset)
968 PyObject_ClearWeakRefs(self);
969
970 /* Maybe call finalizer; exit early if resurrected */
971 if (type->tp_del) {
Tim Petersf7f9e992003-11-13 21:59:32 +0000972 _PyObject_GC_TRACK(self);
Guido van Rossum1987c662003-05-29 14:29:23 +0000973 type->tp_del(self);
974 if (self->ob_refcnt > 0)
Tim Petersf7f9e992003-11-13 21:59:32 +0000975 goto endlabel; /* resurrected */
976 else
977 _PyObject_GC_UNTRACK(self);
Brett Cannonf5bee302007-01-23 23:21:22 +0000978 /* New weakrefs could be created during the finalizer call.
979 If this occurs, clear them out without calling their
980 finalizers since they might rely on part of the object
981 being finalized that has already been destroyed. */
982 if (type->tp_weaklistoffset && !base->tp_weaklistoffset) {
983 /* Modeled after GET_WEAKREFS_LISTPTR() */
984 PyWeakReference **list = (PyWeakReference **) \
985 PyObject_GET_WEAKREFS_LISTPTR(self);
986 while (*list)
987 _PyWeakref_ClearRef(*list);
988 }
Guido van Rossum1987c662003-05-29 14:29:23 +0000989 }
990
Guido van Rossum59195fd2003-06-13 20:54:40 +0000991 /* Clear slots up to the nearest base with a different tp_dealloc */
992 base = type;
993 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
Christian Heimese93237d2007-12-19 02:37:44 +0000994 if (Py_SIZE(base))
Guido van Rossum59195fd2003-06-13 20:54:40 +0000995 clear_slots(base, self);
996 base = base->tp_base;
997 assert(base);
998 }
999
Tim Peters6d6c1a32001-08-02 04:15:00 +00001000 /* If we added a dict, DECREF it */
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001001 if (type->tp_dictoffset && !base->tp_dictoffset) {
1002 PyObject **dictptr = _PyObject_GetDictPtr(self);
1003 if (dictptr != NULL) {
1004 PyObject *dict = *dictptr;
1005 if (dict != NULL) {
1006 Py_DECREF(dict);
1007 *dictptr = NULL;
1008 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001009 }
1010 }
1011
Tim Peters0bd743c2003-11-13 22:50:00 +00001012 /* Call the base tp_dealloc(); first retrack self if
1013 * basedealloc knows about gc.
1014 */
1015 if (PyType_IS_GC(base))
1016 _PyObject_GC_TRACK(self);
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001017 assert(basedealloc);
1018 basedealloc(self);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001019
1020 /* Can't reference self beyond this point */
Guido van Rossum22b13872002-08-06 21:41:44 +00001021 Py_DECREF(type);
1022
Guido van Rossum0906e072002-08-07 20:42:09 +00001023 endlabel:
Guido van Rossumce8bcd82003-02-05 22:39:45 +00001024 ++_PyTrash_delete_nesting;
Guido van Rossum22b13872002-08-06 21:41:44 +00001025 Py_TRASHCAN_SAFE_END(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +00001026 --_PyTrash_delete_nesting;
1027
1028 /* Explanation of the weirdness around the trashcan macros:
1029
1030 Q. What do the trashcan macros do?
1031
1032 A. Read the comment titled "Trashcan mechanism" in object.h.
1033 For one, this explains why there must be a call to GC-untrack
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001034 before the trashcan begin macro. Without understanding the
Guido van Rossumce8bcd82003-02-05 22:39:45 +00001035 trashcan code, the answers to the following questions don't make
1036 sense.
1037
1038 Q. Why do we GC-untrack before the trashcan and then immediately
1039 GC-track again afterward?
1040
1041 A. In the case that the base class is GC-aware, the base class
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001042 probably GC-untracks the object. If it does that using the
Guido van Rossumce8bcd82003-02-05 22:39:45 +00001043 UNTRACK macro, this will crash when the object is already
1044 untracked. Because we don't know what the base class does, the
1045 only safe thing is to make sure the object is tracked when we
1046 call the base class dealloc. But... The trashcan begin macro
1047 requires that the object is *untracked* before it is called. So
1048 the dance becomes:
1049
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001050 GC untrack
Guido van Rossumce8bcd82003-02-05 22:39:45 +00001051 trashcan begin
1052 GC track
1053
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001054 Q. Why did the last question say "immediately GC-track again"?
1055 It's nowhere near immediately.
Tim Petersf7f9e992003-11-13 21:59:32 +00001056
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001057 A. Because the code *used* to re-track immediately. Bad Idea.
1058 self has a refcount of 0, and if gc ever gets its hands on it
1059 (which can happen if any weakref callback gets invoked), it
1060 looks like trash to gc too, and gc also tries to delete self
1061 then. But we're already deleting self. Double dealloction is
1062 a subtle disaster.
Tim Petersf7f9e992003-11-13 21:59:32 +00001063
Guido van Rossumce8bcd82003-02-05 22:39:45 +00001064 Q. Why the bizarre (net-zero) manipulation of
1065 _PyTrash_delete_nesting around the trashcan macros?
1066
1067 A. Some base classes (e.g. list) also use the trashcan mechanism.
1068 The following scenario used to be possible:
1069
1070 - suppose the trashcan level is one below the trashcan limit
1071
1072 - subtype_dealloc() is called
1073
1074 - the trashcan limit is not yet reached, so the trashcan level
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001075 is incremented and the code between trashcan begin and end is
1076 executed
Guido van Rossumce8bcd82003-02-05 22:39:45 +00001077
1078 - this destroys much of the object's contents, including its
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001079 slots and __dict__
Guido van Rossumce8bcd82003-02-05 22:39:45 +00001080
1081 - basedealloc() is called; this is really list_dealloc(), or
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001082 some other type which also uses the trashcan macros
Guido van Rossumce8bcd82003-02-05 22:39:45 +00001083
1084 - the trashcan limit is now reached, so the object is put on the
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001085 trashcan's to-be-deleted-later list
Guido van Rossumce8bcd82003-02-05 22:39:45 +00001086
1087 - basedealloc() returns
1088
1089 - subtype_dealloc() decrefs the object's type
1090
1091 - subtype_dealloc() returns
1092
1093 - later, the trashcan code starts deleting the objects from its
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001094 to-be-deleted-later list
Guido van Rossumce8bcd82003-02-05 22:39:45 +00001095
1096 - subtype_dealloc() is called *AGAIN* for the same object
1097
1098 - at the very least (if the destroyed slots and __dict__ don't
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001099 cause problems) the object's type gets decref'ed a second
1100 time, which is *BAD*!!!
Guido van Rossumce8bcd82003-02-05 22:39:45 +00001101
1102 The remedy is to make sure that if the code between trashcan
1103 begin and end in subtype_dealloc() is called, the code between
1104 trashcan begin and end in basedealloc() will also be called.
1105 This is done by decrementing the level after passing into the
1106 trashcan block, and incrementing it just before leaving the
1107 block.
1108
1109 But now it's possible that a chain of objects consisting solely
1110 of objects whose deallocator is subtype_dealloc() will defeat
1111 the trashcan mechanism completely: the decremented level means
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001112 that the effective level never reaches the limit. Therefore, we
Guido van Rossumce8bcd82003-02-05 22:39:45 +00001113 *increment* the level *before* entering the trashcan block, and
1114 matchingly decrement it after leaving. This means the trashcan
1115 code will trigger a little early, but that's no big deal.
1116
1117 Q. Are there any live examples of code in need of all this
1118 complexity?
1119
1120 A. Yes. See SF bug 668433 for code that crashed (when Python was
1121 compiled in debug mode) before the trashcan level manipulations
1122 were added. For more discussion, see SF patches 581742, 575073
1123 and bug 574207.
1124 */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001125}
1126
Jeremy Hylton938ace62002-07-17 16:30:39 +00001127static PyTypeObject *solid_base(PyTypeObject *type);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001128
Tim Peters6d6c1a32001-08-02 04:15:00 +00001129/* type test with subclassing support */
1130
1131int
1132PyType_IsSubtype(PyTypeObject *a, PyTypeObject *b)
1133{
1134 PyObject *mro;
1135
Guido van Rossum9478d072001-09-07 18:52:13 +00001136 if (!(a->tp_flags & Py_TPFLAGS_HAVE_CLASS))
1137 return b == a || b == &PyBaseObject_Type;
1138
Tim Peters6d6c1a32001-08-02 04:15:00 +00001139 mro = a->tp_mro;
1140 if (mro != NULL) {
1141 /* Deal with multiple inheritance without recursion
1142 by walking the MRO tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001143 Py_ssize_t i, n;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001144 assert(PyTuple_Check(mro));
1145 n = PyTuple_GET_SIZE(mro);
1146 for (i = 0; i < n; i++) {
1147 if (PyTuple_GET_ITEM(mro, i) == (PyObject *)b)
1148 return 1;
1149 }
1150 return 0;
1151 }
1152 else {
1153 /* a is not completely initilized yet; follow tp_base */
1154 do {
1155 if (a == b)
1156 return 1;
1157 a = a->tp_base;
1158 } while (a != NULL);
1159 return b == &PyBaseObject_Type;
1160 }
1161}
1162
Guido van Rossumf21c6be2001-09-14 17:51:50 +00001163/* Internal routines to do a method lookup in the type
Guido van Rossum60718732001-08-28 17:47:51 +00001164 without looking in the instance dictionary
1165 (so we can't use PyObject_GetAttr) but still binding
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001166 it to the instance. The arguments are the object,
Guido van Rossum60718732001-08-28 17:47:51 +00001167 the method name as a C string, and the address of a
Guido van Rossumf21c6be2001-09-14 17:51:50 +00001168 static variable used to cache the interned Python string.
1169
1170 Two variants:
1171
1172 - lookup_maybe() returns NULL without raising an exception
1173 when the _PyType_Lookup() call fails;
1174
1175 - lookup_method() always raises an exception upon errors.
1176*/
Guido van Rossum60718732001-08-28 17:47:51 +00001177
1178static PyObject *
Guido van Rossumf21c6be2001-09-14 17:51:50 +00001179lookup_maybe(PyObject *self, char *attrstr, PyObject **attrobj)
Guido van Rossum60718732001-08-28 17:47:51 +00001180{
1181 PyObject *res;
1182
1183 if (*attrobj == NULL) {
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001184 *attrobj = PyString_InternFromString(attrstr);
Guido van Rossum60718732001-08-28 17:47:51 +00001185 if (*attrobj == NULL)
1186 return NULL;
1187 }
Christian Heimese93237d2007-12-19 02:37:44 +00001188 res = _PyType_Lookup(Py_TYPE(self), *attrobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +00001189 if (res != NULL) {
Guido van Rossum60718732001-08-28 17:47:51 +00001190 descrgetfunc f;
Christian Heimese93237d2007-12-19 02:37:44 +00001191 if ((f = Py_TYPE(res)->tp_descr_get) == NULL)
Guido van Rossum60718732001-08-28 17:47:51 +00001192 Py_INCREF(res);
1193 else
Christian Heimese93237d2007-12-19 02:37:44 +00001194 res = f(res, self, (PyObject *)(Py_TYPE(self)));
Guido van Rossum60718732001-08-28 17:47:51 +00001195 }
1196 return res;
1197}
1198
Guido van Rossumf21c6be2001-09-14 17:51:50 +00001199static PyObject *
1200lookup_method(PyObject *self, char *attrstr, PyObject **attrobj)
1201{
1202 PyObject *res = lookup_maybe(self, attrstr, attrobj);
1203 if (res == NULL && !PyErr_Occurred())
1204 PyErr_SetObject(PyExc_AttributeError, *attrobj);
1205 return res;
1206}
1207
Guido van Rossum2730b132001-08-28 18:22:14 +00001208/* A variation of PyObject_CallMethod that uses lookup_method()
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001209 instead of PyObject_GetAttrString(). This uses the same convention
Guido van Rossum2730b132001-08-28 18:22:14 +00001210 as lookup_method to cache the interned name string object. */
1211
Neil Schemenauerf23473f2001-10-21 22:28:58 +00001212static PyObject *
Guido van Rossum2730b132001-08-28 18:22:14 +00001213call_method(PyObject *o, char *name, PyObject **nameobj, char *format, ...)
1214{
1215 va_list va;
1216 PyObject *args, *func = 0, *retval;
Guido van Rossum2730b132001-08-28 18:22:14 +00001217 va_start(va, format);
1218
Guido van Rossumda21c012001-10-03 00:50:18 +00001219 func = lookup_maybe(o, name, nameobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +00001220 if (func == NULL) {
1221 va_end(va);
1222 if (!PyErr_Occurred())
Guido van Rossumda21c012001-10-03 00:50:18 +00001223 PyErr_SetObject(PyExc_AttributeError, *nameobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +00001224 return NULL;
1225 }
Guido van Rossumf21c6be2001-09-14 17:51:50 +00001226
1227 if (format && *format)
1228 args = Py_VaBuildValue(format, va);
1229 else
1230 args = PyTuple_New(0);
1231
1232 va_end(va);
1233
1234 if (args == NULL)
1235 return NULL;
1236
1237 assert(PyTuple_Check(args));
1238 retval = PyObject_Call(func, args, NULL);
1239
1240 Py_DECREF(args);
1241 Py_DECREF(func);
1242
1243 return retval;
1244}
1245
1246/* Clone of call_method() that returns NotImplemented when the lookup fails. */
1247
Neil Schemenauerf23473f2001-10-21 22:28:58 +00001248static PyObject *
Guido van Rossumf21c6be2001-09-14 17:51:50 +00001249call_maybe(PyObject *o, char *name, PyObject **nameobj, char *format, ...)
1250{
1251 va_list va;
1252 PyObject *args, *func = 0, *retval;
Guido van Rossumf21c6be2001-09-14 17:51:50 +00001253 va_start(va, format);
1254
Guido van Rossumda21c012001-10-03 00:50:18 +00001255 func = lookup_maybe(o, name, nameobj);
Guido van Rossum2730b132001-08-28 18:22:14 +00001256 if (func == NULL) {
1257 va_end(va);
Guido van Rossumf21c6be2001-09-14 17:51:50 +00001258 if (!PyErr_Occurred()) {
1259 Py_INCREF(Py_NotImplemented);
1260 return Py_NotImplemented;
1261 }
Guido van Rossum717ce002001-09-14 16:58:08 +00001262 return NULL;
Guido van Rossum2730b132001-08-28 18:22:14 +00001263 }
1264
1265 if (format && *format)
1266 args = Py_VaBuildValue(format, va);
1267 else
1268 args = PyTuple_New(0);
1269
1270 va_end(va);
1271
Guido van Rossum717ce002001-09-14 16:58:08 +00001272 if (args == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00001273 return NULL;
1274
Guido van Rossum717ce002001-09-14 16:58:08 +00001275 assert(PyTuple_Check(args));
1276 retval = PyObject_Call(func, args, NULL);
Guido van Rossum2730b132001-08-28 18:22:14 +00001277
1278 Py_DECREF(args);
1279 Py_DECREF(func);
1280
1281 return retval;
1282}
1283
Tim Petersa91e9642001-11-14 23:32:33 +00001284static int
1285fill_classic_mro(PyObject *mro, PyObject *cls)
1286{
1287 PyObject *bases, *base;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001288 Py_ssize_t i, n;
Tim Petersa91e9642001-11-14 23:32:33 +00001289
1290 assert(PyList_Check(mro));
1291 assert(PyClass_Check(cls));
1292 i = PySequence_Contains(mro, cls);
1293 if (i < 0)
1294 return -1;
1295 if (!i) {
1296 if (PyList_Append(mro, cls) < 0)
1297 return -1;
1298 }
1299 bases = ((PyClassObject *)cls)->cl_bases;
1300 assert(bases && PyTuple_Check(bases));
1301 n = PyTuple_GET_SIZE(bases);
1302 for (i = 0; i < n; i++) {
1303 base = PyTuple_GET_ITEM(bases, i);
1304 if (fill_classic_mro(mro, base) < 0)
1305 return -1;
1306 }
1307 return 0;
1308}
1309
1310static PyObject *
1311classic_mro(PyObject *cls)
1312{
1313 PyObject *mro;
1314
1315 assert(PyClass_Check(cls));
1316 mro = PyList_New(0);
1317 if (mro != NULL) {
1318 if (fill_classic_mro(mro, cls) == 0)
1319 return mro;
1320 Py_DECREF(mro);
1321 }
1322 return NULL;
1323}
1324
Tim Petersea7f75d2002-12-07 21:39:16 +00001325/*
Guido van Rossum1f121312002-11-14 19:49:16 +00001326 Method resolution order algorithm C3 described in
1327 "A Monotonic Superclass Linearization for Dylan",
1328 by Kim Barrett, Bob Cassel, Paul Haahr,
Tim Petersea7f75d2002-12-07 21:39:16 +00001329 David A. Moon, Keith Playford, and P. Tucker Withington.
Guido van Rossum1f121312002-11-14 19:49:16 +00001330 (OOPSLA 1996)
1331
Guido van Rossum98f33732002-11-25 21:36:54 +00001332 Some notes about the rules implied by C3:
1333
Tim Petersea7f75d2002-12-07 21:39:16 +00001334 No duplicate bases.
Guido van Rossum98f33732002-11-25 21:36:54 +00001335 It isn't legal to repeat a class in a list of base classes.
1336
1337 The next three properties are the 3 constraints in "C3".
1338
Tim Petersea7f75d2002-12-07 21:39:16 +00001339 Local precendece order.
Guido van Rossum98f33732002-11-25 21:36:54 +00001340 If A precedes B in C's MRO, then A will precede B in the MRO of all
1341 subclasses of C.
1342
1343 Monotonicity.
1344 The MRO of a class must be an extension without reordering of the
1345 MRO of each of its superclasses.
1346
1347 Extended Precedence Graph (EPG).
1348 Linearization is consistent if there is a path in the EPG from
1349 each class to all its successors in the linearization. See
1350 the paper for definition of EPG.
Guido van Rossum1f121312002-11-14 19:49:16 +00001351 */
1352
Tim Petersea7f75d2002-12-07 21:39:16 +00001353static int
Guido van Rossum1f121312002-11-14 19:49:16 +00001354tail_contains(PyObject *list, int whence, PyObject *o) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001355 Py_ssize_t j, size;
Guido van Rossum1f121312002-11-14 19:49:16 +00001356 size = PyList_GET_SIZE(list);
1357
1358 for (j = whence+1; j < size; j++) {
1359 if (PyList_GET_ITEM(list, j) == o)
1360 return 1;
1361 }
1362 return 0;
1363}
1364
Guido van Rossum98f33732002-11-25 21:36:54 +00001365static PyObject *
1366class_name(PyObject *cls)
1367{
1368 PyObject *name = PyObject_GetAttrString(cls, "__name__");
1369 if (name == NULL) {
1370 PyErr_Clear();
1371 Py_XDECREF(name);
1372 name = PyObject_Repr(cls);
1373 }
1374 if (name == NULL)
1375 return NULL;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001376 if (!PyString_Check(name)) {
Guido van Rossum98f33732002-11-25 21:36:54 +00001377 Py_DECREF(name);
1378 return NULL;
1379 }
1380 return name;
1381}
1382
1383static int
1384check_duplicates(PyObject *list)
1385{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001386 Py_ssize_t i, j, n;
Guido van Rossum98f33732002-11-25 21:36:54 +00001387 /* Let's use a quadratic time algorithm,
1388 assuming that the bases lists is short.
1389 */
1390 n = PyList_GET_SIZE(list);
1391 for (i = 0; i < n; i++) {
1392 PyObject *o = PyList_GET_ITEM(list, i);
1393 for (j = i + 1; j < n; j++) {
1394 if (PyList_GET_ITEM(list, j) == o) {
1395 o = class_name(o);
1396 PyErr_Format(PyExc_TypeError,
1397 "duplicate base class %s",
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001398 o ? PyString_AS_STRING(o) : "?");
Guido van Rossum98f33732002-11-25 21:36:54 +00001399 Py_XDECREF(o);
1400 return -1;
1401 }
1402 }
1403 }
1404 return 0;
1405}
1406
1407/* Raise a TypeError for an MRO order disagreement.
1408
1409 It's hard to produce a good error message. In the absence of better
1410 insight into error reporting, report the classes that were candidates
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001411 to be put next into the MRO. There is some conflict between the
Guido van Rossum98f33732002-11-25 21:36:54 +00001412 order in which they should be put in the MRO, but it's hard to
1413 diagnose what constraint can't be satisfied.
1414*/
1415
1416static void
1417set_mro_error(PyObject *to_merge, int *remain)
1418{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001419 Py_ssize_t i, n, off, to_merge_size;
Guido van Rossum98f33732002-11-25 21:36:54 +00001420 char buf[1000];
1421 PyObject *k, *v;
1422 PyObject *set = PyDict_New();
Georg Brandl5c170fd2006-03-17 19:03:25 +00001423 if (!set) return;
Guido van Rossum98f33732002-11-25 21:36:54 +00001424
1425 to_merge_size = PyList_GET_SIZE(to_merge);
1426 for (i = 0; i < to_merge_size; i++) {
1427 PyObject *L = PyList_GET_ITEM(to_merge, i);
1428 if (remain[i] < PyList_GET_SIZE(L)) {
1429 PyObject *c = PyList_GET_ITEM(L, remain[i]);
Georg Brandl5c170fd2006-03-17 19:03:25 +00001430 if (PyDict_SetItem(set, c, Py_None) < 0) {
1431 Py_DECREF(set);
Guido van Rossum98f33732002-11-25 21:36:54 +00001432 return;
Georg Brandl5c170fd2006-03-17 19:03:25 +00001433 }
Guido van Rossum98f33732002-11-25 21:36:54 +00001434 }
1435 }
1436 n = PyDict_Size(set);
1437
Raymond Hettingerf394df42003-04-06 19:13:41 +00001438 off = PyOS_snprintf(buf, sizeof(buf), "Cannot create a \
1439consistent method resolution\norder (MRO) for bases");
Guido van Rossum98f33732002-11-25 21:36:54 +00001440 i = 0;
Skip Montanaro429433b2006-04-18 00:35:43 +00001441 while (PyDict_Next(set, &i, &k, &v) && (size_t)off < sizeof(buf)) {
Guido van Rossum98f33732002-11-25 21:36:54 +00001442 PyObject *name = class_name(k);
1443 off += PyOS_snprintf(buf + off, sizeof(buf) - off, " %s",
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001444 name ? PyString_AS_STRING(name) : "?");
Guido van Rossum98f33732002-11-25 21:36:54 +00001445 Py_XDECREF(name);
Skip Montanaro429433b2006-04-18 00:35:43 +00001446 if (--n && (size_t)(off+1) < sizeof(buf)) {
Guido van Rossum98f33732002-11-25 21:36:54 +00001447 buf[off++] = ',';
1448 buf[off] = '\0';
1449 }
1450 }
1451 PyErr_SetString(PyExc_TypeError, buf);
1452 Py_DECREF(set);
1453}
1454
Tim Petersea7f75d2002-12-07 21:39:16 +00001455static int
Guido van Rossum1f121312002-11-14 19:49:16 +00001456pmerge(PyObject *acc, PyObject* to_merge) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001457 Py_ssize_t i, j, to_merge_size, empty_cnt;
Guido van Rossum1f121312002-11-14 19:49:16 +00001458 int *remain;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001459 int ok;
Tim Petersea7f75d2002-12-07 21:39:16 +00001460
Guido van Rossum1f121312002-11-14 19:49:16 +00001461 to_merge_size = PyList_GET_SIZE(to_merge);
1462
Guido van Rossum98f33732002-11-25 21:36:54 +00001463 /* remain stores an index into each sublist of to_merge.
1464 remain[i] is the index of the next base in to_merge[i]
1465 that is not included in acc.
1466 */
Anthony Baxtera6286212006-04-11 07:42:36 +00001467 remain = (int *)PyMem_MALLOC(SIZEOF_INT*to_merge_size);
Guido van Rossum1f121312002-11-14 19:49:16 +00001468 if (remain == NULL)
1469 return -1;
1470 for (i = 0; i < to_merge_size; i++)
1471 remain[i] = 0;
1472
1473 again:
1474 empty_cnt = 0;
1475 for (i = 0; i < to_merge_size; i++) {
1476 PyObject *candidate;
Tim Petersea7f75d2002-12-07 21:39:16 +00001477
Guido van Rossum1f121312002-11-14 19:49:16 +00001478 PyObject *cur_list = PyList_GET_ITEM(to_merge, i);
1479
1480 if (remain[i] >= PyList_GET_SIZE(cur_list)) {
1481 empty_cnt++;
1482 continue;
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001483 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001484
Guido van Rossum98f33732002-11-25 21:36:54 +00001485 /* Choose next candidate for MRO.
1486
1487 The input sequences alone can determine the choice.
1488 If not, choose the class which appears in the MRO
1489 of the earliest direct superclass of the new class.
1490 */
1491
Guido van Rossum1f121312002-11-14 19:49:16 +00001492 candidate = PyList_GET_ITEM(cur_list, remain[i]);
1493 for (j = 0; j < to_merge_size; j++) {
1494 PyObject *j_lst = PyList_GET_ITEM(to_merge, j);
Guido van Rossum98f33732002-11-25 21:36:54 +00001495 if (tail_contains(j_lst, remain[j], candidate)) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001496 goto skip; /* continue outer loop */
Guido van Rossum98f33732002-11-25 21:36:54 +00001497 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001498 }
1499 ok = PyList_Append(acc, candidate);
1500 if (ok < 0) {
1501 PyMem_Free(remain);
1502 return -1;
1503 }
1504 for (j = 0; j < to_merge_size; j++) {
1505 PyObject *j_lst = PyList_GET_ITEM(to_merge, j);
Guido van Rossum768158c2002-12-31 16:33:01 +00001506 if (remain[j] < PyList_GET_SIZE(j_lst) &&
1507 PyList_GET_ITEM(j_lst, remain[j]) == candidate) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001508 remain[j]++;
1509 }
1510 }
1511 goto again;
Tim Peters9a6b8d82002-11-14 23:22:33 +00001512 skip: ;
Guido van Rossum1f121312002-11-14 19:49:16 +00001513 }
1514
Guido van Rossum98f33732002-11-25 21:36:54 +00001515 if (empty_cnt == to_merge_size) {
1516 PyMem_FREE(remain);
Guido van Rossum1f121312002-11-14 19:49:16 +00001517 return 0;
Guido van Rossum98f33732002-11-25 21:36:54 +00001518 }
1519 set_mro_error(to_merge, remain);
1520 PyMem_FREE(remain);
Guido van Rossum1f121312002-11-14 19:49:16 +00001521 return -1;
1522}
1523
Tim Peters6d6c1a32001-08-02 04:15:00 +00001524static PyObject *
1525mro_implementation(PyTypeObject *type)
1526{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001527 Py_ssize_t i, n;
1528 int ok;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001529 PyObject *bases, *result;
Guido van Rossum1f121312002-11-14 19:49:16 +00001530 PyObject *to_merge, *bases_aslist;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001531
Neal Norwitze7bb9182008-01-27 17:10:14 +00001532 if (type->tp_dict == NULL) {
1533 if (PyType_Ready(type) < 0)
Guido van Rossum63517572002-06-18 16:44:57 +00001534 return NULL;
1535 }
1536
Guido van Rossum98f33732002-11-25 21:36:54 +00001537 /* Find a superclass linearization that honors the constraints
1538 of the explicit lists of bases and the constraints implied by
Tim Petersea7f75d2002-12-07 21:39:16 +00001539 each base class.
Guido van Rossum98f33732002-11-25 21:36:54 +00001540
1541 to_merge is a list of lists, where each list is a superclass
1542 linearization implied by a base class. The last element of
1543 to_merge is the declared list of bases.
1544 */
1545
Tim Peters6d6c1a32001-08-02 04:15:00 +00001546 bases = type->tp_bases;
1547 n = PyTuple_GET_SIZE(bases);
Guido van Rossum1f121312002-11-14 19:49:16 +00001548
1549 to_merge = PyList_New(n+1);
1550 if (to_merge == NULL)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001551 return NULL;
Guido van Rossum1f121312002-11-14 19:49:16 +00001552
Tim Peters6d6c1a32001-08-02 04:15:00 +00001553 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00001554 PyObject *base = PyTuple_GET_ITEM(bases, i);
1555 PyObject *parentMRO;
1556 if (PyType_Check(base))
1557 parentMRO = PySequence_List(
1558 ((PyTypeObject*)base)->tp_mro);
1559 else
1560 parentMRO = classic_mro(base);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001561 if (parentMRO == NULL) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001562 Py_DECREF(to_merge);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001563 return NULL;
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001564 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001565
1566 PyList_SET_ITEM(to_merge, i, parentMRO);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001567 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001568
1569 bases_aslist = PySequence_List(bases);
1570 if (bases_aslist == NULL) {
1571 Py_DECREF(to_merge);
1572 return NULL;
1573 }
Guido van Rossum98f33732002-11-25 21:36:54 +00001574 /* This is just a basic sanity check. */
1575 if (check_duplicates(bases_aslist) < 0) {
1576 Py_DECREF(to_merge);
1577 Py_DECREF(bases_aslist);
1578 return NULL;
1579 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001580 PyList_SET_ITEM(to_merge, n, bases_aslist);
1581
1582 result = Py_BuildValue("[O]", (PyObject *)type);
1583 if (result == NULL) {
1584 Py_DECREF(to_merge);
1585 return NULL;
1586 }
1587
1588 ok = pmerge(result, to_merge);
1589 Py_DECREF(to_merge);
1590 if (ok < 0) {
1591 Py_DECREF(result);
1592 return NULL;
1593 }
1594
Tim Peters6d6c1a32001-08-02 04:15:00 +00001595 return result;
1596}
1597
1598static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001599mro_external(PyObject *self)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001600{
1601 PyTypeObject *type = (PyTypeObject *)self;
1602
Tim Peters6d6c1a32001-08-02 04:15:00 +00001603 return mro_implementation(type);
1604}
1605
1606static int
1607mro_internal(PyTypeObject *type)
1608{
1609 PyObject *mro, *result, *tuple;
Armin Rigo037d1e02005-12-29 17:07:39 +00001610 int checkit = 0;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001611
Christian Heimese93237d2007-12-19 02:37:44 +00001612 if (Py_TYPE(type) == &PyType_Type) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001613 result = mro_implementation(type);
1614 }
1615 else {
Guido van Rossum60718732001-08-28 17:47:51 +00001616 static PyObject *mro_str;
Armin Rigo037d1e02005-12-29 17:07:39 +00001617 checkit = 1;
Guido van Rossum60718732001-08-28 17:47:51 +00001618 mro = lookup_method((PyObject *)type, "mro", &mro_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001619 if (mro == NULL)
1620 return -1;
1621 result = PyObject_CallObject(mro, NULL);
1622 Py_DECREF(mro);
1623 }
1624 if (result == NULL)
1625 return -1;
1626 tuple = PySequence_Tuple(result);
1627 Py_DECREF(result);
Armin Rigo037d1e02005-12-29 17:07:39 +00001628 if (tuple == NULL)
1629 return -1;
1630 if (checkit) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001631 Py_ssize_t i, len;
Armin Rigo037d1e02005-12-29 17:07:39 +00001632 PyObject *cls;
1633 PyTypeObject *solid;
1634
1635 solid = solid_base(type);
1636
1637 len = PyTuple_GET_SIZE(tuple);
1638
1639 for (i = 0; i < len; i++) {
1640 PyTypeObject *t;
1641 cls = PyTuple_GET_ITEM(tuple, i);
1642 if (PyClass_Check(cls))
1643 continue;
1644 else if (!PyType_Check(cls)) {
1645 PyErr_Format(PyExc_TypeError,
1646 "mro() returned a non-class ('%.500s')",
Christian Heimese93237d2007-12-19 02:37:44 +00001647 Py_TYPE(cls)->tp_name);
Neal Norwitz50bf51a2006-01-02 02:46:54 +00001648 Py_DECREF(tuple);
Armin Rigo037d1e02005-12-29 17:07:39 +00001649 return -1;
1650 }
1651 t = (PyTypeObject*)cls;
1652 if (!PyType_IsSubtype(solid, solid_base(t))) {
1653 PyErr_Format(PyExc_TypeError,
1654 "mro() returned base with unsuitable layout ('%.500s')",
1655 t->tp_name);
Neal Norwitz50bf51a2006-01-02 02:46:54 +00001656 Py_DECREF(tuple);
Armin Rigo037d1e02005-12-29 17:07:39 +00001657 return -1;
1658 }
1659 }
1660 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001661 type->tp_mro = tuple;
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +00001662
1663 type_mro_modified(type, type->tp_mro);
1664 /* corner case: the old-style super class might have been hidden
1665 from the custom MRO */
1666 type_mro_modified(type, type->tp_bases);
1667
Georg Brandl74a1dea2008-05-28 11:21:39 +00001668 PyType_Modified(type);
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +00001669
Tim Peters6d6c1a32001-08-02 04:15:00 +00001670 return 0;
1671}
1672
1673
1674/* Calculate the best base amongst multiple base classes.
Armin Rigoc0ba52d2007-04-19 14:44:48 +00001675 This is the first one that's on the path to the "solid base". */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001676
1677static PyTypeObject *
1678best_base(PyObject *bases)
1679{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001680 Py_ssize_t i, n;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001681 PyTypeObject *base, *winner, *candidate, *base_i;
Tim Petersa91e9642001-11-14 23:32:33 +00001682 PyObject *base_proto;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001683
1684 assert(PyTuple_Check(bases));
1685 n = PyTuple_GET_SIZE(bases);
1686 assert(n > 0);
Tim Petersa91e9642001-11-14 23:32:33 +00001687 base = NULL;
1688 winner = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001689 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00001690 base_proto = PyTuple_GET_ITEM(bases, i);
1691 if (PyClass_Check(base_proto))
1692 continue;
Armin Rigoc0ba52d2007-04-19 14:44:48 +00001693 if (!PyType_Check(base_proto)) {
1694 PyErr_SetString(
1695 PyExc_TypeError,
1696 "bases must be types");
1697 return NULL;
1698 }
Tim Petersa91e9642001-11-14 23:32:33 +00001699 base_i = (PyTypeObject *)base_proto;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001700 if (base_i->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001701 if (PyType_Ready(base_i) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001702 return NULL;
1703 }
1704 candidate = solid_base(base_i);
Tim Petersa91e9642001-11-14 23:32:33 +00001705 if (winner == NULL) {
1706 winner = candidate;
1707 base = base_i;
1708 }
1709 else if (PyType_IsSubtype(winner, candidate))
Tim Peters6d6c1a32001-08-02 04:15:00 +00001710 ;
1711 else if (PyType_IsSubtype(candidate, winner)) {
1712 winner = candidate;
1713 base = base_i;
1714 }
1715 else {
1716 PyErr_SetString(
1717 PyExc_TypeError,
1718 "multiple bases have "
1719 "instance lay-out conflict");
1720 return NULL;
1721 }
1722 }
Guido van Rossume54616c2001-12-14 04:19:56 +00001723 if (base == NULL)
1724 PyErr_SetString(PyExc_TypeError,
1725 "a new-style class can't have only classic bases");
Tim Peters6d6c1a32001-08-02 04:15:00 +00001726 return base;
1727}
1728
1729static int
1730extra_ivars(PyTypeObject *type, PyTypeObject *base)
1731{
Neil Schemenauerc806c882001-08-29 23:54:54 +00001732 size_t t_size = type->tp_basicsize;
1733 size_t b_size = base->tp_basicsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001734
Guido van Rossum9676b222001-08-17 20:32:36 +00001735 assert(t_size >= b_size); /* Else type smaller than base! */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001736 if (type->tp_itemsize || base->tp_itemsize) {
1737 /* If itemsize is involved, stricter rules */
1738 return t_size != b_size ||
1739 type->tp_itemsize != base->tp_itemsize;
1740 }
Guido van Rossum9676b222001-08-17 20:32:36 +00001741 if (type->tp_weaklistoffset && base->tp_weaklistoffset == 0 &&
Armin Rigo9790a272007-05-02 19:23:31 +00001742 type->tp_weaklistoffset + sizeof(PyObject *) == t_size &&
1743 type->tp_flags & Py_TPFLAGS_HEAPTYPE)
Guido van Rossum9676b222001-08-17 20:32:36 +00001744 t_size -= sizeof(PyObject *);
1745 if (type->tp_dictoffset && base->tp_dictoffset == 0 &&
Armin Rigo9790a272007-05-02 19:23:31 +00001746 type->tp_dictoffset + sizeof(PyObject *) == t_size &&
1747 type->tp_flags & Py_TPFLAGS_HEAPTYPE)
Guido van Rossum9676b222001-08-17 20:32:36 +00001748 t_size -= sizeof(PyObject *);
1749
1750 return t_size != b_size;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001751}
1752
1753static PyTypeObject *
1754solid_base(PyTypeObject *type)
1755{
1756 PyTypeObject *base;
1757
1758 if (type->tp_base)
1759 base = solid_base(type->tp_base);
1760 else
1761 base = &PyBaseObject_Type;
1762 if (extra_ivars(type, base))
1763 return type;
1764 else
1765 return base;
1766}
1767
Jeremy Hylton938ace62002-07-17 16:30:39 +00001768static void object_dealloc(PyObject *);
1769static int object_init(PyObject *, PyObject *, PyObject *);
1770static int update_slot(PyTypeObject *, PyObject *);
1771static void fixup_slot_dispatchers(PyTypeObject *);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001772
Armin Rigo9790a272007-05-02 19:23:31 +00001773/*
1774 * Helpers for __dict__ descriptor. We don't want to expose the dicts
1775 * inherited from various builtin types. The builtin base usually provides
1776 * its own __dict__ descriptor, so we use that when we can.
1777 */
1778static PyTypeObject *
1779get_builtin_base_with_dict(PyTypeObject *type)
1780{
1781 while (type->tp_base != NULL) {
1782 if (type->tp_dictoffset != 0 &&
1783 !(type->tp_flags & Py_TPFLAGS_HEAPTYPE))
1784 return type;
1785 type = type->tp_base;
1786 }
1787 return NULL;
1788}
1789
1790static PyObject *
1791get_dict_descriptor(PyTypeObject *type)
1792{
1793 static PyObject *dict_str;
1794 PyObject *descr;
1795
1796 if (dict_str == NULL) {
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001797 dict_str = PyString_InternFromString("__dict__");
Armin Rigo9790a272007-05-02 19:23:31 +00001798 if (dict_str == NULL)
1799 return NULL;
1800 }
1801 descr = _PyType_Lookup(type, dict_str);
1802 if (descr == NULL || !PyDescr_IsData(descr))
1803 return NULL;
1804
1805 return descr;
1806}
1807
1808static void
1809raise_dict_descr_error(PyObject *obj)
1810{
1811 PyErr_Format(PyExc_TypeError,
1812 "this __dict__ descriptor does not support "
1813 "'%.200s' objects", obj->ob_type->tp_name);
1814}
1815
Tim Peters6d6c1a32001-08-02 04:15:00 +00001816static PyObject *
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001817subtype_dict(PyObject *obj, void *context)
1818{
Armin Rigo9790a272007-05-02 19:23:31 +00001819 PyObject **dictptr;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001820 PyObject *dict;
Armin Rigo9790a272007-05-02 19:23:31 +00001821 PyTypeObject *base;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001822
Armin Rigo9790a272007-05-02 19:23:31 +00001823 base = get_builtin_base_with_dict(obj->ob_type);
1824 if (base != NULL) {
1825 descrgetfunc func;
1826 PyObject *descr = get_dict_descriptor(base);
1827 if (descr == NULL) {
1828 raise_dict_descr_error(obj);
1829 return NULL;
1830 }
1831 func = descr->ob_type->tp_descr_get;
1832 if (func == NULL) {
1833 raise_dict_descr_error(obj);
1834 return NULL;
1835 }
1836 return func(descr, obj, (PyObject *)(obj->ob_type));
1837 }
1838
1839 dictptr = _PyObject_GetDictPtr(obj);
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001840 if (dictptr == NULL) {
1841 PyErr_SetString(PyExc_AttributeError,
1842 "This object has no __dict__");
1843 return NULL;
1844 }
1845 dict = *dictptr;
Guido van Rossum3926a632001-09-25 16:25:58 +00001846 if (dict == NULL)
1847 *dictptr = dict = PyDict_New();
1848 Py_XINCREF(dict);
1849 return dict;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001850}
1851
Guido van Rossum6661be32001-10-26 04:26:12 +00001852static int
1853subtype_setdict(PyObject *obj, PyObject *value, void *context)
1854{
Armin Rigo9790a272007-05-02 19:23:31 +00001855 PyObject **dictptr;
Guido van Rossum6661be32001-10-26 04:26:12 +00001856 PyObject *dict;
Armin Rigo9790a272007-05-02 19:23:31 +00001857 PyTypeObject *base;
Guido van Rossum6661be32001-10-26 04:26:12 +00001858
Armin Rigo9790a272007-05-02 19:23:31 +00001859 base = get_builtin_base_with_dict(obj->ob_type);
1860 if (base != NULL) {
1861 descrsetfunc func;
1862 PyObject *descr = get_dict_descriptor(base);
1863 if (descr == NULL) {
1864 raise_dict_descr_error(obj);
1865 return -1;
1866 }
1867 func = descr->ob_type->tp_descr_set;
1868 if (func == NULL) {
1869 raise_dict_descr_error(obj);
1870 return -1;
1871 }
1872 return func(descr, obj, value);
1873 }
1874
1875 dictptr = _PyObject_GetDictPtr(obj);
Guido van Rossum6661be32001-10-26 04:26:12 +00001876 if (dictptr == NULL) {
1877 PyErr_SetString(PyExc_AttributeError,
1878 "This object has no __dict__");
1879 return -1;
1880 }
Guido van Rossumd331cb52001-12-05 19:46:42 +00001881 if (value != NULL && !PyDict_Check(value)) {
Georg Brandlccff7852006-06-18 22:17:29 +00001882 PyErr_Format(PyExc_TypeError,
1883 "__dict__ must be set to a dictionary, "
Christian Heimese93237d2007-12-19 02:37:44 +00001884 "not a '%.200s'", Py_TYPE(value)->tp_name);
Guido van Rossum6661be32001-10-26 04:26:12 +00001885 return -1;
1886 }
1887 dict = *dictptr;
Guido van Rossumd331cb52001-12-05 19:46:42 +00001888 Py_XINCREF(value);
Guido van Rossum6661be32001-10-26 04:26:12 +00001889 *dictptr = value;
1890 Py_XDECREF(dict);
1891 return 0;
1892}
1893
Guido van Rossumad47da02002-08-12 19:05:44 +00001894static PyObject *
1895subtype_getweakref(PyObject *obj, void *context)
1896{
1897 PyObject **weaklistptr;
1898 PyObject *result;
1899
Christian Heimese93237d2007-12-19 02:37:44 +00001900 if (Py_TYPE(obj)->tp_weaklistoffset == 0) {
Guido van Rossumad47da02002-08-12 19:05:44 +00001901 PyErr_SetString(PyExc_AttributeError,
Fred Drake7a36f5f2006-08-04 05:17:21 +00001902 "This object has no __weakref__");
Guido van Rossumad47da02002-08-12 19:05:44 +00001903 return NULL;
1904 }
Christian Heimese93237d2007-12-19 02:37:44 +00001905 assert(Py_TYPE(obj)->tp_weaklistoffset > 0);
1906 assert(Py_TYPE(obj)->tp_weaklistoffset + sizeof(PyObject *) <=
1907 (size_t)(Py_TYPE(obj)->tp_basicsize));
Guido van Rossumad47da02002-08-12 19:05:44 +00001908 weaklistptr = (PyObject **)
Christian Heimese93237d2007-12-19 02:37:44 +00001909 ((char *)obj + Py_TYPE(obj)->tp_weaklistoffset);
Guido van Rossumad47da02002-08-12 19:05:44 +00001910 if (*weaklistptr == NULL)
1911 result = Py_None;
1912 else
1913 result = *weaklistptr;
1914 Py_INCREF(result);
1915 return result;
1916}
1917
Guido van Rossum373c7412003-01-07 13:41:37 +00001918/* Three variants on the subtype_getsets list. */
1919
1920static PyGetSetDef subtype_getsets_full[] = {
Guido van Rossumad47da02002-08-12 19:05:44 +00001921 {"__dict__", subtype_dict, subtype_setdict,
Neal Norwitz858e34f2002-08-13 17:18:45 +00001922 PyDoc_STR("dictionary for instance variables (if defined)")},
Guido van Rossumad47da02002-08-12 19:05:44 +00001923 {"__weakref__", subtype_getweakref, NULL,
Neal Norwitz858e34f2002-08-13 17:18:45 +00001924 PyDoc_STR("list of weak references to the object (if defined)")},
Guido van Rossumad47da02002-08-12 19:05:44 +00001925 {0}
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001926};
1927
Guido van Rossum373c7412003-01-07 13:41:37 +00001928static PyGetSetDef subtype_getsets_dict_only[] = {
1929 {"__dict__", subtype_dict, subtype_setdict,
1930 PyDoc_STR("dictionary for instance variables (if defined)")},
1931 {0}
1932};
1933
1934static PyGetSetDef subtype_getsets_weakref_only[] = {
1935 {"__weakref__", subtype_getweakref, NULL,
1936 PyDoc_STR("list of weak references to the object (if defined)")},
1937 {0}
1938};
1939
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001940static int
1941valid_identifier(PyObject *s)
1942{
Guido van Rossum03013a02002-07-16 14:30:28 +00001943 unsigned char *p;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001944 Py_ssize_t i, n;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001945
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001946 if (!PyString_Check(s)) {
Georg Brandlccff7852006-06-18 22:17:29 +00001947 PyErr_Format(PyExc_TypeError,
1948 "__slots__ items must be strings, not '%.200s'",
Christian Heimese93237d2007-12-19 02:37:44 +00001949 Py_TYPE(s)->tp_name);
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001950 return 0;
1951 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001952 p = (unsigned char *) PyString_AS_STRING(s);
1953 n = PyString_GET_SIZE(s);
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001954 /* We must reject an empty name. As a hack, we bump the
1955 length to 1 so that the loop will balk on the trailing \0. */
1956 if (n == 0)
1957 n = 1;
1958 for (i = 0; i < n; i++, p++) {
1959 if (!(i == 0 ? isalpha(*p) : isalnum(*p)) && *p != '_') {
1960 PyErr_SetString(PyExc_TypeError,
1961 "__slots__ must be identifiers");
1962 return 0;
1963 }
1964 }
1965 return 1;
1966}
1967
Martin v. Löwisd919a592002-10-14 21:07:28 +00001968#ifdef Py_USING_UNICODE
1969/* Replace Unicode objects in slots. */
1970
1971static PyObject *
Martin v. Löwiseb079f12006-02-16 14:32:27 +00001972_unicode_to_string(PyObject *slots, Py_ssize_t nslots)
Martin v. Löwisd919a592002-10-14 21:07:28 +00001973{
Žiga Seilnacht71436f02007-03-14 12:24:09 +00001974 PyObject *tmp = NULL;
1975 PyObject *slot_name, *new_name;
Martin v. Löwiseb079f12006-02-16 14:32:27 +00001976 Py_ssize_t i;
Žiga Seilnacht71436f02007-03-14 12:24:09 +00001977
Martin v. Löwisd919a592002-10-14 21:07:28 +00001978 for (i = 0; i < nslots; i++) {
Žiga Seilnacht71436f02007-03-14 12:24:09 +00001979 if (PyUnicode_Check(slot_name = PyTuple_GET_ITEM(slots, i))) {
1980 if (tmp == NULL) {
1981 tmp = PySequence_List(slots);
Martin v. Löwisd919a592002-10-14 21:07:28 +00001982 if (tmp == NULL)
1983 return NULL;
1984 }
Žiga Seilnacht71436f02007-03-14 12:24:09 +00001985 new_name = _PyUnicode_AsDefaultEncodedString(slot_name,
1986 NULL);
1987 if (new_name == NULL) {
Martin v. Löwisd919a592002-10-14 21:07:28 +00001988 Py_DECREF(tmp);
Žiga Seilnacht71436f02007-03-14 12:24:09 +00001989 return NULL;
Martin v. Löwisd919a592002-10-14 21:07:28 +00001990 }
Žiga Seilnacht71436f02007-03-14 12:24:09 +00001991 Py_INCREF(new_name);
1992 PyList_SET_ITEM(tmp, i, new_name);
1993 Py_DECREF(slot_name);
Martin v. Löwisd919a592002-10-14 21:07:28 +00001994 }
1995 }
Žiga Seilnacht71436f02007-03-14 12:24:09 +00001996 if (tmp != NULL) {
1997 slots = PyList_AsTuple(tmp);
1998 Py_DECREF(tmp);
1999 }
2000 return slots;
Martin v. Löwisd919a592002-10-14 21:07:28 +00002001}
2002#endif
2003
Guido van Rossumf102e242007-03-23 18:53:03 +00002004/* Forward */
2005static int
2006object_init(PyObject *self, PyObject *args, PyObject *kwds);
2007
2008static int
2009type_init(PyObject *cls, PyObject *args, PyObject *kwds)
2010{
2011 int res;
2012
2013 assert(args != NULL && PyTuple_Check(args));
2014 assert(kwds == NULL || PyDict_Check(kwds));
2015
2016 if (kwds != NULL && PyDict_Check(kwds) && PyDict_Size(kwds) != 0) {
2017 PyErr_SetString(PyExc_TypeError,
2018 "type.__init__() takes no keyword arguments");
2019 return -1;
2020 }
2021
2022 if (args != NULL && PyTuple_Check(args) &&
2023 (PyTuple_GET_SIZE(args) != 1 && PyTuple_GET_SIZE(args) != 3)) {
2024 PyErr_SetString(PyExc_TypeError,
2025 "type.__init__() takes 1 or 3 arguments");
2026 return -1;
2027 }
2028
2029 /* Call object.__init__(self) now. */
2030 /* XXX Could call super(type, cls).__init__() but what's the point? */
2031 args = PyTuple_GetSlice(args, 0, 0);
2032 res = object_init(cls, args, NULL);
2033 Py_DECREF(args);
2034 return res;
2035}
2036
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00002037static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00002038type_new(PyTypeObject *metatype, PyObject *args, PyObject *kwds)
2039{
2040 PyObject *name, *bases, *dict;
Martin v. Löwis15e62742006-02-27 16:46:16 +00002041 static char *kwlist[] = {"name", "bases", "dict", 0};
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00002042 PyObject *slots, *tmp, *newslots;
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00002043 PyTypeObject *type, *base, *tmptype, *winner;
Guido van Rossume5c691a2003-03-07 15:13:17 +00002044 PyHeapTypeObject *et;
Guido van Rossum6f799372001-09-20 20:46:19 +00002045 PyMemberDef *mp;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002046 Py_ssize_t i, nbases, nslots, slotoffset, add_dict, add_weak;
Guido van Rossumad47da02002-08-12 19:05:44 +00002047 int j, may_add_dict, may_add_weak;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002048
Tim Peters3abca122001-10-27 19:37:48 +00002049 assert(args != NULL && PyTuple_Check(args));
2050 assert(kwds == NULL || PyDict_Check(kwds));
2051
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00002052 /* Special case: type(x) should return x->ob_type */
Tim Peters3abca122001-10-27 19:37:48 +00002053 {
Martin v. Löwis18e16552006-02-15 17:27:45 +00002054 const Py_ssize_t nargs = PyTuple_GET_SIZE(args);
2055 const Py_ssize_t nkwds = kwds == NULL ? 0 : PyDict_Size(kwds);
Tim Peters3abca122001-10-27 19:37:48 +00002056
2057 if (PyType_CheckExact(metatype) && nargs == 1 && nkwds == 0) {
2058 PyObject *x = PyTuple_GET_ITEM(args, 0);
Christian Heimese93237d2007-12-19 02:37:44 +00002059 Py_INCREF(Py_TYPE(x));
2060 return (PyObject *) Py_TYPE(x);
Tim Peters3abca122001-10-27 19:37:48 +00002061 }
2062
2063 /* SF bug 475327 -- if that didn't trigger, we need 3
2064 arguments. but PyArg_ParseTupleAndKeywords below may give
2065 a msg saying type() needs exactly 3. */
2066 if (nargs + nkwds != 3) {
2067 PyErr_SetString(PyExc_TypeError,
2068 "type() takes 1 or 3 arguments");
2069 return NULL;
2070 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002071 }
2072
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00002073 /* Check arguments: (name, bases, dict) */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002074 if (!PyArg_ParseTupleAndKeywords(args, kwds, "SO!O!:type", kwlist,
2075 &name,
2076 &PyTuple_Type, &bases,
2077 &PyDict_Type, &dict))
2078 return NULL;
2079
Armin Rigoc0ba52d2007-04-19 14:44:48 +00002080 /* Determine the proper metatype to deal with this,
2081 and check for metatype conflicts while we're at it.
2082 Note that if some other metatype wins to contract,
2083 it's possible that its instances are not types. */
2084 nbases = PyTuple_GET_SIZE(bases);
2085 winner = metatype;
2086 for (i = 0; i < nbases; i++) {
2087 tmp = PyTuple_GET_ITEM(bases, i);
2088 tmptype = tmp->ob_type;
2089 if (tmptype == &PyClass_Type)
2090 continue; /* Special case classic classes */
2091 if (PyType_IsSubtype(winner, tmptype))
2092 continue;
2093 if (PyType_IsSubtype(tmptype, winner)) {
2094 winner = tmptype;
2095 continue;
Jeremy Hyltonfa955692007-02-27 18:29:45 +00002096 }
Armin Rigoc0ba52d2007-04-19 14:44:48 +00002097 PyErr_SetString(PyExc_TypeError,
2098 "metaclass conflict: "
2099 "the metaclass of a derived class "
2100 "must be a (non-strict) subclass "
2101 "of the metaclasses of all its bases");
2102 return NULL;
2103 }
2104 if (winner != metatype) {
2105 if (winner->tp_new != type_new) /* Pass it to the winner */
2106 return winner->tp_new(winner, args, kwds);
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00002107 metatype = winner;
2108 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002109
2110 /* Adjust for empty tuple bases */
2111 if (nbases == 0) {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002112 bases = PyTuple_Pack(1, &PyBaseObject_Type);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002113 if (bases == NULL)
2114 return NULL;
2115 nbases = 1;
2116 }
2117 else
2118 Py_INCREF(bases);
2119
2120 /* XXX From here until type is allocated, "return NULL" leaks bases! */
2121
2122 /* Calculate best base, and check that all bases are type objects */
2123 base = best_base(bases);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00002124 if (base == NULL) {
2125 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002126 return NULL;
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00002127 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002128 if (!PyType_HasFeature(base, Py_TPFLAGS_BASETYPE)) {
2129 PyErr_Format(PyExc_TypeError,
2130 "type '%.100s' is not an acceptable base type",
2131 base->tp_name);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00002132 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002133 return NULL;
2134 }
2135
Tim Peters6d6c1a32001-08-02 04:15:00 +00002136 /* Check for a __slots__ sequence variable in dict, and count it */
2137 slots = PyDict_GetItemString(dict, "__slots__");
2138 nslots = 0;
Guido van Rossum9676b222001-08-17 20:32:36 +00002139 add_dict = 0;
2140 add_weak = 0;
Guido van Rossumad47da02002-08-12 19:05:44 +00002141 may_add_dict = base->tp_dictoffset == 0;
2142 may_add_weak = base->tp_weaklistoffset == 0 && base->tp_itemsize == 0;
2143 if (slots == NULL) {
2144 if (may_add_dict) {
2145 add_dict++;
2146 }
2147 if (may_add_weak) {
2148 add_weak++;
2149 }
2150 }
2151 else {
2152 /* Have slots */
2153
Tim Peters6d6c1a32001-08-02 04:15:00 +00002154 /* Make it into a tuple */
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002155 if (PyString_Check(slots) || PyUnicode_Check(slots))
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002156 slots = PyTuple_Pack(1, slots);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002157 else
2158 slots = PySequence_Tuple(slots);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00002159 if (slots == NULL) {
2160 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002161 return NULL;
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00002162 }
Guido van Rossumad47da02002-08-12 19:05:44 +00002163 assert(PyTuple_Check(slots));
2164
2165 /* Are slots allowed? */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002166 nslots = PyTuple_GET_SIZE(slots);
Jeremy Hylton1c7a0ea2003-07-16 16:08:23 +00002167 if (nslots > 0 && base->tp_itemsize != 0) {
Guido van Rossumc4141872001-08-30 04:43:35 +00002168 PyErr_Format(PyExc_TypeError,
2169 "nonempty __slots__ "
2170 "not supported for subtype of '%s'",
2171 base->tp_name);
Guido van Rossumad47da02002-08-12 19:05:44 +00002172 bad_slots:
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00002173 Py_DECREF(bases);
Guido van Rossumad47da02002-08-12 19:05:44 +00002174 Py_DECREF(slots);
Guido van Rossumc4141872001-08-30 04:43:35 +00002175 return NULL;
2176 }
Guido van Rossumad47da02002-08-12 19:05:44 +00002177
Martin v. Löwisd919a592002-10-14 21:07:28 +00002178#ifdef Py_USING_UNICODE
2179 tmp = _unicode_to_string(slots, nslots);
Žiga Seilnacht71436f02007-03-14 12:24:09 +00002180 if (tmp == NULL)
2181 goto bad_slots;
Martin v. Löwis13b1a5c2002-10-14 21:11:34 +00002182 if (tmp != slots) {
2183 Py_DECREF(slots);
2184 slots = tmp;
2185 }
Martin v. Löwisd919a592002-10-14 21:07:28 +00002186#endif
Guido van Rossumad47da02002-08-12 19:05:44 +00002187 /* Check for valid slot names and two special cases */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002188 for (i = 0; i < nslots; i++) {
Guido van Rossumad47da02002-08-12 19:05:44 +00002189 PyObject *tmp = PyTuple_GET_ITEM(slots, i);
2190 char *s;
2191 if (!valid_identifier(tmp))
2192 goto bad_slots;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002193 assert(PyString_Check(tmp));
2194 s = PyString_AS_STRING(tmp);
Guido van Rossumad47da02002-08-12 19:05:44 +00002195 if (strcmp(s, "__dict__") == 0) {
2196 if (!may_add_dict || add_dict) {
2197 PyErr_SetString(PyExc_TypeError,
2198 "__dict__ slot disallowed: "
2199 "we already got one");
2200 goto bad_slots;
2201 }
2202 add_dict++;
2203 }
2204 if (strcmp(s, "__weakref__") == 0) {
2205 if (!may_add_weak || add_weak) {
2206 PyErr_SetString(PyExc_TypeError,
2207 "__weakref__ slot disallowed: "
2208 "either we already got one, "
2209 "or __itemsize__ != 0");
2210 goto bad_slots;
2211 }
2212 add_weak++;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002213 }
2214 }
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00002215
Žiga Seilnacht6f2d09c2007-03-16 11:59:38 +00002216 /* Copy slots into a list, mangle names and sort them.
2217 Sorted names are needed for __class__ assignment.
2218 Convert them back to tuple at the end.
2219 */
2220 newslots = PyList_New(nslots - add_dict - add_weak);
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00002221 if (newslots == NULL)
Guido van Rossumad47da02002-08-12 19:05:44 +00002222 goto bad_slots;
2223 for (i = j = 0; i < nslots; i++) {
2224 char *s;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00002225 tmp = PyTuple_GET_ITEM(slots, i);
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002226 s = PyString_AS_STRING(tmp);
Guido van Rossumad47da02002-08-12 19:05:44 +00002227 if ((add_dict && strcmp(s, "__dict__") == 0) ||
2228 (add_weak && strcmp(s, "__weakref__") == 0))
2229 continue;
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00002230 tmp =_Py_Mangle(name, tmp);
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002231 if (!tmp)
2232 goto bad_slots;
Žiga Seilnacht6f2d09c2007-03-16 11:59:38 +00002233 PyList_SET_ITEM(newslots, j, tmp);
Guido van Rossumad47da02002-08-12 19:05:44 +00002234 j++;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00002235 }
Guido van Rossumad47da02002-08-12 19:05:44 +00002236 assert(j == nslots - add_dict - add_weak);
2237 nslots = j;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00002238 Py_DECREF(slots);
Žiga Seilnacht6f2d09c2007-03-16 11:59:38 +00002239 if (PyList_Sort(newslots) == -1) {
2240 Py_DECREF(bases);
2241 Py_DECREF(newslots);
2242 return NULL;
2243 }
2244 slots = PyList_AsTuple(newslots);
2245 Py_DECREF(newslots);
2246 if (slots == NULL) {
2247 Py_DECREF(bases);
2248 return NULL;
2249 }
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00002250
Guido van Rossumad47da02002-08-12 19:05:44 +00002251 /* Secondary bases may provide weakrefs or dict */
2252 if (nbases > 1 &&
2253 ((may_add_dict && !add_dict) ||
2254 (may_add_weak && !add_weak))) {
2255 for (i = 0; i < nbases; i++) {
2256 tmp = PyTuple_GET_ITEM(bases, i);
2257 if (tmp == (PyObject *)base)
2258 continue; /* Skip primary base */
2259 if (PyClass_Check(tmp)) {
2260 /* Classic base class provides both */
2261 if (may_add_dict && !add_dict)
2262 add_dict++;
2263 if (may_add_weak && !add_weak)
2264 add_weak++;
2265 break;
2266 }
2267 assert(PyType_Check(tmp));
2268 tmptype = (PyTypeObject *)tmp;
2269 if (may_add_dict && !add_dict &&
2270 tmptype->tp_dictoffset != 0)
2271 add_dict++;
2272 if (may_add_weak && !add_weak &&
2273 tmptype->tp_weaklistoffset != 0)
2274 add_weak++;
2275 if (may_add_dict && !add_dict)
2276 continue;
2277 if (may_add_weak && !add_weak)
2278 continue;
2279 /* Nothing more to check */
2280 break;
2281 }
2282 }
Guido van Rossum9676b222001-08-17 20:32:36 +00002283 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002284
2285 /* XXX From here until type is safely allocated,
2286 "return NULL" may leak slots! */
2287
2288 /* Allocate the type object */
2289 type = (PyTypeObject *)metatype->tp_alloc(metatype, nslots);
Guido van Rossumad47da02002-08-12 19:05:44 +00002290 if (type == NULL) {
2291 Py_XDECREF(slots);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00002292 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002293 return NULL;
Guido van Rossumad47da02002-08-12 19:05:44 +00002294 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002295
2296 /* Keep name and slots alive in the extended type object */
Guido van Rossume5c691a2003-03-07 15:13:17 +00002297 et = (PyHeapTypeObject *)type;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002298 Py_INCREF(name);
Georg Brandlc255c7b2006-02-20 22:27:28 +00002299 et->ht_name = name;
2300 et->ht_slots = slots;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002301
Guido van Rossumdc91b992001-08-08 22:26:22 +00002302 /* Initialize tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002303 type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HEAPTYPE |
2304 Py_TPFLAGS_BASETYPE;
Guido van Rossum048eb752001-10-02 21:24:57 +00002305 if (base->tp_flags & Py_TPFLAGS_HAVE_GC)
2306 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
Guido van Rossumdc91b992001-08-08 22:26:22 +00002307
2308 /* It's a new-style number unless it specifically inherits any
2309 old-style numeric behavior */
2310 if ((base->tp_flags & Py_TPFLAGS_CHECKTYPES) ||
2311 (base->tp_as_number == NULL))
2312 type->tp_flags |= Py_TPFLAGS_CHECKTYPES;
2313
2314 /* Initialize essential fields */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002315 type->tp_as_number = &et->as_number;
2316 type->tp_as_sequence = &et->as_sequence;
2317 type->tp_as_mapping = &et->as_mapping;
2318 type->tp_as_buffer = &et->as_buffer;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002319 type->tp_name = PyString_AS_STRING(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002320
2321 /* Set tp_base and tp_bases */
2322 type->tp_bases = bases;
2323 Py_INCREF(base);
2324 type->tp_base = base;
2325
Guido van Rossum687ae002001-10-15 22:03:32 +00002326 /* Initialize tp_dict from passed-in dict */
2327 type->tp_dict = dict = PyDict_Copy(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002328 if (dict == NULL) {
2329 Py_DECREF(type);
2330 return NULL;
2331 }
2332
Guido van Rossumc3542212001-08-16 09:18:56 +00002333 /* Set __module__ in the dict */
2334 if (PyDict_GetItemString(dict, "__module__") == NULL) {
2335 tmp = PyEval_GetGlobals();
2336 if (tmp != NULL) {
2337 tmp = PyDict_GetItemString(tmp, "__name__");
2338 if (tmp != NULL) {
2339 if (PyDict_SetItemString(dict, "__module__",
2340 tmp) < 0)
2341 return NULL;
2342 }
2343 }
2344 }
2345
Tim Peters2f93e282001-10-04 05:27:00 +00002346 /* Set tp_doc to a copy of dict['__doc__'], if the latter is there
Tim Peters24008312002-03-17 18:56:20 +00002347 and is a string. The __doc__ accessor will first look for tp_doc;
2348 if that fails, it will still look into __dict__.
Tim Peters2f93e282001-10-04 05:27:00 +00002349 */
2350 {
2351 PyObject *doc = PyDict_GetItemString(dict, "__doc__");
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002352 if (doc != NULL && PyString_Check(doc)) {
2353 const size_t n = (size_t)PyString_GET_SIZE(doc);
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002354 char *tp_doc = (char *)PyObject_MALLOC(n+1);
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002355 if (tp_doc == NULL) {
Tim Peters2f93e282001-10-04 05:27:00 +00002356 Py_DECREF(type);
2357 return NULL;
2358 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002359 memcpy(tp_doc, PyString_AS_STRING(doc), n+1);
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002360 type->tp_doc = tp_doc;
Tim Peters2f93e282001-10-04 05:27:00 +00002361 }
2362 }
2363
Tim Peters6d6c1a32001-08-02 04:15:00 +00002364 /* Special-case __new__: if it's a plain function,
2365 make it a static function */
2366 tmp = PyDict_GetItemString(dict, "__new__");
2367 if (tmp != NULL && PyFunction_Check(tmp)) {
2368 tmp = PyStaticMethod_New(tmp);
2369 if (tmp == NULL) {
2370 Py_DECREF(type);
2371 return NULL;
2372 }
2373 PyDict_SetItemString(dict, "__new__", tmp);
2374 Py_DECREF(tmp);
2375 }
2376
2377 /* Add descriptors for custom slots from __slots__, or for __dict__ */
Guido van Rossume5c691a2003-03-07 15:13:17 +00002378 mp = PyHeapType_GET_MEMBERS(et);
Neil Schemenauerc806c882001-08-29 23:54:54 +00002379 slotoffset = base->tp_basicsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002380 if (slots != NULL) {
2381 for (i = 0; i < nslots; i++, mp++) {
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002382 mp->name = PyString_AS_STRING(
Tim Peters6d6c1a32001-08-02 04:15:00 +00002383 PyTuple_GET_ITEM(slots, i));
Guido van Rossum64b206c2001-12-04 17:13:22 +00002384 mp->type = T_OBJECT_EX;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002385 mp->offset = slotoffset;
Žiga Seilnacht89032082007-03-11 15:54:54 +00002386
2387 /* __dict__ and __weakref__ are already filtered out */
2388 assert(strcmp(mp->name, "__dict__") != 0);
2389 assert(strcmp(mp->name, "__weakref__") != 0);
2390
Tim Peters6d6c1a32001-08-02 04:15:00 +00002391 slotoffset += sizeof(PyObject *);
2392 }
2393 }
Guido van Rossumad47da02002-08-12 19:05:44 +00002394 if (add_dict) {
2395 if (base->tp_itemsize)
2396 type->tp_dictoffset = -(long)sizeof(PyObject *);
2397 else
2398 type->tp_dictoffset = slotoffset;
2399 slotoffset += sizeof(PyObject *);
2400 }
2401 if (add_weak) {
2402 assert(!base->tp_itemsize);
2403 type->tp_weaklistoffset = slotoffset;
2404 slotoffset += sizeof(PyObject *);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002405 }
2406 type->tp_basicsize = slotoffset;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00002407 type->tp_itemsize = base->tp_itemsize;
Guido van Rossume5c691a2003-03-07 15:13:17 +00002408 type->tp_members = PyHeapType_GET_MEMBERS(et);
Guido van Rossum373c7412003-01-07 13:41:37 +00002409
2410 if (type->tp_weaklistoffset && type->tp_dictoffset)
2411 type->tp_getset = subtype_getsets_full;
2412 else if (type->tp_weaklistoffset && !type->tp_dictoffset)
2413 type->tp_getset = subtype_getsets_weakref_only;
2414 else if (!type->tp_weaklistoffset && type->tp_dictoffset)
2415 type->tp_getset = subtype_getsets_dict_only;
2416 else
2417 type->tp_getset = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002418
2419 /* Special case some slots */
2420 if (type->tp_dictoffset != 0 || nslots > 0) {
2421 if (base->tp_getattr == NULL && base->tp_getattro == NULL)
2422 type->tp_getattro = PyObject_GenericGetAttr;
2423 if (base->tp_setattr == NULL && base->tp_setattro == NULL)
2424 type->tp_setattro = PyObject_GenericSetAttr;
2425 }
2426 type->tp_dealloc = subtype_dealloc;
2427
Guido van Rossum9475a232001-10-05 20:51:39 +00002428 /* Enable GC unless there are really no instance variables possible */
2429 if (!(type->tp_basicsize == sizeof(PyObject) &&
2430 type->tp_itemsize == 0))
2431 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
2432
Tim Peters6d6c1a32001-08-02 04:15:00 +00002433 /* Always override allocation strategy to use regular heap */
2434 type->tp_alloc = PyType_GenericAlloc;
Guido van Rossum048eb752001-10-02 21:24:57 +00002435 if (type->tp_flags & Py_TPFLAGS_HAVE_GC) {
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00002436 type->tp_free = PyObject_GC_Del;
Guido van Rossum9475a232001-10-05 20:51:39 +00002437 type->tp_traverse = subtype_traverse;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00002438 type->tp_clear = subtype_clear;
Guido van Rossum048eb752001-10-02 21:24:57 +00002439 }
2440 else
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00002441 type->tp_free = PyObject_Del;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002442
2443 /* Initialize the rest */
Guido van Rossum528b7eb2001-08-07 17:24:28 +00002444 if (PyType_Ready(type) < 0) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00002445 Py_DECREF(type);
2446 return NULL;
2447 }
2448
Guido van Rossum7b9144b2001-10-09 19:39:46 +00002449 /* Put the proper slots in place */
2450 fixup_slot_dispatchers(type);
Guido van Rossumf040ede2001-08-07 16:40:56 +00002451
Tim Peters6d6c1a32001-08-02 04:15:00 +00002452 return (PyObject *)type;
2453}
2454
2455/* Internal API to look for a name through the MRO.
2456 This returns a borrowed reference, and doesn't set an exception! */
2457PyObject *
2458_PyType_Lookup(PyTypeObject *type, PyObject *name)
2459{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002460 Py_ssize_t i, n;
Georg Brandlf18a7072008-05-29 14:35:39 +00002461 PyObject *mro, *res, *base, *dict;
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +00002462 unsigned int h;
2463
2464 if (MCACHE_CACHEABLE_NAME(name) &&
Neal Norwitze7bb9182008-01-27 17:10:14 +00002465 PyType_HasFeature(type, Py_TPFLAGS_VALID_VERSION_TAG)) {
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +00002466 /* fast path */
2467 h = MCACHE_HASH_METHOD(type, name);
2468 if (method_cache[h].version == type->tp_version_tag &&
2469 method_cache[h].name == name)
2470 return method_cache[h].value;
2471 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002472
Guido van Rossum687ae002001-10-15 22:03:32 +00002473 /* Look in tp_dict of types in MRO */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002474 mro = type->tp_mro;
Guido van Rossum23094982002-06-10 14:30:43 +00002475
2476 /* If mro is NULL, the type is either not yet initialized
2477 by PyType_Ready(), or already cleared by type_clear().
2478 Either way the safest thing to do is to return NULL. */
2479 if (mro == NULL)
2480 return NULL;
2481
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +00002482 res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002483 assert(PyTuple_Check(mro));
2484 n = PyTuple_GET_SIZE(mro);
2485 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00002486 base = PyTuple_GET_ITEM(mro, i);
2487 if (PyClass_Check(base))
2488 dict = ((PyClassObject *)base)->cl_dict;
2489 else {
2490 assert(PyType_Check(base));
2491 dict = ((PyTypeObject *)base)->tp_dict;
2492 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002493 assert(dict && PyDict_Check(dict));
2494 res = PyDict_GetItem(dict, name);
2495 if (res != NULL)
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +00002496 break;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002497 }
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +00002498
2499 if (MCACHE_CACHEABLE_NAME(name) && assign_version_tag(type)) {
2500 h = MCACHE_HASH_METHOD(type, name);
2501 method_cache[h].version = type->tp_version_tag;
2502 method_cache[h].value = res; /* borrowed */
2503 Py_INCREF(name);
Georg Brandlf18a7072008-05-29 14:35:39 +00002504 Py_DECREF(method_cache[h].name);
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +00002505 method_cache[h].name = name;
2506 }
2507 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002508}
2509
2510/* This is similar to PyObject_GenericGetAttr(),
2511 but uses _PyType_Lookup() instead of just looking in type->tp_dict. */
2512static PyObject *
2513type_getattro(PyTypeObject *type, PyObject *name)
2514{
Christian Heimese93237d2007-12-19 02:37:44 +00002515 PyTypeObject *metatype = Py_TYPE(type);
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002516 PyObject *meta_attribute, *attribute;
2517 descrgetfunc meta_get;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002518
2519 /* Initialize this type (we'll assume the metatype is initialized) */
2520 if (type->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00002521 if (PyType_Ready(type) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002522 return NULL;
2523 }
2524
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002525 /* No readable descriptor found yet */
2526 meta_get = NULL;
Tim Peters34592512002-07-11 06:23:50 +00002527
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002528 /* Look for the attribute in the metatype */
2529 meta_attribute = _PyType_Lookup(metatype, name);
2530
2531 if (meta_attribute != NULL) {
Christian Heimese93237d2007-12-19 02:37:44 +00002532 meta_get = Py_TYPE(meta_attribute)->tp_descr_get;
Tim Peters34592512002-07-11 06:23:50 +00002533
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002534 if (meta_get != NULL && PyDescr_IsData(meta_attribute)) {
2535 /* Data descriptors implement tp_descr_set to intercept
2536 * writes. Assume the attribute is not overridden in
2537 * type's tp_dict (and bases): call the descriptor now.
2538 */
2539 return meta_get(meta_attribute, (PyObject *)type,
2540 (PyObject *)metatype);
2541 }
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002542 Py_INCREF(meta_attribute);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002543 }
2544
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002545 /* No data descriptor found on metatype. Look in tp_dict of this
2546 * type and its bases */
2547 attribute = _PyType_Lookup(type, name);
2548 if (attribute != NULL) {
2549 /* Implement descriptor functionality, if any */
Christian Heimese93237d2007-12-19 02:37:44 +00002550 descrgetfunc local_get = Py_TYPE(attribute)->tp_descr_get;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002551
2552 Py_XDECREF(meta_attribute);
2553
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002554 if (local_get != NULL) {
2555 /* NULL 2nd argument indicates the descriptor was
2556 * found on the target object itself (or a base) */
2557 return local_get(attribute, (PyObject *)NULL,
2558 (PyObject *)type);
2559 }
Tim Peters34592512002-07-11 06:23:50 +00002560
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002561 Py_INCREF(attribute);
2562 return attribute;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002563 }
2564
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002565 /* No attribute found in local __dict__ (or bases): use the
2566 * descriptor from the metatype, if any */
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002567 if (meta_get != NULL) {
2568 PyObject *res;
2569 res = meta_get(meta_attribute, (PyObject *)type,
2570 (PyObject *)metatype);
2571 Py_DECREF(meta_attribute);
2572 return res;
2573 }
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002574
2575 /* If an ordinary attribute was found on the metatype, return it now */
2576 if (meta_attribute != NULL) {
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002577 return meta_attribute;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002578 }
2579
2580 /* Give up */
2581 PyErr_Format(PyExc_AttributeError,
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002582 "type object '%.50s' has no attribute '%.400s'",
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002583 type->tp_name, PyString_AS_STRING(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +00002584 return NULL;
2585}
2586
2587static int
2588type_setattro(PyTypeObject *type, PyObject *name, PyObject *value)
2589{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00002590 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
2591 PyErr_Format(
2592 PyExc_TypeError,
2593 "can't set attributes of built-in/extension type '%s'",
2594 type->tp_name);
2595 return -1;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00002596 }
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00002597 if (PyObject_GenericSetAttr((PyObject *)type, name, value) < 0)
2598 return -1;
2599 return update_slot(type, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002600}
2601
2602static void
2603type_dealloc(PyTypeObject *type)
2604{
Guido van Rossume5c691a2003-03-07 15:13:17 +00002605 PyHeapTypeObject *et;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002606
2607 /* Assert this is a heap-allocated type object */
2608 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002609 _PyObject_GC_UNTRACK(type);
Guido van Rossum1c450732001-10-08 15:18:27 +00002610 PyObject_ClearWeakRefs((PyObject *)type);
Guido van Rossume5c691a2003-03-07 15:13:17 +00002611 et = (PyHeapTypeObject *)type;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002612 Py_XDECREF(type->tp_base);
2613 Py_XDECREF(type->tp_dict);
2614 Py_XDECREF(type->tp_bases);
2615 Py_XDECREF(type->tp_mro);
Guido van Rossum687ae002001-10-15 22:03:32 +00002616 Py_XDECREF(type->tp_cache);
Guido van Rossum1c450732001-10-08 15:18:27 +00002617 Py_XDECREF(type->tp_subclasses);
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002618 /* A type's tp_doc is heap allocated, unlike the tp_doc slots
2619 * of most other objects. It's okay to cast it to char *.
2620 */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002621 PyObject_Free((char *)type->tp_doc);
Georg Brandlc255c7b2006-02-20 22:27:28 +00002622 Py_XDECREF(et->ht_name);
2623 Py_XDECREF(et->ht_slots);
Christian Heimese93237d2007-12-19 02:37:44 +00002624 Py_TYPE(type)->tp_free((PyObject *)type);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002625}
2626
Guido van Rossum1c450732001-10-08 15:18:27 +00002627static PyObject *
2628type_subclasses(PyTypeObject *type, PyObject *args_ignored)
2629{
2630 PyObject *list, *raw, *ref;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002631 Py_ssize_t i, n;
Guido van Rossum1c450732001-10-08 15:18:27 +00002632
2633 list = PyList_New(0);
2634 if (list == NULL)
2635 return NULL;
2636 raw = type->tp_subclasses;
2637 if (raw == NULL)
2638 return list;
2639 assert(PyList_Check(raw));
2640 n = PyList_GET_SIZE(raw);
2641 for (i = 0; i < n; i++) {
2642 ref = PyList_GET_ITEM(raw, i);
Tim Peters44383382001-10-08 16:49:26 +00002643 assert(PyWeakref_CheckRef(ref));
Guido van Rossum1c450732001-10-08 15:18:27 +00002644 ref = PyWeakref_GET_OBJECT(ref);
2645 if (ref != Py_None) {
2646 if (PyList_Append(list, ref) < 0) {
2647 Py_DECREF(list);
2648 return NULL;
2649 }
2650 }
2651 }
2652 return list;
2653}
2654
Tim Peters6d6c1a32001-08-02 04:15:00 +00002655static PyMethodDef type_methods[] = {
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002656 {"mro", (PyCFunction)mro_external, METH_NOARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002657 PyDoc_STR("mro() -> list\nreturn a type's method resolution order")},
Guido van Rossum1c450732001-10-08 15:18:27 +00002658 {"__subclasses__", (PyCFunction)type_subclasses, METH_NOARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002659 PyDoc_STR("__subclasses__() -> list of immediate subclasses")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00002660 {0}
2661};
2662
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002663PyDoc_STRVAR(type_doc,
Tim Peters6d6c1a32001-08-02 04:15:00 +00002664"type(object) -> the object's type\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002665"type(name, bases, dict) -> a new type");
Tim Peters6d6c1a32001-08-02 04:15:00 +00002666
Guido van Rossum048eb752001-10-02 21:24:57 +00002667static int
2668type_traverse(PyTypeObject *type, visitproc visit, void *arg)
2669{
Guido van Rossuma3862092002-06-10 15:24:42 +00002670 /* Because of type_is_gc(), the collector only calls this
2671 for heaptypes. */
2672 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002673
Thomas Woutersc6e55062006-04-15 21:47:09 +00002674 Py_VISIT(type->tp_dict);
2675 Py_VISIT(type->tp_cache);
2676 Py_VISIT(type->tp_mro);
2677 Py_VISIT(type->tp_bases);
2678 Py_VISIT(type->tp_base);
Guido van Rossuma3862092002-06-10 15:24:42 +00002679
2680 /* There's no need to visit type->tp_subclasses or
Georg Brandlc255c7b2006-02-20 22:27:28 +00002681 ((PyHeapTypeObject *)type)->ht_slots, because they can't be involved
Guido van Rossuma3862092002-06-10 15:24:42 +00002682 in cycles; tp_subclasses is a list of weak references,
2683 and slots is a tuple of strings. */
Guido van Rossum048eb752001-10-02 21:24:57 +00002684
Guido van Rossum048eb752001-10-02 21:24:57 +00002685 return 0;
2686}
2687
2688static int
2689type_clear(PyTypeObject *type)
2690{
Guido van Rossuma3862092002-06-10 15:24:42 +00002691 /* Because of type_is_gc(), the collector only calls this
2692 for heaptypes. */
2693 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002694
Guido van Rossuma3862092002-06-10 15:24:42 +00002695 /* The only field we need to clear is tp_mro, which is part of a
2696 hard cycle (its first element is the class itself) that won't
2697 be broken otherwise (it's a tuple and tuples don't have a
2698 tp_clear handler). None of the other fields need to be
2699 cleared, and here's why:
Guido van Rossum048eb752001-10-02 21:24:57 +00002700
Guido van Rossuma3862092002-06-10 15:24:42 +00002701 tp_dict:
2702 It is a dict, so the collector will call its tp_clear.
2703
2704 tp_cache:
2705 Not used; if it were, it would be a dict.
2706
2707 tp_bases, tp_base:
2708 If these are involved in a cycle, there must be at least
2709 one other, mutable object in the cycle, e.g. a base
2710 class's dict; the cycle will be broken that way.
2711
2712 tp_subclasses:
2713 A list of weak references can't be part of a cycle; and
2714 lists have their own tp_clear.
2715
Guido van Rossume5c691a2003-03-07 15:13:17 +00002716 slots (in PyHeapTypeObject):
Guido van Rossuma3862092002-06-10 15:24:42 +00002717 A tuple of strings can't be part of a cycle.
2718 */
2719
Thomas Woutersedf17d82006-04-15 17:28:34 +00002720 Py_CLEAR(type->tp_mro);
Guido van Rossum048eb752001-10-02 21:24:57 +00002721
2722 return 0;
2723}
2724
2725static int
2726type_is_gc(PyTypeObject *type)
2727{
2728 return type->tp_flags & Py_TPFLAGS_HEAPTYPE;
2729}
2730
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002731PyTypeObject PyType_Type = {
Martin v. Löwis68192102007-07-21 06:55:02 +00002732 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002733 "type", /* tp_name */
Guido van Rossume5c691a2003-03-07 15:13:17 +00002734 sizeof(PyHeapTypeObject), /* tp_basicsize */
Guido van Rossum6f799372001-09-20 20:46:19 +00002735 sizeof(PyMemberDef), /* tp_itemsize */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002736 (destructor)type_dealloc, /* tp_dealloc */
2737 0, /* tp_print */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002738 0, /* tp_getattr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002739 0, /* tp_setattr */
2740 type_compare, /* tp_compare */
2741 (reprfunc)type_repr, /* tp_repr */
2742 0, /* tp_as_number */
2743 0, /* tp_as_sequence */
2744 0, /* tp_as_mapping */
2745 (hashfunc)_Py_HashPointer, /* tp_hash */
2746 (ternaryfunc)type_call, /* tp_call */
2747 0, /* tp_str */
2748 (getattrofunc)type_getattro, /* tp_getattro */
2749 (setattrofunc)type_setattro, /* tp_setattro */
2750 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00002751 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
Neal Norwitzee3a1b52007-02-25 19:44:48 +00002752 Py_TPFLAGS_BASETYPE | Py_TPFLAGS_TYPE_SUBCLASS, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002753 type_doc, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +00002754 (traverseproc)type_traverse, /* tp_traverse */
2755 (inquiry)type_clear, /* tp_clear */
Steven Bethardae42f332008-03-18 17:26:10 +00002756 type_richcompare, /* tp_richcompare */
Guido van Rossum1c450732001-10-08 15:18:27 +00002757 offsetof(PyTypeObject, tp_weaklist), /* tp_weaklistoffset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002758 0, /* tp_iter */
2759 0, /* tp_iternext */
2760 type_methods, /* tp_methods */
2761 type_members, /* tp_members */
2762 type_getsets, /* tp_getset */
2763 0, /* tp_base */
2764 0, /* tp_dict */
2765 0, /* tp_descr_get */
2766 0, /* tp_descr_set */
2767 offsetof(PyTypeObject, tp_dict), /* tp_dictoffset */
Guido van Rossumf102e242007-03-23 18:53:03 +00002768 type_init, /* tp_init */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002769 0, /* tp_alloc */
2770 type_new, /* tp_new */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002771 PyObject_GC_Del, /* tp_free */
Guido van Rossum048eb752001-10-02 21:24:57 +00002772 (inquiry)type_is_gc, /* tp_is_gc */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002773};
Tim Peters6d6c1a32001-08-02 04:15:00 +00002774
2775
2776/* The base type of all types (eventually)... except itself. */
2777
Guido van Rossum143b5642007-03-23 04:58:42 +00002778/* You may wonder why object.__new__() only complains about arguments
2779 when object.__init__() is not overridden, and vice versa.
2780
2781 Consider the use cases:
2782
2783 1. When neither is overridden, we want to hear complaints about
2784 excess (i.e., any) arguments, since their presence could
2785 indicate there's a bug.
2786
2787 2. When defining an Immutable type, we are likely to override only
2788 __new__(), since __init__() is called too late to initialize an
2789 Immutable object. Since __new__() defines the signature for the
2790 type, it would be a pain to have to override __init__() just to
2791 stop it from complaining about excess arguments.
2792
2793 3. When defining a Mutable type, we are likely to override only
2794 __init__(). So here the converse reasoning applies: we don't
2795 want to have to override __new__() just to stop it from
2796 complaining.
2797
2798 4. When __init__() is overridden, and the subclass __init__() calls
2799 object.__init__(), the latter should complain about excess
2800 arguments; ditto for __new__().
2801
2802 Use cases 2 and 3 make it unattractive to unconditionally check for
2803 excess arguments. The best solution that addresses all four use
2804 cases is as follows: __init__() complains about excess arguments
2805 unless __new__() is overridden and __init__() is not overridden
2806 (IOW, if __init__() is overridden or __new__() is not overridden);
2807 symmetrically, __new__() complains about excess arguments unless
2808 __init__() is overridden and __new__() is not overridden
2809 (IOW, if __new__() is overridden or __init__() is not overridden).
2810
2811 However, for backwards compatibility, this breaks too much code.
2812 Therefore, in 2.6, we'll *warn* about excess arguments when both
2813 methods are overridden; for all other cases we'll use the above
2814 rules.
2815
2816*/
2817
2818/* Forward */
2819static PyObject *
2820object_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
2821
2822static int
2823excess_args(PyObject *args, PyObject *kwds)
2824{
2825 return PyTuple_GET_SIZE(args) ||
2826 (kwds && PyDict_Check(kwds) && PyDict_Size(kwds));
2827}
2828
Tim Peters6d6c1a32001-08-02 04:15:00 +00002829static int
2830object_init(PyObject *self, PyObject *args, PyObject *kwds)
2831{
Guido van Rossum143b5642007-03-23 04:58:42 +00002832 int err = 0;
2833 if (excess_args(args, kwds)) {
Christian Heimese93237d2007-12-19 02:37:44 +00002834 PyTypeObject *type = Py_TYPE(self);
Guido van Rossum143b5642007-03-23 04:58:42 +00002835 if (type->tp_init != object_init &&
2836 type->tp_new != object_new)
2837 {
2838 err = PyErr_WarnEx(PyExc_DeprecationWarning,
2839 "object.__init__() takes no parameters",
2840 1);
2841 }
2842 else if (type->tp_init != object_init ||
2843 type->tp_new == object_new)
2844 {
2845 PyErr_SetString(PyExc_TypeError,
2846 "object.__init__() takes no parameters");
2847 err = -1;
2848 }
2849 }
2850 return err;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002851}
2852
Guido van Rossum298e4212003-02-13 16:30:16 +00002853static PyObject *
2854object_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
2855{
Guido van Rossum143b5642007-03-23 04:58:42 +00002856 int err = 0;
2857 if (excess_args(args, kwds)) {
2858 if (type->tp_new != object_new &&
2859 type->tp_init != object_init)
2860 {
2861 err = PyErr_WarnEx(PyExc_DeprecationWarning,
2862 "object.__new__() takes no parameters",
2863 1);
2864 }
2865 else if (type->tp_new != object_new ||
2866 type->tp_init == object_init)
2867 {
2868 PyErr_SetString(PyExc_TypeError,
2869 "object.__new__() takes no parameters");
2870 err = -1;
2871 }
Guido van Rossum298e4212003-02-13 16:30:16 +00002872 }
Guido van Rossum143b5642007-03-23 04:58:42 +00002873 if (err < 0)
2874 return NULL;
Jeffrey Yasskin960b9b72008-02-28 04:45:36 +00002875
2876 if (type->tp_flags & Py_TPFLAGS_IS_ABSTRACT) {
2877 static PyObject *comma = NULL;
2878 PyObject *abstract_methods = NULL;
2879 PyObject *builtins;
2880 PyObject *sorted;
2881 PyObject *sorted_methods = NULL;
2882 PyObject *joined = NULL;
2883 const char *joined_str;
2884
2885 /* Compute ", ".join(sorted(type.__abstractmethods__))
2886 into joined. */
2887 abstract_methods = type_abstractmethods(type, NULL);
2888 if (abstract_methods == NULL)
2889 goto error;
2890 builtins = PyEval_GetBuiltins();
2891 if (builtins == NULL)
2892 goto error;
2893 sorted = PyDict_GetItemString(builtins, "sorted");
2894 if (sorted == NULL)
2895 goto error;
2896 sorted_methods = PyObject_CallFunctionObjArgs(sorted,
2897 abstract_methods,
2898 NULL);
2899 if (sorted_methods == NULL)
2900 goto error;
2901 if (comma == NULL) {
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002902 comma = PyString_InternFromString(", ");
Jeffrey Yasskin960b9b72008-02-28 04:45:36 +00002903 if (comma == NULL)
2904 goto error;
2905 }
2906 joined = PyObject_CallMethod(comma, "join",
2907 "O", sorted_methods);
2908 if (joined == NULL)
2909 goto error;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002910 joined_str = PyString_AsString(joined);
Jeffrey Yasskin960b9b72008-02-28 04:45:36 +00002911 if (joined_str == NULL)
2912 goto error;
2913
2914 PyErr_Format(PyExc_TypeError,
2915 "Can't instantiate abstract class %s "
2916 "with abstract methods %s",
2917 type->tp_name,
2918 joined_str);
2919 error:
2920 Py_XDECREF(joined);
2921 Py_XDECREF(sorted_methods);
2922 Py_XDECREF(abstract_methods);
2923 return NULL;
2924 }
Guido van Rossum298e4212003-02-13 16:30:16 +00002925 return type->tp_alloc(type, 0);
2926}
2927
Tim Peters6d6c1a32001-08-02 04:15:00 +00002928static void
2929object_dealloc(PyObject *self)
2930{
Christian Heimese93237d2007-12-19 02:37:44 +00002931 Py_TYPE(self)->tp_free(self);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002932}
2933
Guido van Rossum8e248182001-08-12 05:17:56 +00002934static PyObject *
2935object_repr(PyObject *self)
2936{
Guido van Rossum76e69632001-08-16 18:52:43 +00002937 PyTypeObject *type;
Barry Warsaw7ce36942001-08-24 18:34:26 +00002938 PyObject *mod, *name, *rtn;
Guido van Rossum8e248182001-08-12 05:17:56 +00002939
Christian Heimese93237d2007-12-19 02:37:44 +00002940 type = Py_TYPE(self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002941 mod = type_module(type, NULL);
2942 if (mod == NULL)
2943 PyErr_Clear();
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002944 else if (!PyString_Check(mod)) {
Guido van Rossum76e69632001-08-16 18:52:43 +00002945 Py_DECREF(mod);
2946 mod = NULL;
2947 }
2948 name = type_name(type, NULL);
2949 if (name == NULL)
2950 return NULL;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002951 if (mod != NULL && strcmp(PyString_AS_STRING(mod), "__builtin__"))
2952 rtn = PyString_FromFormat("<%s.%s object at %p>",
2953 PyString_AS_STRING(mod),
2954 PyString_AS_STRING(name),
Barry Warsaw7ce36942001-08-24 18:34:26 +00002955 self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002956 else
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002957 rtn = PyString_FromFormat("<%s object at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +00002958 type->tp_name, self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002959 Py_XDECREF(mod);
2960 Py_DECREF(name);
Barry Warsaw7ce36942001-08-24 18:34:26 +00002961 return rtn;
Guido van Rossum8e248182001-08-12 05:17:56 +00002962}
2963
Guido van Rossumb8f63662001-08-15 23:57:02 +00002964static PyObject *
2965object_str(PyObject *self)
2966{
2967 unaryfunc f;
2968
Christian Heimese93237d2007-12-19 02:37:44 +00002969 f = Py_TYPE(self)->tp_repr;
Guido van Rossumb8f63662001-08-15 23:57:02 +00002970 if (f == NULL)
2971 f = object_repr;
2972 return f(self);
2973}
2974
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002975static PyObject *
2976object_get_class(PyObject *self, void *closure)
2977{
Christian Heimese93237d2007-12-19 02:37:44 +00002978 Py_INCREF(Py_TYPE(self));
2979 return (PyObject *)(Py_TYPE(self));
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002980}
2981
2982static int
2983equiv_structs(PyTypeObject *a, PyTypeObject *b)
2984{
2985 return a == b ||
2986 (a != NULL &&
2987 b != NULL &&
2988 a->tp_basicsize == b->tp_basicsize &&
2989 a->tp_itemsize == b->tp_itemsize &&
2990 a->tp_dictoffset == b->tp_dictoffset &&
2991 a->tp_weaklistoffset == b->tp_weaklistoffset &&
2992 ((a->tp_flags & Py_TPFLAGS_HAVE_GC) ==
2993 (b->tp_flags & Py_TPFLAGS_HAVE_GC)));
2994}
2995
2996static int
2997same_slots_added(PyTypeObject *a, PyTypeObject *b)
2998{
2999 PyTypeObject *base = a->tp_base;
Martin v. Löwiseb079f12006-02-16 14:32:27 +00003000 Py_ssize_t size;
Žiga Seilnacht6f2d09c2007-03-16 11:59:38 +00003001 PyObject *slots_a, *slots_b;
Guido van Rossum5c294fb2001-09-25 03:43:42 +00003002
3003 if (base != b->tp_base)
3004 return 0;
3005 if (equiv_structs(a, base) && equiv_structs(b, base))
3006 return 1;
3007 size = base->tp_basicsize;
3008 if (a->tp_dictoffset == size && b->tp_dictoffset == size)
3009 size += sizeof(PyObject *);
3010 if (a->tp_weaklistoffset == size && b->tp_weaklistoffset == size)
3011 size += sizeof(PyObject *);
Žiga Seilnacht6f2d09c2007-03-16 11:59:38 +00003012
3013 /* Check slots compliance */
3014 slots_a = ((PyHeapTypeObject *)a)->ht_slots;
3015 slots_b = ((PyHeapTypeObject *)b)->ht_slots;
3016 if (slots_a && slots_b) {
3017 if (PyObject_Compare(slots_a, slots_b) != 0)
3018 return 0;
3019 size += sizeof(PyObject *) * PyTuple_GET_SIZE(slots_a);
3020 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00003021 return size == a->tp_basicsize && size == b->tp_basicsize;
3022}
3023
3024static int
Anthony Baxtera6286212006-04-11 07:42:36 +00003025compatible_for_assignment(PyTypeObject* oldto, PyTypeObject* newto, char* attr)
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003026{
3027 PyTypeObject *newbase, *oldbase;
3028
Anthony Baxtera6286212006-04-11 07:42:36 +00003029 if (newto->tp_dealloc != oldto->tp_dealloc ||
3030 newto->tp_free != oldto->tp_free)
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003031 {
3032 PyErr_Format(PyExc_TypeError,
3033 "%s assignment: "
3034 "'%s' deallocator differs from '%s'",
3035 attr,
Anthony Baxtera6286212006-04-11 07:42:36 +00003036 newto->tp_name,
3037 oldto->tp_name);
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003038 return 0;
3039 }
Anthony Baxtera6286212006-04-11 07:42:36 +00003040 newbase = newto;
3041 oldbase = oldto;
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003042 while (equiv_structs(newbase, newbase->tp_base))
3043 newbase = newbase->tp_base;
3044 while (equiv_structs(oldbase, oldbase->tp_base))
3045 oldbase = oldbase->tp_base;
3046 if (newbase != oldbase &&
3047 (newbase->tp_base != oldbase->tp_base ||
3048 !same_slots_added(newbase, oldbase))) {
3049 PyErr_Format(PyExc_TypeError,
3050 "%s assignment: "
3051 "'%s' object layout differs from '%s'",
3052 attr,
Anthony Baxtera6286212006-04-11 07:42:36 +00003053 newto->tp_name,
3054 oldto->tp_name);
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003055 return 0;
3056 }
Tim Petersea7f75d2002-12-07 21:39:16 +00003057
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003058 return 1;
3059}
3060
3061static int
Guido van Rossum5c294fb2001-09-25 03:43:42 +00003062object_set_class(PyObject *self, PyObject *value, void *closure)
3063{
Christian Heimese93237d2007-12-19 02:37:44 +00003064 PyTypeObject *oldto = Py_TYPE(self);
Anthony Baxtera6286212006-04-11 07:42:36 +00003065 PyTypeObject *newto;
Guido van Rossum5c294fb2001-09-25 03:43:42 +00003066
Guido van Rossumb6b89422002-04-15 01:03:30 +00003067 if (value == NULL) {
3068 PyErr_SetString(PyExc_TypeError,
3069 "can't delete __class__ attribute");
3070 return -1;
3071 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00003072 if (!PyType_Check(value)) {
3073 PyErr_Format(PyExc_TypeError,
3074 "__class__ must be set to new-style class, not '%s' object",
Christian Heimese93237d2007-12-19 02:37:44 +00003075 Py_TYPE(value)->tp_name);
Guido van Rossum5c294fb2001-09-25 03:43:42 +00003076 return -1;
3077 }
Anthony Baxtera6286212006-04-11 07:42:36 +00003078 newto = (PyTypeObject *)value;
3079 if (!(newto->tp_flags & Py_TPFLAGS_HEAPTYPE) ||
3080 !(oldto->tp_flags & Py_TPFLAGS_HEAPTYPE))
Guido van Rossum40af8892002-08-10 05:42:07 +00003081 {
3082 PyErr_Format(PyExc_TypeError,
3083 "__class__ assignment: only for heap types");
3084 return -1;
3085 }
Anthony Baxtera6286212006-04-11 07:42:36 +00003086 if (compatible_for_assignment(newto, oldto, "__class__")) {
3087 Py_INCREF(newto);
Christian Heimese93237d2007-12-19 02:37:44 +00003088 Py_TYPE(self) = newto;
Anthony Baxtera6286212006-04-11 07:42:36 +00003089 Py_DECREF(oldto);
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003090 return 0;
3091 }
3092 else {
Guido van Rossum9ee4b942002-05-24 18:47:47 +00003093 return -1;
3094 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00003095}
3096
3097static PyGetSetDef object_getsets[] = {
3098 {"__class__", object_get_class, object_set_class,
Neal Norwitz858e34f2002-08-13 17:18:45 +00003099 PyDoc_STR("the object's class")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00003100 {0}
3101};
3102
Guido van Rossumc53f0092003-02-18 22:05:12 +00003103
Guido van Rossum036f9992003-02-21 22:02:54 +00003104/* Stuff to implement __reduce_ex__ for pickle protocols >= 2.
Georg Brandldffbf5f2008-05-20 07:49:57 +00003105 We fall back to helpers in copy_reg for:
Guido van Rossum036f9992003-02-21 22:02:54 +00003106 - pickle protocols < 2
3107 - calculating the list of slot names (done only once per class)
3108 - the __newobj__ function (which is used as a token but never called)
3109*/
3110
3111static PyObject *
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003112import_copyreg(void)
Guido van Rossum036f9992003-02-21 22:02:54 +00003113{
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003114 static PyObject *copyreg_str;
Guido van Rossum3926a632001-09-25 16:25:58 +00003115
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003116 if (!copyreg_str) {
Gregory P. Smithdd96db62008-06-09 04:58:54 +00003117 copyreg_str = PyString_InternFromString("copy_reg");
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003118 if (copyreg_str == NULL)
Guido van Rossum3926a632001-09-25 16:25:58 +00003119 return NULL;
3120 }
Guido van Rossum036f9992003-02-21 22:02:54 +00003121
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003122 return PyImport_Import(copyreg_str);
Guido van Rossum036f9992003-02-21 22:02:54 +00003123}
3124
3125static PyObject *
3126slotnames(PyObject *cls)
3127{
3128 PyObject *clsdict;
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003129 PyObject *copyreg;
Guido van Rossum036f9992003-02-21 22:02:54 +00003130 PyObject *slotnames;
3131
3132 if (!PyType_Check(cls)) {
3133 Py_INCREF(Py_None);
3134 return Py_None;
3135 }
3136
3137 clsdict = ((PyTypeObject *)cls)->tp_dict;
3138 slotnames = PyDict_GetItemString(clsdict, "__slotnames__");
Armin Rigoec862b92005-09-24 22:58:41 +00003139 if (slotnames != NULL && PyList_Check(slotnames)) {
Guido van Rossum036f9992003-02-21 22:02:54 +00003140 Py_INCREF(slotnames);
3141 return slotnames;
3142 }
3143
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003144 copyreg = import_copyreg();
3145 if (copyreg == NULL)
Guido van Rossum036f9992003-02-21 22:02:54 +00003146 return NULL;
3147
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003148 slotnames = PyObject_CallMethod(copyreg, "_slotnames", "O", cls);
3149 Py_DECREF(copyreg);
Guido van Rossum036f9992003-02-21 22:02:54 +00003150 if (slotnames != NULL &&
3151 slotnames != Py_None &&
3152 !PyList_Check(slotnames))
3153 {
3154 PyErr_SetString(PyExc_TypeError,
Georg Brandldffbf5f2008-05-20 07:49:57 +00003155 "copy_reg._slotnames didn't return a list or None");
Guido van Rossum036f9992003-02-21 22:02:54 +00003156 Py_DECREF(slotnames);
3157 slotnames = NULL;
3158 }
3159
3160 return slotnames;
3161}
3162
3163static PyObject *
3164reduce_2(PyObject *obj)
3165{
3166 PyObject *cls, *getnewargs;
3167 PyObject *args = NULL, *args2 = NULL;
3168 PyObject *getstate = NULL, *state = NULL, *names = NULL;
3169 PyObject *slots = NULL, *listitems = NULL, *dictitems = NULL;
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003170 PyObject *copyreg = NULL, *newobj = NULL, *res = NULL;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003171 Py_ssize_t i, n;
Guido van Rossum036f9992003-02-21 22:02:54 +00003172
3173 cls = PyObject_GetAttrString(obj, "__class__");
3174 if (cls == NULL)
3175 return NULL;
3176
3177 getnewargs = PyObject_GetAttrString(obj, "__getnewargs__");
3178 if (getnewargs != NULL) {
3179 args = PyObject_CallObject(getnewargs, NULL);
3180 Py_DECREF(getnewargs);
3181 if (args != NULL && !PyTuple_Check(args)) {
Georg Brandlccff7852006-06-18 22:17:29 +00003182 PyErr_Format(PyExc_TypeError,
3183 "__getnewargs__ should return a tuple, "
Christian Heimese93237d2007-12-19 02:37:44 +00003184 "not '%.200s'", Py_TYPE(args)->tp_name);
Guido van Rossum036f9992003-02-21 22:02:54 +00003185 goto end;
3186 }
3187 }
3188 else {
3189 PyErr_Clear();
3190 args = PyTuple_New(0);
3191 }
3192 if (args == NULL)
3193 goto end;
3194
3195 getstate = PyObject_GetAttrString(obj, "__getstate__");
3196 if (getstate != NULL) {
3197 state = PyObject_CallObject(getstate, NULL);
3198 Py_DECREF(getstate);
Neal Norwitze2fdc612003-06-08 13:19:58 +00003199 if (state == NULL)
3200 goto end;
Guido van Rossum036f9992003-02-21 22:02:54 +00003201 }
3202 else {
Jim Fulton8a1a5942004-02-08 04:21:26 +00003203 PyErr_Clear();
Guido van Rossum036f9992003-02-21 22:02:54 +00003204 state = PyObject_GetAttrString(obj, "__dict__");
3205 if (state == NULL) {
3206 PyErr_Clear();
3207 state = Py_None;
3208 Py_INCREF(state);
3209 }
3210 names = slotnames(cls);
3211 if (names == NULL)
3212 goto end;
3213 if (names != Py_None) {
3214 assert(PyList_Check(names));
3215 slots = PyDict_New();
3216 if (slots == NULL)
3217 goto end;
3218 n = 0;
3219 /* Can't pre-compute the list size; the list
3220 is stored on the class so accessible to other
3221 threads, which may be run by DECREF */
3222 for (i = 0; i < PyList_GET_SIZE(names); i++) {
3223 PyObject *name, *value;
3224 name = PyList_GET_ITEM(names, i);
3225 value = PyObject_GetAttr(obj, name);
3226 if (value == NULL)
3227 PyErr_Clear();
3228 else {
3229 int err = PyDict_SetItem(slots, name,
3230 value);
3231 Py_DECREF(value);
3232 if (err)
3233 goto end;
3234 n++;
3235 }
3236 }
3237 if (n) {
3238 state = Py_BuildValue("(NO)", state, slots);
3239 if (state == NULL)
3240 goto end;
3241 }
3242 }
3243 }
3244
3245 if (!PyList_Check(obj)) {
3246 listitems = Py_None;
3247 Py_INCREF(listitems);
3248 }
3249 else {
3250 listitems = PyObject_GetIter(obj);
3251 if (listitems == NULL)
3252 goto end;
3253 }
3254
3255 if (!PyDict_Check(obj)) {
3256 dictitems = Py_None;
3257 Py_INCREF(dictitems);
3258 }
3259 else {
3260 dictitems = PyObject_CallMethod(obj, "iteritems", "");
3261 if (dictitems == NULL)
3262 goto end;
3263 }
3264
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003265 copyreg = import_copyreg();
3266 if (copyreg == NULL)
Guido van Rossum036f9992003-02-21 22:02:54 +00003267 goto end;
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003268 newobj = PyObject_GetAttrString(copyreg, "__newobj__");
Guido van Rossum036f9992003-02-21 22:02:54 +00003269 if (newobj == NULL)
3270 goto end;
3271
3272 n = PyTuple_GET_SIZE(args);
3273 args2 = PyTuple_New(n+1);
3274 if (args2 == NULL)
3275 goto end;
3276 PyTuple_SET_ITEM(args2, 0, cls);
3277 cls = NULL;
3278 for (i = 0; i < n; i++) {
3279 PyObject *v = PyTuple_GET_ITEM(args, i);
3280 Py_INCREF(v);
3281 PyTuple_SET_ITEM(args2, i+1, v);
3282 }
3283
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003284 res = PyTuple_Pack(5, newobj, args2, state, listitems, dictitems);
Guido van Rossum036f9992003-02-21 22:02:54 +00003285
3286 end:
3287 Py_XDECREF(cls);
3288 Py_XDECREF(args);
3289 Py_XDECREF(args2);
Jeremy Hyltond06483c2003-04-09 21:01:42 +00003290 Py_XDECREF(slots);
Guido van Rossum036f9992003-02-21 22:02:54 +00003291 Py_XDECREF(state);
3292 Py_XDECREF(names);
3293 Py_XDECREF(listitems);
3294 Py_XDECREF(dictitems);
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003295 Py_XDECREF(copyreg);
Guido van Rossum036f9992003-02-21 22:02:54 +00003296 Py_XDECREF(newobj);
3297 return res;
3298}
3299
Žiga Seilnacht20f43d32007-03-15 11:44:55 +00003300/*
3301 * There were two problems when object.__reduce__ and object.__reduce_ex__
3302 * were implemented in the same function:
3303 * - trying to pickle an object with a custom __reduce__ method that
3304 * fell back to object.__reduce__ in certain circumstances led to
3305 * infinite recursion at Python level and eventual RuntimeError.
3306 * - Pickling objects that lied about their type by overwriting the
3307 * __class__ descriptor could lead to infinite recursion at C level
3308 * and eventual segfault.
3309 *
3310 * Because of backwards compatibility, the two methods still have to
3311 * behave in the same way, even if this is not required by the pickle
3312 * protocol. This common functionality was moved to the _common_reduce
3313 * function.
3314 */
3315static PyObject *
3316_common_reduce(PyObject *self, int proto)
3317{
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003318 PyObject *copyreg, *res;
Žiga Seilnacht20f43d32007-03-15 11:44:55 +00003319
3320 if (proto >= 2)
3321 return reduce_2(self);
3322
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003323 copyreg = import_copyreg();
3324 if (!copyreg)
Žiga Seilnacht20f43d32007-03-15 11:44:55 +00003325 return NULL;
3326
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003327 res = PyEval_CallMethod(copyreg, "_reduce_ex", "(Oi)", self, proto);
3328 Py_DECREF(copyreg);
Žiga Seilnacht20f43d32007-03-15 11:44:55 +00003329
3330 return res;
3331}
3332
3333static PyObject *
3334object_reduce(PyObject *self, PyObject *args)
3335{
3336 int proto = 0;
3337
3338 if (!PyArg_ParseTuple(args, "|i:__reduce__", &proto))
3339 return NULL;
3340
3341 return _common_reduce(self, proto);
3342}
3343
Guido van Rossum036f9992003-02-21 22:02:54 +00003344static PyObject *
3345object_reduce_ex(PyObject *self, PyObject *args)
3346{
Žiga Seilnacht20f43d32007-03-15 11:44:55 +00003347 PyObject *reduce, *res;
Guido van Rossum036f9992003-02-21 22:02:54 +00003348 int proto = 0;
3349
3350 if (!PyArg_ParseTuple(args, "|i:__reduce_ex__", &proto))
3351 return NULL;
3352
3353 reduce = PyObject_GetAttrString(self, "__reduce__");
3354 if (reduce == NULL)
3355 PyErr_Clear();
3356 else {
3357 PyObject *cls, *clsreduce, *objreduce;
3358 int override;
3359 cls = PyObject_GetAttrString(self, "__class__");
3360 if (cls == NULL) {
3361 Py_DECREF(reduce);
3362 return NULL;
3363 }
3364 clsreduce = PyObject_GetAttrString(cls, "__reduce__");
3365 Py_DECREF(cls);
3366 if (clsreduce == NULL) {
3367 Py_DECREF(reduce);
3368 return NULL;
3369 }
3370 objreduce = PyDict_GetItemString(PyBaseObject_Type.tp_dict,
3371 "__reduce__");
3372 override = (clsreduce != objreduce);
3373 Py_DECREF(clsreduce);
3374 if (override) {
3375 res = PyObject_CallObject(reduce, NULL);
3376 Py_DECREF(reduce);
3377 return res;
3378 }
3379 else
3380 Py_DECREF(reduce);
3381 }
3382
Žiga Seilnacht20f43d32007-03-15 11:44:55 +00003383 return _common_reduce(self, proto);
Guido van Rossum3926a632001-09-25 16:25:58 +00003384}
3385
Jeffrey Yasskin960b9b72008-02-28 04:45:36 +00003386static PyObject *
3387object_subclasshook(PyObject *cls, PyObject *args)
3388{
3389 Py_INCREF(Py_NotImplemented);
3390 return Py_NotImplemented;
3391}
3392
3393PyDoc_STRVAR(object_subclasshook_doc,
3394"Abstract classes can override this to customize issubclass().\n"
3395"\n"
3396"This is invoked early on by abc.ABCMeta.__subclasscheck__().\n"
3397"It should return True, False or NotImplemented. If it returns\n"
3398"NotImplemented, the normal algorithm is used. Otherwise, it\n"
3399"overrides the normal algorithm (and the outcome is cached).\n");
3400
Eric Smitha9f7d622008-02-17 19:46:49 +00003401/*
3402 from PEP 3101, this code implements:
3403
3404 class object:
3405 def __format__(self, format_spec):
3406 if isinstance(format_spec, str):
3407 return format(str(self), format_spec)
3408 elif isinstance(format_spec, unicode):
3409 return format(unicode(self), format_spec)
3410*/
3411static PyObject *
3412object_format(PyObject *self, PyObject *args)
3413{
3414 PyObject *format_spec;
3415 PyObject *self_as_str = NULL;
3416 PyObject *result = NULL;
3417 PyObject *format_meth = NULL;
3418
3419 if (!PyArg_ParseTuple(args, "O:__format__", &format_spec))
3420 return NULL;
3421 if (PyUnicode_Check(format_spec)) {
3422 self_as_str = PyObject_Unicode(self);
Gregory P. Smithdd96db62008-06-09 04:58:54 +00003423 } else if (PyString_Check(format_spec)) {
Eric Smitha9f7d622008-02-17 19:46:49 +00003424 self_as_str = PyObject_Str(self);
3425 } else {
3426 PyErr_SetString(PyExc_TypeError, "argument to __format__ must be unicode or str");
3427 return NULL;
3428 }
3429
3430 if (self_as_str != NULL) {
3431 /* find the format function */
3432 format_meth = PyObject_GetAttrString(self_as_str, "__format__");
3433 if (format_meth != NULL) {
3434 /* and call it */
3435 result = PyObject_CallFunctionObjArgs(format_meth, format_spec, NULL);
3436 }
3437 }
3438
3439 Py_XDECREF(self_as_str);
3440 Py_XDECREF(format_meth);
3441
3442 return result;
3443}
3444
Robert Schuppenies51df0642008-06-01 16:16:17 +00003445static PyObject *
3446object_sizeof(PyObject *self, PyObject *args)
3447{
3448 Py_ssize_t res, isize;
3449
3450 res = 0;
3451 isize = self->ob_type->tp_itemsize;
3452 if (isize > 0)
3453 res = self->ob_type->ob_size * isize;
3454 res += self->ob_type->tp_basicsize;
3455
3456 return PyInt_FromSsize_t(res);
3457}
3458
Guido van Rossum3926a632001-09-25 16:25:58 +00003459static PyMethodDef object_methods[] = {
Guido van Rossumc53f0092003-02-18 22:05:12 +00003460 {"__reduce_ex__", object_reduce_ex, METH_VARARGS,
3461 PyDoc_STR("helper for pickle")},
Žiga Seilnacht20f43d32007-03-15 11:44:55 +00003462 {"__reduce__", object_reduce, METH_VARARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00003463 PyDoc_STR("helper for pickle")},
Jeffrey Yasskin960b9b72008-02-28 04:45:36 +00003464 {"__subclasshook__", object_subclasshook, METH_CLASS | METH_VARARGS,
3465 object_subclasshook_doc},
Eric Smitha9f7d622008-02-17 19:46:49 +00003466 {"__format__", object_format, METH_VARARGS,
3467 PyDoc_STR("default object formatter")},
Robert Schuppenies51df0642008-06-01 16:16:17 +00003468 {"__sizeof__", object_sizeof, METH_NOARGS,
Georg Brandl7a6de8b2008-06-01 16:42:16 +00003469 PyDoc_STR("__sizeof__() -> size of object in memory, in bytes")},
Guido van Rossum3926a632001-09-25 16:25:58 +00003470 {0}
3471};
3472
Guido van Rossum036f9992003-02-21 22:02:54 +00003473
Tim Peters6d6c1a32001-08-02 04:15:00 +00003474PyTypeObject PyBaseObject_Type = {
Martin v. Löwis68192102007-07-21 06:55:02 +00003475 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003476 "object", /* tp_name */
3477 sizeof(PyObject), /* tp_basicsize */
3478 0, /* tp_itemsize */
Georg Brandl347b3002006-03-30 11:57:00 +00003479 object_dealloc, /* tp_dealloc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003480 0, /* tp_print */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003481 0, /* tp_getattr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003482 0, /* tp_setattr */
3483 0, /* tp_compare */
Guido van Rossumb8f63662001-08-15 23:57:02 +00003484 object_repr, /* tp_repr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003485 0, /* tp_as_number */
3486 0, /* tp_as_sequence */
3487 0, /* tp_as_mapping */
Guido van Rossum64c06e32007-11-22 00:55:51 +00003488 (hashfunc)_Py_HashPointer, /* tp_hash */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003489 0, /* tp_call */
Guido van Rossumb8f63662001-08-15 23:57:02 +00003490 object_str, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003491 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum13d52f02001-08-10 21:24:08 +00003492 PyObject_GenericSetAttr, /* tp_setattro */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003493 0, /* tp_as_buffer */
3494 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Neal Norwitz5dc2a372002-08-13 22:19:13 +00003495 PyDoc_STR("The most base type"), /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003496 0, /* tp_traverse */
3497 0, /* tp_clear */
3498 0, /* tp_richcompare */
3499 0, /* tp_weaklistoffset */
3500 0, /* tp_iter */
3501 0, /* tp_iternext */
Guido van Rossum3926a632001-09-25 16:25:58 +00003502 object_methods, /* tp_methods */
Guido van Rossum5c294fb2001-09-25 03:43:42 +00003503 0, /* tp_members */
3504 object_getsets, /* tp_getset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003505 0, /* tp_base */
3506 0, /* tp_dict */
3507 0, /* tp_descr_get */
3508 0, /* tp_descr_set */
3509 0, /* tp_dictoffset */
3510 object_init, /* tp_init */
3511 PyType_GenericAlloc, /* tp_alloc */
Guido van Rossum298e4212003-02-13 16:30:16 +00003512 object_new, /* tp_new */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003513 PyObject_Del, /* tp_free */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003514};
3515
3516
3517/* Initialize the __dict__ in a type object */
3518
3519static int
3520add_methods(PyTypeObject *type, PyMethodDef *meth)
3521{
Guido van Rossum687ae002001-10-15 22:03:32 +00003522 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003523
3524 for (; meth->ml_name != NULL; meth++) {
3525 PyObject *descr;
Raymond Hettinger8f5cdaa2003-12-13 11:26:12 +00003526 if (PyDict_GetItemString(dict, meth->ml_name) &&
3527 !(meth->ml_flags & METH_COEXIST))
3528 continue;
Fred Drake7bf97152002-03-28 05:33:33 +00003529 if (meth->ml_flags & METH_CLASS) {
3530 if (meth->ml_flags & METH_STATIC) {
3531 PyErr_SetString(PyExc_ValueError,
3532 "method cannot be both class and static");
3533 return -1;
3534 }
Tim Petersbca1cbc2002-12-09 22:56:13 +00003535 descr = PyDescr_NewClassMethod(type, meth);
Fred Drake7bf97152002-03-28 05:33:33 +00003536 }
3537 else if (meth->ml_flags & METH_STATIC) {
Guido van Rossum9af48ff2003-02-11 17:12:46 +00003538 PyObject *cfunc = PyCFunction_New(meth, NULL);
3539 if (cfunc == NULL)
3540 return -1;
3541 descr = PyStaticMethod_New(cfunc);
3542 Py_DECREF(cfunc);
Fred Drake7bf97152002-03-28 05:33:33 +00003543 }
3544 else {
3545 descr = PyDescr_NewMethod(type, meth);
3546 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003547 if (descr == NULL)
3548 return -1;
Fred Drake7bf97152002-03-28 05:33:33 +00003549 if (PyDict_SetItemString(dict, meth->ml_name, descr) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003550 return -1;
3551 Py_DECREF(descr);
3552 }
3553 return 0;
3554}
3555
3556static int
Guido van Rossum6f799372001-09-20 20:46:19 +00003557add_members(PyTypeObject *type, PyMemberDef *memb)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003558{
Guido van Rossum687ae002001-10-15 22:03:32 +00003559 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003560
3561 for (; memb->name != NULL; memb++) {
3562 PyObject *descr;
3563 if (PyDict_GetItemString(dict, memb->name))
3564 continue;
3565 descr = PyDescr_NewMember(type, memb);
3566 if (descr == NULL)
3567 return -1;
3568 if (PyDict_SetItemString(dict, memb->name, descr) < 0)
3569 return -1;
3570 Py_DECREF(descr);
3571 }
3572 return 0;
3573}
3574
3575static int
Guido van Rossum32d34c82001-09-20 21:45:26 +00003576add_getset(PyTypeObject *type, PyGetSetDef *gsp)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003577{
Guido van Rossum687ae002001-10-15 22:03:32 +00003578 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003579
3580 for (; gsp->name != NULL; gsp++) {
3581 PyObject *descr;
3582 if (PyDict_GetItemString(dict, gsp->name))
3583 continue;
3584 descr = PyDescr_NewGetSet(type, gsp);
3585
3586 if (descr == NULL)
3587 return -1;
3588 if (PyDict_SetItemString(dict, gsp->name, descr) < 0)
3589 return -1;
3590 Py_DECREF(descr);
3591 }
3592 return 0;
3593}
3594
Guido van Rossum13d52f02001-08-10 21:24:08 +00003595static void
3596inherit_special(PyTypeObject *type, PyTypeObject *base)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003597{
Martin v. Löwiseb079f12006-02-16 14:32:27 +00003598 Py_ssize_t oldsize, newsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003599
Guido van Rossum13d52f02001-08-10 21:24:08 +00003600 /* Special flag magic */
3601 if (!type->tp_as_buffer && base->tp_as_buffer) {
3602 type->tp_flags &= ~Py_TPFLAGS_HAVE_GETCHARBUFFER;
3603 type->tp_flags |=
3604 base->tp_flags & Py_TPFLAGS_HAVE_GETCHARBUFFER;
3605 }
3606 if (!type->tp_as_sequence && base->tp_as_sequence) {
3607 type->tp_flags &= ~Py_TPFLAGS_HAVE_SEQUENCE_IN;
3608 type->tp_flags |= base->tp_flags & Py_TPFLAGS_HAVE_SEQUENCE_IN;
3609 }
3610 if ((type->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS) !=
3611 (base->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS)) {
3612 if ((!type->tp_as_number && base->tp_as_number) ||
3613 (!type->tp_as_sequence && base->tp_as_sequence)) {
3614 type->tp_flags &= ~Py_TPFLAGS_HAVE_INPLACEOPS;
3615 if (!type->tp_as_number && !type->tp_as_sequence) {
3616 type->tp_flags |= base->tp_flags &
3617 Py_TPFLAGS_HAVE_INPLACEOPS;
3618 }
3619 }
3620 /* Wow */
3621 }
3622 if (!type->tp_as_number && base->tp_as_number) {
3623 type->tp_flags &= ~Py_TPFLAGS_CHECKTYPES;
3624 type->tp_flags |= base->tp_flags & Py_TPFLAGS_CHECKTYPES;
3625 }
3626
3627 /* Copying basicsize is connected to the GC flags */
Neil Schemenauerc806c882001-08-29 23:54:54 +00003628 oldsize = base->tp_basicsize;
3629 newsize = type->tp_basicsize ? type->tp_basicsize : oldsize;
3630 if (!(type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
3631 (base->tp_flags & Py_TPFLAGS_HAVE_GC) &&
Guido van Rossum13d52f02001-08-10 21:24:08 +00003632 (type->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE/*GC slots exist*/) &&
3633 (!type->tp_traverse && !type->tp_clear)) {
Neil Schemenauerc806c882001-08-29 23:54:54 +00003634 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
Guido van Rossum13d52f02001-08-10 21:24:08 +00003635 if (type->tp_traverse == NULL)
3636 type->tp_traverse = base->tp_traverse;
3637 if (type->tp_clear == NULL)
3638 type->tp_clear = base->tp_clear;
3639 }
3640 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
Guido van Rossumf884b742001-12-17 17:14:22 +00003641 /* The condition below could use some explanation.
3642 It appears that tp_new is not inherited for static types
3643 whose base class is 'object'; this seems to be a precaution
3644 so that old extension types don't suddenly become
3645 callable (object.__new__ wouldn't insure the invariants
3646 that the extension type's own factory function ensures).
3647 Heap types, of course, are under our control, so they do
3648 inherit tp_new; static extension types that specify some
3649 other built-in type as the default are considered
3650 new-style-aware so they also inherit object.__new__. */
Guido van Rossum13d52f02001-08-10 21:24:08 +00003651 if (base != &PyBaseObject_Type ||
3652 (type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
3653 if (type->tp_new == NULL)
3654 type->tp_new = base->tp_new;
3655 }
3656 }
Neil Schemenauerc806c882001-08-29 23:54:54 +00003657 type->tp_basicsize = newsize;
Guido van Rossum4dd64ab2001-08-14 20:04:48 +00003658
3659 /* Copy other non-function slots */
3660
3661#undef COPYVAL
3662#define COPYVAL(SLOT) \
3663 if (type->SLOT == 0) type->SLOT = base->SLOT
3664
3665 COPYVAL(tp_itemsize);
3666 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_WEAKREFS) {
3667 COPYVAL(tp_weaklistoffset);
3668 }
3669 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
3670 COPYVAL(tp_dictoffset);
3671 }
Neal Norwitzee3a1b52007-02-25 19:44:48 +00003672
3673 /* Setup fast subclass flags */
3674 if (PyType_IsSubtype(base, (PyTypeObject*)PyExc_BaseException))
3675 type->tp_flags |= Py_TPFLAGS_BASE_EXC_SUBCLASS;
3676 else if (PyType_IsSubtype(base, &PyType_Type))
3677 type->tp_flags |= Py_TPFLAGS_TYPE_SUBCLASS;
3678 else if (PyType_IsSubtype(base, &PyInt_Type))
3679 type->tp_flags |= Py_TPFLAGS_INT_SUBCLASS;
3680 else if (PyType_IsSubtype(base, &PyLong_Type))
3681 type->tp_flags |= Py_TPFLAGS_LONG_SUBCLASS;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00003682 else if (PyType_IsSubtype(base, &PyString_Type))
Neal Norwitzee3a1b52007-02-25 19:44:48 +00003683 type->tp_flags |= Py_TPFLAGS_STRING_SUBCLASS;
Georg Brandldfe5dc82008-01-07 18:16:36 +00003684#ifdef Py_USING_UNICODE
Neal Norwitzee3a1b52007-02-25 19:44:48 +00003685 else if (PyType_IsSubtype(base, &PyUnicode_Type))
3686 type->tp_flags |= Py_TPFLAGS_UNICODE_SUBCLASS;
Georg Brandldfe5dc82008-01-07 18:16:36 +00003687#endif
Neal Norwitzee3a1b52007-02-25 19:44:48 +00003688 else if (PyType_IsSubtype(base, &PyTuple_Type))
3689 type->tp_flags |= Py_TPFLAGS_TUPLE_SUBCLASS;
3690 else if (PyType_IsSubtype(base, &PyList_Type))
3691 type->tp_flags |= Py_TPFLAGS_LIST_SUBCLASS;
3692 else if (PyType_IsSubtype(base, &PyDict_Type))
3693 type->tp_flags |= Py_TPFLAGS_DICT_SUBCLASS;
Guido van Rossum13d52f02001-08-10 21:24:08 +00003694}
3695
Nick Coghlan48361f52008-08-11 15:45:58 +00003696static int
3697overrides_name(PyTypeObject *type, char *name)
3698{
3699 PyObject *dict = type->tp_dict;
3700
3701 assert(dict != NULL);
3702 if (PyDict_GetItemString(dict, name) != NULL) {
3703 return 1;
3704 }
3705 return 0;
3706}
3707
3708#define OVERRIDES_HASH(x) overrides_name(x, "__hash__")
3709#define OVERRIDES_CMP(x) overrides_name(x, "__cmp__")
3710#define OVERRIDES_EQ(x) overrides_name(x, "__eq__")
3711
Guido van Rossum13d52f02001-08-10 21:24:08 +00003712static void
3713inherit_slots(PyTypeObject *type, PyTypeObject *base)
3714{
3715 PyTypeObject *basebase;
3716
3717#undef SLOTDEFINED
Tim Peters6d6c1a32001-08-02 04:15:00 +00003718#undef COPYSLOT
3719#undef COPYNUM
3720#undef COPYSEQ
3721#undef COPYMAP
Guido van Rossum5af588b2001-10-12 14:13:21 +00003722#undef COPYBUF
Guido van Rossum13d52f02001-08-10 21:24:08 +00003723
3724#define SLOTDEFINED(SLOT) \
3725 (base->SLOT != 0 && \
3726 (basebase == NULL || base->SLOT != basebase->SLOT))
3727
Tim Peters6d6c1a32001-08-02 04:15:00 +00003728#define COPYSLOT(SLOT) \
Guido van Rossum13d52f02001-08-10 21:24:08 +00003729 if (!type->SLOT && SLOTDEFINED(SLOT)) type->SLOT = base->SLOT
Tim Peters6d6c1a32001-08-02 04:15:00 +00003730
3731#define COPYNUM(SLOT) COPYSLOT(tp_as_number->SLOT)
3732#define COPYSEQ(SLOT) COPYSLOT(tp_as_sequence->SLOT)
3733#define COPYMAP(SLOT) COPYSLOT(tp_as_mapping->SLOT)
Tim Petersfc57ccb2001-10-12 02:38:24 +00003734#define COPYBUF(SLOT) COPYSLOT(tp_as_buffer->SLOT)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003735
Guido van Rossum13d52f02001-08-10 21:24:08 +00003736 /* This won't inherit indirect slots (from tp_as_number etc.)
3737 if type doesn't provide the space. */
3738
3739 if (type->tp_as_number != NULL && base->tp_as_number != NULL) {
3740 basebase = base->tp_base;
3741 if (basebase->tp_as_number == NULL)
3742 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003743 COPYNUM(nb_add);
3744 COPYNUM(nb_subtract);
3745 COPYNUM(nb_multiply);
3746 COPYNUM(nb_divide);
3747 COPYNUM(nb_remainder);
3748 COPYNUM(nb_divmod);
3749 COPYNUM(nb_power);
3750 COPYNUM(nb_negative);
3751 COPYNUM(nb_positive);
3752 COPYNUM(nb_absolute);
3753 COPYNUM(nb_nonzero);
3754 COPYNUM(nb_invert);
3755 COPYNUM(nb_lshift);
3756 COPYNUM(nb_rshift);
3757 COPYNUM(nb_and);
3758 COPYNUM(nb_xor);
3759 COPYNUM(nb_or);
3760 COPYNUM(nb_coerce);
3761 COPYNUM(nb_int);
3762 COPYNUM(nb_long);
3763 COPYNUM(nb_float);
3764 COPYNUM(nb_oct);
3765 COPYNUM(nb_hex);
3766 COPYNUM(nb_inplace_add);
3767 COPYNUM(nb_inplace_subtract);
3768 COPYNUM(nb_inplace_multiply);
3769 COPYNUM(nb_inplace_divide);
3770 COPYNUM(nb_inplace_remainder);
3771 COPYNUM(nb_inplace_power);
3772 COPYNUM(nb_inplace_lshift);
3773 COPYNUM(nb_inplace_rshift);
3774 COPYNUM(nb_inplace_and);
3775 COPYNUM(nb_inplace_xor);
3776 COPYNUM(nb_inplace_or);
Guido van Rossumdc91b992001-08-08 22:26:22 +00003777 if (base->tp_flags & Py_TPFLAGS_CHECKTYPES) {
3778 COPYNUM(nb_true_divide);
3779 COPYNUM(nb_floor_divide);
3780 COPYNUM(nb_inplace_true_divide);
3781 COPYNUM(nb_inplace_floor_divide);
3782 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +00003783 if (base->tp_flags & Py_TPFLAGS_HAVE_INDEX) {
3784 COPYNUM(nb_index);
3785 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003786 }
3787
Guido van Rossum13d52f02001-08-10 21:24:08 +00003788 if (type->tp_as_sequence != NULL && base->tp_as_sequence != NULL) {
3789 basebase = base->tp_base;
3790 if (basebase->tp_as_sequence == NULL)
3791 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003792 COPYSEQ(sq_length);
3793 COPYSEQ(sq_concat);
3794 COPYSEQ(sq_repeat);
3795 COPYSEQ(sq_item);
3796 COPYSEQ(sq_slice);
3797 COPYSEQ(sq_ass_item);
3798 COPYSEQ(sq_ass_slice);
3799 COPYSEQ(sq_contains);
3800 COPYSEQ(sq_inplace_concat);
3801 COPYSEQ(sq_inplace_repeat);
3802 }
3803
Guido van Rossum13d52f02001-08-10 21:24:08 +00003804 if (type->tp_as_mapping != NULL && base->tp_as_mapping != NULL) {
3805 basebase = base->tp_base;
3806 if (basebase->tp_as_mapping == NULL)
3807 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003808 COPYMAP(mp_length);
3809 COPYMAP(mp_subscript);
3810 COPYMAP(mp_ass_subscript);
3811 }
3812
Tim Petersfc57ccb2001-10-12 02:38:24 +00003813 if (type->tp_as_buffer != NULL && base->tp_as_buffer != NULL) {
3814 basebase = base->tp_base;
3815 if (basebase->tp_as_buffer == NULL)
3816 basebase = NULL;
3817 COPYBUF(bf_getreadbuffer);
3818 COPYBUF(bf_getwritebuffer);
3819 COPYBUF(bf_getsegcount);
3820 COPYBUF(bf_getcharbuffer);
Christian Heimes1a6387e2008-03-26 12:49:49 +00003821 COPYBUF(bf_getbuffer);
3822 COPYBUF(bf_releasebuffer);
Tim Petersfc57ccb2001-10-12 02:38:24 +00003823 }
3824
Guido van Rossum13d52f02001-08-10 21:24:08 +00003825 basebase = base->tp_base;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003826
Tim Peters6d6c1a32001-08-02 04:15:00 +00003827 COPYSLOT(tp_dealloc);
3828 COPYSLOT(tp_print);
3829 if (type->tp_getattr == NULL && type->tp_getattro == NULL) {
3830 type->tp_getattr = base->tp_getattr;
3831 type->tp_getattro = base->tp_getattro;
3832 }
3833 if (type->tp_setattr == NULL && type->tp_setattro == NULL) {
3834 type->tp_setattr = base->tp_setattr;
3835 type->tp_setattro = base->tp_setattro;
3836 }
3837 /* tp_compare see tp_richcompare */
3838 COPYSLOT(tp_repr);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003839 /* tp_hash see tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003840 COPYSLOT(tp_call);
3841 COPYSLOT(tp_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003842 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00003843 if (type->tp_compare == NULL &&
3844 type->tp_richcompare == NULL &&
Nick Coghlan53663a62008-07-15 14:27:37 +00003845 type->tp_hash == NULL)
Guido van Rossumb8f63662001-08-15 23:57:02 +00003846 {
Tim Peters6d6c1a32001-08-02 04:15:00 +00003847 type->tp_compare = base->tp_compare;
3848 type->tp_richcompare = base->tp_richcompare;
Guido van Rossumb8f63662001-08-15 23:57:02 +00003849 type->tp_hash = base->tp_hash;
Nick Coghlan48361f52008-08-11 15:45:58 +00003850 /* Check for changes to inherited methods in Py3k*/
3851 if (Py_Py3kWarningFlag) {
3852 if (base->tp_hash &&
3853 (base->tp_hash != PyObject_HashNotImplemented) &&
3854 !OVERRIDES_HASH(type)) {
3855 if (OVERRIDES_CMP(type)) {
3856 PyErr_WarnPy3k("Overriding "
3857 "__cmp__ blocks inheritance "
3858 "of __hash__ in 3.x",
3859 1);
3860 }
3861 if (OVERRIDES_EQ(type)) {
3862 PyErr_WarnPy3k("Overriding "
3863 "__eq__ blocks inheritance "
3864 "of __hash__ in 3.x",
3865 1);
3866 }
3867 }
3868 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003869 }
3870 }
3871 else {
3872 COPYSLOT(tp_compare);
3873 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003874 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_ITER) {
3875 COPYSLOT(tp_iter);
3876 COPYSLOT(tp_iternext);
3877 }
3878 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
3879 COPYSLOT(tp_descr_get);
3880 COPYSLOT(tp_descr_set);
3881 COPYSLOT(tp_dictoffset);
3882 COPYSLOT(tp_init);
3883 COPYSLOT(tp_alloc);
Guido van Rossumcc8fe042002-04-05 17:10:16 +00003884 COPYSLOT(tp_is_gc);
Tim Peters3cfe7542003-05-21 21:29:48 +00003885 if ((type->tp_flags & Py_TPFLAGS_HAVE_GC) ==
3886 (base->tp_flags & Py_TPFLAGS_HAVE_GC)) {
3887 /* They agree about gc. */
3888 COPYSLOT(tp_free);
3889 }
3890 else if ((type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
3891 type->tp_free == NULL &&
3892 base->tp_free == _PyObject_Del) {
3893 /* A bit of magic to plug in the correct default
3894 * tp_free function when a derived class adds gc,
3895 * didn't define tp_free, and the base uses the
3896 * default non-gc tp_free.
3897 */
3898 type->tp_free = PyObject_GC_Del;
3899 }
3900 /* else they didn't agree about gc, and there isn't something
3901 * obvious to be done -- the type is on its own.
3902 */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003903 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003904}
3905
Jeremy Hylton938ace62002-07-17 16:30:39 +00003906static int add_operators(PyTypeObject *);
Guido van Rossum13d52f02001-08-10 21:24:08 +00003907
Tim Peters6d6c1a32001-08-02 04:15:00 +00003908int
Guido van Rossum528b7eb2001-08-07 17:24:28 +00003909PyType_Ready(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003910{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00003911 PyObject *dict, *bases;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003912 PyTypeObject *base;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003913 Py_ssize_t i, n;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003914
Guido van Rossumcab05802002-06-10 15:29:03 +00003915 if (type->tp_flags & Py_TPFLAGS_READY) {
3916 assert(type->tp_dict != NULL);
Guido van Rossumd614f972001-08-10 17:39:49 +00003917 return 0;
Guido van Rossumcab05802002-06-10 15:29:03 +00003918 }
Guido van Rossumd614f972001-08-10 17:39:49 +00003919 assert((type->tp_flags & Py_TPFLAGS_READYING) == 0);
Guido van Rossumd614f972001-08-10 17:39:49 +00003920
3921 type->tp_flags |= Py_TPFLAGS_READYING;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003922
Tim Peters36eb4df2003-03-23 03:33:13 +00003923#ifdef Py_TRACE_REFS
3924 /* PyType_Ready is the closest thing we have to a choke point
3925 * for type objects, so is the best place I can think of to try
3926 * to get type objects into the doubly-linked list of all objects.
3927 * Still, not all type objects go thru PyType_Ready.
3928 */
Tim Peters7571a0f2003-03-23 17:52:28 +00003929 _Py_AddToAllObjects((PyObject *)type, 0);
Tim Peters36eb4df2003-03-23 03:33:13 +00003930#endif
3931
Tim Peters6d6c1a32001-08-02 04:15:00 +00003932 /* Initialize tp_base (defaults to BaseObject unless that's us) */
3933 base = type->tp_base;
Martin v. Löwisbf608752004-08-18 13:16:54 +00003934 if (base == NULL && type != &PyBaseObject_Type) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00003935 base = type->tp_base = &PyBaseObject_Type;
Martin v. Löwisbf608752004-08-18 13:16:54 +00003936 Py_INCREF(base);
3937 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003938
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003939 /* Now the only way base can still be NULL is if type is
3940 * &PyBaseObject_Type.
3941 */
Guido van Rossum692cdbc2006-03-10 02:04:28 +00003942
Guido van Rossum323a9cf2002-08-14 17:26:30 +00003943 /* Initialize the base class */
3944 if (base && base->tp_dict == NULL) {
3945 if (PyType_Ready(base) < 0)
3946 goto error;
3947 }
3948
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003949 /* Initialize ob_type if NULL. This means extensions that want to be
Guido van Rossum0986d822002-04-08 01:38:42 +00003950 compilable separately on Windows can call PyType_Ready() instead of
3951 initializing the ob_type field of their type objects. */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003952 /* The test for base != NULL is really unnecessary, since base is only
3953 NULL when type is &PyBaseObject_Type, and we know its ob_type is
3954 not NULL (it's initialized to &PyType_Type). But coverity doesn't
3955 know that. */
Christian Heimese93237d2007-12-19 02:37:44 +00003956 if (Py_TYPE(type) == NULL && base != NULL)
3957 Py_TYPE(type) = Py_TYPE(base);
Guido van Rossum0986d822002-04-08 01:38:42 +00003958
Tim Peters6d6c1a32001-08-02 04:15:00 +00003959 /* Initialize tp_bases */
3960 bases = type->tp_bases;
3961 if (bases == NULL) {
3962 if (base == NULL)
3963 bases = PyTuple_New(0);
3964 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003965 bases = PyTuple_Pack(1, base);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003966 if (bases == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00003967 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003968 type->tp_bases = bases;
3969 }
3970
Guido van Rossum687ae002001-10-15 22:03:32 +00003971 /* Initialize tp_dict */
3972 dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003973 if (dict == NULL) {
3974 dict = PyDict_New();
3975 if (dict == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00003976 goto error;
Guido van Rossum687ae002001-10-15 22:03:32 +00003977 type->tp_dict = dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003978 }
3979
Guido van Rossum687ae002001-10-15 22:03:32 +00003980 /* Add type-specific descriptors to tp_dict */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003981 if (add_operators(type) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003982 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003983 if (type->tp_methods != NULL) {
3984 if (add_methods(type, type->tp_methods) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003985 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003986 }
3987 if (type->tp_members != NULL) {
3988 if (add_members(type, type->tp_members) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003989 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003990 }
3991 if (type->tp_getset != NULL) {
3992 if (add_getset(type, type->tp_getset) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003993 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003994 }
3995
Tim Peters6d6c1a32001-08-02 04:15:00 +00003996 /* Calculate method resolution order */
3997 if (mro_internal(type) < 0) {
Guido van Rossumd614f972001-08-10 17:39:49 +00003998 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003999 }
4000
Guido van Rossum13d52f02001-08-10 21:24:08 +00004001 /* Inherit special flags from dominant base */
4002 if (type->tp_base != NULL)
4003 inherit_special(type, type->tp_base);
4004
Tim Peters6d6c1a32001-08-02 04:15:00 +00004005 /* Initialize tp_dict properly */
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00004006 bases = type->tp_mro;
4007 assert(bases != NULL);
4008 assert(PyTuple_Check(bases));
4009 n = PyTuple_GET_SIZE(bases);
4010 for (i = 1; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00004011 PyObject *b = PyTuple_GET_ITEM(bases, i);
4012 if (PyType_Check(b))
4013 inherit_slots(type, (PyTypeObject *)b);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004014 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004015
Tim Peters3cfe7542003-05-21 21:29:48 +00004016 /* Sanity check for tp_free. */
4017 if (PyType_IS_GC(type) && (type->tp_flags & Py_TPFLAGS_BASETYPE) &&
4018 (type->tp_free == NULL || type->tp_free == PyObject_Del)) {
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00004019 /* This base class needs to call tp_free, but doesn't have
4020 * one, or its tp_free is for non-gc'ed objects.
4021 */
Tim Peters3cfe7542003-05-21 21:29:48 +00004022 PyErr_Format(PyExc_TypeError, "type '%.100s' participates in "
4023 "gc and is a base type but has inappropriate "
4024 "tp_free slot",
4025 type->tp_name);
4026 goto error;
4027 }
4028
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00004029 /* if the type dictionary doesn't contain a __doc__, set it from
4030 the tp_doc slot.
4031 */
4032 if (PyDict_GetItemString(type->tp_dict, "__doc__") == NULL) {
4033 if (type->tp_doc != NULL) {
Gregory P. Smithdd96db62008-06-09 04:58:54 +00004034 PyObject *doc = PyString_FromString(type->tp_doc);
Neal Norwitze1fdb322006-07-21 05:32:28 +00004035 if (doc == NULL)
4036 goto error;
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00004037 PyDict_SetItemString(type->tp_dict, "__doc__", doc);
4038 Py_DECREF(doc);
4039 } else {
Guido van Rossumd4641072002-04-03 02:13:37 +00004040 PyDict_SetItemString(type->tp_dict,
4041 "__doc__", Py_None);
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00004042 }
4043 }
4044
Guido van Rossum13d52f02001-08-10 21:24:08 +00004045 /* Some more special stuff */
4046 base = type->tp_base;
4047 if (base != NULL) {
4048 if (type->tp_as_number == NULL)
4049 type->tp_as_number = base->tp_as_number;
4050 if (type->tp_as_sequence == NULL)
4051 type->tp_as_sequence = base->tp_as_sequence;
4052 if (type->tp_as_mapping == NULL)
4053 type->tp_as_mapping = base->tp_as_mapping;
Guido van Rossumeea47182003-02-11 20:39:59 +00004054 if (type->tp_as_buffer == NULL)
4055 type->tp_as_buffer = base->tp_as_buffer;
Guido van Rossum13d52f02001-08-10 21:24:08 +00004056 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004057
Guido van Rossum1c450732001-10-08 15:18:27 +00004058 /* Link into each base class's list of subclasses */
4059 bases = type->tp_bases;
4060 n = PyTuple_GET_SIZE(bases);
4061 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00004062 PyObject *b = PyTuple_GET_ITEM(bases, i);
4063 if (PyType_Check(b) &&
4064 add_subclass((PyTypeObject *)b, type) < 0)
Guido van Rossum1c450732001-10-08 15:18:27 +00004065 goto error;
4066 }
4067
Guido van Rossum13d52f02001-08-10 21:24:08 +00004068 /* All done -- set the ready flag */
Guido van Rossumd614f972001-08-10 17:39:49 +00004069 assert(type->tp_dict != NULL);
4070 type->tp_flags =
4071 (type->tp_flags & ~Py_TPFLAGS_READYING) | Py_TPFLAGS_READY;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004072 return 0;
Guido van Rossumd614f972001-08-10 17:39:49 +00004073
4074 error:
4075 type->tp_flags &= ~Py_TPFLAGS_READYING;
4076 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004077}
4078
Guido van Rossum1c450732001-10-08 15:18:27 +00004079static int
4080add_subclass(PyTypeObject *base, PyTypeObject *type)
4081{
Martin v. Löwiseb079f12006-02-16 14:32:27 +00004082 Py_ssize_t i;
4083 int result;
Anthony Baxtera6286212006-04-11 07:42:36 +00004084 PyObject *list, *ref, *newobj;
Guido van Rossum1c450732001-10-08 15:18:27 +00004085
4086 list = base->tp_subclasses;
4087 if (list == NULL) {
4088 base->tp_subclasses = list = PyList_New(0);
4089 if (list == NULL)
4090 return -1;
4091 }
4092 assert(PyList_Check(list));
Anthony Baxtera6286212006-04-11 07:42:36 +00004093 newobj = PyWeakref_NewRef((PyObject *)type, NULL);
Guido van Rossum1c450732001-10-08 15:18:27 +00004094 i = PyList_GET_SIZE(list);
4095 while (--i >= 0) {
4096 ref = PyList_GET_ITEM(list, i);
4097 assert(PyWeakref_CheckRef(ref));
Guido van Rossum3930bc32002-10-18 13:51:49 +00004098 if (PyWeakref_GET_OBJECT(ref) == Py_None)
Anthony Baxtera6286212006-04-11 07:42:36 +00004099 return PyList_SetItem(list, i, newobj);
Guido van Rossum1c450732001-10-08 15:18:27 +00004100 }
Anthony Baxtera6286212006-04-11 07:42:36 +00004101 result = PyList_Append(list, newobj);
4102 Py_DECREF(newobj);
Martin v. Löwiseb079f12006-02-16 14:32:27 +00004103 return result;
Guido van Rossum1c450732001-10-08 15:18:27 +00004104}
4105
Michael W. Hudson98bbc492002-11-26 14:47:27 +00004106static void
4107remove_subclass(PyTypeObject *base, PyTypeObject *type)
4108{
Martin v. Löwis18e16552006-02-15 17:27:45 +00004109 Py_ssize_t i;
Michael W. Hudson98bbc492002-11-26 14:47:27 +00004110 PyObject *list, *ref;
4111
4112 list = base->tp_subclasses;
4113 if (list == NULL) {
4114 return;
4115 }
4116 assert(PyList_Check(list));
4117 i = PyList_GET_SIZE(list);
4118 while (--i >= 0) {
4119 ref = PyList_GET_ITEM(list, i);
4120 assert(PyWeakref_CheckRef(ref));
4121 if (PyWeakref_GET_OBJECT(ref) == (PyObject*)type) {
4122 /* this can't fail, right? */
4123 PySequence_DelItem(list, i);
4124 return;
4125 }
4126 }
4127}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004128
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004129static int
4130check_num_args(PyObject *ob, int n)
4131{
4132 if (!PyTuple_CheckExact(ob)) {
4133 PyErr_SetString(PyExc_SystemError,
4134 "PyArg_UnpackTuple() argument list is not a tuple");
4135 return 0;
4136 }
4137 if (n == PyTuple_GET_SIZE(ob))
4138 return 1;
4139 PyErr_Format(
4140 PyExc_TypeError,
Martin v. Löwis2c95cc62006-02-16 06:54:25 +00004141 "expected %d arguments, got %zd", n, PyTuple_GET_SIZE(ob));
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004142 return 0;
4143}
4144
Tim Peters6d6c1a32001-08-02 04:15:00 +00004145/* Generic wrappers for overloadable 'operators' such as __getitem__ */
4146
4147/* There's a wrapper *function* for each distinct function typedef used
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00004148 for type object slots (e.g. binaryfunc, ternaryfunc, etc.). There's a
Tim Peters6d6c1a32001-08-02 04:15:00 +00004149 wrapper *table* for each distinct operation (e.g. __len__, __add__).
4150 Most tables have only one entry; the tables for binary operators have two
4151 entries, one regular and one with reversed arguments. */
4152
4153static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00004154wrap_lenfunc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004155{
Martin v. Löwis18e16552006-02-15 17:27:45 +00004156 lenfunc func = (lenfunc)wrapped;
4157 Py_ssize_t res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004158
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004159 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004160 return NULL;
4161 res = (*func)(self);
4162 if (res == -1 && PyErr_Occurred())
4163 return NULL;
4164 return PyInt_FromLong((long)res);
4165}
4166
Tim Peters6d6c1a32001-08-02 04:15:00 +00004167static PyObject *
Raymond Hettingerf34f2642003-10-11 17:29:04 +00004168wrap_inquirypred(PyObject *self, PyObject *args, void *wrapped)
4169{
4170 inquiry func = (inquiry)wrapped;
4171 int res;
4172
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004173 if (!check_num_args(args, 0))
Raymond Hettingerf34f2642003-10-11 17:29:04 +00004174 return NULL;
4175 res = (*func)(self);
4176 if (res == -1 && PyErr_Occurred())
4177 return NULL;
4178 return PyBool_FromLong((long)res);
4179}
4180
4181static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00004182wrap_binaryfunc(PyObject *self, PyObject *args, void *wrapped)
4183{
4184 binaryfunc func = (binaryfunc)wrapped;
4185 PyObject *other;
4186
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004187 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004188 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004189 other = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004190 return (*func)(self, other);
4191}
4192
4193static PyObject *
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00004194wrap_binaryfunc_l(PyObject *self, PyObject *args, void *wrapped)
4195{
4196 binaryfunc func = (binaryfunc)wrapped;
4197 PyObject *other;
4198
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004199 if (!check_num_args(args, 1))
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00004200 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004201 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00004202 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004203 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00004204 Py_INCREF(Py_NotImplemented);
4205 return Py_NotImplemented;
4206 }
4207 return (*func)(self, other);
4208}
4209
4210static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00004211wrap_binaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
4212{
4213 binaryfunc func = (binaryfunc)wrapped;
4214 PyObject *other;
4215
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004216 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004217 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004218 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00004219 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004220 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00004221 Py_INCREF(Py_NotImplemented);
4222 return Py_NotImplemented;
4223 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004224 return (*func)(other, self);
4225}
4226
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004227static PyObject *
4228wrap_coercefunc(PyObject *self, PyObject *args, void *wrapped)
4229{
4230 coercion func = (coercion)wrapped;
4231 PyObject *other, *res;
4232 int ok;
4233
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004234 if (!check_num_args(args, 1))
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004235 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004236 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004237 ok = func(&self, &other);
4238 if (ok < 0)
4239 return NULL;
4240 if (ok > 0) {
4241 Py_INCREF(Py_NotImplemented);
4242 return Py_NotImplemented;
4243 }
4244 res = PyTuple_New(2);
4245 if (res == NULL) {
4246 Py_DECREF(self);
4247 Py_DECREF(other);
4248 return NULL;
4249 }
4250 PyTuple_SET_ITEM(res, 0, self);
4251 PyTuple_SET_ITEM(res, 1, other);
4252 return res;
4253}
4254
Tim Peters6d6c1a32001-08-02 04:15:00 +00004255static PyObject *
4256wrap_ternaryfunc(PyObject *self, PyObject *args, void *wrapped)
4257{
4258 ternaryfunc func = (ternaryfunc)wrapped;
4259 PyObject *other;
4260 PyObject *third = Py_None;
4261
4262 /* Note: This wrapper only works for __pow__() */
4263
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00004264 if (!PyArg_UnpackTuple(args, "", 1, 2, &other, &third))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004265 return NULL;
4266 return (*func)(self, other, third);
4267}
4268
Guido van Rossum9bea3ab2001-09-28 22:58:52 +00004269static PyObject *
4270wrap_ternaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
4271{
4272 ternaryfunc func = (ternaryfunc)wrapped;
4273 PyObject *other;
4274 PyObject *third = Py_None;
4275
4276 /* Note: This wrapper only works for __pow__() */
4277
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00004278 if (!PyArg_UnpackTuple(args, "", 1, 2, &other, &third))
Guido van Rossum9bea3ab2001-09-28 22:58:52 +00004279 return NULL;
4280 return (*func)(other, self, third);
4281}
4282
Tim Peters6d6c1a32001-08-02 04:15:00 +00004283static PyObject *
4284wrap_unaryfunc(PyObject *self, PyObject *args, void *wrapped)
4285{
4286 unaryfunc func = (unaryfunc)wrapped;
4287
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004288 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004289 return NULL;
4290 return (*func)(self);
4291}
4292
Tim Peters6d6c1a32001-08-02 04:15:00 +00004293static PyObject *
Armin Rigo314861c2006-03-30 14:04:02 +00004294wrap_indexargfunc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004295{
Martin v. Löwis18e16552006-02-15 17:27:45 +00004296 ssizeargfunc func = (ssizeargfunc)wrapped;
Armin Rigo314861c2006-03-30 14:04:02 +00004297 PyObject* o;
Martin v. Löwis18e16552006-02-15 17:27:45 +00004298 Py_ssize_t i;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004299
Armin Rigo314861c2006-03-30 14:04:02 +00004300 if (!PyArg_UnpackTuple(args, "", 1, 1, &o))
4301 return NULL;
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00004302 i = PyNumber_AsSsize_t(o, PyExc_OverflowError);
Armin Rigo314861c2006-03-30 14:04:02 +00004303 if (i == -1 && PyErr_Occurred())
Tim Peters6d6c1a32001-08-02 04:15:00 +00004304 return NULL;
4305 return (*func)(self, i);
4306}
4307
Martin v. Löwis18e16552006-02-15 17:27:45 +00004308static Py_ssize_t
Guido van Rossum5d815f32001-08-17 21:57:47 +00004309getindex(PyObject *self, PyObject *arg)
4310{
Martin v. Löwis18e16552006-02-15 17:27:45 +00004311 Py_ssize_t i;
Guido van Rossum5d815f32001-08-17 21:57:47 +00004312
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00004313 i = PyNumber_AsSsize_t(arg, PyExc_OverflowError);
Guido van Rossum5d815f32001-08-17 21:57:47 +00004314 if (i == -1 && PyErr_Occurred())
4315 return -1;
4316 if (i < 0) {
Christian Heimese93237d2007-12-19 02:37:44 +00004317 PySequenceMethods *sq = Py_TYPE(self)->tp_as_sequence;
Guido van Rossum5d815f32001-08-17 21:57:47 +00004318 if (sq && sq->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00004319 Py_ssize_t n = (*sq->sq_length)(self);
Guido van Rossum5d815f32001-08-17 21:57:47 +00004320 if (n < 0)
4321 return -1;
4322 i += n;
4323 }
4324 }
4325 return i;
4326}
4327
4328static PyObject *
4329wrap_sq_item(PyObject *self, PyObject *args, void *wrapped)
4330{
Martin v. Löwis18e16552006-02-15 17:27:45 +00004331 ssizeargfunc func = (ssizeargfunc)wrapped;
Guido van Rossum5d815f32001-08-17 21:57:47 +00004332 PyObject *arg;
Martin v. Löwis18e16552006-02-15 17:27:45 +00004333 Py_ssize_t i;
Guido van Rossum5d815f32001-08-17 21:57:47 +00004334
Guido van Rossumf4593e02001-10-03 12:09:30 +00004335 if (PyTuple_GET_SIZE(args) == 1) {
4336 arg = PyTuple_GET_ITEM(args, 0);
4337 i = getindex(self, arg);
4338 if (i == -1 && PyErr_Occurred())
4339 return NULL;
4340 return (*func)(self, i);
4341 }
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004342 check_num_args(args, 1);
Guido van Rossumf4593e02001-10-03 12:09:30 +00004343 assert(PyErr_Occurred());
4344 return NULL;
Guido van Rossum5d815f32001-08-17 21:57:47 +00004345}
4346
Tim Peters6d6c1a32001-08-02 04:15:00 +00004347static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00004348wrap_ssizessizeargfunc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004349{
Martin v. Löwis18e16552006-02-15 17:27:45 +00004350 ssizessizeargfunc func = (ssizessizeargfunc)wrapped;
4351 Py_ssize_t i, j;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004352
Martin v. Löwis18e16552006-02-15 17:27:45 +00004353 if (!PyArg_ParseTuple(args, "nn", &i, &j))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004354 return NULL;
4355 return (*func)(self, i, j);
4356}
4357
Tim Peters6d6c1a32001-08-02 04:15:00 +00004358static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00004359wrap_sq_setitem(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004360{
Martin v. Löwis18e16552006-02-15 17:27:45 +00004361 ssizeobjargproc func = (ssizeobjargproc)wrapped;
4362 Py_ssize_t i;
4363 int res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00004364 PyObject *arg, *value;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004365
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00004366 if (!PyArg_UnpackTuple(args, "", 2, 2, &arg, &value))
Guido van Rossum5d815f32001-08-17 21:57:47 +00004367 return NULL;
4368 i = getindex(self, arg);
4369 if (i == -1 && PyErr_Occurred())
Tim Peters6d6c1a32001-08-02 04:15:00 +00004370 return NULL;
4371 res = (*func)(self, i, value);
4372 if (res == -1 && PyErr_Occurred())
4373 return NULL;
4374 Py_INCREF(Py_None);
4375 return Py_None;
4376}
4377
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00004378static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00004379wrap_sq_delitem(PyObject *self, PyObject *args, void *wrapped)
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00004380{
Martin v. Löwis18e16552006-02-15 17:27:45 +00004381 ssizeobjargproc func = (ssizeobjargproc)wrapped;
4382 Py_ssize_t i;
4383 int res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00004384 PyObject *arg;
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00004385
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004386 if (!check_num_args(args, 1))
Guido van Rossum5d815f32001-08-17 21:57:47 +00004387 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004388 arg = PyTuple_GET_ITEM(args, 0);
Guido van Rossum5d815f32001-08-17 21:57:47 +00004389 i = getindex(self, arg);
4390 if (i == -1 && PyErr_Occurred())
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00004391 return NULL;
4392 res = (*func)(self, i, NULL);
4393 if (res == -1 && PyErr_Occurred())
4394 return NULL;
4395 Py_INCREF(Py_None);
4396 return Py_None;
4397}
4398
Tim Peters6d6c1a32001-08-02 04:15:00 +00004399static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00004400wrap_ssizessizeobjargproc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004401{
Martin v. Löwis18e16552006-02-15 17:27:45 +00004402 ssizessizeobjargproc func = (ssizessizeobjargproc)wrapped;
4403 Py_ssize_t i, j;
4404 int res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004405 PyObject *value;
4406
Martin v. Löwis18e16552006-02-15 17:27:45 +00004407 if (!PyArg_ParseTuple(args, "nnO", &i, &j, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004408 return NULL;
4409 res = (*func)(self, i, j, value);
4410 if (res == -1 && PyErr_Occurred())
4411 return NULL;
4412 Py_INCREF(Py_None);
4413 return Py_None;
4414}
4415
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004416static PyObject *
4417wrap_delslice(PyObject *self, PyObject *args, void *wrapped)
4418{
Martin v. Löwis18e16552006-02-15 17:27:45 +00004419 ssizessizeobjargproc func = (ssizessizeobjargproc)wrapped;
4420 Py_ssize_t i, j;
4421 int res;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004422
Martin v. Löwis18e16552006-02-15 17:27:45 +00004423 if (!PyArg_ParseTuple(args, "nn", &i, &j))
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004424 return NULL;
4425 res = (*func)(self, i, j, NULL);
4426 if (res == -1 && PyErr_Occurred())
4427 return NULL;
4428 Py_INCREF(Py_None);
4429 return Py_None;
4430}
4431
Tim Peters6d6c1a32001-08-02 04:15:00 +00004432/* XXX objobjproc is a misnomer; should be objargpred */
4433static PyObject *
4434wrap_objobjproc(PyObject *self, PyObject *args, void *wrapped)
4435{
4436 objobjproc func = (objobjproc)wrapped;
4437 int res;
Guido van Rossum22c3dda2003-10-09 03:46:35 +00004438 PyObject *value;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004439
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004440 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004441 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004442 value = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004443 res = (*func)(self, value);
4444 if (res == -1 && PyErr_Occurred())
4445 return NULL;
Guido van Rossum22c3dda2003-10-09 03:46:35 +00004446 else
4447 return PyBool_FromLong(res);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004448}
4449
Tim Peters6d6c1a32001-08-02 04:15:00 +00004450static PyObject *
4451wrap_objobjargproc(PyObject *self, PyObject *args, void *wrapped)
4452{
4453 objobjargproc func = (objobjargproc)wrapped;
4454 int res;
4455 PyObject *key, *value;
4456
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00004457 if (!PyArg_UnpackTuple(args, "", 2, 2, &key, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004458 return NULL;
4459 res = (*func)(self, key, value);
4460 if (res == -1 && PyErr_Occurred())
4461 return NULL;
4462 Py_INCREF(Py_None);
4463 return Py_None;
4464}
4465
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00004466static PyObject *
4467wrap_delitem(PyObject *self, PyObject *args, void *wrapped)
4468{
4469 objobjargproc func = (objobjargproc)wrapped;
4470 int res;
4471 PyObject *key;
4472
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004473 if (!check_num_args(args, 1))
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00004474 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004475 key = PyTuple_GET_ITEM(args, 0);
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00004476 res = (*func)(self, key, NULL);
4477 if (res == -1 && PyErr_Occurred())
4478 return NULL;
4479 Py_INCREF(Py_None);
4480 return Py_None;
4481}
4482
Tim Peters6d6c1a32001-08-02 04:15:00 +00004483static PyObject *
4484wrap_cmpfunc(PyObject *self, PyObject *args, void *wrapped)
4485{
4486 cmpfunc func = (cmpfunc)wrapped;
4487 int res;
4488 PyObject *other;
4489
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004490 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004491 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004492 other = PyTuple_GET_ITEM(args, 0);
Christian Heimese93237d2007-12-19 02:37:44 +00004493 if (Py_TYPE(other)->tp_compare != func &&
4494 !PyType_IsSubtype(Py_TYPE(other), Py_TYPE(self))) {
Guido van Rossumceccae52001-09-18 20:03:57 +00004495 PyErr_Format(
4496 PyExc_TypeError,
4497 "%s.__cmp__(x,y) requires y to be a '%s', not a '%s'",
Christian Heimese93237d2007-12-19 02:37:44 +00004498 Py_TYPE(self)->tp_name,
4499 Py_TYPE(self)->tp_name,
4500 Py_TYPE(other)->tp_name);
Guido van Rossumceccae52001-09-18 20:03:57 +00004501 return NULL;
4502 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004503 res = (*func)(self, other);
4504 if (PyErr_Occurred())
4505 return NULL;
4506 return PyInt_FromLong((long)res);
4507}
4508
Guido van Rossum4dcdb782003-04-14 21:46:03 +00004509/* Helper to check for object.__setattr__ or __delattr__ applied to a type.
Guido van Rossum52b27052003-04-15 20:05:10 +00004510 This is called the Carlo Verre hack after its discoverer. */
Guido van Rossum4dcdb782003-04-14 21:46:03 +00004511static int
4512hackcheck(PyObject *self, setattrofunc func, char *what)
4513{
Christian Heimese93237d2007-12-19 02:37:44 +00004514 PyTypeObject *type = Py_TYPE(self);
Guido van Rossum4dcdb782003-04-14 21:46:03 +00004515 while (type && type->tp_flags & Py_TPFLAGS_HEAPTYPE)
4516 type = type->tp_base;
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00004517 /* If type is NULL now, this is a really weird type.
4518 In the spirit of backwards compatibility (?), just shut up. */
Guido van Rossum692cdbc2006-03-10 02:04:28 +00004519 if (type && type->tp_setattro != func) {
Guido van Rossum4dcdb782003-04-14 21:46:03 +00004520 PyErr_Format(PyExc_TypeError,
4521 "can't apply this %s to %s object",
4522 what,
4523 type->tp_name);
4524 return 0;
4525 }
4526 return 1;
4527}
4528
Tim Peters6d6c1a32001-08-02 04:15:00 +00004529static PyObject *
4530wrap_setattr(PyObject *self, PyObject *args, void *wrapped)
4531{
4532 setattrofunc func = (setattrofunc)wrapped;
4533 int res;
4534 PyObject *name, *value;
4535
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00004536 if (!PyArg_UnpackTuple(args, "", 2, 2, &name, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004537 return NULL;
Guido van Rossum4dcdb782003-04-14 21:46:03 +00004538 if (!hackcheck(self, func, "__setattr__"))
4539 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004540 res = (*func)(self, name, value);
4541 if (res < 0)
4542 return NULL;
4543 Py_INCREF(Py_None);
4544 return Py_None;
4545}
4546
4547static PyObject *
4548wrap_delattr(PyObject *self, PyObject *args, void *wrapped)
4549{
4550 setattrofunc func = (setattrofunc)wrapped;
4551 int res;
4552 PyObject *name;
4553
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004554 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004555 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004556 name = PyTuple_GET_ITEM(args, 0);
Guido van Rossum4dcdb782003-04-14 21:46:03 +00004557 if (!hackcheck(self, func, "__delattr__"))
4558 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004559 res = (*func)(self, name, NULL);
4560 if (res < 0)
4561 return NULL;
4562 Py_INCREF(Py_None);
4563 return Py_None;
4564}
4565
Tim Peters6d6c1a32001-08-02 04:15:00 +00004566static PyObject *
4567wrap_hashfunc(PyObject *self, PyObject *args, void *wrapped)
4568{
4569 hashfunc func = (hashfunc)wrapped;
4570 long res;
4571
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004572 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004573 return NULL;
4574 res = (*func)(self);
4575 if (res == -1 && PyErr_Occurred())
4576 return NULL;
4577 return PyInt_FromLong(res);
4578}
4579
Tim Peters6d6c1a32001-08-02 04:15:00 +00004580static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00004581wrap_call(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004582{
4583 ternaryfunc func = (ternaryfunc)wrapped;
4584
Guido van Rossumc8e56452001-10-22 00:43:43 +00004585 return (*func)(self, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004586}
4587
Tim Peters6d6c1a32001-08-02 04:15:00 +00004588static PyObject *
4589wrap_richcmpfunc(PyObject *self, PyObject *args, void *wrapped, int op)
4590{
4591 richcmpfunc func = (richcmpfunc)wrapped;
4592 PyObject *other;
4593
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004594 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004595 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004596 other = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004597 return (*func)(self, other, op);
4598}
4599
4600#undef RICHCMP_WRAPPER
4601#define RICHCMP_WRAPPER(NAME, OP) \
4602static PyObject * \
4603richcmp_##NAME(PyObject *self, PyObject *args, void *wrapped) \
4604{ \
4605 return wrap_richcmpfunc(self, args, wrapped, OP); \
4606}
4607
Jack Jansen8e938b42001-08-08 15:29:49 +00004608RICHCMP_WRAPPER(lt, Py_LT)
4609RICHCMP_WRAPPER(le, Py_LE)
4610RICHCMP_WRAPPER(eq, Py_EQ)
4611RICHCMP_WRAPPER(ne, Py_NE)
4612RICHCMP_WRAPPER(gt, Py_GT)
4613RICHCMP_WRAPPER(ge, Py_GE)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004614
Tim Peters6d6c1a32001-08-02 04:15:00 +00004615static PyObject *
4616wrap_next(PyObject *self, PyObject *args, void *wrapped)
4617{
4618 unaryfunc func = (unaryfunc)wrapped;
4619 PyObject *res;
4620
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004621 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004622 return NULL;
4623 res = (*func)(self);
4624 if (res == NULL && !PyErr_Occurred())
4625 PyErr_SetNone(PyExc_StopIteration);
4626 return res;
4627}
4628
Tim Peters6d6c1a32001-08-02 04:15:00 +00004629static PyObject *
4630wrap_descr_get(PyObject *self, PyObject *args, void *wrapped)
4631{
4632 descrgetfunc func = (descrgetfunc)wrapped;
4633 PyObject *obj;
4634 PyObject *type = NULL;
4635
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00004636 if (!PyArg_UnpackTuple(args, "", 1, 2, &obj, &type))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004637 return NULL;
Guido van Rossum82ed25c2003-02-11 16:25:43 +00004638 if (obj == Py_None)
4639 obj = NULL;
4640 if (type == Py_None)
4641 type = NULL;
4642 if (type == NULL &&obj == NULL) {
4643 PyErr_SetString(PyExc_TypeError,
4644 "__get__(None, None) is invalid");
4645 return NULL;
4646 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004647 return (*func)(self, obj, type);
4648}
4649
Tim Peters6d6c1a32001-08-02 04:15:00 +00004650static PyObject *
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004651wrap_descr_set(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004652{
4653 descrsetfunc func = (descrsetfunc)wrapped;
4654 PyObject *obj, *value;
4655 int ret;
4656
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00004657 if (!PyArg_UnpackTuple(args, "", 2, 2, &obj, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004658 return NULL;
4659 ret = (*func)(self, obj, value);
4660 if (ret < 0)
4661 return NULL;
4662 Py_INCREF(Py_None);
4663 return Py_None;
4664}
Guido van Rossum22b13872002-08-06 21:41:44 +00004665
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00004666static PyObject *
4667wrap_descr_delete(PyObject *self, PyObject *args, void *wrapped)
4668{
4669 descrsetfunc func = (descrsetfunc)wrapped;
4670 PyObject *obj;
4671 int ret;
4672
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004673 if (!check_num_args(args, 1))
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00004674 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004675 obj = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00004676 ret = (*func)(self, obj, NULL);
4677 if (ret < 0)
4678 return NULL;
4679 Py_INCREF(Py_None);
4680 return Py_None;
4681}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004682
Tim Peters6d6c1a32001-08-02 04:15:00 +00004683static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00004684wrap_init(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004685{
4686 initproc func = (initproc)wrapped;
4687
Guido van Rossumc8e56452001-10-22 00:43:43 +00004688 if (func(self, args, kwds) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004689 return NULL;
4690 Py_INCREF(Py_None);
4691 return Py_None;
4692}
4693
Tim Peters6d6c1a32001-08-02 04:15:00 +00004694static PyObject *
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004695tp_new_wrapper(PyObject *self, PyObject *args, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004696{
Barry Warsaw60f01882001-08-22 19:24:42 +00004697 PyTypeObject *type, *subtype, *staticbase;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004698 PyObject *arg0, *res;
4699
4700 if (self == NULL || !PyType_Check(self))
4701 Py_FatalError("__new__() called with non-type 'self'");
4702 type = (PyTypeObject *)self;
4703 if (!PyTuple_Check(args) || PyTuple_GET_SIZE(args) < 1) {
Barry Warsaw60f01882001-08-22 19:24:42 +00004704 PyErr_Format(PyExc_TypeError,
4705 "%s.__new__(): not enough arguments",
4706 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004707 return NULL;
4708 }
4709 arg0 = PyTuple_GET_ITEM(args, 0);
4710 if (!PyType_Check(arg0)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00004711 PyErr_Format(PyExc_TypeError,
4712 "%s.__new__(X): X is not a type object (%s)",
4713 type->tp_name,
Christian Heimese93237d2007-12-19 02:37:44 +00004714 Py_TYPE(arg0)->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004715 return NULL;
4716 }
4717 subtype = (PyTypeObject *)arg0;
4718 if (!PyType_IsSubtype(subtype, type)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00004719 PyErr_Format(PyExc_TypeError,
4720 "%s.__new__(%s): %s is not a subtype of %s",
4721 type->tp_name,
4722 subtype->tp_name,
4723 subtype->tp_name,
4724 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004725 return NULL;
4726 }
Barry Warsaw60f01882001-08-22 19:24:42 +00004727
4728 /* Check that the use doesn't do something silly and unsafe like
Tim Petersa427a2b2001-10-29 22:25:45 +00004729 object.__new__(dict). To do this, we check that the
Barry Warsaw60f01882001-08-22 19:24:42 +00004730 most derived base that's not a heap type is this type. */
4731 staticbase = subtype;
4732 while (staticbase && (staticbase->tp_flags & Py_TPFLAGS_HEAPTYPE))
4733 staticbase = staticbase->tp_base;
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00004734 /* If staticbase is NULL now, it is a really weird type.
4735 In the spirit of backwards compatibility (?), just shut up. */
Guido van Rossum692cdbc2006-03-10 02:04:28 +00004736 if (staticbase && staticbase->tp_new != type->tp_new) {
Barry Warsaw60f01882001-08-22 19:24:42 +00004737 PyErr_Format(PyExc_TypeError,
4738 "%s.__new__(%s) is not safe, use %s.__new__()",
4739 type->tp_name,
4740 subtype->tp_name,
4741 staticbase == NULL ? "?" : staticbase->tp_name);
4742 return NULL;
4743 }
4744
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004745 args = PyTuple_GetSlice(args, 1, PyTuple_GET_SIZE(args));
4746 if (args == NULL)
4747 return NULL;
4748 res = type->tp_new(subtype, args, kwds);
4749 Py_DECREF(args);
4750 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004751}
4752
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004753static struct PyMethodDef tp_new_methoddef[] = {
Neal Norwitza84dcd72007-05-22 07:16:44 +00004754 {"__new__", (PyCFunction)tp_new_wrapper, METH_VARARGS|METH_KEYWORDS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00004755 PyDoc_STR("T.__new__(S, ...) -> "
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00004756 "a new object with type S, a subtype of T")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00004757 {0}
4758};
4759
4760static int
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004761add_tp_new_wrapper(PyTypeObject *type)
4762{
Guido van Rossumf040ede2001-08-07 16:40:56 +00004763 PyObject *func;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004764
Guido van Rossum687ae002001-10-15 22:03:32 +00004765 if (PyDict_GetItemString(type->tp_dict, "__new__") != NULL)
Guido van Rossumf040ede2001-08-07 16:40:56 +00004766 return 0;
4767 func = PyCFunction_New(tp_new_methoddef, (PyObject *)type);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004768 if (func == NULL)
4769 return -1;
Raymond Hettinger8d726ee2004-06-25 22:24:35 +00004770 if (PyDict_SetItemString(type->tp_dict, "__new__", func)) {
Raymond Hettingerd56cbe52004-06-25 22:17:39 +00004771 Py_DECREF(func);
4772 return -1;
4773 }
4774 Py_DECREF(func);
4775 return 0;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004776}
4777
Guido van Rossumf040ede2001-08-07 16:40:56 +00004778/* Slot wrappers that call the corresponding __foo__ slot. See comments
4779 below at override_slots() for more explanation. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004780
Guido van Rossumdc91b992001-08-08 22:26:22 +00004781#define SLOT0(FUNCNAME, OPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004782static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004783FUNCNAME(PyObject *self) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004784{ \
Guido van Rossum5592e4d2001-08-28 18:28:21 +00004785 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00004786 return call_method(self, OPSTR, &cache_str, "()"); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004787}
4788
Guido van Rossumdc91b992001-08-08 22:26:22 +00004789#define SLOT1(FUNCNAME, OPSTR, ARG1TYPE, ARGCODES) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004790static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004791FUNCNAME(PyObject *self, ARG1TYPE arg1) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004792{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004793 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00004794 return call_method(self, OPSTR, &cache_str, "(" ARGCODES ")", arg1); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004795}
4796
Guido van Rossumcd118802003-01-06 22:57:47 +00004797/* Boolean helper for SLOT1BINFULL().
4798 right.__class__ is a nontrivial subclass of left.__class__. */
4799static int
4800method_is_overloaded(PyObject *left, PyObject *right, char *name)
4801{
4802 PyObject *a, *b;
4803 int ok;
4804
Christian Heimese93237d2007-12-19 02:37:44 +00004805 b = PyObject_GetAttrString((PyObject *)(Py_TYPE(right)), name);
Guido van Rossumcd118802003-01-06 22:57:47 +00004806 if (b == NULL) {
4807 PyErr_Clear();
4808 /* If right doesn't have it, it's not overloaded */
4809 return 0;
4810 }
4811
Christian Heimese93237d2007-12-19 02:37:44 +00004812 a = PyObject_GetAttrString((PyObject *)(Py_TYPE(left)), name);
Guido van Rossumcd118802003-01-06 22:57:47 +00004813 if (a == NULL) {
4814 PyErr_Clear();
4815 Py_DECREF(b);
4816 /* If right has it but left doesn't, it's overloaded */
4817 return 1;
4818 }
4819
4820 ok = PyObject_RichCompareBool(a, b, Py_NE);
4821 Py_DECREF(a);
4822 Py_DECREF(b);
4823 if (ok < 0) {
4824 PyErr_Clear();
4825 return 0;
4826 }
4827
4828 return ok;
4829}
4830
Guido van Rossumdc91b992001-08-08 22:26:22 +00004831
4832#define SLOT1BINFULL(FUNCNAME, TESTFUNC, SLOTNAME, OPSTR, ROPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004833static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004834FUNCNAME(PyObject *self, PyObject *other) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004835{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004836 static PyObject *cache_str, *rcache_str; \
Christian Heimese93237d2007-12-19 02:37:44 +00004837 int do_other = Py_TYPE(self) != Py_TYPE(other) && \
4838 Py_TYPE(other)->tp_as_number != NULL && \
4839 Py_TYPE(other)->tp_as_number->SLOTNAME == TESTFUNC; \
4840 if (Py_TYPE(self)->tp_as_number != NULL && \
4841 Py_TYPE(self)->tp_as_number->SLOTNAME == TESTFUNC) { \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004842 PyObject *r; \
Guido van Rossum55f20992001-10-01 17:18:22 +00004843 if (do_other && \
Christian Heimese93237d2007-12-19 02:37:44 +00004844 PyType_IsSubtype(Py_TYPE(other), Py_TYPE(self)) && \
Guido van Rossumcd118802003-01-06 22:57:47 +00004845 method_is_overloaded(self, other, ROPSTR)) { \
Guido van Rossum55f20992001-10-01 17:18:22 +00004846 r = call_maybe( \
4847 other, ROPSTR, &rcache_str, "(O)", self); \
4848 if (r != Py_NotImplemented) \
4849 return r; \
4850 Py_DECREF(r); \
4851 do_other = 0; \
4852 } \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00004853 r = call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00004854 self, OPSTR, &cache_str, "(O)", other); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004855 if (r != Py_NotImplemented || \
Christian Heimese93237d2007-12-19 02:37:44 +00004856 Py_TYPE(other) == Py_TYPE(self)) \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004857 return r; \
4858 Py_DECREF(r); \
4859 } \
Guido van Rossum55f20992001-10-01 17:18:22 +00004860 if (do_other) { \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00004861 return call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00004862 other, ROPSTR, &rcache_str, "(O)", self); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004863 } \
4864 Py_INCREF(Py_NotImplemented); \
4865 return Py_NotImplemented; \
4866}
4867
4868#define SLOT1BIN(FUNCNAME, SLOTNAME, OPSTR, ROPSTR) \
4869 SLOT1BINFULL(FUNCNAME, FUNCNAME, SLOTNAME, OPSTR, ROPSTR)
4870
4871#define SLOT2(FUNCNAME, OPSTR, ARG1TYPE, ARG2TYPE, ARGCODES) \
4872static PyObject * \
4873FUNCNAME(PyObject *self, ARG1TYPE arg1, ARG2TYPE arg2) \
4874{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004875 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00004876 return call_method(self, OPSTR, &cache_str, \
4877 "(" ARGCODES ")", arg1, arg2); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004878}
4879
Martin v. Löwis18e16552006-02-15 17:27:45 +00004880static Py_ssize_t
Tim Peters6d6c1a32001-08-02 04:15:00 +00004881slot_sq_length(PyObject *self)
4882{
Guido van Rossum2730b132001-08-28 18:22:14 +00004883 static PyObject *len_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00004884 PyObject *res = call_method(self, "__len__", &len_str, "()");
Martin v. Löwis18e16552006-02-15 17:27:45 +00004885 Py_ssize_t len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004886
4887 if (res == NULL)
4888 return -1;
Neal Norwitz1872b1c2006-08-12 18:44:06 +00004889 len = PyInt_AsSsize_t(res);
Guido van Rossum26111622001-10-01 16:42:49 +00004890 Py_DECREF(res);
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00004891 if (len < 0) {
Armin Rigo7ccbca92006-10-04 12:17:45 +00004892 if (!PyErr_Occurred())
4893 PyErr_SetString(PyExc_ValueError,
4894 "__len__() should return >= 0");
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00004895 return -1;
4896 }
Guido van Rossum26111622001-10-01 16:42:49 +00004897 return len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004898}
4899
Guido van Rossumf4593e02001-10-03 12:09:30 +00004900/* Super-optimized version of slot_sq_item.
4901 Other slots could do the same... */
4902static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00004903slot_sq_item(PyObject *self, Py_ssize_t i)
Guido van Rossumf4593e02001-10-03 12:09:30 +00004904{
4905 static PyObject *getitem_str;
4906 PyObject *func, *args = NULL, *ival = NULL, *retval = NULL;
4907 descrgetfunc f;
4908
4909 if (getitem_str == NULL) {
Gregory P. Smithdd96db62008-06-09 04:58:54 +00004910 getitem_str = PyString_InternFromString("__getitem__");
Guido van Rossumf4593e02001-10-03 12:09:30 +00004911 if (getitem_str == NULL)
4912 return NULL;
4913 }
Christian Heimese93237d2007-12-19 02:37:44 +00004914 func = _PyType_Lookup(Py_TYPE(self), getitem_str);
Guido van Rossumf4593e02001-10-03 12:09:30 +00004915 if (func != NULL) {
Christian Heimese93237d2007-12-19 02:37:44 +00004916 if ((f = Py_TYPE(func)->tp_descr_get) == NULL)
Guido van Rossumf4593e02001-10-03 12:09:30 +00004917 Py_INCREF(func);
Neal Norwitz673cd822002-10-18 16:33:13 +00004918 else {
Christian Heimese93237d2007-12-19 02:37:44 +00004919 func = f(func, self, (PyObject *)(Py_TYPE(self)));
Neal Norwitz673cd822002-10-18 16:33:13 +00004920 if (func == NULL) {
4921 return NULL;
4922 }
4923 }
Martin v. Löwiseb079f12006-02-16 14:32:27 +00004924 ival = PyInt_FromSsize_t(i);
Guido van Rossumf4593e02001-10-03 12:09:30 +00004925 if (ival != NULL) {
4926 args = PyTuple_New(1);
4927 if (args != NULL) {
4928 PyTuple_SET_ITEM(args, 0, ival);
4929 retval = PyObject_Call(func, args, NULL);
4930 Py_XDECREF(args);
4931 Py_XDECREF(func);
4932 return retval;
4933 }
4934 }
4935 }
4936 else {
4937 PyErr_SetObject(PyExc_AttributeError, getitem_str);
4938 }
4939 Py_XDECREF(args);
4940 Py_XDECREF(ival);
4941 Py_XDECREF(func);
4942 return NULL;
4943}
4944
Benjamin Peterson712ee922008-08-24 18:10:20 +00004945static PyObject*
4946slot_sq_slice(PyObject *self, Py_ssize_t i, Py_ssize_t j)
4947{
4948 static PyObject *getslice_str;
4949
4950 if (PyErr_WarnPy3k("in 3.x, __getslice__ has been removed; "
4951 "use __getitem__", 1) < 0)
4952 return NULL;
4953 return call_method(self, "__getslice__", &getslice_str,
4954 "nn", i, j);
4955}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004956
4957static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00004958slot_sq_ass_item(PyObject *self, Py_ssize_t index, PyObject *value)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004959{
4960 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004961 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004962
4963 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004964 res = call_method(self, "__delitem__", &delitem_str,
Thomas Wouters4e908102006-04-21 11:26:56 +00004965 "(n)", index);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004966 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004967 res = call_method(self, "__setitem__", &setitem_str,
Thomas Wouters4e908102006-04-21 11:26:56 +00004968 "(nO)", index, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004969 if (res == NULL)
4970 return -1;
4971 Py_DECREF(res);
4972 return 0;
4973}
4974
4975static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00004976slot_sq_ass_slice(PyObject *self, Py_ssize_t i, Py_ssize_t j, PyObject *value)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004977{
4978 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004979 static PyObject *delslice_str, *setslice_str;
Benjamin Peterson712ee922008-08-24 18:10:20 +00004980
4981 if (value == NULL) {
4982 if (PyErr_WarnPy3k("in 3.x, __delslice__ has been removed; "
4983 "use __delitem__", 1) < 0)
4984 return -1;
Guido van Rossum2730b132001-08-28 18:22:14 +00004985 res = call_method(self, "__delslice__", &delslice_str,
Thomas Wouters4e908102006-04-21 11:26:56 +00004986 "(nn)", i, j);
Benjamin Peterson712ee922008-08-24 18:10:20 +00004987 }
4988 else {
4989 if (PyErr_WarnPy3k("in 3.x, __setslice__ has been removed; "
4990 "use __setitem__", 1) < 0)
4991 return -1;
Guido van Rossum2730b132001-08-28 18:22:14 +00004992 res = call_method(self, "__setslice__", &setslice_str,
Benjamin Peterson712ee922008-08-24 18:10:20 +00004993 "(nnO)", i, j, value);
4994 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004995 if (res == NULL)
4996 return -1;
4997 Py_DECREF(res);
4998 return 0;
4999}
5000
5001static int
5002slot_sq_contains(PyObject *self, PyObject *value)
5003{
Guido van Rossumb8f63662001-08-15 23:57:02 +00005004 PyObject *func, *res, *args;
Tim Petersbf9b2442003-03-23 05:35:36 +00005005 int result = -1;
5006
Guido van Rossum60718732001-08-28 17:47:51 +00005007 static PyObject *contains_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005008
Guido van Rossum55f20992001-10-01 17:18:22 +00005009 func = lookup_maybe(self, "__contains__", &contains_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005010 if (func != NULL) {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00005011 args = PyTuple_Pack(1, value);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005012 if (args == NULL)
5013 res = NULL;
5014 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00005015 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005016 Py_DECREF(args);
5017 }
5018 Py_DECREF(func);
Tim Petersbf9b2442003-03-23 05:35:36 +00005019 if (res != NULL) {
5020 result = PyObject_IsTrue(res);
5021 Py_DECREF(res);
5022 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00005023 }
Tim Petersbf9b2442003-03-23 05:35:36 +00005024 else if (! PyErr_Occurred()) {
Martin v. Löwis725507b2006-03-07 12:08:51 +00005025 /* Possible results: -1 and 1 */
5026 result = (int)_PySequence_IterSearch(self, value,
Tim Petersbf9b2442003-03-23 05:35:36 +00005027 PY_ITERSEARCH_CONTAINS);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005028 }
Tim Petersbf9b2442003-03-23 05:35:36 +00005029 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005030}
5031
Tim Peters6d6c1a32001-08-02 04:15:00 +00005032#define slot_mp_length slot_sq_length
5033
Guido van Rossumdc91b992001-08-08 22:26:22 +00005034SLOT1(slot_mp_subscript, "__getitem__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00005035
5036static int
5037slot_mp_ass_subscript(PyObject *self, PyObject *key, PyObject *value)
5038{
5039 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00005040 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005041
5042 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00005043 res = call_method(self, "__delitem__", &delitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00005044 "(O)", key);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005045 else
Guido van Rossum2730b132001-08-28 18:22:14 +00005046 res = call_method(self, "__setitem__", &setitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00005047 "(OO)", key, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005048 if (res == NULL)
5049 return -1;
5050 Py_DECREF(res);
5051 return 0;
5052}
5053
Guido van Rossumdc91b992001-08-08 22:26:22 +00005054SLOT1BIN(slot_nb_add, nb_add, "__add__", "__radd__")
5055SLOT1BIN(slot_nb_subtract, nb_subtract, "__sub__", "__rsub__")
5056SLOT1BIN(slot_nb_multiply, nb_multiply, "__mul__", "__rmul__")
5057SLOT1BIN(slot_nb_divide, nb_divide, "__div__", "__rdiv__")
5058SLOT1BIN(slot_nb_remainder, nb_remainder, "__mod__", "__rmod__")
5059SLOT1BIN(slot_nb_divmod, nb_divmod, "__divmod__", "__rdivmod__")
5060
Jeremy Hylton938ace62002-07-17 16:30:39 +00005061static PyObject *slot_nb_power(PyObject *, PyObject *, PyObject *);
Guido van Rossumdc91b992001-08-08 22:26:22 +00005062
5063SLOT1BINFULL(slot_nb_power_binary, slot_nb_power,
5064 nb_power, "__pow__", "__rpow__")
5065
5066static PyObject *
5067slot_nb_power(PyObject *self, PyObject *other, PyObject *modulus)
5068{
Guido van Rossum2730b132001-08-28 18:22:14 +00005069 static PyObject *pow_str;
5070
Guido van Rossumdc91b992001-08-08 22:26:22 +00005071 if (modulus == Py_None)
5072 return slot_nb_power_binary(self, other);
Guido van Rossum23094982002-06-10 14:30:43 +00005073 /* Three-arg power doesn't use __rpow__. But ternary_op
5074 can call this when the second argument's type uses
5075 slot_nb_power, so check before calling self.__pow__. */
Christian Heimese93237d2007-12-19 02:37:44 +00005076 if (Py_TYPE(self)->tp_as_number != NULL &&
5077 Py_TYPE(self)->tp_as_number->nb_power == slot_nb_power) {
Guido van Rossum23094982002-06-10 14:30:43 +00005078 return call_method(self, "__pow__", &pow_str,
5079 "(OO)", other, modulus);
5080 }
5081 Py_INCREF(Py_NotImplemented);
5082 return Py_NotImplemented;
Guido van Rossumdc91b992001-08-08 22:26:22 +00005083}
5084
5085SLOT0(slot_nb_negative, "__neg__")
5086SLOT0(slot_nb_positive, "__pos__")
5087SLOT0(slot_nb_absolute, "__abs__")
Tim Peters6d6c1a32001-08-02 04:15:00 +00005088
5089static int
5090slot_nb_nonzero(PyObject *self)
5091{
Tim Petersea7f75d2002-12-07 21:39:16 +00005092 PyObject *func, *args;
Guido van Rossum60718732001-08-28 17:47:51 +00005093 static PyObject *nonzero_str, *len_str;
Tim Petersea7f75d2002-12-07 21:39:16 +00005094 int result = -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005095
Guido van Rossum55f20992001-10-01 17:18:22 +00005096 func = lookup_maybe(self, "__nonzero__", &nonzero_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005097 if (func == NULL) {
Guido van Rossum55f20992001-10-01 17:18:22 +00005098 if (PyErr_Occurred())
Guido van Rossumb8f63662001-08-15 23:57:02 +00005099 return -1;
Guido van Rossum55f20992001-10-01 17:18:22 +00005100 func = lookup_maybe(self, "__len__", &len_str);
Tim Petersea7f75d2002-12-07 21:39:16 +00005101 if (func == NULL)
5102 return PyErr_Occurred() ? -1 : 1;
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005103 }
Tim Petersea7f75d2002-12-07 21:39:16 +00005104 args = PyTuple_New(0);
5105 if (args != NULL) {
5106 PyObject *temp = PyObject_Call(func, args, NULL);
5107 Py_DECREF(args);
5108 if (temp != NULL) {
Jeremy Hylton3e3159c2003-06-27 17:38:27 +00005109 if (PyInt_CheckExact(temp) || PyBool_Check(temp))
Jeremy Hylton090a3492003-06-27 16:46:45 +00005110 result = PyObject_IsTrue(temp);
5111 else {
5112 PyErr_Format(PyExc_TypeError,
5113 "__nonzero__ should return "
5114 "bool or int, returned %s",
5115 temp->ob_type->tp_name);
Jeremy Hylton3e3159c2003-06-27 17:38:27 +00005116 result = -1;
Jeremy Hylton090a3492003-06-27 16:46:45 +00005117 }
Tim Petersea7f75d2002-12-07 21:39:16 +00005118 Py_DECREF(temp);
Guido van Rossum55f20992001-10-01 17:18:22 +00005119 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00005120 }
Guido van Rossum55f20992001-10-01 17:18:22 +00005121 Py_DECREF(func);
Tim Petersea7f75d2002-12-07 21:39:16 +00005122 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005123}
5124
Guido van Rossum38fff8c2006-03-07 18:50:55 +00005125
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00005126static PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00005127slot_nb_index(PyObject *self)
5128{
Guido van Rossum38fff8c2006-03-07 18:50:55 +00005129 static PyObject *index_str;
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00005130 return call_method(self, "__index__", &index_str, "()");
Guido van Rossum38fff8c2006-03-07 18:50:55 +00005131}
5132
5133
Guido van Rossumdc91b992001-08-08 22:26:22 +00005134SLOT0(slot_nb_invert, "__invert__")
5135SLOT1BIN(slot_nb_lshift, nb_lshift, "__lshift__", "__rlshift__")
5136SLOT1BIN(slot_nb_rshift, nb_rshift, "__rshift__", "__rrshift__")
5137SLOT1BIN(slot_nb_and, nb_and, "__and__", "__rand__")
5138SLOT1BIN(slot_nb_xor, nb_xor, "__xor__", "__rxor__")
5139SLOT1BIN(slot_nb_or, nb_or, "__or__", "__ror__")
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00005140
5141static int
5142slot_nb_coerce(PyObject **a, PyObject **b)
5143{
5144 static PyObject *coerce_str;
5145 PyObject *self = *a, *other = *b;
5146
5147 if (self->ob_type->tp_as_number != NULL &&
5148 self->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
5149 PyObject *r;
5150 r = call_maybe(
5151 self, "__coerce__", &coerce_str, "(O)", other);
5152 if (r == NULL)
5153 return -1;
5154 if (r == Py_NotImplemented) {
5155 Py_DECREF(r);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00005156 }
Guido van Rossum55f20992001-10-01 17:18:22 +00005157 else {
5158 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
5159 PyErr_SetString(PyExc_TypeError,
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00005160 "__coerce__ didn't return a 2-tuple");
Guido van Rossum55f20992001-10-01 17:18:22 +00005161 Py_DECREF(r);
5162 return -1;
5163 }
5164 *a = PyTuple_GET_ITEM(r, 0);
5165 Py_INCREF(*a);
5166 *b = PyTuple_GET_ITEM(r, 1);
5167 Py_INCREF(*b);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00005168 Py_DECREF(r);
Guido van Rossum55f20992001-10-01 17:18:22 +00005169 return 0;
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00005170 }
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00005171 }
5172 if (other->ob_type->tp_as_number != NULL &&
5173 other->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
5174 PyObject *r;
5175 r = call_maybe(
5176 other, "__coerce__", &coerce_str, "(O)", self);
5177 if (r == NULL)
5178 return -1;
5179 if (r == Py_NotImplemented) {
5180 Py_DECREF(r);
5181 return 1;
5182 }
5183 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
5184 PyErr_SetString(PyExc_TypeError,
5185 "__coerce__ didn't return a 2-tuple");
5186 Py_DECREF(r);
5187 return -1;
5188 }
5189 *a = PyTuple_GET_ITEM(r, 1);
5190 Py_INCREF(*a);
5191 *b = PyTuple_GET_ITEM(r, 0);
5192 Py_INCREF(*b);
5193 Py_DECREF(r);
5194 return 0;
5195 }
5196 return 1;
5197}
5198
Guido van Rossumdc91b992001-08-08 22:26:22 +00005199SLOT0(slot_nb_int, "__int__")
5200SLOT0(slot_nb_long, "__long__")
5201SLOT0(slot_nb_float, "__float__")
5202SLOT0(slot_nb_oct, "__oct__")
5203SLOT0(slot_nb_hex, "__hex__")
5204SLOT1(slot_nb_inplace_add, "__iadd__", PyObject *, "O")
5205SLOT1(slot_nb_inplace_subtract, "__isub__", PyObject *, "O")
5206SLOT1(slot_nb_inplace_multiply, "__imul__", PyObject *, "O")
5207SLOT1(slot_nb_inplace_divide, "__idiv__", PyObject *, "O")
5208SLOT1(slot_nb_inplace_remainder, "__imod__", PyObject *, "O")
Martin v. Löwisfd963262007-02-09 12:19:32 +00005209/* Can't use SLOT1 here, because nb_inplace_power is ternary */
5210static PyObject *
5211slot_nb_inplace_power(PyObject *self, PyObject * arg1, PyObject *arg2)
5212{
5213 static PyObject *cache_str;
5214 return call_method(self, "__ipow__", &cache_str, "(" "O" ")", arg1);
5215}
Guido van Rossumdc91b992001-08-08 22:26:22 +00005216SLOT1(slot_nb_inplace_lshift, "__ilshift__", PyObject *, "O")
5217SLOT1(slot_nb_inplace_rshift, "__irshift__", PyObject *, "O")
5218SLOT1(slot_nb_inplace_and, "__iand__", PyObject *, "O")
5219SLOT1(slot_nb_inplace_xor, "__ixor__", PyObject *, "O")
5220SLOT1(slot_nb_inplace_or, "__ior__", PyObject *, "O")
5221SLOT1BIN(slot_nb_floor_divide, nb_floor_divide,
5222 "__floordiv__", "__rfloordiv__")
5223SLOT1BIN(slot_nb_true_divide, nb_true_divide, "__truediv__", "__rtruediv__")
5224SLOT1(slot_nb_inplace_floor_divide, "__ifloordiv__", PyObject *, "O")
5225SLOT1(slot_nb_inplace_true_divide, "__itruediv__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00005226
5227static int
Guido van Rossumb8f63662001-08-15 23:57:02 +00005228half_compare(PyObject *self, PyObject *other)
Tim Peters6d6c1a32001-08-02 04:15:00 +00005229{
Guido van Rossumb8f63662001-08-15 23:57:02 +00005230 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00005231 static PyObject *cmp_str;
Martin v. Löwis18e16552006-02-15 17:27:45 +00005232 Py_ssize_t c;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005233
Guido van Rossum60718732001-08-28 17:47:51 +00005234 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005235 if (func == NULL) {
5236 PyErr_Clear();
5237 }
5238 else {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00005239 args = PyTuple_Pack(1, other);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005240 if (args == NULL)
5241 res = NULL;
5242 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00005243 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005244 Py_DECREF(args);
5245 }
Raymond Hettingerab5dae32002-06-24 13:08:16 +00005246 Py_DECREF(func);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005247 if (res != Py_NotImplemented) {
5248 if (res == NULL)
5249 return -2;
5250 c = PyInt_AsLong(res);
5251 Py_DECREF(res);
5252 if (c == -1 && PyErr_Occurred())
5253 return -2;
5254 return (c < 0) ? -1 : (c > 0) ? 1 : 0;
5255 }
5256 Py_DECREF(res);
5257 }
5258 return 2;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005259}
5260
Guido van Rossumab3b0342001-09-18 20:38:53 +00005261/* This slot is published for the benefit of try_3way_compare in object.c */
5262int
5263_PyObject_SlotCompare(PyObject *self, PyObject *other)
Guido van Rossumb8f63662001-08-15 23:57:02 +00005264{
5265 int c;
5266
Christian Heimese93237d2007-12-19 02:37:44 +00005267 if (Py_TYPE(self)->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00005268 c = half_compare(self, other);
5269 if (c <= 1)
5270 return c;
5271 }
Christian Heimese93237d2007-12-19 02:37:44 +00005272 if (Py_TYPE(other)->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00005273 c = half_compare(other, self);
5274 if (c < -1)
5275 return -2;
5276 if (c <= 1)
5277 return -c;
5278 }
5279 return (void *)self < (void *)other ? -1 :
5280 (void *)self > (void *)other ? 1 : 0;
5281}
5282
5283static PyObject *
5284slot_tp_repr(PyObject *self)
5285{
5286 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00005287 static PyObject *repr_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00005288
Guido van Rossum60718732001-08-28 17:47:51 +00005289 func = lookup_method(self, "__repr__", &repr_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005290 if (func != NULL) {
5291 res = PyEval_CallObject(func, NULL);
5292 Py_DECREF(func);
5293 return res;
5294 }
Barry Warsaw7ce36942001-08-24 18:34:26 +00005295 PyErr_Clear();
Gregory P. Smithdd96db62008-06-09 04:58:54 +00005296 return PyString_FromFormat("<%s object at %p>",
Christian Heimese93237d2007-12-19 02:37:44 +00005297 Py_TYPE(self)->tp_name, self);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005298}
5299
5300static PyObject *
5301slot_tp_str(PyObject *self)
5302{
5303 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00005304 static PyObject *str_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00005305
Guido van Rossum60718732001-08-28 17:47:51 +00005306 func = lookup_method(self, "__str__", &str_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005307 if (func != NULL) {
5308 res = PyEval_CallObject(func, NULL);
5309 Py_DECREF(func);
5310 return res;
5311 }
5312 else {
5313 PyErr_Clear();
5314 return slot_tp_repr(self);
5315 }
5316}
Tim Peters6d6c1a32001-08-02 04:15:00 +00005317
5318static long
5319slot_tp_hash(PyObject *self)
5320{
Tim Peters61ce0a92002-12-06 23:38:02 +00005321 PyObject *func;
Guido van Rossum60718732001-08-28 17:47:51 +00005322 static PyObject *hash_str, *eq_str, *cmp_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005323 long h;
5324
Guido van Rossum60718732001-08-28 17:47:51 +00005325 func = lookup_method(self, "__hash__", &hash_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005326
Guido van Rossum0b7b6fd2007-12-19 22:51:13 +00005327 if (func != NULL && func != Py_None) {
Tim Peters61ce0a92002-12-06 23:38:02 +00005328 PyObject *res = PyEval_CallObject(func, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005329 Py_DECREF(func);
5330 if (res == NULL)
5331 return -1;
Martin v. Löwisab2f8f72006-08-09 07:57:39 +00005332 if (PyLong_Check(res))
Armin Rigo51fc8c42006-08-09 14:55:26 +00005333 h = PyLong_Type.tp_hash(res);
Martin v. Löwisab2f8f72006-08-09 07:57:39 +00005334 else
5335 h = PyInt_AsLong(res);
Tim Peters61ce0a92002-12-06 23:38:02 +00005336 Py_DECREF(res);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005337 }
5338 else {
Georg Brandl30b78042007-12-20 21:03:02 +00005339 Py_XDECREF(func); /* may be None */
Guido van Rossumb8f63662001-08-15 23:57:02 +00005340 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00005341 func = lookup_method(self, "__eq__", &eq_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005342 if (func == NULL) {
5343 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00005344 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005345 }
5346 if (func != NULL) {
5347 Py_DECREF(func);
Nick Coghlan53663a62008-07-15 14:27:37 +00005348 return PyObject_HashNotImplemented(self);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005349 }
5350 PyErr_Clear();
5351 h = _Py_HashPointer((void *)self);
5352 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00005353 if (h == -1 && !PyErr_Occurred())
5354 h = -2;
5355 return h;
5356}
5357
5358static PyObject *
5359slot_tp_call(PyObject *self, PyObject *args, PyObject *kwds)
5360{
Guido van Rossum60718732001-08-28 17:47:51 +00005361 static PyObject *call_str;
5362 PyObject *meth = lookup_method(self, "__call__", &call_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005363 PyObject *res;
5364
5365 if (meth == NULL)
5366 return NULL;
Armin Rigo53c1692f2006-06-21 21:58:50 +00005367
Tim Peters6d6c1a32001-08-02 04:15:00 +00005368 res = PyObject_Call(meth, args, kwds);
Armin Rigo53c1692f2006-06-21 21:58:50 +00005369
Tim Peters6d6c1a32001-08-02 04:15:00 +00005370 Py_DECREF(meth);
5371 return res;
5372}
5373
Guido van Rossum14a6f832001-10-17 13:59:09 +00005374/* There are two slot dispatch functions for tp_getattro.
5375
5376 - slot_tp_getattro() is used when __getattribute__ is overridden
5377 but no __getattr__ hook is present;
5378
5379 - slot_tp_getattr_hook() is used when a __getattr__ hook is present.
5380
Guido van Rossumc334df52002-04-04 23:44:47 +00005381 The code in update_one_slot() always installs slot_tp_getattr_hook(); this
5382 detects the absence of __getattr__ and then installs the simpler slot if
5383 necessary. */
Guido van Rossum14a6f832001-10-17 13:59:09 +00005384
Tim Peters6d6c1a32001-08-02 04:15:00 +00005385static PyObject *
5386slot_tp_getattro(PyObject *self, PyObject *name)
5387{
Guido van Rossum14a6f832001-10-17 13:59:09 +00005388 static PyObject *getattribute_str = NULL;
5389 return call_method(self, "__getattribute__", &getattribute_str,
5390 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005391}
5392
Guido van Rossum19c1cd52001-09-21 21:24:49 +00005393static PyObject *
Benjamin Peterson273c2332008-11-17 22:39:09 +00005394call_attribute(PyObject *self, PyObject *attr, PyObject *name)
5395{
5396 PyObject *res, *descr = NULL;
5397 descrgetfunc f = Py_TYPE(attr)->tp_descr_get;
5398
5399 if (f != NULL) {
5400 descr = f(attr, self, (PyObject *)(Py_TYPE(self)));
5401 if (descr == NULL)
5402 return NULL;
5403 else
5404 attr = descr;
5405 }
5406 res = PyObject_CallFunctionObjArgs(attr, name, NULL);
5407 Py_XDECREF(descr);
5408 return res;
5409}
5410
5411static PyObject *
Guido van Rossum19c1cd52001-09-21 21:24:49 +00005412slot_tp_getattr_hook(PyObject *self, PyObject *name)
5413{
Christian Heimese93237d2007-12-19 02:37:44 +00005414 PyTypeObject *tp = Py_TYPE(self);
Guido van Rossum19c1cd52001-09-21 21:24:49 +00005415 PyObject *getattr, *getattribute, *res;
5416 static PyObject *getattribute_str = NULL;
5417 static PyObject *getattr_str = NULL;
5418
5419 if (getattr_str == NULL) {
Gregory P. Smithdd96db62008-06-09 04:58:54 +00005420 getattr_str = PyString_InternFromString("__getattr__");
Guido van Rossum19c1cd52001-09-21 21:24:49 +00005421 if (getattr_str == NULL)
5422 return NULL;
5423 }
5424 if (getattribute_str == NULL) {
5425 getattribute_str =
Gregory P. Smithdd96db62008-06-09 04:58:54 +00005426 PyString_InternFromString("__getattribute__");
Guido van Rossum19c1cd52001-09-21 21:24:49 +00005427 if (getattribute_str == NULL)
5428 return NULL;
5429 }
Benjamin Peterson273c2332008-11-17 22:39:09 +00005430 /* speed hack: we could use lookup_maybe, but that would resolve the
5431 method fully for each attribute lookup for classes with
5432 __getattr__, even when the attribute is present. So we use
5433 _PyType_Lookup and create the method only when needed, with
5434 call_attribute. */
Guido van Rossum19c1cd52001-09-21 21:24:49 +00005435 getattr = _PyType_Lookup(tp, getattr_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00005436 if (getattr == NULL) {
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005437 /* No __getattr__ hook: use a simpler dispatcher */
5438 tp->tp_getattro = slot_tp_getattro;
5439 return slot_tp_getattro(self, name);
5440 }
Benjamin Peterson273c2332008-11-17 22:39:09 +00005441 Py_INCREF(getattr);
5442 /* speed hack: we could use lookup_maybe, but that would resolve the
5443 method fully for each attribute lookup for classes with
5444 __getattr__, even when self has the default __getattribute__
5445 method. So we use _PyType_Lookup and create the method only when
5446 needed, with call_attribute. */
Guido van Rossum19c1cd52001-09-21 21:24:49 +00005447 getattribute = _PyType_Lookup(tp, getattribute_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00005448 if (getattribute == NULL ||
Christian Heimese93237d2007-12-19 02:37:44 +00005449 (Py_TYPE(getattribute) == &PyWrapperDescr_Type &&
Guido van Rossum14a6f832001-10-17 13:59:09 +00005450 ((PyWrapperDescrObject *)getattribute)->d_wrapped ==
5451 (void *)PyObject_GenericGetAttr))
Guido van Rossum19c1cd52001-09-21 21:24:49 +00005452 res = PyObject_GenericGetAttr(self, name);
Benjamin Peterson273c2332008-11-17 22:39:09 +00005453 else {
5454 Py_INCREF(getattribute);
5455 res = call_attribute(self, getattribute, name);
5456 Py_DECREF(getattribute);
5457 }
Guido van Rossum14a6f832001-10-17 13:59:09 +00005458 if (res == NULL && PyErr_ExceptionMatches(PyExc_AttributeError)) {
Guido van Rossum19c1cd52001-09-21 21:24:49 +00005459 PyErr_Clear();
Benjamin Peterson273c2332008-11-17 22:39:09 +00005460 res = call_attribute(self, getattr, name);
Guido van Rossum19c1cd52001-09-21 21:24:49 +00005461 }
Benjamin Peterson273c2332008-11-17 22:39:09 +00005462 Py_DECREF(getattr);
Guido van Rossum19c1cd52001-09-21 21:24:49 +00005463 return res;
5464}
5465
Tim Peters6d6c1a32001-08-02 04:15:00 +00005466static int
5467slot_tp_setattro(PyObject *self, PyObject *name, PyObject *value)
5468{
5469 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00005470 static PyObject *delattr_str, *setattr_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005471
5472 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00005473 res = call_method(self, "__delattr__", &delattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00005474 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005475 else
Guido van Rossum2730b132001-08-28 18:22:14 +00005476 res = call_method(self, "__setattr__", &setattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00005477 "(OO)", name, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005478 if (res == NULL)
5479 return -1;
5480 Py_DECREF(res);
5481 return 0;
5482}
5483
Guido van Rossum0b7b6fd2007-12-19 22:51:13 +00005484static char *name_op[] = {
5485 "__lt__",
5486 "__le__",
5487 "__eq__",
5488 "__ne__",
5489 "__gt__",
5490 "__ge__",
5491};
5492
Tim Peters6d6c1a32001-08-02 04:15:00 +00005493static PyObject *
Guido van Rossumb8f63662001-08-15 23:57:02 +00005494half_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters6d6c1a32001-08-02 04:15:00 +00005495{
Guido van Rossumb8f63662001-08-15 23:57:02 +00005496 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00005497 static PyObject *op_str[6];
Tim Peters6d6c1a32001-08-02 04:15:00 +00005498
Guido van Rossum60718732001-08-28 17:47:51 +00005499 func = lookup_method(self, name_op[op], &op_str[op]);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005500 if (func == NULL) {
5501 PyErr_Clear();
5502 Py_INCREF(Py_NotImplemented);
5503 return Py_NotImplemented;
5504 }
Raymond Hettinger8ae46892003-10-12 19:09:37 +00005505 args = PyTuple_Pack(1, other);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005506 if (args == NULL)
5507 res = NULL;
5508 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00005509 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005510 Py_DECREF(args);
5511 }
5512 Py_DECREF(func);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005513 return res;
5514}
5515
Guido van Rossumb8f63662001-08-15 23:57:02 +00005516static PyObject *
5517slot_tp_richcompare(PyObject *self, PyObject *other, int op)
5518{
5519 PyObject *res;
5520
Christian Heimese93237d2007-12-19 02:37:44 +00005521 if (Py_TYPE(self)->tp_richcompare == slot_tp_richcompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00005522 res = half_richcompare(self, other, op);
5523 if (res != Py_NotImplemented)
5524 return res;
5525 Py_DECREF(res);
5526 }
Christian Heimese93237d2007-12-19 02:37:44 +00005527 if (Py_TYPE(other)->tp_richcompare == slot_tp_richcompare) {
Tim Petersf4aca752004-09-23 02:39:37 +00005528 res = half_richcompare(other, self, _Py_SwappedOp[op]);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005529 if (res != Py_NotImplemented) {
5530 return res;
5531 }
5532 Py_DECREF(res);
5533 }
5534 Py_INCREF(Py_NotImplemented);
5535 return Py_NotImplemented;
5536}
5537
5538static PyObject *
5539slot_tp_iter(PyObject *self)
5540{
5541 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00005542 static PyObject *iter_str, *getitem_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00005543
Guido van Rossum60718732001-08-28 17:47:51 +00005544 func = lookup_method(self, "__iter__", &iter_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005545 if (func != NULL) {
Guido van Rossum84b2bed2002-08-16 17:01:09 +00005546 PyObject *args;
5547 args = res = PyTuple_New(0);
5548 if (args != NULL) {
5549 res = PyObject_Call(func, args, NULL);
5550 Py_DECREF(args);
5551 }
5552 Py_DECREF(func);
5553 return res;
Guido van Rossumb8f63662001-08-15 23:57:02 +00005554 }
5555 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00005556 func = lookup_method(self, "__getitem__", &getitem_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005557 if (func == NULL) {
Georg Brandlccff7852006-06-18 22:17:29 +00005558 PyErr_Format(PyExc_TypeError,
5559 "'%.200s' object is not iterable",
Christian Heimese93237d2007-12-19 02:37:44 +00005560 Py_TYPE(self)->tp_name);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005561 return NULL;
5562 }
5563 Py_DECREF(func);
5564 return PySeqIter_New(self);
5565}
Tim Peters6d6c1a32001-08-02 04:15:00 +00005566
5567static PyObject *
5568slot_tp_iternext(PyObject *self)
5569{
Guido van Rossum2730b132001-08-28 18:22:14 +00005570 static PyObject *next_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00005571 return call_method(self, "next", &next_str, "()");
Tim Peters6d6c1a32001-08-02 04:15:00 +00005572}
5573
Guido van Rossum1a493502001-08-17 16:47:50 +00005574static PyObject *
5575slot_tp_descr_get(PyObject *self, PyObject *obj, PyObject *type)
5576{
Christian Heimese93237d2007-12-19 02:37:44 +00005577 PyTypeObject *tp = Py_TYPE(self);
Guido van Rossum1a493502001-08-17 16:47:50 +00005578 PyObject *get;
5579 static PyObject *get_str = NULL;
5580
5581 if (get_str == NULL) {
Gregory P. Smithdd96db62008-06-09 04:58:54 +00005582 get_str = PyString_InternFromString("__get__");
Guido van Rossum1a493502001-08-17 16:47:50 +00005583 if (get_str == NULL)
5584 return NULL;
5585 }
5586 get = _PyType_Lookup(tp, get_str);
5587 if (get == NULL) {
5588 /* Avoid further slowdowns */
5589 if (tp->tp_descr_get == slot_tp_descr_get)
5590 tp->tp_descr_get = NULL;
5591 Py_INCREF(self);
5592 return self;
5593 }
Guido van Rossum2c252392001-08-24 10:13:31 +00005594 if (obj == NULL)
5595 obj = Py_None;
5596 if (type == NULL)
5597 type = Py_None;
Georg Brandl684fd0c2006-05-25 19:15:31 +00005598 return PyObject_CallFunctionObjArgs(get, self, obj, type, NULL);
Guido van Rossum1a493502001-08-17 16:47:50 +00005599}
Tim Peters6d6c1a32001-08-02 04:15:00 +00005600
5601static int
5602slot_tp_descr_set(PyObject *self, PyObject *target, PyObject *value)
5603{
Guido van Rossum2c252392001-08-24 10:13:31 +00005604 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00005605 static PyObject *del_str, *set_str;
Guido van Rossum2c252392001-08-24 10:13:31 +00005606
5607 if (value == NULL)
Guido van Rossum1d5b3f22001-12-03 00:08:33 +00005608 res = call_method(self, "__delete__", &del_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00005609 "(O)", target);
Guido van Rossum2c252392001-08-24 10:13:31 +00005610 else
Guido van Rossum2730b132001-08-28 18:22:14 +00005611 res = call_method(self, "__set__", &set_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00005612 "(OO)", target, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005613 if (res == NULL)
5614 return -1;
5615 Py_DECREF(res);
5616 return 0;
5617}
5618
5619static int
5620slot_tp_init(PyObject *self, PyObject *args, PyObject *kwds)
5621{
Guido van Rossum60718732001-08-28 17:47:51 +00005622 static PyObject *init_str;
5623 PyObject *meth = lookup_method(self, "__init__", &init_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005624 PyObject *res;
5625
5626 if (meth == NULL)
5627 return -1;
5628 res = PyObject_Call(meth, args, kwds);
5629 Py_DECREF(meth);
5630 if (res == NULL)
5631 return -1;
Raymond Hettingerb67cc802005-03-03 16:45:19 +00005632 if (res != Py_None) {
Georg Brandlccff7852006-06-18 22:17:29 +00005633 PyErr_Format(PyExc_TypeError,
5634 "__init__() should return None, not '%.200s'",
Christian Heimese93237d2007-12-19 02:37:44 +00005635 Py_TYPE(res)->tp_name);
Raymond Hettingerb67cc802005-03-03 16:45:19 +00005636 Py_DECREF(res);
5637 return -1;
5638 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00005639 Py_DECREF(res);
5640 return 0;
5641}
5642
5643static PyObject *
5644slot_tp_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
5645{
Guido van Rossum7bed2132002-08-08 21:57:53 +00005646 static PyObject *new_str;
5647 PyObject *func;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005648 PyObject *newargs, *x;
Martin v. Löwis18e16552006-02-15 17:27:45 +00005649 Py_ssize_t i, n;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005650
Guido van Rossum7bed2132002-08-08 21:57:53 +00005651 if (new_str == NULL) {
Gregory P. Smithdd96db62008-06-09 04:58:54 +00005652 new_str = PyString_InternFromString("__new__");
Guido van Rossum7bed2132002-08-08 21:57:53 +00005653 if (new_str == NULL)
5654 return NULL;
5655 }
5656 func = PyObject_GetAttr((PyObject *)type, new_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005657 if (func == NULL)
5658 return NULL;
5659 assert(PyTuple_Check(args));
5660 n = PyTuple_GET_SIZE(args);
5661 newargs = PyTuple_New(n+1);
5662 if (newargs == NULL)
5663 return NULL;
5664 Py_INCREF(type);
5665 PyTuple_SET_ITEM(newargs, 0, (PyObject *)type);
5666 for (i = 0; i < n; i++) {
5667 x = PyTuple_GET_ITEM(args, i);
5668 Py_INCREF(x);
5669 PyTuple_SET_ITEM(newargs, i+1, x);
5670 }
5671 x = PyObject_Call(func, newargs, kwds);
Guido van Rossum25d18072001-10-01 15:55:28 +00005672 Py_DECREF(newargs);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005673 Py_DECREF(func);
5674 return x;
5675}
5676
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005677static void
5678slot_tp_del(PyObject *self)
5679{
5680 static PyObject *del_str = NULL;
5681 PyObject *del, *res;
5682 PyObject *error_type, *error_value, *error_traceback;
5683
5684 /* Temporarily resurrect the object. */
5685 assert(self->ob_refcnt == 0);
5686 self->ob_refcnt = 1;
5687
5688 /* Save the current exception, if any. */
5689 PyErr_Fetch(&error_type, &error_value, &error_traceback);
5690
5691 /* Execute __del__ method, if any. */
5692 del = lookup_maybe(self, "__del__", &del_str);
5693 if (del != NULL) {
5694 res = PyEval_CallObject(del, NULL);
5695 if (res == NULL)
5696 PyErr_WriteUnraisable(del);
5697 else
5698 Py_DECREF(res);
5699 Py_DECREF(del);
5700 }
5701
5702 /* Restore the saved exception. */
5703 PyErr_Restore(error_type, error_value, error_traceback);
5704
5705 /* Undo the temporary resurrection; can't use DECREF here, it would
5706 * cause a recursive call.
5707 */
5708 assert(self->ob_refcnt > 0);
5709 if (--self->ob_refcnt == 0)
5710 return; /* this is the normal path out */
5711
5712 /* __del__ resurrected it! Make it look like the original Py_DECREF
5713 * never happened.
5714 */
5715 {
Martin v. Löwis725507b2006-03-07 12:08:51 +00005716 Py_ssize_t refcnt = self->ob_refcnt;
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005717 _Py_NewReference(self);
5718 self->ob_refcnt = refcnt;
5719 }
Christian Heimese93237d2007-12-19 02:37:44 +00005720 assert(!PyType_IS_GC(Py_TYPE(self)) ||
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005721 _Py_AS_GC(self)->gc.gc_refs != _PyGC_REFS_UNTRACKED);
Michael W. Hudson3f3b6682004-08-03 10:21:03 +00005722 /* If Py_REF_DEBUG, _Py_NewReference bumped _Py_RefTotal, so
5723 * we need to undo that. */
5724 _Py_DEC_REFTOTAL;
5725 /* If Py_TRACE_REFS, _Py_NewReference re-added self to the object
5726 * chain, so no more to do there.
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005727 * If COUNT_ALLOCS, the original decref bumped tp_frees, and
5728 * _Py_NewReference bumped tp_allocs: both of those need to be
5729 * undone.
5730 */
5731#ifdef COUNT_ALLOCS
Christian Heimese93237d2007-12-19 02:37:44 +00005732 --Py_TYPE(self)->tp_frees;
5733 --Py_TYPE(self)->tp_allocs;
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005734#endif
5735}
5736
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005737
5738/* Table mapping __foo__ names to tp_foo offsets and slot_tp_foo wrapper
Tim Petersbf9b2442003-03-23 05:35:36 +00005739 functions. The offsets here are relative to the 'PyHeapTypeObject'
Guido van Rossume5c691a2003-03-07 15:13:17 +00005740 structure, which incorporates the additional structures used for numbers,
5741 sequences and mappings.
5742 Note that multiple names may map to the same slot (e.g. __eq__,
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005743 __ne__ etc. all map to tp_richcompare) and one name may map to multiple
Guido van Rossumc334df52002-04-04 23:44:47 +00005744 slots (e.g. __str__ affects tp_str as well as tp_repr). The table is
5745 terminated with an all-zero entry. (This table is further initialized and
5746 sorted in init_slotdefs() below.) */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005747
Guido van Rossum6d204072001-10-21 00:44:31 +00005748typedef struct wrapperbase slotdef;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005749
5750#undef TPSLOT
Guido van Rossumc8e56452001-10-22 00:43:43 +00005751#undef FLSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005752#undef ETSLOT
5753#undef SQSLOT
5754#undef MPSLOT
5755#undef NBSLOT
Guido van Rossum6d204072001-10-21 00:44:31 +00005756#undef UNSLOT
5757#undef IBSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005758#undef BINSLOT
5759#undef RBINSLOT
5760
Guido van Rossum6d204072001-10-21 00:44:31 +00005761#define TPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Neal Norwitzd47714a2002-08-13 19:01:38 +00005762 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
5763 PyDoc_STR(DOC)}
Guido van Rossumc8e56452001-10-22 00:43:43 +00005764#define FLSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC, FLAGS) \
5765 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00005766 PyDoc_STR(DOC), FLAGS}
Guido van Rossum6d204072001-10-21 00:44:31 +00005767#define ETSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Guido van Rossume5c691a2003-03-07 15:13:17 +00005768 {NAME, offsetof(PyHeapTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00005769 PyDoc_STR(DOC)}
Guido van Rossum6d204072001-10-21 00:44:31 +00005770#define SQSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
5771 ETSLOT(NAME, as_sequence.SLOT, FUNCTION, WRAPPER, DOC)
5772#define MPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
5773 ETSLOT(NAME, as_mapping.SLOT, FUNCTION, WRAPPER, DOC)
5774#define NBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
5775 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, DOC)
5776#define UNSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
5777 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
5778 "x." NAME "() <==> " DOC)
5779#define IBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
5780 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
5781 "x." NAME "(y) <==> x" DOC "y")
5782#define BINSLOT(NAME, SLOT, FUNCTION, DOC) \
5783 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_l, \
5784 "x." NAME "(y) <==> x" DOC "y")
5785#define RBINSLOT(NAME, SLOT, FUNCTION, DOC) \
5786 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_r, \
5787 "x." NAME "(y) <==> y" DOC "x")
Anthony Baxter56616992005-06-03 14:12:21 +00005788#define BINSLOTNOTINFIX(NAME, SLOT, FUNCTION, DOC) \
5789 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_l, \
5790 "x." NAME "(y) <==> " DOC)
5791#define RBINSLOTNOTINFIX(NAME, SLOT, FUNCTION, DOC) \
5792 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_r, \
5793 "x." NAME "(y) <==> " DOC)
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005794
5795static slotdef slotdefs[] = {
Martin v. Löwis18e16552006-02-15 17:27:45 +00005796 SQSLOT("__len__", sq_length, slot_sq_length, wrap_lenfunc,
Guido van Rossum6d204072001-10-21 00:44:31 +00005797 "x.__len__() <==> len(x)"),
Armin Rigofd163f92005-12-29 15:59:19 +00005798 /* Heap types defining __add__/__mul__ have sq_concat/sq_repeat == NULL.
5799 The logic in abstract.c always falls back to nb_add/nb_multiply in
5800 this case. Defining both the nb_* and the sq_* slots to call the
5801 user-defined methods has unexpected side-effects, as shown by
5802 test_descr.notimplemented() */
5803 SQSLOT("__add__", sq_concat, NULL, wrap_binaryfunc,
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005804 "x.__add__(y) <==> x+y"),
Armin Rigo314861c2006-03-30 14:04:02 +00005805 SQSLOT("__mul__", sq_repeat, NULL, wrap_indexargfunc,
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005806 "x.__mul__(n) <==> x*n"),
Armin Rigo314861c2006-03-30 14:04:02 +00005807 SQSLOT("__rmul__", sq_repeat, NULL, wrap_indexargfunc,
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005808 "x.__rmul__(n) <==> n*x"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005809 SQSLOT("__getitem__", sq_item, slot_sq_item, wrap_sq_item,
5810 "x.__getitem__(y) <==> x[y]"),
Martin v. Löwis18e16552006-02-15 17:27:45 +00005811 SQSLOT("__getslice__", sq_slice, slot_sq_slice, wrap_ssizessizeargfunc,
Brett Cannon154da9b2003-05-20 02:30:04 +00005812 "x.__getslice__(i, j) <==> x[i:j]\n\
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005813 \n\
5814 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00005815 SQSLOT("__setitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_setitem,
Brett Cannonbe67d872003-05-20 02:40:12 +00005816 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005817 SQSLOT("__delitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_delitem,
Brett Cannonbe67d872003-05-20 02:40:12 +00005818 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005819 SQSLOT("__setslice__", sq_ass_slice, slot_sq_ass_slice,
Martin v. Löwis18e16552006-02-15 17:27:45 +00005820 wrap_ssizessizeobjargproc,
Brett Cannonbe67d872003-05-20 02:40:12 +00005821 "x.__setslice__(i, j, y) <==> x[i:j]=y\n\
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005822 \n\
5823 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00005824 SQSLOT("__delslice__", sq_ass_slice, slot_sq_ass_slice, wrap_delslice,
Brett Cannonbe67d872003-05-20 02:40:12 +00005825 "x.__delslice__(i, j) <==> del x[i:j]\n\
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005826 \n\
5827 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00005828 SQSLOT("__contains__", sq_contains, slot_sq_contains, wrap_objobjproc,
5829 "x.__contains__(y) <==> y in x"),
Armin Rigofd163f92005-12-29 15:59:19 +00005830 SQSLOT("__iadd__", sq_inplace_concat, NULL,
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005831 wrap_binaryfunc, "x.__iadd__(y) <==> x+=y"),
Armin Rigofd163f92005-12-29 15:59:19 +00005832 SQSLOT("__imul__", sq_inplace_repeat, NULL,
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005833 wrap_indexargfunc, "x.__imul__(y) <==> x*=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005834
Martin v. Löwis18e16552006-02-15 17:27:45 +00005835 MPSLOT("__len__", mp_length, slot_mp_length, wrap_lenfunc,
Guido van Rossum6d204072001-10-21 00:44:31 +00005836 "x.__len__() <==> len(x)"),
Guido van Rossumfd38f8e2001-10-09 20:17:57 +00005837 MPSLOT("__getitem__", mp_subscript, slot_mp_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00005838 wrap_binaryfunc,
5839 "x.__getitem__(y) <==> x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005840 MPSLOT("__setitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00005841 wrap_objobjargproc,
5842 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005843 MPSLOT("__delitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00005844 wrap_delitem,
5845 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005846
Guido van Rossum6d204072001-10-21 00:44:31 +00005847 BINSLOT("__add__", nb_add, slot_nb_add,
5848 "+"),
5849 RBINSLOT("__radd__", nb_add, slot_nb_add,
5850 "+"),
5851 BINSLOT("__sub__", nb_subtract, slot_nb_subtract,
5852 "-"),
5853 RBINSLOT("__rsub__", nb_subtract, slot_nb_subtract,
5854 "-"),
5855 BINSLOT("__mul__", nb_multiply, slot_nb_multiply,
5856 "*"),
5857 RBINSLOT("__rmul__", nb_multiply, slot_nb_multiply,
5858 "*"),
5859 BINSLOT("__div__", nb_divide, slot_nb_divide,
5860 "/"),
5861 RBINSLOT("__rdiv__", nb_divide, slot_nb_divide,
5862 "/"),
5863 BINSLOT("__mod__", nb_remainder, slot_nb_remainder,
5864 "%"),
5865 RBINSLOT("__rmod__", nb_remainder, slot_nb_remainder,
5866 "%"),
Anthony Baxter56616992005-06-03 14:12:21 +00005867 BINSLOTNOTINFIX("__divmod__", nb_divmod, slot_nb_divmod,
Guido van Rossum6d204072001-10-21 00:44:31 +00005868 "divmod(x, y)"),
Anthony Baxter56616992005-06-03 14:12:21 +00005869 RBINSLOTNOTINFIX("__rdivmod__", nb_divmod, slot_nb_divmod,
Guido van Rossum6d204072001-10-21 00:44:31 +00005870 "divmod(y, x)"),
5871 NBSLOT("__pow__", nb_power, slot_nb_power, wrap_ternaryfunc,
5872 "x.__pow__(y[, z]) <==> pow(x, y[, z])"),
5873 NBSLOT("__rpow__", nb_power, slot_nb_power, wrap_ternaryfunc_r,
5874 "y.__rpow__(x[, z]) <==> pow(x, y[, z])"),
5875 UNSLOT("__neg__", nb_negative, slot_nb_negative, wrap_unaryfunc, "-x"),
5876 UNSLOT("__pos__", nb_positive, slot_nb_positive, wrap_unaryfunc, "+x"),
5877 UNSLOT("__abs__", nb_absolute, slot_nb_absolute, wrap_unaryfunc,
5878 "abs(x)"),
Raymond Hettingerf34f2642003-10-11 17:29:04 +00005879 UNSLOT("__nonzero__", nb_nonzero, slot_nb_nonzero, wrap_inquirypred,
Guido van Rossum6d204072001-10-21 00:44:31 +00005880 "x != 0"),
5881 UNSLOT("__invert__", nb_invert, slot_nb_invert, wrap_unaryfunc, "~x"),
5882 BINSLOT("__lshift__", nb_lshift, slot_nb_lshift, "<<"),
5883 RBINSLOT("__rlshift__", nb_lshift, slot_nb_lshift, "<<"),
5884 BINSLOT("__rshift__", nb_rshift, slot_nb_rshift, ">>"),
5885 RBINSLOT("__rrshift__", nb_rshift, slot_nb_rshift, ">>"),
5886 BINSLOT("__and__", nb_and, slot_nb_and, "&"),
5887 RBINSLOT("__rand__", nb_and, slot_nb_and, "&"),
5888 BINSLOT("__xor__", nb_xor, slot_nb_xor, "^"),
5889 RBINSLOT("__rxor__", nb_xor, slot_nb_xor, "^"),
5890 BINSLOT("__or__", nb_or, slot_nb_or, "|"),
5891 RBINSLOT("__ror__", nb_or, slot_nb_or, "|"),
5892 NBSLOT("__coerce__", nb_coerce, slot_nb_coerce, wrap_coercefunc,
5893 "x.__coerce__(y) <==> coerce(x, y)"),
5894 UNSLOT("__int__", nb_int, slot_nb_int, wrap_unaryfunc,
5895 "int(x)"),
5896 UNSLOT("__long__", nb_long, slot_nb_long, wrap_unaryfunc,
5897 "long(x)"),
5898 UNSLOT("__float__", nb_float, slot_nb_float, wrap_unaryfunc,
5899 "float(x)"),
5900 UNSLOT("__oct__", nb_oct, slot_nb_oct, wrap_unaryfunc,
5901 "oct(x)"),
5902 UNSLOT("__hex__", nb_hex, slot_nb_hex, wrap_unaryfunc,
5903 "hex(x)"),
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00005904 NBSLOT("__index__", nb_index, slot_nb_index, wrap_unaryfunc,
Guido van Rossum38fff8c2006-03-07 18:50:55 +00005905 "x[y:z] <==> x[y.__index__():z.__index__()]"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005906 IBSLOT("__iadd__", nb_inplace_add, slot_nb_inplace_add,
5907 wrap_binaryfunc, "+"),
5908 IBSLOT("__isub__", nb_inplace_subtract, slot_nb_inplace_subtract,
5909 wrap_binaryfunc, "-"),
5910 IBSLOT("__imul__", nb_inplace_multiply, slot_nb_inplace_multiply,
5911 wrap_binaryfunc, "*"),
5912 IBSLOT("__idiv__", nb_inplace_divide, slot_nb_inplace_divide,
5913 wrap_binaryfunc, "/"),
5914 IBSLOT("__imod__", nb_inplace_remainder, slot_nb_inplace_remainder,
5915 wrap_binaryfunc, "%"),
5916 IBSLOT("__ipow__", nb_inplace_power, slot_nb_inplace_power,
Guido van Rossum6e5680f2002-10-15 01:01:53 +00005917 wrap_binaryfunc, "**"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005918 IBSLOT("__ilshift__", nb_inplace_lshift, slot_nb_inplace_lshift,
5919 wrap_binaryfunc, "<<"),
5920 IBSLOT("__irshift__", nb_inplace_rshift, slot_nb_inplace_rshift,
5921 wrap_binaryfunc, ">>"),
5922 IBSLOT("__iand__", nb_inplace_and, slot_nb_inplace_and,
5923 wrap_binaryfunc, "&"),
5924 IBSLOT("__ixor__", nb_inplace_xor, slot_nb_inplace_xor,
5925 wrap_binaryfunc, "^"),
5926 IBSLOT("__ior__", nb_inplace_or, slot_nb_inplace_or,
5927 wrap_binaryfunc, "|"),
5928 BINSLOT("__floordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
5929 RBINSLOT("__rfloordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
5930 BINSLOT("__truediv__", nb_true_divide, slot_nb_true_divide, "/"),
5931 RBINSLOT("__rtruediv__", nb_true_divide, slot_nb_true_divide, "/"),
5932 IBSLOT("__ifloordiv__", nb_inplace_floor_divide,
5933 slot_nb_inplace_floor_divide, wrap_binaryfunc, "//"),
5934 IBSLOT("__itruediv__", nb_inplace_true_divide,
5935 slot_nb_inplace_true_divide, wrap_binaryfunc, "/"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005936
Guido van Rossum6d204072001-10-21 00:44:31 +00005937 TPSLOT("__str__", tp_str, slot_tp_str, wrap_unaryfunc,
5938 "x.__str__() <==> str(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00005939 TPSLOT("__str__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00005940 TPSLOT("__repr__", tp_repr, slot_tp_repr, wrap_unaryfunc,
5941 "x.__repr__() <==> repr(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00005942 TPSLOT("__repr__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00005943 TPSLOT("__cmp__", tp_compare, _PyObject_SlotCompare, wrap_cmpfunc,
5944 "x.__cmp__(y) <==> cmp(x,y)"),
5945 TPSLOT("__hash__", tp_hash, slot_tp_hash, wrap_hashfunc,
5946 "x.__hash__() <==> hash(x)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00005947 FLSLOT("__call__", tp_call, slot_tp_call, (wrapperfunc)wrap_call,
5948 "x.__call__(...) <==> x(...)", PyWrapperFlag_KEYWORDS),
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005949 TPSLOT("__getattribute__", tp_getattro, slot_tp_getattr_hook,
Guido van Rossum6d204072001-10-21 00:44:31 +00005950 wrap_binaryfunc, "x.__getattribute__('name') <==> x.name"),
5951 TPSLOT("__getattribute__", tp_getattr, NULL, NULL, ""),
5952 TPSLOT("__getattr__", tp_getattro, slot_tp_getattr_hook, NULL, ""),
5953 TPSLOT("__getattr__", tp_getattr, NULL, NULL, ""),
5954 TPSLOT("__setattr__", tp_setattro, slot_tp_setattro, wrap_setattr,
5955 "x.__setattr__('name', value) <==> x.name = value"),
5956 TPSLOT("__setattr__", tp_setattr, NULL, NULL, ""),
5957 TPSLOT("__delattr__", tp_setattro, slot_tp_setattro, wrap_delattr,
5958 "x.__delattr__('name') <==> del x.name"),
5959 TPSLOT("__delattr__", tp_setattr, NULL, NULL, ""),
5960 TPSLOT("__lt__", tp_richcompare, slot_tp_richcompare, richcmp_lt,
5961 "x.__lt__(y) <==> x<y"),
5962 TPSLOT("__le__", tp_richcompare, slot_tp_richcompare, richcmp_le,
5963 "x.__le__(y) <==> x<=y"),
5964 TPSLOT("__eq__", tp_richcompare, slot_tp_richcompare, richcmp_eq,
5965 "x.__eq__(y) <==> x==y"),
5966 TPSLOT("__ne__", tp_richcompare, slot_tp_richcompare, richcmp_ne,
5967 "x.__ne__(y) <==> x!=y"),
5968 TPSLOT("__gt__", tp_richcompare, slot_tp_richcompare, richcmp_gt,
5969 "x.__gt__(y) <==> x>y"),
5970 TPSLOT("__ge__", tp_richcompare, slot_tp_richcompare, richcmp_ge,
5971 "x.__ge__(y) <==> x>=y"),
5972 TPSLOT("__iter__", tp_iter, slot_tp_iter, wrap_unaryfunc,
5973 "x.__iter__() <==> iter(x)"),
5974 TPSLOT("next", tp_iternext, slot_tp_iternext, wrap_next,
5975 "x.next() -> the next value, or raise StopIteration"),
5976 TPSLOT("__get__", tp_descr_get, slot_tp_descr_get, wrap_descr_get,
5977 "descr.__get__(obj[, type]) -> value"),
5978 TPSLOT("__set__", tp_descr_set, slot_tp_descr_set, wrap_descr_set,
5979 "descr.__set__(obj, value)"),
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00005980 TPSLOT("__delete__", tp_descr_set, slot_tp_descr_set,
5981 wrap_descr_delete, "descr.__delete__(obj)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00005982 FLSLOT("__init__", tp_init, slot_tp_init, (wrapperfunc)wrap_init,
Guido van Rossum6d204072001-10-21 00:44:31 +00005983 "x.__init__(...) initializes x; "
Guido van Rossumc8e56452001-10-22 00:43:43 +00005984 "see x.__class__.__doc__ for signature",
5985 PyWrapperFlag_KEYWORDS),
5986 TPSLOT("__new__", tp_new, slot_tp_new, NULL, ""),
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005987 TPSLOT("__del__", tp_del, slot_tp_del, NULL, ""),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005988 {NULL}
5989};
5990
Guido van Rossumc334df52002-04-04 23:44:47 +00005991/* Given a type pointer and an offset gotten from a slotdef entry, return a
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005992 pointer to the actual slot. This is not quite the same as simply adding
Guido van Rossumc334df52002-04-04 23:44:47 +00005993 the offset to the type pointer, since it takes care to indirect through the
5994 proper indirection pointer (as_buffer, etc.); it returns NULL if the
5995 indirection pointer is NULL. */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005996static void **
Martin v. Löwis18e16552006-02-15 17:27:45 +00005997slotptr(PyTypeObject *type, int ioffset)
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005998{
5999 char *ptr;
Martin v. Löwis18e16552006-02-15 17:27:45 +00006000 long offset = ioffset;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00006001
Guido van Rossume5c691a2003-03-07 15:13:17 +00006002 /* Note: this depends on the order of the members of PyHeapTypeObject! */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00006003 assert(offset >= 0);
Skip Montanaro429433b2006-04-18 00:35:43 +00006004 assert((size_t)offset < offsetof(PyHeapTypeObject, as_buffer));
6005 if ((size_t)offset >= offsetof(PyHeapTypeObject, as_sequence)) {
Martin v. Löwisee36d652006-04-11 09:08:02 +00006006 ptr = (char *)type->tp_as_sequence;
Guido van Rossume5c691a2003-03-07 15:13:17 +00006007 offset -= offsetof(PyHeapTypeObject, as_sequence);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00006008 }
Skip Montanaro429433b2006-04-18 00:35:43 +00006009 else if ((size_t)offset >= offsetof(PyHeapTypeObject, as_mapping)) {
Martin v. Löwisee36d652006-04-11 09:08:02 +00006010 ptr = (char *)type->tp_as_mapping;
Guido van Rossume5c691a2003-03-07 15:13:17 +00006011 offset -= offsetof(PyHeapTypeObject, as_mapping);
Guido van Rossum09638c12002-06-13 19:17:46 +00006012 }
Skip Montanaro429433b2006-04-18 00:35:43 +00006013 else if ((size_t)offset >= offsetof(PyHeapTypeObject, as_number)) {
Martin v. Löwisee36d652006-04-11 09:08:02 +00006014 ptr = (char *)type->tp_as_number;
Guido van Rossume5c691a2003-03-07 15:13:17 +00006015 offset -= offsetof(PyHeapTypeObject, as_number);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00006016 }
6017 else {
Martin v. Löwisee36d652006-04-11 09:08:02 +00006018 ptr = (char *)type;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00006019 }
6020 if (ptr != NULL)
6021 ptr += offset;
6022 return (void **)ptr;
6023}
Guido van Rossumf040ede2001-08-07 16:40:56 +00006024
Guido van Rossumc334df52002-04-04 23:44:47 +00006025/* Length of array of slotdef pointers used to store slots with the
6026 same __name__. There should be at most MAX_EQUIV-1 slotdef entries with
6027 the same __name__, for any __name__. Since that's a static property, it is
6028 appropriate to declare fixed-size arrays for this. */
6029#define MAX_EQUIV 10
6030
6031/* Return a slot pointer for a given name, but ONLY if the attribute has
6032 exactly one slot function. The name must be an interned string. */
6033static void **
6034resolve_slotdups(PyTypeObject *type, PyObject *name)
6035{
6036 /* XXX Maybe this could be optimized more -- but is it worth it? */
6037
6038 /* pname and ptrs act as a little cache */
6039 static PyObject *pname;
6040 static slotdef *ptrs[MAX_EQUIV];
6041 slotdef *p, **pp;
6042 void **res, **ptr;
6043
6044 if (pname != name) {
6045 /* Collect all slotdefs that match name into ptrs. */
6046 pname = name;
6047 pp = ptrs;
6048 for (p = slotdefs; p->name_strobj; p++) {
6049 if (p->name_strobj == name)
6050 *pp++ = p;
6051 }
6052 *pp = NULL;
6053 }
6054
6055 /* Look in all matching slots of the type; if exactly one of these has
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006056 a filled-in slot, return its value. Otherwise return NULL. */
Guido van Rossumc334df52002-04-04 23:44:47 +00006057 res = NULL;
6058 for (pp = ptrs; *pp; pp++) {
6059 ptr = slotptr(type, (*pp)->offset);
6060 if (ptr == NULL || *ptr == NULL)
6061 continue;
6062 if (res != NULL)
6063 return NULL;
6064 res = ptr;
6065 }
6066 return res;
6067}
6068
Guido van Rossum8d24ee92003-03-24 23:49:49 +00006069/* Common code for update_slots_callback() and fixup_slot_dispatchers(). This
Guido van Rossumc334df52002-04-04 23:44:47 +00006070 does some incredibly complex thinking and then sticks something into the
6071 slot. (It sees if the adjacent slotdefs for the same slot have conflicting
6072 interests, and then stores a generic wrapper or a specific function into
6073 the slot.) Return a pointer to the next slotdef with a different offset,
6074 because that's convenient for fixup_slot_dispatchers(). */
6075static slotdef *
6076update_one_slot(PyTypeObject *type, slotdef *p)
6077{
6078 PyObject *descr;
6079 PyWrapperDescrObject *d;
6080 void *generic = NULL, *specific = NULL;
6081 int use_generic = 0;
6082 int offset = p->offset;
6083 void **ptr = slotptr(type, offset);
6084
6085 if (ptr == NULL) {
6086 do {
6087 ++p;
6088 } while (p->offset == offset);
6089 return p;
6090 }
6091 do {
6092 descr = _PyType_Lookup(type, p->name_strobj);
6093 if (descr == NULL)
6094 continue;
Christian Heimese93237d2007-12-19 02:37:44 +00006095 if (Py_TYPE(descr) == &PyWrapperDescr_Type) {
Guido van Rossumc334df52002-04-04 23:44:47 +00006096 void **tptr = resolve_slotdups(type, p->name_strobj);
6097 if (tptr == NULL || tptr == ptr)
6098 generic = p->function;
6099 d = (PyWrapperDescrObject *)descr;
6100 if (d->d_base->wrapper == p->wrapper &&
6101 PyType_IsSubtype(type, d->d_type))
6102 {
6103 if (specific == NULL ||
6104 specific == d->d_wrapped)
6105 specific = d->d_wrapped;
6106 else
6107 use_generic = 1;
6108 }
6109 }
Christian Heimese93237d2007-12-19 02:37:44 +00006110 else if (Py_TYPE(descr) == &PyCFunction_Type &&
Guido van Rossum721f62e2002-08-09 02:14:34 +00006111 PyCFunction_GET_FUNCTION(descr) ==
6112 (PyCFunction)tp_new_wrapper &&
6113 strcmp(p->name, "__new__") == 0)
6114 {
6115 /* The __new__ wrapper is not a wrapper descriptor,
6116 so must be special-cased differently.
6117 If we don't do this, creating an instance will
6118 always use slot_tp_new which will look up
6119 __new__ in the MRO which will call tp_new_wrapper
6120 which will look through the base classes looking
6121 for a static base and call its tp_new (usually
6122 PyType_GenericNew), after performing various
6123 sanity checks and constructing a new argument
6124 list. Cut all that nonsense short -- this speeds
6125 up instance creation tremendously. */
Martin v. Löwisa94568a2003-05-10 07:36:56 +00006126 specific = (void *)type->tp_new;
Guido van Rossum721f62e2002-08-09 02:14:34 +00006127 /* XXX I'm not 100% sure that there isn't a hole
6128 in this reasoning that requires additional
6129 sanity checks. I'll buy the first person to
6130 point out a bug in this reasoning a beer. */
6131 }
Nick Coghlan53663a62008-07-15 14:27:37 +00006132 else if (descr == Py_None &&
6133 strcmp(p->name, "__hash__") == 0) {
6134 /* We specifically allow __hash__ to be set to None
6135 to prevent inheritance of the default
6136 implementation from object.__hash__ */
6137 specific = PyObject_HashNotImplemented;
6138 }
Guido van Rossumc334df52002-04-04 23:44:47 +00006139 else {
6140 use_generic = 1;
6141 generic = p->function;
6142 }
6143 } while ((++p)->offset == offset);
6144 if (specific && !use_generic)
6145 *ptr = specific;
6146 else
6147 *ptr = generic;
6148 return p;
6149}
6150
Guido van Rossum8d24ee92003-03-24 23:49:49 +00006151/* In the type, update the slots whose slotdefs are gathered in the pp array.
6152 This is a callback for update_subclasses(). */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006153static int
Guido van Rossum8d24ee92003-03-24 23:49:49 +00006154update_slots_callback(PyTypeObject *type, void *data)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006155{
Guido van Rossum8d24ee92003-03-24 23:49:49 +00006156 slotdef **pp = (slotdef **)data;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006157
Guido van Rossum8d24ee92003-03-24 23:49:49 +00006158 for (; *pp; pp++)
Guido van Rossumc334df52002-04-04 23:44:47 +00006159 update_one_slot(type, *pp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006160 return 0;
6161}
6162
Guido van Rossumc334df52002-04-04 23:44:47 +00006163/* Comparison function for qsort() to compare slotdefs by their offset, and
6164 for equal offset by their address (to force a stable sort). */
Guido van Rossumd396b9c2001-10-13 20:02:41 +00006165static int
6166slotdef_cmp(const void *aa, const void *bb)
6167{
6168 const slotdef *a = (const slotdef *)aa, *b = (const slotdef *)bb;
6169 int c = a->offset - b->offset;
6170 if (c != 0)
6171 return c;
6172 else
Martin v. Löwis18e16552006-02-15 17:27:45 +00006173 /* Cannot use a-b, as this gives off_t,
6174 which may lose precision when converted to int. */
6175 return (a > b) ? 1 : (a < b) ? -1 : 0;
Guido van Rossumd396b9c2001-10-13 20:02:41 +00006176}
6177
Guido van Rossumc334df52002-04-04 23:44:47 +00006178/* Initialize the slotdefs table by adding interned string objects for the
6179 names and sorting the entries. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006180static void
Guido van Rossumd396b9c2001-10-13 20:02:41 +00006181init_slotdefs(void)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006182{
6183 slotdef *p;
6184 static int initialized = 0;
6185
6186 if (initialized)
6187 return;
6188 for (p = slotdefs; p->name; p++) {
Gregory P. Smithdd96db62008-06-09 04:58:54 +00006189 p->name_strobj = PyString_InternFromString(p->name);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006190 if (!p->name_strobj)
Guido van Rossumc334df52002-04-04 23:44:47 +00006191 Py_FatalError("Out of memory interning slotdef names");
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006192 }
Guido van Rossumb85a8b72001-10-16 17:00:48 +00006193 qsort((void *)slotdefs, (size_t)(p-slotdefs), sizeof(slotdef),
6194 slotdef_cmp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006195 initialized = 1;
6196}
6197
Guido van Rossumc334df52002-04-04 23:44:47 +00006198/* Update the slots after assignment to a class (type) attribute. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006199static int
6200update_slot(PyTypeObject *type, PyObject *name)
6201{
Guido van Rossumc334df52002-04-04 23:44:47 +00006202 slotdef *ptrs[MAX_EQUIV];
Guido van Rossumd396b9c2001-10-13 20:02:41 +00006203 slotdef *p;
6204 slotdef **pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00006205 int offset;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006206
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +00006207 /* Clear the VALID_VERSION flag of 'type' and all its
6208 subclasses. This could possibly be unified with the
6209 update_subclasses() recursion below, but carefully:
6210 they each have their own conditions on which to stop
6211 recursing into subclasses. */
Georg Brandl74a1dea2008-05-28 11:21:39 +00006212 PyType_Modified(type);
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +00006213
Guido van Rossumb85a8b72001-10-16 17:00:48 +00006214 init_slotdefs();
6215 pp = ptrs;
6216 for (p = slotdefs; p->name; p++) {
6217 /* XXX assume name is interned! */
6218 if (p->name_strobj == name)
6219 *pp++ = p;
6220 }
6221 *pp = NULL;
Guido van Rossumd396b9c2001-10-13 20:02:41 +00006222 for (pp = ptrs; *pp; pp++) {
6223 p = *pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00006224 offset = p->offset;
6225 while (p > slotdefs && (p-1)->offset == offset)
Guido van Rossumd396b9c2001-10-13 20:02:41 +00006226 --p;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00006227 *pp = p;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006228 }
Guido van Rossumc334df52002-04-04 23:44:47 +00006229 if (ptrs[0] == NULL)
6230 return 0; /* Not an attribute that affects any slots */
Guido van Rossum8d24ee92003-03-24 23:49:49 +00006231 return update_subclasses(type, name,
6232 update_slots_callback, (void *)ptrs);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006233}
6234
Guido van Rossumc334df52002-04-04 23:44:47 +00006235/* Store the proper functions in the slot dispatches at class (type)
6236 definition time, based upon which operations the class overrides in its
6237 dict. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00006238static void
Guido van Rossum7b9144b2001-10-09 19:39:46 +00006239fixup_slot_dispatchers(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00006240{
Guido van Rossum7b9144b2001-10-09 19:39:46 +00006241 slotdef *p;
Tim Peters6d6c1a32001-08-02 04:15:00 +00006242
Guido van Rossumd396b9c2001-10-13 20:02:41 +00006243 init_slotdefs();
Guido van Rossumc334df52002-04-04 23:44:47 +00006244 for (p = slotdefs; p->name; )
6245 p = update_one_slot(type, p);
Tim Peters6d6c1a32001-08-02 04:15:00 +00006246}
Guido van Rossum705f0f52001-08-24 16:47:00 +00006247
Michael W. Hudson98bbc492002-11-26 14:47:27 +00006248static void
6249update_all_slots(PyTypeObject* type)
6250{
6251 slotdef *p;
6252
6253 init_slotdefs();
6254 for (p = slotdefs; p->name; p++) {
6255 /* update_slot returns int but can't actually fail */
6256 update_slot(type, p->name_strobj);
6257 }
6258}
6259
Guido van Rossum8d24ee92003-03-24 23:49:49 +00006260/* recurse_down_subclasses() and update_subclasses() are mutually
6261 recursive functions to call a callback for all subclasses,
6262 but refraining from recursing into subclasses that define 'name'. */
6263
6264static int
6265update_subclasses(PyTypeObject *type, PyObject *name,
6266 update_callback callback, void *data)
6267{
6268 if (callback(type, data) < 0)
6269 return -1;
6270 return recurse_down_subclasses(type, name, callback, data);
6271}
6272
6273static int
6274recurse_down_subclasses(PyTypeObject *type, PyObject *name,
6275 update_callback callback, void *data)
6276{
6277 PyTypeObject *subclass;
6278 PyObject *ref, *subclasses, *dict;
Martin v. Löwis18e16552006-02-15 17:27:45 +00006279 Py_ssize_t i, n;
Guido van Rossum8d24ee92003-03-24 23:49:49 +00006280
6281 subclasses = type->tp_subclasses;
6282 if (subclasses == NULL)
6283 return 0;
6284 assert(PyList_Check(subclasses));
6285 n = PyList_GET_SIZE(subclasses);
6286 for (i = 0; i < n; i++) {
6287 ref = PyList_GET_ITEM(subclasses, i);
6288 assert(PyWeakref_CheckRef(ref));
6289 subclass = (PyTypeObject *)PyWeakref_GET_OBJECT(ref);
6290 assert(subclass != NULL);
6291 if ((PyObject *)subclass == Py_None)
6292 continue;
6293 assert(PyType_Check(subclass));
6294 /* Avoid recursing down into unaffected classes */
6295 dict = subclass->tp_dict;
6296 if (dict != NULL && PyDict_Check(dict) &&
6297 PyDict_GetItem(dict, name) != NULL)
6298 continue;
6299 if (update_subclasses(subclass, name, callback, data) < 0)
6300 return -1;
6301 }
6302 return 0;
6303}
6304
Guido van Rossum6d204072001-10-21 00:44:31 +00006305/* This function is called by PyType_Ready() to populate the type's
6306 dictionary with method descriptors for function slots. For each
Guido van Rossum09638c12002-06-13 19:17:46 +00006307 function slot (like tp_repr) that's defined in the type, one or more
6308 corresponding descriptors are added in the type's tp_dict dictionary
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006309 under the appropriate name (like __repr__). Some function slots
Guido van Rossum09638c12002-06-13 19:17:46 +00006310 cause more than one descriptor to be added (for example, the nb_add
6311 slot adds both __add__ and __radd__ descriptors) and some function
6312 slots compete for the same descriptor (for example both sq_item and
6313 mp_subscript generate a __getitem__ descriptor).
6314
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006315 In the latter case, the first slotdef entry encoutered wins. Since
Tim Petersbf9b2442003-03-23 05:35:36 +00006316 slotdef entries are sorted by the offset of the slot in the
Guido van Rossume5c691a2003-03-07 15:13:17 +00006317 PyHeapTypeObject, this gives us some control over disambiguating
Guido van Rossum8d24ee92003-03-24 23:49:49 +00006318 between competing slots: the members of PyHeapTypeObject are listed
6319 from most general to least general, so the most general slot is
6320 preferred. In particular, because as_mapping comes before as_sequence,
6321 for a type that defines both mp_subscript and sq_item, mp_subscript
6322 wins.
Guido van Rossum09638c12002-06-13 19:17:46 +00006323
6324 This only adds new descriptors and doesn't overwrite entries in
6325 tp_dict that were previously defined. The descriptors contain a
6326 reference to the C function they must call, so that it's safe if they
6327 are copied into a subtype's __dict__ and the subtype has a different
6328 C function in its slot -- calling the method defined by the
6329 descriptor will call the C function that was used to create it,
6330 rather than the C function present in the slot when it is called.
6331 (This is important because a subtype may have a C function in the
6332 slot that calls the method from the dictionary, and we want to avoid
6333 infinite recursion here.) */
Guido van Rossum6d204072001-10-21 00:44:31 +00006334
6335static int
6336add_operators(PyTypeObject *type)
6337{
6338 PyObject *dict = type->tp_dict;
6339 slotdef *p;
6340 PyObject *descr;
6341 void **ptr;
6342
6343 init_slotdefs();
6344 for (p = slotdefs; p->name; p++) {
6345 if (p->wrapper == NULL)
6346 continue;
6347 ptr = slotptr(type, p->offset);
6348 if (!ptr || !*ptr)
6349 continue;
6350 if (PyDict_GetItem(dict, p->name_strobj))
6351 continue;
Nick Coghlan53663a62008-07-15 14:27:37 +00006352 if (*ptr == PyObject_HashNotImplemented) {
6353 /* Classes may prevent the inheritance of the tp_hash
6354 slot by storing PyObject_HashNotImplemented in it. Make it
6355 visible as a None value for the __hash__ attribute. */
6356 if (PyDict_SetItem(dict, p->name_strobj, Py_None) < 0)
6357 return -1;
6358 }
6359 else {
6360 descr = PyDescr_NewWrapper(type, p, *ptr);
6361 if (descr == NULL)
6362 return -1;
6363 if (PyDict_SetItem(dict, p->name_strobj, descr) < 0)
6364 return -1;
6365 Py_DECREF(descr);
6366 }
Guido van Rossum6d204072001-10-21 00:44:31 +00006367 }
6368 if (type->tp_new != NULL) {
6369 if (add_tp_new_wrapper(type) < 0)
6370 return -1;
6371 }
6372 return 0;
6373}
6374
Guido van Rossum705f0f52001-08-24 16:47:00 +00006375
6376/* Cooperative 'super' */
6377
6378typedef struct {
6379 PyObject_HEAD
Guido van Rossume705ef12001-08-29 15:47:06 +00006380 PyTypeObject *type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006381 PyObject *obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006382 PyTypeObject *obj_type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006383} superobject;
6384
Guido van Rossum6f799372001-09-20 20:46:19 +00006385static PyMemberDef super_members[] = {
6386 {"__thisclass__", T_OBJECT, offsetof(superobject, type), READONLY,
6387 "the class invoking super()"},
6388 {"__self__", T_OBJECT, offsetof(superobject, obj), READONLY,
6389 "the instance invoking super(); may be None"},
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006390 {"__self_class__", T_OBJECT, offsetof(superobject, obj_type), READONLY,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +00006391 "the type of the instance invoking super(); may be None"},
Guido van Rossum41eb14d2001-08-30 23:13:11 +00006392 {0}
6393};
6394
Guido van Rossum705f0f52001-08-24 16:47:00 +00006395static void
6396super_dealloc(PyObject *self)
6397{
6398 superobject *su = (superobject *)self;
6399
Guido van Rossum048eb752001-10-02 21:24:57 +00006400 _PyObject_GC_UNTRACK(self);
Guido van Rossum705f0f52001-08-24 16:47:00 +00006401 Py_XDECREF(su->obj);
6402 Py_XDECREF(su->type);
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006403 Py_XDECREF(su->obj_type);
Christian Heimese93237d2007-12-19 02:37:44 +00006404 Py_TYPE(self)->tp_free(self);
Guido van Rossum705f0f52001-08-24 16:47:00 +00006405}
6406
6407static PyObject *
Guido van Rossum41eb14d2001-08-30 23:13:11 +00006408super_repr(PyObject *self)
6409{
6410 superobject *su = (superobject *)self;
6411
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006412 if (su->obj_type)
Gregory P. Smithdd96db62008-06-09 04:58:54 +00006413 return PyString_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00006414 "<super: <class '%s'>, <%s object>>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00006415 su->type ? su->type->tp_name : "NULL",
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006416 su->obj_type->tp_name);
Guido van Rossum41eb14d2001-08-30 23:13:11 +00006417 else
Gregory P. Smithdd96db62008-06-09 04:58:54 +00006418 return PyString_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00006419 "<super: <class '%s'>, NULL>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00006420 su->type ? su->type->tp_name : "NULL");
6421}
6422
6423static PyObject *
Guido van Rossum705f0f52001-08-24 16:47:00 +00006424super_getattro(PyObject *self, PyObject *name)
6425{
6426 superobject *su = (superobject *)self;
Guido van Rossum76ba09f2003-04-16 19:40:58 +00006427 int skip = su->obj_type == NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006428
Guido van Rossum76ba09f2003-04-16 19:40:58 +00006429 if (!skip) {
6430 /* We want __class__ to return the class of the super object
6431 (i.e. super, or a subclass), not the class of su->obj. */
Gregory P. Smithdd96db62008-06-09 04:58:54 +00006432 skip = (PyString_Check(name) &&
6433 PyString_GET_SIZE(name) == 9 &&
6434 strcmp(PyString_AS_STRING(name), "__class__") == 0);
Guido van Rossum76ba09f2003-04-16 19:40:58 +00006435 }
6436
6437 if (!skip) {
Tim Petersa91e9642001-11-14 23:32:33 +00006438 PyObject *mro, *res, *tmp, *dict;
Guido van Rossum155db9a2002-04-02 17:53:47 +00006439 PyTypeObject *starttype;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006440 descrgetfunc f;
Martin v. Löwis18e16552006-02-15 17:27:45 +00006441 Py_ssize_t i, n;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006442
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006443 starttype = su->obj_type;
Guido van Rossum155db9a2002-04-02 17:53:47 +00006444 mro = starttype->tp_mro;
6445
Guido van Rossum41eb14d2001-08-30 23:13:11 +00006446 if (mro == NULL)
6447 n = 0;
6448 else {
6449 assert(PyTuple_Check(mro));
6450 n = PyTuple_GET_SIZE(mro);
6451 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00006452 for (i = 0; i < n; i++) {
Guido van Rossume705ef12001-08-29 15:47:06 +00006453 if ((PyObject *)(su->type) == PyTuple_GET_ITEM(mro, i))
Guido van Rossum705f0f52001-08-24 16:47:00 +00006454 break;
6455 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00006456 i++;
6457 res = NULL;
6458 for (; i < n; i++) {
6459 tmp = PyTuple_GET_ITEM(mro, i);
Tim Petersa91e9642001-11-14 23:32:33 +00006460 if (PyType_Check(tmp))
6461 dict = ((PyTypeObject *)tmp)->tp_dict;
6462 else if (PyClass_Check(tmp))
6463 dict = ((PyClassObject *)tmp)->cl_dict;
6464 else
6465 continue;
6466 res = PyDict_GetItem(dict, name);
Guido van Rossum6cc5bb62003-04-16 20:01:36 +00006467 if (res != NULL) {
Guido van Rossum705f0f52001-08-24 16:47:00 +00006468 Py_INCREF(res);
Christian Heimese93237d2007-12-19 02:37:44 +00006469 f = Py_TYPE(res)->tp_descr_get;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006470 if (f != NULL) {
Phillip J. Eby91a968a2004-03-25 02:19:34 +00006471 tmp = f(res,
6472 /* Only pass 'obj' param if
6473 this is instance-mode super
6474 (See SF ID #743627)
6475 */
Hye-Shik Changff365c92004-03-25 16:37:03 +00006476 (su->obj == (PyObject *)
6477 su->obj_type
Phillip J. Eby91a968a2004-03-25 02:19:34 +00006478 ? (PyObject *)NULL
6479 : su->obj),
Guido van Rossumd4641072002-04-03 02:13:37 +00006480 (PyObject *)starttype);
Guido van Rossum705f0f52001-08-24 16:47:00 +00006481 Py_DECREF(res);
6482 res = tmp;
6483 }
6484 return res;
6485 }
6486 }
6487 }
6488 return PyObject_GenericGetAttr(self, name);
6489}
6490
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006491static PyTypeObject *
Guido van Rossum5b443c62001-12-03 15:38:28 +00006492supercheck(PyTypeObject *type, PyObject *obj)
6493{
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006494 /* Check that a super() call makes sense. Return a type object.
6495
6496 obj can be a new-style class, or an instance of one:
6497
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006498 - If it is a class, it must be a subclass of 'type'. This case is
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006499 used for class methods; the return value is obj.
6500
6501 - If it is an instance, it must be an instance of 'type'. This is
6502 the normal case; the return value is obj.__class__.
6503
6504 But... when obj is an instance, we want to allow for the case where
Christian Heimese93237d2007-12-19 02:37:44 +00006505 Py_TYPE(obj) is not a subclass of type, but obj.__class__ is!
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006506 This will allow using super() with a proxy for obj.
6507 */
6508
Guido van Rossum8e80a722003-02-18 19:22:22 +00006509 /* Check for first bullet above (special case) */
6510 if (PyType_Check(obj) && PyType_IsSubtype((PyTypeObject *)obj, type)) {
6511 Py_INCREF(obj);
6512 return (PyTypeObject *)obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006513 }
Guido van Rossum8e80a722003-02-18 19:22:22 +00006514
6515 /* Normal case */
Christian Heimese93237d2007-12-19 02:37:44 +00006516 if (PyType_IsSubtype(Py_TYPE(obj), type)) {
6517 Py_INCREF(Py_TYPE(obj));
6518 return Py_TYPE(obj);
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006519 }
6520 else {
6521 /* Try the slow way */
6522 static PyObject *class_str = NULL;
6523 PyObject *class_attr;
6524
6525 if (class_str == NULL) {
Gregory P. Smithdd96db62008-06-09 04:58:54 +00006526 class_str = PyString_FromString("__class__");
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006527 if (class_str == NULL)
6528 return NULL;
6529 }
6530
6531 class_attr = PyObject_GetAttr(obj, class_str);
6532
6533 if (class_attr != NULL &&
6534 PyType_Check(class_attr) &&
Christian Heimese93237d2007-12-19 02:37:44 +00006535 (PyTypeObject *)class_attr != Py_TYPE(obj))
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006536 {
6537 int ok = PyType_IsSubtype(
6538 (PyTypeObject *)class_attr, type);
6539 if (ok)
6540 return (PyTypeObject *)class_attr;
6541 }
6542
6543 if (class_attr == NULL)
6544 PyErr_Clear();
6545 else
6546 Py_DECREF(class_attr);
6547 }
6548
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006549 PyErr_SetString(PyExc_TypeError,
Guido van Rossum5b443c62001-12-03 15:38:28 +00006550 "super(type, obj): "
6551 "obj must be an instance or subtype of type");
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006552 return NULL;
Guido van Rossum5b443c62001-12-03 15:38:28 +00006553}
6554
Guido van Rossum705f0f52001-08-24 16:47:00 +00006555static PyObject *
6556super_descr_get(PyObject *self, PyObject *obj, PyObject *type)
6557{
6558 superobject *su = (superobject *)self;
Anthony Baxtera6286212006-04-11 07:42:36 +00006559 superobject *newobj;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006560
6561 if (obj == NULL || obj == Py_None || su->obj != NULL) {
6562 /* Not binding to an object, or already bound */
6563 Py_INCREF(self);
6564 return self;
6565 }
Christian Heimese93237d2007-12-19 02:37:44 +00006566 if (Py_TYPE(su) != &PySuper_Type)
Armin Rigo7726dc02005-05-15 15:32:08 +00006567 /* If su is an instance of a (strict) subclass of super,
Guido van Rossum5b443c62001-12-03 15:38:28 +00006568 call its type */
Christian Heimese93237d2007-12-19 02:37:44 +00006569 return PyObject_CallFunctionObjArgs((PyObject *)Py_TYPE(su),
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006570 su->type, obj, NULL);
Guido van Rossum5b443c62001-12-03 15:38:28 +00006571 else {
6572 /* Inline the common case */
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006573 PyTypeObject *obj_type = supercheck(su->type, obj);
6574 if (obj_type == NULL)
Guido van Rossum5b443c62001-12-03 15:38:28 +00006575 return NULL;
Anthony Baxtera6286212006-04-11 07:42:36 +00006576 newobj = (superobject *)PySuper_Type.tp_new(&PySuper_Type,
Guido van Rossum5b443c62001-12-03 15:38:28 +00006577 NULL, NULL);
Anthony Baxtera6286212006-04-11 07:42:36 +00006578 if (newobj == NULL)
Guido van Rossum5b443c62001-12-03 15:38:28 +00006579 return NULL;
6580 Py_INCREF(su->type);
6581 Py_INCREF(obj);
Anthony Baxtera6286212006-04-11 07:42:36 +00006582 newobj->type = su->type;
6583 newobj->obj = obj;
6584 newobj->obj_type = obj_type;
6585 return (PyObject *)newobj;
Guido van Rossum5b443c62001-12-03 15:38:28 +00006586 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00006587}
6588
6589static int
6590super_init(PyObject *self, PyObject *args, PyObject *kwds)
6591{
6592 superobject *su = (superobject *)self;
Guido van Rossume705ef12001-08-29 15:47:06 +00006593 PyTypeObject *type;
6594 PyObject *obj = NULL;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006595 PyTypeObject *obj_type = NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006596
Georg Brandl5d59c092006-09-30 08:43:30 +00006597 if (!_PyArg_NoKeywords("super", kwds))
6598 return -1;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006599 if (!PyArg_ParseTuple(args, "O!|O:super", &PyType_Type, &type, &obj))
6600 return -1;
6601 if (obj == Py_None)
6602 obj = NULL;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006603 if (obj != NULL) {
6604 obj_type = supercheck(type, obj);
6605 if (obj_type == NULL)
6606 return -1;
6607 Py_INCREF(obj);
6608 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00006609 Py_INCREF(type);
Guido van Rossum705f0f52001-08-24 16:47:00 +00006610 su->type = type;
6611 su->obj = obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006612 su->obj_type = obj_type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006613 return 0;
6614}
6615
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00006616PyDoc_STRVAR(super_doc,
Guido van Rossum705f0f52001-08-24 16:47:00 +00006617"super(type) -> unbound super object\n"
6618"super(type, obj) -> bound super object; requires isinstance(obj, type)\n"
Guido van Rossume705ef12001-08-29 15:47:06 +00006619"super(type, type2) -> bound super object; requires issubclass(type2, type)\n"
Guido van Rossum705f0f52001-08-24 16:47:00 +00006620"Typical use to call a cooperative superclass method:\n"
6621"class C(B):\n"
6622" def meth(self, arg):\n"
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006623" super(C, self).meth(arg)");
Guido van Rossum705f0f52001-08-24 16:47:00 +00006624
Guido van Rossum048eb752001-10-02 21:24:57 +00006625static int
6626super_traverse(PyObject *self, visitproc visit, void *arg)
6627{
6628 superobject *su = (superobject *)self;
Guido van Rossum048eb752001-10-02 21:24:57 +00006629
Thomas Woutersc6e55062006-04-15 21:47:09 +00006630 Py_VISIT(su->obj);
6631 Py_VISIT(su->type);
6632 Py_VISIT(su->obj_type);
Guido van Rossum048eb752001-10-02 21:24:57 +00006633
6634 return 0;
6635}
6636
Guido van Rossum705f0f52001-08-24 16:47:00 +00006637PyTypeObject PySuper_Type = {
Martin v. Löwis68192102007-07-21 06:55:02 +00006638 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossum705f0f52001-08-24 16:47:00 +00006639 "super", /* tp_name */
6640 sizeof(superobject), /* tp_basicsize */
6641 0, /* tp_itemsize */
6642 /* methods */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006643 super_dealloc, /* tp_dealloc */
Guido van Rossum705f0f52001-08-24 16:47:00 +00006644 0, /* tp_print */
6645 0, /* tp_getattr */
6646 0, /* tp_setattr */
6647 0, /* tp_compare */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00006648 super_repr, /* tp_repr */
Guido van Rossum705f0f52001-08-24 16:47:00 +00006649 0, /* tp_as_number */
6650 0, /* tp_as_sequence */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006651 0, /* tp_as_mapping */
Guido van Rossum705f0f52001-08-24 16:47:00 +00006652 0, /* tp_hash */
6653 0, /* tp_call */
6654 0, /* tp_str */
6655 super_getattro, /* tp_getattro */
6656 0, /* tp_setattro */
6657 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00006658 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
6659 Py_TPFLAGS_BASETYPE, /* tp_flags */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006660 super_doc, /* tp_doc */
6661 super_traverse, /* tp_traverse */
6662 0, /* tp_clear */
Guido van Rossum705f0f52001-08-24 16:47:00 +00006663 0, /* tp_richcompare */
6664 0, /* tp_weaklistoffset */
6665 0, /* tp_iter */
6666 0, /* tp_iternext */
6667 0, /* tp_methods */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00006668 super_members, /* tp_members */
Guido van Rossum705f0f52001-08-24 16:47:00 +00006669 0, /* tp_getset */
6670 0, /* tp_base */
6671 0, /* tp_dict */
6672 super_descr_get, /* tp_descr_get */
6673 0, /* tp_descr_set */
6674 0, /* tp_dictoffset */
6675 super_init, /* tp_init */
6676 PyType_GenericAlloc, /* tp_alloc */
6677 PyType_GenericNew, /* tp_new */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006678 PyObject_GC_Del, /* tp_free */
Guido van Rossum705f0f52001-08-24 16:47:00 +00006679};