blob: 5405fec607b995ad90a2d6045c2301f2ba34106c [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, \
Christian Heimes593daf52008-05-26 12:51:38 +000022 ((PyBytesObject *)(name))->ob_shash)
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +000023#define MCACHE_CACHEABLE_NAME(name) \
Christian Heimes593daf52008-05-26 12:51:38 +000024 PyBytes_CheckExact(name) && \
25 PyBytes_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++;
Christian Heimes593daf52008-05-26 12:51:38 +0000220 return PyBytes_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 }
Christian Heimes593daf52008-05-26 12:51:38 +0000239 if (!PyBytes_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 }
Christian Heimes593daf52008-05-26 12:51:38 +0000245 if (strlen(PyBytes_AS_STRING(value))
246 != (size_t)PyBytes_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
Christian Heimes593daf52008-05-26 12:51:38 +0000259 type->tp_name = PyBytes_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)
Christian Heimes593daf52008-05-26 12:51:38 +0000282 return PyBytes_FromStringAndSize(
Armin Rigo7ccbca92006-10-04 12:17:45 +0000283 type->tp_name, (Py_ssize_t)(s - type->tp_name));
Christian Heimes593daf52008-05-26 12:51:38 +0000284 return PyBytes_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)
Christian Heimes593daf52008-05-26 12:51:38 +0000558 return PyBytes_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
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000574static PyGetSetDef type_getsets[] = {
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000575 {"__name__", (getter)type_name, (setter)type_set_name, NULL},
576 {"__bases__", (getter)type_get_bases, (setter)type_set_bases, NULL},
Guido van Rossum3926a632001-09-25 16:25:58 +0000577 {"__module__", (getter)type_module, (setter)type_set_module, NULL},
Jeffrey Yasskin960b9b72008-02-28 04:45:36 +0000578 {"__abstractmethods__", (getter)type_abstractmethods,
579 (setter)type_set_abstractmethods, NULL},
Tim Peters6d6c1a32001-08-02 04:15:00 +0000580 {"__dict__", (getter)type_dict, NULL, NULL},
Tim Peters24008312002-03-17 18:56:20 +0000581 {"__doc__", (getter)type_get_doc, NULL, NULL},
Tim Peters6d6c1a32001-08-02 04:15:00 +0000582 {0}
583};
584
Martin v. Löwis0163d6d2001-06-09 07:34:05 +0000585static int
586type_compare(PyObject *v, PyObject *w)
587{
588 /* This is called with type objects only. So we
589 can just compare the addresses. */
590 Py_uintptr_t vv = (Py_uintptr_t)v;
591 Py_uintptr_t ww = (Py_uintptr_t)w;
592 return (vv < ww) ? -1 : (vv > ww) ? 1 : 0;
593}
594
Steven Bethardae42f332008-03-18 17:26:10 +0000595static PyObject*
596type_richcompare(PyObject *v, PyObject *w, int op)
597{
598 PyObject *result;
599 Py_uintptr_t vv, ww;
600 int c;
601
602 /* Make sure both arguments are types. */
603 if (!PyType_Check(v) || !PyType_Check(w)) {
604 result = Py_NotImplemented;
605 goto out;
606 }
607
608 /* Py3K warning if comparison isn't == or != */
609 if (Py_Py3kWarningFlag && op != Py_EQ && op != Py_NE &&
Benjamin Peterson9f4f4812008-04-27 03:01:45 +0000610 PyErr_WarnEx(PyExc_DeprecationWarning,
Georg Brandld5b635f2008-03-25 08:29:14 +0000611 "type inequality comparisons not supported "
Benjamin Peterson9f4f4812008-04-27 03:01:45 +0000612 "in 3.x", 1) < 0) {
Steven Bethardae42f332008-03-18 17:26:10 +0000613 return NULL;
614 }
615
616 /* Compare addresses */
617 vv = (Py_uintptr_t)v;
618 ww = (Py_uintptr_t)w;
619 switch (op) {
620 case Py_LT: c = vv < ww; break;
621 case Py_LE: c = vv <= ww; break;
622 case Py_EQ: c = vv == ww; break;
623 case Py_NE: c = vv != ww; break;
624 case Py_GT: c = vv > ww; break;
625 case Py_GE: c = vv >= ww; break;
626 default:
627 result = Py_NotImplemented;
628 goto out;
629 }
630 result = c ? Py_True : Py_False;
631
632 /* incref and return */
633 out:
634 Py_INCREF(result);
635 return result;
636}
637
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000638static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000639type_repr(PyTypeObject *type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000640{
Barry Warsaw7ce36942001-08-24 18:34:26 +0000641 PyObject *mod, *name, *rtn;
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000642 char *kind;
Guido van Rossumc3542212001-08-16 09:18:56 +0000643
644 mod = type_module(type, NULL);
645 if (mod == NULL)
646 PyErr_Clear();
Christian Heimes593daf52008-05-26 12:51:38 +0000647 else if (!PyBytes_Check(mod)) {
Guido van Rossumc3542212001-08-16 09:18:56 +0000648 Py_DECREF(mod);
649 mod = NULL;
650 }
651 name = type_name(type, NULL);
652 if (name == NULL)
653 return NULL;
Barry Warsaw7ce36942001-08-24 18:34:26 +0000654
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000655 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
656 kind = "class";
657 else
658 kind = "type";
659
Christian Heimes593daf52008-05-26 12:51:38 +0000660 if (mod != NULL && strcmp(PyBytes_AS_STRING(mod), "__builtin__")) {
661 rtn = PyBytes_FromFormat("<%s '%s.%s'>",
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000662 kind,
Christian Heimes593daf52008-05-26 12:51:38 +0000663 PyBytes_AS_STRING(mod),
664 PyBytes_AS_STRING(name));
Barry Warsaw7ce36942001-08-24 18:34:26 +0000665 }
Guido van Rossumc3542212001-08-16 09:18:56 +0000666 else
Christian Heimes593daf52008-05-26 12:51:38 +0000667 rtn = PyBytes_FromFormat("<%s '%s'>", kind, type->tp_name);
Barry Warsaw7ce36942001-08-24 18:34:26 +0000668
Guido van Rossumc3542212001-08-16 09:18:56 +0000669 Py_XDECREF(mod);
670 Py_DECREF(name);
Barry Warsaw7ce36942001-08-24 18:34:26 +0000671 return rtn;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000672}
673
Tim Peters6d6c1a32001-08-02 04:15:00 +0000674static PyObject *
675type_call(PyTypeObject *type, PyObject *args, PyObject *kwds)
676{
677 PyObject *obj;
678
679 if (type->tp_new == NULL) {
680 PyErr_Format(PyExc_TypeError,
681 "cannot create '%.100s' instances",
682 type->tp_name);
683 return NULL;
684 }
685
Tim Peters3f996e72001-09-13 19:18:27 +0000686 obj = type->tp_new(type, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000687 if (obj != NULL) {
Guido van Rossumf76de622001-10-18 15:49:21 +0000688 /* Ugly exception: when the call was type(something),
689 don't call tp_init on the result. */
690 if (type == &PyType_Type &&
691 PyTuple_Check(args) && PyTuple_GET_SIZE(args) == 1 &&
692 (kwds == NULL ||
693 (PyDict_Check(kwds) && PyDict_Size(kwds) == 0)))
694 return obj;
Guido van Rossum8ace1ab2002-04-06 01:05:01 +0000695 /* If the returned object is not an instance of type,
696 it won't be initialized. */
697 if (!PyType_IsSubtype(obj->ob_type, type))
698 return obj;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000699 type = obj->ob_type;
Jeremy Hylton719841e2002-07-16 19:39:38 +0000700 if (PyType_HasFeature(type, Py_TPFLAGS_HAVE_CLASS) &&
701 type->tp_init != NULL &&
Tim Peters6d6c1a32001-08-02 04:15:00 +0000702 type->tp_init(obj, args, kwds) < 0) {
703 Py_DECREF(obj);
704 obj = NULL;
705 }
706 }
707 return obj;
708}
709
710PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000711PyType_GenericAlloc(PyTypeObject *type, Py_ssize_t nitems)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000712{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000713 PyObject *obj;
Guido van Rossume5c691a2003-03-07 15:13:17 +0000714 const size_t size = _PyObject_VAR_SIZE(type, nitems+1);
715 /* note that we need to add one, for the sentinel */
Tim Peters406fe3b2001-10-06 19:04:01 +0000716
717 if (PyType_IS_GC(type))
Neil Schemenauer09a2ae52002-04-12 03:06:53 +0000718 obj = _PyObject_GC_Malloc(size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000719 else
Anthony Baxtera6286212006-04-11 07:42:36 +0000720 obj = (PyObject *)PyObject_MALLOC(size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000721
Neil Schemenauerc806c882001-08-29 23:54:54 +0000722 if (obj == NULL)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000723 return PyErr_NoMemory();
Tim Peters406fe3b2001-10-06 19:04:01 +0000724
Neil Schemenauerc806c882001-08-29 23:54:54 +0000725 memset(obj, '\0', size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000726
Tim Peters6d6c1a32001-08-02 04:15:00 +0000727 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
728 Py_INCREF(type);
Tim Peters406fe3b2001-10-06 19:04:01 +0000729
Tim Peters6d6c1a32001-08-02 04:15:00 +0000730 if (type->tp_itemsize == 0)
731 PyObject_INIT(obj, type);
732 else
733 (void) PyObject_INIT_VAR((PyVarObject *)obj, type, nitems);
Tim Peters406fe3b2001-10-06 19:04:01 +0000734
Tim Peters6d6c1a32001-08-02 04:15:00 +0000735 if (PyType_IS_GC(type))
Neil Schemenauerc806c882001-08-29 23:54:54 +0000736 _PyObject_GC_TRACK(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000737 return obj;
738}
739
740PyObject *
741PyType_GenericNew(PyTypeObject *type, PyObject *args, PyObject *kwds)
742{
743 return type->tp_alloc(type, 0);
744}
745
Guido van Rossum9475a232001-10-05 20:51:39 +0000746/* Helpers for subtyping */
747
748static int
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000749traverse_slots(PyTypeObject *type, PyObject *self, visitproc visit, void *arg)
750{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000751 Py_ssize_t i, n;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000752 PyMemberDef *mp;
753
Christian Heimese93237d2007-12-19 02:37:44 +0000754 n = Py_SIZE(type);
Guido van Rossume5c691a2003-03-07 15:13:17 +0000755 mp = PyHeapType_GET_MEMBERS((PyHeapTypeObject *)type);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000756 for (i = 0; i < n; i++, mp++) {
757 if (mp->type == T_OBJECT_EX) {
758 char *addr = (char *)self + mp->offset;
759 PyObject *obj = *(PyObject **)addr;
760 if (obj != NULL) {
761 int err = visit(obj, arg);
762 if (err)
763 return err;
764 }
765 }
766 }
767 return 0;
768}
769
770static int
Guido van Rossum9475a232001-10-05 20:51:39 +0000771subtype_traverse(PyObject *self, visitproc visit, void *arg)
772{
773 PyTypeObject *type, *base;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000774 traverseproc basetraverse;
Guido van Rossum9475a232001-10-05 20:51:39 +0000775
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000776 /* Find the nearest base with a different tp_traverse,
777 and traverse slots while we're at it */
Christian Heimese93237d2007-12-19 02:37:44 +0000778 type = Py_TYPE(self);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000779 base = type;
780 while ((basetraverse = base->tp_traverse) == subtype_traverse) {
Christian Heimese93237d2007-12-19 02:37:44 +0000781 if (Py_SIZE(base)) {
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000782 int err = traverse_slots(base, self, visit, arg);
783 if (err)
784 return err;
785 }
Guido van Rossum9475a232001-10-05 20:51:39 +0000786 base = base->tp_base;
787 assert(base);
788 }
789
790 if (type->tp_dictoffset != base->tp_dictoffset) {
791 PyObject **dictptr = _PyObject_GetDictPtr(self);
Thomas Woutersc6e55062006-04-15 21:47:09 +0000792 if (dictptr && *dictptr)
793 Py_VISIT(*dictptr);
Guido van Rossum9475a232001-10-05 20:51:39 +0000794 }
795
Thomas Woutersc6e55062006-04-15 21:47:09 +0000796 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
Guido van Rossuma3862092002-06-10 15:24:42 +0000797 /* For a heaptype, the instances count as references
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000798 to the type. Traverse the type so the collector
Guido van Rossuma3862092002-06-10 15:24:42 +0000799 can find cycles involving this link. */
Thomas Woutersc6e55062006-04-15 21:47:09 +0000800 Py_VISIT(type);
Guido van Rossuma3862092002-06-10 15:24:42 +0000801
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000802 if (basetraverse)
803 return basetraverse(self, visit, arg);
804 return 0;
805}
806
807static void
808clear_slots(PyTypeObject *type, PyObject *self)
809{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000810 Py_ssize_t i, n;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000811 PyMemberDef *mp;
812
Christian Heimese93237d2007-12-19 02:37:44 +0000813 n = Py_SIZE(type);
Guido van Rossume5c691a2003-03-07 15:13:17 +0000814 mp = PyHeapType_GET_MEMBERS((PyHeapTypeObject *)type);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000815 for (i = 0; i < n; i++, mp++) {
816 if (mp->type == T_OBJECT_EX && !(mp->flags & READONLY)) {
817 char *addr = (char *)self + mp->offset;
818 PyObject *obj = *(PyObject **)addr;
819 if (obj != NULL) {
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000820 *(PyObject **)addr = NULL;
Thomas Woutersedf17d82006-04-15 17:28:34 +0000821 Py_DECREF(obj);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000822 }
823 }
824 }
825}
826
827static int
828subtype_clear(PyObject *self)
829{
830 PyTypeObject *type, *base;
831 inquiry baseclear;
832
833 /* Find the nearest base with a different tp_clear
834 and clear slots while we're at it */
Christian Heimese93237d2007-12-19 02:37:44 +0000835 type = Py_TYPE(self);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000836 base = type;
837 while ((baseclear = base->tp_clear) == subtype_clear) {
Christian Heimese93237d2007-12-19 02:37:44 +0000838 if (Py_SIZE(base))
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000839 clear_slots(base, self);
840 base = base->tp_base;
841 assert(base);
842 }
843
Guido van Rossuma3862092002-06-10 15:24:42 +0000844 /* There's no need to clear the instance dict (if any);
845 the collector will call its tp_clear handler. */
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000846
847 if (baseclear)
848 return baseclear(self);
Guido van Rossum9475a232001-10-05 20:51:39 +0000849 return 0;
850}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000851
852static void
853subtype_dealloc(PyObject *self)
854{
Guido van Rossum14227b42001-12-06 02:35:58 +0000855 PyTypeObject *type, *base;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000856 destructor basedealloc;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000857
Guido van Rossum22b13872002-08-06 21:41:44 +0000858 /* Extract the type; we expect it to be a heap type */
Christian Heimese93237d2007-12-19 02:37:44 +0000859 type = Py_TYPE(self);
Guido van Rossum22b13872002-08-06 21:41:44 +0000860 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000861
Guido van Rossum22b13872002-08-06 21:41:44 +0000862 /* Test whether the type has GC exactly once */
863
864 if (!PyType_IS_GC(type)) {
865 /* It's really rare to find a dynamic type that doesn't have
866 GC; it can only happen when deriving from 'object' and not
867 adding any slots or instance variables. This allows
868 certain simplifications: there's no need to call
869 clear_slots(), or DECREF the dict, or clear weakrefs. */
870
871 /* Maybe call finalizer; exit early if resurrected */
Guido van Rossumfebd61d2002-08-08 20:55:20 +0000872 if (type->tp_del) {
873 type->tp_del(self);
874 if (self->ob_refcnt > 0)
875 return;
876 }
Guido van Rossum22b13872002-08-06 21:41:44 +0000877
878 /* Find the nearest base with a different tp_dealloc */
879 base = type;
880 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
Christian Heimese93237d2007-12-19 02:37:44 +0000881 assert(Py_SIZE(base) == 0);
Guido van Rossum22b13872002-08-06 21:41:44 +0000882 base = base->tp_base;
883 assert(base);
884 }
885
886 /* Call the base tp_dealloc() */
887 assert(basedealloc);
888 basedealloc(self);
889
890 /* Can't reference self beyond this point */
891 Py_DECREF(type);
892
893 /* Done */
894 return;
895 }
896
897 /* We get here only if the type has GC */
898
899 /* UnTrack and re-Track around the trashcan macro, alas */
Andrew M. Kuchlingc9172d32003-02-06 15:22:49 +0000900 /* See explanation at end of function for full disclosure */
Guido van Rossum0906e072002-08-07 20:42:09 +0000901 PyObject_GC_UnTrack(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000902 ++_PyTrash_delete_nesting;
Guido van Rossum22b13872002-08-06 21:41:44 +0000903 Py_TRASHCAN_SAFE_BEGIN(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000904 --_PyTrash_delete_nesting;
Tim Petersf7f9e992003-11-13 21:59:32 +0000905 /* DO NOT restore GC tracking at this point. weakref callbacks
906 * (if any, and whether directly here or indirectly in something we
907 * call) may trigger GC, and if self is tracked at that point, it
908 * will look like trash to GC and GC will try to delete self again.
Tim Petersadd09b42003-11-12 20:43:28 +0000909 */
Guido van Rossum22b13872002-08-06 21:41:44 +0000910
Guido van Rossum59195fd2003-06-13 20:54:40 +0000911 /* Find the nearest base with a different tp_dealloc */
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000912 base = type;
913 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000914 base = base->tp_base;
915 assert(base);
Guido van Rossum14227b42001-12-06 02:35:58 +0000916 }
917
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000918 /* If we added a weaklist, we clear it. Do this *before* calling
Guido van Rossum59195fd2003-06-13 20:54:40 +0000919 the finalizer (__del__), clearing slots, or clearing the instance
920 dict. */
921
Guido van Rossum1987c662003-05-29 14:29:23 +0000922 if (type->tp_weaklistoffset && !base->tp_weaklistoffset)
923 PyObject_ClearWeakRefs(self);
924
925 /* Maybe call finalizer; exit early if resurrected */
926 if (type->tp_del) {
Tim Petersf7f9e992003-11-13 21:59:32 +0000927 _PyObject_GC_TRACK(self);
Guido van Rossum1987c662003-05-29 14:29:23 +0000928 type->tp_del(self);
929 if (self->ob_refcnt > 0)
Tim Petersf7f9e992003-11-13 21:59:32 +0000930 goto endlabel; /* resurrected */
931 else
932 _PyObject_GC_UNTRACK(self);
Brett Cannonf5bee302007-01-23 23:21:22 +0000933 /* New weakrefs could be created during the finalizer call.
934 If this occurs, clear them out without calling their
935 finalizers since they might rely on part of the object
936 being finalized that has already been destroyed. */
937 if (type->tp_weaklistoffset && !base->tp_weaklistoffset) {
938 /* Modeled after GET_WEAKREFS_LISTPTR() */
939 PyWeakReference **list = (PyWeakReference **) \
940 PyObject_GET_WEAKREFS_LISTPTR(self);
941 while (*list)
942 _PyWeakref_ClearRef(*list);
943 }
Guido van Rossum1987c662003-05-29 14:29:23 +0000944 }
945
Guido van Rossum59195fd2003-06-13 20:54:40 +0000946 /* Clear slots up to the nearest base with a different tp_dealloc */
947 base = type;
948 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
Christian Heimese93237d2007-12-19 02:37:44 +0000949 if (Py_SIZE(base))
Guido van Rossum59195fd2003-06-13 20:54:40 +0000950 clear_slots(base, self);
951 base = base->tp_base;
952 assert(base);
953 }
954
Tim Peters6d6c1a32001-08-02 04:15:00 +0000955 /* If we added a dict, DECREF it */
Guido van Rossum6fb3fde2001-08-30 20:00:07 +0000956 if (type->tp_dictoffset && !base->tp_dictoffset) {
957 PyObject **dictptr = _PyObject_GetDictPtr(self);
958 if (dictptr != NULL) {
959 PyObject *dict = *dictptr;
960 if (dict != NULL) {
961 Py_DECREF(dict);
962 *dictptr = NULL;
963 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000964 }
965 }
966
Tim Peters0bd743c2003-11-13 22:50:00 +0000967 /* Call the base tp_dealloc(); first retrack self if
968 * basedealloc knows about gc.
969 */
970 if (PyType_IS_GC(base))
971 _PyObject_GC_TRACK(self);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000972 assert(basedealloc);
973 basedealloc(self);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000974
975 /* Can't reference self beyond this point */
Guido van Rossum22b13872002-08-06 21:41:44 +0000976 Py_DECREF(type);
977
Guido van Rossum0906e072002-08-07 20:42:09 +0000978 endlabel:
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000979 ++_PyTrash_delete_nesting;
Guido van Rossum22b13872002-08-06 21:41:44 +0000980 Py_TRASHCAN_SAFE_END(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000981 --_PyTrash_delete_nesting;
982
983 /* Explanation of the weirdness around the trashcan macros:
984
985 Q. What do the trashcan macros do?
986
987 A. Read the comment titled "Trashcan mechanism" in object.h.
988 For one, this explains why there must be a call to GC-untrack
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000989 before the trashcan begin macro. Without understanding the
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000990 trashcan code, the answers to the following questions don't make
991 sense.
992
993 Q. Why do we GC-untrack before the trashcan and then immediately
994 GC-track again afterward?
995
996 A. In the case that the base class is GC-aware, the base class
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000997 probably GC-untracks the object. If it does that using the
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000998 UNTRACK macro, this will crash when the object is already
999 untracked. Because we don't know what the base class does, the
1000 only safe thing is to make sure the object is tracked when we
1001 call the base class dealloc. But... The trashcan begin macro
1002 requires that the object is *untracked* before it is called. So
1003 the dance becomes:
1004
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001005 GC untrack
Guido van Rossumce8bcd82003-02-05 22:39:45 +00001006 trashcan begin
1007 GC track
1008
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001009 Q. Why did the last question say "immediately GC-track again"?
1010 It's nowhere near immediately.
Tim Petersf7f9e992003-11-13 21:59:32 +00001011
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001012 A. Because the code *used* to re-track immediately. Bad Idea.
1013 self has a refcount of 0, and if gc ever gets its hands on it
1014 (which can happen if any weakref callback gets invoked), it
1015 looks like trash to gc too, and gc also tries to delete self
1016 then. But we're already deleting self. Double dealloction is
1017 a subtle disaster.
Tim Petersf7f9e992003-11-13 21:59:32 +00001018
Guido van Rossumce8bcd82003-02-05 22:39:45 +00001019 Q. Why the bizarre (net-zero) manipulation of
1020 _PyTrash_delete_nesting around the trashcan macros?
1021
1022 A. Some base classes (e.g. list) also use the trashcan mechanism.
1023 The following scenario used to be possible:
1024
1025 - suppose the trashcan level is one below the trashcan limit
1026
1027 - subtype_dealloc() is called
1028
1029 - the trashcan limit is not yet reached, so the trashcan level
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001030 is incremented and the code between trashcan begin and end is
1031 executed
Guido van Rossumce8bcd82003-02-05 22:39:45 +00001032
1033 - this destroys much of the object's contents, including its
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001034 slots and __dict__
Guido van Rossumce8bcd82003-02-05 22:39:45 +00001035
1036 - basedealloc() is called; this is really list_dealloc(), or
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001037 some other type which also uses the trashcan macros
Guido van Rossumce8bcd82003-02-05 22:39:45 +00001038
1039 - the trashcan limit is now reached, so the object is put on the
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001040 trashcan's to-be-deleted-later list
Guido van Rossumce8bcd82003-02-05 22:39:45 +00001041
1042 - basedealloc() returns
1043
1044 - subtype_dealloc() decrefs the object's type
1045
1046 - subtype_dealloc() returns
1047
1048 - later, the trashcan code starts deleting the objects from its
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001049 to-be-deleted-later list
Guido van Rossumce8bcd82003-02-05 22:39:45 +00001050
1051 - subtype_dealloc() is called *AGAIN* for the same object
1052
1053 - at the very least (if the destroyed slots and __dict__ don't
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001054 cause problems) the object's type gets decref'ed a second
1055 time, which is *BAD*!!!
Guido van Rossumce8bcd82003-02-05 22:39:45 +00001056
1057 The remedy is to make sure that if the code between trashcan
1058 begin and end in subtype_dealloc() is called, the code between
1059 trashcan begin and end in basedealloc() will also be called.
1060 This is done by decrementing the level after passing into the
1061 trashcan block, and incrementing it just before leaving the
1062 block.
1063
1064 But now it's possible that a chain of objects consisting solely
1065 of objects whose deallocator is subtype_dealloc() will defeat
1066 the trashcan mechanism completely: the decremented level means
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001067 that the effective level never reaches the limit. Therefore, we
Guido van Rossumce8bcd82003-02-05 22:39:45 +00001068 *increment* the level *before* entering the trashcan block, and
1069 matchingly decrement it after leaving. This means the trashcan
1070 code will trigger a little early, but that's no big deal.
1071
1072 Q. Are there any live examples of code in need of all this
1073 complexity?
1074
1075 A. Yes. See SF bug 668433 for code that crashed (when Python was
1076 compiled in debug mode) before the trashcan level manipulations
1077 were added. For more discussion, see SF patches 581742, 575073
1078 and bug 574207.
1079 */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001080}
1081
Jeremy Hylton938ace62002-07-17 16:30:39 +00001082static PyTypeObject *solid_base(PyTypeObject *type);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001083
Tim Peters6d6c1a32001-08-02 04:15:00 +00001084/* type test with subclassing support */
1085
1086int
1087PyType_IsSubtype(PyTypeObject *a, PyTypeObject *b)
1088{
1089 PyObject *mro;
1090
Guido van Rossum9478d072001-09-07 18:52:13 +00001091 if (!(a->tp_flags & Py_TPFLAGS_HAVE_CLASS))
1092 return b == a || b == &PyBaseObject_Type;
1093
Tim Peters6d6c1a32001-08-02 04:15:00 +00001094 mro = a->tp_mro;
1095 if (mro != NULL) {
1096 /* Deal with multiple inheritance without recursion
1097 by walking the MRO tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001098 Py_ssize_t i, n;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001099 assert(PyTuple_Check(mro));
1100 n = PyTuple_GET_SIZE(mro);
1101 for (i = 0; i < n; i++) {
1102 if (PyTuple_GET_ITEM(mro, i) == (PyObject *)b)
1103 return 1;
1104 }
1105 return 0;
1106 }
1107 else {
1108 /* a is not completely initilized yet; follow tp_base */
1109 do {
1110 if (a == b)
1111 return 1;
1112 a = a->tp_base;
1113 } while (a != NULL);
1114 return b == &PyBaseObject_Type;
1115 }
1116}
1117
Guido van Rossumf21c6be2001-09-14 17:51:50 +00001118/* Internal routines to do a method lookup in the type
Guido van Rossum60718732001-08-28 17:47:51 +00001119 without looking in the instance dictionary
1120 (so we can't use PyObject_GetAttr) but still binding
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001121 it to the instance. The arguments are the object,
Guido van Rossum60718732001-08-28 17:47:51 +00001122 the method name as a C string, and the address of a
Guido van Rossumf21c6be2001-09-14 17:51:50 +00001123 static variable used to cache the interned Python string.
1124
1125 Two variants:
1126
1127 - lookup_maybe() returns NULL without raising an exception
1128 when the _PyType_Lookup() call fails;
1129
1130 - lookup_method() always raises an exception upon errors.
1131*/
Guido van Rossum60718732001-08-28 17:47:51 +00001132
1133static PyObject *
Guido van Rossumf21c6be2001-09-14 17:51:50 +00001134lookup_maybe(PyObject *self, char *attrstr, PyObject **attrobj)
Guido van Rossum60718732001-08-28 17:47:51 +00001135{
1136 PyObject *res;
1137
1138 if (*attrobj == NULL) {
Christian Heimes593daf52008-05-26 12:51:38 +00001139 *attrobj = PyBytes_InternFromString(attrstr);
Guido van Rossum60718732001-08-28 17:47:51 +00001140 if (*attrobj == NULL)
1141 return NULL;
1142 }
Christian Heimese93237d2007-12-19 02:37:44 +00001143 res = _PyType_Lookup(Py_TYPE(self), *attrobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +00001144 if (res != NULL) {
Guido van Rossum60718732001-08-28 17:47:51 +00001145 descrgetfunc f;
Christian Heimese93237d2007-12-19 02:37:44 +00001146 if ((f = Py_TYPE(res)->tp_descr_get) == NULL)
Guido van Rossum60718732001-08-28 17:47:51 +00001147 Py_INCREF(res);
1148 else
Christian Heimese93237d2007-12-19 02:37:44 +00001149 res = f(res, self, (PyObject *)(Py_TYPE(self)));
Guido van Rossum60718732001-08-28 17:47:51 +00001150 }
1151 return res;
1152}
1153
Guido van Rossumf21c6be2001-09-14 17:51:50 +00001154static PyObject *
1155lookup_method(PyObject *self, char *attrstr, PyObject **attrobj)
1156{
1157 PyObject *res = lookup_maybe(self, attrstr, attrobj);
1158 if (res == NULL && !PyErr_Occurred())
1159 PyErr_SetObject(PyExc_AttributeError, *attrobj);
1160 return res;
1161}
1162
Guido van Rossum2730b132001-08-28 18:22:14 +00001163/* A variation of PyObject_CallMethod that uses lookup_method()
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001164 instead of PyObject_GetAttrString(). This uses the same convention
Guido van Rossum2730b132001-08-28 18:22:14 +00001165 as lookup_method to cache the interned name string object. */
1166
Neil Schemenauerf23473f2001-10-21 22:28:58 +00001167static PyObject *
Guido van Rossum2730b132001-08-28 18:22:14 +00001168call_method(PyObject *o, char *name, PyObject **nameobj, char *format, ...)
1169{
1170 va_list va;
1171 PyObject *args, *func = 0, *retval;
Guido van Rossum2730b132001-08-28 18:22:14 +00001172 va_start(va, format);
1173
Guido van Rossumda21c012001-10-03 00:50:18 +00001174 func = lookup_maybe(o, name, nameobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +00001175 if (func == NULL) {
1176 va_end(va);
1177 if (!PyErr_Occurred())
Guido van Rossumda21c012001-10-03 00:50:18 +00001178 PyErr_SetObject(PyExc_AttributeError, *nameobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +00001179 return NULL;
1180 }
Guido van Rossumf21c6be2001-09-14 17:51:50 +00001181
1182 if (format && *format)
1183 args = Py_VaBuildValue(format, va);
1184 else
1185 args = PyTuple_New(0);
1186
1187 va_end(va);
1188
1189 if (args == NULL)
1190 return NULL;
1191
1192 assert(PyTuple_Check(args));
1193 retval = PyObject_Call(func, args, NULL);
1194
1195 Py_DECREF(args);
1196 Py_DECREF(func);
1197
1198 return retval;
1199}
1200
1201/* Clone of call_method() that returns NotImplemented when the lookup fails. */
1202
Neil Schemenauerf23473f2001-10-21 22:28:58 +00001203static PyObject *
Guido van Rossumf21c6be2001-09-14 17:51:50 +00001204call_maybe(PyObject *o, char *name, PyObject **nameobj, char *format, ...)
1205{
1206 va_list va;
1207 PyObject *args, *func = 0, *retval;
Guido van Rossumf21c6be2001-09-14 17:51:50 +00001208 va_start(va, format);
1209
Guido van Rossumda21c012001-10-03 00:50:18 +00001210 func = lookup_maybe(o, name, nameobj);
Guido van Rossum2730b132001-08-28 18:22:14 +00001211 if (func == NULL) {
1212 va_end(va);
Guido van Rossumf21c6be2001-09-14 17:51:50 +00001213 if (!PyErr_Occurred()) {
1214 Py_INCREF(Py_NotImplemented);
1215 return Py_NotImplemented;
1216 }
Guido van Rossum717ce002001-09-14 16:58:08 +00001217 return NULL;
Guido van Rossum2730b132001-08-28 18:22:14 +00001218 }
1219
1220 if (format && *format)
1221 args = Py_VaBuildValue(format, va);
1222 else
1223 args = PyTuple_New(0);
1224
1225 va_end(va);
1226
Guido van Rossum717ce002001-09-14 16:58:08 +00001227 if (args == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00001228 return NULL;
1229
Guido van Rossum717ce002001-09-14 16:58:08 +00001230 assert(PyTuple_Check(args));
1231 retval = PyObject_Call(func, args, NULL);
Guido van Rossum2730b132001-08-28 18:22:14 +00001232
1233 Py_DECREF(args);
1234 Py_DECREF(func);
1235
1236 return retval;
1237}
1238
Tim Petersa91e9642001-11-14 23:32:33 +00001239static int
1240fill_classic_mro(PyObject *mro, PyObject *cls)
1241{
1242 PyObject *bases, *base;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001243 Py_ssize_t i, n;
Tim Petersa91e9642001-11-14 23:32:33 +00001244
1245 assert(PyList_Check(mro));
1246 assert(PyClass_Check(cls));
1247 i = PySequence_Contains(mro, cls);
1248 if (i < 0)
1249 return -1;
1250 if (!i) {
1251 if (PyList_Append(mro, cls) < 0)
1252 return -1;
1253 }
1254 bases = ((PyClassObject *)cls)->cl_bases;
1255 assert(bases && PyTuple_Check(bases));
1256 n = PyTuple_GET_SIZE(bases);
1257 for (i = 0; i < n; i++) {
1258 base = PyTuple_GET_ITEM(bases, i);
1259 if (fill_classic_mro(mro, base) < 0)
1260 return -1;
1261 }
1262 return 0;
1263}
1264
1265static PyObject *
1266classic_mro(PyObject *cls)
1267{
1268 PyObject *mro;
1269
1270 assert(PyClass_Check(cls));
1271 mro = PyList_New(0);
1272 if (mro != NULL) {
1273 if (fill_classic_mro(mro, cls) == 0)
1274 return mro;
1275 Py_DECREF(mro);
1276 }
1277 return NULL;
1278}
1279
Tim Petersea7f75d2002-12-07 21:39:16 +00001280/*
Guido van Rossum1f121312002-11-14 19:49:16 +00001281 Method resolution order algorithm C3 described in
1282 "A Monotonic Superclass Linearization for Dylan",
1283 by Kim Barrett, Bob Cassel, Paul Haahr,
Tim Petersea7f75d2002-12-07 21:39:16 +00001284 David A. Moon, Keith Playford, and P. Tucker Withington.
Guido van Rossum1f121312002-11-14 19:49:16 +00001285 (OOPSLA 1996)
1286
Guido van Rossum98f33732002-11-25 21:36:54 +00001287 Some notes about the rules implied by C3:
1288
Tim Petersea7f75d2002-12-07 21:39:16 +00001289 No duplicate bases.
Guido van Rossum98f33732002-11-25 21:36:54 +00001290 It isn't legal to repeat a class in a list of base classes.
1291
1292 The next three properties are the 3 constraints in "C3".
1293
Tim Petersea7f75d2002-12-07 21:39:16 +00001294 Local precendece order.
Guido van Rossum98f33732002-11-25 21:36:54 +00001295 If A precedes B in C's MRO, then A will precede B in the MRO of all
1296 subclasses of C.
1297
1298 Monotonicity.
1299 The MRO of a class must be an extension without reordering of the
1300 MRO of each of its superclasses.
1301
1302 Extended Precedence Graph (EPG).
1303 Linearization is consistent if there is a path in the EPG from
1304 each class to all its successors in the linearization. See
1305 the paper for definition of EPG.
Guido van Rossum1f121312002-11-14 19:49:16 +00001306 */
1307
Tim Petersea7f75d2002-12-07 21:39:16 +00001308static int
Guido van Rossum1f121312002-11-14 19:49:16 +00001309tail_contains(PyObject *list, int whence, PyObject *o) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001310 Py_ssize_t j, size;
Guido van Rossum1f121312002-11-14 19:49:16 +00001311 size = PyList_GET_SIZE(list);
1312
1313 for (j = whence+1; j < size; j++) {
1314 if (PyList_GET_ITEM(list, j) == o)
1315 return 1;
1316 }
1317 return 0;
1318}
1319
Guido van Rossum98f33732002-11-25 21:36:54 +00001320static PyObject *
1321class_name(PyObject *cls)
1322{
1323 PyObject *name = PyObject_GetAttrString(cls, "__name__");
1324 if (name == NULL) {
1325 PyErr_Clear();
1326 Py_XDECREF(name);
1327 name = PyObject_Repr(cls);
1328 }
1329 if (name == NULL)
1330 return NULL;
Christian Heimes593daf52008-05-26 12:51:38 +00001331 if (!PyBytes_Check(name)) {
Guido van Rossum98f33732002-11-25 21:36:54 +00001332 Py_DECREF(name);
1333 return NULL;
1334 }
1335 return name;
1336}
1337
1338static int
1339check_duplicates(PyObject *list)
1340{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001341 Py_ssize_t i, j, n;
Guido van Rossum98f33732002-11-25 21:36:54 +00001342 /* Let's use a quadratic time algorithm,
1343 assuming that the bases lists is short.
1344 */
1345 n = PyList_GET_SIZE(list);
1346 for (i = 0; i < n; i++) {
1347 PyObject *o = PyList_GET_ITEM(list, i);
1348 for (j = i + 1; j < n; j++) {
1349 if (PyList_GET_ITEM(list, j) == o) {
1350 o = class_name(o);
1351 PyErr_Format(PyExc_TypeError,
1352 "duplicate base class %s",
Christian Heimes593daf52008-05-26 12:51:38 +00001353 o ? PyBytes_AS_STRING(o) : "?");
Guido van Rossum98f33732002-11-25 21:36:54 +00001354 Py_XDECREF(o);
1355 return -1;
1356 }
1357 }
1358 }
1359 return 0;
1360}
1361
1362/* Raise a TypeError for an MRO order disagreement.
1363
1364 It's hard to produce a good error message. In the absence of better
1365 insight into error reporting, report the classes that were candidates
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001366 to be put next into the MRO. There is some conflict between the
Guido van Rossum98f33732002-11-25 21:36:54 +00001367 order in which they should be put in the MRO, but it's hard to
1368 diagnose what constraint can't be satisfied.
1369*/
1370
1371static void
1372set_mro_error(PyObject *to_merge, int *remain)
1373{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001374 Py_ssize_t i, n, off, to_merge_size;
Guido van Rossum98f33732002-11-25 21:36:54 +00001375 char buf[1000];
1376 PyObject *k, *v;
1377 PyObject *set = PyDict_New();
Georg Brandl5c170fd2006-03-17 19:03:25 +00001378 if (!set) return;
Guido van Rossum98f33732002-11-25 21:36:54 +00001379
1380 to_merge_size = PyList_GET_SIZE(to_merge);
1381 for (i = 0; i < to_merge_size; i++) {
1382 PyObject *L = PyList_GET_ITEM(to_merge, i);
1383 if (remain[i] < PyList_GET_SIZE(L)) {
1384 PyObject *c = PyList_GET_ITEM(L, remain[i]);
Georg Brandl5c170fd2006-03-17 19:03:25 +00001385 if (PyDict_SetItem(set, c, Py_None) < 0) {
1386 Py_DECREF(set);
Guido van Rossum98f33732002-11-25 21:36:54 +00001387 return;
Georg Brandl5c170fd2006-03-17 19:03:25 +00001388 }
Guido van Rossum98f33732002-11-25 21:36:54 +00001389 }
1390 }
1391 n = PyDict_Size(set);
1392
Raymond Hettingerf394df42003-04-06 19:13:41 +00001393 off = PyOS_snprintf(buf, sizeof(buf), "Cannot create a \
1394consistent method resolution\norder (MRO) for bases");
Guido van Rossum98f33732002-11-25 21:36:54 +00001395 i = 0;
Skip Montanaro429433b2006-04-18 00:35:43 +00001396 while (PyDict_Next(set, &i, &k, &v) && (size_t)off < sizeof(buf)) {
Guido van Rossum98f33732002-11-25 21:36:54 +00001397 PyObject *name = class_name(k);
1398 off += PyOS_snprintf(buf + off, sizeof(buf) - off, " %s",
Christian Heimes593daf52008-05-26 12:51:38 +00001399 name ? PyBytes_AS_STRING(name) : "?");
Guido van Rossum98f33732002-11-25 21:36:54 +00001400 Py_XDECREF(name);
Skip Montanaro429433b2006-04-18 00:35:43 +00001401 if (--n && (size_t)(off+1) < sizeof(buf)) {
Guido van Rossum98f33732002-11-25 21:36:54 +00001402 buf[off++] = ',';
1403 buf[off] = '\0';
1404 }
1405 }
1406 PyErr_SetString(PyExc_TypeError, buf);
1407 Py_DECREF(set);
1408}
1409
Tim Petersea7f75d2002-12-07 21:39:16 +00001410static int
Guido van Rossum1f121312002-11-14 19:49:16 +00001411pmerge(PyObject *acc, PyObject* to_merge) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001412 Py_ssize_t i, j, to_merge_size, empty_cnt;
Guido van Rossum1f121312002-11-14 19:49:16 +00001413 int *remain;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001414 int ok;
Tim Petersea7f75d2002-12-07 21:39:16 +00001415
Guido van Rossum1f121312002-11-14 19:49:16 +00001416 to_merge_size = PyList_GET_SIZE(to_merge);
1417
Guido van Rossum98f33732002-11-25 21:36:54 +00001418 /* remain stores an index into each sublist of to_merge.
1419 remain[i] is the index of the next base in to_merge[i]
1420 that is not included in acc.
1421 */
Anthony Baxtera6286212006-04-11 07:42:36 +00001422 remain = (int *)PyMem_MALLOC(SIZEOF_INT*to_merge_size);
Guido van Rossum1f121312002-11-14 19:49:16 +00001423 if (remain == NULL)
1424 return -1;
1425 for (i = 0; i < to_merge_size; i++)
1426 remain[i] = 0;
1427
1428 again:
1429 empty_cnt = 0;
1430 for (i = 0; i < to_merge_size; i++) {
1431 PyObject *candidate;
Tim Petersea7f75d2002-12-07 21:39:16 +00001432
Guido van Rossum1f121312002-11-14 19:49:16 +00001433 PyObject *cur_list = PyList_GET_ITEM(to_merge, i);
1434
1435 if (remain[i] >= PyList_GET_SIZE(cur_list)) {
1436 empty_cnt++;
1437 continue;
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001438 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001439
Guido van Rossum98f33732002-11-25 21:36:54 +00001440 /* Choose next candidate for MRO.
1441
1442 The input sequences alone can determine the choice.
1443 If not, choose the class which appears in the MRO
1444 of the earliest direct superclass of the new class.
1445 */
1446
Guido van Rossum1f121312002-11-14 19:49:16 +00001447 candidate = PyList_GET_ITEM(cur_list, remain[i]);
1448 for (j = 0; j < to_merge_size; j++) {
1449 PyObject *j_lst = PyList_GET_ITEM(to_merge, j);
Guido van Rossum98f33732002-11-25 21:36:54 +00001450 if (tail_contains(j_lst, remain[j], candidate)) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001451 goto skip; /* continue outer loop */
Guido van Rossum98f33732002-11-25 21:36:54 +00001452 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001453 }
1454 ok = PyList_Append(acc, candidate);
1455 if (ok < 0) {
1456 PyMem_Free(remain);
1457 return -1;
1458 }
1459 for (j = 0; j < to_merge_size; j++) {
1460 PyObject *j_lst = PyList_GET_ITEM(to_merge, j);
Guido van Rossum768158c2002-12-31 16:33:01 +00001461 if (remain[j] < PyList_GET_SIZE(j_lst) &&
1462 PyList_GET_ITEM(j_lst, remain[j]) == candidate) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001463 remain[j]++;
1464 }
1465 }
1466 goto again;
Tim Peters9a6b8d82002-11-14 23:22:33 +00001467 skip: ;
Guido van Rossum1f121312002-11-14 19:49:16 +00001468 }
1469
Guido van Rossum98f33732002-11-25 21:36:54 +00001470 if (empty_cnt == to_merge_size) {
1471 PyMem_FREE(remain);
Guido van Rossum1f121312002-11-14 19:49:16 +00001472 return 0;
Guido van Rossum98f33732002-11-25 21:36:54 +00001473 }
1474 set_mro_error(to_merge, remain);
1475 PyMem_FREE(remain);
Guido van Rossum1f121312002-11-14 19:49:16 +00001476 return -1;
1477}
1478
Tim Peters6d6c1a32001-08-02 04:15:00 +00001479static PyObject *
1480mro_implementation(PyTypeObject *type)
1481{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001482 Py_ssize_t i, n;
1483 int ok;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001484 PyObject *bases, *result;
Guido van Rossum1f121312002-11-14 19:49:16 +00001485 PyObject *to_merge, *bases_aslist;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001486
Neal Norwitze7bb9182008-01-27 17:10:14 +00001487 if (type->tp_dict == NULL) {
1488 if (PyType_Ready(type) < 0)
Guido van Rossum63517572002-06-18 16:44:57 +00001489 return NULL;
1490 }
1491
Guido van Rossum98f33732002-11-25 21:36:54 +00001492 /* Find a superclass linearization that honors the constraints
1493 of the explicit lists of bases and the constraints implied by
Tim Petersea7f75d2002-12-07 21:39:16 +00001494 each base class.
Guido van Rossum98f33732002-11-25 21:36:54 +00001495
1496 to_merge is a list of lists, where each list is a superclass
1497 linearization implied by a base class. The last element of
1498 to_merge is the declared list of bases.
1499 */
1500
Tim Peters6d6c1a32001-08-02 04:15:00 +00001501 bases = type->tp_bases;
1502 n = PyTuple_GET_SIZE(bases);
Guido van Rossum1f121312002-11-14 19:49:16 +00001503
1504 to_merge = PyList_New(n+1);
1505 if (to_merge == NULL)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001506 return NULL;
Guido van Rossum1f121312002-11-14 19:49:16 +00001507
Tim Peters6d6c1a32001-08-02 04:15:00 +00001508 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00001509 PyObject *base = PyTuple_GET_ITEM(bases, i);
1510 PyObject *parentMRO;
1511 if (PyType_Check(base))
1512 parentMRO = PySequence_List(
1513 ((PyTypeObject*)base)->tp_mro);
1514 else
1515 parentMRO = classic_mro(base);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001516 if (parentMRO == NULL) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001517 Py_DECREF(to_merge);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001518 return NULL;
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001519 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001520
1521 PyList_SET_ITEM(to_merge, i, parentMRO);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001522 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001523
1524 bases_aslist = PySequence_List(bases);
1525 if (bases_aslist == NULL) {
1526 Py_DECREF(to_merge);
1527 return NULL;
1528 }
Guido van Rossum98f33732002-11-25 21:36:54 +00001529 /* This is just a basic sanity check. */
1530 if (check_duplicates(bases_aslist) < 0) {
1531 Py_DECREF(to_merge);
1532 Py_DECREF(bases_aslist);
1533 return NULL;
1534 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001535 PyList_SET_ITEM(to_merge, n, bases_aslist);
1536
1537 result = Py_BuildValue("[O]", (PyObject *)type);
1538 if (result == NULL) {
1539 Py_DECREF(to_merge);
1540 return NULL;
1541 }
1542
1543 ok = pmerge(result, to_merge);
1544 Py_DECREF(to_merge);
1545 if (ok < 0) {
1546 Py_DECREF(result);
1547 return NULL;
1548 }
1549
Tim Peters6d6c1a32001-08-02 04:15:00 +00001550 return result;
1551}
1552
1553static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001554mro_external(PyObject *self)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001555{
1556 PyTypeObject *type = (PyTypeObject *)self;
1557
Tim Peters6d6c1a32001-08-02 04:15:00 +00001558 return mro_implementation(type);
1559}
1560
1561static int
1562mro_internal(PyTypeObject *type)
1563{
1564 PyObject *mro, *result, *tuple;
Armin Rigo037d1e02005-12-29 17:07:39 +00001565 int checkit = 0;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001566
Christian Heimese93237d2007-12-19 02:37:44 +00001567 if (Py_TYPE(type) == &PyType_Type) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001568 result = mro_implementation(type);
1569 }
1570 else {
Guido van Rossum60718732001-08-28 17:47:51 +00001571 static PyObject *mro_str;
Armin Rigo037d1e02005-12-29 17:07:39 +00001572 checkit = 1;
Guido van Rossum60718732001-08-28 17:47:51 +00001573 mro = lookup_method((PyObject *)type, "mro", &mro_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001574 if (mro == NULL)
1575 return -1;
1576 result = PyObject_CallObject(mro, NULL);
1577 Py_DECREF(mro);
1578 }
1579 if (result == NULL)
1580 return -1;
1581 tuple = PySequence_Tuple(result);
1582 Py_DECREF(result);
Armin Rigo037d1e02005-12-29 17:07:39 +00001583 if (tuple == NULL)
1584 return -1;
1585 if (checkit) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001586 Py_ssize_t i, len;
Armin Rigo037d1e02005-12-29 17:07:39 +00001587 PyObject *cls;
1588 PyTypeObject *solid;
1589
1590 solid = solid_base(type);
1591
1592 len = PyTuple_GET_SIZE(tuple);
1593
1594 for (i = 0; i < len; i++) {
1595 PyTypeObject *t;
1596 cls = PyTuple_GET_ITEM(tuple, i);
1597 if (PyClass_Check(cls))
1598 continue;
1599 else if (!PyType_Check(cls)) {
1600 PyErr_Format(PyExc_TypeError,
1601 "mro() returned a non-class ('%.500s')",
Christian Heimese93237d2007-12-19 02:37:44 +00001602 Py_TYPE(cls)->tp_name);
Neal Norwitz50bf51a2006-01-02 02:46:54 +00001603 Py_DECREF(tuple);
Armin Rigo037d1e02005-12-29 17:07:39 +00001604 return -1;
1605 }
1606 t = (PyTypeObject*)cls;
1607 if (!PyType_IsSubtype(solid, solid_base(t))) {
1608 PyErr_Format(PyExc_TypeError,
1609 "mro() returned base with unsuitable layout ('%.500s')",
1610 t->tp_name);
Neal Norwitz50bf51a2006-01-02 02:46:54 +00001611 Py_DECREF(tuple);
Armin Rigo037d1e02005-12-29 17:07:39 +00001612 return -1;
1613 }
1614 }
1615 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001616 type->tp_mro = tuple;
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +00001617
1618 type_mro_modified(type, type->tp_mro);
1619 /* corner case: the old-style super class might have been hidden
1620 from the custom MRO */
1621 type_mro_modified(type, type->tp_bases);
1622
Georg Brandl74a1dea2008-05-28 11:21:39 +00001623 PyType_Modified(type);
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +00001624
Tim Peters6d6c1a32001-08-02 04:15:00 +00001625 return 0;
1626}
1627
1628
1629/* Calculate the best base amongst multiple base classes.
Armin Rigoc0ba52d2007-04-19 14:44:48 +00001630 This is the first one that's on the path to the "solid base". */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001631
1632static PyTypeObject *
1633best_base(PyObject *bases)
1634{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001635 Py_ssize_t i, n;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001636 PyTypeObject *base, *winner, *candidate, *base_i;
Tim Petersa91e9642001-11-14 23:32:33 +00001637 PyObject *base_proto;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001638
1639 assert(PyTuple_Check(bases));
1640 n = PyTuple_GET_SIZE(bases);
1641 assert(n > 0);
Tim Petersa91e9642001-11-14 23:32:33 +00001642 base = NULL;
1643 winner = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001644 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00001645 base_proto = PyTuple_GET_ITEM(bases, i);
1646 if (PyClass_Check(base_proto))
1647 continue;
Armin Rigoc0ba52d2007-04-19 14:44:48 +00001648 if (!PyType_Check(base_proto)) {
1649 PyErr_SetString(
1650 PyExc_TypeError,
1651 "bases must be types");
1652 return NULL;
1653 }
Tim Petersa91e9642001-11-14 23:32:33 +00001654 base_i = (PyTypeObject *)base_proto;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001655 if (base_i->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001656 if (PyType_Ready(base_i) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001657 return NULL;
1658 }
1659 candidate = solid_base(base_i);
Tim Petersa91e9642001-11-14 23:32:33 +00001660 if (winner == NULL) {
1661 winner = candidate;
1662 base = base_i;
1663 }
1664 else if (PyType_IsSubtype(winner, candidate))
Tim Peters6d6c1a32001-08-02 04:15:00 +00001665 ;
1666 else if (PyType_IsSubtype(candidate, winner)) {
1667 winner = candidate;
1668 base = base_i;
1669 }
1670 else {
1671 PyErr_SetString(
1672 PyExc_TypeError,
1673 "multiple bases have "
1674 "instance lay-out conflict");
1675 return NULL;
1676 }
1677 }
Guido van Rossume54616c2001-12-14 04:19:56 +00001678 if (base == NULL)
1679 PyErr_SetString(PyExc_TypeError,
1680 "a new-style class can't have only classic bases");
Tim Peters6d6c1a32001-08-02 04:15:00 +00001681 return base;
1682}
1683
1684static int
1685extra_ivars(PyTypeObject *type, PyTypeObject *base)
1686{
Neil Schemenauerc806c882001-08-29 23:54:54 +00001687 size_t t_size = type->tp_basicsize;
1688 size_t b_size = base->tp_basicsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001689
Guido van Rossum9676b222001-08-17 20:32:36 +00001690 assert(t_size >= b_size); /* Else type smaller than base! */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001691 if (type->tp_itemsize || base->tp_itemsize) {
1692 /* If itemsize is involved, stricter rules */
1693 return t_size != b_size ||
1694 type->tp_itemsize != base->tp_itemsize;
1695 }
Guido van Rossum9676b222001-08-17 20:32:36 +00001696 if (type->tp_weaklistoffset && base->tp_weaklistoffset == 0 &&
Armin Rigo9790a272007-05-02 19:23:31 +00001697 type->tp_weaklistoffset + sizeof(PyObject *) == t_size &&
1698 type->tp_flags & Py_TPFLAGS_HEAPTYPE)
Guido van Rossum9676b222001-08-17 20:32:36 +00001699 t_size -= sizeof(PyObject *);
1700 if (type->tp_dictoffset && base->tp_dictoffset == 0 &&
Armin Rigo9790a272007-05-02 19:23:31 +00001701 type->tp_dictoffset + sizeof(PyObject *) == t_size &&
1702 type->tp_flags & Py_TPFLAGS_HEAPTYPE)
Guido van Rossum9676b222001-08-17 20:32:36 +00001703 t_size -= sizeof(PyObject *);
1704
1705 return t_size != b_size;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001706}
1707
1708static PyTypeObject *
1709solid_base(PyTypeObject *type)
1710{
1711 PyTypeObject *base;
1712
1713 if (type->tp_base)
1714 base = solid_base(type->tp_base);
1715 else
1716 base = &PyBaseObject_Type;
1717 if (extra_ivars(type, base))
1718 return type;
1719 else
1720 return base;
1721}
1722
Jeremy Hylton938ace62002-07-17 16:30:39 +00001723static void object_dealloc(PyObject *);
1724static int object_init(PyObject *, PyObject *, PyObject *);
1725static int update_slot(PyTypeObject *, PyObject *);
1726static void fixup_slot_dispatchers(PyTypeObject *);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001727
Armin Rigo9790a272007-05-02 19:23:31 +00001728/*
1729 * Helpers for __dict__ descriptor. We don't want to expose the dicts
1730 * inherited from various builtin types. The builtin base usually provides
1731 * its own __dict__ descriptor, so we use that when we can.
1732 */
1733static PyTypeObject *
1734get_builtin_base_with_dict(PyTypeObject *type)
1735{
1736 while (type->tp_base != NULL) {
1737 if (type->tp_dictoffset != 0 &&
1738 !(type->tp_flags & Py_TPFLAGS_HEAPTYPE))
1739 return type;
1740 type = type->tp_base;
1741 }
1742 return NULL;
1743}
1744
1745static PyObject *
1746get_dict_descriptor(PyTypeObject *type)
1747{
1748 static PyObject *dict_str;
1749 PyObject *descr;
1750
1751 if (dict_str == NULL) {
Christian Heimes593daf52008-05-26 12:51:38 +00001752 dict_str = PyBytes_InternFromString("__dict__");
Armin Rigo9790a272007-05-02 19:23:31 +00001753 if (dict_str == NULL)
1754 return NULL;
1755 }
1756 descr = _PyType_Lookup(type, dict_str);
1757 if (descr == NULL || !PyDescr_IsData(descr))
1758 return NULL;
1759
1760 return descr;
1761}
1762
1763static void
1764raise_dict_descr_error(PyObject *obj)
1765{
1766 PyErr_Format(PyExc_TypeError,
1767 "this __dict__ descriptor does not support "
1768 "'%.200s' objects", obj->ob_type->tp_name);
1769}
1770
Tim Peters6d6c1a32001-08-02 04:15:00 +00001771static PyObject *
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001772subtype_dict(PyObject *obj, void *context)
1773{
Armin Rigo9790a272007-05-02 19:23:31 +00001774 PyObject **dictptr;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001775 PyObject *dict;
Armin Rigo9790a272007-05-02 19:23:31 +00001776 PyTypeObject *base;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001777
Armin Rigo9790a272007-05-02 19:23:31 +00001778 base = get_builtin_base_with_dict(obj->ob_type);
1779 if (base != NULL) {
1780 descrgetfunc func;
1781 PyObject *descr = get_dict_descriptor(base);
1782 if (descr == NULL) {
1783 raise_dict_descr_error(obj);
1784 return NULL;
1785 }
1786 func = descr->ob_type->tp_descr_get;
1787 if (func == NULL) {
1788 raise_dict_descr_error(obj);
1789 return NULL;
1790 }
1791 return func(descr, obj, (PyObject *)(obj->ob_type));
1792 }
1793
1794 dictptr = _PyObject_GetDictPtr(obj);
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001795 if (dictptr == NULL) {
1796 PyErr_SetString(PyExc_AttributeError,
1797 "This object has no __dict__");
1798 return NULL;
1799 }
1800 dict = *dictptr;
Guido van Rossum3926a632001-09-25 16:25:58 +00001801 if (dict == NULL)
1802 *dictptr = dict = PyDict_New();
1803 Py_XINCREF(dict);
1804 return dict;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001805}
1806
Guido van Rossum6661be32001-10-26 04:26:12 +00001807static int
1808subtype_setdict(PyObject *obj, PyObject *value, void *context)
1809{
Armin Rigo9790a272007-05-02 19:23:31 +00001810 PyObject **dictptr;
Guido van Rossum6661be32001-10-26 04:26:12 +00001811 PyObject *dict;
Armin Rigo9790a272007-05-02 19:23:31 +00001812 PyTypeObject *base;
Guido van Rossum6661be32001-10-26 04:26:12 +00001813
Armin Rigo9790a272007-05-02 19:23:31 +00001814 base = get_builtin_base_with_dict(obj->ob_type);
1815 if (base != NULL) {
1816 descrsetfunc func;
1817 PyObject *descr = get_dict_descriptor(base);
1818 if (descr == NULL) {
1819 raise_dict_descr_error(obj);
1820 return -1;
1821 }
1822 func = descr->ob_type->tp_descr_set;
1823 if (func == NULL) {
1824 raise_dict_descr_error(obj);
1825 return -1;
1826 }
1827 return func(descr, obj, value);
1828 }
1829
1830 dictptr = _PyObject_GetDictPtr(obj);
Guido van Rossum6661be32001-10-26 04:26:12 +00001831 if (dictptr == NULL) {
1832 PyErr_SetString(PyExc_AttributeError,
1833 "This object has no __dict__");
1834 return -1;
1835 }
Guido van Rossumd331cb52001-12-05 19:46:42 +00001836 if (value != NULL && !PyDict_Check(value)) {
Georg Brandlccff7852006-06-18 22:17:29 +00001837 PyErr_Format(PyExc_TypeError,
1838 "__dict__ must be set to a dictionary, "
Christian Heimese93237d2007-12-19 02:37:44 +00001839 "not a '%.200s'", Py_TYPE(value)->tp_name);
Guido van Rossum6661be32001-10-26 04:26:12 +00001840 return -1;
1841 }
1842 dict = *dictptr;
Guido van Rossumd331cb52001-12-05 19:46:42 +00001843 Py_XINCREF(value);
Guido van Rossum6661be32001-10-26 04:26:12 +00001844 *dictptr = value;
1845 Py_XDECREF(dict);
1846 return 0;
1847}
1848
Guido van Rossumad47da02002-08-12 19:05:44 +00001849static PyObject *
1850subtype_getweakref(PyObject *obj, void *context)
1851{
1852 PyObject **weaklistptr;
1853 PyObject *result;
1854
Christian Heimese93237d2007-12-19 02:37:44 +00001855 if (Py_TYPE(obj)->tp_weaklistoffset == 0) {
Guido van Rossumad47da02002-08-12 19:05:44 +00001856 PyErr_SetString(PyExc_AttributeError,
Fred Drake7a36f5f2006-08-04 05:17:21 +00001857 "This object has no __weakref__");
Guido van Rossumad47da02002-08-12 19:05:44 +00001858 return NULL;
1859 }
Christian Heimese93237d2007-12-19 02:37:44 +00001860 assert(Py_TYPE(obj)->tp_weaklistoffset > 0);
1861 assert(Py_TYPE(obj)->tp_weaklistoffset + sizeof(PyObject *) <=
1862 (size_t)(Py_TYPE(obj)->tp_basicsize));
Guido van Rossumad47da02002-08-12 19:05:44 +00001863 weaklistptr = (PyObject **)
Christian Heimese93237d2007-12-19 02:37:44 +00001864 ((char *)obj + Py_TYPE(obj)->tp_weaklistoffset);
Guido van Rossumad47da02002-08-12 19:05:44 +00001865 if (*weaklistptr == NULL)
1866 result = Py_None;
1867 else
1868 result = *weaklistptr;
1869 Py_INCREF(result);
1870 return result;
1871}
1872
Guido van Rossum373c7412003-01-07 13:41:37 +00001873/* Three variants on the subtype_getsets list. */
1874
1875static PyGetSetDef subtype_getsets_full[] = {
Guido van Rossumad47da02002-08-12 19:05:44 +00001876 {"__dict__", subtype_dict, subtype_setdict,
Neal Norwitz858e34f2002-08-13 17:18:45 +00001877 PyDoc_STR("dictionary for instance variables (if defined)")},
Guido van Rossumad47da02002-08-12 19:05:44 +00001878 {"__weakref__", subtype_getweakref, NULL,
Neal Norwitz858e34f2002-08-13 17:18:45 +00001879 PyDoc_STR("list of weak references to the object (if defined)")},
Guido van Rossumad47da02002-08-12 19:05:44 +00001880 {0}
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001881};
1882
Guido van Rossum373c7412003-01-07 13:41:37 +00001883static PyGetSetDef subtype_getsets_dict_only[] = {
1884 {"__dict__", subtype_dict, subtype_setdict,
1885 PyDoc_STR("dictionary for instance variables (if defined)")},
1886 {0}
1887};
1888
1889static PyGetSetDef subtype_getsets_weakref_only[] = {
1890 {"__weakref__", subtype_getweakref, NULL,
1891 PyDoc_STR("list of weak references to the object (if defined)")},
1892 {0}
1893};
1894
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001895static int
1896valid_identifier(PyObject *s)
1897{
Guido van Rossum03013a02002-07-16 14:30:28 +00001898 unsigned char *p;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001899 Py_ssize_t i, n;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001900
Christian Heimes593daf52008-05-26 12:51:38 +00001901 if (!PyBytes_Check(s)) {
Georg Brandlccff7852006-06-18 22:17:29 +00001902 PyErr_Format(PyExc_TypeError,
1903 "__slots__ items must be strings, not '%.200s'",
Christian Heimese93237d2007-12-19 02:37:44 +00001904 Py_TYPE(s)->tp_name);
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001905 return 0;
1906 }
Christian Heimes593daf52008-05-26 12:51:38 +00001907 p = (unsigned char *) PyBytes_AS_STRING(s);
1908 n = PyBytes_GET_SIZE(s);
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001909 /* We must reject an empty name. As a hack, we bump the
1910 length to 1 so that the loop will balk on the trailing \0. */
1911 if (n == 0)
1912 n = 1;
1913 for (i = 0; i < n; i++, p++) {
1914 if (!(i == 0 ? isalpha(*p) : isalnum(*p)) && *p != '_') {
1915 PyErr_SetString(PyExc_TypeError,
1916 "__slots__ must be identifiers");
1917 return 0;
1918 }
1919 }
1920 return 1;
1921}
1922
Martin v. Löwisd919a592002-10-14 21:07:28 +00001923#ifdef Py_USING_UNICODE
1924/* Replace Unicode objects in slots. */
1925
1926static PyObject *
Martin v. Löwiseb079f12006-02-16 14:32:27 +00001927_unicode_to_string(PyObject *slots, Py_ssize_t nslots)
Martin v. Löwisd919a592002-10-14 21:07:28 +00001928{
Žiga Seilnacht71436f02007-03-14 12:24:09 +00001929 PyObject *tmp = NULL;
1930 PyObject *slot_name, *new_name;
Martin v. Löwiseb079f12006-02-16 14:32:27 +00001931 Py_ssize_t i;
Žiga Seilnacht71436f02007-03-14 12:24:09 +00001932
Martin v. Löwisd919a592002-10-14 21:07:28 +00001933 for (i = 0; i < nslots; i++) {
Žiga Seilnacht71436f02007-03-14 12:24:09 +00001934 if (PyUnicode_Check(slot_name = PyTuple_GET_ITEM(slots, i))) {
1935 if (tmp == NULL) {
1936 tmp = PySequence_List(slots);
Martin v. Löwisd919a592002-10-14 21:07:28 +00001937 if (tmp == NULL)
1938 return NULL;
1939 }
Žiga Seilnacht71436f02007-03-14 12:24:09 +00001940 new_name = _PyUnicode_AsDefaultEncodedString(slot_name,
1941 NULL);
1942 if (new_name == NULL) {
Martin v. Löwisd919a592002-10-14 21:07:28 +00001943 Py_DECREF(tmp);
Žiga Seilnacht71436f02007-03-14 12:24:09 +00001944 return NULL;
Martin v. Löwisd919a592002-10-14 21:07:28 +00001945 }
Žiga Seilnacht71436f02007-03-14 12:24:09 +00001946 Py_INCREF(new_name);
1947 PyList_SET_ITEM(tmp, i, new_name);
1948 Py_DECREF(slot_name);
Martin v. Löwisd919a592002-10-14 21:07:28 +00001949 }
1950 }
Žiga Seilnacht71436f02007-03-14 12:24:09 +00001951 if (tmp != NULL) {
1952 slots = PyList_AsTuple(tmp);
1953 Py_DECREF(tmp);
1954 }
1955 return slots;
Martin v. Löwisd919a592002-10-14 21:07:28 +00001956}
1957#endif
1958
Guido van Rossumf102e242007-03-23 18:53:03 +00001959/* Forward */
1960static int
1961object_init(PyObject *self, PyObject *args, PyObject *kwds);
1962
1963static int
1964type_init(PyObject *cls, PyObject *args, PyObject *kwds)
1965{
1966 int res;
1967
1968 assert(args != NULL && PyTuple_Check(args));
1969 assert(kwds == NULL || PyDict_Check(kwds));
1970
1971 if (kwds != NULL && PyDict_Check(kwds) && PyDict_Size(kwds) != 0) {
1972 PyErr_SetString(PyExc_TypeError,
1973 "type.__init__() takes no keyword arguments");
1974 return -1;
1975 }
1976
1977 if (args != NULL && PyTuple_Check(args) &&
1978 (PyTuple_GET_SIZE(args) != 1 && PyTuple_GET_SIZE(args) != 3)) {
1979 PyErr_SetString(PyExc_TypeError,
1980 "type.__init__() takes 1 or 3 arguments");
1981 return -1;
1982 }
1983
1984 /* Call object.__init__(self) now. */
1985 /* XXX Could call super(type, cls).__init__() but what's the point? */
1986 args = PyTuple_GetSlice(args, 0, 0);
1987 res = object_init(cls, args, NULL);
1988 Py_DECREF(args);
1989 return res;
1990}
1991
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001992static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001993type_new(PyTypeObject *metatype, PyObject *args, PyObject *kwds)
1994{
1995 PyObject *name, *bases, *dict;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001996 static char *kwlist[] = {"name", "bases", "dict", 0};
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001997 PyObject *slots, *tmp, *newslots;
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001998 PyTypeObject *type, *base, *tmptype, *winner;
Guido van Rossume5c691a2003-03-07 15:13:17 +00001999 PyHeapTypeObject *et;
Guido van Rossum6f799372001-09-20 20:46:19 +00002000 PyMemberDef *mp;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002001 Py_ssize_t i, nbases, nslots, slotoffset, add_dict, add_weak;
Guido van Rossumad47da02002-08-12 19:05:44 +00002002 int j, may_add_dict, may_add_weak;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002003
Tim Peters3abca122001-10-27 19:37:48 +00002004 assert(args != NULL && PyTuple_Check(args));
2005 assert(kwds == NULL || PyDict_Check(kwds));
2006
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00002007 /* Special case: type(x) should return x->ob_type */
Tim Peters3abca122001-10-27 19:37:48 +00002008 {
Martin v. Löwis18e16552006-02-15 17:27:45 +00002009 const Py_ssize_t nargs = PyTuple_GET_SIZE(args);
2010 const Py_ssize_t nkwds = kwds == NULL ? 0 : PyDict_Size(kwds);
Tim Peters3abca122001-10-27 19:37:48 +00002011
2012 if (PyType_CheckExact(metatype) && nargs == 1 && nkwds == 0) {
2013 PyObject *x = PyTuple_GET_ITEM(args, 0);
Christian Heimese93237d2007-12-19 02:37:44 +00002014 Py_INCREF(Py_TYPE(x));
2015 return (PyObject *) Py_TYPE(x);
Tim Peters3abca122001-10-27 19:37:48 +00002016 }
2017
2018 /* SF bug 475327 -- if that didn't trigger, we need 3
2019 arguments. but PyArg_ParseTupleAndKeywords below may give
2020 a msg saying type() needs exactly 3. */
2021 if (nargs + nkwds != 3) {
2022 PyErr_SetString(PyExc_TypeError,
2023 "type() takes 1 or 3 arguments");
2024 return NULL;
2025 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002026 }
2027
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00002028 /* Check arguments: (name, bases, dict) */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002029 if (!PyArg_ParseTupleAndKeywords(args, kwds, "SO!O!:type", kwlist,
2030 &name,
2031 &PyTuple_Type, &bases,
2032 &PyDict_Type, &dict))
2033 return NULL;
2034
Armin Rigoc0ba52d2007-04-19 14:44:48 +00002035 /* Determine the proper metatype to deal with this,
2036 and check for metatype conflicts while we're at it.
2037 Note that if some other metatype wins to contract,
2038 it's possible that its instances are not types. */
2039 nbases = PyTuple_GET_SIZE(bases);
2040 winner = metatype;
2041 for (i = 0; i < nbases; i++) {
2042 tmp = PyTuple_GET_ITEM(bases, i);
2043 tmptype = tmp->ob_type;
2044 if (tmptype == &PyClass_Type)
2045 continue; /* Special case classic classes */
2046 if (PyType_IsSubtype(winner, tmptype))
2047 continue;
2048 if (PyType_IsSubtype(tmptype, winner)) {
2049 winner = tmptype;
2050 continue;
Jeremy Hyltonfa955692007-02-27 18:29:45 +00002051 }
Armin Rigoc0ba52d2007-04-19 14:44:48 +00002052 PyErr_SetString(PyExc_TypeError,
2053 "metaclass conflict: "
2054 "the metaclass of a derived class "
2055 "must be a (non-strict) subclass "
2056 "of the metaclasses of all its bases");
2057 return NULL;
2058 }
2059 if (winner != metatype) {
2060 if (winner->tp_new != type_new) /* Pass it to the winner */
2061 return winner->tp_new(winner, args, kwds);
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00002062 metatype = winner;
2063 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002064
2065 /* Adjust for empty tuple bases */
2066 if (nbases == 0) {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002067 bases = PyTuple_Pack(1, &PyBaseObject_Type);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002068 if (bases == NULL)
2069 return NULL;
2070 nbases = 1;
2071 }
2072 else
2073 Py_INCREF(bases);
2074
2075 /* XXX From here until type is allocated, "return NULL" leaks bases! */
2076
2077 /* Calculate best base, and check that all bases are type objects */
2078 base = best_base(bases);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00002079 if (base == NULL) {
2080 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002081 return NULL;
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00002082 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002083 if (!PyType_HasFeature(base, Py_TPFLAGS_BASETYPE)) {
2084 PyErr_Format(PyExc_TypeError,
2085 "type '%.100s' is not an acceptable base type",
2086 base->tp_name);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00002087 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002088 return NULL;
2089 }
2090
Tim Peters6d6c1a32001-08-02 04:15:00 +00002091 /* Check for a __slots__ sequence variable in dict, and count it */
2092 slots = PyDict_GetItemString(dict, "__slots__");
2093 nslots = 0;
Guido van Rossum9676b222001-08-17 20:32:36 +00002094 add_dict = 0;
2095 add_weak = 0;
Guido van Rossumad47da02002-08-12 19:05:44 +00002096 may_add_dict = base->tp_dictoffset == 0;
2097 may_add_weak = base->tp_weaklistoffset == 0 && base->tp_itemsize == 0;
2098 if (slots == NULL) {
2099 if (may_add_dict) {
2100 add_dict++;
2101 }
2102 if (may_add_weak) {
2103 add_weak++;
2104 }
2105 }
2106 else {
2107 /* Have slots */
2108
Tim Peters6d6c1a32001-08-02 04:15:00 +00002109 /* Make it into a tuple */
Christian Heimes593daf52008-05-26 12:51:38 +00002110 if (PyBytes_Check(slots) || PyUnicode_Check(slots))
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002111 slots = PyTuple_Pack(1, slots);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002112 else
2113 slots = PySequence_Tuple(slots);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00002114 if (slots == NULL) {
2115 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002116 return NULL;
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00002117 }
Guido van Rossumad47da02002-08-12 19:05:44 +00002118 assert(PyTuple_Check(slots));
2119
2120 /* Are slots allowed? */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002121 nslots = PyTuple_GET_SIZE(slots);
Jeremy Hylton1c7a0ea2003-07-16 16:08:23 +00002122 if (nslots > 0 && base->tp_itemsize != 0) {
Guido van Rossumc4141872001-08-30 04:43:35 +00002123 PyErr_Format(PyExc_TypeError,
2124 "nonempty __slots__ "
2125 "not supported for subtype of '%s'",
2126 base->tp_name);
Guido van Rossumad47da02002-08-12 19:05:44 +00002127 bad_slots:
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00002128 Py_DECREF(bases);
Guido van Rossumad47da02002-08-12 19:05:44 +00002129 Py_DECREF(slots);
Guido van Rossumc4141872001-08-30 04:43:35 +00002130 return NULL;
2131 }
Guido van Rossumad47da02002-08-12 19:05:44 +00002132
Martin v. Löwisd919a592002-10-14 21:07:28 +00002133#ifdef Py_USING_UNICODE
2134 tmp = _unicode_to_string(slots, nslots);
Žiga Seilnacht71436f02007-03-14 12:24:09 +00002135 if (tmp == NULL)
2136 goto bad_slots;
Martin v. Löwis13b1a5c2002-10-14 21:11:34 +00002137 if (tmp != slots) {
2138 Py_DECREF(slots);
2139 slots = tmp;
2140 }
Martin v. Löwisd919a592002-10-14 21:07:28 +00002141#endif
Guido van Rossumad47da02002-08-12 19:05:44 +00002142 /* Check for valid slot names and two special cases */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002143 for (i = 0; i < nslots; i++) {
Guido van Rossumad47da02002-08-12 19:05:44 +00002144 PyObject *tmp = PyTuple_GET_ITEM(slots, i);
2145 char *s;
2146 if (!valid_identifier(tmp))
2147 goto bad_slots;
Christian Heimes593daf52008-05-26 12:51:38 +00002148 assert(PyBytes_Check(tmp));
2149 s = PyBytes_AS_STRING(tmp);
Guido van Rossumad47da02002-08-12 19:05:44 +00002150 if (strcmp(s, "__dict__") == 0) {
2151 if (!may_add_dict || add_dict) {
2152 PyErr_SetString(PyExc_TypeError,
2153 "__dict__ slot disallowed: "
2154 "we already got one");
2155 goto bad_slots;
2156 }
2157 add_dict++;
2158 }
2159 if (strcmp(s, "__weakref__") == 0) {
2160 if (!may_add_weak || add_weak) {
2161 PyErr_SetString(PyExc_TypeError,
2162 "__weakref__ slot disallowed: "
2163 "either we already got one, "
2164 "or __itemsize__ != 0");
2165 goto bad_slots;
2166 }
2167 add_weak++;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002168 }
2169 }
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00002170
Žiga Seilnacht6f2d09c2007-03-16 11:59:38 +00002171 /* Copy slots into a list, mangle names and sort them.
2172 Sorted names are needed for __class__ assignment.
2173 Convert them back to tuple at the end.
2174 */
2175 newslots = PyList_New(nslots - add_dict - add_weak);
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00002176 if (newslots == NULL)
Guido van Rossumad47da02002-08-12 19:05:44 +00002177 goto bad_slots;
2178 for (i = j = 0; i < nslots; i++) {
2179 char *s;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00002180 tmp = PyTuple_GET_ITEM(slots, i);
Christian Heimes593daf52008-05-26 12:51:38 +00002181 s = PyBytes_AS_STRING(tmp);
Guido van Rossumad47da02002-08-12 19:05:44 +00002182 if ((add_dict && strcmp(s, "__dict__") == 0) ||
2183 (add_weak && strcmp(s, "__weakref__") == 0))
2184 continue;
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00002185 tmp =_Py_Mangle(name, tmp);
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002186 if (!tmp)
2187 goto bad_slots;
Žiga Seilnacht6f2d09c2007-03-16 11:59:38 +00002188 PyList_SET_ITEM(newslots, j, tmp);
Guido van Rossumad47da02002-08-12 19:05:44 +00002189 j++;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00002190 }
Guido van Rossumad47da02002-08-12 19:05:44 +00002191 assert(j == nslots - add_dict - add_weak);
2192 nslots = j;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00002193 Py_DECREF(slots);
Žiga Seilnacht6f2d09c2007-03-16 11:59:38 +00002194 if (PyList_Sort(newslots) == -1) {
2195 Py_DECREF(bases);
2196 Py_DECREF(newslots);
2197 return NULL;
2198 }
2199 slots = PyList_AsTuple(newslots);
2200 Py_DECREF(newslots);
2201 if (slots == NULL) {
2202 Py_DECREF(bases);
2203 return NULL;
2204 }
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00002205
Guido van Rossumad47da02002-08-12 19:05:44 +00002206 /* Secondary bases may provide weakrefs or dict */
2207 if (nbases > 1 &&
2208 ((may_add_dict && !add_dict) ||
2209 (may_add_weak && !add_weak))) {
2210 for (i = 0; i < nbases; i++) {
2211 tmp = PyTuple_GET_ITEM(bases, i);
2212 if (tmp == (PyObject *)base)
2213 continue; /* Skip primary base */
2214 if (PyClass_Check(tmp)) {
2215 /* Classic base class provides both */
2216 if (may_add_dict && !add_dict)
2217 add_dict++;
2218 if (may_add_weak && !add_weak)
2219 add_weak++;
2220 break;
2221 }
2222 assert(PyType_Check(tmp));
2223 tmptype = (PyTypeObject *)tmp;
2224 if (may_add_dict && !add_dict &&
2225 tmptype->tp_dictoffset != 0)
2226 add_dict++;
2227 if (may_add_weak && !add_weak &&
2228 tmptype->tp_weaklistoffset != 0)
2229 add_weak++;
2230 if (may_add_dict && !add_dict)
2231 continue;
2232 if (may_add_weak && !add_weak)
2233 continue;
2234 /* Nothing more to check */
2235 break;
2236 }
2237 }
Guido van Rossum9676b222001-08-17 20:32:36 +00002238 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002239
2240 /* XXX From here until type is safely allocated,
2241 "return NULL" may leak slots! */
2242
2243 /* Allocate the type object */
2244 type = (PyTypeObject *)metatype->tp_alloc(metatype, nslots);
Guido van Rossumad47da02002-08-12 19:05:44 +00002245 if (type == NULL) {
2246 Py_XDECREF(slots);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00002247 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002248 return NULL;
Guido van Rossumad47da02002-08-12 19:05:44 +00002249 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002250
2251 /* Keep name and slots alive in the extended type object */
Guido van Rossume5c691a2003-03-07 15:13:17 +00002252 et = (PyHeapTypeObject *)type;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002253 Py_INCREF(name);
Georg Brandlc255c7b2006-02-20 22:27:28 +00002254 et->ht_name = name;
2255 et->ht_slots = slots;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002256
Guido van Rossumdc91b992001-08-08 22:26:22 +00002257 /* Initialize tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002258 type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HEAPTYPE |
2259 Py_TPFLAGS_BASETYPE;
Guido van Rossum048eb752001-10-02 21:24:57 +00002260 if (base->tp_flags & Py_TPFLAGS_HAVE_GC)
2261 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
Guido van Rossumdc91b992001-08-08 22:26:22 +00002262
2263 /* It's a new-style number unless it specifically inherits any
2264 old-style numeric behavior */
2265 if ((base->tp_flags & Py_TPFLAGS_CHECKTYPES) ||
2266 (base->tp_as_number == NULL))
2267 type->tp_flags |= Py_TPFLAGS_CHECKTYPES;
2268
2269 /* Initialize essential fields */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002270 type->tp_as_number = &et->as_number;
2271 type->tp_as_sequence = &et->as_sequence;
2272 type->tp_as_mapping = &et->as_mapping;
2273 type->tp_as_buffer = &et->as_buffer;
Christian Heimes593daf52008-05-26 12:51:38 +00002274 type->tp_name = PyBytes_AS_STRING(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002275
2276 /* Set tp_base and tp_bases */
2277 type->tp_bases = bases;
2278 Py_INCREF(base);
2279 type->tp_base = base;
2280
Guido van Rossum687ae002001-10-15 22:03:32 +00002281 /* Initialize tp_dict from passed-in dict */
2282 type->tp_dict = dict = PyDict_Copy(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002283 if (dict == NULL) {
2284 Py_DECREF(type);
2285 return NULL;
2286 }
2287
Guido van Rossumc3542212001-08-16 09:18:56 +00002288 /* Set __module__ in the dict */
2289 if (PyDict_GetItemString(dict, "__module__") == NULL) {
2290 tmp = PyEval_GetGlobals();
2291 if (tmp != NULL) {
2292 tmp = PyDict_GetItemString(tmp, "__name__");
2293 if (tmp != NULL) {
2294 if (PyDict_SetItemString(dict, "__module__",
2295 tmp) < 0)
2296 return NULL;
2297 }
2298 }
2299 }
2300
Tim Peters2f93e282001-10-04 05:27:00 +00002301 /* Set tp_doc to a copy of dict['__doc__'], if the latter is there
Tim Peters24008312002-03-17 18:56:20 +00002302 and is a string. The __doc__ accessor will first look for tp_doc;
2303 if that fails, it will still look into __dict__.
Tim Peters2f93e282001-10-04 05:27:00 +00002304 */
2305 {
2306 PyObject *doc = PyDict_GetItemString(dict, "__doc__");
Christian Heimes593daf52008-05-26 12:51:38 +00002307 if (doc != NULL && PyBytes_Check(doc)) {
2308 const size_t n = (size_t)PyBytes_GET_SIZE(doc);
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002309 char *tp_doc = (char *)PyObject_MALLOC(n+1);
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002310 if (tp_doc == NULL) {
Tim Peters2f93e282001-10-04 05:27:00 +00002311 Py_DECREF(type);
2312 return NULL;
2313 }
Christian Heimes593daf52008-05-26 12:51:38 +00002314 memcpy(tp_doc, PyBytes_AS_STRING(doc), n+1);
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002315 type->tp_doc = tp_doc;
Tim Peters2f93e282001-10-04 05:27:00 +00002316 }
2317 }
2318
Tim Peters6d6c1a32001-08-02 04:15:00 +00002319 /* Special-case __new__: if it's a plain function,
2320 make it a static function */
2321 tmp = PyDict_GetItemString(dict, "__new__");
2322 if (tmp != NULL && PyFunction_Check(tmp)) {
2323 tmp = PyStaticMethod_New(tmp);
2324 if (tmp == NULL) {
2325 Py_DECREF(type);
2326 return NULL;
2327 }
2328 PyDict_SetItemString(dict, "__new__", tmp);
2329 Py_DECREF(tmp);
2330 }
2331
2332 /* Add descriptors for custom slots from __slots__, or for __dict__ */
Guido van Rossume5c691a2003-03-07 15:13:17 +00002333 mp = PyHeapType_GET_MEMBERS(et);
Neil Schemenauerc806c882001-08-29 23:54:54 +00002334 slotoffset = base->tp_basicsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002335 if (slots != NULL) {
2336 for (i = 0; i < nslots; i++, mp++) {
Christian Heimes593daf52008-05-26 12:51:38 +00002337 mp->name = PyBytes_AS_STRING(
Tim Peters6d6c1a32001-08-02 04:15:00 +00002338 PyTuple_GET_ITEM(slots, i));
Guido van Rossum64b206c2001-12-04 17:13:22 +00002339 mp->type = T_OBJECT_EX;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002340 mp->offset = slotoffset;
Žiga Seilnacht89032082007-03-11 15:54:54 +00002341
2342 /* __dict__ and __weakref__ are already filtered out */
2343 assert(strcmp(mp->name, "__dict__") != 0);
2344 assert(strcmp(mp->name, "__weakref__") != 0);
2345
Tim Peters6d6c1a32001-08-02 04:15:00 +00002346 slotoffset += sizeof(PyObject *);
2347 }
2348 }
Guido van Rossumad47da02002-08-12 19:05:44 +00002349 if (add_dict) {
2350 if (base->tp_itemsize)
2351 type->tp_dictoffset = -(long)sizeof(PyObject *);
2352 else
2353 type->tp_dictoffset = slotoffset;
2354 slotoffset += sizeof(PyObject *);
2355 }
2356 if (add_weak) {
2357 assert(!base->tp_itemsize);
2358 type->tp_weaklistoffset = slotoffset;
2359 slotoffset += sizeof(PyObject *);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002360 }
2361 type->tp_basicsize = slotoffset;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00002362 type->tp_itemsize = base->tp_itemsize;
Guido van Rossume5c691a2003-03-07 15:13:17 +00002363 type->tp_members = PyHeapType_GET_MEMBERS(et);
Guido van Rossum373c7412003-01-07 13:41:37 +00002364
2365 if (type->tp_weaklistoffset && type->tp_dictoffset)
2366 type->tp_getset = subtype_getsets_full;
2367 else if (type->tp_weaklistoffset && !type->tp_dictoffset)
2368 type->tp_getset = subtype_getsets_weakref_only;
2369 else if (!type->tp_weaklistoffset && type->tp_dictoffset)
2370 type->tp_getset = subtype_getsets_dict_only;
2371 else
2372 type->tp_getset = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002373
2374 /* Special case some slots */
2375 if (type->tp_dictoffset != 0 || nslots > 0) {
2376 if (base->tp_getattr == NULL && base->tp_getattro == NULL)
2377 type->tp_getattro = PyObject_GenericGetAttr;
2378 if (base->tp_setattr == NULL && base->tp_setattro == NULL)
2379 type->tp_setattro = PyObject_GenericSetAttr;
2380 }
2381 type->tp_dealloc = subtype_dealloc;
2382
Guido van Rossum9475a232001-10-05 20:51:39 +00002383 /* Enable GC unless there are really no instance variables possible */
2384 if (!(type->tp_basicsize == sizeof(PyObject) &&
2385 type->tp_itemsize == 0))
2386 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
2387
Tim Peters6d6c1a32001-08-02 04:15:00 +00002388 /* Always override allocation strategy to use regular heap */
2389 type->tp_alloc = PyType_GenericAlloc;
Guido van Rossum048eb752001-10-02 21:24:57 +00002390 if (type->tp_flags & Py_TPFLAGS_HAVE_GC) {
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00002391 type->tp_free = PyObject_GC_Del;
Guido van Rossum9475a232001-10-05 20:51:39 +00002392 type->tp_traverse = subtype_traverse;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00002393 type->tp_clear = subtype_clear;
Guido van Rossum048eb752001-10-02 21:24:57 +00002394 }
2395 else
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00002396 type->tp_free = PyObject_Del;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002397
2398 /* Initialize the rest */
Guido van Rossum528b7eb2001-08-07 17:24:28 +00002399 if (PyType_Ready(type) < 0) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00002400 Py_DECREF(type);
2401 return NULL;
2402 }
2403
Guido van Rossum7b9144b2001-10-09 19:39:46 +00002404 /* Put the proper slots in place */
2405 fixup_slot_dispatchers(type);
Guido van Rossumf040ede2001-08-07 16:40:56 +00002406
Tim Peters6d6c1a32001-08-02 04:15:00 +00002407 return (PyObject *)type;
2408}
2409
2410/* Internal API to look for a name through the MRO.
2411 This returns a borrowed reference, and doesn't set an exception! */
2412PyObject *
2413_PyType_Lookup(PyTypeObject *type, PyObject *name)
2414{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002415 Py_ssize_t i, n;
Georg Brandlf18a7072008-05-29 14:35:39 +00002416 PyObject *mro, *res, *base, *dict;
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +00002417 unsigned int h;
2418
2419 if (MCACHE_CACHEABLE_NAME(name) &&
Neal Norwitze7bb9182008-01-27 17:10:14 +00002420 PyType_HasFeature(type, Py_TPFLAGS_VALID_VERSION_TAG)) {
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +00002421 /* fast path */
2422 h = MCACHE_HASH_METHOD(type, name);
2423 if (method_cache[h].version == type->tp_version_tag &&
2424 method_cache[h].name == name)
2425 return method_cache[h].value;
2426 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002427
Guido van Rossum687ae002001-10-15 22:03:32 +00002428 /* Look in tp_dict of types in MRO */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002429 mro = type->tp_mro;
Guido van Rossum23094982002-06-10 14:30:43 +00002430
2431 /* If mro is NULL, the type is either not yet initialized
2432 by PyType_Ready(), or already cleared by type_clear().
2433 Either way the safest thing to do is to return NULL. */
2434 if (mro == NULL)
2435 return NULL;
2436
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +00002437 res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002438 assert(PyTuple_Check(mro));
2439 n = PyTuple_GET_SIZE(mro);
2440 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00002441 base = PyTuple_GET_ITEM(mro, i);
2442 if (PyClass_Check(base))
2443 dict = ((PyClassObject *)base)->cl_dict;
2444 else {
2445 assert(PyType_Check(base));
2446 dict = ((PyTypeObject *)base)->tp_dict;
2447 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002448 assert(dict && PyDict_Check(dict));
2449 res = PyDict_GetItem(dict, name);
2450 if (res != NULL)
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +00002451 break;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002452 }
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +00002453
2454 if (MCACHE_CACHEABLE_NAME(name) && assign_version_tag(type)) {
2455 h = MCACHE_HASH_METHOD(type, name);
2456 method_cache[h].version = type->tp_version_tag;
2457 method_cache[h].value = res; /* borrowed */
2458 Py_INCREF(name);
Georg Brandlf18a7072008-05-29 14:35:39 +00002459 Py_DECREF(method_cache[h].name);
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +00002460 method_cache[h].name = name;
2461 }
2462 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002463}
2464
2465/* This is similar to PyObject_GenericGetAttr(),
2466 but uses _PyType_Lookup() instead of just looking in type->tp_dict. */
2467static PyObject *
2468type_getattro(PyTypeObject *type, PyObject *name)
2469{
Christian Heimese93237d2007-12-19 02:37:44 +00002470 PyTypeObject *metatype = Py_TYPE(type);
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002471 PyObject *meta_attribute, *attribute;
2472 descrgetfunc meta_get;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002473
2474 /* Initialize this type (we'll assume the metatype is initialized) */
2475 if (type->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00002476 if (PyType_Ready(type) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002477 return NULL;
2478 }
2479
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002480 /* No readable descriptor found yet */
2481 meta_get = NULL;
Tim Peters34592512002-07-11 06:23:50 +00002482
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002483 /* Look for the attribute in the metatype */
2484 meta_attribute = _PyType_Lookup(metatype, name);
2485
2486 if (meta_attribute != NULL) {
Christian Heimese93237d2007-12-19 02:37:44 +00002487 meta_get = Py_TYPE(meta_attribute)->tp_descr_get;
Tim Peters34592512002-07-11 06:23:50 +00002488
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002489 if (meta_get != NULL && PyDescr_IsData(meta_attribute)) {
2490 /* Data descriptors implement tp_descr_set to intercept
2491 * writes. Assume the attribute is not overridden in
2492 * type's tp_dict (and bases): call the descriptor now.
2493 */
2494 return meta_get(meta_attribute, (PyObject *)type,
2495 (PyObject *)metatype);
2496 }
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002497 Py_INCREF(meta_attribute);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002498 }
2499
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002500 /* No data descriptor found on metatype. Look in tp_dict of this
2501 * type and its bases */
2502 attribute = _PyType_Lookup(type, name);
2503 if (attribute != NULL) {
2504 /* Implement descriptor functionality, if any */
Christian Heimese93237d2007-12-19 02:37:44 +00002505 descrgetfunc local_get = Py_TYPE(attribute)->tp_descr_get;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002506
2507 Py_XDECREF(meta_attribute);
2508
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002509 if (local_get != NULL) {
2510 /* NULL 2nd argument indicates the descriptor was
2511 * found on the target object itself (or a base) */
2512 return local_get(attribute, (PyObject *)NULL,
2513 (PyObject *)type);
2514 }
Tim Peters34592512002-07-11 06:23:50 +00002515
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002516 Py_INCREF(attribute);
2517 return attribute;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002518 }
2519
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002520 /* No attribute found in local __dict__ (or bases): use the
2521 * descriptor from the metatype, if any */
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002522 if (meta_get != NULL) {
2523 PyObject *res;
2524 res = meta_get(meta_attribute, (PyObject *)type,
2525 (PyObject *)metatype);
2526 Py_DECREF(meta_attribute);
2527 return res;
2528 }
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002529
2530 /* If an ordinary attribute was found on the metatype, return it now */
2531 if (meta_attribute != NULL) {
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002532 return meta_attribute;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002533 }
2534
2535 /* Give up */
2536 PyErr_Format(PyExc_AttributeError,
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002537 "type object '%.50s' has no attribute '%.400s'",
Christian Heimes593daf52008-05-26 12:51:38 +00002538 type->tp_name, PyBytes_AS_STRING(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +00002539 return NULL;
2540}
2541
2542static int
2543type_setattro(PyTypeObject *type, PyObject *name, PyObject *value)
2544{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00002545 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
2546 PyErr_Format(
2547 PyExc_TypeError,
2548 "can't set attributes of built-in/extension type '%s'",
2549 type->tp_name);
2550 return -1;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00002551 }
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00002552 if (PyObject_GenericSetAttr((PyObject *)type, name, value) < 0)
2553 return -1;
2554 return update_slot(type, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002555}
2556
2557static void
2558type_dealloc(PyTypeObject *type)
2559{
Guido van Rossume5c691a2003-03-07 15:13:17 +00002560 PyHeapTypeObject *et;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002561
2562 /* Assert this is a heap-allocated type object */
2563 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002564 _PyObject_GC_UNTRACK(type);
Guido van Rossum1c450732001-10-08 15:18:27 +00002565 PyObject_ClearWeakRefs((PyObject *)type);
Guido van Rossume5c691a2003-03-07 15:13:17 +00002566 et = (PyHeapTypeObject *)type;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002567 Py_XDECREF(type->tp_base);
2568 Py_XDECREF(type->tp_dict);
2569 Py_XDECREF(type->tp_bases);
2570 Py_XDECREF(type->tp_mro);
Guido van Rossum687ae002001-10-15 22:03:32 +00002571 Py_XDECREF(type->tp_cache);
Guido van Rossum1c450732001-10-08 15:18:27 +00002572 Py_XDECREF(type->tp_subclasses);
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002573 /* A type's tp_doc is heap allocated, unlike the tp_doc slots
2574 * of most other objects. It's okay to cast it to char *.
2575 */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002576 PyObject_Free((char *)type->tp_doc);
Georg Brandlc255c7b2006-02-20 22:27:28 +00002577 Py_XDECREF(et->ht_name);
2578 Py_XDECREF(et->ht_slots);
Christian Heimese93237d2007-12-19 02:37:44 +00002579 Py_TYPE(type)->tp_free((PyObject *)type);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002580}
2581
Guido van Rossum1c450732001-10-08 15:18:27 +00002582static PyObject *
2583type_subclasses(PyTypeObject *type, PyObject *args_ignored)
2584{
2585 PyObject *list, *raw, *ref;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002586 Py_ssize_t i, n;
Guido van Rossum1c450732001-10-08 15:18:27 +00002587
2588 list = PyList_New(0);
2589 if (list == NULL)
2590 return NULL;
2591 raw = type->tp_subclasses;
2592 if (raw == NULL)
2593 return list;
2594 assert(PyList_Check(raw));
2595 n = PyList_GET_SIZE(raw);
2596 for (i = 0; i < n; i++) {
2597 ref = PyList_GET_ITEM(raw, i);
Tim Peters44383382001-10-08 16:49:26 +00002598 assert(PyWeakref_CheckRef(ref));
Guido van Rossum1c450732001-10-08 15:18:27 +00002599 ref = PyWeakref_GET_OBJECT(ref);
2600 if (ref != Py_None) {
2601 if (PyList_Append(list, ref) < 0) {
2602 Py_DECREF(list);
2603 return NULL;
2604 }
2605 }
2606 }
2607 return list;
2608}
2609
Tim Peters6d6c1a32001-08-02 04:15:00 +00002610static PyMethodDef type_methods[] = {
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002611 {"mro", (PyCFunction)mro_external, METH_NOARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002612 PyDoc_STR("mro() -> list\nreturn a type's method resolution order")},
Guido van Rossum1c450732001-10-08 15:18:27 +00002613 {"__subclasses__", (PyCFunction)type_subclasses, METH_NOARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002614 PyDoc_STR("__subclasses__() -> list of immediate subclasses")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00002615 {0}
2616};
2617
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002618PyDoc_STRVAR(type_doc,
Tim Peters6d6c1a32001-08-02 04:15:00 +00002619"type(object) -> the object's type\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002620"type(name, bases, dict) -> a new type");
Tim Peters6d6c1a32001-08-02 04:15:00 +00002621
Guido van Rossum048eb752001-10-02 21:24:57 +00002622static int
2623type_traverse(PyTypeObject *type, visitproc visit, void *arg)
2624{
Guido van Rossuma3862092002-06-10 15:24:42 +00002625 /* Because of type_is_gc(), the collector only calls this
2626 for heaptypes. */
2627 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002628
Thomas Woutersc6e55062006-04-15 21:47:09 +00002629 Py_VISIT(type->tp_dict);
2630 Py_VISIT(type->tp_cache);
2631 Py_VISIT(type->tp_mro);
2632 Py_VISIT(type->tp_bases);
2633 Py_VISIT(type->tp_base);
Guido van Rossuma3862092002-06-10 15:24:42 +00002634
2635 /* There's no need to visit type->tp_subclasses or
Georg Brandlc255c7b2006-02-20 22:27:28 +00002636 ((PyHeapTypeObject *)type)->ht_slots, because they can't be involved
Guido van Rossuma3862092002-06-10 15:24:42 +00002637 in cycles; tp_subclasses is a list of weak references,
2638 and slots is a tuple of strings. */
Guido van Rossum048eb752001-10-02 21:24:57 +00002639
Guido van Rossum048eb752001-10-02 21:24:57 +00002640 return 0;
2641}
2642
2643static int
2644type_clear(PyTypeObject *type)
2645{
Guido van Rossuma3862092002-06-10 15:24:42 +00002646 /* Because of type_is_gc(), the collector only calls this
2647 for heaptypes. */
2648 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002649
Guido van Rossuma3862092002-06-10 15:24:42 +00002650 /* The only field we need to clear is tp_mro, which is part of a
2651 hard cycle (its first element is the class itself) that won't
2652 be broken otherwise (it's a tuple and tuples don't have a
2653 tp_clear handler). None of the other fields need to be
2654 cleared, and here's why:
Guido van Rossum048eb752001-10-02 21:24:57 +00002655
Guido van Rossuma3862092002-06-10 15:24:42 +00002656 tp_dict:
2657 It is a dict, so the collector will call its tp_clear.
2658
2659 tp_cache:
2660 Not used; if it were, it would be a dict.
2661
2662 tp_bases, tp_base:
2663 If these are involved in a cycle, there must be at least
2664 one other, mutable object in the cycle, e.g. a base
2665 class's dict; the cycle will be broken that way.
2666
2667 tp_subclasses:
2668 A list of weak references can't be part of a cycle; and
2669 lists have their own tp_clear.
2670
Guido van Rossume5c691a2003-03-07 15:13:17 +00002671 slots (in PyHeapTypeObject):
Guido van Rossuma3862092002-06-10 15:24:42 +00002672 A tuple of strings can't be part of a cycle.
2673 */
2674
Thomas Woutersedf17d82006-04-15 17:28:34 +00002675 Py_CLEAR(type->tp_mro);
Guido van Rossum048eb752001-10-02 21:24:57 +00002676
2677 return 0;
2678}
2679
2680static int
2681type_is_gc(PyTypeObject *type)
2682{
2683 return type->tp_flags & Py_TPFLAGS_HEAPTYPE;
2684}
2685
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002686PyTypeObject PyType_Type = {
Martin v. Löwis68192102007-07-21 06:55:02 +00002687 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002688 "type", /* tp_name */
Guido van Rossume5c691a2003-03-07 15:13:17 +00002689 sizeof(PyHeapTypeObject), /* tp_basicsize */
Guido van Rossum6f799372001-09-20 20:46:19 +00002690 sizeof(PyMemberDef), /* tp_itemsize */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002691 (destructor)type_dealloc, /* tp_dealloc */
2692 0, /* tp_print */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002693 0, /* tp_getattr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002694 0, /* tp_setattr */
2695 type_compare, /* tp_compare */
2696 (reprfunc)type_repr, /* tp_repr */
2697 0, /* tp_as_number */
2698 0, /* tp_as_sequence */
2699 0, /* tp_as_mapping */
2700 (hashfunc)_Py_HashPointer, /* tp_hash */
2701 (ternaryfunc)type_call, /* tp_call */
2702 0, /* tp_str */
2703 (getattrofunc)type_getattro, /* tp_getattro */
2704 (setattrofunc)type_setattro, /* tp_setattro */
2705 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00002706 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
Neal Norwitzee3a1b52007-02-25 19:44:48 +00002707 Py_TPFLAGS_BASETYPE | Py_TPFLAGS_TYPE_SUBCLASS, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002708 type_doc, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +00002709 (traverseproc)type_traverse, /* tp_traverse */
2710 (inquiry)type_clear, /* tp_clear */
Steven Bethardae42f332008-03-18 17:26:10 +00002711 type_richcompare, /* tp_richcompare */
Guido van Rossum1c450732001-10-08 15:18:27 +00002712 offsetof(PyTypeObject, tp_weaklist), /* tp_weaklistoffset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002713 0, /* tp_iter */
2714 0, /* tp_iternext */
2715 type_methods, /* tp_methods */
2716 type_members, /* tp_members */
2717 type_getsets, /* tp_getset */
2718 0, /* tp_base */
2719 0, /* tp_dict */
2720 0, /* tp_descr_get */
2721 0, /* tp_descr_set */
2722 offsetof(PyTypeObject, tp_dict), /* tp_dictoffset */
Guido van Rossumf102e242007-03-23 18:53:03 +00002723 type_init, /* tp_init */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002724 0, /* tp_alloc */
2725 type_new, /* tp_new */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002726 PyObject_GC_Del, /* tp_free */
Guido van Rossum048eb752001-10-02 21:24:57 +00002727 (inquiry)type_is_gc, /* tp_is_gc */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002728};
Tim Peters6d6c1a32001-08-02 04:15:00 +00002729
2730
2731/* The base type of all types (eventually)... except itself. */
2732
Guido van Rossum143b5642007-03-23 04:58:42 +00002733/* You may wonder why object.__new__() only complains about arguments
2734 when object.__init__() is not overridden, and vice versa.
2735
2736 Consider the use cases:
2737
2738 1. When neither is overridden, we want to hear complaints about
2739 excess (i.e., any) arguments, since their presence could
2740 indicate there's a bug.
2741
2742 2. When defining an Immutable type, we are likely to override only
2743 __new__(), since __init__() is called too late to initialize an
2744 Immutable object. Since __new__() defines the signature for the
2745 type, it would be a pain to have to override __init__() just to
2746 stop it from complaining about excess arguments.
2747
2748 3. When defining a Mutable type, we are likely to override only
2749 __init__(). So here the converse reasoning applies: we don't
2750 want to have to override __new__() just to stop it from
2751 complaining.
2752
2753 4. When __init__() is overridden, and the subclass __init__() calls
2754 object.__init__(), the latter should complain about excess
2755 arguments; ditto for __new__().
2756
2757 Use cases 2 and 3 make it unattractive to unconditionally check for
2758 excess arguments. The best solution that addresses all four use
2759 cases is as follows: __init__() complains about excess arguments
2760 unless __new__() is overridden and __init__() is not overridden
2761 (IOW, if __init__() is overridden or __new__() is not overridden);
2762 symmetrically, __new__() complains about excess arguments unless
2763 __init__() is overridden and __new__() is not overridden
2764 (IOW, if __new__() is overridden or __init__() is not overridden).
2765
2766 However, for backwards compatibility, this breaks too much code.
2767 Therefore, in 2.6, we'll *warn* about excess arguments when both
2768 methods are overridden; for all other cases we'll use the above
2769 rules.
2770
2771*/
2772
2773/* Forward */
2774static PyObject *
2775object_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
2776
2777static int
2778excess_args(PyObject *args, PyObject *kwds)
2779{
2780 return PyTuple_GET_SIZE(args) ||
2781 (kwds && PyDict_Check(kwds) && PyDict_Size(kwds));
2782}
2783
Tim Peters6d6c1a32001-08-02 04:15:00 +00002784static int
2785object_init(PyObject *self, PyObject *args, PyObject *kwds)
2786{
Guido van Rossum143b5642007-03-23 04:58:42 +00002787 int err = 0;
2788 if (excess_args(args, kwds)) {
Christian Heimese93237d2007-12-19 02:37:44 +00002789 PyTypeObject *type = Py_TYPE(self);
Guido van Rossum143b5642007-03-23 04:58:42 +00002790 if (type->tp_init != object_init &&
2791 type->tp_new != object_new)
2792 {
2793 err = PyErr_WarnEx(PyExc_DeprecationWarning,
2794 "object.__init__() takes no parameters",
2795 1);
2796 }
2797 else if (type->tp_init != object_init ||
2798 type->tp_new == object_new)
2799 {
2800 PyErr_SetString(PyExc_TypeError,
2801 "object.__init__() takes no parameters");
2802 err = -1;
2803 }
2804 }
2805 return err;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002806}
2807
Guido van Rossum298e4212003-02-13 16:30:16 +00002808static PyObject *
2809object_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
2810{
Guido van Rossum143b5642007-03-23 04:58:42 +00002811 int err = 0;
2812 if (excess_args(args, kwds)) {
2813 if (type->tp_new != object_new &&
2814 type->tp_init != object_init)
2815 {
2816 err = PyErr_WarnEx(PyExc_DeprecationWarning,
2817 "object.__new__() takes no parameters",
2818 1);
2819 }
2820 else if (type->tp_new != object_new ||
2821 type->tp_init == object_init)
2822 {
2823 PyErr_SetString(PyExc_TypeError,
2824 "object.__new__() takes no parameters");
2825 err = -1;
2826 }
Guido van Rossum298e4212003-02-13 16:30:16 +00002827 }
Guido van Rossum143b5642007-03-23 04:58:42 +00002828 if (err < 0)
2829 return NULL;
Jeffrey Yasskin960b9b72008-02-28 04:45:36 +00002830
2831 if (type->tp_flags & Py_TPFLAGS_IS_ABSTRACT) {
2832 static PyObject *comma = NULL;
2833 PyObject *abstract_methods = NULL;
2834 PyObject *builtins;
2835 PyObject *sorted;
2836 PyObject *sorted_methods = NULL;
2837 PyObject *joined = NULL;
2838 const char *joined_str;
2839
2840 /* Compute ", ".join(sorted(type.__abstractmethods__))
2841 into joined. */
2842 abstract_methods = type_abstractmethods(type, NULL);
2843 if (abstract_methods == NULL)
2844 goto error;
2845 builtins = PyEval_GetBuiltins();
2846 if (builtins == NULL)
2847 goto error;
2848 sorted = PyDict_GetItemString(builtins, "sorted");
2849 if (sorted == NULL)
2850 goto error;
2851 sorted_methods = PyObject_CallFunctionObjArgs(sorted,
2852 abstract_methods,
2853 NULL);
2854 if (sorted_methods == NULL)
2855 goto error;
2856 if (comma == NULL) {
Christian Heimes593daf52008-05-26 12:51:38 +00002857 comma = PyBytes_InternFromString(", ");
Jeffrey Yasskin960b9b72008-02-28 04:45:36 +00002858 if (comma == NULL)
2859 goto error;
2860 }
2861 joined = PyObject_CallMethod(comma, "join",
2862 "O", sorted_methods);
2863 if (joined == NULL)
2864 goto error;
Christian Heimes593daf52008-05-26 12:51:38 +00002865 joined_str = PyBytes_AsString(joined);
Jeffrey Yasskin960b9b72008-02-28 04:45:36 +00002866 if (joined_str == NULL)
2867 goto error;
2868
2869 PyErr_Format(PyExc_TypeError,
2870 "Can't instantiate abstract class %s "
2871 "with abstract methods %s",
2872 type->tp_name,
2873 joined_str);
2874 error:
2875 Py_XDECREF(joined);
2876 Py_XDECREF(sorted_methods);
2877 Py_XDECREF(abstract_methods);
2878 return NULL;
2879 }
Guido van Rossum298e4212003-02-13 16:30:16 +00002880 return type->tp_alloc(type, 0);
2881}
2882
Tim Peters6d6c1a32001-08-02 04:15:00 +00002883static void
2884object_dealloc(PyObject *self)
2885{
Christian Heimese93237d2007-12-19 02:37:44 +00002886 Py_TYPE(self)->tp_free(self);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002887}
2888
Guido van Rossum8e248182001-08-12 05:17:56 +00002889static PyObject *
2890object_repr(PyObject *self)
2891{
Guido van Rossum76e69632001-08-16 18:52:43 +00002892 PyTypeObject *type;
Barry Warsaw7ce36942001-08-24 18:34:26 +00002893 PyObject *mod, *name, *rtn;
Guido van Rossum8e248182001-08-12 05:17:56 +00002894
Christian Heimese93237d2007-12-19 02:37:44 +00002895 type = Py_TYPE(self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002896 mod = type_module(type, NULL);
2897 if (mod == NULL)
2898 PyErr_Clear();
Christian Heimes593daf52008-05-26 12:51:38 +00002899 else if (!PyBytes_Check(mod)) {
Guido van Rossum76e69632001-08-16 18:52:43 +00002900 Py_DECREF(mod);
2901 mod = NULL;
2902 }
2903 name = type_name(type, NULL);
2904 if (name == NULL)
2905 return NULL;
Christian Heimes593daf52008-05-26 12:51:38 +00002906 if (mod != NULL && strcmp(PyBytes_AS_STRING(mod), "__builtin__"))
2907 rtn = PyBytes_FromFormat("<%s.%s object at %p>",
2908 PyBytes_AS_STRING(mod),
2909 PyBytes_AS_STRING(name),
Barry Warsaw7ce36942001-08-24 18:34:26 +00002910 self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002911 else
Christian Heimes593daf52008-05-26 12:51:38 +00002912 rtn = PyBytes_FromFormat("<%s object at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +00002913 type->tp_name, self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002914 Py_XDECREF(mod);
2915 Py_DECREF(name);
Barry Warsaw7ce36942001-08-24 18:34:26 +00002916 return rtn;
Guido van Rossum8e248182001-08-12 05:17:56 +00002917}
2918
Guido van Rossumb8f63662001-08-15 23:57:02 +00002919static PyObject *
2920object_str(PyObject *self)
2921{
2922 unaryfunc f;
2923
Christian Heimese93237d2007-12-19 02:37:44 +00002924 f = Py_TYPE(self)->tp_repr;
Guido van Rossumb8f63662001-08-15 23:57:02 +00002925 if (f == NULL)
2926 f = object_repr;
2927 return f(self);
2928}
2929
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002930static PyObject *
2931object_get_class(PyObject *self, void *closure)
2932{
Christian Heimese93237d2007-12-19 02:37:44 +00002933 Py_INCREF(Py_TYPE(self));
2934 return (PyObject *)(Py_TYPE(self));
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002935}
2936
2937static int
2938equiv_structs(PyTypeObject *a, PyTypeObject *b)
2939{
2940 return a == b ||
2941 (a != NULL &&
2942 b != NULL &&
2943 a->tp_basicsize == b->tp_basicsize &&
2944 a->tp_itemsize == b->tp_itemsize &&
2945 a->tp_dictoffset == b->tp_dictoffset &&
2946 a->tp_weaklistoffset == b->tp_weaklistoffset &&
2947 ((a->tp_flags & Py_TPFLAGS_HAVE_GC) ==
2948 (b->tp_flags & Py_TPFLAGS_HAVE_GC)));
2949}
2950
2951static int
2952same_slots_added(PyTypeObject *a, PyTypeObject *b)
2953{
2954 PyTypeObject *base = a->tp_base;
Martin v. Löwiseb079f12006-02-16 14:32:27 +00002955 Py_ssize_t size;
Žiga Seilnacht6f2d09c2007-03-16 11:59:38 +00002956 PyObject *slots_a, *slots_b;
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002957
2958 if (base != b->tp_base)
2959 return 0;
2960 if (equiv_structs(a, base) && equiv_structs(b, base))
2961 return 1;
2962 size = base->tp_basicsize;
2963 if (a->tp_dictoffset == size && b->tp_dictoffset == size)
2964 size += sizeof(PyObject *);
2965 if (a->tp_weaklistoffset == size && b->tp_weaklistoffset == size)
2966 size += sizeof(PyObject *);
Žiga Seilnacht6f2d09c2007-03-16 11:59:38 +00002967
2968 /* Check slots compliance */
2969 slots_a = ((PyHeapTypeObject *)a)->ht_slots;
2970 slots_b = ((PyHeapTypeObject *)b)->ht_slots;
2971 if (slots_a && slots_b) {
2972 if (PyObject_Compare(slots_a, slots_b) != 0)
2973 return 0;
2974 size += sizeof(PyObject *) * PyTuple_GET_SIZE(slots_a);
2975 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002976 return size == a->tp_basicsize && size == b->tp_basicsize;
2977}
2978
2979static int
Anthony Baxtera6286212006-04-11 07:42:36 +00002980compatible_for_assignment(PyTypeObject* oldto, PyTypeObject* newto, char* attr)
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002981{
2982 PyTypeObject *newbase, *oldbase;
2983
Anthony Baxtera6286212006-04-11 07:42:36 +00002984 if (newto->tp_dealloc != oldto->tp_dealloc ||
2985 newto->tp_free != oldto->tp_free)
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002986 {
2987 PyErr_Format(PyExc_TypeError,
2988 "%s assignment: "
2989 "'%s' deallocator differs from '%s'",
2990 attr,
Anthony Baxtera6286212006-04-11 07:42:36 +00002991 newto->tp_name,
2992 oldto->tp_name);
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002993 return 0;
2994 }
Anthony Baxtera6286212006-04-11 07:42:36 +00002995 newbase = newto;
2996 oldbase = oldto;
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002997 while (equiv_structs(newbase, newbase->tp_base))
2998 newbase = newbase->tp_base;
2999 while (equiv_structs(oldbase, oldbase->tp_base))
3000 oldbase = oldbase->tp_base;
3001 if (newbase != oldbase &&
3002 (newbase->tp_base != oldbase->tp_base ||
3003 !same_slots_added(newbase, oldbase))) {
3004 PyErr_Format(PyExc_TypeError,
3005 "%s assignment: "
3006 "'%s' object layout differs from '%s'",
3007 attr,
Anthony Baxtera6286212006-04-11 07:42:36 +00003008 newto->tp_name,
3009 oldto->tp_name);
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003010 return 0;
3011 }
Tim Petersea7f75d2002-12-07 21:39:16 +00003012
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003013 return 1;
3014}
3015
3016static int
Guido van Rossum5c294fb2001-09-25 03:43:42 +00003017object_set_class(PyObject *self, PyObject *value, void *closure)
3018{
Christian Heimese93237d2007-12-19 02:37:44 +00003019 PyTypeObject *oldto = Py_TYPE(self);
Anthony Baxtera6286212006-04-11 07:42:36 +00003020 PyTypeObject *newto;
Guido van Rossum5c294fb2001-09-25 03:43:42 +00003021
Guido van Rossumb6b89422002-04-15 01:03:30 +00003022 if (value == NULL) {
3023 PyErr_SetString(PyExc_TypeError,
3024 "can't delete __class__ attribute");
3025 return -1;
3026 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00003027 if (!PyType_Check(value)) {
3028 PyErr_Format(PyExc_TypeError,
3029 "__class__ must be set to new-style class, not '%s' object",
Christian Heimese93237d2007-12-19 02:37:44 +00003030 Py_TYPE(value)->tp_name);
Guido van Rossum5c294fb2001-09-25 03:43:42 +00003031 return -1;
3032 }
Anthony Baxtera6286212006-04-11 07:42:36 +00003033 newto = (PyTypeObject *)value;
3034 if (!(newto->tp_flags & Py_TPFLAGS_HEAPTYPE) ||
3035 !(oldto->tp_flags & Py_TPFLAGS_HEAPTYPE))
Guido van Rossum40af8892002-08-10 05:42:07 +00003036 {
3037 PyErr_Format(PyExc_TypeError,
3038 "__class__ assignment: only for heap types");
3039 return -1;
3040 }
Anthony Baxtera6286212006-04-11 07:42:36 +00003041 if (compatible_for_assignment(newto, oldto, "__class__")) {
3042 Py_INCREF(newto);
Christian Heimese93237d2007-12-19 02:37:44 +00003043 Py_TYPE(self) = newto;
Anthony Baxtera6286212006-04-11 07:42:36 +00003044 Py_DECREF(oldto);
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003045 return 0;
3046 }
3047 else {
Guido van Rossum9ee4b942002-05-24 18:47:47 +00003048 return -1;
3049 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00003050}
3051
3052static PyGetSetDef object_getsets[] = {
3053 {"__class__", object_get_class, object_set_class,
Neal Norwitz858e34f2002-08-13 17:18:45 +00003054 PyDoc_STR("the object's class")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00003055 {0}
3056};
3057
Guido van Rossumc53f0092003-02-18 22:05:12 +00003058
Guido van Rossum036f9992003-02-21 22:02:54 +00003059/* Stuff to implement __reduce_ex__ for pickle protocols >= 2.
Georg Brandldffbf5f2008-05-20 07:49:57 +00003060 We fall back to helpers in copy_reg for:
Guido van Rossum036f9992003-02-21 22:02:54 +00003061 - pickle protocols < 2
3062 - calculating the list of slot names (done only once per class)
3063 - the __newobj__ function (which is used as a token but never called)
3064*/
3065
3066static PyObject *
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003067import_copyreg(void)
Guido van Rossum036f9992003-02-21 22:02:54 +00003068{
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003069 static PyObject *copyreg_str;
Guido van Rossum3926a632001-09-25 16:25:58 +00003070
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003071 if (!copyreg_str) {
Christian Heimes593daf52008-05-26 12:51:38 +00003072 copyreg_str = PyBytes_InternFromString("copy_reg");
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003073 if (copyreg_str == NULL)
Guido van Rossum3926a632001-09-25 16:25:58 +00003074 return NULL;
3075 }
Guido van Rossum036f9992003-02-21 22:02:54 +00003076
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003077 return PyImport_Import(copyreg_str);
Guido van Rossum036f9992003-02-21 22:02:54 +00003078}
3079
3080static PyObject *
3081slotnames(PyObject *cls)
3082{
3083 PyObject *clsdict;
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003084 PyObject *copyreg;
Guido van Rossum036f9992003-02-21 22:02:54 +00003085 PyObject *slotnames;
3086
3087 if (!PyType_Check(cls)) {
3088 Py_INCREF(Py_None);
3089 return Py_None;
3090 }
3091
3092 clsdict = ((PyTypeObject *)cls)->tp_dict;
3093 slotnames = PyDict_GetItemString(clsdict, "__slotnames__");
Armin Rigoec862b92005-09-24 22:58:41 +00003094 if (slotnames != NULL && PyList_Check(slotnames)) {
Guido van Rossum036f9992003-02-21 22:02:54 +00003095 Py_INCREF(slotnames);
3096 return slotnames;
3097 }
3098
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003099 copyreg = import_copyreg();
3100 if (copyreg == NULL)
Guido van Rossum036f9992003-02-21 22:02:54 +00003101 return NULL;
3102
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003103 slotnames = PyObject_CallMethod(copyreg, "_slotnames", "O", cls);
3104 Py_DECREF(copyreg);
Guido van Rossum036f9992003-02-21 22:02:54 +00003105 if (slotnames != NULL &&
3106 slotnames != Py_None &&
3107 !PyList_Check(slotnames))
3108 {
3109 PyErr_SetString(PyExc_TypeError,
Georg Brandldffbf5f2008-05-20 07:49:57 +00003110 "copy_reg._slotnames didn't return a list or None");
Guido van Rossum036f9992003-02-21 22:02:54 +00003111 Py_DECREF(slotnames);
3112 slotnames = NULL;
3113 }
3114
3115 return slotnames;
3116}
3117
3118static PyObject *
3119reduce_2(PyObject *obj)
3120{
3121 PyObject *cls, *getnewargs;
3122 PyObject *args = NULL, *args2 = NULL;
3123 PyObject *getstate = NULL, *state = NULL, *names = NULL;
3124 PyObject *slots = NULL, *listitems = NULL, *dictitems = NULL;
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003125 PyObject *copyreg = NULL, *newobj = NULL, *res = NULL;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003126 Py_ssize_t i, n;
Guido van Rossum036f9992003-02-21 22:02:54 +00003127
3128 cls = PyObject_GetAttrString(obj, "__class__");
3129 if (cls == NULL)
3130 return NULL;
3131
3132 getnewargs = PyObject_GetAttrString(obj, "__getnewargs__");
3133 if (getnewargs != NULL) {
3134 args = PyObject_CallObject(getnewargs, NULL);
3135 Py_DECREF(getnewargs);
3136 if (args != NULL && !PyTuple_Check(args)) {
Georg Brandlccff7852006-06-18 22:17:29 +00003137 PyErr_Format(PyExc_TypeError,
3138 "__getnewargs__ should return a tuple, "
Christian Heimese93237d2007-12-19 02:37:44 +00003139 "not '%.200s'", Py_TYPE(args)->tp_name);
Guido van Rossum036f9992003-02-21 22:02:54 +00003140 goto end;
3141 }
3142 }
3143 else {
3144 PyErr_Clear();
3145 args = PyTuple_New(0);
3146 }
3147 if (args == NULL)
3148 goto end;
3149
3150 getstate = PyObject_GetAttrString(obj, "__getstate__");
3151 if (getstate != NULL) {
3152 state = PyObject_CallObject(getstate, NULL);
3153 Py_DECREF(getstate);
Neal Norwitze2fdc612003-06-08 13:19:58 +00003154 if (state == NULL)
3155 goto end;
Guido van Rossum036f9992003-02-21 22:02:54 +00003156 }
3157 else {
Jim Fulton8a1a5942004-02-08 04:21:26 +00003158 PyErr_Clear();
Guido van Rossum036f9992003-02-21 22:02:54 +00003159 state = PyObject_GetAttrString(obj, "__dict__");
3160 if (state == NULL) {
3161 PyErr_Clear();
3162 state = Py_None;
3163 Py_INCREF(state);
3164 }
3165 names = slotnames(cls);
3166 if (names == NULL)
3167 goto end;
3168 if (names != Py_None) {
3169 assert(PyList_Check(names));
3170 slots = PyDict_New();
3171 if (slots == NULL)
3172 goto end;
3173 n = 0;
3174 /* Can't pre-compute the list size; the list
3175 is stored on the class so accessible to other
3176 threads, which may be run by DECREF */
3177 for (i = 0; i < PyList_GET_SIZE(names); i++) {
3178 PyObject *name, *value;
3179 name = PyList_GET_ITEM(names, i);
3180 value = PyObject_GetAttr(obj, name);
3181 if (value == NULL)
3182 PyErr_Clear();
3183 else {
3184 int err = PyDict_SetItem(slots, name,
3185 value);
3186 Py_DECREF(value);
3187 if (err)
3188 goto end;
3189 n++;
3190 }
3191 }
3192 if (n) {
3193 state = Py_BuildValue("(NO)", state, slots);
3194 if (state == NULL)
3195 goto end;
3196 }
3197 }
3198 }
3199
3200 if (!PyList_Check(obj)) {
3201 listitems = Py_None;
3202 Py_INCREF(listitems);
3203 }
3204 else {
3205 listitems = PyObject_GetIter(obj);
3206 if (listitems == NULL)
3207 goto end;
3208 }
3209
3210 if (!PyDict_Check(obj)) {
3211 dictitems = Py_None;
3212 Py_INCREF(dictitems);
3213 }
3214 else {
3215 dictitems = PyObject_CallMethod(obj, "iteritems", "");
3216 if (dictitems == NULL)
3217 goto end;
3218 }
3219
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003220 copyreg = import_copyreg();
3221 if (copyreg == NULL)
Guido van Rossum036f9992003-02-21 22:02:54 +00003222 goto end;
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003223 newobj = PyObject_GetAttrString(copyreg, "__newobj__");
Guido van Rossum036f9992003-02-21 22:02:54 +00003224 if (newobj == NULL)
3225 goto end;
3226
3227 n = PyTuple_GET_SIZE(args);
3228 args2 = PyTuple_New(n+1);
3229 if (args2 == NULL)
3230 goto end;
3231 PyTuple_SET_ITEM(args2, 0, cls);
3232 cls = NULL;
3233 for (i = 0; i < n; i++) {
3234 PyObject *v = PyTuple_GET_ITEM(args, i);
3235 Py_INCREF(v);
3236 PyTuple_SET_ITEM(args2, i+1, v);
3237 }
3238
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003239 res = PyTuple_Pack(5, newobj, args2, state, listitems, dictitems);
Guido van Rossum036f9992003-02-21 22:02:54 +00003240
3241 end:
3242 Py_XDECREF(cls);
3243 Py_XDECREF(args);
3244 Py_XDECREF(args2);
Jeremy Hyltond06483c2003-04-09 21:01:42 +00003245 Py_XDECREF(slots);
Guido van Rossum036f9992003-02-21 22:02:54 +00003246 Py_XDECREF(state);
3247 Py_XDECREF(names);
3248 Py_XDECREF(listitems);
3249 Py_XDECREF(dictitems);
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003250 Py_XDECREF(copyreg);
Guido van Rossum036f9992003-02-21 22:02:54 +00003251 Py_XDECREF(newobj);
3252 return res;
3253}
3254
Žiga Seilnacht20f43d32007-03-15 11:44:55 +00003255/*
3256 * There were two problems when object.__reduce__ and object.__reduce_ex__
3257 * were implemented in the same function:
3258 * - trying to pickle an object with a custom __reduce__ method that
3259 * fell back to object.__reduce__ in certain circumstances led to
3260 * infinite recursion at Python level and eventual RuntimeError.
3261 * - Pickling objects that lied about their type by overwriting the
3262 * __class__ descriptor could lead to infinite recursion at C level
3263 * and eventual segfault.
3264 *
3265 * Because of backwards compatibility, the two methods still have to
3266 * behave in the same way, even if this is not required by the pickle
3267 * protocol. This common functionality was moved to the _common_reduce
3268 * function.
3269 */
3270static PyObject *
3271_common_reduce(PyObject *self, int proto)
3272{
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003273 PyObject *copyreg, *res;
Žiga Seilnacht20f43d32007-03-15 11:44:55 +00003274
3275 if (proto >= 2)
3276 return reduce_2(self);
3277
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003278 copyreg = import_copyreg();
3279 if (!copyreg)
Žiga Seilnacht20f43d32007-03-15 11:44:55 +00003280 return NULL;
3281
Alexandre Vassalotti9510e4a2008-05-11 08:25:28 +00003282 res = PyEval_CallMethod(copyreg, "_reduce_ex", "(Oi)", self, proto);
3283 Py_DECREF(copyreg);
Žiga Seilnacht20f43d32007-03-15 11:44:55 +00003284
3285 return res;
3286}
3287
3288static PyObject *
3289object_reduce(PyObject *self, PyObject *args)
3290{
3291 int proto = 0;
3292
3293 if (!PyArg_ParseTuple(args, "|i:__reduce__", &proto))
3294 return NULL;
3295
3296 return _common_reduce(self, proto);
3297}
3298
Guido van Rossum036f9992003-02-21 22:02:54 +00003299static PyObject *
3300object_reduce_ex(PyObject *self, PyObject *args)
3301{
Žiga Seilnacht20f43d32007-03-15 11:44:55 +00003302 PyObject *reduce, *res;
Guido van Rossum036f9992003-02-21 22:02:54 +00003303 int proto = 0;
3304
3305 if (!PyArg_ParseTuple(args, "|i:__reduce_ex__", &proto))
3306 return NULL;
3307
3308 reduce = PyObject_GetAttrString(self, "__reduce__");
3309 if (reduce == NULL)
3310 PyErr_Clear();
3311 else {
3312 PyObject *cls, *clsreduce, *objreduce;
3313 int override;
3314 cls = PyObject_GetAttrString(self, "__class__");
3315 if (cls == NULL) {
3316 Py_DECREF(reduce);
3317 return NULL;
3318 }
3319 clsreduce = PyObject_GetAttrString(cls, "__reduce__");
3320 Py_DECREF(cls);
3321 if (clsreduce == NULL) {
3322 Py_DECREF(reduce);
3323 return NULL;
3324 }
3325 objreduce = PyDict_GetItemString(PyBaseObject_Type.tp_dict,
3326 "__reduce__");
3327 override = (clsreduce != objreduce);
3328 Py_DECREF(clsreduce);
3329 if (override) {
3330 res = PyObject_CallObject(reduce, NULL);
3331 Py_DECREF(reduce);
3332 return res;
3333 }
3334 else
3335 Py_DECREF(reduce);
3336 }
3337
Žiga Seilnacht20f43d32007-03-15 11:44:55 +00003338 return _common_reduce(self, proto);
Guido van Rossum3926a632001-09-25 16:25:58 +00003339}
3340
Jeffrey Yasskin960b9b72008-02-28 04:45:36 +00003341static PyObject *
3342object_subclasshook(PyObject *cls, PyObject *args)
3343{
3344 Py_INCREF(Py_NotImplemented);
3345 return Py_NotImplemented;
3346}
3347
3348PyDoc_STRVAR(object_subclasshook_doc,
3349"Abstract classes can override this to customize issubclass().\n"
3350"\n"
3351"This is invoked early on by abc.ABCMeta.__subclasscheck__().\n"
3352"It should return True, False or NotImplemented. If it returns\n"
3353"NotImplemented, the normal algorithm is used. Otherwise, it\n"
3354"overrides the normal algorithm (and the outcome is cached).\n");
3355
Eric Smitha9f7d622008-02-17 19:46:49 +00003356/*
3357 from PEP 3101, this code implements:
3358
3359 class object:
3360 def __format__(self, format_spec):
3361 if isinstance(format_spec, str):
3362 return format(str(self), format_spec)
3363 elif isinstance(format_spec, unicode):
3364 return format(unicode(self), format_spec)
3365*/
3366static PyObject *
3367object_format(PyObject *self, PyObject *args)
3368{
3369 PyObject *format_spec;
3370 PyObject *self_as_str = NULL;
3371 PyObject *result = NULL;
3372 PyObject *format_meth = NULL;
3373
3374 if (!PyArg_ParseTuple(args, "O:__format__", &format_spec))
3375 return NULL;
3376 if (PyUnicode_Check(format_spec)) {
3377 self_as_str = PyObject_Unicode(self);
Christian Heimes593daf52008-05-26 12:51:38 +00003378 } else if (PyBytes_Check(format_spec)) {
Eric Smitha9f7d622008-02-17 19:46:49 +00003379 self_as_str = PyObject_Str(self);
3380 } else {
3381 PyErr_SetString(PyExc_TypeError, "argument to __format__ must be unicode or str");
3382 return NULL;
3383 }
3384
3385 if (self_as_str != NULL) {
3386 /* find the format function */
3387 format_meth = PyObject_GetAttrString(self_as_str, "__format__");
3388 if (format_meth != NULL) {
3389 /* and call it */
3390 result = PyObject_CallFunctionObjArgs(format_meth, format_spec, NULL);
3391 }
3392 }
3393
3394 Py_XDECREF(self_as_str);
3395 Py_XDECREF(format_meth);
3396
3397 return result;
3398}
3399
Robert Schuppenies51df0642008-06-01 16:16:17 +00003400static PyObject *
3401object_sizeof(PyObject *self, PyObject *args)
3402{
3403 Py_ssize_t res, isize;
3404
3405 res = 0;
3406 isize = self->ob_type->tp_itemsize;
3407 if (isize > 0)
3408 res = self->ob_type->ob_size * isize;
3409 res += self->ob_type->tp_basicsize;
3410
3411 return PyInt_FromSsize_t(res);
3412}
3413
Guido van Rossum3926a632001-09-25 16:25:58 +00003414static PyMethodDef object_methods[] = {
Guido van Rossumc53f0092003-02-18 22:05:12 +00003415 {"__reduce_ex__", object_reduce_ex, METH_VARARGS,
3416 PyDoc_STR("helper for pickle")},
Žiga Seilnacht20f43d32007-03-15 11:44:55 +00003417 {"__reduce__", object_reduce, METH_VARARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00003418 PyDoc_STR("helper for pickle")},
Jeffrey Yasskin960b9b72008-02-28 04:45:36 +00003419 {"__subclasshook__", object_subclasshook, METH_CLASS | METH_VARARGS,
3420 object_subclasshook_doc},
Eric Smitha9f7d622008-02-17 19:46:49 +00003421 {"__format__", object_format, METH_VARARGS,
3422 PyDoc_STR("default object formatter")},
Robert Schuppenies51df0642008-06-01 16:16:17 +00003423 {"__sizeof__", object_sizeof, METH_NOARGS,
3424 PyDoc_STR("__sizeof__() -> size of object in bytes")},
Guido van Rossum3926a632001-09-25 16:25:58 +00003425 {0}
3426};
3427
Guido van Rossum036f9992003-02-21 22:02:54 +00003428
Tim Peters6d6c1a32001-08-02 04:15:00 +00003429PyTypeObject PyBaseObject_Type = {
Martin v. Löwis68192102007-07-21 06:55:02 +00003430 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003431 "object", /* tp_name */
3432 sizeof(PyObject), /* tp_basicsize */
3433 0, /* tp_itemsize */
Georg Brandl347b3002006-03-30 11:57:00 +00003434 object_dealloc, /* tp_dealloc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003435 0, /* tp_print */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003436 0, /* tp_getattr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003437 0, /* tp_setattr */
3438 0, /* tp_compare */
Guido van Rossumb8f63662001-08-15 23:57:02 +00003439 object_repr, /* tp_repr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003440 0, /* tp_as_number */
3441 0, /* tp_as_sequence */
3442 0, /* tp_as_mapping */
Guido van Rossum64c06e32007-11-22 00:55:51 +00003443 (hashfunc)_Py_HashPointer, /* tp_hash */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003444 0, /* tp_call */
Guido van Rossumb8f63662001-08-15 23:57:02 +00003445 object_str, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003446 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum13d52f02001-08-10 21:24:08 +00003447 PyObject_GenericSetAttr, /* tp_setattro */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003448 0, /* tp_as_buffer */
3449 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Neal Norwitz5dc2a372002-08-13 22:19:13 +00003450 PyDoc_STR("The most base type"), /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003451 0, /* tp_traverse */
3452 0, /* tp_clear */
3453 0, /* tp_richcompare */
3454 0, /* tp_weaklistoffset */
3455 0, /* tp_iter */
3456 0, /* tp_iternext */
Guido van Rossum3926a632001-09-25 16:25:58 +00003457 object_methods, /* tp_methods */
Guido van Rossum5c294fb2001-09-25 03:43:42 +00003458 0, /* tp_members */
3459 object_getsets, /* tp_getset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003460 0, /* tp_base */
3461 0, /* tp_dict */
3462 0, /* tp_descr_get */
3463 0, /* tp_descr_set */
3464 0, /* tp_dictoffset */
3465 object_init, /* tp_init */
3466 PyType_GenericAlloc, /* tp_alloc */
Guido van Rossum298e4212003-02-13 16:30:16 +00003467 object_new, /* tp_new */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003468 PyObject_Del, /* tp_free */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003469};
3470
3471
3472/* Initialize the __dict__ in a type object */
3473
3474static int
3475add_methods(PyTypeObject *type, PyMethodDef *meth)
3476{
Guido van Rossum687ae002001-10-15 22:03:32 +00003477 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003478
3479 for (; meth->ml_name != NULL; meth++) {
3480 PyObject *descr;
Raymond Hettinger8f5cdaa2003-12-13 11:26:12 +00003481 if (PyDict_GetItemString(dict, meth->ml_name) &&
3482 !(meth->ml_flags & METH_COEXIST))
3483 continue;
Fred Drake7bf97152002-03-28 05:33:33 +00003484 if (meth->ml_flags & METH_CLASS) {
3485 if (meth->ml_flags & METH_STATIC) {
3486 PyErr_SetString(PyExc_ValueError,
3487 "method cannot be both class and static");
3488 return -1;
3489 }
Tim Petersbca1cbc2002-12-09 22:56:13 +00003490 descr = PyDescr_NewClassMethod(type, meth);
Fred Drake7bf97152002-03-28 05:33:33 +00003491 }
3492 else if (meth->ml_flags & METH_STATIC) {
Guido van Rossum9af48ff2003-02-11 17:12:46 +00003493 PyObject *cfunc = PyCFunction_New(meth, NULL);
3494 if (cfunc == NULL)
3495 return -1;
3496 descr = PyStaticMethod_New(cfunc);
3497 Py_DECREF(cfunc);
Fred Drake7bf97152002-03-28 05:33:33 +00003498 }
3499 else {
3500 descr = PyDescr_NewMethod(type, meth);
3501 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003502 if (descr == NULL)
3503 return -1;
Fred Drake7bf97152002-03-28 05:33:33 +00003504 if (PyDict_SetItemString(dict, meth->ml_name, descr) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003505 return -1;
3506 Py_DECREF(descr);
3507 }
3508 return 0;
3509}
3510
3511static int
Guido van Rossum6f799372001-09-20 20:46:19 +00003512add_members(PyTypeObject *type, PyMemberDef *memb)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003513{
Guido van Rossum687ae002001-10-15 22:03:32 +00003514 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003515
3516 for (; memb->name != NULL; memb++) {
3517 PyObject *descr;
3518 if (PyDict_GetItemString(dict, memb->name))
3519 continue;
3520 descr = PyDescr_NewMember(type, memb);
3521 if (descr == NULL)
3522 return -1;
3523 if (PyDict_SetItemString(dict, memb->name, descr) < 0)
3524 return -1;
3525 Py_DECREF(descr);
3526 }
3527 return 0;
3528}
3529
3530static int
Guido van Rossum32d34c82001-09-20 21:45:26 +00003531add_getset(PyTypeObject *type, PyGetSetDef *gsp)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003532{
Guido van Rossum687ae002001-10-15 22:03:32 +00003533 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003534
3535 for (; gsp->name != NULL; gsp++) {
3536 PyObject *descr;
3537 if (PyDict_GetItemString(dict, gsp->name))
3538 continue;
3539 descr = PyDescr_NewGetSet(type, gsp);
3540
3541 if (descr == NULL)
3542 return -1;
3543 if (PyDict_SetItemString(dict, gsp->name, descr) < 0)
3544 return -1;
3545 Py_DECREF(descr);
3546 }
3547 return 0;
3548}
3549
Guido van Rossum13d52f02001-08-10 21:24:08 +00003550static void
3551inherit_special(PyTypeObject *type, PyTypeObject *base)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003552{
Martin v. Löwiseb079f12006-02-16 14:32:27 +00003553 Py_ssize_t oldsize, newsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003554
Guido van Rossum13d52f02001-08-10 21:24:08 +00003555 /* Special flag magic */
3556 if (!type->tp_as_buffer && base->tp_as_buffer) {
3557 type->tp_flags &= ~Py_TPFLAGS_HAVE_GETCHARBUFFER;
3558 type->tp_flags |=
3559 base->tp_flags & Py_TPFLAGS_HAVE_GETCHARBUFFER;
3560 }
3561 if (!type->tp_as_sequence && base->tp_as_sequence) {
3562 type->tp_flags &= ~Py_TPFLAGS_HAVE_SEQUENCE_IN;
3563 type->tp_flags |= base->tp_flags & Py_TPFLAGS_HAVE_SEQUENCE_IN;
3564 }
3565 if ((type->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS) !=
3566 (base->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS)) {
3567 if ((!type->tp_as_number && base->tp_as_number) ||
3568 (!type->tp_as_sequence && base->tp_as_sequence)) {
3569 type->tp_flags &= ~Py_TPFLAGS_HAVE_INPLACEOPS;
3570 if (!type->tp_as_number && !type->tp_as_sequence) {
3571 type->tp_flags |= base->tp_flags &
3572 Py_TPFLAGS_HAVE_INPLACEOPS;
3573 }
3574 }
3575 /* Wow */
3576 }
3577 if (!type->tp_as_number && base->tp_as_number) {
3578 type->tp_flags &= ~Py_TPFLAGS_CHECKTYPES;
3579 type->tp_flags |= base->tp_flags & Py_TPFLAGS_CHECKTYPES;
3580 }
3581
3582 /* Copying basicsize is connected to the GC flags */
Neil Schemenauerc806c882001-08-29 23:54:54 +00003583 oldsize = base->tp_basicsize;
3584 newsize = type->tp_basicsize ? type->tp_basicsize : oldsize;
3585 if (!(type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
3586 (base->tp_flags & Py_TPFLAGS_HAVE_GC) &&
Guido van Rossum13d52f02001-08-10 21:24:08 +00003587 (type->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE/*GC slots exist*/) &&
3588 (!type->tp_traverse && !type->tp_clear)) {
Neil Schemenauerc806c882001-08-29 23:54:54 +00003589 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
Guido van Rossum13d52f02001-08-10 21:24:08 +00003590 if (type->tp_traverse == NULL)
3591 type->tp_traverse = base->tp_traverse;
3592 if (type->tp_clear == NULL)
3593 type->tp_clear = base->tp_clear;
3594 }
3595 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
Guido van Rossumf884b742001-12-17 17:14:22 +00003596 /* The condition below could use some explanation.
3597 It appears that tp_new is not inherited for static types
3598 whose base class is 'object'; this seems to be a precaution
3599 so that old extension types don't suddenly become
3600 callable (object.__new__ wouldn't insure the invariants
3601 that the extension type's own factory function ensures).
3602 Heap types, of course, are under our control, so they do
3603 inherit tp_new; static extension types that specify some
3604 other built-in type as the default are considered
3605 new-style-aware so they also inherit object.__new__. */
Guido van Rossum13d52f02001-08-10 21:24:08 +00003606 if (base != &PyBaseObject_Type ||
3607 (type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
3608 if (type->tp_new == NULL)
3609 type->tp_new = base->tp_new;
3610 }
3611 }
Neil Schemenauerc806c882001-08-29 23:54:54 +00003612 type->tp_basicsize = newsize;
Guido van Rossum4dd64ab2001-08-14 20:04:48 +00003613
3614 /* Copy other non-function slots */
3615
3616#undef COPYVAL
3617#define COPYVAL(SLOT) \
3618 if (type->SLOT == 0) type->SLOT = base->SLOT
3619
3620 COPYVAL(tp_itemsize);
3621 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_WEAKREFS) {
3622 COPYVAL(tp_weaklistoffset);
3623 }
3624 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
3625 COPYVAL(tp_dictoffset);
3626 }
Neal Norwitzee3a1b52007-02-25 19:44:48 +00003627
3628 /* Setup fast subclass flags */
3629 if (PyType_IsSubtype(base, (PyTypeObject*)PyExc_BaseException))
3630 type->tp_flags |= Py_TPFLAGS_BASE_EXC_SUBCLASS;
3631 else if (PyType_IsSubtype(base, &PyType_Type))
3632 type->tp_flags |= Py_TPFLAGS_TYPE_SUBCLASS;
3633 else if (PyType_IsSubtype(base, &PyInt_Type))
3634 type->tp_flags |= Py_TPFLAGS_INT_SUBCLASS;
3635 else if (PyType_IsSubtype(base, &PyLong_Type))
3636 type->tp_flags |= Py_TPFLAGS_LONG_SUBCLASS;
Christian Heimes593daf52008-05-26 12:51:38 +00003637 else if (PyType_IsSubtype(base, &PyBytes_Type))
Neal Norwitzee3a1b52007-02-25 19:44:48 +00003638 type->tp_flags |= Py_TPFLAGS_STRING_SUBCLASS;
Georg Brandldfe5dc82008-01-07 18:16:36 +00003639#ifdef Py_USING_UNICODE
Neal Norwitzee3a1b52007-02-25 19:44:48 +00003640 else if (PyType_IsSubtype(base, &PyUnicode_Type))
3641 type->tp_flags |= Py_TPFLAGS_UNICODE_SUBCLASS;
Georg Brandldfe5dc82008-01-07 18:16:36 +00003642#endif
Neal Norwitzee3a1b52007-02-25 19:44:48 +00003643 else if (PyType_IsSubtype(base, &PyTuple_Type))
3644 type->tp_flags |= Py_TPFLAGS_TUPLE_SUBCLASS;
3645 else if (PyType_IsSubtype(base, &PyList_Type))
3646 type->tp_flags |= Py_TPFLAGS_LIST_SUBCLASS;
3647 else if (PyType_IsSubtype(base, &PyDict_Type))
3648 type->tp_flags |= Py_TPFLAGS_DICT_SUBCLASS;
Guido van Rossum13d52f02001-08-10 21:24:08 +00003649}
3650
Guido van Rossum0b7b6fd2007-12-19 22:51:13 +00003651static char *hash_name_op[] = {
3652 "__eq__",
3653 "__cmp__",
3654 "__hash__",
3655 NULL
Guido van Rossum64c06e32007-11-22 00:55:51 +00003656};
3657
3658static int
3659overrides_hash(PyTypeObject *type)
3660{
Guido van Rossum0b7b6fd2007-12-19 22:51:13 +00003661 char **p;
Guido van Rossum64c06e32007-11-22 00:55:51 +00003662 PyObject *dict = type->tp_dict;
3663
3664 assert(dict != NULL);
Guido van Rossum0b7b6fd2007-12-19 22:51:13 +00003665 for (p = hash_name_op; *p; p++) {
3666 if (PyDict_GetItemString(dict, *p) != NULL)
Guido van Rossum64c06e32007-11-22 00:55:51 +00003667 return 1;
3668 }
3669 return 0;
3670}
3671
Guido van Rossum13d52f02001-08-10 21:24:08 +00003672static void
3673inherit_slots(PyTypeObject *type, PyTypeObject *base)
3674{
3675 PyTypeObject *basebase;
3676
3677#undef SLOTDEFINED
Tim Peters6d6c1a32001-08-02 04:15:00 +00003678#undef COPYSLOT
3679#undef COPYNUM
3680#undef COPYSEQ
3681#undef COPYMAP
Guido van Rossum5af588b2001-10-12 14:13:21 +00003682#undef COPYBUF
Guido van Rossum13d52f02001-08-10 21:24:08 +00003683
3684#define SLOTDEFINED(SLOT) \
3685 (base->SLOT != 0 && \
3686 (basebase == NULL || base->SLOT != basebase->SLOT))
3687
Tim Peters6d6c1a32001-08-02 04:15:00 +00003688#define COPYSLOT(SLOT) \
Guido van Rossum13d52f02001-08-10 21:24:08 +00003689 if (!type->SLOT && SLOTDEFINED(SLOT)) type->SLOT = base->SLOT
Tim Peters6d6c1a32001-08-02 04:15:00 +00003690
3691#define COPYNUM(SLOT) COPYSLOT(tp_as_number->SLOT)
3692#define COPYSEQ(SLOT) COPYSLOT(tp_as_sequence->SLOT)
3693#define COPYMAP(SLOT) COPYSLOT(tp_as_mapping->SLOT)
Tim Petersfc57ccb2001-10-12 02:38:24 +00003694#define COPYBUF(SLOT) COPYSLOT(tp_as_buffer->SLOT)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003695
Guido van Rossum13d52f02001-08-10 21:24:08 +00003696 /* This won't inherit indirect slots (from tp_as_number etc.)
3697 if type doesn't provide the space. */
3698
3699 if (type->tp_as_number != NULL && base->tp_as_number != NULL) {
3700 basebase = base->tp_base;
3701 if (basebase->tp_as_number == NULL)
3702 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003703 COPYNUM(nb_add);
3704 COPYNUM(nb_subtract);
3705 COPYNUM(nb_multiply);
3706 COPYNUM(nb_divide);
3707 COPYNUM(nb_remainder);
3708 COPYNUM(nb_divmod);
3709 COPYNUM(nb_power);
3710 COPYNUM(nb_negative);
3711 COPYNUM(nb_positive);
3712 COPYNUM(nb_absolute);
3713 COPYNUM(nb_nonzero);
3714 COPYNUM(nb_invert);
3715 COPYNUM(nb_lshift);
3716 COPYNUM(nb_rshift);
3717 COPYNUM(nb_and);
3718 COPYNUM(nb_xor);
3719 COPYNUM(nb_or);
3720 COPYNUM(nb_coerce);
3721 COPYNUM(nb_int);
3722 COPYNUM(nb_long);
3723 COPYNUM(nb_float);
3724 COPYNUM(nb_oct);
3725 COPYNUM(nb_hex);
3726 COPYNUM(nb_inplace_add);
3727 COPYNUM(nb_inplace_subtract);
3728 COPYNUM(nb_inplace_multiply);
3729 COPYNUM(nb_inplace_divide);
3730 COPYNUM(nb_inplace_remainder);
3731 COPYNUM(nb_inplace_power);
3732 COPYNUM(nb_inplace_lshift);
3733 COPYNUM(nb_inplace_rshift);
3734 COPYNUM(nb_inplace_and);
3735 COPYNUM(nb_inplace_xor);
3736 COPYNUM(nb_inplace_or);
Guido van Rossumdc91b992001-08-08 22:26:22 +00003737 if (base->tp_flags & Py_TPFLAGS_CHECKTYPES) {
3738 COPYNUM(nb_true_divide);
3739 COPYNUM(nb_floor_divide);
3740 COPYNUM(nb_inplace_true_divide);
3741 COPYNUM(nb_inplace_floor_divide);
3742 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +00003743 if (base->tp_flags & Py_TPFLAGS_HAVE_INDEX) {
3744 COPYNUM(nb_index);
3745 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003746 }
3747
Guido van Rossum13d52f02001-08-10 21:24:08 +00003748 if (type->tp_as_sequence != NULL && base->tp_as_sequence != NULL) {
3749 basebase = base->tp_base;
3750 if (basebase->tp_as_sequence == NULL)
3751 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003752 COPYSEQ(sq_length);
3753 COPYSEQ(sq_concat);
3754 COPYSEQ(sq_repeat);
3755 COPYSEQ(sq_item);
3756 COPYSEQ(sq_slice);
3757 COPYSEQ(sq_ass_item);
3758 COPYSEQ(sq_ass_slice);
3759 COPYSEQ(sq_contains);
3760 COPYSEQ(sq_inplace_concat);
3761 COPYSEQ(sq_inplace_repeat);
3762 }
3763
Guido van Rossum13d52f02001-08-10 21:24:08 +00003764 if (type->tp_as_mapping != NULL && base->tp_as_mapping != NULL) {
3765 basebase = base->tp_base;
3766 if (basebase->tp_as_mapping == NULL)
3767 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003768 COPYMAP(mp_length);
3769 COPYMAP(mp_subscript);
3770 COPYMAP(mp_ass_subscript);
3771 }
3772
Tim Petersfc57ccb2001-10-12 02:38:24 +00003773 if (type->tp_as_buffer != NULL && base->tp_as_buffer != NULL) {
3774 basebase = base->tp_base;
3775 if (basebase->tp_as_buffer == NULL)
3776 basebase = NULL;
3777 COPYBUF(bf_getreadbuffer);
3778 COPYBUF(bf_getwritebuffer);
3779 COPYBUF(bf_getsegcount);
3780 COPYBUF(bf_getcharbuffer);
Christian Heimes1a6387e2008-03-26 12:49:49 +00003781 COPYBUF(bf_getbuffer);
3782 COPYBUF(bf_releasebuffer);
Tim Petersfc57ccb2001-10-12 02:38:24 +00003783 }
3784
Guido van Rossum13d52f02001-08-10 21:24:08 +00003785 basebase = base->tp_base;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003786
Tim Peters6d6c1a32001-08-02 04:15:00 +00003787 COPYSLOT(tp_dealloc);
3788 COPYSLOT(tp_print);
3789 if (type->tp_getattr == NULL && type->tp_getattro == NULL) {
3790 type->tp_getattr = base->tp_getattr;
3791 type->tp_getattro = base->tp_getattro;
3792 }
3793 if (type->tp_setattr == NULL && type->tp_setattro == NULL) {
3794 type->tp_setattr = base->tp_setattr;
3795 type->tp_setattro = base->tp_setattro;
3796 }
3797 /* tp_compare see tp_richcompare */
3798 COPYSLOT(tp_repr);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003799 /* tp_hash see tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003800 COPYSLOT(tp_call);
3801 COPYSLOT(tp_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003802 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00003803 if (type->tp_compare == NULL &&
3804 type->tp_richcompare == NULL &&
Guido van Rossum64c06e32007-11-22 00:55:51 +00003805 type->tp_hash == NULL &&
3806 !overrides_hash(type))
Guido van Rossumb8f63662001-08-15 23:57:02 +00003807 {
Tim Peters6d6c1a32001-08-02 04:15:00 +00003808 type->tp_compare = base->tp_compare;
3809 type->tp_richcompare = base->tp_richcompare;
Guido van Rossumb8f63662001-08-15 23:57:02 +00003810 type->tp_hash = base->tp_hash;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003811 }
3812 }
3813 else {
3814 COPYSLOT(tp_compare);
3815 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003816 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_ITER) {
3817 COPYSLOT(tp_iter);
3818 COPYSLOT(tp_iternext);
3819 }
3820 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
3821 COPYSLOT(tp_descr_get);
3822 COPYSLOT(tp_descr_set);
3823 COPYSLOT(tp_dictoffset);
3824 COPYSLOT(tp_init);
3825 COPYSLOT(tp_alloc);
Guido van Rossumcc8fe042002-04-05 17:10:16 +00003826 COPYSLOT(tp_is_gc);
Tim Peters3cfe7542003-05-21 21:29:48 +00003827 if ((type->tp_flags & Py_TPFLAGS_HAVE_GC) ==
3828 (base->tp_flags & Py_TPFLAGS_HAVE_GC)) {
3829 /* They agree about gc. */
3830 COPYSLOT(tp_free);
3831 }
3832 else if ((type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
3833 type->tp_free == NULL &&
3834 base->tp_free == _PyObject_Del) {
3835 /* A bit of magic to plug in the correct default
3836 * tp_free function when a derived class adds gc,
3837 * didn't define tp_free, and the base uses the
3838 * default non-gc tp_free.
3839 */
3840 type->tp_free = PyObject_GC_Del;
3841 }
3842 /* else they didn't agree about gc, and there isn't something
3843 * obvious to be done -- the type is on its own.
3844 */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003845 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003846}
3847
Jeremy Hylton938ace62002-07-17 16:30:39 +00003848static int add_operators(PyTypeObject *);
Guido van Rossum13d52f02001-08-10 21:24:08 +00003849
Tim Peters6d6c1a32001-08-02 04:15:00 +00003850int
Guido van Rossum528b7eb2001-08-07 17:24:28 +00003851PyType_Ready(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003852{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00003853 PyObject *dict, *bases;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003854 PyTypeObject *base;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003855 Py_ssize_t i, n;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003856
Guido van Rossumcab05802002-06-10 15:29:03 +00003857 if (type->tp_flags & Py_TPFLAGS_READY) {
3858 assert(type->tp_dict != NULL);
Guido van Rossumd614f972001-08-10 17:39:49 +00003859 return 0;
Guido van Rossumcab05802002-06-10 15:29:03 +00003860 }
Guido van Rossumd614f972001-08-10 17:39:49 +00003861 assert((type->tp_flags & Py_TPFLAGS_READYING) == 0);
Guido van Rossumd614f972001-08-10 17:39:49 +00003862
3863 type->tp_flags |= Py_TPFLAGS_READYING;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003864
Tim Peters36eb4df2003-03-23 03:33:13 +00003865#ifdef Py_TRACE_REFS
3866 /* PyType_Ready is the closest thing we have to a choke point
3867 * for type objects, so is the best place I can think of to try
3868 * to get type objects into the doubly-linked list of all objects.
3869 * Still, not all type objects go thru PyType_Ready.
3870 */
Tim Peters7571a0f2003-03-23 17:52:28 +00003871 _Py_AddToAllObjects((PyObject *)type, 0);
Tim Peters36eb4df2003-03-23 03:33:13 +00003872#endif
3873
Tim Peters6d6c1a32001-08-02 04:15:00 +00003874 /* Initialize tp_base (defaults to BaseObject unless that's us) */
3875 base = type->tp_base;
Martin v. Löwisbf608752004-08-18 13:16:54 +00003876 if (base == NULL && type != &PyBaseObject_Type) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00003877 base = type->tp_base = &PyBaseObject_Type;
Martin v. Löwisbf608752004-08-18 13:16:54 +00003878 Py_INCREF(base);
3879 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003880
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003881 /* Now the only way base can still be NULL is if type is
3882 * &PyBaseObject_Type.
3883 */
Guido van Rossum692cdbc2006-03-10 02:04:28 +00003884
Guido van Rossum323a9cf2002-08-14 17:26:30 +00003885 /* Initialize the base class */
3886 if (base && base->tp_dict == NULL) {
3887 if (PyType_Ready(base) < 0)
3888 goto error;
3889 }
3890
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003891 /* Initialize ob_type if NULL. This means extensions that want to be
Guido van Rossum0986d822002-04-08 01:38:42 +00003892 compilable separately on Windows can call PyType_Ready() instead of
3893 initializing the ob_type field of their type objects. */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003894 /* The test for base != NULL is really unnecessary, since base is only
3895 NULL when type is &PyBaseObject_Type, and we know its ob_type is
3896 not NULL (it's initialized to &PyType_Type). But coverity doesn't
3897 know that. */
Christian Heimese93237d2007-12-19 02:37:44 +00003898 if (Py_TYPE(type) == NULL && base != NULL)
3899 Py_TYPE(type) = Py_TYPE(base);
Guido van Rossum0986d822002-04-08 01:38:42 +00003900
Tim Peters6d6c1a32001-08-02 04:15:00 +00003901 /* Initialize tp_bases */
3902 bases = type->tp_bases;
3903 if (bases == NULL) {
3904 if (base == NULL)
3905 bases = PyTuple_New(0);
3906 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003907 bases = PyTuple_Pack(1, base);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003908 if (bases == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00003909 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003910 type->tp_bases = bases;
3911 }
3912
Guido van Rossum687ae002001-10-15 22:03:32 +00003913 /* Initialize tp_dict */
3914 dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003915 if (dict == NULL) {
3916 dict = PyDict_New();
3917 if (dict == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00003918 goto error;
Guido van Rossum687ae002001-10-15 22:03:32 +00003919 type->tp_dict = dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003920 }
3921
Guido van Rossum687ae002001-10-15 22:03:32 +00003922 /* Add type-specific descriptors to tp_dict */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003923 if (add_operators(type) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003924 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003925 if (type->tp_methods != NULL) {
3926 if (add_methods(type, type->tp_methods) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003927 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003928 }
3929 if (type->tp_members != NULL) {
3930 if (add_members(type, type->tp_members) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003931 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003932 }
3933 if (type->tp_getset != NULL) {
3934 if (add_getset(type, type->tp_getset) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003935 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003936 }
3937
Tim Peters6d6c1a32001-08-02 04:15:00 +00003938 /* Calculate method resolution order */
3939 if (mro_internal(type) < 0) {
Guido van Rossumd614f972001-08-10 17:39:49 +00003940 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003941 }
3942
Guido van Rossum13d52f02001-08-10 21:24:08 +00003943 /* Inherit special flags from dominant base */
3944 if (type->tp_base != NULL)
3945 inherit_special(type, type->tp_base);
3946
Tim Peters6d6c1a32001-08-02 04:15:00 +00003947 /* Initialize tp_dict properly */
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00003948 bases = type->tp_mro;
3949 assert(bases != NULL);
3950 assert(PyTuple_Check(bases));
3951 n = PyTuple_GET_SIZE(bases);
3952 for (i = 1; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00003953 PyObject *b = PyTuple_GET_ITEM(bases, i);
3954 if (PyType_Check(b))
3955 inherit_slots(type, (PyTypeObject *)b);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003956 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003957
Tim Peters3cfe7542003-05-21 21:29:48 +00003958 /* Sanity check for tp_free. */
3959 if (PyType_IS_GC(type) && (type->tp_flags & Py_TPFLAGS_BASETYPE) &&
3960 (type->tp_free == NULL || type->tp_free == PyObject_Del)) {
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003961 /* This base class needs to call tp_free, but doesn't have
3962 * one, or its tp_free is for non-gc'ed objects.
3963 */
Tim Peters3cfe7542003-05-21 21:29:48 +00003964 PyErr_Format(PyExc_TypeError, "type '%.100s' participates in "
3965 "gc and is a base type but has inappropriate "
3966 "tp_free slot",
3967 type->tp_name);
3968 goto error;
3969 }
3970
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003971 /* if the type dictionary doesn't contain a __doc__, set it from
3972 the tp_doc slot.
3973 */
3974 if (PyDict_GetItemString(type->tp_dict, "__doc__") == NULL) {
3975 if (type->tp_doc != NULL) {
Christian Heimes593daf52008-05-26 12:51:38 +00003976 PyObject *doc = PyBytes_FromString(type->tp_doc);
Neal Norwitze1fdb322006-07-21 05:32:28 +00003977 if (doc == NULL)
3978 goto error;
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003979 PyDict_SetItemString(type->tp_dict, "__doc__", doc);
3980 Py_DECREF(doc);
3981 } else {
Guido van Rossumd4641072002-04-03 02:13:37 +00003982 PyDict_SetItemString(type->tp_dict,
3983 "__doc__", Py_None);
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003984 }
3985 }
3986
Guido van Rossum64c06e32007-11-22 00:55:51 +00003987 /* Hack for tp_hash and __hash__.
3988 If after all that, tp_hash is still NULL, and __hash__ is not in
3989 tp_dict, set tp_dict['__hash__'] equal to None.
3990 This signals that __hash__ is not inherited.
3991 */
3992 if (type->tp_hash == NULL &&
3993 PyDict_GetItemString(type->tp_dict, "__hash__") == NULL &&
3994 PyDict_SetItemString(type->tp_dict, "__hash__", Py_None) < 0)
3995 {
3996 goto error;
3997 }
3998
Guido van Rossum13d52f02001-08-10 21:24:08 +00003999 /* Some more special stuff */
4000 base = type->tp_base;
4001 if (base != NULL) {
4002 if (type->tp_as_number == NULL)
4003 type->tp_as_number = base->tp_as_number;
4004 if (type->tp_as_sequence == NULL)
4005 type->tp_as_sequence = base->tp_as_sequence;
4006 if (type->tp_as_mapping == NULL)
4007 type->tp_as_mapping = base->tp_as_mapping;
Guido van Rossumeea47182003-02-11 20:39:59 +00004008 if (type->tp_as_buffer == NULL)
4009 type->tp_as_buffer = base->tp_as_buffer;
Guido van Rossum13d52f02001-08-10 21:24:08 +00004010 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004011
Guido van Rossum1c450732001-10-08 15:18:27 +00004012 /* Link into each base class's list of subclasses */
4013 bases = type->tp_bases;
4014 n = PyTuple_GET_SIZE(bases);
4015 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00004016 PyObject *b = PyTuple_GET_ITEM(bases, i);
4017 if (PyType_Check(b) &&
4018 add_subclass((PyTypeObject *)b, type) < 0)
Guido van Rossum1c450732001-10-08 15:18:27 +00004019 goto error;
4020 }
4021
Guido van Rossum13d52f02001-08-10 21:24:08 +00004022 /* All done -- set the ready flag */
Guido van Rossumd614f972001-08-10 17:39:49 +00004023 assert(type->tp_dict != NULL);
4024 type->tp_flags =
4025 (type->tp_flags & ~Py_TPFLAGS_READYING) | Py_TPFLAGS_READY;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004026 return 0;
Guido van Rossumd614f972001-08-10 17:39:49 +00004027
4028 error:
4029 type->tp_flags &= ~Py_TPFLAGS_READYING;
4030 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004031}
4032
Guido van Rossum1c450732001-10-08 15:18:27 +00004033static int
4034add_subclass(PyTypeObject *base, PyTypeObject *type)
4035{
Martin v. Löwiseb079f12006-02-16 14:32:27 +00004036 Py_ssize_t i;
4037 int result;
Anthony Baxtera6286212006-04-11 07:42:36 +00004038 PyObject *list, *ref, *newobj;
Guido van Rossum1c450732001-10-08 15:18:27 +00004039
4040 list = base->tp_subclasses;
4041 if (list == NULL) {
4042 base->tp_subclasses = list = PyList_New(0);
4043 if (list == NULL)
4044 return -1;
4045 }
4046 assert(PyList_Check(list));
Anthony Baxtera6286212006-04-11 07:42:36 +00004047 newobj = PyWeakref_NewRef((PyObject *)type, NULL);
Guido van Rossum1c450732001-10-08 15:18:27 +00004048 i = PyList_GET_SIZE(list);
4049 while (--i >= 0) {
4050 ref = PyList_GET_ITEM(list, i);
4051 assert(PyWeakref_CheckRef(ref));
Guido van Rossum3930bc32002-10-18 13:51:49 +00004052 if (PyWeakref_GET_OBJECT(ref) == Py_None)
Anthony Baxtera6286212006-04-11 07:42:36 +00004053 return PyList_SetItem(list, i, newobj);
Guido van Rossum1c450732001-10-08 15:18:27 +00004054 }
Anthony Baxtera6286212006-04-11 07:42:36 +00004055 result = PyList_Append(list, newobj);
4056 Py_DECREF(newobj);
Martin v. Löwiseb079f12006-02-16 14:32:27 +00004057 return result;
Guido van Rossum1c450732001-10-08 15:18:27 +00004058}
4059
Michael W. Hudson98bbc492002-11-26 14:47:27 +00004060static void
4061remove_subclass(PyTypeObject *base, PyTypeObject *type)
4062{
Martin v. Löwis18e16552006-02-15 17:27:45 +00004063 Py_ssize_t i;
Michael W. Hudson98bbc492002-11-26 14:47:27 +00004064 PyObject *list, *ref;
4065
4066 list = base->tp_subclasses;
4067 if (list == NULL) {
4068 return;
4069 }
4070 assert(PyList_Check(list));
4071 i = PyList_GET_SIZE(list);
4072 while (--i >= 0) {
4073 ref = PyList_GET_ITEM(list, i);
4074 assert(PyWeakref_CheckRef(ref));
4075 if (PyWeakref_GET_OBJECT(ref) == (PyObject*)type) {
4076 /* this can't fail, right? */
4077 PySequence_DelItem(list, i);
4078 return;
4079 }
4080 }
4081}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004082
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004083static int
4084check_num_args(PyObject *ob, int n)
4085{
4086 if (!PyTuple_CheckExact(ob)) {
4087 PyErr_SetString(PyExc_SystemError,
4088 "PyArg_UnpackTuple() argument list is not a tuple");
4089 return 0;
4090 }
4091 if (n == PyTuple_GET_SIZE(ob))
4092 return 1;
4093 PyErr_Format(
4094 PyExc_TypeError,
Martin v. Löwis2c95cc62006-02-16 06:54:25 +00004095 "expected %d arguments, got %zd", n, PyTuple_GET_SIZE(ob));
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004096 return 0;
4097}
4098
Tim Peters6d6c1a32001-08-02 04:15:00 +00004099/* Generic wrappers for overloadable 'operators' such as __getitem__ */
4100
4101/* There's a wrapper *function* for each distinct function typedef used
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00004102 for type object slots (e.g. binaryfunc, ternaryfunc, etc.). There's a
Tim Peters6d6c1a32001-08-02 04:15:00 +00004103 wrapper *table* for each distinct operation (e.g. __len__, __add__).
4104 Most tables have only one entry; the tables for binary operators have two
4105 entries, one regular and one with reversed arguments. */
4106
4107static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00004108wrap_lenfunc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004109{
Martin v. Löwis18e16552006-02-15 17:27:45 +00004110 lenfunc func = (lenfunc)wrapped;
4111 Py_ssize_t res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004112
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004113 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004114 return NULL;
4115 res = (*func)(self);
4116 if (res == -1 && PyErr_Occurred())
4117 return NULL;
4118 return PyInt_FromLong((long)res);
4119}
4120
Tim Peters6d6c1a32001-08-02 04:15:00 +00004121static PyObject *
Raymond Hettingerf34f2642003-10-11 17:29:04 +00004122wrap_inquirypred(PyObject *self, PyObject *args, void *wrapped)
4123{
4124 inquiry func = (inquiry)wrapped;
4125 int res;
4126
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004127 if (!check_num_args(args, 0))
Raymond Hettingerf34f2642003-10-11 17:29:04 +00004128 return NULL;
4129 res = (*func)(self);
4130 if (res == -1 && PyErr_Occurred())
4131 return NULL;
4132 return PyBool_FromLong((long)res);
4133}
4134
4135static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00004136wrap_binaryfunc(PyObject *self, PyObject *args, void *wrapped)
4137{
4138 binaryfunc func = (binaryfunc)wrapped;
4139 PyObject *other;
4140
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004141 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004142 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004143 other = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004144 return (*func)(self, other);
4145}
4146
4147static PyObject *
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00004148wrap_binaryfunc_l(PyObject *self, PyObject *args, void *wrapped)
4149{
4150 binaryfunc func = (binaryfunc)wrapped;
4151 PyObject *other;
4152
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004153 if (!check_num_args(args, 1))
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00004154 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004155 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00004156 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004157 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00004158 Py_INCREF(Py_NotImplemented);
4159 return Py_NotImplemented;
4160 }
4161 return (*func)(self, other);
4162}
4163
4164static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00004165wrap_binaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
4166{
4167 binaryfunc func = (binaryfunc)wrapped;
4168 PyObject *other;
4169
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004170 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004171 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004172 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00004173 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004174 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00004175 Py_INCREF(Py_NotImplemented);
4176 return Py_NotImplemented;
4177 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004178 return (*func)(other, self);
4179}
4180
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004181static PyObject *
4182wrap_coercefunc(PyObject *self, PyObject *args, void *wrapped)
4183{
4184 coercion func = (coercion)wrapped;
4185 PyObject *other, *res;
4186 int ok;
4187
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004188 if (!check_num_args(args, 1))
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004189 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004190 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004191 ok = func(&self, &other);
4192 if (ok < 0)
4193 return NULL;
4194 if (ok > 0) {
4195 Py_INCREF(Py_NotImplemented);
4196 return Py_NotImplemented;
4197 }
4198 res = PyTuple_New(2);
4199 if (res == NULL) {
4200 Py_DECREF(self);
4201 Py_DECREF(other);
4202 return NULL;
4203 }
4204 PyTuple_SET_ITEM(res, 0, self);
4205 PyTuple_SET_ITEM(res, 1, other);
4206 return res;
4207}
4208
Tim Peters6d6c1a32001-08-02 04:15:00 +00004209static PyObject *
4210wrap_ternaryfunc(PyObject *self, PyObject *args, void *wrapped)
4211{
4212 ternaryfunc func = (ternaryfunc)wrapped;
4213 PyObject *other;
4214 PyObject *third = Py_None;
4215
4216 /* Note: This wrapper only works for __pow__() */
4217
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00004218 if (!PyArg_UnpackTuple(args, "", 1, 2, &other, &third))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004219 return NULL;
4220 return (*func)(self, other, third);
4221}
4222
Guido van Rossum9bea3ab2001-09-28 22:58:52 +00004223static PyObject *
4224wrap_ternaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
4225{
4226 ternaryfunc func = (ternaryfunc)wrapped;
4227 PyObject *other;
4228 PyObject *third = Py_None;
4229
4230 /* Note: This wrapper only works for __pow__() */
4231
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00004232 if (!PyArg_UnpackTuple(args, "", 1, 2, &other, &third))
Guido van Rossum9bea3ab2001-09-28 22:58:52 +00004233 return NULL;
4234 return (*func)(other, self, third);
4235}
4236
Tim Peters6d6c1a32001-08-02 04:15:00 +00004237static PyObject *
4238wrap_unaryfunc(PyObject *self, PyObject *args, void *wrapped)
4239{
4240 unaryfunc func = (unaryfunc)wrapped;
4241
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004242 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004243 return NULL;
4244 return (*func)(self);
4245}
4246
Tim Peters6d6c1a32001-08-02 04:15:00 +00004247static PyObject *
Armin Rigo314861c2006-03-30 14:04:02 +00004248wrap_indexargfunc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004249{
Martin v. Löwis18e16552006-02-15 17:27:45 +00004250 ssizeargfunc func = (ssizeargfunc)wrapped;
Armin Rigo314861c2006-03-30 14:04:02 +00004251 PyObject* o;
Martin v. Löwis18e16552006-02-15 17:27:45 +00004252 Py_ssize_t i;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004253
Armin Rigo314861c2006-03-30 14:04:02 +00004254 if (!PyArg_UnpackTuple(args, "", 1, 1, &o))
4255 return NULL;
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00004256 i = PyNumber_AsSsize_t(o, PyExc_OverflowError);
Armin Rigo314861c2006-03-30 14:04:02 +00004257 if (i == -1 && PyErr_Occurred())
Tim Peters6d6c1a32001-08-02 04:15:00 +00004258 return NULL;
4259 return (*func)(self, i);
4260}
4261
Martin v. Löwis18e16552006-02-15 17:27:45 +00004262static Py_ssize_t
Guido van Rossum5d815f32001-08-17 21:57:47 +00004263getindex(PyObject *self, PyObject *arg)
4264{
Martin v. Löwis18e16552006-02-15 17:27:45 +00004265 Py_ssize_t i;
Guido van Rossum5d815f32001-08-17 21:57:47 +00004266
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00004267 i = PyNumber_AsSsize_t(arg, PyExc_OverflowError);
Guido van Rossum5d815f32001-08-17 21:57:47 +00004268 if (i == -1 && PyErr_Occurred())
4269 return -1;
4270 if (i < 0) {
Christian Heimese93237d2007-12-19 02:37:44 +00004271 PySequenceMethods *sq = Py_TYPE(self)->tp_as_sequence;
Guido van Rossum5d815f32001-08-17 21:57:47 +00004272 if (sq && sq->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00004273 Py_ssize_t n = (*sq->sq_length)(self);
Guido van Rossum5d815f32001-08-17 21:57:47 +00004274 if (n < 0)
4275 return -1;
4276 i += n;
4277 }
4278 }
4279 return i;
4280}
4281
4282static PyObject *
4283wrap_sq_item(PyObject *self, PyObject *args, void *wrapped)
4284{
Martin v. Löwis18e16552006-02-15 17:27:45 +00004285 ssizeargfunc func = (ssizeargfunc)wrapped;
Guido van Rossum5d815f32001-08-17 21:57:47 +00004286 PyObject *arg;
Martin v. Löwis18e16552006-02-15 17:27:45 +00004287 Py_ssize_t i;
Guido van Rossum5d815f32001-08-17 21:57:47 +00004288
Guido van Rossumf4593e02001-10-03 12:09:30 +00004289 if (PyTuple_GET_SIZE(args) == 1) {
4290 arg = PyTuple_GET_ITEM(args, 0);
4291 i = getindex(self, arg);
4292 if (i == -1 && PyErr_Occurred())
4293 return NULL;
4294 return (*func)(self, i);
4295 }
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004296 check_num_args(args, 1);
Guido van Rossumf4593e02001-10-03 12:09:30 +00004297 assert(PyErr_Occurred());
4298 return NULL;
Guido van Rossum5d815f32001-08-17 21:57:47 +00004299}
4300
Tim Peters6d6c1a32001-08-02 04:15:00 +00004301static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00004302wrap_ssizessizeargfunc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004303{
Martin v. Löwis18e16552006-02-15 17:27:45 +00004304 ssizessizeargfunc func = (ssizessizeargfunc)wrapped;
4305 Py_ssize_t i, j;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004306
Martin v. Löwis18e16552006-02-15 17:27:45 +00004307 if (!PyArg_ParseTuple(args, "nn", &i, &j))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004308 return NULL;
4309 return (*func)(self, i, j);
4310}
4311
Tim Peters6d6c1a32001-08-02 04:15:00 +00004312static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00004313wrap_sq_setitem(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004314{
Martin v. Löwis18e16552006-02-15 17:27:45 +00004315 ssizeobjargproc func = (ssizeobjargproc)wrapped;
4316 Py_ssize_t i;
4317 int res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00004318 PyObject *arg, *value;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004319
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00004320 if (!PyArg_UnpackTuple(args, "", 2, 2, &arg, &value))
Guido van Rossum5d815f32001-08-17 21:57:47 +00004321 return NULL;
4322 i = getindex(self, arg);
4323 if (i == -1 && PyErr_Occurred())
Tim Peters6d6c1a32001-08-02 04:15:00 +00004324 return NULL;
4325 res = (*func)(self, i, value);
4326 if (res == -1 && PyErr_Occurred())
4327 return NULL;
4328 Py_INCREF(Py_None);
4329 return Py_None;
4330}
4331
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00004332static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00004333wrap_sq_delitem(PyObject *self, PyObject *args, void *wrapped)
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00004334{
Martin v. Löwis18e16552006-02-15 17:27:45 +00004335 ssizeobjargproc func = (ssizeobjargproc)wrapped;
4336 Py_ssize_t i;
4337 int res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00004338 PyObject *arg;
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00004339
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004340 if (!check_num_args(args, 1))
Guido van Rossum5d815f32001-08-17 21:57:47 +00004341 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004342 arg = PyTuple_GET_ITEM(args, 0);
Guido van Rossum5d815f32001-08-17 21:57:47 +00004343 i = getindex(self, arg);
4344 if (i == -1 && PyErr_Occurred())
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00004345 return NULL;
4346 res = (*func)(self, i, NULL);
4347 if (res == -1 && PyErr_Occurred())
4348 return NULL;
4349 Py_INCREF(Py_None);
4350 return Py_None;
4351}
4352
Tim Peters6d6c1a32001-08-02 04:15:00 +00004353static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00004354wrap_ssizessizeobjargproc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004355{
Martin v. Löwis18e16552006-02-15 17:27:45 +00004356 ssizessizeobjargproc func = (ssizessizeobjargproc)wrapped;
4357 Py_ssize_t i, j;
4358 int res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004359 PyObject *value;
4360
Martin v. Löwis18e16552006-02-15 17:27:45 +00004361 if (!PyArg_ParseTuple(args, "nnO", &i, &j, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004362 return NULL;
4363 res = (*func)(self, i, j, value);
4364 if (res == -1 && PyErr_Occurred())
4365 return NULL;
4366 Py_INCREF(Py_None);
4367 return Py_None;
4368}
4369
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004370static PyObject *
4371wrap_delslice(PyObject *self, PyObject *args, void *wrapped)
4372{
Martin v. Löwis18e16552006-02-15 17:27:45 +00004373 ssizessizeobjargproc func = (ssizessizeobjargproc)wrapped;
4374 Py_ssize_t i, j;
4375 int res;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004376
Martin v. Löwis18e16552006-02-15 17:27:45 +00004377 if (!PyArg_ParseTuple(args, "nn", &i, &j))
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004378 return NULL;
4379 res = (*func)(self, i, j, NULL);
4380 if (res == -1 && PyErr_Occurred())
4381 return NULL;
4382 Py_INCREF(Py_None);
4383 return Py_None;
4384}
4385
Tim Peters6d6c1a32001-08-02 04:15:00 +00004386/* XXX objobjproc is a misnomer; should be objargpred */
4387static PyObject *
4388wrap_objobjproc(PyObject *self, PyObject *args, void *wrapped)
4389{
4390 objobjproc func = (objobjproc)wrapped;
4391 int res;
Guido van Rossum22c3dda2003-10-09 03:46:35 +00004392 PyObject *value;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004393
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004394 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004395 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004396 value = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004397 res = (*func)(self, value);
4398 if (res == -1 && PyErr_Occurred())
4399 return NULL;
Guido van Rossum22c3dda2003-10-09 03:46:35 +00004400 else
4401 return PyBool_FromLong(res);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004402}
4403
Tim Peters6d6c1a32001-08-02 04:15:00 +00004404static PyObject *
4405wrap_objobjargproc(PyObject *self, PyObject *args, void *wrapped)
4406{
4407 objobjargproc func = (objobjargproc)wrapped;
4408 int res;
4409 PyObject *key, *value;
4410
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00004411 if (!PyArg_UnpackTuple(args, "", 2, 2, &key, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004412 return NULL;
4413 res = (*func)(self, key, value);
4414 if (res == -1 && PyErr_Occurred())
4415 return NULL;
4416 Py_INCREF(Py_None);
4417 return Py_None;
4418}
4419
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00004420static PyObject *
4421wrap_delitem(PyObject *self, PyObject *args, void *wrapped)
4422{
4423 objobjargproc func = (objobjargproc)wrapped;
4424 int res;
4425 PyObject *key;
4426
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004427 if (!check_num_args(args, 1))
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00004428 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004429 key = PyTuple_GET_ITEM(args, 0);
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00004430 res = (*func)(self, key, NULL);
4431 if (res == -1 && PyErr_Occurred())
4432 return NULL;
4433 Py_INCREF(Py_None);
4434 return Py_None;
4435}
4436
Tim Peters6d6c1a32001-08-02 04:15:00 +00004437static PyObject *
4438wrap_cmpfunc(PyObject *self, PyObject *args, void *wrapped)
4439{
4440 cmpfunc func = (cmpfunc)wrapped;
4441 int res;
4442 PyObject *other;
4443
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004444 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004445 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004446 other = PyTuple_GET_ITEM(args, 0);
Christian Heimese93237d2007-12-19 02:37:44 +00004447 if (Py_TYPE(other)->tp_compare != func &&
4448 !PyType_IsSubtype(Py_TYPE(other), Py_TYPE(self))) {
Guido van Rossumceccae52001-09-18 20:03:57 +00004449 PyErr_Format(
4450 PyExc_TypeError,
4451 "%s.__cmp__(x,y) requires y to be a '%s', not a '%s'",
Christian Heimese93237d2007-12-19 02:37:44 +00004452 Py_TYPE(self)->tp_name,
4453 Py_TYPE(self)->tp_name,
4454 Py_TYPE(other)->tp_name);
Guido van Rossumceccae52001-09-18 20:03:57 +00004455 return NULL;
4456 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004457 res = (*func)(self, other);
4458 if (PyErr_Occurred())
4459 return NULL;
4460 return PyInt_FromLong((long)res);
4461}
4462
Guido van Rossum4dcdb782003-04-14 21:46:03 +00004463/* Helper to check for object.__setattr__ or __delattr__ applied to a type.
Guido van Rossum52b27052003-04-15 20:05:10 +00004464 This is called the Carlo Verre hack after its discoverer. */
Guido van Rossum4dcdb782003-04-14 21:46:03 +00004465static int
4466hackcheck(PyObject *self, setattrofunc func, char *what)
4467{
Christian Heimese93237d2007-12-19 02:37:44 +00004468 PyTypeObject *type = Py_TYPE(self);
Guido van Rossum4dcdb782003-04-14 21:46:03 +00004469 while (type && type->tp_flags & Py_TPFLAGS_HEAPTYPE)
4470 type = type->tp_base;
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00004471 /* If type is NULL now, this is a really weird type.
4472 In the spirit of backwards compatibility (?), just shut up. */
Guido van Rossum692cdbc2006-03-10 02:04:28 +00004473 if (type && type->tp_setattro != func) {
Guido van Rossum4dcdb782003-04-14 21:46:03 +00004474 PyErr_Format(PyExc_TypeError,
4475 "can't apply this %s to %s object",
4476 what,
4477 type->tp_name);
4478 return 0;
4479 }
4480 return 1;
4481}
4482
Tim Peters6d6c1a32001-08-02 04:15:00 +00004483static PyObject *
4484wrap_setattr(PyObject *self, PyObject *args, void *wrapped)
4485{
4486 setattrofunc func = (setattrofunc)wrapped;
4487 int res;
4488 PyObject *name, *value;
4489
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00004490 if (!PyArg_UnpackTuple(args, "", 2, 2, &name, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004491 return NULL;
Guido van Rossum4dcdb782003-04-14 21:46:03 +00004492 if (!hackcheck(self, func, "__setattr__"))
4493 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004494 res = (*func)(self, name, value);
4495 if (res < 0)
4496 return NULL;
4497 Py_INCREF(Py_None);
4498 return Py_None;
4499}
4500
4501static PyObject *
4502wrap_delattr(PyObject *self, PyObject *args, void *wrapped)
4503{
4504 setattrofunc func = (setattrofunc)wrapped;
4505 int res;
4506 PyObject *name;
4507
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004508 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004509 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004510 name = PyTuple_GET_ITEM(args, 0);
Guido van Rossum4dcdb782003-04-14 21:46:03 +00004511 if (!hackcheck(self, func, "__delattr__"))
4512 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004513 res = (*func)(self, name, NULL);
4514 if (res < 0)
4515 return NULL;
4516 Py_INCREF(Py_None);
4517 return Py_None;
4518}
4519
Tim Peters6d6c1a32001-08-02 04:15:00 +00004520static PyObject *
4521wrap_hashfunc(PyObject *self, PyObject *args, void *wrapped)
4522{
4523 hashfunc func = (hashfunc)wrapped;
4524 long res;
4525
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004526 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004527 return NULL;
4528 res = (*func)(self);
4529 if (res == -1 && PyErr_Occurred())
4530 return NULL;
4531 return PyInt_FromLong(res);
4532}
4533
Tim Peters6d6c1a32001-08-02 04:15:00 +00004534static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00004535wrap_call(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004536{
4537 ternaryfunc func = (ternaryfunc)wrapped;
4538
Guido van Rossumc8e56452001-10-22 00:43:43 +00004539 return (*func)(self, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004540}
4541
Tim Peters6d6c1a32001-08-02 04:15:00 +00004542static PyObject *
4543wrap_richcmpfunc(PyObject *self, PyObject *args, void *wrapped, int op)
4544{
4545 richcmpfunc func = (richcmpfunc)wrapped;
4546 PyObject *other;
4547
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004548 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004549 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004550 other = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004551 return (*func)(self, other, op);
4552}
4553
4554#undef RICHCMP_WRAPPER
4555#define RICHCMP_WRAPPER(NAME, OP) \
4556static PyObject * \
4557richcmp_##NAME(PyObject *self, PyObject *args, void *wrapped) \
4558{ \
4559 return wrap_richcmpfunc(self, args, wrapped, OP); \
4560}
4561
Jack Jansen8e938b42001-08-08 15:29:49 +00004562RICHCMP_WRAPPER(lt, Py_LT)
4563RICHCMP_WRAPPER(le, Py_LE)
4564RICHCMP_WRAPPER(eq, Py_EQ)
4565RICHCMP_WRAPPER(ne, Py_NE)
4566RICHCMP_WRAPPER(gt, Py_GT)
4567RICHCMP_WRAPPER(ge, Py_GE)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004568
Tim Peters6d6c1a32001-08-02 04:15:00 +00004569static PyObject *
4570wrap_next(PyObject *self, PyObject *args, void *wrapped)
4571{
4572 unaryfunc func = (unaryfunc)wrapped;
4573 PyObject *res;
4574
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004575 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004576 return NULL;
4577 res = (*func)(self);
4578 if (res == NULL && !PyErr_Occurred())
4579 PyErr_SetNone(PyExc_StopIteration);
4580 return res;
4581}
4582
Tim Peters6d6c1a32001-08-02 04:15:00 +00004583static PyObject *
4584wrap_descr_get(PyObject *self, PyObject *args, void *wrapped)
4585{
4586 descrgetfunc func = (descrgetfunc)wrapped;
4587 PyObject *obj;
4588 PyObject *type = NULL;
4589
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00004590 if (!PyArg_UnpackTuple(args, "", 1, 2, &obj, &type))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004591 return NULL;
Guido van Rossum82ed25c2003-02-11 16:25:43 +00004592 if (obj == Py_None)
4593 obj = NULL;
4594 if (type == Py_None)
4595 type = NULL;
4596 if (type == NULL &&obj == NULL) {
4597 PyErr_SetString(PyExc_TypeError,
4598 "__get__(None, None) is invalid");
4599 return NULL;
4600 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004601 return (*func)(self, obj, type);
4602}
4603
Tim Peters6d6c1a32001-08-02 04:15:00 +00004604static PyObject *
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004605wrap_descr_set(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004606{
4607 descrsetfunc func = (descrsetfunc)wrapped;
4608 PyObject *obj, *value;
4609 int ret;
4610
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00004611 if (!PyArg_UnpackTuple(args, "", 2, 2, &obj, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004612 return NULL;
4613 ret = (*func)(self, obj, value);
4614 if (ret < 0)
4615 return NULL;
4616 Py_INCREF(Py_None);
4617 return Py_None;
4618}
Guido van Rossum22b13872002-08-06 21:41:44 +00004619
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00004620static PyObject *
4621wrap_descr_delete(PyObject *self, PyObject *args, void *wrapped)
4622{
4623 descrsetfunc func = (descrsetfunc)wrapped;
4624 PyObject *obj;
4625 int ret;
4626
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004627 if (!check_num_args(args, 1))
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00004628 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004629 obj = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00004630 ret = (*func)(self, obj, NULL);
4631 if (ret < 0)
4632 return NULL;
4633 Py_INCREF(Py_None);
4634 return Py_None;
4635}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004636
Tim Peters6d6c1a32001-08-02 04:15:00 +00004637static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00004638wrap_init(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004639{
4640 initproc func = (initproc)wrapped;
4641
Guido van Rossumc8e56452001-10-22 00:43:43 +00004642 if (func(self, args, kwds) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004643 return NULL;
4644 Py_INCREF(Py_None);
4645 return Py_None;
4646}
4647
Tim Peters6d6c1a32001-08-02 04:15:00 +00004648static PyObject *
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004649tp_new_wrapper(PyObject *self, PyObject *args, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004650{
Barry Warsaw60f01882001-08-22 19:24:42 +00004651 PyTypeObject *type, *subtype, *staticbase;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004652 PyObject *arg0, *res;
4653
4654 if (self == NULL || !PyType_Check(self))
4655 Py_FatalError("__new__() called with non-type 'self'");
4656 type = (PyTypeObject *)self;
4657 if (!PyTuple_Check(args) || PyTuple_GET_SIZE(args) < 1) {
Barry Warsaw60f01882001-08-22 19:24:42 +00004658 PyErr_Format(PyExc_TypeError,
4659 "%s.__new__(): not enough arguments",
4660 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004661 return NULL;
4662 }
4663 arg0 = PyTuple_GET_ITEM(args, 0);
4664 if (!PyType_Check(arg0)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00004665 PyErr_Format(PyExc_TypeError,
4666 "%s.__new__(X): X is not a type object (%s)",
4667 type->tp_name,
Christian Heimese93237d2007-12-19 02:37:44 +00004668 Py_TYPE(arg0)->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004669 return NULL;
4670 }
4671 subtype = (PyTypeObject *)arg0;
4672 if (!PyType_IsSubtype(subtype, type)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00004673 PyErr_Format(PyExc_TypeError,
4674 "%s.__new__(%s): %s is not a subtype of %s",
4675 type->tp_name,
4676 subtype->tp_name,
4677 subtype->tp_name,
4678 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004679 return NULL;
4680 }
Barry Warsaw60f01882001-08-22 19:24:42 +00004681
4682 /* Check that the use doesn't do something silly and unsafe like
Tim Petersa427a2b2001-10-29 22:25:45 +00004683 object.__new__(dict). To do this, we check that the
Barry Warsaw60f01882001-08-22 19:24:42 +00004684 most derived base that's not a heap type is this type. */
4685 staticbase = subtype;
4686 while (staticbase && (staticbase->tp_flags & Py_TPFLAGS_HEAPTYPE))
4687 staticbase = staticbase->tp_base;
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00004688 /* If staticbase is NULL now, it is a really weird type.
4689 In the spirit of backwards compatibility (?), just shut up. */
Guido van Rossum692cdbc2006-03-10 02:04:28 +00004690 if (staticbase && staticbase->tp_new != type->tp_new) {
Barry Warsaw60f01882001-08-22 19:24:42 +00004691 PyErr_Format(PyExc_TypeError,
4692 "%s.__new__(%s) is not safe, use %s.__new__()",
4693 type->tp_name,
4694 subtype->tp_name,
4695 staticbase == NULL ? "?" : staticbase->tp_name);
4696 return NULL;
4697 }
4698
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004699 args = PyTuple_GetSlice(args, 1, PyTuple_GET_SIZE(args));
4700 if (args == NULL)
4701 return NULL;
4702 res = type->tp_new(subtype, args, kwds);
4703 Py_DECREF(args);
4704 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004705}
4706
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004707static struct PyMethodDef tp_new_methoddef[] = {
Neal Norwitza84dcd72007-05-22 07:16:44 +00004708 {"__new__", (PyCFunction)tp_new_wrapper, METH_VARARGS|METH_KEYWORDS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00004709 PyDoc_STR("T.__new__(S, ...) -> "
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00004710 "a new object with type S, a subtype of T")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00004711 {0}
4712};
4713
4714static int
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004715add_tp_new_wrapper(PyTypeObject *type)
4716{
Guido van Rossumf040ede2001-08-07 16:40:56 +00004717 PyObject *func;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004718
Guido van Rossum687ae002001-10-15 22:03:32 +00004719 if (PyDict_GetItemString(type->tp_dict, "__new__") != NULL)
Guido van Rossumf040ede2001-08-07 16:40:56 +00004720 return 0;
4721 func = PyCFunction_New(tp_new_methoddef, (PyObject *)type);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004722 if (func == NULL)
4723 return -1;
Raymond Hettinger8d726ee2004-06-25 22:24:35 +00004724 if (PyDict_SetItemString(type->tp_dict, "__new__", func)) {
Raymond Hettingerd56cbe52004-06-25 22:17:39 +00004725 Py_DECREF(func);
4726 return -1;
4727 }
4728 Py_DECREF(func);
4729 return 0;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004730}
4731
Guido van Rossumf040ede2001-08-07 16:40:56 +00004732/* Slot wrappers that call the corresponding __foo__ slot. See comments
4733 below at override_slots() for more explanation. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004734
Guido van Rossumdc91b992001-08-08 22:26:22 +00004735#define SLOT0(FUNCNAME, OPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004736static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004737FUNCNAME(PyObject *self) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004738{ \
Guido van Rossum5592e4d2001-08-28 18:28:21 +00004739 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00004740 return call_method(self, OPSTR, &cache_str, "()"); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004741}
4742
Guido van Rossumdc91b992001-08-08 22:26:22 +00004743#define SLOT1(FUNCNAME, OPSTR, ARG1TYPE, ARGCODES) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004744static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004745FUNCNAME(PyObject *self, ARG1TYPE arg1) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004746{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004747 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00004748 return call_method(self, OPSTR, &cache_str, "(" ARGCODES ")", arg1); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004749}
4750
Guido van Rossumcd118802003-01-06 22:57:47 +00004751/* Boolean helper for SLOT1BINFULL().
4752 right.__class__ is a nontrivial subclass of left.__class__. */
4753static int
4754method_is_overloaded(PyObject *left, PyObject *right, char *name)
4755{
4756 PyObject *a, *b;
4757 int ok;
4758
Christian Heimese93237d2007-12-19 02:37:44 +00004759 b = PyObject_GetAttrString((PyObject *)(Py_TYPE(right)), name);
Guido van Rossumcd118802003-01-06 22:57:47 +00004760 if (b == NULL) {
4761 PyErr_Clear();
4762 /* If right doesn't have it, it's not overloaded */
4763 return 0;
4764 }
4765
Christian Heimese93237d2007-12-19 02:37:44 +00004766 a = PyObject_GetAttrString((PyObject *)(Py_TYPE(left)), name);
Guido van Rossumcd118802003-01-06 22:57:47 +00004767 if (a == NULL) {
4768 PyErr_Clear();
4769 Py_DECREF(b);
4770 /* If right has it but left doesn't, it's overloaded */
4771 return 1;
4772 }
4773
4774 ok = PyObject_RichCompareBool(a, b, Py_NE);
4775 Py_DECREF(a);
4776 Py_DECREF(b);
4777 if (ok < 0) {
4778 PyErr_Clear();
4779 return 0;
4780 }
4781
4782 return ok;
4783}
4784
Guido van Rossumdc91b992001-08-08 22:26:22 +00004785
4786#define SLOT1BINFULL(FUNCNAME, TESTFUNC, SLOTNAME, OPSTR, ROPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004787static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004788FUNCNAME(PyObject *self, PyObject *other) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004789{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004790 static PyObject *cache_str, *rcache_str; \
Christian Heimese93237d2007-12-19 02:37:44 +00004791 int do_other = Py_TYPE(self) != Py_TYPE(other) && \
4792 Py_TYPE(other)->tp_as_number != NULL && \
4793 Py_TYPE(other)->tp_as_number->SLOTNAME == TESTFUNC; \
4794 if (Py_TYPE(self)->tp_as_number != NULL && \
4795 Py_TYPE(self)->tp_as_number->SLOTNAME == TESTFUNC) { \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004796 PyObject *r; \
Guido van Rossum55f20992001-10-01 17:18:22 +00004797 if (do_other && \
Christian Heimese93237d2007-12-19 02:37:44 +00004798 PyType_IsSubtype(Py_TYPE(other), Py_TYPE(self)) && \
Guido van Rossumcd118802003-01-06 22:57:47 +00004799 method_is_overloaded(self, other, ROPSTR)) { \
Guido van Rossum55f20992001-10-01 17:18:22 +00004800 r = call_maybe( \
4801 other, ROPSTR, &rcache_str, "(O)", self); \
4802 if (r != Py_NotImplemented) \
4803 return r; \
4804 Py_DECREF(r); \
4805 do_other = 0; \
4806 } \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00004807 r = call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00004808 self, OPSTR, &cache_str, "(O)", other); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004809 if (r != Py_NotImplemented || \
Christian Heimese93237d2007-12-19 02:37:44 +00004810 Py_TYPE(other) == Py_TYPE(self)) \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004811 return r; \
4812 Py_DECREF(r); \
4813 } \
Guido van Rossum55f20992001-10-01 17:18:22 +00004814 if (do_other) { \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00004815 return call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00004816 other, ROPSTR, &rcache_str, "(O)", self); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004817 } \
4818 Py_INCREF(Py_NotImplemented); \
4819 return Py_NotImplemented; \
4820}
4821
4822#define SLOT1BIN(FUNCNAME, SLOTNAME, OPSTR, ROPSTR) \
4823 SLOT1BINFULL(FUNCNAME, FUNCNAME, SLOTNAME, OPSTR, ROPSTR)
4824
4825#define SLOT2(FUNCNAME, OPSTR, ARG1TYPE, ARG2TYPE, ARGCODES) \
4826static PyObject * \
4827FUNCNAME(PyObject *self, ARG1TYPE arg1, ARG2TYPE arg2) \
4828{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004829 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00004830 return call_method(self, OPSTR, &cache_str, \
4831 "(" ARGCODES ")", arg1, arg2); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004832}
4833
Martin v. Löwis18e16552006-02-15 17:27:45 +00004834static Py_ssize_t
Tim Peters6d6c1a32001-08-02 04:15:00 +00004835slot_sq_length(PyObject *self)
4836{
Guido van Rossum2730b132001-08-28 18:22:14 +00004837 static PyObject *len_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00004838 PyObject *res = call_method(self, "__len__", &len_str, "()");
Martin v. Löwis18e16552006-02-15 17:27:45 +00004839 Py_ssize_t len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004840
4841 if (res == NULL)
4842 return -1;
Neal Norwitz1872b1c2006-08-12 18:44:06 +00004843 len = PyInt_AsSsize_t(res);
Guido van Rossum26111622001-10-01 16:42:49 +00004844 Py_DECREF(res);
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00004845 if (len < 0) {
Armin Rigo7ccbca92006-10-04 12:17:45 +00004846 if (!PyErr_Occurred())
4847 PyErr_SetString(PyExc_ValueError,
4848 "__len__() should return >= 0");
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00004849 return -1;
4850 }
Guido van Rossum26111622001-10-01 16:42:49 +00004851 return len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004852}
4853
Guido van Rossumf4593e02001-10-03 12:09:30 +00004854/* Super-optimized version of slot_sq_item.
4855 Other slots could do the same... */
4856static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00004857slot_sq_item(PyObject *self, Py_ssize_t i)
Guido van Rossumf4593e02001-10-03 12:09:30 +00004858{
4859 static PyObject *getitem_str;
4860 PyObject *func, *args = NULL, *ival = NULL, *retval = NULL;
4861 descrgetfunc f;
4862
4863 if (getitem_str == NULL) {
Christian Heimes593daf52008-05-26 12:51:38 +00004864 getitem_str = PyBytes_InternFromString("__getitem__");
Guido van Rossumf4593e02001-10-03 12:09:30 +00004865 if (getitem_str == NULL)
4866 return NULL;
4867 }
Christian Heimese93237d2007-12-19 02:37:44 +00004868 func = _PyType_Lookup(Py_TYPE(self), getitem_str);
Guido van Rossumf4593e02001-10-03 12:09:30 +00004869 if (func != NULL) {
Christian Heimese93237d2007-12-19 02:37:44 +00004870 if ((f = Py_TYPE(func)->tp_descr_get) == NULL)
Guido van Rossumf4593e02001-10-03 12:09:30 +00004871 Py_INCREF(func);
Neal Norwitz673cd822002-10-18 16:33:13 +00004872 else {
Christian Heimese93237d2007-12-19 02:37:44 +00004873 func = f(func, self, (PyObject *)(Py_TYPE(self)));
Neal Norwitz673cd822002-10-18 16:33:13 +00004874 if (func == NULL) {
4875 return NULL;
4876 }
4877 }
Martin v. Löwiseb079f12006-02-16 14:32:27 +00004878 ival = PyInt_FromSsize_t(i);
Guido van Rossumf4593e02001-10-03 12:09:30 +00004879 if (ival != NULL) {
4880 args = PyTuple_New(1);
4881 if (args != NULL) {
4882 PyTuple_SET_ITEM(args, 0, ival);
4883 retval = PyObject_Call(func, args, NULL);
4884 Py_XDECREF(args);
4885 Py_XDECREF(func);
4886 return retval;
4887 }
4888 }
4889 }
4890 else {
4891 PyErr_SetObject(PyExc_AttributeError, getitem_str);
4892 }
4893 Py_XDECREF(args);
4894 Py_XDECREF(ival);
4895 Py_XDECREF(func);
4896 return NULL;
4897}
4898
Martin v. Löwis18e16552006-02-15 17:27:45 +00004899SLOT2(slot_sq_slice, "__getslice__", Py_ssize_t, Py_ssize_t, "nn")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004900
4901static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00004902slot_sq_ass_item(PyObject *self, Py_ssize_t index, PyObject *value)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004903{
4904 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004905 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004906
4907 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004908 res = call_method(self, "__delitem__", &delitem_str,
Thomas Wouters4e908102006-04-21 11:26:56 +00004909 "(n)", index);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004910 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004911 res = call_method(self, "__setitem__", &setitem_str,
Thomas Wouters4e908102006-04-21 11:26:56 +00004912 "(nO)", index, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004913 if (res == NULL)
4914 return -1;
4915 Py_DECREF(res);
4916 return 0;
4917}
4918
4919static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00004920slot_sq_ass_slice(PyObject *self, Py_ssize_t i, Py_ssize_t j, PyObject *value)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004921{
4922 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004923 static PyObject *delslice_str, *setslice_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004924
4925 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004926 res = call_method(self, "__delslice__", &delslice_str,
Thomas Wouters4e908102006-04-21 11:26:56 +00004927 "(nn)", i, j);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004928 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004929 res = call_method(self, "__setslice__", &setslice_str,
Thomas Wouters4e908102006-04-21 11:26:56 +00004930 "(nnO)", i, j, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004931 if (res == NULL)
4932 return -1;
4933 Py_DECREF(res);
4934 return 0;
4935}
4936
4937static int
4938slot_sq_contains(PyObject *self, PyObject *value)
4939{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004940 PyObject *func, *res, *args;
Tim Petersbf9b2442003-03-23 05:35:36 +00004941 int result = -1;
4942
Guido van Rossum60718732001-08-28 17:47:51 +00004943 static PyObject *contains_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004944
Guido van Rossum55f20992001-10-01 17:18:22 +00004945 func = lookup_maybe(self, "__contains__", &contains_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004946 if (func != NULL) {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004947 args = PyTuple_Pack(1, value);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004948 if (args == NULL)
4949 res = NULL;
4950 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004951 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004952 Py_DECREF(args);
4953 }
4954 Py_DECREF(func);
Tim Petersbf9b2442003-03-23 05:35:36 +00004955 if (res != NULL) {
4956 result = PyObject_IsTrue(res);
4957 Py_DECREF(res);
4958 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00004959 }
Tim Petersbf9b2442003-03-23 05:35:36 +00004960 else if (! PyErr_Occurred()) {
Martin v. Löwis725507b2006-03-07 12:08:51 +00004961 /* Possible results: -1 and 1 */
4962 result = (int)_PySequence_IterSearch(self, value,
Tim Petersbf9b2442003-03-23 05:35:36 +00004963 PY_ITERSEARCH_CONTAINS);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004964 }
Tim Petersbf9b2442003-03-23 05:35:36 +00004965 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004966}
4967
Tim Peters6d6c1a32001-08-02 04:15:00 +00004968#define slot_mp_length slot_sq_length
4969
Guido van Rossumdc91b992001-08-08 22:26:22 +00004970SLOT1(slot_mp_subscript, "__getitem__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004971
4972static int
4973slot_mp_ass_subscript(PyObject *self, PyObject *key, PyObject *value)
4974{
4975 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004976 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004977
4978 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004979 res = call_method(self, "__delitem__", &delitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004980 "(O)", key);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004981 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004982 res = call_method(self, "__setitem__", &setitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004983 "(OO)", key, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004984 if (res == NULL)
4985 return -1;
4986 Py_DECREF(res);
4987 return 0;
4988}
4989
Guido van Rossumdc91b992001-08-08 22:26:22 +00004990SLOT1BIN(slot_nb_add, nb_add, "__add__", "__radd__")
4991SLOT1BIN(slot_nb_subtract, nb_subtract, "__sub__", "__rsub__")
4992SLOT1BIN(slot_nb_multiply, nb_multiply, "__mul__", "__rmul__")
4993SLOT1BIN(slot_nb_divide, nb_divide, "__div__", "__rdiv__")
4994SLOT1BIN(slot_nb_remainder, nb_remainder, "__mod__", "__rmod__")
4995SLOT1BIN(slot_nb_divmod, nb_divmod, "__divmod__", "__rdivmod__")
4996
Jeremy Hylton938ace62002-07-17 16:30:39 +00004997static PyObject *slot_nb_power(PyObject *, PyObject *, PyObject *);
Guido van Rossumdc91b992001-08-08 22:26:22 +00004998
4999SLOT1BINFULL(slot_nb_power_binary, slot_nb_power,
5000 nb_power, "__pow__", "__rpow__")
5001
5002static PyObject *
5003slot_nb_power(PyObject *self, PyObject *other, PyObject *modulus)
5004{
Guido van Rossum2730b132001-08-28 18:22:14 +00005005 static PyObject *pow_str;
5006
Guido van Rossumdc91b992001-08-08 22:26:22 +00005007 if (modulus == Py_None)
5008 return slot_nb_power_binary(self, other);
Guido van Rossum23094982002-06-10 14:30:43 +00005009 /* Three-arg power doesn't use __rpow__. But ternary_op
5010 can call this when the second argument's type uses
5011 slot_nb_power, so check before calling self.__pow__. */
Christian Heimese93237d2007-12-19 02:37:44 +00005012 if (Py_TYPE(self)->tp_as_number != NULL &&
5013 Py_TYPE(self)->tp_as_number->nb_power == slot_nb_power) {
Guido van Rossum23094982002-06-10 14:30:43 +00005014 return call_method(self, "__pow__", &pow_str,
5015 "(OO)", other, modulus);
5016 }
5017 Py_INCREF(Py_NotImplemented);
5018 return Py_NotImplemented;
Guido van Rossumdc91b992001-08-08 22:26:22 +00005019}
5020
5021SLOT0(slot_nb_negative, "__neg__")
5022SLOT0(slot_nb_positive, "__pos__")
5023SLOT0(slot_nb_absolute, "__abs__")
Tim Peters6d6c1a32001-08-02 04:15:00 +00005024
5025static int
5026slot_nb_nonzero(PyObject *self)
5027{
Tim Petersea7f75d2002-12-07 21:39:16 +00005028 PyObject *func, *args;
Guido van Rossum60718732001-08-28 17:47:51 +00005029 static PyObject *nonzero_str, *len_str;
Tim Petersea7f75d2002-12-07 21:39:16 +00005030 int result = -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005031
Guido van Rossum55f20992001-10-01 17:18:22 +00005032 func = lookup_maybe(self, "__nonzero__", &nonzero_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005033 if (func == NULL) {
Guido van Rossum55f20992001-10-01 17:18:22 +00005034 if (PyErr_Occurred())
Guido van Rossumb8f63662001-08-15 23:57:02 +00005035 return -1;
Guido van Rossum55f20992001-10-01 17:18:22 +00005036 func = lookup_maybe(self, "__len__", &len_str);
Tim Petersea7f75d2002-12-07 21:39:16 +00005037 if (func == NULL)
5038 return PyErr_Occurred() ? -1 : 1;
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005039 }
Tim Petersea7f75d2002-12-07 21:39:16 +00005040 args = PyTuple_New(0);
5041 if (args != NULL) {
5042 PyObject *temp = PyObject_Call(func, args, NULL);
5043 Py_DECREF(args);
5044 if (temp != NULL) {
Jeremy Hylton3e3159c2003-06-27 17:38:27 +00005045 if (PyInt_CheckExact(temp) || PyBool_Check(temp))
Jeremy Hylton090a3492003-06-27 16:46:45 +00005046 result = PyObject_IsTrue(temp);
5047 else {
5048 PyErr_Format(PyExc_TypeError,
5049 "__nonzero__ should return "
5050 "bool or int, returned %s",
5051 temp->ob_type->tp_name);
Jeremy Hylton3e3159c2003-06-27 17:38:27 +00005052 result = -1;
Jeremy Hylton090a3492003-06-27 16:46:45 +00005053 }
Tim Petersea7f75d2002-12-07 21:39:16 +00005054 Py_DECREF(temp);
Guido van Rossum55f20992001-10-01 17:18:22 +00005055 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00005056 }
Guido van Rossum55f20992001-10-01 17:18:22 +00005057 Py_DECREF(func);
Tim Petersea7f75d2002-12-07 21:39:16 +00005058 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005059}
5060
Guido van Rossum38fff8c2006-03-07 18:50:55 +00005061
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00005062static PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00005063slot_nb_index(PyObject *self)
5064{
Guido van Rossum38fff8c2006-03-07 18:50:55 +00005065 static PyObject *index_str;
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00005066 return call_method(self, "__index__", &index_str, "()");
Guido van Rossum38fff8c2006-03-07 18:50:55 +00005067}
5068
5069
Guido van Rossumdc91b992001-08-08 22:26:22 +00005070SLOT0(slot_nb_invert, "__invert__")
5071SLOT1BIN(slot_nb_lshift, nb_lshift, "__lshift__", "__rlshift__")
5072SLOT1BIN(slot_nb_rshift, nb_rshift, "__rshift__", "__rrshift__")
5073SLOT1BIN(slot_nb_and, nb_and, "__and__", "__rand__")
5074SLOT1BIN(slot_nb_xor, nb_xor, "__xor__", "__rxor__")
5075SLOT1BIN(slot_nb_or, nb_or, "__or__", "__ror__")
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00005076
5077static int
5078slot_nb_coerce(PyObject **a, PyObject **b)
5079{
5080 static PyObject *coerce_str;
5081 PyObject *self = *a, *other = *b;
5082
5083 if (self->ob_type->tp_as_number != NULL &&
5084 self->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
5085 PyObject *r;
5086 r = call_maybe(
5087 self, "__coerce__", &coerce_str, "(O)", other);
5088 if (r == NULL)
5089 return -1;
5090 if (r == Py_NotImplemented) {
5091 Py_DECREF(r);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00005092 }
Guido van Rossum55f20992001-10-01 17:18:22 +00005093 else {
5094 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
5095 PyErr_SetString(PyExc_TypeError,
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00005096 "__coerce__ didn't return a 2-tuple");
Guido van Rossum55f20992001-10-01 17:18:22 +00005097 Py_DECREF(r);
5098 return -1;
5099 }
5100 *a = PyTuple_GET_ITEM(r, 0);
5101 Py_INCREF(*a);
5102 *b = PyTuple_GET_ITEM(r, 1);
5103 Py_INCREF(*b);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00005104 Py_DECREF(r);
Guido van Rossum55f20992001-10-01 17:18:22 +00005105 return 0;
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00005106 }
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00005107 }
5108 if (other->ob_type->tp_as_number != NULL &&
5109 other->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
5110 PyObject *r;
5111 r = call_maybe(
5112 other, "__coerce__", &coerce_str, "(O)", self);
5113 if (r == NULL)
5114 return -1;
5115 if (r == Py_NotImplemented) {
5116 Py_DECREF(r);
5117 return 1;
5118 }
5119 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
5120 PyErr_SetString(PyExc_TypeError,
5121 "__coerce__ didn't return a 2-tuple");
5122 Py_DECREF(r);
5123 return -1;
5124 }
5125 *a = PyTuple_GET_ITEM(r, 1);
5126 Py_INCREF(*a);
5127 *b = PyTuple_GET_ITEM(r, 0);
5128 Py_INCREF(*b);
5129 Py_DECREF(r);
5130 return 0;
5131 }
5132 return 1;
5133}
5134
Guido van Rossumdc91b992001-08-08 22:26:22 +00005135SLOT0(slot_nb_int, "__int__")
5136SLOT0(slot_nb_long, "__long__")
5137SLOT0(slot_nb_float, "__float__")
5138SLOT0(slot_nb_oct, "__oct__")
5139SLOT0(slot_nb_hex, "__hex__")
5140SLOT1(slot_nb_inplace_add, "__iadd__", PyObject *, "O")
5141SLOT1(slot_nb_inplace_subtract, "__isub__", PyObject *, "O")
5142SLOT1(slot_nb_inplace_multiply, "__imul__", PyObject *, "O")
5143SLOT1(slot_nb_inplace_divide, "__idiv__", PyObject *, "O")
5144SLOT1(slot_nb_inplace_remainder, "__imod__", PyObject *, "O")
Martin v. Löwisfd963262007-02-09 12:19:32 +00005145/* Can't use SLOT1 here, because nb_inplace_power is ternary */
5146static PyObject *
5147slot_nb_inplace_power(PyObject *self, PyObject * arg1, PyObject *arg2)
5148{
5149 static PyObject *cache_str;
5150 return call_method(self, "__ipow__", &cache_str, "(" "O" ")", arg1);
5151}
Guido van Rossumdc91b992001-08-08 22:26:22 +00005152SLOT1(slot_nb_inplace_lshift, "__ilshift__", PyObject *, "O")
5153SLOT1(slot_nb_inplace_rshift, "__irshift__", PyObject *, "O")
5154SLOT1(slot_nb_inplace_and, "__iand__", PyObject *, "O")
5155SLOT1(slot_nb_inplace_xor, "__ixor__", PyObject *, "O")
5156SLOT1(slot_nb_inplace_or, "__ior__", PyObject *, "O")
5157SLOT1BIN(slot_nb_floor_divide, nb_floor_divide,
5158 "__floordiv__", "__rfloordiv__")
5159SLOT1BIN(slot_nb_true_divide, nb_true_divide, "__truediv__", "__rtruediv__")
5160SLOT1(slot_nb_inplace_floor_divide, "__ifloordiv__", PyObject *, "O")
5161SLOT1(slot_nb_inplace_true_divide, "__itruediv__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00005162
5163static int
Guido van Rossumb8f63662001-08-15 23:57:02 +00005164half_compare(PyObject *self, PyObject *other)
Tim Peters6d6c1a32001-08-02 04:15:00 +00005165{
Guido van Rossumb8f63662001-08-15 23:57:02 +00005166 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00005167 static PyObject *cmp_str;
Martin v. Löwis18e16552006-02-15 17:27:45 +00005168 Py_ssize_t c;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005169
Guido van Rossum60718732001-08-28 17:47:51 +00005170 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005171 if (func == NULL) {
5172 PyErr_Clear();
5173 }
5174 else {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00005175 args = PyTuple_Pack(1, other);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005176 if (args == NULL)
5177 res = NULL;
5178 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00005179 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005180 Py_DECREF(args);
5181 }
Raymond Hettingerab5dae32002-06-24 13:08:16 +00005182 Py_DECREF(func);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005183 if (res != Py_NotImplemented) {
5184 if (res == NULL)
5185 return -2;
5186 c = PyInt_AsLong(res);
5187 Py_DECREF(res);
5188 if (c == -1 && PyErr_Occurred())
5189 return -2;
5190 return (c < 0) ? -1 : (c > 0) ? 1 : 0;
5191 }
5192 Py_DECREF(res);
5193 }
5194 return 2;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005195}
5196
Guido van Rossumab3b0342001-09-18 20:38:53 +00005197/* This slot is published for the benefit of try_3way_compare in object.c */
5198int
5199_PyObject_SlotCompare(PyObject *self, PyObject *other)
Guido van Rossumb8f63662001-08-15 23:57:02 +00005200{
5201 int c;
5202
Christian Heimese93237d2007-12-19 02:37:44 +00005203 if (Py_TYPE(self)->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00005204 c = half_compare(self, other);
5205 if (c <= 1)
5206 return c;
5207 }
Christian Heimese93237d2007-12-19 02:37:44 +00005208 if (Py_TYPE(other)->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00005209 c = half_compare(other, self);
5210 if (c < -1)
5211 return -2;
5212 if (c <= 1)
5213 return -c;
5214 }
5215 return (void *)self < (void *)other ? -1 :
5216 (void *)self > (void *)other ? 1 : 0;
5217}
5218
5219static PyObject *
5220slot_tp_repr(PyObject *self)
5221{
5222 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00005223 static PyObject *repr_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00005224
Guido van Rossum60718732001-08-28 17:47:51 +00005225 func = lookup_method(self, "__repr__", &repr_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005226 if (func != NULL) {
5227 res = PyEval_CallObject(func, NULL);
5228 Py_DECREF(func);
5229 return res;
5230 }
Barry Warsaw7ce36942001-08-24 18:34:26 +00005231 PyErr_Clear();
Christian Heimes593daf52008-05-26 12:51:38 +00005232 return PyBytes_FromFormat("<%s object at %p>",
Christian Heimese93237d2007-12-19 02:37:44 +00005233 Py_TYPE(self)->tp_name, self);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005234}
5235
5236static PyObject *
5237slot_tp_str(PyObject *self)
5238{
5239 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00005240 static PyObject *str_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00005241
Guido van Rossum60718732001-08-28 17:47:51 +00005242 func = lookup_method(self, "__str__", &str_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005243 if (func != NULL) {
5244 res = PyEval_CallObject(func, NULL);
5245 Py_DECREF(func);
5246 return res;
5247 }
5248 else {
5249 PyErr_Clear();
5250 return slot_tp_repr(self);
5251 }
5252}
Tim Peters6d6c1a32001-08-02 04:15:00 +00005253
5254static long
5255slot_tp_hash(PyObject *self)
5256{
Tim Peters61ce0a92002-12-06 23:38:02 +00005257 PyObject *func;
Guido van Rossum60718732001-08-28 17:47:51 +00005258 static PyObject *hash_str, *eq_str, *cmp_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005259 long h;
5260
Guido van Rossum60718732001-08-28 17:47:51 +00005261 func = lookup_method(self, "__hash__", &hash_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005262
Guido van Rossum0b7b6fd2007-12-19 22:51:13 +00005263 if (func != NULL && func != Py_None) {
Tim Peters61ce0a92002-12-06 23:38:02 +00005264 PyObject *res = PyEval_CallObject(func, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005265 Py_DECREF(func);
5266 if (res == NULL)
5267 return -1;
Martin v. Löwisab2f8f72006-08-09 07:57:39 +00005268 if (PyLong_Check(res))
Armin Rigo51fc8c42006-08-09 14:55:26 +00005269 h = PyLong_Type.tp_hash(res);
Martin v. Löwisab2f8f72006-08-09 07:57:39 +00005270 else
5271 h = PyInt_AsLong(res);
Tim Peters61ce0a92002-12-06 23:38:02 +00005272 Py_DECREF(res);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005273 }
5274 else {
Georg Brandl30b78042007-12-20 21:03:02 +00005275 Py_XDECREF(func); /* may be None */
Guido van Rossumb8f63662001-08-15 23:57:02 +00005276 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00005277 func = lookup_method(self, "__eq__", &eq_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005278 if (func == NULL) {
5279 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00005280 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005281 }
5282 if (func != NULL) {
Georg Brandlccff7852006-06-18 22:17:29 +00005283 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
5284 self->ob_type->tp_name);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005285 Py_DECREF(func);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005286 return -1;
5287 }
5288 PyErr_Clear();
5289 h = _Py_HashPointer((void *)self);
5290 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00005291 if (h == -1 && !PyErr_Occurred())
5292 h = -2;
5293 return h;
5294}
5295
5296static PyObject *
5297slot_tp_call(PyObject *self, PyObject *args, PyObject *kwds)
5298{
Guido van Rossum60718732001-08-28 17:47:51 +00005299 static PyObject *call_str;
5300 PyObject *meth = lookup_method(self, "__call__", &call_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005301 PyObject *res;
5302
5303 if (meth == NULL)
5304 return NULL;
Armin Rigo53c1692f2006-06-21 21:58:50 +00005305
Tim Peters6d6c1a32001-08-02 04:15:00 +00005306 res = PyObject_Call(meth, args, kwds);
Armin Rigo53c1692f2006-06-21 21:58:50 +00005307
Tim Peters6d6c1a32001-08-02 04:15:00 +00005308 Py_DECREF(meth);
5309 return res;
5310}
5311
Guido van Rossum14a6f832001-10-17 13:59:09 +00005312/* There are two slot dispatch functions for tp_getattro.
5313
5314 - slot_tp_getattro() is used when __getattribute__ is overridden
5315 but no __getattr__ hook is present;
5316
5317 - slot_tp_getattr_hook() is used when a __getattr__ hook is present.
5318
Guido van Rossumc334df52002-04-04 23:44:47 +00005319 The code in update_one_slot() always installs slot_tp_getattr_hook(); this
5320 detects the absence of __getattr__ and then installs the simpler slot if
5321 necessary. */
Guido van Rossum14a6f832001-10-17 13:59:09 +00005322
Tim Peters6d6c1a32001-08-02 04:15:00 +00005323static PyObject *
5324slot_tp_getattro(PyObject *self, PyObject *name)
5325{
Guido van Rossum14a6f832001-10-17 13:59:09 +00005326 static PyObject *getattribute_str = NULL;
5327 return call_method(self, "__getattribute__", &getattribute_str,
5328 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005329}
5330
Guido van Rossum19c1cd52001-09-21 21:24:49 +00005331static PyObject *
5332slot_tp_getattr_hook(PyObject *self, PyObject *name)
5333{
Christian Heimese93237d2007-12-19 02:37:44 +00005334 PyTypeObject *tp = Py_TYPE(self);
Guido van Rossum19c1cd52001-09-21 21:24:49 +00005335 PyObject *getattr, *getattribute, *res;
5336 static PyObject *getattribute_str = NULL;
5337 static PyObject *getattr_str = NULL;
5338
5339 if (getattr_str == NULL) {
Christian Heimes593daf52008-05-26 12:51:38 +00005340 getattr_str = PyBytes_InternFromString("__getattr__");
Guido van Rossum19c1cd52001-09-21 21:24:49 +00005341 if (getattr_str == NULL)
5342 return NULL;
5343 }
5344 if (getattribute_str == NULL) {
5345 getattribute_str =
Christian Heimes593daf52008-05-26 12:51:38 +00005346 PyBytes_InternFromString("__getattribute__");
Guido van Rossum19c1cd52001-09-21 21:24:49 +00005347 if (getattribute_str == NULL)
5348 return NULL;
5349 }
5350 getattr = _PyType_Lookup(tp, getattr_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00005351 if (getattr == NULL) {
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005352 /* No __getattr__ hook: use a simpler dispatcher */
5353 tp->tp_getattro = slot_tp_getattro;
5354 return slot_tp_getattro(self, name);
5355 }
Guido van Rossum19c1cd52001-09-21 21:24:49 +00005356 getattribute = _PyType_Lookup(tp, getattribute_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00005357 if (getattribute == NULL ||
Christian Heimese93237d2007-12-19 02:37:44 +00005358 (Py_TYPE(getattribute) == &PyWrapperDescr_Type &&
Guido van Rossum14a6f832001-10-17 13:59:09 +00005359 ((PyWrapperDescrObject *)getattribute)->d_wrapped ==
5360 (void *)PyObject_GenericGetAttr))
Guido van Rossum19c1cd52001-09-21 21:24:49 +00005361 res = PyObject_GenericGetAttr(self, name);
5362 else
Georg Brandl684fd0c2006-05-25 19:15:31 +00005363 res = PyObject_CallFunctionObjArgs(getattribute, self, name, NULL);
Guido van Rossum14a6f832001-10-17 13:59:09 +00005364 if (res == NULL && PyErr_ExceptionMatches(PyExc_AttributeError)) {
Guido van Rossum19c1cd52001-09-21 21:24:49 +00005365 PyErr_Clear();
Georg Brandl684fd0c2006-05-25 19:15:31 +00005366 res = PyObject_CallFunctionObjArgs(getattr, self, name, NULL);
Guido van Rossum19c1cd52001-09-21 21:24:49 +00005367 }
5368 return res;
5369}
5370
Tim Peters6d6c1a32001-08-02 04:15:00 +00005371static int
5372slot_tp_setattro(PyObject *self, PyObject *name, PyObject *value)
5373{
5374 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00005375 static PyObject *delattr_str, *setattr_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005376
5377 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00005378 res = call_method(self, "__delattr__", &delattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00005379 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005380 else
Guido van Rossum2730b132001-08-28 18:22:14 +00005381 res = call_method(self, "__setattr__", &setattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00005382 "(OO)", name, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005383 if (res == NULL)
5384 return -1;
5385 Py_DECREF(res);
5386 return 0;
5387}
5388
Guido van Rossum0b7b6fd2007-12-19 22:51:13 +00005389static char *name_op[] = {
5390 "__lt__",
5391 "__le__",
5392 "__eq__",
5393 "__ne__",
5394 "__gt__",
5395 "__ge__",
5396};
5397
Tim Peters6d6c1a32001-08-02 04:15:00 +00005398static PyObject *
Guido van Rossumb8f63662001-08-15 23:57:02 +00005399half_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters6d6c1a32001-08-02 04:15:00 +00005400{
Guido van Rossumb8f63662001-08-15 23:57:02 +00005401 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00005402 static PyObject *op_str[6];
Tim Peters6d6c1a32001-08-02 04:15:00 +00005403
Guido van Rossum60718732001-08-28 17:47:51 +00005404 func = lookup_method(self, name_op[op], &op_str[op]);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005405 if (func == NULL) {
5406 PyErr_Clear();
5407 Py_INCREF(Py_NotImplemented);
5408 return Py_NotImplemented;
5409 }
Raymond Hettinger8ae46892003-10-12 19:09:37 +00005410 args = PyTuple_Pack(1, other);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005411 if (args == NULL)
5412 res = NULL;
5413 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00005414 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005415 Py_DECREF(args);
5416 }
5417 Py_DECREF(func);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005418 return res;
5419}
5420
Guido van Rossumb8f63662001-08-15 23:57:02 +00005421static PyObject *
5422slot_tp_richcompare(PyObject *self, PyObject *other, int op)
5423{
5424 PyObject *res;
5425
Christian Heimese93237d2007-12-19 02:37:44 +00005426 if (Py_TYPE(self)->tp_richcompare == slot_tp_richcompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00005427 res = half_richcompare(self, other, op);
5428 if (res != Py_NotImplemented)
5429 return res;
5430 Py_DECREF(res);
5431 }
Christian Heimese93237d2007-12-19 02:37:44 +00005432 if (Py_TYPE(other)->tp_richcompare == slot_tp_richcompare) {
Tim Petersf4aca752004-09-23 02:39:37 +00005433 res = half_richcompare(other, self, _Py_SwappedOp[op]);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005434 if (res != Py_NotImplemented) {
5435 return res;
5436 }
5437 Py_DECREF(res);
5438 }
5439 Py_INCREF(Py_NotImplemented);
5440 return Py_NotImplemented;
5441}
5442
5443static PyObject *
5444slot_tp_iter(PyObject *self)
5445{
5446 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00005447 static PyObject *iter_str, *getitem_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00005448
Guido van Rossum60718732001-08-28 17:47:51 +00005449 func = lookup_method(self, "__iter__", &iter_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005450 if (func != NULL) {
Guido van Rossum84b2bed2002-08-16 17:01:09 +00005451 PyObject *args;
5452 args = res = PyTuple_New(0);
5453 if (args != NULL) {
5454 res = PyObject_Call(func, args, NULL);
5455 Py_DECREF(args);
5456 }
5457 Py_DECREF(func);
5458 return res;
Guido van Rossumb8f63662001-08-15 23:57:02 +00005459 }
5460 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00005461 func = lookup_method(self, "__getitem__", &getitem_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005462 if (func == NULL) {
Georg Brandlccff7852006-06-18 22:17:29 +00005463 PyErr_Format(PyExc_TypeError,
5464 "'%.200s' object is not iterable",
Christian Heimese93237d2007-12-19 02:37:44 +00005465 Py_TYPE(self)->tp_name);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005466 return NULL;
5467 }
5468 Py_DECREF(func);
5469 return PySeqIter_New(self);
5470}
Tim Peters6d6c1a32001-08-02 04:15:00 +00005471
5472static PyObject *
5473slot_tp_iternext(PyObject *self)
5474{
Guido van Rossum2730b132001-08-28 18:22:14 +00005475 static PyObject *next_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00005476 return call_method(self, "next", &next_str, "()");
Tim Peters6d6c1a32001-08-02 04:15:00 +00005477}
5478
Guido van Rossum1a493502001-08-17 16:47:50 +00005479static PyObject *
5480slot_tp_descr_get(PyObject *self, PyObject *obj, PyObject *type)
5481{
Christian Heimese93237d2007-12-19 02:37:44 +00005482 PyTypeObject *tp = Py_TYPE(self);
Guido van Rossum1a493502001-08-17 16:47:50 +00005483 PyObject *get;
5484 static PyObject *get_str = NULL;
5485
5486 if (get_str == NULL) {
Christian Heimes593daf52008-05-26 12:51:38 +00005487 get_str = PyBytes_InternFromString("__get__");
Guido van Rossum1a493502001-08-17 16:47:50 +00005488 if (get_str == NULL)
5489 return NULL;
5490 }
5491 get = _PyType_Lookup(tp, get_str);
5492 if (get == NULL) {
5493 /* Avoid further slowdowns */
5494 if (tp->tp_descr_get == slot_tp_descr_get)
5495 tp->tp_descr_get = NULL;
5496 Py_INCREF(self);
5497 return self;
5498 }
Guido van Rossum2c252392001-08-24 10:13:31 +00005499 if (obj == NULL)
5500 obj = Py_None;
5501 if (type == NULL)
5502 type = Py_None;
Georg Brandl684fd0c2006-05-25 19:15:31 +00005503 return PyObject_CallFunctionObjArgs(get, self, obj, type, NULL);
Guido van Rossum1a493502001-08-17 16:47:50 +00005504}
Tim Peters6d6c1a32001-08-02 04:15:00 +00005505
5506static int
5507slot_tp_descr_set(PyObject *self, PyObject *target, PyObject *value)
5508{
Guido van Rossum2c252392001-08-24 10:13:31 +00005509 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00005510 static PyObject *del_str, *set_str;
Guido van Rossum2c252392001-08-24 10:13:31 +00005511
5512 if (value == NULL)
Guido van Rossum1d5b3f22001-12-03 00:08:33 +00005513 res = call_method(self, "__delete__", &del_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00005514 "(O)", target);
Guido van Rossum2c252392001-08-24 10:13:31 +00005515 else
Guido van Rossum2730b132001-08-28 18:22:14 +00005516 res = call_method(self, "__set__", &set_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00005517 "(OO)", target, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005518 if (res == NULL)
5519 return -1;
5520 Py_DECREF(res);
5521 return 0;
5522}
5523
5524static int
5525slot_tp_init(PyObject *self, PyObject *args, PyObject *kwds)
5526{
Guido van Rossum60718732001-08-28 17:47:51 +00005527 static PyObject *init_str;
5528 PyObject *meth = lookup_method(self, "__init__", &init_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005529 PyObject *res;
5530
5531 if (meth == NULL)
5532 return -1;
5533 res = PyObject_Call(meth, args, kwds);
5534 Py_DECREF(meth);
5535 if (res == NULL)
5536 return -1;
Raymond Hettingerb67cc802005-03-03 16:45:19 +00005537 if (res != Py_None) {
Georg Brandlccff7852006-06-18 22:17:29 +00005538 PyErr_Format(PyExc_TypeError,
5539 "__init__() should return None, not '%.200s'",
Christian Heimese93237d2007-12-19 02:37:44 +00005540 Py_TYPE(res)->tp_name);
Raymond Hettingerb67cc802005-03-03 16:45:19 +00005541 Py_DECREF(res);
5542 return -1;
5543 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00005544 Py_DECREF(res);
5545 return 0;
5546}
5547
5548static PyObject *
5549slot_tp_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
5550{
Guido van Rossum7bed2132002-08-08 21:57:53 +00005551 static PyObject *new_str;
5552 PyObject *func;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005553 PyObject *newargs, *x;
Martin v. Löwis18e16552006-02-15 17:27:45 +00005554 Py_ssize_t i, n;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005555
Guido van Rossum7bed2132002-08-08 21:57:53 +00005556 if (new_str == NULL) {
Christian Heimes593daf52008-05-26 12:51:38 +00005557 new_str = PyBytes_InternFromString("__new__");
Guido van Rossum7bed2132002-08-08 21:57:53 +00005558 if (new_str == NULL)
5559 return NULL;
5560 }
5561 func = PyObject_GetAttr((PyObject *)type, new_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005562 if (func == NULL)
5563 return NULL;
5564 assert(PyTuple_Check(args));
5565 n = PyTuple_GET_SIZE(args);
5566 newargs = PyTuple_New(n+1);
5567 if (newargs == NULL)
5568 return NULL;
5569 Py_INCREF(type);
5570 PyTuple_SET_ITEM(newargs, 0, (PyObject *)type);
5571 for (i = 0; i < n; i++) {
5572 x = PyTuple_GET_ITEM(args, i);
5573 Py_INCREF(x);
5574 PyTuple_SET_ITEM(newargs, i+1, x);
5575 }
5576 x = PyObject_Call(func, newargs, kwds);
Guido van Rossum25d18072001-10-01 15:55:28 +00005577 Py_DECREF(newargs);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005578 Py_DECREF(func);
5579 return x;
5580}
5581
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005582static void
5583slot_tp_del(PyObject *self)
5584{
5585 static PyObject *del_str = NULL;
5586 PyObject *del, *res;
5587 PyObject *error_type, *error_value, *error_traceback;
5588
5589 /* Temporarily resurrect the object. */
5590 assert(self->ob_refcnt == 0);
5591 self->ob_refcnt = 1;
5592
5593 /* Save the current exception, if any. */
5594 PyErr_Fetch(&error_type, &error_value, &error_traceback);
5595
5596 /* Execute __del__ method, if any. */
5597 del = lookup_maybe(self, "__del__", &del_str);
5598 if (del != NULL) {
5599 res = PyEval_CallObject(del, NULL);
5600 if (res == NULL)
5601 PyErr_WriteUnraisable(del);
5602 else
5603 Py_DECREF(res);
5604 Py_DECREF(del);
5605 }
5606
5607 /* Restore the saved exception. */
5608 PyErr_Restore(error_type, error_value, error_traceback);
5609
5610 /* Undo the temporary resurrection; can't use DECREF here, it would
5611 * cause a recursive call.
5612 */
5613 assert(self->ob_refcnt > 0);
5614 if (--self->ob_refcnt == 0)
5615 return; /* this is the normal path out */
5616
5617 /* __del__ resurrected it! Make it look like the original Py_DECREF
5618 * never happened.
5619 */
5620 {
Martin v. Löwis725507b2006-03-07 12:08:51 +00005621 Py_ssize_t refcnt = self->ob_refcnt;
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005622 _Py_NewReference(self);
5623 self->ob_refcnt = refcnt;
5624 }
Christian Heimese93237d2007-12-19 02:37:44 +00005625 assert(!PyType_IS_GC(Py_TYPE(self)) ||
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005626 _Py_AS_GC(self)->gc.gc_refs != _PyGC_REFS_UNTRACKED);
Michael W. Hudson3f3b6682004-08-03 10:21:03 +00005627 /* If Py_REF_DEBUG, _Py_NewReference bumped _Py_RefTotal, so
5628 * we need to undo that. */
5629 _Py_DEC_REFTOTAL;
5630 /* If Py_TRACE_REFS, _Py_NewReference re-added self to the object
5631 * chain, so no more to do there.
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005632 * If COUNT_ALLOCS, the original decref bumped tp_frees, and
5633 * _Py_NewReference bumped tp_allocs: both of those need to be
5634 * undone.
5635 */
5636#ifdef COUNT_ALLOCS
Christian Heimese93237d2007-12-19 02:37:44 +00005637 --Py_TYPE(self)->tp_frees;
5638 --Py_TYPE(self)->tp_allocs;
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005639#endif
5640}
5641
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005642
5643/* Table mapping __foo__ names to tp_foo offsets and slot_tp_foo wrapper
Tim Petersbf9b2442003-03-23 05:35:36 +00005644 functions. The offsets here are relative to the 'PyHeapTypeObject'
Guido van Rossume5c691a2003-03-07 15:13:17 +00005645 structure, which incorporates the additional structures used for numbers,
5646 sequences and mappings.
5647 Note that multiple names may map to the same slot (e.g. __eq__,
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005648 __ne__ etc. all map to tp_richcompare) and one name may map to multiple
Guido van Rossumc334df52002-04-04 23:44:47 +00005649 slots (e.g. __str__ affects tp_str as well as tp_repr). The table is
5650 terminated with an all-zero entry. (This table is further initialized and
5651 sorted in init_slotdefs() below.) */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005652
Guido van Rossum6d204072001-10-21 00:44:31 +00005653typedef struct wrapperbase slotdef;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005654
5655#undef TPSLOT
Guido van Rossumc8e56452001-10-22 00:43:43 +00005656#undef FLSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005657#undef ETSLOT
5658#undef SQSLOT
5659#undef MPSLOT
5660#undef NBSLOT
Guido van Rossum6d204072001-10-21 00:44:31 +00005661#undef UNSLOT
5662#undef IBSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005663#undef BINSLOT
5664#undef RBINSLOT
5665
Guido van Rossum6d204072001-10-21 00:44:31 +00005666#define TPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Neal Norwitzd47714a2002-08-13 19:01:38 +00005667 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
5668 PyDoc_STR(DOC)}
Guido van Rossumc8e56452001-10-22 00:43:43 +00005669#define FLSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC, FLAGS) \
5670 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00005671 PyDoc_STR(DOC), FLAGS}
Guido van Rossum6d204072001-10-21 00:44:31 +00005672#define ETSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Guido van Rossume5c691a2003-03-07 15:13:17 +00005673 {NAME, offsetof(PyHeapTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00005674 PyDoc_STR(DOC)}
Guido van Rossum6d204072001-10-21 00:44:31 +00005675#define SQSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
5676 ETSLOT(NAME, as_sequence.SLOT, FUNCTION, WRAPPER, DOC)
5677#define MPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
5678 ETSLOT(NAME, as_mapping.SLOT, FUNCTION, WRAPPER, DOC)
5679#define NBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
5680 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, DOC)
5681#define UNSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
5682 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
5683 "x." NAME "() <==> " DOC)
5684#define IBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
5685 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
5686 "x." NAME "(y) <==> x" DOC "y")
5687#define BINSLOT(NAME, SLOT, FUNCTION, DOC) \
5688 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_l, \
5689 "x." NAME "(y) <==> x" DOC "y")
5690#define RBINSLOT(NAME, SLOT, FUNCTION, DOC) \
5691 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_r, \
5692 "x." NAME "(y) <==> y" DOC "x")
Anthony Baxter56616992005-06-03 14:12:21 +00005693#define BINSLOTNOTINFIX(NAME, SLOT, FUNCTION, DOC) \
5694 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_l, \
5695 "x." NAME "(y) <==> " DOC)
5696#define RBINSLOTNOTINFIX(NAME, SLOT, FUNCTION, DOC) \
5697 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_r, \
5698 "x." NAME "(y) <==> " DOC)
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005699
5700static slotdef slotdefs[] = {
Martin v. Löwis18e16552006-02-15 17:27:45 +00005701 SQSLOT("__len__", sq_length, slot_sq_length, wrap_lenfunc,
Guido van Rossum6d204072001-10-21 00:44:31 +00005702 "x.__len__() <==> len(x)"),
Armin Rigofd163f92005-12-29 15:59:19 +00005703 /* Heap types defining __add__/__mul__ have sq_concat/sq_repeat == NULL.
5704 The logic in abstract.c always falls back to nb_add/nb_multiply in
5705 this case. Defining both the nb_* and the sq_* slots to call the
5706 user-defined methods has unexpected side-effects, as shown by
5707 test_descr.notimplemented() */
5708 SQSLOT("__add__", sq_concat, NULL, wrap_binaryfunc,
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005709 "x.__add__(y) <==> x+y"),
Armin Rigo314861c2006-03-30 14:04:02 +00005710 SQSLOT("__mul__", sq_repeat, NULL, wrap_indexargfunc,
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005711 "x.__mul__(n) <==> x*n"),
Armin Rigo314861c2006-03-30 14:04:02 +00005712 SQSLOT("__rmul__", sq_repeat, NULL, wrap_indexargfunc,
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005713 "x.__rmul__(n) <==> n*x"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005714 SQSLOT("__getitem__", sq_item, slot_sq_item, wrap_sq_item,
5715 "x.__getitem__(y) <==> x[y]"),
Martin v. Löwis18e16552006-02-15 17:27:45 +00005716 SQSLOT("__getslice__", sq_slice, slot_sq_slice, wrap_ssizessizeargfunc,
Brett Cannon154da9b2003-05-20 02:30:04 +00005717 "x.__getslice__(i, j) <==> x[i:j]\n\
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005718 \n\
5719 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00005720 SQSLOT("__setitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_setitem,
Brett Cannonbe67d872003-05-20 02:40:12 +00005721 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005722 SQSLOT("__delitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_delitem,
Brett Cannonbe67d872003-05-20 02:40:12 +00005723 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005724 SQSLOT("__setslice__", sq_ass_slice, slot_sq_ass_slice,
Martin v. Löwis18e16552006-02-15 17:27:45 +00005725 wrap_ssizessizeobjargproc,
Brett Cannonbe67d872003-05-20 02:40:12 +00005726 "x.__setslice__(i, j, y) <==> x[i:j]=y\n\
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005727 \n\
5728 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00005729 SQSLOT("__delslice__", sq_ass_slice, slot_sq_ass_slice, wrap_delslice,
Brett Cannonbe67d872003-05-20 02:40:12 +00005730 "x.__delslice__(i, j) <==> del x[i:j]\n\
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005731 \n\
5732 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00005733 SQSLOT("__contains__", sq_contains, slot_sq_contains, wrap_objobjproc,
5734 "x.__contains__(y) <==> y in x"),
Armin Rigofd163f92005-12-29 15:59:19 +00005735 SQSLOT("__iadd__", sq_inplace_concat, NULL,
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005736 wrap_binaryfunc, "x.__iadd__(y) <==> x+=y"),
Armin Rigofd163f92005-12-29 15:59:19 +00005737 SQSLOT("__imul__", sq_inplace_repeat, NULL,
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005738 wrap_indexargfunc, "x.__imul__(y) <==> x*=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005739
Martin v. Löwis18e16552006-02-15 17:27:45 +00005740 MPSLOT("__len__", mp_length, slot_mp_length, wrap_lenfunc,
Guido van Rossum6d204072001-10-21 00:44:31 +00005741 "x.__len__() <==> len(x)"),
Guido van Rossumfd38f8e2001-10-09 20:17:57 +00005742 MPSLOT("__getitem__", mp_subscript, slot_mp_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00005743 wrap_binaryfunc,
5744 "x.__getitem__(y) <==> x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005745 MPSLOT("__setitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00005746 wrap_objobjargproc,
5747 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005748 MPSLOT("__delitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00005749 wrap_delitem,
5750 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005751
Guido van Rossum6d204072001-10-21 00:44:31 +00005752 BINSLOT("__add__", nb_add, slot_nb_add,
5753 "+"),
5754 RBINSLOT("__radd__", nb_add, slot_nb_add,
5755 "+"),
5756 BINSLOT("__sub__", nb_subtract, slot_nb_subtract,
5757 "-"),
5758 RBINSLOT("__rsub__", nb_subtract, slot_nb_subtract,
5759 "-"),
5760 BINSLOT("__mul__", nb_multiply, slot_nb_multiply,
5761 "*"),
5762 RBINSLOT("__rmul__", nb_multiply, slot_nb_multiply,
5763 "*"),
5764 BINSLOT("__div__", nb_divide, slot_nb_divide,
5765 "/"),
5766 RBINSLOT("__rdiv__", nb_divide, slot_nb_divide,
5767 "/"),
5768 BINSLOT("__mod__", nb_remainder, slot_nb_remainder,
5769 "%"),
5770 RBINSLOT("__rmod__", nb_remainder, slot_nb_remainder,
5771 "%"),
Anthony Baxter56616992005-06-03 14:12:21 +00005772 BINSLOTNOTINFIX("__divmod__", nb_divmod, slot_nb_divmod,
Guido van Rossum6d204072001-10-21 00:44:31 +00005773 "divmod(x, y)"),
Anthony Baxter56616992005-06-03 14:12:21 +00005774 RBINSLOTNOTINFIX("__rdivmod__", nb_divmod, slot_nb_divmod,
Guido van Rossum6d204072001-10-21 00:44:31 +00005775 "divmod(y, x)"),
5776 NBSLOT("__pow__", nb_power, slot_nb_power, wrap_ternaryfunc,
5777 "x.__pow__(y[, z]) <==> pow(x, y[, z])"),
5778 NBSLOT("__rpow__", nb_power, slot_nb_power, wrap_ternaryfunc_r,
5779 "y.__rpow__(x[, z]) <==> pow(x, y[, z])"),
5780 UNSLOT("__neg__", nb_negative, slot_nb_negative, wrap_unaryfunc, "-x"),
5781 UNSLOT("__pos__", nb_positive, slot_nb_positive, wrap_unaryfunc, "+x"),
5782 UNSLOT("__abs__", nb_absolute, slot_nb_absolute, wrap_unaryfunc,
5783 "abs(x)"),
Raymond Hettingerf34f2642003-10-11 17:29:04 +00005784 UNSLOT("__nonzero__", nb_nonzero, slot_nb_nonzero, wrap_inquirypred,
Guido van Rossum6d204072001-10-21 00:44:31 +00005785 "x != 0"),
5786 UNSLOT("__invert__", nb_invert, slot_nb_invert, wrap_unaryfunc, "~x"),
5787 BINSLOT("__lshift__", nb_lshift, slot_nb_lshift, "<<"),
5788 RBINSLOT("__rlshift__", nb_lshift, slot_nb_lshift, "<<"),
5789 BINSLOT("__rshift__", nb_rshift, slot_nb_rshift, ">>"),
5790 RBINSLOT("__rrshift__", nb_rshift, slot_nb_rshift, ">>"),
5791 BINSLOT("__and__", nb_and, slot_nb_and, "&"),
5792 RBINSLOT("__rand__", nb_and, slot_nb_and, "&"),
5793 BINSLOT("__xor__", nb_xor, slot_nb_xor, "^"),
5794 RBINSLOT("__rxor__", nb_xor, slot_nb_xor, "^"),
5795 BINSLOT("__or__", nb_or, slot_nb_or, "|"),
5796 RBINSLOT("__ror__", nb_or, slot_nb_or, "|"),
5797 NBSLOT("__coerce__", nb_coerce, slot_nb_coerce, wrap_coercefunc,
5798 "x.__coerce__(y) <==> coerce(x, y)"),
5799 UNSLOT("__int__", nb_int, slot_nb_int, wrap_unaryfunc,
5800 "int(x)"),
5801 UNSLOT("__long__", nb_long, slot_nb_long, wrap_unaryfunc,
5802 "long(x)"),
5803 UNSLOT("__float__", nb_float, slot_nb_float, wrap_unaryfunc,
5804 "float(x)"),
5805 UNSLOT("__oct__", nb_oct, slot_nb_oct, wrap_unaryfunc,
5806 "oct(x)"),
5807 UNSLOT("__hex__", nb_hex, slot_nb_hex, wrap_unaryfunc,
5808 "hex(x)"),
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00005809 NBSLOT("__index__", nb_index, slot_nb_index, wrap_unaryfunc,
Guido van Rossum38fff8c2006-03-07 18:50:55 +00005810 "x[y:z] <==> x[y.__index__():z.__index__()]"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005811 IBSLOT("__iadd__", nb_inplace_add, slot_nb_inplace_add,
5812 wrap_binaryfunc, "+"),
5813 IBSLOT("__isub__", nb_inplace_subtract, slot_nb_inplace_subtract,
5814 wrap_binaryfunc, "-"),
5815 IBSLOT("__imul__", nb_inplace_multiply, slot_nb_inplace_multiply,
5816 wrap_binaryfunc, "*"),
5817 IBSLOT("__idiv__", nb_inplace_divide, slot_nb_inplace_divide,
5818 wrap_binaryfunc, "/"),
5819 IBSLOT("__imod__", nb_inplace_remainder, slot_nb_inplace_remainder,
5820 wrap_binaryfunc, "%"),
5821 IBSLOT("__ipow__", nb_inplace_power, slot_nb_inplace_power,
Guido van Rossum6e5680f2002-10-15 01:01:53 +00005822 wrap_binaryfunc, "**"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005823 IBSLOT("__ilshift__", nb_inplace_lshift, slot_nb_inplace_lshift,
5824 wrap_binaryfunc, "<<"),
5825 IBSLOT("__irshift__", nb_inplace_rshift, slot_nb_inplace_rshift,
5826 wrap_binaryfunc, ">>"),
5827 IBSLOT("__iand__", nb_inplace_and, slot_nb_inplace_and,
5828 wrap_binaryfunc, "&"),
5829 IBSLOT("__ixor__", nb_inplace_xor, slot_nb_inplace_xor,
5830 wrap_binaryfunc, "^"),
5831 IBSLOT("__ior__", nb_inplace_or, slot_nb_inplace_or,
5832 wrap_binaryfunc, "|"),
5833 BINSLOT("__floordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
5834 RBINSLOT("__rfloordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
5835 BINSLOT("__truediv__", nb_true_divide, slot_nb_true_divide, "/"),
5836 RBINSLOT("__rtruediv__", nb_true_divide, slot_nb_true_divide, "/"),
5837 IBSLOT("__ifloordiv__", nb_inplace_floor_divide,
5838 slot_nb_inplace_floor_divide, wrap_binaryfunc, "//"),
5839 IBSLOT("__itruediv__", nb_inplace_true_divide,
5840 slot_nb_inplace_true_divide, wrap_binaryfunc, "/"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005841
Guido van Rossum6d204072001-10-21 00:44:31 +00005842 TPSLOT("__str__", tp_str, slot_tp_str, wrap_unaryfunc,
5843 "x.__str__() <==> str(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00005844 TPSLOT("__str__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00005845 TPSLOT("__repr__", tp_repr, slot_tp_repr, wrap_unaryfunc,
5846 "x.__repr__() <==> repr(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00005847 TPSLOT("__repr__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00005848 TPSLOT("__cmp__", tp_compare, _PyObject_SlotCompare, wrap_cmpfunc,
5849 "x.__cmp__(y) <==> cmp(x,y)"),
5850 TPSLOT("__hash__", tp_hash, slot_tp_hash, wrap_hashfunc,
5851 "x.__hash__() <==> hash(x)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00005852 FLSLOT("__call__", tp_call, slot_tp_call, (wrapperfunc)wrap_call,
5853 "x.__call__(...) <==> x(...)", PyWrapperFlag_KEYWORDS),
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005854 TPSLOT("__getattribute__", tp_getattro, slot_tp_getattr_hook,
Guido van Rossum6d204072001-10-21 00:44:31 +00005855 wrap_binaryfunc, "x.__getattribute__('name') <==> x.name"),
5856 TPSLOT("__getattribute__", tp_getattr, NULL, NULL, ""),
5857 TPSLOT("__getattr__", tp_getattro, slot_tp_getattr_hook, NULL, ""),
5858 TPSLOT("__getattr__", tp_getattr, NULL, NULL, ""),
5859 TPSLOT("__setattr__", tp_setattro, slot_tp_setattro, wrap_setattr,
5860 "x.__setattr__('name', value) <==> x.name = value"),
5861 TPSLOT("__setattr__", tp_setattr, NULL, NULL, ""),
5862 TPSLOT("__delattr__", tp_setattro, slot_tp_setattro, wrap_delattr,
5863 "x.__delattr__('name') <==> del x.name"),
5864 TPSLOT("__delattr__", tp_setattr, NULL, NULL, ""),
5865 TPSLOT("__lt__", tp_richcompare, slot_tp_richcompare, richcmp_lt,
5866 "x.__lt__(y) <==> x<y"),
5867 TPSLOT("__le__", tp_richcompare, slot_tp_richcompare, richcmp_le,
5868 "x.__le__(y) <==> x<=y"),
5869 TPSLOT("__eq__", tp_richcompare, slot_tp_richcompare, richcmp_eq,
5870 "x.__eq__(y) <==> x==y"),
5871 TPSLOT("__ne__", tp_richcompare, slot_tp_richcompare, richcmp_ne,
5872 "x.__ne__(y) <==> x!=y"),
5873 TPSLOT("__gt__", tp_richcompare, slot_tp_richcompare, richcmp_gt,
5874 "x.__gt__(y) <==> x>y"),
5875 TPSLOT("__ge__", tp_richcompare, slot_tp_richcompare, richcmp_ge,
5876 "x.__ge__(y) <==> x>=y"),
5877 TPSLOT("__iter__", tp_iter, slot_tp_iter, wrap_unaryfunc,
5878 "x.__iter__() <==> iter(x)"),
5879 TPSLOT("next", tp_iternext, slot_tp_iternext, wrap_next,
5880 "x.next() -> the next value, or raise StopIteration"),
5881 TPSLOT("__get__", tp_descr_get, slot_tp_descr_get, wrap_descr_get,
5882 "descr.__get__(obj[, type]) -> value"),
5883 TPSLOT("__set__", tp_descr_set, slot_tp_descr_set, wrap_descr_set,
5884 "descr.__set__(obj, value)"),
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00005885 TPSLOT("__delete__", tp_descr_set, slot_tp_descr_set,
5886 wrap_descr_delete, "descr.__delete__(obj)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00005887 FLSLOT("__init__", tp_init, slot_tp_init, (wrapperfunc)wrap_init,
Guido van Rossum6d204072001-10-21 00:44:31 +00005888 "x.__init__(...) initializes x; "
Guido van Rossumc8e56452001-10-22 00:43:43 +00005889 "see x.__class__.__doc__ for signature",
5890 PyWrapperFlag_KEYWORDS),
5891 TPSLOT("__new__", tp_new, slot_tp_new, NULL, ""),
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005892 TPSLOT("__del__", tp_del, slot_tp_del, NULL, ""),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005893 {NULL}
5894};
5895
Guido van Rossumc334df52002-04-04 23:44:47 +00005896/* Given a type pointer and an offset gotten from a slotdef entry, return a
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005897 pointer to the actual slot. This is not quite the same as simply adding
Guido van Rossumc334df52002-04-04 23:44:47 +00005898 the offset to the type pointer, since it takes care to indirect through the
5899 proper indirection pointer (as_buffer, etc.); it returns NULL if the
5900 indirection pointer is NULL. */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005901static void **
Martin v. Löwis18e16552006-02-15 17:27:45 +00005902slotptr(PyTypeObject *type, int ioffset)
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005903{
5904 char *ptr;
Martin v. Löwis18e16552006-02-15 17:27:45 +00005905 long offset = ioffset;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005906
Guido van Rossume5c691a2003-03-07 15:13:17 +00005907 /* Note: this depends on the order of the members of PyHeapTypeObject! */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005908 assert(offset >= 0);
Skip Montanaro429433b2006-04-18 00:35:43 +00005909 assert((size_t)offset < offsetof(PyHeapTypeObject, as_buffer));
5910 if ((size_t)offset >= offsetof(PyHeapTypeObject, as_sequence)) {
Martin v. Löwisee36d652006-04-11 09:08:02 +00005911 ptr = (char *)type->tp_as_sequence;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005912 offset -= offsetof(PyHeapTypeObject, as_sequence);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005913 }
Skip Montanaro429433b2006-04-18 00:35:43 +00005914 else if ((size_t)offset >= offsetof(PyHeapTypeObject, as_mapping)) {
Martin v. Löwisee36d652006-04-11 09:08:02 +00005915 ptr = (char *)type->tp_as_mapping;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005916 offset -= offsetof(PyHeapTypeObject, as_mapping);
Guido van Rossum09638c12002-06-13 19:17:46 +00005917 }
Skip Montanaro429433b2006-04-18 00:35:43 +00005918 else if ((size_t)offset >= offsetof(PyHeapTypeObject, as_number)) {
Martin v. Löwisee36d652006-04-11 09:08:02 +00005919 ptr = (char *)type->tp_as_number;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005920 offset -= offsetof(PyHeapTypeObject, as_number);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005921 }
5922 else {
Martin v. Löwisee36d652006-04-11 09:08:02 +00005923 ptr = (char *)type;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005924 }
5925 if (ptr != NULL)
5926 ptr += offset;
5927 return (void **)ptr;
5928}
Guido van Rossumf040ede2001-08-07 16:40:56 +00005929
Guido van Rossumc334df52002-04-04 23:44:47 +00005930/* Length of array of slotdef pointers used to store slots with the
5931 same __name__. There should be at most MAX_EQUIV-1 slotdef entries with
5932 the same __name__, for any __name__. Since that's a static property, it is
5933 appropriate to declare fixed-size arrays for this. */
5934#define MAX_EQUIV 10
5935
5936/* Return a slot pointer for a given name, but ONLY if the attribute has
5937 exactly one slot function. The name must be an interned string. */
5938static void **
5939resolve_slotdups(PyTypeObject *type, PyObject *name)
5940{
5941 /* XXX Maybe this could be optimized more -- but is it worth it? */
5942
5943 /* pname and ptrs act as a little cache */
5944 static PyObject *pname;
5945 static slotdef *ptrs[MAX_EQUIV];
5946 slotdef *p, **pp;
5947 void **res, **ptr;
5948
5949 if (pname != name) {
5950 /* Collect all slotdefs that match name into ptrs. */
5951 pname = name;
5952 pp = ptrs;
5953 for (p = slotdefs; p->name_strobj; p++) {
5954 if (p->name_strobj == name)
5955 *pp++ = p;
5956 }
5957 *pp = NULL;
5958 }
5959
5960 /* Look in all matching slots of the type; if exactly one of these has
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005961 a filled-in slot, return its value. Otherwise return NULL. */
Guido van Rossumc334df52002-04-04 23:44:47 +00005962 res = NULL;
5963 for (pp = ptrs; *pp; pp++) {
5964 ptr = slotptr(type, (*pp)->offset);
5965 if (ptr == NULL || *ptr == NULL)
5966 continue;
5967 if (res != NULL)
5968 return NULL;
5969 res = ptr;
5970 }
5971 return res;
5972}
5973
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005974/* Common code for update_slots_callback() and fixup_slot_dispatchers(). This
Guido van Rossumc334df52002-04-04 23:44:47 +00005975 does some incredibly complex thinking and then sticks something into the
5976 slot. (It sees if the adjacent slotdefs for the same slot have conflicting
5977 interests, and then stores a generic wrapper or a specific function into
5978 the slot.) Return a pointer to the next slotdef with a different offset,
5979 because that's convenient for fixup_slot_dispatchers(). */
5980static slotdef *
5981update_one_slot(PyTypeObject *type, slotdef *p)
5982{
5983 PyObject *descr;
5984 PyWrapperDescrObject *d;
5985 void *generic = NULL, *specific = NULL;
5986 int use_generic = 0;
5987 int offset = p->offset;
5988 void **ptr = slotptr(type, offset);
5989
5990 if (ptr == NULL) {
5991 do {
5992 ++p;
5993 } while (p->offset == offset);
5994 return p;
5995 }
5996 do {
5997 descr = _PyType_Lookup(type, p->name_strobj);
5998 if (descr == NULL)
5999 continue;
Christian Heimese93237d2007-12-19 02:37:44 +00006000 if (Py_TYPE(descr) == &PyWrapperDescr_Type) {
Guido van Rossumc334df52002-04-04 23:44:47 +00006001 void **tptr = resolve_slotdups(type, p->name_strobj);
6002 if (tptr == NULL || tptr == ptr)
6003 generic = p->function;
6004 d = (PyWrapperDescrObject *)descr;
6005 if (d->d_base->wrapper == p->wrapper &&
6006 PyType_IsSubtype(type, d->d_type))
6007 {
6008 if (specific == NULL ||
6009 specific == d->d_wrapped)
6010 specific = d->d_wrapped;
6011 else
6012 use_generic = 1;
6013 }
6014 }
Christian Heimese93237d2007-12-19 02:37:44 +00006015 else if (Py_TYPE(descr) == &PyCFunction_Type &&
Guido van Rossum721f62e2002-08-09 02:14:34 +00006016 PyCFunction_GET_FUNCTION(descr) ==
6017 (PyCFunction)tp_new_wrapper &&
6018 strcmp(p->name, "__new__") == 0)
6019 {
6020 /* The __new__ wrapper is not a wrapper descriptor,
6021 so must be special-cased differently.
6022 If we don't do this, creating an instance will
6023 always use slot_tp_new which will look up
6024 __new__ in the MRO which will call tp_new_wrapper
6025 which will look through the base classes looking
6026 for a static base and call its tp_new (usually
6027 PyType_GenericNew), after performing various
6028 sanity checks and constructing a new argument
6029 list. Cut all that nonsense short -- this speeds
6030 up instance creation tremendously. */
Martin v. Löwisa94568a2003-05-10 07:36:56 +00006031 specific = (void *)type->tp_new;
Guido van Rossum721f62e2002-08-09 02:14:34 +00006032 /* XXX I'm not 100% sure that there isn't a hole
6033 in this reasoning that requires additional
6034 sanity checks. I'll buy the first person to
6035 point out a bug in this reasoning a beer. */
6036 }
Guido van Rossumc334df52002-04-04 23:44:47 +00006037 else {
6038 use_generic = 1;
6039 generic = p->function;
6040 }
6041 } while ((++p)->offset == offset);
6042 if (specific && !use_generic)
6043 *ptr = specific;
6044 else
6045 *ptr = generic;
6046 return p;
6047}
6048
Guido van Rossum8d24ee92003-03-24 23:49:49 +00006049/* In the type, update the slots whose slotdefs are gathered in the pp array.
6050 This is a callback for update_subclasses(). */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006051static int
Guido van Rossum8d24ee92003-03-24 23:49:49 +00006052update_slots_callback(PyTypeObject *type, void *data)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006053{
Guido van Rossum8d24ee92003-03-24 23:49:49 +00006054 slotdef **pp = (slotdef **)data;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006055
Guido van Rossum8d24ee92003-03-24 23:49:49 +00006056 for (; *pp; pp++)
Guido van Rossumc334df52002-04-04 23:44:47 +00006057 update_one_slot(type, *pp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006058 return 0;
6059}
6060
Guido van Rossumc334df52002-04-04 23:44:47 +00006061/* Comparison function for qsort() to compare slotdefs by their offset, and
6062 for equal offset by their address (to force a stable sort). */
Guido van Rossumd396b9c2001-10-13 20:02:41 +00006063static int
6064slotdef_cmp(const void *aa, const void *bb)
6065{
6066 const slotdef *a = (const slotdef *)aa, *b = (const slotdef *)bb;
6067 int c = a->offset - b->offset;
6068 if (c != 0)
6069 return c;
6070 else
Martin v. Löwis18e16552006-02-15 17:27:45 +00006071 /* Cannot use a-b, as this gives off_t,
6072 which may lose precision when converted to int. */
6073 return (a > b) ? 1 : (a < b) ? -1 : 0;
Guido van Rossumd396b9c2001-10-13 20:02:41 +00006074}
6075
Guido van Rossumc334df52002-04-04 23:44:47 +00006076/* Initialize the slotdefs table by adding interned string objects for the
6077 names and sorting the entries. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006078static void
Guido van Rossumd396b9c2001-10-13 20:02:41 +00006079init_slotdefs(void)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006080{
6081 slotdef *p;
6082 static int initialized = 0;
6083
6084 if (initialized)
6085 return;
6086 for (p = slotdefs; p->name; p++) {
Christian Heimes593daf52008-05-26 12:51:38 +00006087 p->name_strobj = PyBytes_InternFromString(p->name);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006088 if (!p->name_strobj)
Guido van Rossumc334df52002-04-04 23:44:47 +00006089 Py_FatalError("Out of memory interning slotdef names");
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006090 }
Guido van Rossumb85a8b72001-10-16 17:00:48 +00006091 qsort((void *)slotdefs, (size_t)(p-slotdefs), sizeof(slotdef),
6092 slotdef_cmp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006093 initialized = 1;
6094}
6095
Guido van Rossumc334df52002-04-04 23:44:47 +00006096/* Update the slots after assignment to a class (type) attribute. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006097static int
6098update_slot(PyTypeObject *type, PyObject *name)
6099{
Guido van Rossumc334df52002-04-04 23:44:47 +00006100 slotdef *ptrs[MAX_EQUIV];
Guido van Rossumd396b9c2001-10-13 20:02:41 +00006101 slotdef *p;
6102 slotdef **pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00006103 int offset;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006104
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +00006105 /* Clear the VALID_VERSION flag of 'type' and all its
6106 subclasses. This could possibly be unified with the
6107 update_subclasses() recursion below, but carefully:
6108 they each have their own conditions on which to stop
6109 recursing into subclasses. */
Georg Brandl74a1dea2008-05-28 11:21:39 +00006110 PyType_Modified(type);
Amaury Forgeot d'Arce4c270c2008-01-14 00:29:41 +00006111
Guido van Rossumb85a8b72001-10-16 17:00:48 +00006112 init_slotdefs();
6113 pp = ptrs;
6114 for (p = slotdefs; p->name; p++) {
6115 /* XXX assume name is interned! */
6116 if (p->name_strobj == name)
6117 *pp++ = p;
6118 }
6119 *pp = NULL;
Guido van Rossumd396b9c2001-10-13 20:02:41 +00006120 for (pp = ptrs; *pp; pp++) {
6121 p = *pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00006122 offset = p->offset;
6123 while (p > slotdefs && (p-1)->offset == offset)
Guido van Rossumd396b9c2001-10-13 20:02:41 +00006124 --p;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00006125 *pp = p;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006126 }
Guido van Rossumc334df52002-04-04 23:44:47 +00006127 if (ptrs[0] == NULL)
6128 return 0; /* Not an attribute that affects any slots */
Guido van Rossum8d24ee92003-03-24 23:49:49 +00006129 return update_subclasses(type, name,
6130 update_slots_callback, (void *)ptrs);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00006131}
6132
Guido van Rossumc334df52002-04-04 23:44:47 +00006133/* Store the proper functions in the slot dispatches at class (type)
6134 definition time, based upon which operations the class overrides in its
6135 dict. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00006136static void
Guido van Rossum7b9144b2001-10-09 19:39:46 +00006137fixup_slot_dispatchers(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00006138{
Guido van Rossum7b9144b2001-10-09 19:39:46 +00006139 slotdef *p;
Tim Peters6d6c1a32001-08-02 04:15:00 +00006140
Guido van Rossumd396b9c2001-10-13 20:02:41 +00006141 init_slotdefs();
Guido van Rossumc334df52002-04-04 23:44:47 +00006142 for (p = slotdefs; p->name; )
6143 p = update_one_slot(type, p);
Tim Peters6d6c1a32001-08-02 04:15:00 +00006144}
Guido van Rossum705f0f52001-08-24 16:47:00 +00006145
Michael W. Hudson98bbc492002-11-26 14:47:27 +00006146static void
6147update_all_slots(PyTypeObject* type)
6148{
6149 slotdef *p;
6150
6151 init_slotdefs();
6152 for (p = slotdefs; p->name; p++) {
6153 /* update_slot returns int but can't actually fail */
6154 update_slot(type, p->name_strobj);
6155 }
6156}
6157
Guido van Rossum8d24ee92003-03-24 23:49:49 +00006158/* recurse_down_subclasses() and update_subclasses() are mutually
6159 recursive functions to call a callback for all subclasses,
6160 but refraining from recursing into subclasses that define 'name'. */
6161
6162static int
6163update_subclasses(PyTypeObject *type, PyObject *name,
6164 update_callback callback, void *data)
6165{
6166 if (callback(type, data) < 0)
6167 return -1;
6168 return recurse_down_subclasses(type, name, callback, data);
6169}
6170
6171static int
6172recurse_down_subclasses(PyTypeObject *type, PyObject *name,
6173 update_callback callback, void *data)
6174{
6175 PyTypeObject *subclass;
6176 PyObject *ref, *subclasses, *dict;
Martin v. Löwis18e16552006-02-15 17:27:45 +00006177 Py_ssize_t i, n;
Guido van Rossum8d24ee92003-03-24 23:49:49 +00006178
6179 subclasses = type->tp_subclasses;
6180 if (subclasses == NULL)
6181 return 0;
6182 assert(PyList_Check(subclasses));
6183 n = PyList_GET_SIZE(subclasses);
6184 for (i = 0; i < n; i++) {
6185 ref = PyList_GET_ITEM(subclasses, i);
6186 assert(PyWeakref_CheckRef(ref));
6187 subclass = (PyTypeObject *)PyWeakref_GET_OBJECT(ref);
6188 assert(subclass != NULL);
6189 if ((PyObject *)subclass == Py_None)
6190 continue;
6191 assert(PyType_Check(subclass));
6192 /* Avoid recursing down into unaffected classes */
6193 dict = subclass->tp_dict;
6194 if (dict != NULL && PyDict_Check(dict) &&
6195 PyDict_GetItem(dict, name) != NULL)
6196 continue;
6197 if (update_subclasses(subclass, name, callback, data) < 0)
6198 return -1;
6199 }
6200 return 0;
6201}
6202
Guido van Rossum6d204072001-10-21 00:44:31 +00006203/* This function is called by PyType_Ready() to populate the type's
6204 dictionary with method descriptors for function slots. For each
Guido van Rossum09638c12002-06-13 19:17:46 +00006205 function slot (like tp_repr) that's defined in the type, one or more
6206 corresponding descriptors are added in the type's tp_dict dictionary
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006207 under the appropriate name (like __repr__). Some function slots
Guido van Rossum09638c12002-06-13 19:17:46 +00006208 cause more than one descriptor to be added (for example, the nb_add
6209 slot adds both __add__ and __radd__ descriptors) and some function
6210 slots compete for the same descriptor (for example both sq_item and
6211 mp_subscript generate a __getitem__ descriptor).
6212
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006213 In the latter case, the first slotdef entry encoutered wins. Since
Tim Petersbf9b2442003-03-23 05:35:36 +00006214 slotdef entries are sorted by the offset of the slot in the
Guido van Rossume5c691a2003-03-07 15:13:17 +00006215 PyHeapTypeObject, this gives us some control over disambiguating
Guido van Rossum8d24ee92003-03-24 23:49:49 +00006216 between competing slots: the members of PyHeapTypeObject are listed
6217 from most general to least general, so the most general slot is
6218 preferred. In particular, because as_mapping comes before as_sequence,
6219 for a type that defines both mp_subscript and sq_item, mp_subscript
6220 wins.
Guido van Rossum09638c12002-06-13 19:17:46 +00006221
6222 This only adds new descriptors and doesn't overwrite entries in
6223 tp_dict that were previously defined. The descriptors contain a
6224 reference to the C function they must call, so that it's safe if they
6225 are copied into a subtype's __dict__ and the subtype has a different
6226 C function in its slot -- calling the method defined by the
6227 descriptor will call the C function that was used to create it,
6228 rather than the C function present in the slot when it is called.
6229 (This is important because a subtype may have a C function in the
6230 slot that calls the method from the dictionary, and we want to avoid
6231 infinite recursion here.) */
Guido van Rossum6d204072001-10-21 00:44:31 +00006232
6233static int
6234add_operators(PyTypeObject *type)
6235{
6236 PyObject *dict = type->tp_dict;
6237 slotdef *p;
6238 PyObject *descr;
6239 void **ptr;
6240
6241 init_slotdefs();
6242 for (p = slotdefs; p->name; p++) {
6243 if (p->wrapper == NULL)
6244 continue;
6245 ptr = slotptr(type, p->offset);
6246 if (!ptr || !*ptr)
6247 continue;
6248 if (PyDict_GetItem(dict, p->name_strobj))
6249 continue;
6250 descr = PyDescr_NewWrapper(type, p, *ptr);
6251 if (descr == NULL)
6252 return -1;
6253 if (PyDict_SetItem(dict, p->name_strobj, descr) < 0)
6254 return -1;
6255 Py_DECREF(descr);
6256 }
6257 if (type->tp_new != NULL) {
6258 if (add_tp_new_wrapper(type) < 0)
6259 return -1;
6260 }
6261 return 0;
6262}
6263
Guido van Rossum705f0f52001-08-24 16:47:00 +00006264
6265/* Cooperative 'super' */
6266
6267typedef struct {
6268 PyObject_HEAD
Guido van Rossume705ef12001-08-29 15:47:06 +00006269 PyTypeObject *type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006270 PyObject *obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006271 PyTypeObject *obj_type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006272} superobject;
6273
Guido van Rossum6f799372001-09-20 20:46:19 +00006274static PyMemberDef super_members[] = {
6275 {"__thisclass__", T_OBJECT, offsetof(superobject, type), READONLY,
6276 "the class invoking super()"},
6277 {"__self__", T_OBJECT, offsetof(superobject, obj), READONLY,
6278 "the instance invoking super(); may be None"},
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006279 {"__self_class__", T_OBJECT, offsetof(superobject, obj_type), READONLY,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +00006280 "the type of the instance invoking super(); may be None"},
Guido van Rossum41eb14d2001-08-30 23:13:11 +00006281 {0}
6282};
6283
Guido van Rossum705f0f52001-08-24 16:47:00 +00006284static void
6285super_dealloc(PyObject *self)
6286{
6287 superobject *su = (superobject *)self;
6288
Guido van Rossum048eb752001-10-02 21:24:57 +00006289 _PyObject_GC_UNTRACK(self);
Guido van Rossum705f0f52001-08-24 16:47:00 +00006290 Py_XDECREF(su->obj);
6291 Py_XDECREF(su->type);
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006292 Py_XDECREF(su->obj_type);
Christian Heimese93237d2007-12-19 02:37:44 +00006293 Py_TYPE(self)->tp_free(self);
Guido van Rossum705f0f52001-08-24 16:47:00 +00006294}
6295
6296static PyObject *
Guido van Rossum41eb14d2001-08-30 23:13:11 +00006297super_repr(PyObject *self)
6298{
6299 superobject *su = (superobject *)self;
6300
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006301 if (su->obj_type)
Christian Heimes593daf52008-05-26 12:51:38 +00006302 return PyBytes_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00006303 "<super: <class '%s'>, <%s object>>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00006304 su->type ? su->type->tp_name : "NULL",
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006305 su->obj_type->tp_name);
Guido van Rossum41eb14d2001-08-30 23:13:11 +00006306 else
Christian Heimes593daf52008-05-26 12:51:38 +00006307 return PyBytes_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00006308 "<super: <class '%s'>, NULL>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00006309 su->type ? su->type->tp_name : "NULL");
6310}
6311
6312static PyObject *
Guido van Rossum705f0f52001-08-24 16:47:00 +00006313super_getattro(PyObject *self, PyObject *name)
6314{
6315 superobject *su = (superobject *)self;
Guido van Rossum76ba09f2003-04-16 19:40:58 +00006316 int skip = su->obj_type == NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006317
Guido van Rossum76ba09f2003-04-16 19:40:58 +00006318 if (!skip) {
6319 /* We want __class__ to return the class of the super object
6320 (i.e. super, or a subclass), not the class of su->obj. */
Christian Heimes593daf52008-05-26 12:51:38 +00006321 skip = (PyBytes_Check(name) &&
6322 PyBytes_GET_SIZE(name) == 9 &&
6323 strcmp(PyBytes_AS_STRING(name), "__class__") == 0);
Guido van Rossum76ba09f2003-04-16 19:40:58 +00006324 }
6325
6326 if (!skip) {
Tim Petersa91e9642001-11-14 23:32:33 +00006327 PyObject *mro, *res, *tmp, *dict;
Guido van Rossum155db9a2002-04-02 17:53:47 +00006328 PyTypeObject *starttype;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006329 descrgetfunc f;
Martin v. Löwis18e16552006-02-15 17:27:45 +00006330 Py_ssize_t i, n;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006331
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006332 starttype = su->obj_type;
Guido van Rossum155db9a2002-04-02 17:53:47 +00006333 mro = starttype->tp_mro;
6334
Guido van Rossum41eb14d2001-08-30 23:13:11 +00006335 if (mro == NULL)
6336 n = 0;
6337 else {
6338 assert(PyTuple_Check(mro));
6339 n = PyTuple_GET_SIZE(mro);
6340 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00006341 for (i = 0; i < n; i++) {
Guido van Rossume705ef12001-08-29 15:47:06 +00006342 if ((PyObject *)(su->type) == PyTuple_GET_ITEM(mro, i))
Guido van Rossum705f0f52001-08-24 16:47:00 +00006343 break;
6344 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00006345 i++;
6346 res = NULL;
6347 for (; i < n; i++) {
6348 tmp = PyTuple_GET_ITEM(mro, i);
Tim Petersa91e9642001-11-14 23:32:33 +00006349 if (PyType_Check(tmp))
6350 dict = ((PyTypeObject *)tmp)->tp_dict;
6351 else if (PyClass_Check(tmp))
6352 dict = ((PyClassObject *)tmp)->cl_dict;
6353 else
6354 continue;
6355 res = PyDict_GetItem(dict, name);
Guido van Rossum6cc5bb62003-04-16 20:01:36 +00006356 if (res != NULL) {
Guido van Rossum705f0f52001-08-24 16:47:00 +00006357 Py_INCREF(res);
Christian Heimese93237d2007-12-19 02:37:44 +00006358 f = Py_TYPE(res)->tp_descr_get;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006359 if (f != NULL) {
Phillip J. Eby91a968a2004-03-25 02:19:34 +00006360 tmp = f(res,
6361 /* Only pass 'obj' param if
6362 this is instance-mode super
6363 (See SF ID #743627)
6364 */
Hye-Shik Changff365c92004-03-25 16:37:03 +00006365 (su->obj == (PyObject *)
6366 su->obj_type
Phillip J. Eby91a968a2004-03-25 02:19:34 +00006367 ? (PyObject *)NULL
6368 : su->obj),
Guido van Rossumd4641072002-04-03 02:13:37 +00006369 (PyObject *)starttype);
Guido van Rossum705f0f52001-08-24 16:47:00 +00006370 Py_DECREF(res);
6371 res = tmp;
6372 }
6373 return res;
6374 }
6375 }
6376 }
6377 return PyObject_GenericGetAttr(self, name);
6378}
6379
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006380static PyTypeObject *
Guido van Rossum5b443c62001-12-03 15:38:28 +00006381supercheck(PyTypeObject *type, PyObject *obj)
6382{
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006383 /* Check that a super() call makes sense. Return a type object.
6384
6385 obj can be a new-style class, or an instance of one:
6386
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006387 - If it is a class, it must be a subclass of 'type'. This case is
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006388 used for class methods; the return value is obj.
6389
6390 - If it is an instance, it must be an instance of 'type'. This is
6391 the normal case; the return value is obj.__class__.
6392
6393 But... when obj is an instance, we want to allow for the case where
Christian Heimese93237d2007-12-19 02:37:44 +00006394 Py_TYPE(obj) is not a subclass of type, but obj.__class__ is!
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006395 This will allow using super() with a proxy for obj.
6396 */
6397
Guido van Rossum8e80a722003-02-18 19:22:22 +00006398 /* Check for first bullet above (special case) */
6399 if (PyType_Check(obj) && PyType_IsSubtype((PyTypeObject *)obj, type)) {
6400 Py_INCREF(obj);
6401 return (PyTypeObject *)obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006402 }
Guido van Rossum8e80a722003-02-18 19:22:22 +00006403
6404 /* Normal case */
Christian Heimese93237d2007-12-19 02:37:44 +00006405 if (PyType_IsSubtype(Py_TYPE(obj), type)) {
6406 Py_INCREF(Py_TYPE(obj));
6407 return Py_TYPE(obj);
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006408 }
6409 else {
6410 /* Try the slow way */
6411 static PyObject *class_str = NULL;
6412 PyObject *class_attr;
6413
6414 if (class_str == NULL) {
Christian Heimes593daf52008-05-26 12:51:38 +00006415 class_str = PyBytes_FromString("__class__");
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006416 if (class_str == NULL)
6417 return NULL;
6418 }
6419
6420 class_attr = PyObject_GetAttr(obj, class_str);
6421
6422 if (class_attr != NULL &&
6423 PyType_Check(class_attr) &&
Christian Heimese93237d2007-12-19 02:37:44 +00006424 (PyTypeObject *)class_attr != Py_TYPE(obj))
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006425 {
6426 int ok = PyType_IsSubtype(
6427 (PyTypeObject *)class_attr, type);
6428 if (ok)
6429 return (PyTypeObject *)class_attr;
6430 }
6431
6432 if (class_attr == NULL)
6433 PyErr_Clear();
6434 else
6435 Py_DECREF(class_attr);
6436 }
6437
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006438 PyErr_SetString(PyExc_TypeError,
Guido van Rossum5b443c62001-12-03 15:38:28 +00006439 "super(type, obj): "
6440 "obj must be an instance or subtype of type");
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006441 return NULL;
Guido van Rossum5b443c62001-12-03 15:38:28 +00006442}
6443
Guido van Rossum705f0f52001-08-24 16:47:00 +00006444static PyObject *
6445super_descr_get(PyObject *self, PyObject *obj, PyObject *type)
6446{
6447 superobject *su = (superobject *)self;
Anthony Baxtera6286212006-04-11 07:42:36 +00006448 superobject *newobj;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006449
6450 if (obj == NULL || obj == Py_None || su->obj != NULL) {
6451 /* Not binding to an object, or already bound */
6452 Py_INCREF(self);
6453 return self;
6454 }
Christian Heimese93237d2007-12-19 02:37:44 +00006455 if (Py_TYPE(su) != &PySuper_Type)
Armin Rigo7726dc02005-05-15 15:32:08 +00006456 /* If su is an instance of a (strict) subclass of super,
Guido van Rossum5b443c62001-12-03 15:38:28 +00006457 call its type */
Christian Heimese93237d2007-12-19 02:37:44 +00006458 return PyObject_CallFunctionObjArgs((PyObject *)Py_TYPE(su),
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006459 su->type, obj, NULL);
Guido van Rossum5b443c62001-12-03 15:38:28 +00006460 else {
6461 /* Inline the common case */
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006462 PyTypeObject *obj_type = supercheck(su->type, obj);
6463 if (obj_type == NULL)
Guido van Rossum5b443c62001-12-03 15:38:28 +00006464 return NULL;
Anthony Baxtera6286212006-04-11 07:42:36 +00006465 newobj = (superobject *)PySuper_Type.tp_new(&PySuper_Type,
Guido van Rossum5b443c62001-12-03 15:38:28 +00006466 NULL, NULL);
Anthony Baxtera6286212006-04-11 07:42:36 +00006467 if (newobj == NULL)
Guido van Rossum5b443c62001-12-03 15:38:28 +00006468 return NULL;
6469 Py_INCREF(su->type);
6470 Py_INCREF(obj);
Anthony Baxtera6286212006-04-11 07:42:36 +00006471 newobj->type = su->type;
6472 newobj->obj = obj;
6473 newobj->obj_type = obj_type;
6474 return (PyObject *)newobj;
Guido van Rossum5b443c62001-12-03 15:38:28 +00006475 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00006476}
6477
6478static int
6479super_init(PyObject *self, PyObject *args, PyObject *kwds)
6480{
6481 superobject *su = (superobject *)self;
Guido van Rossume705ef12001-08-29 15:47:06 +00006482 PyTypeObject *type;
6483 PyObject *obj = NULL;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006484 PyTypeObject *obj_type = NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006485
Georg Brandl5d59c092006-09-30 08:43:30 +00006486 if (!_PyArg_NoKeywords("super", kwds))
6487 return -1;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006488 if (!PyArg_ParseTuple(args, "O!|O:super", &PyType_Type, &type, &obj))
6489 return -1;
6490 if (obj == Py_None)
6491 obj = NULL;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006492 if (obj != NULL) {
6493 obj_type = supercheck(type, obj);
6494 if (obj_type == NULL)
6495 return -1;
6496 Py_INCREF(obj);
6497 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00006498 Py_INCREF(type);
Guido van Rossum705f0f52001-08-24 16:47:00 +00006499 su->type = type;
6500 su->obj = obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006501 su->obj_type = obj_type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006502 return 0;
6503}
6504
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00006505PyDoc_STRVAR(super_doc,
Guido van Rossum705f0f52001-08-24 16:47:00 +00006506"super(type) -> unbound super object\n"
6507"super(type, obj) -> bound super object; requires isinstance(obj, type)\n"
Guido van Rossume705ef12001-08-29 15:47:06 +00006508"super(type, type2) -> bound super object; requires issubclass(type2, type)\n"
Guido van Rossum705f0f52001-08-24 16:47:00 +00006509"Typical use to call a cooperative superclass method:\n"
6510"class C(B):\n"
6511" def meth(self, arg):\n"
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006512" super(C, self).meth(arg)");
Guido van Rossum705f0f52001-08-24 16:47:00 +00006513
Guido van Rossum048eb752001-10-02 21:24:57 +00006514static int
6515super_traverse(PyObject *self, visitproc visit, void *arg)
6516{
6517 superobject *su = (superobject *)self;
Guido van Rossum048eb752001-10-02 21:24:57 +00006518
Thomas Woutersc6e55062006-04-15 21:47:09 +00006519 Py_VISIT(su->obj);
6520 Py_VISIT(su->type);
6521 Py_VISIT(su->obj_type);
Guido van Rossum048eb752001-10-02 21:24:57 +00006522
6523 return 0;
6524}
6525
Guido van Rossum705f0f52001-08-24 16:47:00 +00006526PyTypeObject PySuper_Type = {
Martin v. Löwis68192102007-07-21 06:55:02 +00006527 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossum705f0f52001-08-24 16:47:00 +00006528 "super", /* tp_name */
6529 sizeof(superobject), /* tp_basicsize */
6530 0, /* tp_itemsize */
6531 /* methods */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006532 super_dealloc, /* tp_dealloc */
Guido van Rossum705f0f52001-08-24 16:47:00 +00006533 0, /* tp_print */
6534 0, /* tp_getattr */
6535 0, /* tp_setattr */
6536 0, /* tp_compare */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00006537 super_repr, /* tp_repr */
Guido van Rossum705f0f52001-08-24 16:47:00 +00006538 0, /* tp_as_number */
6539 0, /* tp_as_sequence */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006540 0, /* tp_as_mapping */
Guido van Rossum705f0f52001-08-24 16:47:00 +00006541 0, /* tp_hash */
6542 0, /* tp_call */
6543 0, /* tp_str */
6544 super_getattro, /* tp_getattro */
6545 0, /* tp_setattro */
6546 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00006547 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
6548 Py_TPFLAGS_BASETYPE, /* tp_flags */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006549 super_doc, /* tp_doc */
6550 super_traverse, /* tp_traverse */
6551 0, /* tp_clear */
Guido van Rossum705f0f52001-08-24 16:47:00 +00006552 0, /* tp_richcompare */
6553 0, /* tp_weaklistoffset */
6554 0, /* tp_iter */
6555 0, /* tp_iternext */
6556 0, /* tp_methods */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00006557 super_members, /* tp_members */
Guido van Rossum705f0f52001-08-24 16:47:00 +00006558 0, /* tp_getset */
6559 0, /* tp_base */
6560 0, /* tp_dict */
6561 super_descr_get, /* tp_descr_get */
6562 0, /* tp_descr_set */
6563 0, /* tp_dictoffset */
6564 super_init, /* tp_init */
6565 PyType_GenericAlloc, /* tp_alloc */
6566 PyType_GenericNew, /* tp_new */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006567 PyObject_GC_Del, /* tp_free */
Guido van Rossum705f0f52001-08-24 16:47:00 +00006568};