blob: 020a9bb646a47a0f2f85debe99fc17449404bf2d [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
Guido van Rossum6f799372001-09-20 20:46:19 +00008static PyMemberDef type_members[] = {
Tim Peters6d6c1a32001-08-02 04:15:00 +00009 {"__basicsize__", T_INT, offsetof(PyTypeObject,tp_basicsize),READONLY},
10 {"__itemsize__", T_INT, offsetof(PyTypeObject, tp_itemsize), READONLY},
11 {"__flags__", T_LONG, offsetof(PyTypeObject, tp_flags), READONLY},
Guido van Rossum9676b222001-08-17 20:32:36 +000012 {"__weakrefoffset__", T_LONG,
Tim Peters6d6c1a32001-08-02 04:15:00 +000013 offsetof(PyTypeObject, tp_weaklistoffset), READONLY},
14 {"__base__", T_OBJECT, offsetof(PyTypeObject, tp_base), READONLY},
15 {"__dictoffset__", T_LONG,
16 offsetof(PyTypeObject, tp_dictoffset), READONLY},
Tim Peters6d6c1a32001-08-02 04:15:00 +000017 {"__mro__", T_OBJECT, offsetof(PyTypeObject, tp_mro), READONLY},
18 {0}
19};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000020
Guido van Rossumc0b618a1997-05-02 03:12:38 +000021static PyObject *
Guido van Rossumc3542212001-08-16 09:18:56 +000022type_name(PyTypeObject *type, void *context)
23{
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000024 const char *s;
Guido van Rossumc3542212001-08-16 09:18:56 +000025
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +000026 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE) {
Guido van Rossume5c691a2003-03-07 15:13:17 +000027 PyHeapTypeObject* et = (PyHeapTypeObject*)type;
Tim Petersea7f75d2002-12-07 21:39:16 +000028
Georg Brandlc255c7b2006-02-20 22:27:28 +000029 Py_INCREF(et->ht_name);
30 return et->ht_name;
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +000031 }
32 else {
33 s = strrchr(type->tp_name, '.');
34 if (s == NULL)
35 s = type->tp_name;
36 else
37 s++;
38 return PyString_FromString(s);
39 }
Guido van Rossumc3542212001-08-16 09:18:56 +000040}
41
Michael W. Hudson98bbc492002-11-26 14:47:27 +000042static int
43type_set_name(PyTypeObject *type, PyObject *value, void *context)
44{
Guido van Rossume5c691a2003-03-07 15:13:17 +000045 PyHeapTypeObject* et;
Michael W. Hudson98bbc492002-11-26 14:47:27 +000046
47 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
48 PyErr_Format(PyExc_TypeError,
49 "can't set %s.__name__", type->tp_name);
50 return -1;
51 }
52 if (!value) {
53 PyErr_Format(PyExc_TypeError,
54 "can't delete %s.__name__", type->tp_name);
55 return -1;
56 }
57 if (!PyString_Check(value)) {
58 PyErr_Format(PyExc_TypeError,
59 "can only assign string to %s.__name__, not '%s'",
60 type->tp_name, value->ob_type->tp_name);
61 return -1;
62 }
Tim Petersea7f75d2002-12-07 21:39:16 +000063 if (strlen(PyString_AS_STRING(value))
Michael W. Hudson98bbc492002-11-26 14:47:27 +000064 != (size_t)PyString_GET_SIZE(value)) {
65 PyErr_Format(PyExc_ValueError,
66 "__name__ must not contain null bytes");
67 return -1;
68 }
69
Guido van Rossume5c691a2003-03-07 15:13:17 +000070 et = (PyHeapTypeObject*)type;
Michael W. Hudson98bbc492002-11-26 14:47:27 +000071
72 Py_INCREF(value);
73
Georg Brandlc255c7b2006-02-20 22:27:28 +000074 Py_DECREF(et->ht_name);
75 et->ht_name = value;
Michael W. Hudson98bbc492002-11-26 14:47:27 +000076
77 type->tp_name = PyString_AS_STRING(value);
78
79 return 0;
80}
81
Guido van Rossumc3542212001-08-16 09:18:56 +000082static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +000083type_module(PyTypeObject *type, void *context)
Guido van Rossum29ca26e1995-01-07 11:58:15 +000084{
Guido van Rossumc3542212001-08-16 09:18:56 +000085 PyObject *mod;
86 char *s;
87
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +000088 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE) {
89 mod = PyDict_GetItemString(type->tp_dict, "__module__");
Anthony Baxter3ecdb252004-06-11 14:41:18 +000090 if (!mod) {
91 PyErr_Format(PyExc_AttributeError, "__module__");
92 return 0;
93 }
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +000094 Py_XINCREF(mod);
Guido van Rossumc3542212001-08-16 09:18:56 +000095 return mod;
96 }
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +000097 else {
98 s = strrchr(type->tp_name, '.');
99 if (s != NULL)
100 return PyString_FromStringAndSize(
Armin Rigo7ccbca92006-10-04 12:17:45 +0000101 type->tp_name, (Py_ssize_t)(s - type->tp_name));
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +0000102 return PyString_FromString("__builtin__");
103 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000104}
105
Guido van Rossum3926a632001-09-25 16:25:58 +0000106static int
107type_set_module(PyTypeObject *type, PyObject *value, void *context)
108{
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000109 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
Guido van Rossum3926a632001-09-25 16:25:58 +0000110 PyErr_Format(PyExc_TypeError,
111 "can't set %s.__module__", type->tp_name);
112 return -1;
113 }
114 if (!value) {
115 PyErr_Format(PyExc_TypeError,
116 "can't delete %s.__module__", type->tp_name);
117 return -1;
118 }
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000119
Guido van Rossum3926a632001-09-25 16:25:58 +0000120 return PyDict_SetItemString(type->tp_dict, "__module__", value);
121}
122
Tim Peters6d6c1a32001-08-02 04:15:00 +0000123static PyObject *
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000124type_get_bases(PyTypeObject *type, void *context)
125{
126 Py_INCREF(type->tp_bases);
127 return type->tp_bases;
128}
129
Jeremy Hyltonfa955692007-02-27 18:29:45 +0000130static PyTypeObject *most_derived_metaclass(PyTypeObject *, PyObject *);
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000131static PyTypeObject *best_base(PyObject *);
132static int mro_internal(PyTypeObject *);
133static int compatible_for_assignment(PyTypeObject *, PyTypeObject *, char *);
134static int add_subclass(PyTypeObject*, PyTypeObject*);
135static void remove_subclass(PyTypeObject *, PyTypeObject *);
136static void update_all_slots(PyTypeObject *);
137
Guido van Rossum8d24ee92003-03-24 23:49:49 +0000138typedef int (*update_callback)(PyTypeObject *, void *);
139static int update_subclasses(PyTypeObject *type, PyObject *name,
140 update_callback callback, void *data);
141static int recurse_down_subclasses(PyTypeObject *type, PyObject *name,
142 update_callback callback, void *data);
143
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000144static int
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000145mro_subclasses(PyTypeObject *type, PyObject* temp)
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000146{
147 PyTypeObject *subclass;
148 PyObject *ref, *subclasses, *old_mro;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000149 Py_ssize_t i, n;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000150
151 subclasses = type->tp_subclasses;
152 if (subclasses == NULL)
153 return 0;
154 assert(PyList_Check(subclasses));
155 n = PyList_GET_SIZE(subclasses);
156 for (i = 0; i < n; i++) {
157 ref = PyList_GET_ITEM(subclasses, i);
158 assert(PyWeakref_CheckRef(ref));
159 subclass = (PyTypeObject *)PyWeakref_GET_OBJECT(ref);
160 assert(subclass != NULL);
161 if ((PyObject *)subclass == Py_None)
162 continue;
163 assert(PyType_Check(subclass));
164 old_mro = subclass->tp_mro;
165 if (mro_internal(subclass) < 0) {
166 subclass->tp_mro = old_mro;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000167 return -1;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000168 }
169 else {
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000170 PyObject* tuple;
Raymond Hettinger8ae46892003-10-12 19:09:37 +0000171 tuple = PyTuple_Pack(2, subclass, old_mro);
Guido van Rossum19a02ba2003-04-15 22:09:45 +0000172 Py_DECREF(old_mro);
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000173 if (!tuple)
174 return -1;
175 if (PyList_Append(temp, tuple) < 0)
176 return -1;
Guido van Rossum19a02ba2003-04-15 22:09:45 +0000177 Py_DECREF(tuple);
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000178 }
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000179 if (mro_subclasses(subclass, temp) < 0)
180 return -1;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000181 }
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000182 return 0;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000183}
184
185static int
186type_set_bases(PyTypeObject *type, PyObject *value, void *context)
187{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000188 Py_ssize_t i;
189 int r = 0;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000190 PyObject *ob, *temp;
Jeremy Hyltonfa955692007-02-27 18:29:45 +0000191 PyTypeObject *new_base, *old_base, *metatype;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000192 PyObject *old_bases, *old_mro;
193
194 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
195 PyErr_Format(PyExc_TypeError,
196 "can't set %s.__bases__", type->tp_name);
197 return -1;
198 }
199 if (!value) {
200 PyErr_Format(PyExc_TypeError,
201 "can't delete %s.__bases__", type->tp_name);
202 return -1;
203 }
204 if (!PyTuple_Check(value)) {
205 PyErr_Format(PyExc_TypeError,
206 "can only assign tuple to %s.__bases__, not %s",
207 type->tp_name, value->ob_type->tp_name);
208 return -1;
209 }
Guido van Rossum3bbc0ee2002-12-13 17:49:38 +0000210 if (PyTuple_GET_SIZE(value) == 0) {
211 PyErr_Format(PyExc_TypeError,
212 "can only assign non-empty tuple to %s.__bases__, not ()",
213 type->tp_name);
214 return -1;
215 }
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000216 for (i = 0; i < PyTuple_GET_SIZE(value); i++) {
217 ob = PyTuple_GET_ITEM(value, i);
218 if (!PyClass_Check(ob) && !PyType_Check(ob)) {
219 PyErr_Format(
220 PyExc_TypeError,
221 "%s.__bases__ must be tuple of old- or new-style classes, not '%s'",
222 type->tp_name, ob->ob_type->tp_name);
223 return -1;
224 }
Michael W. Hudsoncaf17be2002-11-27 10:24:44 +0000225 if (PyType_Check(ob)) {
226 if (PyType_IsSubtype((PyTypeObject*)ob, type)) {
227 PyErr_SetString(PyExc_TypeError,
228 "a __bases__ item causes an inheritance cycle");
229 return -1;
230 }
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000231 }
232 }
233
Jeremy Hyltonfa955692007-02-27 18:29:45 +0000234
235 metatype = most_derived_metaclass(type->ob_type, value);
236 if (metatype == NULL)
237 return -1;
238 if (metatype != type->ob_type) {
239 PyErr_SetString(PyExc_TypeError,
240 "assignment to __bases__ may not change "
241 "metatype");
242 return -1;
243 }
244
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000245 new_base = best_base(value);
246
247 if (!new_base) {
248 return -1;
249 }
250
251 if (!compatible_for_assignment(type->tp_base, new_base, "__bases__"))
252 return -1;
253
254 Py_INCREF(new_base);
255 Py_INCREF(value);
256
257 old_bases = type->tp_bases;
258 old_base = type->tp_base;
259 old_mro = type->tp_mro;
260
261 type->tp_bases = value;
262 type->tp_base = new_base;
263
264 if (mro_internal(type) < 0) {
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000265 goto bail;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000266 }
267
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000268 temp = PyList_New(0);
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000269 if (!temp)
270 goto bail;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000271
272 r = mro_subclasses(type, temp);
273
274 if (r < 0) {
275 for (i = 0; i < PyList_Size(temp); i++) {
276 PyTypeObject* cls;
277 PyObject* mro;
Raymond Hettinger8ae46892003-10-12 19:09:37 +0000278 PyArg_UnpackTuple(PyList_GET_ITEM(temp, i),
279 "", 2, 2, &cls, &mro);
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000280 Py_DECREF(cls->tp_mro);
281 cls->tp_mro = mro;
282 Py_INCREF(cls->tp_mro);
283 }
284 Py_DECREF(temp);
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000285 goto bail;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000286 }
287
288 Py_DECREF(temp);
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000289
290 /* any base that was in __bases__ but now isn't, we
Raymond Hettingera8285862002-12-14 17:17:56 +0000291 need to remove |type| from its tp_subclasses.
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000292 conversely, any class now in __bases__ that wasn't
Raymond Hettingera8285862002-12-14 17:17:56 +0000293 needs to have |type| added to its subclasses. */
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000294
295 /* for now, sod that: just remove from all old_bases,
296 add to all new_bases */
297
298 for (i = PyTuple_GET_SIZE(old_bases) - 1; i >= 0; i--) {
299 ob = PyTuple_GET_ITEM(old_bases, i);
300 if (PyType_Check(ob)) {
301 remove_subclass(
302 (PyTypeObject*)ob, type);
303 }
304 }
305
306 for (i = PyTuple_GET_SIZE(value) - 1; i >= 0; i--) {
307 ob = PyTuple_GET_ITEM(value, i);
308 if (PyType_Check(ob)) {
309 if (add_subclass((PyTypeObject*)ob, type) < 0)
310 r = -1;
311 }
312 }
313
314 update_all_slots(type);
315
316 Py_DECREF(old_bases);
317 Py_DECREF(old_base);
318 Py_DECREF(old_mro);
319
320 return r;
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000321
322 bail:
Michael W. Hudsone723e452003-08-07 14:58:10 +0000323 Py_DECREF(type->tp_bases);
324 Py_DECREF(type->tp_base);
325 if (type->tp_mro != old_mro) {
326 Py_DECREF(type->tp_mro);
327 }
328
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000329 type->tp_bases = old_bases;
330 type->tp_base = old_base;
331 type->tp_mro = old_mro;
Tim Petersea7f75d2002-12-07 21:39:16 +0000332
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000333 return -1;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000334}
335
336static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000337type_dict(PyTypeObject *type, void *context)
338{
339 if (type->tp_dict == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000340 Py_INCREF(Py_None);
341 return Py_None;
Guido van Rossum29ca26e1995-01-07 11:58:15 +0000342 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000343 return PyDictProxy_New(type->tp_dict);
Guido van Rossum29ca26e1995-01-07 11:58:15 +0000344}
345
Tim Peters24008312002-03-17 18:56:20 +0000346static PyObject *
347type_get_doc(PyTypeObject *type, void *context)
348{
349 PyObject *result;
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000350 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE) && type->tp_doc != NULL)
Tim Peters24008312002-03-17 18:56:20 +0000351 return PyString_FromString(type->tp_doc);
Tim Peters24008312002-03-17 18:56:20 +0000352 result = PyDict_GetItemString(type->tp_dict, "__doc__");
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000353 if (result == NULL) {
354 result = Py_None;
355 Py_INCREF(result);
356 }
357 else if (result->ob_type->tp_descr_get) {
Tim Peters2b858972002-04-18 04:12:28 +0000358 result = result->ob_type->tp_descr_get(result, NULL,
359 (PyObject *)type);
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000360 }
361 else {
362 Py_INCREF(result);
363 }
Tim Peters24008312002-03-17 18:56:20 +0000364 return result;
365}
366
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000367static PyGetSetDef type_getsets[] = {
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000368 {"__name__", (getter)type_name, (setter)type_set_name, NULL},
369 {"__bases__", (getter)type_get_bases, (setter)type_set_bases, NULL},
Guido van Rossum3926a632001-09-25 16:25:58 +0000370 {"__module__", (getter)type_module, (setter)type_set_module, NULL},
Tim Peters6d6c1a32001-08-02 04:15:00 +0000371 {"__dict__", (getter)type_dict, NULL, NULL},
Tim Peters24008312002-03-17 18:56:20 +0000372 {"__doc__", (getter)type_get_doc, NULL, NULL},
Tim Peters6d6c1a32001-08-02 04:15:00 +0000373 {0}
374};
375
Martin v. Löwis0163d6d2001-06-09 07:34:05 +0000376static int
377type_compare(PyObject *v, PyObject *w)
378{
379 /* This is called with type objects only. So we
380 can just compare the addresses. */
381 Py_uintptr_t vv = (Py_uintptr_t)v;
382 Py_uintptr_t ww = (Py_uintptr_t)w;
383 return (vv < ww) ? -1 : (vv > ww) ? 1 : 0;
384}
385
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000386static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000387type_repr(PyTypeObject *type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000388{
Barry Warsaw7ce36942001-08-24 18:34:26 +0000389 PyObject *mod, *name, *rtn;
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000390 char *kind;
Guido van Rossumc3542212001-08-16 09:18:56 +0000391
392 mod = type_module(type, NULL);
393 if (mod == NULL)
394 PyErr_Clear();
395 else if (!PyString_Check(mod)) {
396 Py_DECREF(mod);
397 mod = NULL;
398 }
399 name = type_name(type, NULL);
400 if (name == NULL)
401 return NULL;
Barry Warsaw7ce36942001-08-24 18:34:26 +0000402
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000403 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
404 kind = "class";
405 else
406 kind = "type";
407
Barry Warsaw7ce36942001-08-24 18:34:26 +0000408 if (mod != NULL && strcmp(PyString_AS_STRING(mod), "__builtin__")) {
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000409 rtn = PyString_FromFormat("<%s '%s.%s'>",
410 kind,
Barry Warsaw7ce36942001-08-24 18:34:26 +0000411 PyString_AS_STRING(mod),
412 PyString_AS_STRING(name));
413 }
Guido van Rossumc3542212001-08-16 09:18:56 +0000414 else
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000415 rtn = PyString_FromFormat("<%s '%s'>", kind, type->tp_name);
Barry Warsaw7ce36942001-08-24 18:34:26 +0000416
Guido van Rossumc3542212001-08-16 09:18:56 +0000417 Py_XDECREF(mod);
418 Py_DECREF(name);
Barry Warsaw7ce36942001-08-24 18:34:26 +0000419 return rtn;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000420}
421
Tim Peters6d6c1a32001-08-02 04:15:00 +0000422static PyObject *
423type_call(PyTypeObject *type, PyObject *args, PyObject *kwds)
424{
425 PyObject *obj;
426
427 if (type->tp_new == NULL) {
428 PyErr_Format(PyExc_TypeError,
429 "cannot create '%.100s' instances",
430 type->tp_name);
431 return NULL;
432 }
433
Tim Peters3f996e72001-09-13 19:18:27 +0000434 obj = type->tp_new(type, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000435 if (obj != NULL) {
Guido van Rossumf76de622001-10-18 15:49:21 +0000436 /* Ugly exception: when the call was type(something),
437 don't call tp_init on the result. */
438 if (type == &PyType_Type &&
439 PyTuple_Check(args) && PyTuple_GET_SIZE(args) == 1 &&
440 (kwds == NULL ||
441 (PyDict_Check(kwds) && PyDict_Size(kwds) == 0)))
442 return obj;
Guido van Rossum8ace1ab2002-04-06 01:05:01 +0000443 /* If the returned object is not an instance of type,
444 it won't be initialized. */
445 if (!PyType_IsSubtype(obj->ob_type, type))
446 return obj;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000447 type = obj->ob_type;
Jeremy Hylton719841e2002-07-16 19:39:38 +0000448 if (PyType_HasFeature(type, Py_TPFLAGS_HAVE_CLASS) &&
449 type->tp_init != NULL &&
Tim Peters6d6c1a32001-08-02 04:15:00 +0000450 type->tp_init(obj, args, kwds) < 0) {
451 Py_DECREF(obj);
452 obj = NULL;
453 }
454 }
455 return obj;
456}
457
458PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000459PyType_GenericAlloc(PyTypeObject *type, Py_ssize_t nitems)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000460{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000461 PyObject *obj;
Guido van Rossume5c691a2003-03-07 15:13:17 +0000462 const size_t size = _PyObject_VAR_SIZE(type, nitems+1);
463 /* note that we need to add one, for the sentinel */
Tim Peters406fe3b2001-10-06 19:04:01 +0000464
465 if (PyType_IS_GC(type))
Neil Schemenauer09a2ae52002-04-12 03:06:53 +0000466 obj = _PyObject_GC_Malloc(size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000467 else
Anthony Baxtera6286212006-04-11 07:42:36 +0000468 obj = (PyObject *)PyObject_MALLOC(size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000469
Neil Schemenauerc806c882001-08-29 23:54:54 +0000470 if (obj == NULL)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000471 return PyErr_NoMemory();
Tim Peters406fe3b2001-10-06 19:04:01 +0000472
Neil Schemenauerc806c882001-08-29 23:54:54 +0000473 memset(obj, '\0', size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000474
Tim Peters6d6c1a32001-08-02 04:15:00 +0000475 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
476 Py_INCREF(type);
Tim Peters406fe3b2001-10-06 19:04:01 +0000477
Tim Peters6d6c1a32001-08-02 04:15:00 +0000478 if (type->tp_itemsize == 0)
479 PyObject_INIT(obj, type);
480 else
481 (void) PyObject_INIT_VAR((PyVarObject *)obj, type, nitems);
Tim Peters406fe3b2001-10-06 19:04:01 +0000482
Tim Peters6d6c1a32001-08-02 04:15:00 +0000483 if (PyType_IS_GC(type))
Neil Schemenauerc806c882001-08-29 23:54:54 +0000484 _PyObject_GC_TRACK(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000485 return obj;
486}
487
488PyObject *
489PyType_GenericNew(PyTypeObject *type, PyObject *args, PyObject *kwds)
490{
491 return type->tp_alloc(type, 0);
492}
493
Guido van Rossum9475a232001-10-05 20:51:39 +0000494/* Helpers for subtyping */
495
496static int
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000497traverse_slots(PyTypeObject *type, PyObject *self, visitproc visit, void *arg)
498{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000499 Py_ssize_t i, n;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000500 PyMemberDef *mp;
501
502 n = type->ob_size;
Guido van Rossume5c691a2003-03-07 15:13:17 +0000503 mp = PyHeapType_GET_MEMBERS((PyHeapTypeObject *)type);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000504 for (i = 0; i < n; i++, mp++) {
505 if (mp->type == T_OBJECT_EX) {
506 char *addr = (char *)self + mp->offset;
507 PyObject *obj = *(PyObject **)addr;
508 if (obj != NULL) {
509 int err = visit(obj, arg);
510 if (err)
511 return err;
512 }
513 }
514 }
515 return 0;
516}
517
518static int
Guido van Rossum9475a232001-10-05 20:51:39 +0000519subtype_traverse(PyObject *self, visitproc visit, void *arg)
520{
521 PyTypeObject *type, *base;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000522 traverseproc basetraverse;
Guido van Rossum9475a232001-10-05 20:51:39 +0000523
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000524 /* Find the nearest base with a different tp_traverse,
525 and traverse slots while we're at it */
Guido van Rossum9475a232001-10-05 20:51:39 +0000526 type = self->ob_type;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000527 base = type;
528 while ((basetraverse = base->tp_traverse) == subtype_traverse) {
529 if (base->ob_size) {
530 int err = traverse_slots(base, self, visit, arg);
531 if (err)
532 return err;
533 }
Guido van Rossum9475a232001-10-05 20:51:39 +0000534 base = base->tp_base;
535 assert(base);
536 }
537
538 if (type->tp_dictoffset != base->tp_dictoffset) {
539 PyObject **dictptr = _PyObject_GetDictPtr(self);
Thomas Woutersc6e55062006-04-15 21:47:09 +0000540 if (dictptr && *dictptr)
541 Py_VISIT(*dictptr);
Guido van Rossum9475a232001-10-05 20:51:39 +0000542 }
543
Thomas Woutersc6e55062006-04-15 21:47:09 +0000544 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
Guido van Rossuma3862092002-06-10 15:24:42 +0000545 /* For a heaptype, the instances count as references
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000546 to the type. Traverse the type so the collector
Guido van Rossuma3862092002-06-10 15:24:42 +0000547 can find cycles involving this link. */
Thomas Woutersc6e55062006-04-15 21:47:09 +0000548 Py_VISIT(type);
Guido van Rossuma3862092002-06-10 15:24:42 +0000549
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000550 if (basetraverse)
551 return basetraverse(self, visit, arg);
552 return 0;
553}
554
555static void
556clear_slots(PyTypeObject *type, PyObject *self)
557{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000558 Py_ssize_t i, n;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000559 PyMemberDef *mp;
560
561 n = type->ob_size;
Guido van Rossume5c691a2003-03-07 15:13:17 +0000562 mp = PyHeapType_GET_MEMBERS((PyHeapTypeObject *)type);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000563 for (i = 0; i < n; i++, mp++) {
564 if (mp->type == T_OBJECT_EX && !(mp->flags & READONLY)) {
565 char *addr = (char *)self + mp->offset;
566 PyObject *obj = *(PyObject **)addr;
567 if (obj != NULL) {
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000568 *(PyObject **)addr = NULL;
Thomas Woutersedf17d82006-04-15 17:28:34 +0000569 Py_DECREF(obj);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000570 }
571 }
572 }
573}
574
575static int
576subtype_clear(PyObject *self)
577{
578 PyTypeObject *type, *base;
579 inquiry baseclear;
580
581 /* Find the nearest base with a different tp_clear
582 and clear slots while we're at it */
583 type = self->ob_type;
584 base = type;
585 while ((baseclear = base->tp_clear) == subtype_clear) {
586 if (base->ob_size)
587 clear_slots(base, self);
588 base = base->tp_base;
589 assert(base);
590 }
591
Guido van Rossuma3862092002-06-10 15:24:42 +0000592 /* There's no need to clear the instance dict (if any);
593 the collector will call its tp_clear handler. */
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000594
595 if (baseclear)
596 return baseclear(self);
Guido van Rossum9475a232001-10-05 20:51:39 +0000597 return 0;
598}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000599
600static void
601subtype_dealloc(PyObject *self)
602{
Guido van Rossum14227b42001-12-06 02:35:58 +0000603 PyTypeObject *type, *base;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000604 destructor basedealloc;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000605
Guido van Rossum22b13872002-08-06 21:41:44 +0000606 /* Extract the type; we expect it to be a heap type */
607 type = self->ob_type;
608 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000609
Guido van Rossum22b13872002-08-06 21:41:44 +0000610 /* Test whether the type has GC exactly once */
611
612 if (!PyType_IS_GC(type)) {
613 /* It's really rare to find a dynamic type that doesn't have
614 GC; it can only happen when deriving from 'object' and not
615 adding any slots or instance variables. This allows
616 certain simplifications: there's no need to call
617 clear_slots(), or DECREF the dict, or clear weakrefs. */
618
619 /* Maybe call finalizer; exit early if resurrected */
Guido van Rossumfebd61d2002-08-08 20:55:20 +0000620 if (type->tp_del) {
621 type->tp_del(self);
622 if (self->ob_refcnt > 0)
623 return;
624 }
Guido van Rossum22b13872002-08-06 21:41:44 +0000625
626 /* Find the nearest base with a different tp_dealloc */
627 base = type;
628 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
629 assert(base->ob_size == 0);
630 base = base->tp_base;
631 assert(base);
632 }
633
634 /* Call the base tp_dealloc() */
635 assert(basedealloc);
636 basedealloc(self);
637
638 /* Can't reference self beyond this point */
639 Py_DECREF(type);
640
641 /* Done */
642 return;
643 }
644
645 /* We get here only if the type has GC */
646
647 /* UnTrack and re-Track around the trashcan macro, alas */
Andrew M. Kuchlingc9172d32003-02-06 15:22:49 +0000648 /* See explanation at end of function for full disclosure */
Guido van Rossum0906e072002-08-07 20:42:09 +0000649 PyObject_GC_UnTrack(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000650 ++_PyTrash_delete_nesting;
Guido van Rossum22b13872002-08-06 21:41:44 +0000651 Py_TRASHCAN_SAFE_BEGIN(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000652 --_PyTrash_delete_nesting;
Tim Petersf7f9e992003-11-13 21:59:32 +0000653 /* DO NOT restore GC tracking at this point. weakref callbacks
654 * (if any, and whether directly here or indirectly in something we
655 * call) may trigger GC, and if self is tracked at that point, it
656 * will look like trash to GC and GC will try to delete self again.
Tim Petersadd09b42003-11-12 20:43:28 +0000657 */
Guido van Rossum22b13872002-08-06 21:41:44 +0000658
Guido van Rossum59195fd2003-06-13 20:54:40 +0000659 /* Find the nearest base with a different tp_dealloc */
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000660 base = type;
661 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000662 base = base->tp_base;
663 assert(base);
Guido van Rossum14227b42001-12-06 02:35:58 +0000664 }
665
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000666 /* If we added a weaklist, we clear it. Do this *before* calling
Guido van Rossum59195fd2003-06-13 20:54:40 +0000667 the finalizer (__del__), clearing slots, or clearing the instance
668 dict. */
669
Guido van Rossum1987c662003-05-29 14:29:23 +0000670 if (type->tp_weaklistoffset && !base->tp_weaklistoffset)
671 PyObject_ClearWeakRefs(self);
672
673 /* Maybe call finalizer; exit early if resurrected */
674 if (type->tp_del) {
Tim Petersf7f9e992003-11-13 21:59:32 +0000675 _PyObject_GC_TRACK(self);
Guido van Rossum1987c662003-05-29 14:29:23 +0000676 type->tp_del(self);
677 if (self->ob_refcnt > 0)
Tim Petersf7f9e992003-11-13 21:59:32 +0000678 goto endlabel; /* resurrected */
679 else
680 _PyObject_GC_UNTRACK(self);
Brett Cannonf5bee302007-01-23 23:21:22 +0000681 /* New weakrefs could be created during the finalizer call.
682 If this occurs, clear them out without calling their
683 finalizers since they might rely on part of the object
684 being finalized that has already been destroyed. */
685 if (type->tp_weaklistoffset && !base->tp_weaklistoffset) {
686 /* Modeled after GET_WEAKREFS_LISTPTR() */
687 PyWeakReference **list = (PyWeakReference **) \
688 PyObject_GET_WEAKREFS_LISTPTR(self);
689 while (*list)
690 _PyWeakref_ClearRef(*list);
691 }
Guido van Rossum1987c662003-05-29 14:29:23 +0000692 }
693
Guido van Rossum59195fd2003-06-13 20:54:40 +0000694 /* Clear slots up to the nearest base with a different tp_dealloc */
695 base = type;
696 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
697 if (base->ob_size)
698 clear_slots(base, self);
699 base = base->tp_base;
700 assert(base);
701 }
702
Tim Peters6d6c1a32001-08-02 04:15:00 +0000703 /* If we added a dict, DECREF it */
Guido van Rossum6fb3fde2001-08-30 20:00:07 +0000704 if (type->tp_dictoffset && !base->tp_dictoffset) {
705 PyObject **dictptr = _PyObject_GetDictPtr(self);
706 if (dictptr != NULL) {
707 PyObject *dict = *dictptr;
708 if (dict != NULL) {
709 Py_DECREF(dict);
710 *dictptr = NULL;
711 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000712 }
713 }
714
Tim Peters0bd743c2003-11-13 22:50:00 +0000715 /* Call the base tp_dealloc(); first retrack self if
716 * basedealloc knows about gc.
717 */
718 if (PyType_IS_GC(base))
719 _PyObject_GC_TRACK(self);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000720 assert(basedealloc);
721 basedealloc(self);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000722
723 /* Can't reference self beyond this point */
Guido van Rossum22b13872002-08-06 21:41:44 +0000724 Py_DECREF(type);
725
Guido van Rossum0906e072002-08-07 20:42:09 +0000726 endlabel:
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000727 ++_PyTrash_delete_nesting;
Guido van Rossum22b13872002-08-06 21:41:44 +0000728 Py_TRASHCAN_SAFE_END(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000729 --_PyTrash_delete_nesting;
730
731 /* Explanation of the weirdness around the trashcan macros:
732
733 Q. What do the trashcan macros do?
734
735 A. Read the comment titled "Trashcan mechanism" in object.h.
736 For one, this explains why there must be a call to GC-untrack
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000737 before the trashcan begin macro. Without understanding the
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000738 trashcan code, the answers to the following questions don't make
739 sense.
740
741 Q. Why do we GC-untrack before the trashcan and then immediately
742 GC-track again afterward?
743
744 A. In the case that the base class is GC-aware, the base class
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000745 probably GC-untracks the object. If it does that using the
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000746 UNTRACK macro, this will crash when the object is already
747 untracked. Because we don't know what the base class does, the
748 only safe thing is to make sure the object is tracked when we
749 call the base class dealloc. But... The trashcan begin macro
750 requires that the object is *untracked* before it is called. So
751 the dance becomes:
752
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000753 GC untrack
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000754 trashcan begin
755 GC track
756
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000757 Q. Why did the last question say "immediately GC-track again"?
758 It's nowhere near immediately.
Tim Petersf7f9e992003-11-13 21:59:32 +0000759
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000760 A. Because the code *used* to re-track immediately. Bad Idea.
761 self has a refcount of 0, and if gc ever gets its hands on it
762 (which can happen if any weakref callback gets invoked), it
763 looks like trash to gc too, and gc also tries to delete self
764 then. But we're already deleting self. Double dealloction is
765 a subtle disaster.
Tim Petersf7f9e992003-11-13 21:59:32 +0000766
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000767 Q. Why the bizarre (net-zero) manipulation of
768 _PyTrash_delete_nesting around the trashcan macros?
769
770 A. Some base classes (e.g. list) also use the trashcan mechanism.
771 The following scenario used to be possible:
772
773 - suppose the trashcan level is one below the trashcan limit
774
775 - subtype_dealloc() is called
776
777 - the trashcan limit is not yet reached, so the trashcan level
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000778 is incremented and the code between trashcan begin and end is
779 executed
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000780
781 - this destroys much of the object's contents, including its
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000782 slots and __dict__
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000783
784 - basedealloc() is called; this is really list_dealloc(), or
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000785 some other type which also uses the trashcan macros
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000786
787 - the trashcan limit is now reached, so the object is put on the
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000788 trashcan's to-be-deleted-later list
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000789
790 - basedealloc() returns
791
792 - subtype_dealloc() decrefs the object's type
793
794 - subtype_dealloc() returns
795
796 - later, the trashcan code starts deleting the objects from its
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000797 to-be-deleted-later list
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000798
799 - subtype_dealloc() is called *AGAIN* for the same object
800
801 - at the very least (if the destroyed slots and __dict__ don't
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000802 cause problems) the object's type gets decref'ed a second
803 time, which is *BAD*!!!
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000804
805 The remedy is to make sure that if the code between trashcan
806 begin and end in subtype_dealloc() is called, the code between
807 trashcan begin and end in basedealloc() will also be called.
808 This is done by decrementing the level after passing into the
809 trashcan block, and incrementing it just before leaving the
810 block.
811
812 But now it's possible that a chain of objects consisting solely
813 of objects whose deallocator is subtype_dealloc() will defeat
814 the trashcan mechanism completely: the decremented level means
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000815 that the effective level never reaches the limit. Therefore, we
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000816 *increment* the level *before* entering the trashcan block, and
817 matchingly decrement it after leaving. This means the trashcan
818 code will trigger a little early, but that's no big deal.
819
820 Q. Are there any live examples of code in need of all this
821 complexity?
822
823 A. Yes. See SF bug 668433 for code that crashed (when Python was
824 compiled in debug mode) before the trashcan level manipulations
825 were added. For more discussion, see SF patches 581742, 575073
826 and bug 574207.
827 */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000828}
829
Jeremy Hylton938ace62002-07-17 16:30:39 +0000830static PyTypeObject *solid_base(PyTypeObject *type);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000831
Tim Peters6d6c1a32001-08-02 04:15:00 +0000832/* type test with subclassing support */
833
834int
835PyType_IsSubtype(PyTypeObject *a, PyTypeObject *b)
836{
837 PyObject *mro;
838
Guido van Rossum9478d072001-09-07 18:52:13 +0000839 if (!(a->tp_flags & Py_TPFLAGS_HAVE_CLASS))
840 return b == a || b == &PyBaseObject_Type;
841
Tim Peters6d6c1a32001-08-02 04:15:00 +0000842 mro = a->tp_mro;
843 if (mro != NULL) {
844 /* Deal with multiple inheritance without recursion
845 by walking the MRO tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000846 Py_ssize_t i, n;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000847 assert(PyTuple_Check(mro));
848 n = PyTuple_GET_SIZE(mro);
849 for (i = 0; i < n; i++) {
850 if (PyTuple_GET_ITEM(mro, i) == (PyObject *)b)
851 return 1;
852 }
853 return 0;
854 }
855 else {
856 /* a is not completely initilized yet; follow tp_base */
857 do {
858 if (a == b)
859 return 1;
860 a = a->tp_base;
861 } while (a != NULL);
862 return b == &PyBaseObject_Type;
863 }
864}
865
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000866/* Internal routines to do a method lookup in the type
Guido van Rossum60718732001-08-28 17:47:51 +0000867 without looking in the instance dictionary
868 (so we can't use PyObject_GetAttr) but still binding
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000869 it to the instance. The arguments are the object,
Guido van Rossum60718732001-08-28 17:47:51 +0000870 the method name as a C string, and the address of a
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000871 static variable used to cache the interned Python string.
872
873 Two variants:
874
875 - lookup_maybe() returns NULL without raising an exception
876 when the _PyType_Lookup() call fails;
877
878 - lookup_method() always raises an exception upon errors.
879*/
Guido van Rossum60718732001-08-28 17:47:51 +0000880
881static PyObject *
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000882lookup_maybe(PyObject *self, char *attrstr, PyObject **attrobj)
Guido van Rossum60718732001-08-28 17:47:51 +0000883{
884 PyObject *res;
885
886 if (*attrobj == NULL) {
887 *attrobj = PyString_InternFromString(attrstr);
888 if (*attrobj == NULL)
889 return NULL;
890 }
891 res = _PyType_Lookup(self->ob_type, *attrobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000892 if (res != NULL) {
Guido van Rossum60718732001-08-28 17:47:51 +0000893 descrgetfunc f;
894 if ((f = res->ob_type->tp_descr_get) == NULL)
895 Py_INCREF(res);
896 else
897 res = f(res, self, (PyObject *)(self->ob_type));
898 }
899 return res;
900}
901
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000902static PyObject *
903lookup_method(PyObject *self, char *attrstr, PyObject **attrobj)
904{
905 PyObject *res = lookup_maybe(self, attrstr, attrobj);
906 if (res == NULL && !PyErr_Occurred())
907 PyErr_SetObject(PyExc_AttributeError, *attrobj);
908 return res;
909}
910
Guido van Rossum2730b132001-08-28 18:22:14 +0000911/* A variation of PyObject_CallMethod that uses lookup_method()
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000912 instead of PyObject_GetAttrString(). This uses the same convention
Guido van Rossum2730b132001-08-28 18:22:14 +0000913 as lookup_method to cache the interned name string object. */
914
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000915static PyObject *
Guido van Rossum2730b132001-08-28 18:22:14 +0000916call_method(PyObject *o, char *name, PyObject **nameobj, char *format, ...)
917{
918 va_list va;
919 PyObject *args, *func = 0, *retval;
Guido van Rossum2730b132001-08-28 18:22:14 +0000920 va_start(va, format);
921
Guido van Rossumda21c012001-10-03 00:50:18 +0000922 func = lookup_maybe(o, name, nameobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000923 if (func == NULL) {
924 va_end(va);
925 if (!PyErr_Occurred())
Guido van Rossumda21c012001-10-03 00:50:18 +0000926 PyErr_SetObject(PyExc_AttributeError, *nameobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000927 return NULL;
928 }
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000929
930 if (format && *format)
931 args = Py_VaBuildValue(format, va);
932 else
933 args = PyTuple_New(0);
934
935 va_end(va);
936
937 if (args == NULL)
938 return NULL;
939
940 assert(PyTuple_Check(args));
941 retval = PyObject_Call(func, args, NULL);
942
943 Py_DECREF(args);
944 Py_DECREF(func);
945
946 return retval;
947}
948
949/* Clone of call_method() that returns NotImplemented when the lookup fails. */
950
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000951static PyObject *
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000952call_maybe(PyObject *o, char *name, PyObject **nameobj, char *format, ...)
953{
954 va_list va;
955 PyObject *args, *func = 0, *retval;
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000956 va_start(va, format);
957
Guido van Rossumda21c012001-10-03 00:50:18 +0000958 func = lookup_maybe(o, name, nameobj);
Guido van Rossum2730b132001-08-28 18:22:14 +0000959 if (func == NULL) {
960 va_end(va);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000961 if (!PyErr_Occurred()) {
962 Py_INCREF(Py_NotImplemented);
963 return Py_NotImplemented;
964 }
Guido van Rossum717ce002001-09-14 16:58:08 +0000965 return NULL;
Guido van Rossum2730b132001-08-28 18:22:14 +0000966 }
967
968 if (format && *format)
969 args = Py_VaBuildValue(format, va);
970 else
971 args = PyTuple_New(0);
972
973 va_end(va);
974
Guido van Rossum717ce002001-09-14 16:58:08 +0000975 if (args == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +0000976 return NULL;
977
Guido van Rossum717ce002001-09-14 16:58:08 +0000978 assert(PyTuple_Check(args));
979 retval = PyObject_Call(func, args, NULL);
Guido van Rossum2730b132001-08-28 18:22:14 +0000980
981 Py_DECREF(args);
982 Py_DECREF(func);
983
984 return retval;
985}
986
Tim Petersa91e9642001-11-14 23:32:33 +0000987static int
988fill_classic_mro(PyObject *mro, PyObject *cls)
989{
990 PyObject *bases, *base;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000991 Py_ssize_t i, n;
Tim Petersa91e9642001-11-14 23:32:33 +0000992
993 assert(PyList_Check(mro));
994 assert(PyClass_Check(cls));
995 i = PySequence_Contains(mro, cls);
996 if (i < 0)
997 return -1;
998 if (!i) {
999 if (PyList_Append(mro, cls) < 0)
1000 return -1;
1001 }
1002 bases = ((PyClassObject *)cls)->cl_bases;
1003 assert(bases && PyTuple_Check(bases));
1004 n = PyTuple_GET_SIZE(bases);
1005 for (i = 0; i < n; i++) {
1006 base = PyTuple_GET_ITEM(bases, i);
1007 if (fill_classic_mro(mro, base) < 0)
1008 return -1;
1009 }
1010 return 0;
1011}
1012
1013static PyObject *
1014classic_mro(PyObject *cls)
1015{
1016 PyObject *mro;
1017
1018 assert(PyClass_Check(cls));
1019 mro = PyList_New(0);
1020 if (mro != NULL) {
1021 if (fill_classic_mro(mro, cls) == 0)
1022 return mro;
1023 Py_DECREF(mro);
1024 }
1025 return NULL;
1026}
1027
Tim Petersea7f75d2002-12-07 21:39:16 +00001028/*
Guido van Rossum1f121312002-11-14 19:49:16 +00001029 Method resolution order algorithm C3 described in
1030 "A Monotonic Superclass Linearization for Dylan",
1031 by Kim Barrett, Bob Cassel, Paul Haahr,
Tim Petersea7f75d2002-12-07 21:39:16 +00001032 David A. Moon, Keith Playford, and P. Tucker Withington.
Guido van Rossum1f121312002-11-14 19:49:16 +00001033 (OOPSLA 1996)
1034
Guido van Rossum98f33732002-11-25 21:36:54 +00001035 Some notes about the rules implied by C3:
1036
Tim Petersea7f75d2002-12-07 21:39:16 +00001037 No duplicate bases.
Guido van Rossum98f33732002-11-25 21:36:54 +00001038 It isn't legal to repeat a class in a list of base classes.
1039
1040 The next three properties are the 3 constraints in "C3".
1041
Tim Petersea7f75d2002-12-07 21:39:16 +00001042 Local precendece order.
Guido van Rossum98f33732002-11-25 21:36:54 +00001043 If A precedes B in C's MRO, then A will precede B in the MRO of all
1044 subclasses of C.
1045
1046 Monotonicity.
1047 The MRO of a class must be an extension without reordering of the
1048 MRO of each of its superclasses.
1049
1050 Extended Precedence Graph (EPG).
1051 Linearization is consistent if there is a path in the EPG from
1052 each class to all its successors in the linearization. See
1053 the paper for definition of EPG.
Guido van Rossum1f121312002-11-14 19:49:16 +00001054 */
1055
Tim Petersea7f75d2002-12-07 21:39:16 +00001056static int
Guido van Rossum1f121312002-11-14 19:49:16 +00001057tail_contains(PyObject *list, int whence, PyObject *o) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001058 Py_ssize_t j, size;
Guido van Rossum1f121312002-11-14 19:49:16 +00001059 size = PyList_GET_SIZE(list);
1060
1061 for (j = whence+1; j < size; j++) {
1062 if (PyList_GET_ITEM(list, j) == o)
1063 return 1;
1064 }
1065 return 0;
1066}
1067
Guido van Rossum98f33732002-11-25 21:36:54 +00001068static PyObject *
1069class_name(PyObject *cls)
1070{
1071 PyObject *name = PyObject_GetAttrString(cls, "__name__");
1072 if (name == NULL) {
1073 PyErr_Clear();
1074 Py_XDECREF(name);
1075 name = PyObject_Repr(cls);
1076 }
1077 if (name == NULL)
1078 return NULL;
1079 if (!PyString_Check(name)) {
1080 Py_DECREF(name);
1081 return NULL;
1082 }
1083 return name;
1084}
1085
1086static int
1087check_duplicates(PyObject *list)
1088{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001089 Py_ssize_t i, j, n;
Guido van Rossum98f33732002-11-25 21:36:54 +00001090 /* Let's use a quadratic time algorithm,
1091 assuming that the bases lists is short.
1092 */
1093 n = PyList_GET_SIZE(list);
1094 for (i = 0; i < n; i++) {
1095 PyObject *o = PyList_GET_ITEM(list, i);
1096 for (j = i + 1; j < n; j++) {
1097 if (PyList_GET_ITEM(list, j) == o) {
1098 o = class_name(o);
1099 PyErr_Format(PyExc_TypeError,
1100 "duplicate base class %s",
1101 o ? PyString_AS_STRING(o) : "?");
1102 Py_XDECREF(o);
1103 return -1;
1104 }
1105 }
1106 }
1107 return 0;
1108}
1109
1110/* Raise a TypeError for an MRO order disagreement.
1111
1112 It's hard to produce a good error message. In the absence of better
1113 insight into error reporting, report the classes that were candidates
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001114 to be put next into the MRO. There is some conflict between the
Guido van Rossum98f33732002-11-25 21:36:54 +00001115 order in which they should be put in the MRO, but it's hard to
1116 diagnose what constraint can't be satisfied.
1117*/
1118
1119static void
1120set_mro_error(PyObject *to_merge, int *remain)
1121{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001122 Py_ssize_t i, n, off, to_merge_size;
Guido van Rossum98f33732002-11-25 21:36:54 +00001123 char buf[1000];
1124 PyObject *k, *v;
1125 PyObject *set = PyDict_New();
Georg Brandl5c170fd2006-03-17 19:03:25 +00001126 if (!set) return;
Guido van Rossum98f33732002-11-25 21:36:54 +00001127
1128 to_merge_size = PyList_GET_SIZE(to_merge);
1129 for (i = 0; i < to_merge_size; i++) {
1130 PyObject *L = PyList_GET_ITEM(to_merge, i);
1131 if (remain[i] < PyList_GET_SIZE(L)) {
1132 PyObject *c = PyList_GET_ITEM(L, remain[i]);
Georg Brandl5c170fd2006-03-17 19:03:25 +00001133 if (PyDict_SetItem(set, c, Py_None) < 0) {
1134 Py_DECREF(set);
Guido van Rossum98f33732002-11-25 21:36:54 +00001135 return;
Georg Brandl5c170fd2006-03-17 19:03:25 +00001136 }
Guido van Rossum98f33732002-11-25 21:36:54 +00001137 }
1138 }
1139 n = PyDict_Size(set);
1140
Raymond Hettingerf394df42003-04-06 19:13:41 +00001141 off = PyOS_snprintf(buf, sizeof(buf), "Cannot create a \
1142consistent method resolution\norder (MRO) for bases");
Guido van Rossum98f33732002-11-25 21:36:54 +00001143 i = 0;
Skip Montanaro429433b2006-04-18 00:35:43 +00001144 while (PyDict_Next(set, &i, &k, &v) && (size_t)off < sizeof(buf)) {
Guido van Rossum98f33732002-11-25 21:36:54 +00001145 PyObject *name = class_name(k);
1146 off += PyOS_snprintf(buf + off, sizeof(buf) - off, " %s",
1147 name ? PyString_AS_STRING(name) : "?");
1148 Py_XDECREF(name);
Skip Montanaro429433b2006-04-18 00:35:43 +00001149 if (--n && (size_t)(off+1) < sizeof(buf)) {
Guido van Rossum98f33732002-11-25 21:36:54 +00001150 buf[off++] = ',';
1151 buf[off] = '\0';
1152 }
1153 }
1154 PyErr_SetString(PyExc_TypeError, buf);
1155 Py_DECREF(set);
1156}
1157
Tim Petersea7f75d2002-12-07 21:39:16 +00001158static int
Guido van Rossum1f121312002-11-14 19:49:16 +00001159pmerge(PyObject *acc, PyObject* to_merge) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001160 Py_ssize_t i, j, to_merge_size, empty_cnt;
Guido van Rossum1f121312002-11-14 19:49:16 +00001161 int *remain;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001162 int ok;
Tim Petersea7f75d2002-12-07 21:39:16 +00001163
Guido van Rossum1f121312002-11-14 19:49:16 +00001164 to_merge_size = PyList_GET_SIZE(to_merge);
1165
Guido van Rossum98f33732002-11-25 21:36:54 +00001166 /* remain stores an index into each sublist of to_merge.
1167 remain[i] is the index of the next base in to_merge[i]
1168 that is not included in acc.
1169 */
Anthony Baxtera6286212006-04-11 07:42:36 +00001170 remain = (int *)PyMem_MALLOC(SIZEOF_INT*to_merge_size);
Guido van Rossum1f121312002-11-14 19:49:16 +00001171 if (remain == NULL)
1172 return -1;
1173 for (i = 0; i < to_merge_size; i++)
1174 remain[i] = 0;
1175
1176 again:
1177 empty_cnt = 0;
1178 for (i = 0; i < to_merge_size; i++) {
1179 PyObject *candidate;
Tim Petersea7f75d2002-12-07 21:39:16 +00001180
Guido van Rossum1f121312002-11-14 19:49:16 +00001181 PyObject *cur_list = PyList_GET_ITEM(to_merge, i);
1182
1183 if (remain[i] >= PyList_GET_SIZE(cur_list)) {
1184 empty_cnt++;
1185 continue;
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001186 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001187
Guido van Rossum98f33732002-11-25 21:36:54 +00001188 /* Choose next candidate for MRO.
1189
1190 The input sequences alone can determine the choice.
1191 If not, choose the class which appears in the MRO
1192 of the earliest direct superclass of the new class.
1193 */
1194
Guido van Rossum1f121312002-11-14 19:49:16 +00001195 candidate = PyList_GET_ITEM(cur_list, remain[i]);
1196 for (j = 0; j < to_merge_size; j++) {
1197 PyObject *j_lst = PyList_GET_ITEM(to_merge, j);
Guido van Rossum98f33732002-11-25 21:36:54 +00001198 if (tail_contains(j_lst, remain[j], candidate)) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001199 goto skip; /* continue outer loop */
Guido van Rossum98f33732002-11-25 21:36:54 +00001200 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001201 }
1202 ok = PyList_Append(acc, candidate);
1203 if (ok < 0) {
1204 PyMem_Free(remain);
1205 return -1;
1206 }
1207 for (j = 0; j < to_merge_size; j++) {
1208 PyObject *j_lst = PyList_GET_ITEM(to_merge, j);
Guido van Rossum768158c2002-12-31 16:33:01 +00001209 if (remain[j] < PyList_GET_SIZE(j_lst) &&
1210 PyList_GET_ITEM(j_lst, remain[j]) == candidate) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001211 remain[j]++;
1212 }
1213 }
1214 goto again;
Tim Peters9a6b8d82002-11-14 23:22:33 +00001215 skip: ;
Guido van Rossum1f121312002-11-14 19:49:16 +00001216 }
1217
Guido van Rossum98f33732002-11-25 21:36:54 +00001218 if (empty_cnt == to_merge_size) {
1219 PyMem_FREE(remain);
Guido van Rossum1f121312002-11-14 19:49:16 +00001220 return 0;
Guido van Rossum98f33732002-11-25 21:36:54 +00001221 }
1222 set_mro_error(to_merge, remain);
1223 PyMem_FREE(remain);
Guido van Rossum1f121312002-11-14 19:49:16 +00001224 return -1;
1225}
1226
Tim Peters6d6c1a32001-08-02 04:15:00 +00001227static PyObject *
1228mro_implementation(PyTypeObject *type)
1229{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001230 Py_ssize_t i, n;
1231 int ok;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001232 PyObject *bases, *result;
Guido van Rossum1f121312002-11-14 19:49:16 +00001233 PyObject *to_merge, *bases_aslist;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001234
Guido van Rossum63517572002-06-18 16:44:57 +00001235 if(type->tp_dict == NULL) {
1236 if(PyType_Ready(type) < 0)
1237 return NULL;
1238 }
1239
Guido van Rossum98f33732002-11-25 21:36:54 +00001240 /* Find a superclass linearization that honors the constraints
1241 of the explicit lists of bases and the constraints implied by
Tim Petersea7f75d2002-12-07 21:39:16 +00001242 each base class.
Guido van Rossum98f33732002-11-25 21:36:54 +00001243
1244 to_merge is a list of lists, where each list is a superclass
1245 linearization implied by a base class. The last element of
1246 to_merge is the declared list of bases.
1247 */
1248
Tim Peters6d6c1a32001-08-02 04:15:00 +00001249 bases = type->tp_bases;
1250 n = PyTuple_GET_SIZE(bases);
Guido van Rossum1f121312002-11-14 19:49:16 +00001251
1252 to_merge = PyList_New(n+1);
1253 if (to_merge == NULL)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001254 return NULL;
Guido van Rossum1f121312002-11-14 19:49:16 +00001255
Tim Peters6d6c1a32001-08-02 04:15:00 +00001256 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00001257 PyObject *base = PyTuple_GET_ITEM(bases, i);
1258 PyObject *parentMRO;
1259 if (PyType_Check(base))
1260 parentMRO = PySequence_List(
1261 ((PyTypeObject*)base)->tp_mro);
1262 else
1263 parentMRO = classic_mro(base);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001264 if (parentMRO == NULL) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001265 Py_DECREF(to_merge);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001266 return NULL;
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001267 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001268
1269 PyList_SET_ITEM(to_merge, i, parentMRO);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001270 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001271
1272 bases_aslist = PySequence_List(bases);
1273 if (bases_aslist == NULL) {
1274 Py_DECREF(to_merge);
1275 return NULL;
1276 }
Guido van Rossum98f33732002-11-25 21:36:54 +00001277 /* This is just a basic sanity check. */
1278 if (check_duplicates(bases_aslist) < 0) {
1279 Py_DECREF(to_merge);
1280 Py_DECREF(bases_aslist);
1281 return NULL;
1282 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001283 PyList_SET_ITEM(to_merge, n, bases_aslist);
1284
1285 result = Py_BuildValue("[O]", (PyObject *)type);
1286 if (result == NULL) {
1287 Py_DECREF(to_merge);
1288 return NULL;
1289 }
1290
1291 ok = pmerge(result, to_merge);
1292 Py_DECREF(to_merge);
1293 if (ok < 0) {
1294 Py_DECREF(result);
1295 return NULL;
1296 }
1297
Tim Peters6d6c1a32001-08-02 04:15:00 +00001298 return result;
1299}
1300
1301static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001302mro_external(PyObject *self)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001303{
1304 PyTypeObject *type = (PyTypeObject *)self;
1305
Tim Peters6d6c1a32001-08-02 04:15:00 +00001306 return mro_implementation(type);
1307}
1308
1309static int
1310mro_internal(PyTypeObject *type)
1311{
1312 PyObject *mro, *result, *tuple;
Armin Rigo037d1e02005-12-29 17:07:39 +00001313 int checkit = 0;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001314
1315 if (type->ob_type == &PyType_Type) {
1316 result = mro_implementation(type);
1317 }
1318 else {
Guido van Rossum60718732001-08-28 17:47:51 +00001319 static PyObject *mro_str;
Armin Rigo037d1e02005-12-29 17:07:39 +00001320 checkit = 1;
Guido van Rossum60718732001-08-28 17:47:51 +00001321 mro = lookup_method((PyObject *)type, "mro", &mro_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001322 if (mro == NULL)
1323 return -1;
1324 result = PyObject_CallObject(mro, NULL);
1325 Py_DECREF(mro);
1326 }
1327 if (result == NULL)
1328 return -1;
1329 tuple = PySequence_Tuple(result);
1330 Py_DECREF(result);
Armin Rigo037d1e02005-12-29 17:07:39 +00001331 if (tuple == NULL)
1332 return -1;
1333 if (checkit) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001334 Py_ssize_t i, len;
Armin Rigo037d1e02005-12-29 17:07:39 +00001335 PyObject *cls;
1336 PyTypeObject *solid;
1337
1338 solid = solid_base(type);
1339
1340 len = PyTuple_GET_SIZE(tuple);
1341
1342 for (i = 0; i < len; i++) {
1343 PyTypeObject *t;
1344 cls = PyTuple_GET_ITEM(tuple, i);
1345 if (PyClass_Check(cls))
1346 continue;
1347 else if (!PyType_Check(cls)) {
1348 PyErr_Format(PyExc_TypeError,
1349 "mro() returned a non-class ('%.500s')",
1350 cls->ob_type->tp_name);
Neal Norwitz50bf51a2006-01-02 02:46:54 +00001351 Py_DECREF(tuple);
Armin Rigo037d1e02005-12-29 17:07:39 +00001352 return -1;
1353 }
1354 t = (PyTypeObject*)cls;
1355 if (!PyType_IsSubtype(solid, solid_base(t))) {
1356 PyErr_Format(PyExc_TypeError,
1357 "mro() returned base with unsuitable layout ('%.500s')",
1358 t->tp_name);
Neal Norwitz50bf51a2006-01-02 02:46:54 +00001359 Py_DECREF(tuple);
Armin Rigo037d1e02005-12-29 17:07:39 +00001360 return -1;
1361 }
1362 }
1363 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001364 type->tp_mro = tuple;
1365 return 0;
1366}
1367
1368
1369/* Calculate the best base amongst multiple base classes.
Jeremy Hyltonfa955692007-02-27 18:29:45 +00001370 This is the first one that's on the path to the "solid base".
1371
1372 Requires that all base classes be types or classic classes.
1373
1374 Will return NULL with TypeError set if
1375 1) the base classes have conflicting layout instances, or
1376 2) all the bases are classic classes.
1377*/
Tim Peters6d6c1a32001-08-02 04:15:00 +00001378
1379static PyTypeObject *
1380best_base(PyObject *bases)
1381{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001382 Py_ssize_t i, n;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001383 PyTypeObject *base, *winner, *candidate, *base_i;
Tim Petersa91e9642001-11-14 23:32:33 +00001384 PyObject *base_proto;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001385
1386 assert(PyTuple_Check(bases));
1387 n = PyTuple_GET_SIZE(bases);
1388 assert(n > 0);
Tim Petersa91e9642001-11-14 23:32:33 +00001389 base = NULL;
1390 winner = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001391 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00001392 base_proto = PyTuple_GET_ITEM(bases, i);
1393 if (PyClass_Check(base_proto))
1394 continue;
Jeremy Hyltonfa955692007-02-27 18:29:45 +00001395 assert(PyType_Check(base_proto));
Tim Petersa91e9642001-11-14 23:32:33 +00001396 base_i = (PyTypeObject *)base_proto;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001397 if (base_i->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001398 if (PyType_Ready(base_i) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001399 return NULL;
1400 }
1401 candidate = solid_base(base_i);
Tim Petersa91e9642001-11-14 23:32:33 +00001402 if (winner == NULL) {
1403 winner = candidate;
1404 base = base_i;
1405 }
1406 else if (PyType_IsSubtype(winner, candidate))
Tim Peters6d6c1a32001-08-02 04:15:00 +00001407 ;
1408 else if (PyType_IsSubtype(candidate, winner)) {
1409 winner = candidate;
1410 base = base_i;
1411 }
1412 else {
1413 PyErr_SetString(
1414 PyExc_TypeError,
1415 "multiple bases have "
1416 "instance lay-out conflict");
1417 return NULL;
1418 }
1419 }
Guido van Rossume54616c2001-12-14 04:19:56 +00001420 if (base == NULL)
1421 PyErr_SetString(PyExc_TypeError,
1422 "a new-style class can't have only classic bases");
Tim Peters6d6c1a32001-08-02 04:15:00 +00001423 return base;
1424}
1425
1426static int
1427extra_ivars(PyTypeObject *type, PyTypeObject *base)
1428{
Neil Schemenauerc806c882001-08-29 23:54:54 +00001429 size_t t_size = type->tp_basicsize;
1430 size_t b_size = base->tp_basicsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001431
Guido van Rossum9676b222001-08-17 20:32:36 +00001432 assert(t_size >= b_size); /* Else type smaller than base! */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001433 if (type->tp_itemsize || base->tp_itemsize) {
1434 /* If itemsize is involved, stricter rules */
1435 return t_size != b_size ||
1436 type->tp_itemsize != base->tp_itemsize;
1437 }
Guido van Rossum9676b222001-08-17 20:32:36 +00001438 if (type->tp_weaklistoffset && base->tp_weaklistoffset == 0 &&
1439 type->tp_weaklistoffset + sizeof(PyObject *) == t_size)
1440 t_size -= sizeof(PyObject *);
1441 if (type->tp_dictoffset && base->tp_dictoffset == 0 &&
1442 type->tp_dictoffset + sizeof(PyObject *) == t_size)
1443 t_size -= sizeof(PyObject *);
1444
1445 return t_size != b_size;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001446}
1447
Jeremy Hyltonfa955692007-02-27 18:29:45 +00001448/* Return the type object that will determine the layout of the instance. */
1449
Tim Peters6d6c1a32001-08-02 04:15:00 +00001450static PyTypeObject *
1451solid_base(PyTypeObject *type)
1452{
1453 PyTypeObject *base;
1454
1455 if (type->tp_base)
1456 base = solid_base(type->tp_base);
1457 else
1458 base = &PyBaseObject_Type;
1459 if (extra_ivars(type, base))
1460 return type;
1461 else
1462 return base;
1463}
1464
Jeremy Hyltonfa955692007-02-27 18:29:45 +00001465/* Determine the proper metatype to deal with this, and check some
1466 error cases while we're at it. Note that if some other metatype
1467 wins to contract, it's possible that its instances are not types.
1468
1469 Error cases of interest: 1. The metaclass is not a subclass of a
1470 base class. 2. A non-type, non-classic base class appears before
1471 type.
1472*/
1473
1474static PyTypeObject *
1475most_derived_metaclass(PyTypeObject *metatype, PyObject *bases)
1476{
1477 Py_ssize_t nbases, i;
1478 PyTypeObject *winner;
1479 /* types_ordered: One of three states possible:
1480 0 type is in bases
1481 1 non-types also in bases
1482 2 type follows non-type in bases (error)
1483 */
1484 int types_ordered = 0;
1485
1486 nbases = PyTuple_GET_SIZE(bases);
1487 winner = metatype;
1488 for (i = 0; i < nbases; i++) {
1489 PyObject *tmp = PyTuple_GET_ITEM(bases, i);
1490 PyTypeObject *tmptype = tmp->ob_type;
1491 if (tmptype == &PyClass_Type)
1492 continue; /* Special case classic classes */
1493 if (!PyType_Check(tmp)) {
1494 PyErr_SetString(PyExc_TypeError,
1495 "bases must be types");
1496 return NULL;
1497 }
1498 if (PyObject_IsSubclass(tmp, (PyObject*)&PyType_Type)) {
1499 if (types_ordered == 1) {
1500 types_ordered = 2;
1501 }
1502 }
1503 else if (!types_ordered)
1504 types_ordered = 1;
1505 if (winner == tmptype)
1506 continue;
1507 if (PyType_IsSubtype(winner, tmptype))
1508 continue;
1509 if (PyType_IsSubtype(tmptype, winner)) {
1510 winner = tmptype;
1511 continue;
1512 }
1513 PyErr_SetString(PyExc_TypeError,
1514 "metaclass conflict: "
1515 "the metaclass of a derived class "
1516 "must be a (non-strict) subclass "
1517 "of the metaclasses of all its bases");
1518 return NULL;
1519 }
1520 if (types_ordered == 2) {
1521 PyErr_SetString(PyExc_TypeError,
1522 "metaclass conflict: "
1523 "type must occur in bases before other "
1524 "non-classic base classes");
1525 return NULL;
1526 }
1527 return winner;
1528}
1529
Jeremy Hylton938ace62002-07-17 16:30:39 +00001530static void object_dealloc(PyObject *);
1531static int object_init(PyObject *, PyObject *, PyObject *);
1532static int update_slot(PyTypeObject *, PyObject *);
1533static void fixup_slot_dispatchers(PyTypeObject *);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001534
1535static PyObject *
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001536subtype_dict(PyObject *obj, void *context)
1537{
1538 PyObject **dictptr = _PyObject_GetDictPtr(obj);
1539 PyObject *dict;
1540
1541 if (dictptr == NULL) {
1542 PyErr_SetString(PyExc_AttributeError,
1543 "This object has no __dict__");
1544 return NULL;
1545 }
1546 dict = *dictptr;
Guido van Rossum3926a632001-09-25 16:25:58 +00001547 if (dict == NULL)
1548 *dictptr = dict = PyDict_New();
1549 Py_XINCREF(dict);
1550 return dict;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001551}
1552
Guido van Rossum6661be32001-10-26 04:26:12 +00001553static int
1554subtype_setdict(PyObject *obj, PyObject *value, void *context)
1555{
1556 PyObject **dictptr = _PyObject_GetDictPtr(obj);
1557 PyObject *dict;
1558
1559 if (dictptr == NULL) {
1560 PyErr_SetString(PyExc_AttributeError,
1561 "This object has no __dict__");
1562 return -1;
1563 }
Guido van Rossumd331cb52001-12-05 19:46:42 +00001564 if (value != NULL && !PyDict_Check(value)) {
Georg Brandlccff7852006-06-18 22:17:29 +00001565 PyErr_Format(PyExc_TypeError,
1566 "__dict__ must be set to a dictionary, "
1567 "not a '%.200s'", value->ob_type->tp_name);
Guido van Rossum6661be32001-10-26 04:26:12 +00001568 return -1;
1569 }
1570 dict = *dictptr;
Guido van Rossumd331cb52001-12-05 19:46:42 +00001571 Py_XINCREF(value);
Guido van Rossum6661be32001-10-26 04:26:12 +00001572 *dictptr = value;
1573 Py_XDECREF(dict);
1574 return 0;
1575}
1576
Guido van Rossumad47da02002-08-12 19:05:44 +00001577static PyObject *
1578subtype_getweakref(PyObject *obj, void *context)
1579{
1580 PyObject **weaklistptr;
1581 PyObject *result;
1582
1583 if (obj->ob_type->tp_weaklistoffset == 0) {
1584 PyErr_SetString(PyExc_AttributeError,
Fred Drake7a36f5f2006-08-04 05:17:21 +00001585 "This object has no __weakref__");
Guido van Rossumad47da02002-08-12 19:05:44 +00001586 return NULL;
1587 }
1588 assert(obj->ob_type->tp_weaklistoffset > 0);
1589 assert(obj->ob_type->tp_weaklistoffset + sizeof(PyObject *) <=
Guido van Rossum3747a0f2002-08-12 19:25:08 +00001590 (size_t)(obj->ob_type->tp_basicsize));
Guido van Rossumad47da02002-08-12 19:05:44 +00001591 weaklistptr = (PyObject **)
Guido van Rossum3747a0f2002-08-12 19:25:08 +00001592 ((char *)obj + obj->ob_type->tp_weaklistoffset);
Guido van Rossumad47da02002-08-12 19:05:44 +00001593 if (*weaklistptr == NULL)
1594 result = Py_None;
1595 else
1596 result = *weaklistptr;
1597 Py_INCREF(result);
1598 return result;
1599}
1600
Guido van Rossum373c7412003-01-07 13:41:37 +00001601/* Three variants on the subtype_getsets list. */
1602
1603static PyGetSetDef subtype_getsets_full[] = {
Guido van Rossumad47da02002-08-12 19:05:44 +00001604 {"__dict__", subtype_dict, subtype_setdict,
Neal Norwitz858e34f2002-08-13 17:18:45 +00001605 PyDoc_STR("dictionary for instance variables (if defined)")},
Guido van Rossumad47da02002-08-12 19:05:44 +00001606 {"__weakref__", subtype_getweakref, NULL,
Neal Norwitz858e34f2002-08-13 17:18:45 +00001607 PyDoc_STR("list of weak references to the object (if defined)")},
Guido van Rossumad47da02002-08-12 19:05:44 +00001608 {0}
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001609};
1610
Guido van Rossum373c7412003-01-07 13:41:37 +00001611static PyGetSetDef subtype_getsets_dict_only[] = {
1612 {"__dict__", subtype_dict, subtype_setdict,
1613 PyDoc_STR("dictionary for instance variables (if defined)")},
1614 {0}
1615};
1616
1617static PyGetSetDef subtype_getsets_weakref_only[] = {
1618 {"__weakref__", subtype_getweakref, NULL,
1619 PyDoc_STR("list of weak references to the object (if defined)")},
1620 {0}
1621};
1622
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001623static int
1624valid_identifier(PyObject *s)
1625{
Guido van Rossum03013a02002-07-16 14:30:28 +00001626 unsigned char *p;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001627 Py_ssize_t i, n;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001628
1629 if (!PyString_Check(s)) {
Georg Brandlccff7852006-06-18 22:17:29 +00001630 PyErr_Format(PyExc_TypeError,
1631 "__slots__ items must be strings, not '%.200s'",
1632 s->ob_type->tp_name);
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001633 return 0;
1634 }
Guido van Rossum03013a02002-07-16 14:30:28 +00001635 p = (unsigned char *) PyString_AS_STRING(s);
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001636 n = PyString_GET_SIZE(s);
1637 /* We must reject an empty name. As a hack, we bump the
1638 length to 1 so that the loop will balk on the trailing \0. */
1639 if (n == 0)
1640 n = 1;
1641 for (i = 0; i < n; i++, p++) {
1642 if (!(i == 0 ? isalpha(*p) : isalnum(*p)) && *p != '_') {
1643 PyErr_SetString(PyExc_TypeError,
1644 "__slots__ must be identifiers");
1645 return 0;
1646 }
1647 }
1648 return 1;
1649}
1650
Martin v. Löwisd919a592002-10-14 21:07:28 +00001651#ifdef Py_USING_UNICODE
1652/* Replace Unicode objects in slots. */
1653
1654static PyObject *
Martin v. Löwiseb079f12006-02-16 14:32:27 +00001655_unicode_to_string(PyObject *slots, Py_ssize_t nslots)
Martin v. Löwisd919a592002-10-14 21:07:28 +00001656{
1657 PyObject *tmp = slots;
1658 PyObject *o, *o1;
Martin v. Löwiseb079f12006-02-16 14:32:27 +00001659 Py_ssize_t i;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001660 ssizessizeargfunc copy = slots->ob_type->tp_as_sequence->sq_slice;
Martin v. Löwisd919a592002-10-14 21:07:28 +00001661 for (i = 0; i < nslots; i++) {
1662 if (PyUnicode_Check(o = PyTuple_GET_ITEM(tmp, i))) {
1663 if (tmp == slots) {
1664 tmp = copy(slots, 0, PyTuple_GET_SIZE(slots));
1665 if (tmp == NULL)
1666 return NULL;
1667 }
1668 o1 = _PyUnicode_AsDefaultEncodedString
1669 (o, NULL);
1670 if (o1 == NULL) {
1671 Py_DECREF(tmp);
1672 return 0;
1673 }
1674 Py_INCREF(o1);
1675 Py_DECREF(o);
1676 PyTuple_SET_ITEM(tmp, i, o1);
1677 }
1678 }
1679 return tmp;
1680}
1681#endif
1682
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001683static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001684type_new(PyTypeObject *metatype, PyObject *args, PyObject *kwds)
1685{
1686 PyObject *name, *bases, *dict;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001687 static char *kwlist[] = {"name", "bases", "dict", 0};
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001688 PyObject *slots, *tmp, *newslots;
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001689 PyTypeObject *type, *base, *tmptype, *winner;
Guido van Rossume5c691a2003-03-07 15:13:17 +00001690 PyHeapTypeObject *et;
Guido van Rossum6f799372001-09-20 20:46:19 +00001691 PyMemberDef *mp;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001692 Py_ssize_t i, nbases, nslots, slotoffset, add_dict, add_weak;
Guido van Rossumad47da02002-08-12 19:05:44 +00001693 int j, may_add_dict, may_add_weak;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001694
Tim Peters3abca122001-10-27 19:37:48 +00001695 assert(args != NULL && PyTuple_Check(args));
1696 assert(kwds == NULL || PyDict_Check(kwds));
1697
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001698 /* Special case: type(x) should return x->ob_type */
Tim Peters3abca122001-10-27 19:37:48 +00001699 {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001700 const Py_ssize_t nargs = PyTuple_GET_SIZE(args);
1701 const Py_ssize_t nkwds = kwds == NULL ? 0 : PyDict_Size(kwds);
Tim Peters3abca122001-10-27 19:37:48 +00001702
1703 if (PyType_CheckExact(metatype) && nargs == 1 && nkwds == 0) {
1704 PyObject *x = PyTuple_GET_ITEM(args, 0);
1705 Py_INCREF(x->ob_type);
1706 return (PyObject *) x->ob_type;
1707 }
1708
1709 /* SF bug 475327 -- if that didn't trigger, we need 3
1710 arguments. but PyArg_ParseTupleAndKeywords below may give
1711 a msg saying type() needs exactly 3. */
1712 if (nargs + nkwds != 3) {
1713 PyErr_SetString(PyExc_TypeError,
1714 "type() takes 1 or 3 arguments");
1715 return NULL;
1716 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001717 }
1718
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001719 /* Check arguments: (name, bases, dict) */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001720 if (!PyArg_ParseTupleAndKeywords(args, kwds, "SO!O!:type", kwlist,
1721 &name,
1722 &PyTuple_Type, &bases,
1723 &PyDict_Type, &dict))
1724 return NULL;
1725
Jeremy Hyltonfa955692007-02-27 18:29:45 +00001726 winner = most_derived_metaclass(metatype, bases);
1727 if (winner == NULL)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001728 return NULL;
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001729 if (winner != metatype) {
Jeremy Hyltonfa955692007-02-27 18:29:45 +00001730 if (winner->tp_new != type_new) /* Pass it to the winner */ {
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001731 return winner->tp_new(winner, args, kwds);
Jeremy Hyltonfa955692007-02-27 18:29:45 +00001732 }
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001733 metatype = winner;
1734 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001735
1736 /* Adjust for empty tuple bases */
Jeremy Hyltonfa955692007-02-27 18:29:45 +00001737 nbases = PyTuple_GET_SIZE(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001738 if (nbases == 0) {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00001739 bases = PyTuple_Pack(1, &PyBaseObject_Type);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001740 if (bases == NULL)
1741 return NULL;
1742 nbases = 1;
1743 }
1744 else
1745 Py_INCREF(bases);
1746
1747 /* XXX From here until type is allocated, "return NULL" leaks bases! */
1748
1749 /* Calculate best base, and check that all bases are type objects */
1750 base = best_base(bases);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001751 if (base == NULL) {
1752 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001753 return NULL;
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001754 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001755 if (!PyType_HasFeature(base, Py_TPFLAGS_BASETYPE)) {
1756 PyErr_Format(PyExc_TypeError,
1757 "type '%.100s' is not an acceptable base type",
1758 base->tp_name);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001759 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001760 return NULL;
1761 }
1762
Tim Peters6d6c1a32001-08-02 04:15:00 +00001763 /* Check for a __slots__ sequence variable in dict, and count it */
1764 slots = PyDict_GetItemString(dict, "__slots__");
1765 nslots = 0;
Guido van Rossum9676b222001-08-17 20:32:36 +00001766 add_dict = 0;
1767 add_weak = 0;
Guido van Rossumad47da02002-08-12 19:05:44 +00001768 may_add_dict = base->tp_dictoffset == 0;
1769 may_add_weak = base->tp_weaklistoffset == 0 && base->tp_itemsize == 0;
1770 if (slots == NULL) {
1771 if (may_add_dict) {
1772 add_dict++;
1773 }
1774 if (may_add_weak) {
1775 add_weak++;
1776 }
1777 }
1778 else {
1779 /* Have slots */
1780
Tim Peters6d6c1a32001-08-02 04:15:00 +00001781 /* Make it into a tuple */
1782 if (PyString_Check(slots))
Raymond Hettinger8ae46892003-10-12 19:09:37 +00001783 slots = PyTuple_Pack(1, slots);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001784 else
1785 slots = PySequence_Tuple(slots);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001786 if (slots == NULL) {
1787 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001788 return NULL;
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001789 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001790 assert(PyTuple_Check(slots));
1791
1792 /* Are slots allowed? */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001793 nslots = PyTuple_GET_SIZE(slots);
Jeremy Hylton1c7a0ea2003-07-16 16:08:23 +00001794 if (nslots > 0 && base->tp_itemsize != 0) {
Guido van Rossumc4141872001-08-30 04:43:35 +00001795 PyErr_Format(PyExc_TypeError,
1796 "nonempty __slots__ "
1797 "not supported for subtype of '%s'",
1798 base->tp_name);
Guido van Rossumad47da02002-08-12 19:05:44 +00001799 bad_slots:
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001800 Py_DECREF(bases);
Guido van Rossumad47da02002-08-12 19:05:44 +00001801 Py_DECREF(slots);
Guido van Rossumc4141872001-08-30 04:43:35 +00001802 return NULL;
1803 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001804
Martin v. Löwisd919a592002-10-14 21:07:28 +00001805#ifdef Py_USING_UNICODE
1806 tmp = _unicode_to_string(slots, nslots);
Martin v. Löwis13b1a5c2002-10-14 21:11:34 +00001807 if (tmp != slots) {
1808 Py_DECREF(slots);
1809 slots = tmp;
1810 }
Martin v. Löwisd919a592002-10-14 21:07:28 +00001811 if (!tmp)
1812 return NULL;
1813#endif
Guido van Rossumad47da02002-08-12 19:05:44 +00001814 /* Check for valid slot names and two special cases */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001815 for (i = 0; i < nslots; i++) {
Guido van Rossumad47da02002-08-12 19:05:44 +00001816 PyObject *tmp = PyTuple_GET_ITEM(slots, i);
1817 char *s;
1818 if (!valid_identifier(tmp))
1819 goto bad_slots;
1820 assert(PyString_Check(tmp));
1821 s = PyString_AS_STRING(tmp);
1822 if (strcmp(s, "__dict__") == 0) {
1823 if (!may_add_dict || add_dict) {
1824 PyErr_SetString(PyExc_TypeError,
1825 "__dict__ slot disallowed: "
1826 "we already got one");
1827 goto bad_slots;
1828 }
1829 add_dict++;
1830 }
1831 if (strcmp(s, "__weakref__") == 0) {
1832 if (!may_add_weak || add_weak) {
1833 PyErr_SetString(PyExc_TypeError,
1834 "__weakref__ slot disallowed: "
1835 "either we already got one, "
1836 "or __itemsize__ != 0");
1837 goto bad_slots;
1838 }
1839 add_weak++;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001840 }
1841 }
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001842
Guido van Rossumad47da02002-08-12 19:05:44 +00001843 /* Copy slots into yet another tuple, demangling names */
1844 newslots = PyTuple_New(nslots - add_dict - add_weak);
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001845 if (newslots == NULL)
Guido van Rossumad47da02002-08-12 19:05:44 +00001846 goto bad_slots;
1847 for (i = j = 0; i < nslots; i++) {
1848 char *s;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001849 tmp = PyTuple_GET_ITEM(slots, i);
Guido van Rossumad47da02002-08-12 19:05:44 +00001850 s = PyString_AS_STRING(tmp);
1851 if ((add_dict && strcmp(s, "__dict__") == 0) ||
1852 (add_weak && strcmp(s, "__weakref__") == 0))
1853 continue;
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001854 tmp =_Py_Mangle(name, tmp);
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001855 if (!tmp)
1856 goto bad_slots;
Guido van Rossumad47da02002-08-12 19:05:44 +00001857 PyTuple_SET_ITEM(newslots, j, tmp);
1858 j++;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001859 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001860 assert(j == nslots - add_dict - add_weak);
1861 nslots = j;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001862 Py_DECREF(slots);
1863 slots = newslots;
1864
Guido van Rossumad47da02002-08-12 19:05:44 +00001865 /* Secondary bases may provide weakrefs or dict */
1866 if (nbases > 1 &&
1867 ((may_add_dict && !add_dict) ||
1868 (may_add_weak && !add_weak))) {
1869 for (i = 0; i < nbases; i++) {
1870 tmp = PyTuple_GET_ITEM(bases, i);
1871 if (tmp == (PyObject *)base)
1872 continue; /* Skip primary base */
1873 if (PyClass_Check(tmp)) {
1874 /* Classic base class provides both */
1875 if (may_add_dict && !add_dict)
1876 add_dict++;
1877 if (may_add_weak && !add_weak)
1878 add_weak++;
1879 break;
1880 }
1881 assert(PyType_Check(tmp));
1882 tmptype = (PyTypeObject *)tmp;
1883 if (may_add_dict && !add_dict &&
1884 tmptype->tp_dictoffset != 0)
1885 add_dict++;
1886 if (may_add_weak && !add_weak &&
1887 tmptype->tp_weaklistoffset != 0)
1888 add_weak++;
1889 if (may_add_dict && !add_dict)
1890 continue;
1891 if (may_add_weak && !add_weak)
1892 continue;
1893 /* Nothing more to check */
1894 break;
1895 }
1896 }
Guido van Rossum9676b222001-08-17 20:32:36 +00001897 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001898
1899 /* XXX From here until type is safely allocated,
1900 "return NULL" may leak slots! */
1901
1902 /* Allocate the type object */
1903 type = (PyTypeObject *)metatype->tp_alloc(metatype, nslots);
Guido van Rossumad47da02002-08-12 19:05:44 +00001904 if (type == NULL) {
1905 Py_XDECREF(slots);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001906 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001907 return NULL;
Guido van Rossumad47da02002-08-12 19:05:44 +00001908 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001909
1910 /* Keep name and slots alive in the extended type object */
Guido van Rossume5c691a2003-03-07 15:13:17 +00001911 et = (PyHeapTypeObject *)type;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001912 Py_INCREF(name);
Georg Brandlc255c7b2006-02-20 22:27:28 +00001913 et->ht_name = name;
1914 et->ht_slots = slots;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001915
Guido van Rossumdc91b992001-08-08 22:26:22 +00001916 /* Initialize tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001917 type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HEAPTYPE |
1918 Py_TPFLAGS_BASETYPE;
Guido van Rossum048eb752001-10-02 21:24:57 +00001919 if (base->tp_flags & Py_TPFLAGS_HAVE_GC)
1920 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
Guido van Rossumdc91b992001-08-08 22:26:22 +00001921
1922 /* It's a new-style number unless it specifically inherits any
1923 old-style numeric behavior */
1924 if ((base->tp_flags & Py_TPFLAGS_CHECKTYPES) ||
1925 (base->tp_as_number == NULL))
1926 type->tp_flags |= Py_TPFLAGS_CHECKTYPES;
1927
1928 /* Initialize essential fields */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001929 type->tp_as_number = &et->as_number;
1930 type->tp_as_sequence = &et->as_sequence;
1931 type->tp_as_mapping = &et->as_mapping;
1932 type->tp_as_buffer = &et->as_buffer;
1933 type->tp_name = PyString_AS_STRING(name);
1934
1935 /* Set tp_base and tp_bases */
1936 type->tp_bases = bases;
1937 Py_INCREF(base);
1938 type->tp_base = base;
1939
Guido van Rossum687ae002001-10-15 22:03:32 +00001940 /* Initialize tp_dict from passed-in dict */
1941 type->tp_dict = dict = PyDict_Copy(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001942 if (dict == NULL) {
1943 Py_DECREF(type);
1944 return NULL;
1945 }
1946
Guido van Rossumc3542212001-08-16 09:18:56 +00001947 /* Set __module__ in the dict */
1948 if (PyDict_GetItemString(dict, "__module__") == NULL) {
1949 tmp = PyEval_GetGlobals();
1950 if (tmp != NULL) {
1951 tmp = PyDict_GetItemString(tmp, "__name__");
1952 if (tmp != NULL) {
1953 if (PyDict_SetItemString(dict, "__module__",
1954 tmp) < 0)
1955 return NULL;
1956 }
1957 }
1958 }
1959
Tim Peters2f93e282001-10-04 05:27:00 +00001960 /* Set tp_doc to a copy of dict['__doc__'], if the latter is there
Tim Peters24008312002-03-17 18:56:20 +00001961 and is a string. The __doc__ accessor will first look for tp_doc;
1962 if that fails, it will still look into __dict__.
Tim Peters2f93e282001-10-04 05:27:00 +00001963 */
1964 {
1965 PyObject *doc = PyDict_GetItemString(dict, "__doc__");
1966 if (doc != NULL && PyString_Check(doc)) {
1967 const size_t n = (size_t)PyString_GET_SIZE(doc);
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001968 char *tp_doc = (char *)PyObject_MALLOC(n+1);
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001969 if (tp_doc == NULL) {
Tim Peters2f93e282001-10-04 05:27:00 +00001970 Py_DECREF(type);
1971 return NULL;
1972 }
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001973 memcpy(tp_doc, PyString_AS_STRING(doc), n+1);
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001974 type->tp_doc = tp_doc;
Tim Peters2f93e282001-10-04 05:27:00 +00001975 }
1976 }
1977
Tim Peters6d6c1a32001-08-02 04:15:00 +00001978 /* Special-case __new__: if it's a plain function,
1979 make it a static function */
1980 tmp = PyDict_GetItemString(dict, "__new__");
1981 if (tmp != NULL && PyFunction_Check(tmp)) {
1982 tmp = PyStaticMethod_New(tmp);
1983 if (tmp == NULL) {
1984 Py_DECREF(type);
1985 return NULL;
1986 }
1987 PyDict_SetItemString(dict, "__new__", tmp);
1988 Py_DECREF(tmp);
1989 }
1990
1991 /* Add descriptors for custom slots from __slots__, or for __dict__ */
Guido van Rossume5c691a2003-03-07 15:13:17 +00001992 mp = PyHeapType_GET_MEMBERS(et);
Neil Schemenauerc806c882001-08-29 23:54:54 +00001993 slotoffset = base->tp_basicsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001994 if (slots != NULL) {
1995 for (i = 0; i < nslots; i++, mp++) {
1996 mp->name = PyString_AS_STRING(
1997 PyTuple_GET_ITEM(slots, i));
Guido van Rossum64b206c2001-12-04 17:13:22 +00001998 mp->type = T_OBJECT_EX;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001999 mp->offset = slotoffset;
Žiga Seilnacht89032082007-03-11 15:54:54 +00002000
2001 /* __dict__ and __weakref__ are already filtered out */
2002 assert(strcmp(mp->name, "__dict__") != 0);
2003 assert(strcmp(mp->name, "__weakref__") != 0);
2004
Tim Peters6d6c1a32001-08-02 04:15:00 +00002005 slotoffset += sizeof(PyObject *);
2006 }
2007 }
Guido van Rossumad47da02002-08-12 19:05:44 +00002008 if (add_dict) {
2009 if (base->tp_itemsize)
2010 type->tp_dictoffset = -(long)sizeof(PyObject *);
2011 else
2012 type->tp_dictoffset = slotoffset;
2013 slotoffset += sizeof(PyObject *);
2014 }
2015 if (add_weak) {
2016 assert(!base->tp_itemsize);
2017 type->tp_weaklistoffset = slotoffset;
2018 slotoffset += sizeof(PyObject *);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002019 }
2020 type->tp_basicsize = slotoffset;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00002021 type->tp_itemsize = base->tp_itemsize;
Guido van Rossume5c691a2003-03-07 15:13:17 +00002022 type->tp_members = PyHeapType_GET_MEMBERS(et);
Guido van Rossum373c7412003-01-07 13:41:37 +00002023
2024 if (type->tp_weaklistoffset && type->tp_dictoffset)
2025 type->tp_getset = subtype_getsets_full;
2026 else if (type->tp_weaklistoffset && !type->tp_dictoffset)
2027 type->tp_getset = subtype_getsets_weakref_only;
2028 else if (!type->tp_weaklistoffset && type->tp_dictoffset)
2029 type->tp_getset = subtype_getsets_dict_only;
2030 else
2031 type->tp_getset = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002032
2033 /* Special case some slots */
2034 if (type->tp_dictoffset != 0 || nslots > 0) {
2035 if (base->tp_getattr == NULL && base->tp_getattro == NULL)
2036 type->tp_getattro = PyObject_GenericGetAttr;
2037 if (base->tp_setattr == NULL && base->tp_setattro == NULL)
2038 type->tp_setattro = PyObject_GenericSetAttr;
2039 }
2040 type->tp_dealloc = subtype_dealloc;
2041
Guido van Rossum9475a232001-10-05 20:51:39 +00002042 /* Enable GC unless there are really no instance variables possible */
2043 if (!(type->tp_basicsize == sizeof(PyObject) &&
2044 type->tp_itemsize == 0))
2045 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
2046
Tim Peters6d6c1a32001-08-02 04:15:00 +00002047 /* Always override allocation strategy to use regular heap */
2048 type->tp_alloc = PyType_GenericAlloc;
Guido van Rossum048eb752001-10-02 21:24:57 +00002049 if (type->tp_flags & Py_TPFLAGS_HAVE_GC) {
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00002050 type->tp_free = PyObject_GC_Del;
Guido van Rossum9475a232001-10-05 20:51:39 +00002051 type->tp_traverse = subtype_traverse;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00002052 type->tp_clear = subtype_clear;
Guido van Rossum048eb752001-10-02 21:24:57 +00002053 }
2054 else
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00002055 type->tp_free = PyObject_Del;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002056
2057 /* Initialize the rest */
Guido van Rossum528b7eb2001-08-07 17:24:28 +00002058 if (PyType_Ready(type) < 0) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00002059 Py_DECREF(type);
2060 return NULL;
2061 }
2062
Guido van Rossum7b9144b2001-10-09 19:39:46 +00002063 /* Put the proper slots in place */
2064 fixup_slot_dispatchers(type);
Guido van Rossumf040ede2001-08-07 16:40:56 +00002065
Tim Peters6d6c1a32001-08-02 04:15:00 +00002066 return (PyObject *)type;
2067}
2068
2069/* Internal API to look for a name through the MRO.
2070 This returns a borrowed reference, and doesn't set an exception! */
2071PyObject *
2072_PyType_Lookup(PyTypeObject *type, PyObject *name)
2073{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002074 Py_ssize_t i, n;
Tim Petersa91e9642001-11-14 23:32:33 +00002075 PyObject *mro, *res, *base, *dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002076
Guido van Rossum687ae002001-10-15 22:03:32 +00002077 /* Look in tp_dict of types in MRO */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002078 mro = type->tp_mro;
Guido van Rossum23094982002-06-10 14:30:43 +00002079
2080 /* If mro is NULL, the type is either not yet initialized
2081 by PyType_Ready(), or already cleared by type_clear().
2082 Either way the safest thing to do is to return NULL. */
2083 if (mro == NULL)
2084 return NULL;
2085
Tim Peters6d6c1a32001-08-02 04:15:00 +00002086 assert(PyTuple_Check(mro));
2087 n = PyTuple_GET_SIZE(mro);
2088 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00002089 base = PyTuple_GET_ITEM(mro, i);
2090 if (PyClass_Check(base))
2091 dict = ((PyClassObject *)base)->cl_dict;
2092 else {
2093 assert(PyType_Check(base));
2094 dict = ((PyTypeObject *)base)->tp_dict;
2095 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002096 assert(dict && PyDict_Check(dict));
2097 res = PyDict_GetItem(dict, name);
2098 if (res != NULL)
2099 return res;
2100 }
2101 return NULL;
2102}
2103
2104/* This is similar to PyObject_GenericGetAttr(),
2105 but uses _PyType_Lookup() instead of just looking in type->tp_dict. */
2106static PyObject *
2107type_getattro(PyTypeObject *type, PyObject *name)
2108{
2109 PyTypeObject *metatype = type->ob_type;
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002110 PyObject *meta_attribute, *attribute;
2111 descrgetfunc meta_get;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002112
2113 /* Initialize this type (we'll assume the metatype is initialized) */
2114 if (type->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00002115 if (PyType_Ready(type) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002116 return NULL;
2117 }
2118
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002119 /* No readable descriptor found yet */
2120 meta_get = NULL;
Tim Peters34592512002-07-11 06:23:50 +00002121
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002122 /* Look for the attribute in the metatype */
2123 meta_attribute = _PyType_Lookup(metatype, name);
2124
2125 if (meta_attribute != NULL) {
2126 meta_get = meta_attribute->ob_type->tp_descr_get;
Tim Peters34592512002-07-11 06:23:50 +00002127
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002128 if (meta_get != NULL && PyDescr_IsData(meta_attribute)) {
2129 /* Data descriptors implement tp_descr_set to intercept
2130 * writes. Assume the attribute is not overridden in
2131 * type's tp_dict (and bases): call the descriptor now.
2132 */
2133 return meta_get(meta_attribute, (PyObject *)type,
2134 (PyObject *)metatype);
2135 }
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002136 Py_INCREF(meta_attribute);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002137 }
2138
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002139 /* No data descriptor found on metatype. Look in tp_dict of this
2140 * type and its bases */
2141 attribute = _PyType_Lookup(type, name);
2142 if (attribute != NULL) {
2143 /* Implement descriptor functionality, if any */
2144 descrgetfunc local_get = attribute->ob_type->tp_descr_get;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002145
2146 Py_XDECREF(meta_attribute);
2147
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002148 if (local_get != NULL) {
2149 /* NULL 2nd argument indicates the descriptor was
2150 * found on the target object itself (or a base) */
2151 return local_get(attribute, (PyObject *)NULL,
2152 (PyObject *)type);
2153 }
Tim Peters34592512002-07-11 06:23:50 +00002154
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002155 Py_INCREF(attribute);
2156 return attribute;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002157 }
2158
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002159 /* No attribute found in local __dict__ (or bases): use the
2160 * descriptor from the metatype, if any */
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002161 if (meta_get != NULL) {
2162 PyObject *res;
2163 res = meta_get(meta_attribute, (PyObject *)type,
2164 (PyObject *)metatype);
2165 Py_DECREF(meta_attribute);
2166 return res;
2167 }
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002168
2169 /* If an ordinary attribute was found on the metatype, return it now */
2170 if (meta_attribute != NULL) {
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002171 return meta_attribute;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002172 }
2173
2174 /* Give up */
2175 PyErr_Format(PyExc_AttributeError,
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002176 "type object '%.50s' has no attribute '%.400s'",
2177 type->tp_name, PyString_AS_STRING(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +00002178 return NULL;
2179}
2180
2181static int
2182type_setattro(PyTypeObject *type, PyObject *name, PyObject *value)
2183{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00002184 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
2185 PyErr_Format(
2186 PyExc_TypeError,
2187 "can't set attributes of built-in/extension type '%s'",
2188 type->tp_name);
2189 return -1;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00002190 }
Guido van Rossum8d24ee92003-03-24 23:49:49 +00002191 /* XXX Example of how I expect this to be used...
2192 if (update_subclasses(type, name, invalidate_cache, NULL) < 0)
2193 return -1;
2194 */
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00002195 if (PyObject_GenericSetAttr((PyObject *)type, name, value) < 0)
2196 return -1;
2197 return update_slot(type, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002198}
2199
2200static void
2201type_dealloc(PyTypeObject *type)
2202{
Guido van Rossume5c691a2003-03-07 15:13:17 +00002203 PyHeapTypeObject *et;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002204
2205 /* Assert this is a heap-allocated type object */
2206 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002207 _PyObject_GC_UNTRACK(type);
Guido van Rossum1c450732001-10-08 15:18:27 +00002208 PyObject_ClearWeakRefs((PyObject *)type);
Guido van Rossume5c691a2003-03-07 15:13:17 +00002209 et = (PyHeapTypeObject *)type;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002210 Py_XDECREF(type->tp_base);
2211 Py_XDECREF(type->tp_dict);
2212 Py_XDECREF(type->tp_bases);
2213 Py_XDECREF(type->tp_mro);
Guido van Rossum687ae002001-10-15 22:03:32 +00002214 Py_XDECREF(type->tp_cache);
Guido van Rossum1c450732001-10-08 15:18:27 +00002215 Py_XDECREF(type->tp_subclasses);
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002216 /* A type's tp_doc is heap allocated, unlike the tp_doc slots
2217 * of most other objects. It's okay to cast it to char *.
2218 */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002219 PyObject_Free((char *)type->tp_doc);
Georg Brandlc255c7b2006-02-20 22:27:28 +00002220 Py_XDECREF(et->ht_name);
2221 Py_XDECREF(et->ht_slots);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002222 type->ob_type->tp_free((PyObject *)type);
2223}
2224
Guido van Rossum1c450732001-10-08 15:18:27 +00002225static PyObject *
2226type_subclasses(PyTypeObject *type, PyObject *args_ignored)
2227{
2228 PyObject *list, *raw, *ref;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002229 Py_ssize_t i, n;
Guido van Rossum1c450732001-10-08 15:18:27 +00002230
2231 list = PyList_New(0);
2232 if (list == NULL)
2233 return NULL;
2234 raw = type->tp_subclasses;
2235 if (raw == NULL)
2236 return list;
2237 assert(PyList_Check(raw));
2238 n = PyList_GET_SIZE(raw);
2239 for (i = 0; i < n; i++) {
2240 ref = PyList_GET_ITEM(raw, i);
Tim Peters44383382001-10-08 16:49:26 +00002241 assert(PyWeakref_CheckRef(ref));
Guido van Rossum1c450732001-10-08 15:18:27 +00002242 ref = PyWeakref_GET_OBJECT(ref);
2243 if (ref != Py_None) {
2244 if (PyList_Append(list, ref) < 0) {
2245 Py_DECREF(list);
2246 return NULL;
2247 }
2248 }
2249 }
2250 return list;
2251}
2252
Tim Peters6d6c1a32001-08-02 04:15:00 +00002253static PyMethodDef type_methods[] = {
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002254 {"mro", (PyCFunction)mro_external, METH_NOARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002255 PyDoc_STR("mro() -> list\nreturn a type's method resolution order")},
Guido van Rossum1c450732001-10-08 15:18:27 +00002256 {"__subclasses__", (PyCFunction)type_subclasses, METH_NOARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002257 PyDoc_STR("__subclasses__() -> list of immediate subclasses")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00002258 {0}
2259};
2260
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002261PyDoc_STRVAR(type_doc,
Tim Peters6d6c1a32001-08-02 04:15:00 +00002262"type(object) -> the object's type\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002263"type(name, bases, dict) -> a new type");
Tim Peters6d6c1a32001-08-02 04:15:00 +00002264
Guido van Rossum048eb752001-10-02 21:24:57 +00002265static int
2266type_traverse(PyTypeObject *type, visitproc visit, void *arg)
2267{
Guido van Rossuma3862092002-06-10 15:24:42 +00002268 /* Because of type_is_gc(), the collector only calls this
2269 for heaptypes. */
2270 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002271
Thomas Woutersc6e55062006-04-15 21:47:09 +00002272 Py_VISIT(type->tp_dict);
2273 Py_VISIT(type->tp_cache);
2274 Py_VISIT(type->tp_mro);
2275 Py_VISIT(type->tp_bases);
2276 Py_VISIT(type->tp_base);
Guido van Rossuma3862092002-06-10 15:24:42 +00002277
2278 /* There's no need to visit type->tp_subclasses or
Georg Brandlc255c7b2006-02-20 22:27:28 +00002279 ((PyHeapTypeObject *)type)->ht_slots, because they can't be involved
Guido van Rossuma3862092002-06-10 15:24:42 +00002280 in cycles; tp_subclasses is a list of weak references,
2281 and slots is a tuple of strings. */
Guido van Rossum048eb752001-10-02 21:24:57 +00002282
Guido van Rossum048eb752001-10-02 21:24:57 +00002283 return 0;
2284}
2285
2286static int
2287type_clear(PyTypeObject *type)
2288{
Guido van Rossuma3862092002-06-10 15:24:42 +00002289 /* Because of type_is_gc(), the collector only calls this
2290 for heaptypes. */
2291 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002292
Guido van Rossuma3862092002-06-10 15:24:42 +00002293 /* The only field we need to clear is tp_mro, which is part of a
2294 hard cycle (its first element is the class itself) that won't
2295 be broken otherwise (it's a tuple and tuples don't have a
2296 tp_clear handler). None of the other fields need to be
2297 cleared, and here's why:
Guido van Rossum048eb752001-10-02 21:24:57 +00002298
Guido van Rossuma3862092002-06-10 15:24:42 +00002299 tp_dict:
2300 It is a dict, so the collector will call its tp_clear.
2301
2302 tp_cache:
2303 Not used; if it were, it would be a dict.
2304
2305 tp_bases, tp_base:
2306 If these are involved in a cycle, there must be at least
2307 one other, mutable object in the cycle, e.g. a base
2308 class's dict; the cycle will be broken that way.
2309
2310 tp_subclasses:
2311 A list of weak references can't be part of a cycle; and
2312 lists have their own tp_clear.
2313
Guido van Rossume5c691a2003-03-07 15:13:17 +00002314 slots (in PyHeapTypeObject):
Guido van Rossuma3862092002-06-10 15:24:42 +00002315 A tuple of strings can't be part of a cycle.
2316 */
2317
Thomas Woutersedf17d82006-04-15 17:28:34 +00002318 Py_CLEAR(type->tp_mro);
Guido van Rossum048eb752001-10-02 21:24:57 +00002319
2320 return 0;
2321}
2322
2323static int
2324type_is_gc(PyTypeObject *type)
2325{
2326 return type->tp_flags & Py_TPFLAGS_HEAPTYPE;
2327}
2328
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002329PyTypeObject PyType_Type = {
2330 PyObject_HEAD_INIT(&PyType_Type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002331 0, /* ob_size */
2332 "type", /* tp_name */
Guido van Rossume5c691a2003-03-07 15:13:17 +00002333 sizeof(PyHeapTypeObject), /* tp_basicsize */
Guido van Rossum6f799372001-09-20 20:46:19 +00002334 sizeof(PyMemberDef), /* tp_itemsize */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002335 (destructor)type_dealloc, /* tp_dealloc */
2336 0, /* tp_print */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002337 0, /* tp_getattr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002338 0, /* tp_setattr */
2339 type_compare, /* tp_compare */
2340 (reprfunc)type_repr, /* tp_repr */
2341 0, /* tp_as_number */
2342 0, /* tp_as_sequence */
2343 0, /* tp_as_mapping */
2344 (hashfunc)_Py_HashPointer, /* tp_hash */
2345 (ternaryfunc)type_call, /* tp_call */
2346 0, /* tp_str */
2347 (getattrofunc)type_getattro, /* tp_getattro */
2348 (setattrofunc)type_setattro, /* tp_setattro */
2349 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00002350 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
Neal Norwitzee3a1b52007-02-25 19:44:48 +00002351 Py_TPFLAGS_BASETYPE | Py_TPFLAGS_TYPE_SUBCLASS, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002352 type_doc, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +00002353 (traverseproc)type_traverse, /* tp_traverse */
2354 (inquiry)type_clear, /* tp_clear */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002355 0, /* tp_richcompare */
Guido van Rossum1c450732001-10-08 15:18:27 +00002356 offsetof(PyTypeObject, tp_weaklist), /* tp_weaklistoffset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002357 0, /* tp_iter */
2358 0, /* tp_iternext */
2359 type_methods, /* tp_methods */
2360 type_members, /* tp_members */
2361 type_getsets, /* tp_getset */
2362 0, /* tp_base */
2363 0, /* tp_dict */
2364 0, /* tp_descr_get */
2365 0, /* tp_descr_set */
2366 offsetof(PyTypeObject, tp_dict), /* tp_dictoffset */
2367 0, /* tp_init */
2368 0, /* tp_alloc */
2369 type_new, /* tp_new */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002370 PyObject_GC_Del, /* tp_free */
Guido van Rossum048eb752001-10-02 21:24:57 +00002371 (inquiry)type_is_gc, /* tp_is_gc */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002372};
Tim Peters6d6c1a32001-08-02 04:15:00 +00002373
2374
2375/* The base type of all types (eventually)... except itself. */
2376
2377static int
2378object_init(PyObject *self, PyObject *args, PyObject *kwds)
2379{
2380 return 0;
2381}
2382
Guido van Rossum298e4212003-02-13 16:30:16 +00002383/* If we don't have a tp_new for a new-style class, new will use this one.
2384 Therefore this should take no arguments/keywords. However, this new may
2385 also be inherited by objects that define a tp_init but no tp_new. These
2386 objects WILL pass argumets to tp_new, because it gets the same args as
2387 tp_init. So only allow arguments if we aren't using the default init, in
2388 which case we expect init to handle argument parsing. */
2389static PyObject *
2390object_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
2391{
2392 if (type->tp_init == object_init && (PyTuple_GET_SIZE(args) ||
2393 (kwds && PyDict_Check(kwds) && PyDict_Size(kwds)))) {
2394 PyErr_SetString(PyExc_TypeError,
2395 "default __new__ takes no parameters");
2396 return NULL;
2397 }
2398 return type->tp_alloc(type, 0);
2399}
2400
Tim Peters6d6c1a32001-08-02 04:15:00 +00002401static void
2402object_dealloc(PyObject *self)
2403{
2404 self->ob_type->tp_free(self);
2405}
2406
Guido van Rossum8e248182001-08-12 05:17:56 +00002407static PyObject *
2408object_repr(PyObject *self)
2409{
Guido van Rossum76e69632001-08-16 18:52:43 +00002410 PyTypeObject *type;
Barry Warsaw7ce36942001-08-24 18:34:26 +00002411 PyObject *mod, *name, *rtn;
Guido van Rossum8e248182001-08-12 05:17:56 +00002412
Guido van Rossum76e69632001-08-16 18:52:43 +00002413 type = self->ob_type;
2414 mod = type_module(type, NULL);
2415 if (mod == NULL)
2416 PyErr_Clear();
2417 else if (!PyString_Check(mod)) {
2418 Py_DECREF(mod);
2419 mod = NULL;
2420 }
2421 name = type_name(type, NULL);
2422 if (name == NULL)
2423 return NULL;
2424 if (mod != NULL && strcmp(PyString_AS_STRING(mod), "__builtin__"))
Guido van Rossumff0e6d62001-09-24 16:03:59 +00002425 rtn = PyString_FromFormat("<%s.%s object at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +00002426 PyString_AS_STRING(mod),
2427 PyString_AS_STRING(name),
2428 self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002429 else
Guido van Rossumff0e6d62001-09-24 16:03:59 +00002430 rtn = PyString_FromFormat("<%s object at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +00002431 type->tp_name, self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002432 Py_XDECREF(mod);
2433 Py_DECREF(name);
Barry Warsaw7ce36942001-08-24 18:34:26 +00002434 return rtn;
Guido van Rossum8e248182001-08-12 05:17:56 +00002435}
2436
Guido van Rossumb8f63662001-08-15 23:57:02 +00002437static PyObject *
2438object_str(PyObject *self)
2439{
2440 unaryfunc f;
2441
2442 f = self->ob_type->tp_repr;
2443 if (f == NULL)
2444 f = object_repr;
2445 return f(self);
2446}
2447
Guido van Rossum8e248182001-08-12 05:17:56 +00002448static long
2449object_hash(PyObject *self)
2450{
2451 return _Py_HashPointer(self);
2452}
Guido van Rossum8e248182001-08-12 05:17:56 +00002453
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002454static PyObject *
2455object_get_class(PyObject *self, void *closure)
2456{
2457 Py_INCREF(self->ob_type);
2458 return (PyObject *)(self->ob_type);
2459}
2460
2461static int
2462equiv_structs(PyTypeObject *a, PyTypeObject *b)
2463{
2464 return a == b ||
2465 (a != NULL &&
2466 b != NULL &&
2467 a->tp_basicsize == b->tp_basicsize &&
2468 a->tp_itemsize == b->tp_itemsize &&
2469 a->tp_dictoffset == b->tp_dictoffset &&
2470 a->tp_weaklistoffset == b->tp_weaklistoffset &&
2471 ((a->tp_flags & Py_TPFLAGS_HAVE_GC) ==
2472 (b->tp_flags & Py_TPFLAGS_HAVE_GC)));
2473}
2474
2475static int
2476same_slots_added(PyTypeObject *a, PyTypeObject *b)
2477{
2478 PyTypeObject *base = a->tp_base;
Martin v. Löwiseb079f12006-02-16 14:32:27 +00002479 Py_ssize_t size;
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002480
2481 if (base != b->tp_base)
2482 return 0;
2483 if (equiv_structs(a, base) && equiv_structs(b, base))
2484 return 1;
2485 size = base->tp_basicsize;
2486 if (a->tp_dictoffset == size && b->tp_dictoffset == size)
2487 size += sizeof(PyObject *);
2488 if (a->tp_weaklistoffset == size && b->tp_weaklistoffset == size)
2489 size += sizeof(PyObject *);
2490 return size == a->tp_basicsize && size == b->tp_basicsize;
2491}
2492
2493static int
Anthony Baxtera6286212006-04-11 07:42:36 +00002494compatible_for_assignment(PyTypeObject* oldto, PyTypeObject* newto, char* attr)
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002495{
2496 PyTypeObject *newbase, *oldbase;
2497
Anthony Baxtera6286212006-04-11 07:42:36 +00002498 if (newto->tp_dealloc != oldto->tp_dealloc ||
2499 newto->tp_free != oldto->tp_free)
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002500 {
2501 PyErr_Format(PyExc_TypeError,
2502 "%s assignment: "
2503 "'%s' deallocator differs from '%s'",
2504 attr,
Anthony Baxtera6286212006-04-11 07:42:36 +00002505 newto->tp_name,
2506 oldto->tp_name);
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002507 return 0;
2508 }
Anthony Baxtera6286212006-04-11 07:42:36 +00002509 newbase = newto;
2510 oldbase = oldto;
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002511 while (equiv_structs(newbase, newbase->tp_base))
2512 newbase = newbase->tp_base;
2513 while (equiv_structs(oldbase, oldbase->tp_base))
2514 oldbase = oldbase->tp_base;
2515 if (newbase != oldbase &&
2516 (newbase->tp_base != oldbase->tp_base ||
2517 !same_slots_added(newbase, oldbase))) {
2518 PyErr_Format(PyExc_TypeError,
2519 "%s assignment: "
2520 "'%s' object layout differs from '%s'",
2521 attr,
Anthony Baxtera6286212006-04-11 07:42:36 +00002522 newto->tp_name,
2523 oldto->tp_name);
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002524 return 0;
2525 }
Tim Petersea7f75d2002-12-07 21:39:16 +00002526
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002527 return 1;
2528}
2529
2530static int
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002531object_set_class(PyObject *self, PyObject *value, void *closure)
2532{
Anthony Baxtera6286212006-04-11 07:42:36 +00002533 PyTypeObject *oldto = self->ob_type;
2534 PyTypeObject *newto;
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002535
Guido van Rossumb6b89422002-04-15 01:03:30 +00002536 if (value == NULL) {
2537 PyErr_SetString(PyExc_TypeError,
2538 "can't delete __class__ attribute");
2539 return -1;
2540 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002541 if (!PyType_Check(value)) {
2542 PyErr_Format(PyExc_TypeError,
2543 "__class__ must be set to new-style class, not '%s' object",
2544 value->ob_type->tp_name);
2545 return -1;
2546 }
Anthony Baxtera6286212006-04-11 07:42:36 +00002547 newto = (PyTypeObject *)value;
2548 if (!(newto->tp_flags & Py_TPFLAGS_HEAPTYPE) ||
2549 !(oldto->tp_flags & Py_TPFLAGS_HEAPTYPE))
Guido van Rossum40af8892002-08-10 05:42:07 +00002550 {
2551 PyErr_Format(PyExc_TypeError,
2552 "__class__ assignment: only for heap types");
2553 return -1;
2554 }
Anthony Baxtera6286212006-04-11 07:42:36 +00002555 if (compatible_for_assignment(newto, oldto, "__class__")) {
2556 Py_INCREF(newto);
2557 self->ob_type = newto;
2558 Py_DECREF(oldto);
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002559 return 0;
2560 }
2561 else {
Guido van Rossum9ee4b942002-05-24 18:47:47 +00002562 return -1;
2563 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002564}
2565
2566static PyGetSetDef object_getsets[] = {
2567 {"__class__", object_get_class, object_set_class,
Neal Norwitz858e34f2002-08-13 17:18:45 +00002568 PyDoc_STR("the object's class")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00002569 {0}
2570};
2571
Guido van Rossumc53f0092003-02-18 22:05:12 +00002572
Guido van Rossum036f9992003-02-21 22:02:54 +00002573/* Stuff to implement __reduce_ex__ for pickle protocols >= 2.
2574 We fall back to helpers in copy_reg for:
2575 - pickle protocols < 2
2576 - calculating the list of slot names (done only once per class)
2577 - the __newobj__ function (which is used as a token but never called)
2578*/
2579
2580static PyObject *
2581import_copy_reg(void)
2582{
2583 static PyObject *copy_reg_str;
Guido van Rossum3926a632001-09-25 16:25:58 +00002584
2585 if (!copy_reg_str) {
2586 copy_reg_str = PyString_InternFromString("copy_reg");
2587 if (copy_reg_str == NULL)
2588 return NULL;
2589 }
Guido van Rossum036f9992003-02-21 22:02:54 +00002590
2591 return PyImport_Import(copy_reg_str);
2592}
2593
2594static PyObject *
2595slotnames(PyObject *cls)
2596{
2597 PyObject *clsdict;
2598 PyObject *copy_reg;
2599 PyObject *slotnames;
2600
2601 if (!PyType_Check(cls)) {
2602 Py_INCREF(Py_None);
2603 return Py_None;
2604 }
2605
2606 clsdict = ((PyTypeObject *)cls)->tp_dict;
2607 slotnames = PyDict_GetItemString(clsdict, "__slotnames__");
Armin Rigoec862b92005-09-24 22:58:41 +00002608 if (slotnames != NULL && PyList_Check(slotnames)) {
Guido van Rossum036f9992003-02-21 22:02:54 +00002609 Py_INCREF(slotnames);
2610 return slotnames;
2611 }
2612
2613 copy_reg = import_copy_reg();
2614 if (copy_reg == NULL)
2615 return NULL;
2616
2617 slotnames = PyObject_CallMethod(copy_reg, "_slotnames", "O", cls);
2618 Py_DECREF(copy_reg);
2619 if (slotnames != NULL &&
2620 slotnames != Py_None &&
2621 !PyList_Check(slotnames))
2622 {
2623 PyErr_SetString(PyExc_TypeError,
2624 "copy_reg._slotnames didn't return a list or None");
2625 Py_DECREF(slotnames);
2626 slotnames = NULL;
2627 }
2628
2629 return slotnames;
2630}
2631
2632static PyObject *
2633reduce_2(PyObject *obj)
2634{
2635 PyObject *cls, *getnewargs;
2636 PyObject *args = NULL, *args2 = NULL;
2637 PyObject *getstate = NULL, *state = NULL, *names = NULL;
2638 PyObject *slots = NULL, *listitems = NULL, *dictitems = NULL;
2639 PyObject *copy_reg = NULL, *newobj = NULL, *res = NULL;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002640 Py_ssize_t i, n;
Guido van Rossum036f9992003-02-21 22:02:54 +00002641
2642 cls = PyObject_GetAttrString(obj, "__class__");
2643 if (cls == NULL)
2644 return NULL;
2645
2646 getnewargs = PyObject_GetAttrString(obj, "__getnewargs__");
2647 if (getnewargs != NULL) {
2648 args = PyObject_CallObject(getnewargs, NULL);
2649 Py_DECREF(getnewargs);
2650 if (args != NULL && !PyTuple_Check(args)) {
Georg Brandlccff7852006-06-18 22:17:29 +00002651 PyErr_Format(PyExc_TypeError,
2652 "__getnewargs__ should return a tuple, "
2653 "not '%.200s'", args->ob_type->tp_name);
Guido van Rossum036f9992003-02-21 22:02:54 +00002654 goto end;
2655 }
2656 }
2657 else {
2658 PyErr_Clear();
2659 args = PyTuple_New(0);
2660 }
2661 if (args == NULL)
2662 goto end;
2663
2664 getstate = PyObject_GetAttrString(obj, "__getstate__");
2665 if (getstate != NULL) {
2666 state = PyObject_CallObject(getstate, NULL);
2667 Py_DECREF(getstate);
Neal Norwitze2fdc612003-06-08 13:19:58 +00002668 if (state == NULL)
2669 goto end;
Guido van Rossum036f9992003-02-21 22:02:54 +00002670 }
2671 else {
Jim Fulton8a1a5942004-02-08 04:21:26 +00002672 PyErr_Clear();
Guido van Rossum036f9992003-02-21 22:02:54 +00002673 state = PyObject_GetAttrString(obj, "__dict__");
2674 if (state == NULL) {
2675 PyErr_Clear();
2676 state = Py_None;
2677 Py_INCREF(state);
2678 }
2679 names = slotnames(cls);
2680 if (names == NULL)
2681 goto end;
2682 if (names != Py_None) {
2683 assert(PyList_Check(names));
2684 slots = PyDict_New();
2685 if (slots == NULL)
2686 goto end;
2687 n = 0;
2688 /* Can't pre-compute the list size; the list
2689 is stored on the class so accessible to other
2690 threads, which may be run by DECREF */
2691 for (i = 0; i < PyList_GET_SIZE(names); i++) {
2692 PyObject *name, *value;
2693 name = PyList_GET_ITEM(names, i);
2694 value = PyObject_GetAttr(obj, name);
2695 if (value == NULL)
2696 PyErr_Clear();
2697 else {
2698 int err = PyDict_SetItem(slots, name,
2699 value);
2700 Py_DECREF(value);
2701 if (err)
2702 goto end;
2703 n++;
2704 }
2705 }
2706 if (n) {
2707 state = Py_BuildValue("(NO)", state, slots);
2708 if (state == NULL)
2709 goto end;
2710 }
2711 }
2712 }
2713
2714 if (!PyList_Check(obj)) {
2715 listitems = Py_None;
2716 Py_INCREF(listitems);
2717 }
2718 else {
2719 listitems = PyObject_GetIter(obj);
2720 if (listitems == NULL)
2721 goto end;
2722 }
2723
2724 if (!PyDict_Check(obj)) {
2725 dictitems = Py_None;
2726 Py_INCREF(dictitems);
2727 }
2728 else {
2729 dictitems = PyObject_CallMethod(obj, "iteritems", "");
2730 if (dictitems == NULL)
2731 goto end;
2732 }
2733
2734 copy_reg = import_copy_reg();
2735 if (copy_reg == NULL)
2736 goto end;
2737 newobj = PyObject_GetAttrString(copy_reg, "__newobj__");
2738 if (newobj == NULL)
2739 goto end;
2740
2741 n = PyTuple_GET_SIZE(args);
2742 args2 = PyTuple_New(n+1);
2743 if (args2 == NULL)
2744 goto end;
2745 PyTuple_SET_ITEM(args2, 0, cls);
2746 cls = NULL;
2747 for (i = 0; i < n; i++) {
2748 PyObject *v = PyTuple_GET_ITEM(args, i);
2749 Py_INCREF(v);
2750 PyTuple_SET_ITEM(args2, i+1, v);
2751 }
2752
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002753 res = PyTuple_Pack(5, newobj, args2, state, listitems, dictitems);
Guido van Rossum036f9992003-02-21 22:02:54 +00002754
2755 end:
2756 Py_XDECREF(cls);
2757 Py_XDECREF(args);
2758 Py_XDECREF(args2);
Jeremy Hyltond06483c2003-04-09 21:01:42 +00002759 Py_XDECREF(slots);
Guido van Rossum036f9992003-02-21 22:02:54 +00002760 Py_XDECREF(state);
2761 Py_XDECREF(names);
2762 Py_XDECREF(listitems);
2763 Py_XDECREF(dictitems);
2764 Py_XDECREF(copy_reg);
2765 Py_XDECREF(newobj);
2766 return res;
2767}
2768
2769static PyObject *
2770object_reduce_ex(PyObject *self, PyObject *args)
2771{
2772 /* Call copy_reg._reduce_ex(self, proto) */
2773 PyObject *reduce, *copy_reg, *res;
2774 int proto = 0;
2775
2776 if (!PyArg_ParseTuple(args, "|i:__reduce_ex__", &proto))
2777 return NULL;
2778
2779 reduce = PyObject_GetAttrString(self, "__reduce__");
2780 if (reduce == NULL)
2781 PyErr_Clear();
2782 else {
2783 PyObject *cls, *clsreduce, *objreduce;
2784 int override;
2785 cls = PyObject_GetAttrString(self, "__class__");
2786 if (cls == NULL) {
2787 Py_DECREF(reduce);
2788 return NULL;
2789 }
2790 clsreduce = PyObject_GetAttrString(cls, "__reduce__");
2791 Py_DECREF(cls);
2792 if (clsreduce == NULL) {
2793 Py_DECREF(reduce);
2794 return NULL;
2795 }
2796 objreduce = PyDict_GetItemString(PyBaseObject_Type.tp_dict,
2797 "__reduce__");
2798 override = (clsreduce != objreduce);
2799 Py_DECREF(clsreduce);
2800 if (override) {
2801 res = PyObject_CallObject(reduce, NULL);
2802 Py_DECREF(reduce);
2803 return res;
2804 }
2805 else
2806 Py_DECREF(reduce);
2807 }
2808
2809 if (proto >= 2)
2810 return reduce_2(self);
2811
2812 copy_reg = import_copy_reg();
Guido van Rossum3926a632001-09-25 16:25:58 +00002813 if (!copy_reg)
2814 return NULL;
Guido van Rossum036f9992003-02-21 22:02:54 +00002815
Guido van Rossumc53f0092003-02-18 22:05:12 +00002816 res = PyEval_CallMethod(copy_reg, "_reduce_ex", "(Oi)", self, proto);
Guido van Rossum3926a632001-09-25 16:25:58 +00002817 Py_DECREF(copy_reg);
Guido van Rossum036f9992003-02-21 22:02:54 +00002818
Guido van Rossum3926a632001-09-25 16:25:58 +00002819 return res;
2820}
2821
2822static PyMethodDef object_methods[] = {
Guido van Rossumc53f0092003-02-18 22:05:12 +00002823 {"__reduce_ex__", object_reduce_ex, METH_VARARGS,
2824 PyDoc_STR("helper for pickle")},
2825 {"__reduce__", object_reduce_ex, METH_VARARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002826 PyDoc_STR("helper for pickle")},
Guido van Rossum3926a632001-09-25 16:25:58 +00002827 {0}
2828};
2829
Guido van Rossum036f9992003-02-21 22:02:54 +00002830
Tim Peters6d6c1a32001-08-02 04:15:00 +00002831PyTypeObject PyBaseObject_Type = {
2832 PyObject_HEAD_INIT(&PyType_Type)
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002833 0, /* ob_size */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002834 "object", /* tp_name */
2835 sizeof(PyObject), /* tp_basicsize */
2836 0, /* tp_itemsize */
Georg Brandl347b3002006-03-30 11:57:00 +00002837 object_dealloc, /* tp_dealloc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002838 0, /* tp_print */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002839 0, /* tp_getattr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002840 0, /* tp_setattr */
2841 0, /* tp_compare */
Guido van Rossumb8f63662001-08-15 23:57:02 +00002842 object_repr, /* tp_repr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002843 0, /* tp_as_number */
2844 0, /* tp_as_sequence */
2845 0, /* tp_as_mapping */
Guido van Rossumb8f63662001-08-15 23:57:02 +00002846 object_hash, /* tp_hash */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002847 0, /* tp_call */
Guido van Rossumb8f63662001-08-15 23:57:02 +00002848 object_str, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002849 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum13d52f02001-08-10 21:24:08 +00002850 PyObject_GenericSetAttr, /* tp_setattro */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002851 0, /* tp_as_buffer */
2852 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002853 PyDoc_STR("The most base type"), /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002854 0, /* tp_traverse */
2855 0, /* tp_clear */
2856 0, /* tp_richcompare */
2857 0, /* tp_weaklistoffset */
2858 0, /* tp_iter */
2859 0, /* tp_iternext */
Guido van Rossum3926a632001-09-25 16:25:58 +00002860 object_methods, /* tp_methods */
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002861 0, /* tp_members */
2862 object_getsets, /* tp_getset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002863 0, /* tp_base */
2864 0, /* tp_dict */
2865 0, /* tp_descr_get */
2866 0, /* tp_descr_set */
2867 0, /* tp_dictoffset */
2868 object_init, /* tp_init */
2869 PyType_GenericAlloc, /* tp_alloc */
Guido van Rossum298e4212003-02-13 16:30:16 +00002870 object_new, /* tp_new */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002871 PyObject_Del, /* tp_free */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002872};
2873
2874
2875/* Initialize the __dict__ in a type object */
2876
2877static int
2878add_methods(PyTypeObject *type, PyMethodDef *meth)
2879{
Guido van Rossum687ae002001-10-15 22:03:32 +00002880 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002881
2882 for (; meth->ml_name != NULL; meth++) {
2883 PyObject *descr;
Raymond Hettinger8f5cdaa2003-12-13 11:26:12 +00002884 if (PyDict_GetItemString(dict, meth->ml_name) &&
2885 !(meth->ml_flags & METH_COEXIST))
2886 continue;
Fred Drake7bf97152002-03-28 05:33:33 +00002887 if (meth->ml_flags & METH_CLASS) {
2888 if (meth->ml_flags & METH_STATIC) {
2889 PyErr_SetString(PyExc_ValueError,
2890 "method cannot be both class and static");
2891 return -1;
2892 }
Tim Petersbca1cbc2002-12-09 22:56:13 +00002893 descr = PyDescr_NewClassMethod(type, meth);
Fred Drake7bf97152002-03-28 05:33:33 +00002894 }
2895 else if (meth->ml_flags & METH_STATIC) {
Guido van Rossum9af48ff2003-02-11 17:12:46 +00002896 PyObject *cfunc = PyCFunction_New(meth, NULL);
2897 if (cfunc == NULL)
2898 return -1;
2899 descr = PyStaticMethod_New(cfunc);
2900 Py_DECREF(cfunc);
Fred Drake7bf97152002-03-28 05:33:33 +00002901 }
2902 else {
2903 descr = PyDescr_NewMethod(type, meth);
2904 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002905 if (descr == NULL)
2906 return -1;
Fred Drake7bf97152002-03-28 05:33:33 +00002907 if (PyDict_SetItemString(dict, meth->ml_name, descr) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002908 return -1;
2909 Py_DECREF(descr);
2910 }
2911 return 0;
2912}
2913
2914static int
Guido van Rossum6f799372001-09-20 20:46:19 +00002915add_members(PyTypeObject *type, PyMemberDef *memb)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002916{
Guido van Rossum687ae002001-10-15 22:03:32 +00002917 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002918
2919 for (; memb->name != NULL; memb++) {
2920 PyObject *descr;
2921 if (PyDict_GetItemString(dict, memb->name))
2922 continue;
2923 descr = PyDescr_NewMember(type, memb);
2924 if (descr == NULL)
2925 return -1;
2926 if (PyDict_SetItemString(dict, memb->name, descr) < 0)
2927 return -1;
2928 Py_DECREF(descr);
2929 }
2930 return 0;
2931}
2932
2933static int
Guido van Rossum32d34c82001-09-20 21:45:26 +00002934add_getset(PyTypeObject *type, PyGetSetDef *gsp)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002935{
Guido van Rossum687ae002001-10-15 22:03:32 +00002936 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002937
2938 for (; gsp->name != NULL; gsp++) {
2939 PyObject *descr;
2940 if (PyDict_GetItemString(dict, gsp->name))
2941 continue;
2942 descr = PyDescr_NewGetSet(type, gsp);
2943
2944 if (descr == NULL)
2945 return -1;
2946 if (PyDict_SetItemString(dict, gsp->name, descr) < 0)
2947 return -1;
2948 Py_DECREF(descr);
2949 }
2950 return 0;
2951}
2952
Guido van Rossum13d52f02001-08-10 21:24:08 +00002953static void
2954inherit_special(PyTypeObject *type, PyTypeObject *base)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002955{
Martin v. Löwiseb079f12006-02-16 14:32:27 +00002956 Py_ssize_t oldsize, newsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002957
Guido van Rossum13d52f02001-08-10 21:24:08 +00002958 /* Special flag magic */
2959 if (!type->tp_as_buffer && base->tp_as_buffer) {
2960 type->tp_flags &= ~Py_TPFLAGS_HAVE_GETCHARBUFFER;
2961 type->tp_flags |=
2962 base->tp_flags & Py_TPFLAGS_HAVE_GETCHARBUFFER;
2963 }
2964 if (!type->tp_as_sequence && base->tp_as_sequence) {
2965 type->tp_flags &= ~Py_TPFLAGS_HAVE_SEQUENCE_IN;
2966 type->tp_flags |= base->tp_flags & Py_TPFLAGS_HAVE_SEQUENCE_IN;
2967 }
2968 if ((type->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS) !=
2969 (base->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS)) {
2970 if ((!type->tp_as_number && base->tp_as_number) ||
2971 (!type->tp_as_sequence && base->tp_as_sequence)) {
2972 type->tp_flags &= ~Py_TPFLAGS_HAVE_INPLACEOPS;
2973 if (!type->tp_as_number && !type->tp_as_sequence) {
2974 type->tp_flags |= base->tp_flags &
2975 Py_TPFLAGS_HAVE_INPLACEOPS;
2976 }
2977 }
2978 /* Wow */
2979 }
2980 if (!type->tp_as_number && base->tp_as_number) {
2981 type->tp_flags &= ~Py_TPFLAGS_CHECKTYPES;
2982 type->tp_flags |= base->tp_flags & Py_TPFLAGS_CHECKTYPES;
2983 }
2984
2985 /* Copying basicsize is connected to the GC flags */
Neil Schemenauerc806c882001-08-29 23:54:54 +00002986 oldsize = base->tp_basicsize;
2987 newsize = type->tp_basicsize ? type->tp_basicsize : oldsize;
2988 if (!(type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
2989 (base->tp_flags & Py_TPFLAGS_HAVE_GC) &&
Guido van Rossum13d52f02001-08-10 21:24:08 +00002990 (type->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE/*GC slots exist*/) &&
2991 (!type->tp_traverse && !type->tp_clear)) {
Neil Schemenauerc806c882001-08-29 23:54:54 +00002992 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
Guido van Rossum13d52f02001-08-10 21:24:08 +00002993 if (type->tp_traverse == NULL)
2994 type->tp_traverse = base->tp_traverse;
2995 if (type->tp_clear == NULL)
2996 type->tp_clear = base->tp_clear;
2997 }
2998 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
Guido van Rossumf884b742001-12-17 17:14:22 +00002999 /* The condition below could use some explanation.
3000 It appears that tp_new is not inherited for static types
3001 whose base class is 'object'; this seems to be a precaution
3002 so that old extension types don't suddenly become
3003 callable (object.__new__ wouldn't insure the invariants
3004 that the extension type's own factory function ensures).
3005 Heap types, of course, are under our control, so they do
3006 inherit tp_new; static extension types that specify some
3007 other built-in type as the default are considered
3008 new-style-aware so they also inherit object.__new__. */
Guido van Rossum13d52f02001-08-10 21:24:08 +00003009 if (base != &PyBaseObject_Type ||
3010 (type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
3011 if (type->tp_new == NULL)
3012 type->tp_new = base->tp_new;
3013 }
3014 }
Neil Schemenauerc806c882001-08-29 23:54:54 +00003015 type->tp_basicsize = newsize;
Guido van Rossum4dd64ab2001-08-14 20:04:48 +00003016
3017 /* Copy other non-function slots */
3018
3019#undef COPYVAL
3020#define COPYVAL(SLOT) \
3021 if (type->SLOT == 0) type->SLOT = base->SLOT
3022
3023 COPYVAL(tp_itemsize);
3024 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_WEAKREFS) {
3025 COPYVAL(tp_weaklistoffset);
3026 }
3027 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
3028 COPYVAL(tp_dictoffset);
3029 }
Neal Norwitzee3a1b52007-02-25 19:44:48 +00003030
3031 /* Setup fast subclass flags */
3032 if (PyType_IsSubtype(base, (PyTypeObject*)PyExc_BaseException))
3033 type->tp_flags |= Py_TPFLAGS_BASE_EXC_SUBCLASS;
3034 else if (PyType_IsSubtype(base, &PyType_Type))
3035 type->tp_flags |= Py_TPFLAGS_TYPE_SUBCLASS;
3036 else if (PyType_IsSubtype(base, &PyInt_Type))
3037 type->tp_flags |= Py_TPFLAGS_INT_SUBCLASS;
3038 else if (PyType_IsSubtype(base, &PyLong_Type))
3039 type->tp_flags |= Py_TPFLAGS_LONG_SUBCLASS;
3040 else if (PyType_IsSubtype(base, &PyString_Type))
3041 type->tp_flags |= Py_TPFLAGS_STRING_SUBCLASS;
3042 else if (PyType_IsSubtype(base, &PyUnicode_Type))
3043 type->tp_flags |= Py_TPFLAGS_UNICODE_SUBCLASS;
3044 else if (PyType_IsSubtype(base, &PyTuple_Type))
3045 type->tp_flags |= Py_TPFLAGS_TUPLE_SUBCLASS;
3046 else if (PyType_IsSubtype(base, &PyList_Type))
3047 type->tp_flags |= Py_TPFLAGS_LIST_SUBCLASS;
3048 else if (PyType_IsSubtype(base, &PyDict_Type))
3049 type->tp_flags |= Py_TPFLAGS_DICT_SUBCLASS;
Guido van Rossum13d52f02001-08-10 21:24:08 +00003050}
3051
3052static void
3053inherit_slots(PyTypeObject *type, PyTypeObject *base)
3054{
3055 PyTypeObject *basebase;
3056
3057#undef SLOTDEFINED
Tim Peters6d6c1a32001-08-02 04:15:00 +00003058#undef COPYSLOT
3059#undef COPYNUM
3060#undef COPYSEQ
3061#undef COPYMAP
Guido van Rossum5af588b2001-10-12 14:13:21 +00003062#undef COPYBUF
Guido van Rossum13d52f02001-08-10 21:24:08 +00003063
3064#define SLOTDEFINED(SLOT) \
3065 (base->SLOT != 0 && \
3066 (basebase == NULL || base->SLOT != basebase->SLOT))
3067
Tim Peters6d6c1a32001-08-02 04:15:00 +00003068#define COPYSLOT(SLOT) \
Guido van Rossum13d52f02001-08-10 21:24:08 +00003069 if (!type->SLOT && SLOTDEFINED(SLOT)) type->SLOT = base->SLOT
Tim Peters6d6c1a32001-08-02 04:15:00 +00003070
3071#define COPYNUM(SLOT) COPYSLOT(tp_as_number->SLOT)
3072#define COPYSEQ(SLOT) COPYSLOT(tp_as_sequence->SLOT)
3073#define COPYMAP(SLOT) COPYSLOT(tp_as_mapping->SLOT)
Tim Petersfc57ccb2001-10-12 02:38:24 +00003074#define COPYBUF(SLOT) COPYSLOT(tp_as_buffer->SLOT)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003075
Guido van Rossum13d52f02001-08-10 21:24:08 +00003076 /* This won't inherit indirect slots (from tp_as_number etc.)
3077 if type doesn't provide the space. */
3078
3079 if (type->tp_as_number != NULL && base->tp_as_number != NULL) {
3080 basebase = base->tp_base;
3081 if (basebase->tp_as_number == NULL)
3082 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003083 COPYNUM(nb_add);
3084 COPYNUM(nb_subtract);
3085 COPYNUM(nb_multiply);
3086 COPYNUM(nb_divide);
3087 COPYNUM(nb_remainder);
3088 COPYNUM(nb_divmod);
3089 COPYNUM(nb_power);
3090 COPYNUM(nb_negative);
3091 COPYNUM(nb_positive);
3092 COPYNUM(nb_absolute);
3093 COPYNUM(nb_nonzero);
3094 COPYNUM(nb_invert);
3095 COPYNUM(nb_lshift);
3096 COPYNUM(nb_rshift);
3097 COPYNUM(nb_and);
3098 COPYNUM(nb_xor);
3099 COPYNUM(nb_or);
3100 COPYNUM(nb_coerce);
3101 COPYNUM(nb_int);
3102 COPYNUM(nb_long);
3103 COPYNUM(nb_float);
3104 COPYNUM(nb_oct);
3105 COPYNUM(nb_hex);
3106 COPYNUM(nb_inplace_add);
3107 COPYNUM(nb_inplace_subtract);
3108 COPYNUM(nb_inplace_multiply);
3109 COPYNUM(nb_inplace_divide);
3110 COPYNUM(nb_inplace_remainder);
3111 COPYNUM(nb_inplace_power);
3112 COPYNUM(nb_inplace_lshift);
3113 COPYNUM(nb_inplace_rshift);
3114 COPYNUM(nb_inplace_and);
3115 COPYNUM(nb_inplace_xor);
3116 COPYNUM(nb_inplace_or);
Guido van Rossumdc91b992001-08-08 22:26:22 +00003117 if (base->tp_flags & Py_TPFLAGS_CHECKTYPES) {
3118 COPYNUM(nb_true_divide);
3119 COPYNUM(nb_floor_divide);
3120 COPYNUM(nb_inplace_true_divide);
3121 COPYNUM(nb_inplace_floor_divide);
3122 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +00003123 if (base->tp_flags & Py_TPFLAGS_HAVE_INDEX) {
3124 COPYNUM(nb_index);
3125 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003126 }
3127
Guido van Rossum13d52f02001-08-10 21:24:08 +00003128 if (type->tp_as_sequence != NULL && base->tp_as_sequence != NULL) {
3129 basebase = base->tp_base;
3130 if (basebase->tp_as_sequence == NULL)
3131 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003132 COPYSEQ(sq_length);
3133 COPYSEQ(sq_concat);
3134 COPYSEQ(sq_repeat);
3135 COPYSEQ(sq_item);
3136 COPYSEQ(sq_slice);
3137 COPYSEQ(sq_ass_item);
3138 COPYSEQ(sq_ass_slice);
3139 COPYSEQ(sq_contains);
3140 COPYSEQ(sq_inplace_concat);
3141 COPYSEQ(sq_inplace_repeat);
3142 }
3143
Guido van Rossum13d52f02001-08-10 21:24:08 +00003144 if (type->tp_as_mapping != NULL && base->tp_as_mapping != NULL) {
3145 basebase = base->tp_base;
3146 if (basebase->tp_as_mapping == NULL)
3147 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003148 COPYMAP(mp_length);
3149 COPYMAP(mp_subscript);
3150 COPYMAP(mp_ass_subscript);
3151 }
3152
Tim Petersfc57ccb2001-10-12 02:38:24 +00003153 if (type->tp_as_buffer != NULL && base->tp_as_buffer != NULL) {
3154 basebase = base->tp_base;
3155 if (basebase->tp_as_buffer == NULL)
3156 basebase = NULL;
3157 COPYBUF(bf_getreadbuffer);
3158 COPYBUF(bf_getwritebuffer);
3159 COPYBUF(bf_getsegcount);
3160 COPYBUF(bf_getcharbuffer);
3161 }
3162
Guido van Rossum13d52f02001-08-10 21:24:08 +00003163 basebase = base->tp_base;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003164
Tim Peters6d6c1a32001-08-02 04:15:00 +00003165 COPYSLOT(tp_dealloc);
3166 COPYSLOT(tp_print);
3167 if (type->tp_getattr == NULL && type->tp_getattro == NULL) {
3168 type->tp_getattr = base->tp_getattr;
3169 type->tp_getattro = base->tp_getattro;
3170 }
3171 if (type->tp_setattr == NULL && type->tp_setattro == NULL) {
3172 type->tp_setattr = base->tp_setattr;
3173 type->tp_setattro = base->tp_setattro;
3174 }
3175 /* tp_compare see tp_richcompare */
3176 COPYSLOT(tp_repr);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003177 /* tp_hash see tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003178 COPYSLOT(tp_call);
3179 COPYSLOT(tp_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003180 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00003181 if (type->tp_compare == NULL &&
3182 type->tp_richcompare == NULL &&
3183 type->tp_hash == NULL)
3184 {
Tim Peters6d6c1a32001-08-02 04:15:00 +00003185 type->tp_compare = base->tp_compare;
3186 type->tp_richcompare = base->tp_richcompare;
Guido van Rossumb8f63662001-08-15 23:57:02 +00003187 type->tp_hash = base->tp_hash;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003188 }
3189 }
3190 else {
3191 COPYSLOT(tp_compare);
3192 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003193 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_ITER) {
3194 COPYSLOT(tp_iter);
3195 COPYSLOT(tp_iternext);
3196 }
3197 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
3198 COPYSLOT(tp_descr_get);
3199 COPYSLOT(tp_descr_set);
3200 COPYSLOT(tp_dictoffset);
3201 COPYSLOT(tp_init);
3202 COPYSLOT(tp_alloc);
Guido van Rossumcc8fe042002-04-05 17:10:16 +00003203 COPYSLOT(tp_is_gc);
Tim Peters3cfe7542003-05-21 21:29:48 +00003204 if ((type->tp_flags & Py_TPFLAGS_HAVE_GC) ==
3205 (base->tp_flags & Py_TPFLAGS_HAVE_GC)) {
3206 /* They agree about gc. */
3207 COPYSLOT(tp_free);
3208 }
3209 else if ((type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
3210 type->tp_free == NULL &&
3211 base->tp_free == _PyObject_Del) {
3212 /* A bit of magic to plug in the correct default
3213 * tp_free function when a derived class adds gc,
3214 * didn't define tp_free, and the base uses the
3215 * default non-gc tp_free.
3216 */
3217 type->tp_free = PyObject_GC_Del;
3218 }
3219 /* else they didn't agree about gc, and there isn't something
3220 * obvious to be done -- the type is on its own.
3221 */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003222 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003223}
3224
Jeremy Hylton938ace62002-07-17 16:30:39 +00003225static int add_operators(PyTypeObject *);
Guido van Rossum13d52f02001-08-10 21:24:08 +00003226
Tim Peters6d6c1a32001-08-02 04:15:00 +00003227int
Guido van Rossum528b7eb2001-08-07 17:24:28 +00003228PyType_Ready(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003229{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00003230 PyObject *dict, *bases;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003231 PyTypeObject *base;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003232 Py_ssize_t i, n;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003233
Guido van Rossumcab05802002-06-10 15:29:03 +00003234 if (type->tp_flags & Py_TPFLAGS_READY) {
3235 assert(type->tp_dict != NULL);
Guido van Rossumd614f972001-08-10 17:39:49 +00003236 return 0;
Guido van Rossumcab05802002-06-10 15:29:03 +00003237 }
Guido van Rossumd614f972001-08-10 17:39:49 +00003238 assert((type->tp_flags & Py_TPFLAGS_READYING) == 0);
Guido van Rossumd614f972001-08-10 17:39:49 +00003239
3240 type->tp_flags |= Py_TPFLAGS_READYING;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003241
Tim Peters36eb4df2003-03-23 03:33:13 +00003242#ifdef Py_TRACE_REFS
3243 /* PyType_Ready is the closest thing we have to a choke point
3244 * for type objects, so is the best place I can think of to try
3245 * to get type objects into the doubly-linked list of all objects.
3246 * Still, not all type objects go thru PyType_Ready.
3247 */
Tim Peters7571a0f2003-03-23 17:52:28 +00003248 _Py_AddToAllObjects((PyObject *)type, 0);
Tim Peters36eb4df2003-03-23 03:33:13 +00003249#endif
3250
Tim Peters6d6c1a32001-08-02 04:15:00 +00003251 /* Initialize tp_base (defaults to BaseObject unless that's us) */
3252 base = type->tp_base;
Martin v. Löwisbf608752004-08-18 13:16:54 +00003253 if (base == NULL && type != &PyBaseObject_Type) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00003254 base = type->tp_base = &PyBaseObject_Type;
Martin v. Löwisbf608752004-08-18 13:16:54 +00003255 Py_INCREF(base);
3256 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003257
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003258 /* Now the only way base can still be NULL is if type is
3259 * &PyBaseObject_Type.
3260 */
Guido van Rossum692cdbc2006-03-10 02:04:28 +00003261
Guido van Rossum323a9cf2002-08-14 17:26:30 +00003262 /* Initialize the base class */
3263 if (base && base->tp_dict == NULL) {
3264 if (PyType_Ready(base) < 0)
3265 goto error;
3266 }
3267
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003268 /* Initialize ob_type if NULL. This means extensions that want to be
Guido van Rossum0986d822002-04-08 01:38:42 +00003269 compilable separately on Windows can call PyType_Ready() instead of
3270 initializing the ob_type field of their type objects. */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003271 /* The test for base != NULL is really unnecessary, since base is only
3272 NULL when type is &PyBaseObject_Type, and we know its ob_type is
3273 not NULL (it's initialized to &PyType_Type). But coverity doesn't
3274 know that. */
Guido van Rossum692cdbc2006-03-10 02:04:28 +00003275 if (type->ob_type == NULL && base != NULL)
Guido van Rossum0986d822002-04-08 01:38:42 +00003276 type->ob_type = base->ob_type;
3277
Tim Peters6d6c1a32001-08-02 04:15:00 +00003278 /* Initialize tp_bases */
3279 bases = type->tp_bases;
3280 if (bases == NULL) {
3281 if (base == NULL)
3282 bases = PyTuple_New(0);
3283 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003284 bases = PyTuple_Pack(1, base);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003285 if (bases == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00003286 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003287 type->tp_bases = bases;
3288 }
3289
Guido van Rossum687ae002001-10-15 22:03:32 +00003290 /* Initialize tp_dict */
3291 dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003292 if (dict == NULL) {
3293 dict = PyDict_New();
3294 if (dict == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00003295 goto error;
Guido van Rossum687ae002001-10-15 22:03:32 +00003296 type->tp_dict = dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003297 }
3298
Guido van Rossum687ae002001-10-15 22:03:32 +00003299 /* Add type-specific descriptors to tp_dict */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003300 if (add_operators(type) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003301 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003302 if (type->tp_methods != NULL) {
3303 if (add_methods(type, type->tp_methods) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003304 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003305 }
3306 if (type->tp_members != NULL) {
3307 if (add_members(type, type->tp_members) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003308 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003309 }
3310 if (type->tp_getset != NULL) {
3311 if (add_getset(type, type->tp_getset) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003312 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003313 }
3314
Tim Peters6d6c1a32001-08-02 04:15:00 +00003315 /* Calculate method resolution order */
3316 if (mro_internal(type) < 0) {
Guido van Rossumd614f972001-08-10 17:39:49 +00003317 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003318 }
3319
Guido van Rossum13d52f02001-08-10 21:24:08 +00003320 /* Inherit special flags from dominant base */
3321 if (type->tp_base != NULL)
3322 inherit_special(type, type->tp_base);
3323
Tim Peters6d6c1a32001-08-02 04:15:00 +00003324 /* Initialize tp_dict properly */
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00003325 bases = type->tp_mro;
3326 assert(bases != NULL);
3327 assert(PyTuple_Check(bases));
3328 n = PyTuple_GET_SIZE(bases);
3329 for (i = 1; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00003330 PyObject *b = PyTuple_GET_ITEM(bases, i);
3331 if (PyType_Check(b))
3332 inherit_slots(type, (PyTypeObject *)b);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003333 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003334
Tim Peters3cfe7542003-05-21 21:29:48 +00003335 /* Sanity check for tp_free. */
3336 if (PyType_IS_GC(type) && (type->tp_flags & Py_TPFLAGS_BASETYPE) &&
3337 (type->tp_free == NULL || type->tp_free == PyObject_Del)) {
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003338 /* This base class needs to call tp_free, but doesn't have
3339 * one, or its tp_free is for non-gc'ed objects.
3340 */
Tim Peters3cfe7542003-05-21 21:29:48 +00003341 PyErr_Format(PyExc_TypeError, "type '%.100s' participates in "
3342 "gc and is a base type but has inappropriate "
3343 "tp_free slot",
3344 type->tp_name);
3345 goto error;
3346 }
3347
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003348 /* if the type dictionary doesn't contain a __doc__, set it from
3349 the tp_doc slot.
3350 */
3351 if (PyDict_GetItemString(type->tp_dict, "__doc__") == NULL) {
3352 if (type->tp_doc != NULL) {
3353 PyObject *doc = PyString_FromString(type->tp_doc);
Neal Norwitze1fdb322006-07-21 05:32:28 +00003354 if (doc == NULL)
3355 goto error;
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003356 PyDict_SetItemString(type->tp_dict, "__doc__", doc);
3357 Py_DECREF(doc);
3358 } else {
Guido van Rossumd4641072002-04-03 02:13:37 +00003359 PyDict_SetItemString(type->tp_dict,
3360 "__doc__", Py_None);
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003361 }
3362 }
3363
Guido van Rossum13d52f02001-08-10 21:24:08 +00003364 /* Some more special stuff */
3365 base = type->tp_base;
3366 if (base != NULL) {
3367 if (type->tp_as_number == NULL)
3368 type->tp_as_number = base->tp_as_number;
3369 if (type->tp_as_sequence == NULL)
3370 type->tp_as_sequence = base->tp_as_sequence;
3371 if (type->tp_as_mapping == NULL)
3372 type->tp_as_mapping = base->tp_as_mapping;
Guido van Rossumeea47182003-02-11 20:39:59 +00003373 if (type->tp_as_buffer == NULL)
3374 type->tp_as_buffer = base->tp_as_buffer;
Guido van Rossum13d52f02001-08-10 21:24:08 +00003375 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003376
Guido van Rossum1c450732001-10-08 15:18:27 +00003377 /* Link into each base class's list of subclasses */
3378 bases = type->tp_bases;
3379 n = PyTuple_GET_SIZE(bases);
3380 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00003381 PyObject *b = PyTuple_GET_ITEM(bases, i);
3382 if (PyType_Check(b) &&
3383 add_subclass((PyTypeObject *)b, type) < 0)
Guido van Rossum1c450732001-10-08 15:18:27 +00003384 goto error;
3385 }
3386
Guido van Rossum13d52f02001-08-10 21:24:08 +00003387 /* All done -- set the ready flag */
Guido van Rossumd614f972001-08-10 17:39:49 +00003388 assert(type->tp_dict != NULL);
3389 type->tp_flags =
3390 (type->tp_flags & ~Py_TPFLAGS_READYING) | Py_TPFLAGS_READY;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003391 return 0;
Guido van Rossumd614f972001-08-10 17:39:49 +00003392
3393 error:
3394 type->tp_flags &= ~Py_TPFLAGS_READYING;
3395 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003396}
3397
Guido van Rossum1c450732001-10-08 15:18:27 +00003398static int
3399add_subclass(PyTypeObject *base, PyTypeObject *type)
3400{
Martin v. Löwiseb079f12006-02-16 14:32:27 +00003401 Py_ssize_t i;
3402 int result;
Anthony Baxtera6286212006-04-11 07:42:36 +00003403 PyObject *list, *ref, *newobj;
Guido van Rossum1c450732001-10-08 15:18:27 +00003404
3405 list = base->tp_subclasses;
3406 if (list == NULL) {
3407 base->tp_subclasses = list = PyList_New(0);
3408 if (list == NULL)
3409 return -1;
3410 }
3411 assert(PyList_Check(list));
Anthony Baxtera6286212006-04-11 07:42:36 +00003412 newobj = PyWeakref_NewRef((PyObject *)type, NULL);
Guido van Rossum1c450732001-10-08 15:18:27 +00003413 i = PyList_GET_SIZE(list);
3414 while (--i >= 0) {
3415 ref = PyList_GET_ITEM(list, i);
3416 assert(PyWeakref_CheckRef(ref));
Guido van Rossum3930bc32002-10-18 13:51:49 +00003417 if (PyWeakref_GET_OBJECT(ref) == Py_None)
Anthony Baxtera6286212006-04-11 07:42:36 +00003418 return PyList_SetItem(list, i, newobj);
Guido van Rossum1c450732001-10-08 15:18:27 +00003419 }
Anthony Baxtera6286212006-04-11 07:42:36 +00003420 result = PyList_Append(list, newobj);
3421 Py_DECREF(newobj);
Martin v. Löwiseb079f12006-02-16 14:32:27 +00003422 return result;
Guido van Rossum1c450732001-10-08 15:18:27 +00003423}
3424
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003425static void
3426remove_subclass(PyTypeObject *base, PyTypeObject *type)
3427{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003428 Py_ssize_t i;
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003429 PyObject *list, *ref;
3430
3431 list = base->tp_subclasses;
3432 if (list == NULL) {
3433 return;
3434 }
3435 assert(PyList_Check(list));
3436 i = PyList_GET_SIZE(list);
3437 while (--i >= 0) {
3438 ref = PyList_GET_ITEM(list, i);
3439 assert(PyWeakref_CheckRef(ref));
3440 if (PyWeakref_GET_OBJECT(ref) == (PyObject*)type) {
3441 /* this can't fail, right? */
3442 PySequence_DelItem(list, i);
3443 return;
3444 }
3445 }
3446}
Tim Peters6d6c1a32001-08-02 04:15:00 +00003447
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003448static int
3449check_num_args(PyObject *ob, int n)
3450{
3451 if (!PyTuple_CheckExact(ob)) {
3452 PyErr_SetString(PyExc_SystemError,
3453 "PyArg_UnpackTuple() argument list is not a tuple");
3454 return 0;
3455 }
3456 if (n == PyTuple_GET_SIZE(ob))
3457 return 1;
3458 PyErr_Format(
3459 PyExc_TypeError,
Martin v. Löwis2c95cc62006-02-16 06:54:25 +00003460 "expected %d arguments, got %zd", n, PyTuple_GET_SIZE(ob));
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003461 return 0;
3462}
3463
Tim Peters6d6c1a32001-08-02 04:15:00 +00003464/* Generic wrappers for overloadable 'operators' such as __getitem__ */
3465
3466/* There's a wrapper *function* for each distinct function typedef used
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003467 for type object slots (e.g. binaryfunc, ternaryfunc, etc.). There's a
Tim Peters6d6c1a32001-08-02 04:15:00 +00003468 wrapper *table* for each distinct operation (e.g. __len__, __add__).
3469 Most tables have only one entry; the tables for binary operators have two
3470 entries, one regular and one with reversed arguments. */
3471
3472static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00003473wrap_lenfunc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003474{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003475 lenfunc func = (lenfunc)wrapped;
3476 Py_ssize_t res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003477
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003478 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003479 return NULL;
3480 res = (*func)(self);
3481 if (res == -1 && PyErr_Occurred())
3482 return NULL;
3483 return PyInt_FromLong((long)res);
3484}
3485
Tim Peters6d6c1a32001-08-02 04:15:00 +00003486static PyObject *
Raymond Hettingerf34f2642003-10-11 17:29:04 +00003487wrap_inquirypred(PyObject *self, PyObject *args, void *wrapped)
3488{
3489 inquiry func = (inquiry)wrapped;
3490 int res;
3491
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003492 if (!check_num_args(args, 0))
Raymond Hettingerf34f2642003-10-11 17:29:04 +00003493 return NULL;
3494 res = (*func)(self);
3495 if (res == -1 && PyErr_Occurred())
3496 return NULL;
3497 return PyBool_FromLong((long)res);
3498}
3499
3500static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00003501wrap_binaryfunc(PyObject *self, PyObject *args, void *wrapped)
3502{
3503 binaryfunc func = (binaryfunc)wrapped;
3504 PyObject *other;
3505
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003506 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003507 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003508 other = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003509 return (*func)(self, other);
3510}
3511
3512static PyObject *
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003513wrap_binaryfunc_l(PyObject *self, PyObject *args, void *wrapped)
3514{
3515 binaryfunc func = (binaryfunc)wrapped;
3516 PyObject *other;
3517
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003518 if (!check_num_args(args, 1))
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003519 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003520 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003521 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003522 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003523 Py_INCREF(Py_NotImplemented);
3524 return Py_NotImplemented;
3525 }
3526 return (*func)(self, other);
3527}
3528
3529static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00003530wrap_binaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
3531{
3532 binaryfunc func = (binaryfunc)wrapped;
3533 PyObject *other;
3534
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003535 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003536 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003537 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003538 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003539 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003540 Py_INCREF(Py_NotImplemented);
3541 return Py_NotImplemented;
3542 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003543 return (*func)(other, self);
3544}
3545
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003546static PyObject *
3547wrap_coercefunc(PyObject *self, PyObject *args, void *wrapped)
3548{
3549 coercion func = (coercion)wrapped;
3550 PyObject *other, *res;
3551 int ok;
3552
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003553 if (!check_num_args(args, 1))
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003554 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003555 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003556 ok = func(&self, &other);
3557 if (ok < 0)
3558 return NULL;
3559 if (ok > 0) {
3560 Py_INCREF(Py_NotImplemented);
3561 return Py_NotImplemented;
3562 }
3563 res = PyTuple_New(2);
3564 if (res == NULL) {
3565 Py_DECREF(self);
3566 Py_DECREF(other);
3567 return NULL;
3568 }
3569 PyTuple_SET_ITEM(res, 0, self);
3570 PyTuple_SET_ITEM(res, 1, other);
3571 return res;
3572}
3573
Tim Peters6d6c1a32001-08-02 04:15:00 +00003574static PyObject *
3575wrap_ternaryfunc(PyObject *self, PyObject *args, void *wrapped)
3576{
3577 ternaryfunc func = (ternaryfunc)wrapped;
3578 PyObject *other;
3579 PyObject *third = Py_None;
3580
3581 /* Note: This wrapper only works for __pow__() */
3582
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003583 if (!PyArg_UnpackTuple(args, "", 1, 2, &other, &third))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003584 return NULL;
3585 return (*func)(self, other, third);
3586}
3587
Guido van Rossum9bea3ab2001-09-28 22:58:52 +00003588static PyObject *
3589wrap_ternaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
3590{
3591 ternaryfunc func = (ternaryfunc)wrapped;
3592 PyObject *other;
3593 PyObject *third = Py_None;
3594
3595 /* Note: This wrapper only works for __pow__() */
3596
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003597 if (!PyArg_UnpackTuple(args, "", 1, 2, &other, &third))
Guido van Rossum9bea3ab2001-09-28 22:58:52 +00003598 return NULL;
3599 return (*func)(other, self, third);
3600}
3601
Tim Peters6d6c1a32001-08-02 04:15:00 +00003602static PyObject *
3603wrap_unaryfunc(PyObject *self, PyObject *args, void *wrapped)
3604{
3605 unaryfunc func = (unaryfunc)wrapped;
3606
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003607 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003608 return NULL;
3609 return (*func)(self);
3610}
3611
Tim Peters6d6c1a32001-08-02 04:15:00 +00003612static PyObject *
Armin Rigo314861c2006-03-30 14:04:02 +00003613wrap_indexargfunc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003614{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003615 ssizeargfunc func = (ssizeargfunc)wrapped;
Armin Rigo314861c2006-03-30 14:04:02 +00003616 PyObject* o;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003617 Py_ssize_t i;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003618
Armin Rigo314861c2006-03-30 14:04:02 +00003619 if (!PyArg_UnpackTuple(args, "", 1, 1, &o))
3620 return NULL;
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00003621 i = PyNumber_AsSsize_t(o, PyExc_OverflowError);
Armin Rigo314861c2006-03-30 14:04:02 +00003622 if (i == -1 && PyErr_Occurred())
Tim Peters6d6c1a32001-08-02 04:15:00 +00003623 return NULL;
3624 return (*func)(self, i);
3625}
3626
Martin v. Löwis18e16552006-02-15 17:27:45 +00003627static Py_ssize_t
Guido van Rossum5d815f32001-08-17 21:57:47 +00003628getindex(PyObject *self, PyObject *arg)
3629{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003630 Py_ssize_t i;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003631
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00003632 i = PyNumber_AsSsize_t(arg, PyExc_OverflowError);
Guido van Rossum5d815f32001-08-17 21:57:47 +00003633 if (i == -1 && PyErr_Occurred())
3634 return -1;
3635 if (i < 0) {
3636 PySequenceMethods *sq = self->ob_type->tp_as_sequence;
3637 if (sq && sq->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00003638 Py_ssize_t n = (*sq->sq_length)(self);
Guido van Rossum5d815f32001-08-17 21:57:47 +00003639 if (n < 0)
3640 return -1;
3641 i += n;
3642 }
3643 }
3644 return i;
3645}
3646
3647static PyObject *
3648wrap_sq_item(PyObject *self, PyObject *args, void *wrapped)
3649{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003650 ssizeargfunc func = (ssizeargfunc)wrapped;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003651 PyObject *arg;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003652 Py_ssize_t i;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003653
Guido van Rossumf4593e02001-10-03 12:09:30 +00003654 if (PyTuple_GET_SIZE(args) == 1) {
3655 arg = PyTuple_GET_ITEM(args, 0);
3656 i = getindex(self, arg);
3657 if (i == -1 && PyErr_Occurred())
3658 return NULL;
3659 return (*func)(self, i);
3660 }
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003661 check_num_args(args, 1);
Guido van Rossumf4593e02001-10-03 12:09:30 +00003662 assert(PyErr_Occurred());
3663 return NULL;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003664}
3665
Tim Peters6d6c1a32001-08-02 04:15:00 +00003666static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00003667wrap_ssizessizeargfunc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003668{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003669 ssizessizeargfunc func = (ssizessizeargfunc)wrapped;
3670 Py_ssize_t i, j;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003671
Martin v. Löwis18e16552006-02-15 17:27:45 +00003672 if (!PyArg_ParseTuple(args, "nn", &i, &j))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003673 return NULL;
3674 return (*func)(self, i, j);
3675}
3676
Tim Peters6d6c1a32001-08-02 04:15:00 +00003677static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00003678wrap_sq_setitem(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003679{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003680 ssizeobjargproc func = (ssizeobjargproc)wrapped;
3681 Py_ssize_t i;
3682 int res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003683 PyObject *arg, *value;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003684
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003685 if (!PyArg_UnpackTuple(args, "", 2, 2, &arg, &value))
Guido van Rossum5d815f32001-08-17 21:57:47 +00003686 return NULL;
3687 i = getindex(self, arg);
3688 if (i == -1 && PyErr_Occurred())
Tim Peters6d6c1a32001-08-02 04:15:00 +00003689 return NULL;
3690 res = (*func)(self, i, value);
3691 if (res == -1 && PyErr_Occurred())
3692 return NULL;
3693 Py_INCREF(Py_None);
3694 return Py_None;
3695}
3696
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003697static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00003698wrap_sq_delitem(PyObject *self, PyObject *args, void *wrapped)
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003699{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003700 ssizeobjargproc func = (ssizeobjargproc)wrapped;
3701 Py_ssize_t i;
3702 int res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003703 PyObject *arg;
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003704
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003705 if (!check_num_args(args, 1))
Guido van Rossum5d815f32001-08-17 21:57:47 +00003706 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003707 arg = PyTuple_GET_ITEM(args, 0);
Guido van Rossum5d815f32001-08-17 21:57:47 +00003708 i = getindex(self, arg);
3709 if (i == -1 && PyErr_Occurred())
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003710 return NULL;
3711 res = (*func)(self, i, NULL);
3712 if (res == -1 && PyErr_Occurred())
3713 return NULL;
3714 Py_INCREF(Py_None);
3715 return Py_None;
3716}
3717
Tim Peters6d6c1a32001-08-02 04:15:00 +00003718static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00003719wrap_ssizessizeobjargproc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003720{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003721 ssizessizeobjargproc func = (ssizessizeobjargproc)wrapped;
3722 Py_ssize_t i, j;
3723 int res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003724 PyObject *value;
3725
Martin v. Löwis18e16552006-02-15 17:27:45 +00003726 if (!PyArg_ParseTuple(args, "nnO", &i, &j, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003727 return NULL;
3728 res = (*func)(self, i, j, value);
3729 if (res == -1 && PyErr_Occurred())
3730 return NULL;
3731 Py_INCREF(Py_None);
3732 return Py_None;
3733}
3734
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003735static PyObject *
3736wrap_delslice(PyObject *self, PyObject *args, void *wrapped)
3737{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003738 ssizessizeobjargproc func = (ssizessizeobjargproc)wrapped;
3739 Py_ssize_t i, j;
3740 int res;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003741
Martin v. Löwis18e16552006-02-15 17:27:45 +00003742 if (!PyArg_ParseTuple(args, "nn", &i, &j))
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003743 return NULL;
3744 res = (*func)(self, i, j, NULL);
3745 if (res == -1 && PyErr_Occurred())
3746 return NULL;
3747 Py_INCREF(Py_None);
3748 return Py_None;
3749}
3750
Tim Peters6d6c1a32001-08-02 04:15:00 +00003751/* XXX objobjproc is a misnomer; should be objargpred */
3752static PyObject *
3753wrap_objobjproc(PyObject *self, PyObject *args, void *wrapped)
3754{
3755 objobjproc func = (objobjproc)wrapped;
3756 int res;
Guido van Rossum22c3dda2003-10-09 03:46:35 +00003757 PyObject *value;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003758
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003759 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003760 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003761 value = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003762 res = (*func)(self, value);
3763 if (res == -1 && PyErr_Occurred())
3764 return NULL;
Guido van Rossum22c3dda2003-10-09 03:46:35 +00003765 else
3766 return PyBool_FromLong(res);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003767}
3768
Tim Peters6d6c1a32001-08-02 04:15:00 +00003769static PyObject *
3770wrap_objobjargproc(PyObject *self, PyObject *args, void *wrapped)
3771{
3772 objobjargproc func = (objobjargproc)wrapped;
3773 int res;
3774 PyObject *key, *value;
3775
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003776 if (!PyArg_UnpackTuple(args, "", 2, 2, &key, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003777 return NULL;
3778 res = (*func)(self, key, value);
3779 if (res == -1 && PyErr_Occurred())
3780 return NULL;
3781 Py_INCREF(Py_None);
3782 return Py_None;
3783}
3784
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003785static PyObject *
3786wrap_delitem(PyObject *self, PyObject *args, void *wrapped)
3787{
3788 objobjargproc func = (objobjargproc)wrapped;
3789 int res;
3790 PyObject *key;
3791
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003792 if (!check_num_args(args, 1))
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003793 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003794 key = PyTuple_GET_ITEM(args, 0);
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003795 res = (*func)(self, key, NULL);
3796 if (res == -1 && PyErr_Occurred())
3797 return NULL;
3798 Py_INCREF(Py_None);
3799 return Py_None;
3800}
3801
Tim Peters6d6c1a32001-08-02 04:15:00 +00003802static PyObject *
3803wrap_cmpfunc(PyObject *self, PyObject *args, void *wrapped)
3804{
3805 cmpfunc func = (cmpfunc)wrapped;
3806 int res;
3807 PyObject *other;
3808
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003809 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003810 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003811 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum3d45d8f2001-09-24 18:47:40 +00003812 if (other->ob_type->tp_compare != func &&
3813 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossumceccae52001-09-18 20:03:57 +00003814 PyErr_Format(
3815 PyExc_TypeError,
3816 "%s.__cmp__(x,y) requires y to be a '%s', not a '%s'",
3817 self->ob_type->tp_name,
3818 self->ob_type->tp_name,
3819 other->ob_type->tp_name);
3820 return NULL;
3821 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003822 res = (*func)(self, other);
3823 if (PyErr_Occurred())
3824 return NULL;
3825 return PyInt_FromLong((long)res);
3826}
3827
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003828/* Helper to check for object.__setattr__ or __delattr__ applied to a type.
Guido van Rossum52b27052003-04-15 20:05:10 +00003829 This is called the Carlo Verre hack after its discoverer. */
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003830static int
3831hackcheck(PyObject *self, setattrofunc func, char *what)
3832{
3833 PyTypeObject *type = self->ob_type;
3834 while (type && type->tp_flags & Py_TPFLAGS_HEAPTYPE)
3835 type = type->tp_base;
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003836 /* If type is NULL now, this is a really weird type.
3837 In the spirit of backwards compatibility (?), just shut up. */
Guido van Rossum692cdbc2006-03-10 02:04:28 +00003838 if (type && type->tp_setattro != func) {
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003839 PyErr_Format(PyExc_TypeError,
3840 "can't apply this %s to %s object",
3841 what,
3842 type->tp_name);
3843 return 0;
3844 }
3845 return 1;
3846}
3847
Tim Peters6d6c1a32001-08-02 04:15:00 +00003848static PyObject *
3849wrap_setattr(PyObject *self, PyObject *args, void *wrapped)
3850{
3851 setattrofunc func = (setattrofunc)wrapped;
3852 int res;
3853 PyObject *name, *value;
3854
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003855 if (!PyArg_UnpackTuple(args, "", 2, 2, &name, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003856 return NULL;
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003857 if (!hackcheck(self, func, "__setattr__"))
3858 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003859 res = (*func)(self, name, value);
3860 if (res < 0)
3861 return NULL;
3862 Py_INCREF(Py_None);
3863 return Py_None;
3864}
3865
3866static PyObject *
3867wrap_delattr(PyObject *self, PyObject *args, void *wrapped)
3868{
3869 setattrofunc func = (setattrofunc)wrapped;
3870 int res;
3871 PyObject *name;
3872
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003873 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003874 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003875 name = PyTuple_GET_ITEM(args, 0);
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003876 if (!hackcheck(self, func, "__delattr__"))
3877 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003878 res = (*func)(self, name, NULL);
3879 if (res < 0)
3880 return NULL;
3881 Py_INCREF(Py_None);
3882 return Py_None;
3883}
3884
Tim Peters6d6c1a32001-08-02 04:15:00 +00003885static PyObject *
3886wrap_hashfunc(PyObject *self, PyObject *args, void *wrapped)
3887{
3888 hashfunc func = (hashfunc)wrapped;
3889 long res;
3890
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003891 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003892 return NULL;
3893 res = (*func)(self);
3894 if (res == -1 && PyErr_Occurred())
3895 return NULL;
3896 return PyInt_FromLong(res);
3897}
3898
Tim Peters6d6c1a32001-08-02 04:15:00 +00003899static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00003900wrap_call(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003901{
3902 ternaryfunc func = (ternaryfunc)wrapped;
3903
Guido van Rossumc8e56452001-10-22 00:43:43 +00003904 return (*func)(self, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003905}
3906
Tim Peters6d6c1a32001-08-02 04:15:00 +00003907static PyObject *
3908wrap_richcmpfunc(PyObject *self, PyObject *args, void *wrapped, int op)
3909{
3910 richcmpfunc func = (richcmpfunc)wrapped;
3911 PyObject *other;
3912
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003913 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003914 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003915 other = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003916 return (*func)(self, other, op);
3917}
3918
3919#undef RICHCMP_WRAPPER
3920#define RICHCMP_WRAPPER(NAME, OP) \
3921static PyObject * \
3922richcmp_##NAME(PyObject *self, PyObject *args, void *wrapped) \
3923{ \
3924 return wrap_richcmpfunc(self, args, wrapped, OP); \
3925}
3926
Jack Jansen8e938b42001-08-08 15:29:49 +00003927RICHCMP_WRAPPER(lt, Py_LT)
3928RICHCMP_WRAPPER(le, Py_LE)
3929RICHCMP_WRAPPER(eq, Py_EQ)
3930RICHCMP_WRAPPER(ne, Py_NE)
3931RICHCMP_WRAPPER(gt, Py_GT)
3932RICHCMP_WRAPPER(ge, Py_GE)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003933
Tim Peters6d6c1a32001-08-02 04:15:00 +00003934static PyObject *
3935wrap_next(PyObject *self, PyObject *args, void *wrapped)
3936{
3937 unaryfunc func = (unaryfunc)wrapped;
3938 PyObject *res;
3939
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003940 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003941 return NULL;
3942 res = (*func)(self);
3943 if (res == NULL && !PyErr_Occurred())
3944 PyErr_SetNone(PyExc_StopIteration);
3945 return res;
3946}
3947
Tim Peters6d6c1a32001-08-02 04:15:00 +00003948static PyObject *
3949wrap_descr_get(PyObject *self, PyObject *args, void *wrapped)
3950{
3951 descrgetfunc func = (descrgetfunc)wrapped;
3952 PyObject *obj;
3953 PyObject *type = NULL;
3954
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003955 if (!PyArg_UnpackTuple(args, "", 1, 2, &obj, &type))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003956 return NULL;
Guido van Rossum82ed25c2003-02-11 16:25:43 +00003957 if (obj == Py_None)
3958 obj = NULL;
3959 if (type == Py_None)
3960 type = NULL;
3961 if (type == NULL &&obj == NULL) {
3962 PyErr_SetString(PyExc_TypeError,
3963 "__get__(None, None) is invalid");
3964 return NULL;
3965 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003966 return (*func)(self, obj, type);
3967}
3968
Tim Peters6d6c1a32001-08-02 04:15:00 +00003969static PyObject *
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003970wrap_descr_set(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003971{
3972 descrsetfunc func = (descrsetfunc)wrapped;
3973 PyObject *obj, *value;
3974 int ret;
3975
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003976 if (!PyArg_UnpackTuple(args, "", 2, 2, &obj, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003977 return NULL;
3978 ret = (*func)(self, obj, value);
3979 if (ret < 0)
3980 return NULL;
3981 Py_INCREF(Py_None);
3982 return Py_None;
3983}
Guido van Rossum22b13872002-08-06 21:41:44 +00003984
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00003985static PyObject *
3986wrap_descr_delete(PyObject *self, PyObject *args, void *wrapped)
3987{
3988 descrsetfunc func = (descrsetfunc)wrapped;
3989 PyObject *obj;
3990 int ret;
3991
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003992 if (!check_num_args(args, 1))
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00003993 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003994 obj = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00003995 ret = (*func)(self, obj, NULL);
3996 if (ret < 0)
3997 return NULL;
3998 Py_INCREF(Py_None);
3999 return Py_None;
4000}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004001
Tim Peters6d6c1a32001-08-02 04:15:00 +00004002static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00004003wrap_init(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004004{
4005 initproc func = (initproc)wrapped;
4006
Guido van Rossumc8e56452001-10-22 00:43:43 +00004007 if (func(self, args, kwds) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004008 return NULL;
4009 Py_INCREF(Py_None);
4010 return Py_None;
4011}
4012
Tim Peters6d6c1a32001-08-02 04:15:00 +00004013static PyObject *
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004014tp_new_wrapper(PyObject *self, PyObject *args, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004015{
Barry Warsaw60f01882001-08-22 19:24:42 +00004016 PyTypeObject *type, *subtype, *staticbase;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004017 PyObject *arg0, *res;
4018
4019 if (self == NULL || !PyType_Check(self))
4020 Py_FatalError("__new__() called with non-type 'self'");
4021 type = (PyTypeObject *)self;
4022 if (!PyTuple_Check(args) || PyTuple_GET_SIZE(args) < 1) {
Barry Warsaw60f01882001-08-22 19:24:42 +00004023 PyErr_Format(PyExc_TypeError,
4024 "%s.__new__(): not enough arguments",
4025 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004026 return NULL;
4027 }
4028 arg0 = PyTuple_GET_ITEM(args, 0);
4029 if (!PyType_Check(arg0)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00004030 PyErr_Format(PyExc_TypeError,
4031 "%s.__new__(X): X is not a type object (%s)",
4032 type->tp_name,
4033 arg0->ob_type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004034 return NULL;
4035 }
4036 subtype = (PyTypeObject *)arg0;
4037 if (!PyType_IsSubtype(subtype, type)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00004038 PyErr_Format(PyExc_TypeError,
4039 "%s.__new__(%s): %s is not a subtype of %s",
4040 type->tp_name,
4041 subtype->tp_name,
4042 subtype->tp_name,
4043 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004044 return NULL;
4045 }
Barry Warsaw60f01882001-08-22 19:24:42 +00004046
4047 /* Check that the use doesn't do something silly and unsafe like
Tim Petersa427a2b2001-10-29 22:25:45 +00004048 object.__new__(dict). To do this, we check that the
Barry Warsaw60f01882001-08-22 19:24:42 +00004049 most derived base that's not a heap type is this type. */
4050 staticbase = subtype;
4051 while (staticbase && (staticbase->tp_flags & Py_TPFLAGS_HEAPTYPE))
4052 staticbase = staticbase->tp_base;
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00004053 /* If staticbase is NULL now, it is a really weird type.
4054 In the spirit of backwards compatibility (?), just shut up. */
Guido van Rossum692cdbc2006-03-10 02:04:28 +00004055 if (staticbase && staticbase->tp_new != type->tp_new) {
Barry Warsaw60f01882001-08-22 19:24:42 +00004056 PyErr_Format(PyExc_TypeError,
4057 "%s.__new__(%s) is not safe, use %s.__new__()",
4058 type->tp_name,
4059 subtype->tp_name,
4060 staticbase == NULL ? "?" : staticbase->tp_name);
4061 return NULL;
4062 }
4063
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004064 args = PyTuple_GetSlice(args, 1, PyTuple_GET_SIZE(args));
4065 if (args == NULL)
4066 return NULL;
4067 res = type->tp_new(subtype, args, kwds);
4068 Py_DECREF(args);
4069 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004070}
4071
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004072static struct PyMethodDef tp_new_methoddef[] = {
4073 {"__new__", (PyCFunction)tp_new_wrapper, METH_KEYWORDS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00004074 PyDoc_STR("T.__new__(S, ...) -> "
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00004075 "a new object with type S, a subtype of T")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00004076 {0}
4077};
4078
4079static int
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004080add_tp_new_wrapper(PyTypeObject *type)
4081{
Guido van Rossumf040ede2001-08-07 16:40:56 +00004082 PyObject *func;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004083
Guido van Rossum687ae002001-10-15 22:03:32 +00004084 if (PyDict_GetItemString(type->tp_dict, "__new__") != NULL)
Guido van Rossumf040ede2001-08-07 16:40:56 +00004085 return 0;
4086 func = PyCFunction_New(tp_new_methoddef, (PyObject *)type);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004087 if (func == NULL)
4088 return -1;
Raymond Hettinger8d726ee2004-06-25 22:24:35 +00004089 if (PyDict_SetItemString(type->tp_dict, "__new__", func)) {
Raymond Hettingerd56cbe52004-06-25 22:17:39 +00004090 Py_DECREF(func);
4091 return -1;
4092 }
4093 Py_DECREF(func);
4094 return 0;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004095}
4096
Guido van Rossumf040ede2001-08-07 16:40:56 +00004097/* Slot wrappers that call the corresponding __foo__ slot. See comments
4098 below at override_slots() for more explanation. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004099
Guido van Rossumdc91b992001-08-08 22:26:22 +00004100#define SLOT0(FUNCNAME, OPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004101static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004102FUNCNAME(PyObject *self) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004103{ \
Guido van Rossum5592e4d2001-08-28 18:28:21 +00004104 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00004105 return call_method(self, OPSTR, &cache_str, "()"); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004106}
4107
Guido van Rossumdc91b992001-08-08 22:26:22 +00004108#define SLOT1(FUNCNAME, OPSTR, ARG1TYPE, ARGCODES) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004109static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004110FUNCNAME(PyObject *self, ARG1TYPE arg1) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004111{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004112 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00004113 return call_method(self, OPSTR, &cache_str, "(" ARGCODES ")", arg1); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004114}
4115
Guido van Rossumcd118802003-01-06 22:57:47 +00004116/* Boolean helper for SLOT1BINFULL().
4117 right.__class__ is a nontrivial subclass of left.__class__. */
4118static int
4119method_is_overloaded(PyObject *left, PyObject *right, char *name)
4120{
4121 PyObject *a, *b;
4122 int ok;
4123
4124 b = PyObject_GetAttrString((PyObject *)(right->ob_type), name);
4125 if (b == NULL) {
4126 PyErr_Clear();
4127 /* If right doesn't have it, it's not overloaded */
4128 return 0;
4129 }
4130
4131 a = PyObject_GetAttrString((PyObject *)(left->ob_type), name);
4132 if (a == NULL) {
4133 PyErr_Clear();
4134 Py_DECREF(b);
4135 /* If right has it but left doesn't, it's overloaded */
4136 return 1;
4137 }
4138
4139 ok = PyObject_RichCompareBool(a, b, Py_NE);
4140 Py_DECREF(a);
4141 Py_DECREF(b);
4142 if (ok < 0) {
4143 PyErr_Clear();
4144 return 0;
4145 }
4146
4147 return ok;
4148}
4149
Guido van Rossumdc91b992001-08-08 22:26:22 +00004150
4151#define SLOT1BINFULL(FUNCNAME, TESTFUNC, SLOTNAME, OPSTR, ROPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004152static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004153FUNCNAME(PyObject *self, PyObject *other) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004154{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004155 static PyObject *cache_str, *rcache_str; \
Guido van Rossum55f20992001-10-01 17:18:22 +00004156 int do_other = self->ob_type != other->ob_type && \
4157 other->ob_type->tp_as_number != NULL && \
4158 other->ob_type->tp_as_number->SLOTNAME == TESTFUNC; \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004159 if (self->ob_type->tp_as_number != NULL && \
4160 self->ob_type->tp_as_number->SLOTNAME == TESTFUNC) { \
4161 PyObject *r; \
Guido van Rossum55f20992001-10-01 17:18:22 +00004162 if (do_other && \
Guido van Rossumcd118802003-01-06 22:57:47 +00004163 PyType_IsSubtype(other->ob_type, self->ob_type) && \
4164 method_is_overloaded(self, other, ROPSTR)) { \
Guido van Rossum55f20992001-10-01 17:18:22 +00004165 r = call_maybe( \
4166 other, ROPSTR, &rcache_str, "(O)", self); \
4167 if (r != Py_NotImplemented) \
4168 return r; \
4169 Py_DECREF(r); \
4170 do_other = 0; \
4171 } \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00004172 r = call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00004173 self, OPSTR, &cache_str, "(O)", other); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004174 if (r != Py_NotImplemented || \
4175 other->ob_type == self->ob_type) \
4176 return r; \
4177 Py_DECREF(r); \
4178 } \
Guido van Rossum55f20992001-10-01 17:18:22 +00004179 if (do_other) { \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00004180 return call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00004181 other, ROPSTR, &rcache_str, "(O)", self); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004182 } \
4183 Py_INCREF(Py_NotImplemented); \
4184 return Py_NotImplemented; \
4185}
4186
4187#define SLOT1BIN(FUNCNAME, SLOTNAME, OPSTR, ROPSTR) \
4188 SLOT1BINFULL(FUNCNAME, FUNCNAME, SLOTNAME, OPSTR, ROPSTR)
4189
4190#define SLOT2(FUNCNAME, OPSTR, ARG1TYPE, ARG2TYPE, ARGCODES) \
4191static PyObject * \
4192FUNCNAME(PyObject *self, ARG1TYPE arg1, ARG2TYPE arg2) \
4193{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004194 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00004195 return call_method(self, OPSTR, &cache_str, \
4196 "(" ARGCODES ")", arg1, arg2); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004197}
4198
Martin v. Löwis18e16552006-02-15 17:27:45 +00004199static Py_ssize_t
Tim Peters6d6c1a32001-08-02 04:15:00 +00004200slot_sq_length(PyObject *self)
4201{
Guido van Rossum2730b132001-08-28 18:22:14 +00004202 static PyObject *len_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00004203 PyObject *res = call_method(self, "__len__", &len_str, "()");
Martin v. Löwis18e16552006-02-15 17:27:45 +00004204 Py_ssize_t len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004205
4206 if (res == NULL)
4207 return -1;
Neal Norwitz1872b1c2006-08-12 18:44:06 +00004208 len = PyInt_AsSsize_t(res);
Guido van Rossum26111622001-10-01 16:42:49 +00004209 Py_DECREF(res);
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00004210 if (len < 0) {
Armin Rigo7ccbca92006-10-04 12:17:45 +00004211 if (!PyErr_Occurred())
4212 PyErr_SetString(PyExc_ValueError,
4213 "__len__() should return >= 0");
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00004214 return -1;
4215 }
Guido van Rossum26111622001-10-01 16:42:49 +00004216 return len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004217}
4218
Guido van Rossumf4593e02001-10-03 12:09:30 +00004219/* Super-optimized version of slot_sq_item.
4220 Other slots could do the same... */
4221static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00004222slot_sq_item(PyObject *self, Py_ssize_t i)
Guido van Rossumf4593e02001-10-03 12:09:30 +00004223{
4224 static PyObject *getitem_str;
4225 PyObject *func, *args = NULL, *ival = NULL, *retval = NULL;
4226 descrgetfunc f;
4227
4228 if (getitem_str == NULL) {
4229 getitem_str = PyString_InternFromString("__getitem__");
4230 if (getitem_str == NULL)
4231 return NULL;
4232 }
4233 func = _PyType_Lookup(self->ob_type, getitem_str);
4234 if (func != NULL) {
Guido van Rossumf4593e02001-10-03 12:09:30 +00004235 if ((f = func->ob_type->tp_descr_get) == NULL)
4236 Py_INCREF(func);
Neal Norwitz673cd822002-10-18 16:33:13 +00004237 else {
Guido van Rossumf4593e02001-10-03 12:09:30 +00004238 func = f(func, self, (PyObject *)(self->ob_type));
Neal Norwitz673cd822002-10-18 16:33:13 +00004239 if (func == NULL) {
4240 return NULL;
4241 }
4242 }
Martin v. Löwiseb079f12006-02-16 14:32:27 +00004243 ival = PyInt_FromSsize_t(i);
Guido van Rossumf4593e02001-10-03 12:09:30 +00004244 if (ival != NULL) {
4245 args = PyTuple_New(1);
4246 if (args != NULL) {
4247 PyTuple_SET_ITEM(args, 0, ival);
4248 retval = PyObject_Call(func, args, NULL);
4249 Py_XDECREF(args);
4250 Py_XDECREF(func);
4251 return retval;
4252 }
4253 }
4254 }
4255 else {
4256 PyErr_SetObject(PyExc_AttributeError, getitem_str);
4257 }
4258 Py_XDECREF(args);
4259 Py_XDECREF(ival);
4260 Py_XDECREF(func);
4261 return NULL;
4262}
4263
Martin v. Löwis18e16552006-02-15 17:27:45 +00004264SLOT2(slot_sq_slice, "__getslice__", Py_ssize_t, Py_ssize_t, "nn")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004265
4266static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00004267slot_sq_ass_item(PyObject *self, Py_ssize_t index, PyObject *value)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004268{
4269 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004270 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004271
4272 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004273 res = call_method(self, "__delitem__", &delitem_str,
Thomas Wouters4e908102006-04-21 11:26:56 +00004274 "(n)", index);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004275 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004276 res = call_method(self, "__setitem__", &setitem_str,
Thomas Wouters4e908102006-04-21 11:26:56 +00004277 "(nO)", index, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004278 if (res == NULL)
4279 return -1;
4280 Py_DECREF(res);
4281 return 0;
4282}
4283
4284static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00004285slot_sq_ass_slice(PyObject *self, Py_ssize_t i, Py_ssize_t j, PyObject *value)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004286{
4287 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004288 static PyObject *delslice_str, *setslice_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004289
4290 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004291 res = call_method(self, "__delslice__", &delslice_str,
Thomas Wouters4e908102006-04-21 11:26:56 +00004292 "(nn)", i, j);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004293 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004294 res = call_method(self, "__setslice__", &setslice_str,
Thomas Wouters4e908102006-04-21 11:26:56 +00004295 "(nnO)", i, j, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004296 if (res == NULL)
4297 return -1;
4298 Py_DECREF(res);
4299 return 0;
4300}
4301
4302static int
4303slot_sq_contains(PyObject *self, PyObject *value)
4304{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004305 PyObject *func, *res, *args;
Tim Petersbf9b2442003-03-23 05:35:36 +00004306 int result = -1;
4307
Guido van Rossum60718732001-08-28 17:47:51 +00004308 static PyObject *contains_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004309
Guido van Rossum55f20992001-10-01 17:18:22 +00004310 func = lookup_maybe(self, "__contains__", &contains_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004311 if (func != NULL) {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004312 args = PyTuple_Pack(1, value);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004313 if (args == NULL)
4314 res = NULL;
4315 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004316 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004317 Py_DECREF(args);
4318 }
4319 Py_DECREF(func);
Tim Petersbf9b2442003-03-23 05:35:36 +00004320 if (res != NULL) {
4321 result = PyObject_IsTrue(res);
4322 Py_DECREF(res);
4323 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00004324 }
Tim Petersbf9b2442003-03-23 05:35:36 +00004325 else if (! PyErr_Occurred()) {
Martin v. Löwis725507b2006-03-07 12:08:51 +00004326 /* Possible results: -1 and 1 */
4327 result = (int)_PySequence_IterSearch(self, value,
Tim Petersbf9b2442003-03-23 05:35:36 +00004328 PY_ITERSEARCH_CONTAINS);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004329 }
Tim Petersbf9b2442003-03-23 05:35:36 +00004330 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004331}
4332
Tim Peters6d6c1a32001-08-02 04:15:00 +00004333#define slot_mp_length slot_sq_length
4334
Guido van Rossumdc91b992001-08-08 22:26:22 +00004335SLOT1(slot_mp_subscript, "__getitem__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004336
4337static int
4338slot_mp_ass_subscript(PyObject *self, PyObject *key, PyObject *value)
4339{
4340 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004341 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004342
4343 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004344 res = call_method(self, "__delitem__", &delitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004345 "(O)", key);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004346 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004347 res = call_method(self, "__setitem__", &setitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004348 "(OO)", key, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004349 if (res == NULL)
4350 return -1;
4351 Py_DECREF(res);
4352 return 0;
4353}
4354
Guido van Rossumdc91b992001-08-08 22:26:22 +00004355SLOT1BIN(slot_nb_add, nb_add, "__add__", "__radd__")
4356SLOT1BIN(slot_nb_subtract, nb_subtract, "__sub__", "__rsub__")
4357SLOT1BIN(slot_nb_multiply, nb_multiply, "__mul__", "__rmul__")
4358SLOT1BIN(slot_nb_divide, nb_divide, "__div__", "__rdiv__")
4359SLOT1BIN(slot_nb_remainder, nb_remainder, "__mod__", "__rmod__")
4360SLOT1BIN(slot_nb_divmod, nb_divmod, "__divmod__", "__rdivmod__")
4361
Jeremy Hylton938ace62002-07-17 16:30:39 +00004362static PyObject *slot_nb_power(PyObject *, PyObject *, PyObject *);
Guido van Rossumdc91b992001-08-08 22:26:22 +00004363
4364SLOT1BINFULL(slot_nb_power_binary, slot_nb_power,
4365 nb_power, "__pow__", "__rpow__")
4366
4367static PyObject *
4368slot_nb_power(PyObject *self, PyObject *other, PyObject *modulus)
4369{
Guido van Rossum2730b132001-08-28 18:22:14 +00004370 static PyObject *pow_str;
4371
Guido van Rossumdc91b992001-08-08 22:26:22 +00004372 if (modulus == Py_None)
4373 return slot_nb_power_binary(self, other);
Guido van Rossum23094982002-06-10 14:30:43 +00004374 /* Three-arg power doesn't use __rpow__. But ternary_op
4375 can call this when the second argument's type uses
4376 slot_nb_power, so check before calling self.__pow__. */
4377 if (self->ob_type->tp_as_number != NULL &&
4378 self->ob_type->tp_as_number->nb_power == slot_nb_power) {
4379 return call_method(self, "__pow__", &pow_str,
4380 "(OO)", other, modulus);
4381 }
4382 Py_INCREF(Py_NotImplemented);
4383 return Py_NotImplemented;
Guido van Rossumdc91b992001-08-08 22:26:22 +00004384}
4385
4386SLOT0(slot_nb_negative, "__neg__")
4387SLOT0(slot_nb_positive, "__pos__")
4388SLOT0(slot_nb_absolute, "__abs__")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004389
4390static int
4391slot_nb_nonzero(PyObject *self)
4392{
Tim Petersea7f75d2002-12-07 21:39:16 +00004393 PyObject *func, *args;
Guido van Rossum60718732001-08-28 17:47:51 +00004394 static PyObject *nonzero_str, *len_str;
Tim Petersea7f75d2002-12-07 21:39:16 +00004395 int result = -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004396
Guido van Rossum55f20992001-10-01 17:18:22 +00004397 func = lookup_maybe(self, "__nonzero__", &nonzero_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004398 if (func == NULL) {
Guido van Rossum55f20992001-10-01 17:18:22 +00004399 if (PyErr_Occurred())
Guido van Rossumb8f63662001-08-15 23:57:02 +00004400 return -1;
Guido van Rossum55f20992001-10-01 17:18:22 +00004401 func = lookup_maybe(self, "__len__", &len_str);
Tim Petersea7f75d2002-12-07 21:39:16 +00004402 if (func == NULL)
4403 return PyErr_Occurred() ? -1 : 1;
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00004404 }
Tim Petersea7f75d2002-12-07 21:39:16 +00004405 args = PyTuple_New(0);
4406 if (args != NULL) {
4407 PyObject *temp = PyObject_Call(func, args, NULL);
4408 Py_DECREF(args);
4409 if (temp != NULL) {
Jeremy Hylton3e3159c2003-06-27 17:38:27 +00004410 if (PyInt_CheckExact(temp) || PyBool_Check(temp))
Jeremy Hylton090a3492003-06-27 16:46:45 +00004411 result = PyObject_IsTrue(temp);
4412 else {
4413 PyErr_Format(PyExc_TypeError,
4414 "__nonzero__ should return "
4415 "bool or int, returned %s",
4416 temp->ob_type->tp_name);
Jeremy Hylton3e3159c2003-06-27 17:38:27 +00004417 result = -1;
Jeremy Hylton090a3492003-06-27 16:46:45 +00004418 }
Tim Petersea7f75d2002-12-07 21:39:16 +00004419 Py_DECREF(temp);
Guido van Rossum55f20992001-10-01 17:18:22 +00004420 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00004421 }
Guido van Rossum55f20992001-10-01 17:18:22 +00004422 Py_DECREF(func);
Tim Petersea7f75d2002-12-07 21:39:16 +00004423 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004424}
4425
Guido van Rossum38fff8c2006-03-07 18:50:55 +00004426
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00004427static PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00004428slot_nb_index(PyObject *self)
4429{
Guido van Rossum38fff8c2006-03-07 18:50:55 +00004430 static PyObject *index_str;
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00004431 return call_method(self, "__index__", &index_str, "()");
Guido van Rossum38fff8c2006-03-07 18:50:55 +00004432}
4433
4434
Guido van Rossumdc91b992001-08-08 22:26:22 +00004435SLOT0(slot_nb_invert, "__invert__")
4436SLOT1BIN(slot_nb_lshift, nb_lshift, "__lshift__", "__rlshift__")
4437SLOT1BIN(slot_nb_rshift, nb_rshift, "__rshift__", "__rrshift__")
4438SLOT1BIN(slot_nb_and, nb_and, "__and__", "__rand__")
4439SLOT1BIN(slot_nb_xor, nb_xor, "__xor__", "__rxor__")
4440SLOT1BIN(slot_nb_or, nb_or, "__or__", "__ror__")
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004441
4442static int
4443slot_nb_coerce(PyObject **a, PyObject **b)
4444{
4445 static PyObject *coerce_str;
4446 PyObject *self = *a, *other = *b;
4447
4448 if (self->ob_type->tp_as_number != NULL &&
4449 self->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
4450 PyObject *r;
4451 r = call_maybe(
4452 self, "__coerce__", &coerce_str, "(O)", other);
4453 if (r == NULL)
4454 return -1;
4455 if (r == Py_NotImplemented) {
4456 Py_DECREF(r);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004457 }
Guido van Rossum55f20992001-10-01 17:18:22 +00004458 else {
4459 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
4460 PyErr_SetString(PyExc_TypeError,
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004461 "__coerce__ didn't return a 2-tuple");
Guido van Rossum55f20992001-10-01 17:18:22 +00004462 Py_DECREF(r);
4463 return -1;
4464 }
4465 *a = PyTuple_GET_ITEM(r, 0);
4466 Py_INCREF(*a);
4467 *b = PyTuple_GET_ITEM(r, 1);
4468 Py_INCREF(*b);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004469 Py_DECREF(r);
Guido van Rossum55f20992001-10-01 17:18:22 +00004470 return 0;
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004471 }
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004472 }
4473 if (other->ob_type->tp_as_number != NULL &&
4474 other->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
4475 PyObject *r;
4476 r = call_maybe(
4477 other, "__coerce__", &coerce_str, "(O)", self);
4478 if (r == NULL)
4479 return -1;
4480 if (r == Py_NotImplemented) {
4481 Py_DECREF(r);
4482 return 1;
4483 }
4484 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
4485 PyErr_SetString(PyExc_TypeError,
4486 "__coerce__ didn't return a 2-tuple");
4487 Py_DECREF(r);
4488 return -1;
4489 }
4490 *a = PyTuple_GET_ITEM(r, 1);
4491 Py_INCREF(*a);
4492 *b = PyTuple_GET_ITEM(r, 0);
4493 Py_INCREF(*b);
4494 Py_DECREF(r);
4495 return 0;
4496 }
4497 return 1;
4498}
4499
Guido van Rossumdc91b992001-08-08 22:26:22 +00004500SLOT0(slot_nb_int, "__int__")
4501SLOT0(slot_nb_long, "__long__")
4502SLOT0(slot_nb_float, "__float__")
4503SLOT0(slot_nb_oct, "__oct__")
4504SLOT0(slot_nb_hex, "__hex__")
4505SLOT1(slot_nb_inplace_add, "__iadd__", PyObject *, "O")
4506SLOT1(slot_nb_inplace_subtract, "__isub__", PyObject *, "O")
4507SLOT1(slot_nb_inplace_multiply, "__imul__", PyObject *, "O")
4508SLOT1(slot_nb_inplace_divide, "__idiv__", PyObject *, "O")
4509SLOT1(slot_nb_inplace_remainder, "__imod__", PyObject *, "O")
Martin v. Löwisfd963262007-02-09 12:19:32 +00004510/* Can't use SLOT1 here, because nb_inplace_power is ternary */
4511static PyObject *
4512slot_nb_inplace_power(PyObject *self, PyObject * arg1, PyObject *arg2)
4513{
4514 static PyObject *cache_str;
4515 return call_method(self, "__ipow__", &cache_str, "(" "O" ")", arg1);
4516}
Guido van Rossumdc91b992001-08-08 22:26:22 +00004517SLOT1(slot_nb_inplace_lshift, "__ilshift__", PyObject *, "O")
4518SLOT1(slot_nb_inplace_rshift, "__irshift__", PyObject *, "O")
4519SLOT1(slot_nb_inplace_and, "__iand__", PyObject *, "O")
4520SLOT1(slot_nb_inplace_xor, "__ixor__", PyObject *, "O")
4521SLOT1(slot_nb_inplace_or, "__ior__", PyObject *, "O")
4522SLOT1BIN(slot_nb_floor_divide, nb_floor_divide,
4523 "__floordiv__", "__rfloordiv__")
4524SLOT1BIN(slot_nb_true_divide, nb_true_divide, "__truediv__", "__rtruediv__")
4525SLOT1(slot_nb_inplace_floor_divide, "__ifloordiv__", PyObject *, "O")
4526SLOT1(slot_nb_inplace_true_divide, "__itruediv__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004527
4528static int
Guido van Rossumb8f63662001-08-15 23:57:02 +00004529half_compare(PyObject *self, PyObject *other)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004530{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004531 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004532 static PyObject *cmp_str;
Martin v. Löwis18e16552006-02-15 17:27:45 +00004533 Py_ssize_t c;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004534
Guido van Rossum60718732001-08-28 17:47:51 +00004535 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004536 if (func == NULL) {
4537 PyErr_Clear();
4538 }
4539 else {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004540 args = PyTuple_Pack(1, other);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004541 if (args == NULL)
4542 res = NULL;
4543 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004544 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004545 Py_DECREF(args);
4546 }
Raymond Hettingerab5dae32002-06-24 13:08:16 +00004547 Py_DECREF(func);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004548 if (res != Py_NotImplemented) {
4549 if (res == NULL)
4550 return -2;
4551 c = PyInt_AsLong(res);
4552 Py_DECREF(res);
4553 if (c == -1 && PyErr_Occurred())
4554 return -2;
4555 return (c < 0) ? -1 : (c > 0) ? 1 : 0;
4556 }
4557 Py_DECREF(res);
4558 }
4559 return 2;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004560}
4561
Guido van Rossumab3b0342001-09-18 20:38:53 +00004562/* This slot is published for the benefit of try_3way_compare in object.c */
4563int
4564_PyObject_SlotCompare(PyObject *self, PyObject *other)
Guido van Rossumb8f63662001-08-15 23:57:02 +00004565{
4566 int c;
4567
Guido van Rossumab3b0342001-09-18 20:38:53 +00004568 if (self->ob_type->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00004569 c = half_compare(self, other);
4570 if (c <= 1)
4571 return c;
4572 }
Guido van Rossumab3b0342001-09-18 20:38:53 +00004573 if (other->ob_type->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00004574 c = half_compare(other, self);
4575 if (c < -1)
4576 return -2;
4577 if (c <= 1)
4578 return -c;
4579 }
4580 return (void *)self < (void *)other ? -1 :
4581 (void *)self > (void *)other ? 1 : 0;
4582}
4583
4584static PyObject *
4585slot_tp_repr(PyObject *self)
4586{
4587 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004588 static PyObject *repr_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004589
Guido van Rossum60718732001-08-28 17:47:51 +00004590 func = lookup_method(self, "__repr__", &repr_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004591 if (func != NULL) {
4592 res = PyEval_CallObject(func, NULL);
4593 Py_DECREF(func);
4594 return res;
4595 }
Barry Warsaw7ce36942001-08-24 18:34:26 +00004596 PyErr_Clear();
4597 return PyString_FromFormat("<%s object at %p>",
4598 self->ob_type->tp_name, self);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004599}
4600
4601static PyObject *
4602slot_tp_str(PyObject *self)
4603{
4604 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004605 static PyObject *str_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004606
Guido van Rossum60718732001-08-28 17:47:51 +00004607 func = lookup_method(self, "__str__", &str_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004608 if (func != NULL) {
4609 res = PyEval_CallObject(func, NULL);
4610 Py_DECREF(func);
4611 return res;
4612 }
4613 else {
4614 PyErr_Clear();
4615 return slot_tp_repr(self);
4616 }
4617}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004618
4619static long
4620slot_tp_hash(PyObject *self)
4621{
Tim Peters61ce0a92002-12-06 23:38:02 +00004622 PyObject *func;
Guido van Rossum60718732001-08-28 17:47:51 +00004623 static PyObject *hash_str, *eq_str, *cmp_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004624 long h;
4625
Guido van Rossum60718732001-08-28 17:47:51 +00004626 func = lookup_method(self, "__hash__", &hash_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004627
4628 if (func != NULL) {
Tim Peters61ce0a92002-12-06 23:38:02 +00004629 PyObject *res = PyEval_CallObject(func, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004630 Py_DECREF(func);
4631 if (res == NULL)
4632 return -1;
Martin v. Löwisab2f8f72006-08-09 07:57:39 +00004633 if (PyLong_Check(res))
Armin Rigo51fc8c42006-08-09 14:55:26 +00004634 h = PyLong_Type.tp_hash(res);
Martin v. Löwisab2f8f72006-08-09 07:57:39 +00004635 else
4636 h = PyInt_AsLong(res);
Tim Peters61ce0a92002-12-06 23:38:02 +00004637 Py_DECREF(res);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004638 }
4639 else {
4640 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004641 func = lookup_method(self, "__eq__", &eq_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004642 if (func == NULL) {
4643 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004644 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004645 }
4646 if (func != NULL) {
Georg Brandlccff7852006-06-18 22:17:29 +00004647 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
4648 self->ob_type->tp_name);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004649 Py_DECREF(func);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004650 return -1;
4651 }
4652 PyErr_Clear();
4653 h = _Py_HashPointer((void *)self);
4654 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004655 if (h == -1 && !PyErr_Occurred())
4656 h = -2;
4657 return h;
4658}
4659
4660static PyObject *
4661slot_tp_call(PyObject *self, PyObject *args, PyObject *kwds)
4662{
Guido van Rossum60718732001-08-28 17:47:51 +00004663 static PyObject *call_str;
4664 PyObject *meth = lookup_method(self, "__call__", &call_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004665 PyObject *res;
4666
4667 if (meth == NULL)
4668 return NULL;
Armin Rigo53c1692f2006-06-21 21:58:50 +00004669
4670 /* PyObject_Call() will end up calling slot_tp_call() again if
4671 the object returned for __call__ has __call__ itself defined
4672 upon it. This can be an infinite recursion if you set
4673 __call__ in a class to an instance of it. */
Neal Norwitzb1149842006-06-23 03:32:44 +00004674 if (Py_EnterRecursiveCall(" in __call__")) {
4675 Py_DECREF(meth);
Armin Rigo53c1692f2006-06-21 21:58:50 +00004676 return NULL;
Neal Norwitzb1149842006-06-23 03:32:44 +00004677 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004678 res = PyObject_Call(meth, args, kwds);
Armin Rigo53c1692f2006-06-21 21:58:50 +00004679 Py_LeaveRecursiveCall();
4680
Tim Peters6d6c1a32001-08-02 04:15:00 +00004681 Py_DECREF(meth);
4682 return res;
4683}
4684
Guido van Rossum14a6f832001-10-17 13:59:09 +00004685/* There are two slot dispatch functions for tp_getattro.
4686
4687 - slot_tp_getattro() is used when __getattribute__ is overridden
4688 but no __getattr__ hook is present;
4689
4690 - slot_tp_getattr_hook() is used when a __getattr__ hook is present.
4691
Guido van Rossumc334df52002-04-04 23:44:47 +00004692 The code in update_one_slot() always installs slot_tp_getattr_hook(); this
4693 detects the absence of __getattr__ and then installs the simpler slot if
4694 necessary. */
Guido van Rossum14a6f832001-10-17 13:59:09 +00004695
Tim Peters6d6c1a32001-08-02 04:15:00 +00004696static PyObject *
4697slot_tp_getattro(PyObject *self, PyObject *name)
4698{
Guido van Rossum14a6f832001-10-17 13:59:09 +00004699 static PyObject *getattribute_str = NULL;
4700 return call_method(self, "__getattribute__", &getattribute_str,
4701 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004702}
4703
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004704static PyObject *
4705slot_tp_getattr_hook(PyObject *self, PyObject *name)
4706{
4707 PyTypeObject *tp = self->ob_type;
4708 PyObject *getattr, *getattribute, *res;
4709 static PyObject *getattribute_str = NULL;
4710 static PyObject *getattr_str = NULL;
4711
4712 if (getattr_str == NULL) {
4713 getattr_str = PyString_InternFromString("__getattr__");
4714 if (getattr_str == NULL)
4715 return NULL;
4716 }
4717 if (getattribute_str == NULL) {
4718 getattribute_str =
4719 PyString_InternFromString("__getattribute__");
4720 if (getattribute_str == NULL)
4721 return NULL;
4722 }
4723 getattr = _PyType_Lookup(tp, getattr_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004724 if (getattr == NULL) {
Guido van Rossumd396b9c2001-10-13 20:02:41 +00004725 /* No __getattr__ hook: use a simpler dispatcher */
4726 tp->tp_getattro = slot_tp_getattro;
4727 return slot_tp_getattro(self, name);
4728 }
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004729 getattribute = _PyType_Lookup(tp, getattribute_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004730 if (getattribute == NULL ||
4731 (getattribute->ob_type == &PyWrapperDescr_Type &&
4732 ((PyWrapperDescrObject *)getattribute)->d_wrapped ==
4733 (void *)PyObject_GenericGetAttr))
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004734 res = PyObject_GenericGetAttr(self, name);
4735 else
Georg Brandl684fd0c2006-05-25 19:15:31 +00004736 res = PyObject_CallFunctionObjArgs(getattribute, self, name, NULL);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004737 if (res == NULL && PyErr_ExceptionMatches(PyExc_AttributeError)) {
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004738 PyErr_Clear();
Georg Brandl684fd0c2006-05-25 19:15:31 +00004739 res = PyObject_CallFunctionObjArgs(getattr, self, name, NULL);
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004740 }
4741 return res;
4742}
4743
Tim Peters6d6c1a32001-08-02 04:15:00 +00004744static int
4745slot_tp_setattro(PyObject *self, PyObject *name, PyObject *value)
4746{
4747 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004748 static PyObject *delattr_str, *setattr_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004749
4750 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004751 res = call_method(self, "__delattr__", &delattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004752 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004753 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004754 res = call_method(self, "__setattr__", &setattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004755 "(OO)", name, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004756 if (res == NULL)
4757 return -1;
4758 Py_DECREF(res);
4759 return 0;
4760}
4761
4762/* Map rich comparison operators to their __xx__ namesakes */
4763static char *name_op[] = {
4764 "__lt__",
4765 "__le__",
4766 "__eq__",
4767 "__ne__",
4768 "__gt__",
4769 "__ge__",
4770};
4771
4772static PyObject *
Guido van Rossumb8f63662001-08-15 23:57:02 +00004773half_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004774{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004775 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004776 static PyObject *op_str[6];
Tim Peters6d6c1a32001-08-02 04:15:00 +00004777
Guido van Rossum60718732001-08-28 17:47:51 +00004778 func = lookup_method(self, name_op[op], &op_str[op]);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004779 if (func == NULL) {
4780 PyErr_Clear();
4781 Py_INCREF(Py_NotImplemented);
4782 return Py_NotImplemented;
4783 }
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004784 args = PyTuple_Pack(1, other);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004785 if (args == NULL)
4786 res = NULL;
4787 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004788 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004789 Py_DECREF(args);
4790 }
4791 Py_DECREF(func);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004792 return res;
4793}
4794
Guido van Rossumb8f63662001-08-15 23:57:02 +00004795static PyObject *
4796slot_tp_richcompare(PyObject *self, PyObject *other, int op)
4797{
4798 PyObject *res;
4799
4800 if (self->ob_type->tp_richcompare == slot_tp_richcompare) {
4801 res = half_richcompare(self, other, op);
4802 if (res != Py_NotImplemented)
4803 return res;
4804 Py_DECREF(res);
4805 }
4806 if (other->ob_type->tp_richcompare == slot_tp_richcompare) {
Tim Petersf4aca752004-09-23 02:39:37 +00004807 res = half_richcompare(other, self, _Py_SwappedOp[op]);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004808 if (res != Py_NotImplemented) {
4809 return res;
4810 }
4811 Py_DECREF(res);
4812 }
4813 Py_INCREF(Py_NotImplemented);
4814 return Py_NotImplemented;
4815}
4816
4817static PyObject *
4818slot_tp_iter(PyObject *self)
4819{
4820 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004821 static PyObject *iter_str, *getitem_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004822
Guido van Rossum60718732001-08-28 17:47:51 +00004823 func = lookup_method(self, "__iter__", &iter_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004824 if (func != NULL) {
Guido van Rossum84b2bed2002-08-16 17:01:09 +00004825 PyObject *args;
4826 args = res = PyTuple_New(0);
4827 if (args != NULL) {
4828 res = PyObject_Call(func, args, NULL);
4829 Py_DECREF(args);
4830 }
4831 Py_DECREF(func);
4832 return res;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004833 }
4834 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004835 func = lookup_method(self, "__getitem__", &getitem_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004836 if (func == NULL) {
Georg Brandlccff7852006-06-18 22:17:29 +00004837 PyErr_Format(PyExc_TypeError,
4838 "'%.200s' object is not iterable",
4839 self->ob_type->tp_name);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004840 return NULL;
4841 }
4842 Py_DECREF(func);
4843 return PySeqIter_New(self);
4844}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004845
4846static PyObject *
4847slot_tp_iternext(PyObject *self)
4848{
Guido van Rossum2730b132001-08-28 18:22:14 +00004849 static PyObject *next_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00004850 return call_method(self, "next", &next_str, "()");
Tim Peters6d6c1a32001-08-02 04:15:00 +00004851}
4852
Guido van Rossum1a493502001-08-17 16:47:50 +00004853static PyObject *
4854slot_tp_descr_get(PyObject *self, PyObject *obj, PyObject *type)
4855{
4856 PyTypeObject *tp = self->ob_type;
4857 PyObject *get;
4858 static PyObject *get_str = NULL;
4859
4860 if (get_str == NULL) {
4861 get_str = PyString_InternFromString("__get__");
4862 if (get_str == NULL)
4863 return NULL;
4864 }
4865 get = _PyType_Lookup(tp, get_str);
4866 if (get == NULL) {
4867 /* Avoid further slowdowns */
4868 if (tp->tp_descr_get == slot_tp_descr_get)
4869 tp->tp_descr_get = NULL;
4870 Py_INCREF(self);
4871 return self;
4872 }
Guido van Rossum2c252392001-08-24 10:13:31 +00004873 if (obj == NULL)
4874 obj = Py_None;
4875 if (type == NULL)
4876 type = Py_None;
Georg Brandl684fd0c2006-05-25 19:15:31 +00004877 return PyObject_CallFunctionObjArgs(get, self, obj, type, NULL);
Guido van Rossum1a493502001-08-17 16:47:50 +00004878}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004879
4880static int
4881slot_tp_descr_set(PyObject *self, PyObject *target, PyObject *value)
4882{
Guido van Rossum2c252392001-08-24 10:13:31 +00004883 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004884 static PyObject *del_str, *set_str;
Guido van Rossum2c252392001-08-24 10:13:31 +00004885
4886 if (value == NULL)
Guido van Rossum1d5b3f22001-12-03 00:08:33 +00004887 res = call_method(self, "__delete__", &del_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004888 "(O)", target);
Guido van Rossum2c252392001-08-24 10:13:31 +00004889 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004890 res = call_method(self, "__set__", &set_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004891 "(OO)", target, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004892 if (res == NULL)
4893 return -1;
4894 Py_DECREF(res);
4895 return 0;
4896}
4897
4898static int
4899slot_tp_init(PyObject *self, PyObject *args, PyObject *kwds)
4900{
Guido van Rossum60718732001-08-28 17:47:51 +00004901 static PyObject *init_str;
4902 PyObject *meth = lookup_method(self, "__init__", &init_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004903 PyObject *res;
4904
4905 if (meth == NULL)
4906 return -1;
4907 res = PyObject_Call(meth, args, kwds);
4908 Py_DECREF(meth);
4909 if (res == NULL)
4910 return -1;
Raymond Hettingerb67cc802005-03-03 16:45:19 +00004911 if (res != Py_None) {
Georg Brandlccff7852006-06-18 22:17:29 +00004912 PyErr_Format(PyExc_TypeError,
4913 "__init__() should return None, not '%.200s'",
4914 res->ob_type->tp_name);
Raymond Hettingerb67cc802005-03-03 16:45:19 +00004915 Py_DECREF(res);
4916 return -1;
4917 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004918 Py_DECREF(res);
4919 return 0;
4920}
4921
4922static PyObject *
4923slot_tp_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
4924{
Guido van Rossum7bed2132002-08-08 21:57:53 +00004925 static PyObject *new_str;
4926 PyObject *func;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004927 PyObject *newargs, *x;
Martin v. Löwis18e16552006-02-15 17:27:45 +00004928 Py_ssize_t i, n;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004929
Guido van Rossum7bed2132002-08-08 21:57:53 +00004930 if (new_str == NULL) {
4931 new_str = PyString_InternFromString("__new__");
4932 if (new_str == NULL)
4933 return NULL;
4934 }
4935 func = PyObject_GetAttr((PyObject *)type, new_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004936 if (func == NULL)
4937 return NULL;
4938 assert(PyTuple_Check(args));
4939 n = PyTuple_GET_SIZE(args);
4940 newargs = PyTuple_New(n+1);
4941 if (newargs == NULL)
4942 return NULL;
4943 Py_INCREF(type);
4944 PyTuple_SET_ITEM(newargs, 0, (PyObject *)type);
4945 for (i = 0; i < n; i++) {
4946 x = PyTuple_GET_ITEM(args, i);
4947 Py_INCREF(x);
4948 PyTuple_SET_ITEM(newargs, i+1, x);
4949 }
4950 x = PyObject_Call(func, newargs, kwds);
Guido van Rossum25d18072001-10-01 15:55:28 +00004951 Py_DECREF(newargs);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004952 Py_DECREF(func);
4953 return x;
4954}
4955
Guido van Rossumfebd61d2002-08-08 20:55:20 +00004956static void
4957slot_tp_del(PyObject *self)
4958{
4959 static PyObject *del_str = NULL;
4960 PyObject *del, *res;
4961 PyObject *error_type, *error_value, *error_traceback;
4962
4963 /* Temporarily resurrect the object. */
4964 assert(self->ob_refcnt == 0);
4965 self->ob_refcnt = 1;
4966
4967 /* Save the current exception, if any. */
4968 PyErr_Fetch(&error_type, &error_value, &error_traceback);
4969
4970 /* Execute __del__ method, if any. */
4971 del = lookup_maybe(self, "__del__", &del_str);
4972 if (del != NULL) {
4973 res = PyEval_CallObject(del, NULL);
4974 if (res == NULL)
4975 PyErr_WriteUnraisable(del);
4976 else
4977 Py_DECREF(res);
4978 Py_DECREF(del);
4979 }
4980
4981 /* Restore the saved exception. */
4982 PyErr_Restore(error_type, error_value, error_traceback);
4983
4984 /* Undo the temporary resurrection; can't use DECREF here, it would
4985 * cause a recursive call.
4986 */
4987 assert(self->ob_refcnt > 0);
4988 if (--self->ob_refcnt == 0)
4989 return; /* this is the normal path out */
4990
4991 /* __del__ resurrected it! Make it look like the original Py_DECREF
4992 * never happened.
4993 */
4994 {
Martin v. Löwis725507b2006-03-07 12:08:51 +00004995 Py_ssize_t refcnt = self->ob_refcnt;
Guido van Rossumfebd61d2002-08-08 20:55:20 +00004996 _Py_NewReference(self);
4997 self->ob_refcnt = refcnt;
4998 }
4999 assert(!PyType_IS_GC(self->ob_type) ||
5000 _Py_AS_GC(self)->gc.gc_refs != _PyGC_REFS_UNTRACKED);
Michael W. Hudson3f3b6682004-08-03 10:21:03 +00005001 /* If Py_REF_DEBUG, _Py_NewReference bumped _Py_RefTotal, so
5002 * we need to undo that. */
5003 _Py_DEC_REFTOTAL;
5004 /* If Py_TRACE_REFS, _Py_NewReference re-added self to the object
5005 * chain, so no more to do there.
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005006 * If COUNT_ALLOCS, the original decref bumped tp_frees, and
5007 * _Py_NewReference bumped tp_allocs: both of those need to be
5008 * undone.
5009 */
5010#ifdef COUNT_ALLOCS
5011 --self->ob_type->tp_frees;
5012 --self->ob_type->tp_allocs;
5013#endif
5014}
5015
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005016
5017/* Table mapping __foo__ names to tp_foo offsets and slot_tp_foo wrapper
Tim Petersbf9b2442003-03-23 05:35:36 +00005018 functions. The offsets here are relative to the 'PyHeapTypeObject'
Guido van Rossume5c691a2003-03-07 15:13:17 +00005019 structure, which incorporates the additional structures used for numbers,
5020 sequences and mappings.
5021 Note that multiple names may map to the same slot (e.g. __eq__,
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005022 __ne__ etc. all map to tp_richcompare) and one name may map to multiple
Guido van Rossumc334df52002-04-04 23:44:47 +00005023 slots (e.g. __str__ affects tp_str as well as tp_repr). The table is
5024 terminated with an all-zero entry. (This table is further initialized and
5025 sorted in init_slotdefs() below.) */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005026
Guido van Rossum6d204072001-10-21 00:44:31 +00005027typedef struct wrapperbase slotdef;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005028
5029#undef TPSLOT
Guido van Rossumc8e56452001-10-22 00:43:43 +00005030#undef FLSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005031#undef ETSLOT
5032#undef SQSLOT
5033#undef MPSLOT
5034#undef NBSLOT
Guido van Rossum6d204072001-10-21 00:44:31 +00005035#undef UNSLOT
5036#undef IBSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005037#undef BINSLOT
5038#undef RBINSLOT
5039
Guido van Rossum6d204072001-10-21 00:44:31 +00005040#define TPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Neal Norwitzd47714a2002-08-13 19:01:38 +00005041 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
5042 PyDoc_STR(DOC)}
Guido van Rossumc8e56452001-10-22 00:43:43 +00005043#define FLSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC, FLAGS) \
5044 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00005045 PyDoc_STR(DOC), FLAGS}
Guido van Rossum6d204072001-10-21 00:44:31 +00005046#define ETSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Guido van Rossume5c691a2003-03-07 15:13:17 +00005047 {NAME, offsetof(PyHeapTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00005048 PyDoc_STR(DOC)}
Guido van Rossum6d204072001-10-21 00:44:31 +00005049#define SQSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
5050 ETSLOT(NAME, as_sequence.SLOT, FUNCTION, WRAPPER, DOC)
5051#define MPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
5052 ETSLOT(NAME, as_mapping.SLOT, FUNCTION, WRAPPER, DOC)
5053#define NBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
5054 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, DOC)
5055#define UNSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
5056 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
5057 "x." NAME "() <==> " DOC)
5058#define IBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
5059 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
5060 "x." NAME "(y) <==> x" DOC "y")
5061#define BINSLOT(NAME, SLOT, FUNCTION, DOC) \
5062 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_l, \
5063 "x." NAME "(y) <==> x" DOC "y")
5064#define RBINSLOT(NAME, SLOT, FUNCTION, DOC) \
5065 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_r, \
5066 "x." NAME "(y) <==> y" DOC "x")
Anthony Baxter56616992005-06-03 14:12:21 +00005067#define BINSLOTNOTINFIX(NAME, SLOT, FUNCTION, DOC) \
5068 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_l, \
5069 "x." NAME "(y) <==> " DOC)
5070#define RBINSLOTNOTINFIX(NAME, SLOT, FUNCTION, DOC) \
5071 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_r, \
5072 "x." NAME "(y) <==> " DOC)
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005073
5074static slotdef slotdefs[] = {
Martin v. Löwis18e16552006-02-15 17:27:45 +00005075 SQSLOT("__len__", sq_length, slot_sq_length, wrap_lenfunc,
Guido van Rossum6d204072001-10-21 00:44:31 +00005076 "x.__len__() <==> len(x)"),
Armin Rigofd163f92005-12-29 15:59:19 +00005077 /* Heap types defining __add__/__mul__ have sq_concat/sq_repeat == NULL.
5078 The logic in abstract.c always falls back to nb_add/nb_multiply in
5079 this case. Defining both the nb_* and the sq_* slots to call the
5080 user-defined methods has unexpected side-effects, as shown by
5081 test_descr.notimplemented() */
5082 SQSLOT("__add__", sq_concat, NULL, wrap_binaryfunc,
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005083 "x.__add__(y) <==> x+y"),
Armin Rigo314861c2006-03-30 14:04:02 +00005084 SQSLOT("__mul__", sq_repeat, NULL, wrap_indexargfunc,
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005085 "x.__mul__(n) <==> x*n"),
Armin Rigo314861c2006-03-30 14:04:02 +00005086 SQSLOT("__rmul__", sq_repeat, NULL, wrap_indexargfunc,
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005087 "x.__rmul__(n) <==> n*x"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005088 SQSLOT("__getitem__", sq_item, slot_sq_item, wrap_sq_item,
5089 "x.__getitem__(y) <==> x[y]"),
Martin v. Löwis18e16552006-02-15 17:27:45 +00005090 SQSLOT("__getslice__", sq_slice, slot_sq_slice, wrap_ssizessizeargfunc,
Brett Cannon154da9b2003-05-20 02:30:04 +00005091 "x.__getslice__(i, j) <==> x[i:j]\n\
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005092 \n\
5093 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00005094 SQSLOT("__setitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_setitem,
Brett Cannonbe67d872003-05-20 02:40:12 +00005095 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005096 SQSLOT("__delitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_delitem,
Brett Cannonbe67d872003-05-20 02:40:12 +00005097 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005098 SQSLOT("__setslice__", sq_ass_slice, slot_sq_ass_slice,
Martin v. Löwis18e16552006-02-15 17:27:45 +00005099 wrap_ssizessizeobjargproc,
Brett Cannonbe67d872003-05-20 02:40:12 +00005100 "x.__setslice__(i, j, y) <==> x[i:j]=y\n\
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005101 \n\
5102 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00005103 SQSLOT("__delslice__", sq_ass_slice, slot_sq_ass_slice, wrap_delslice,
Brett Cannonbe67d872003-05-20 02:40:12 +00005104 "x.__delslice__(i, j) <==> del x[i:j]\n\
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005105 \n\
5106 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00005107 SQSLOT("__contains__", sq_contains, slot_sq_contains, wrap_objobjproc,
5108 "x.__contains__(y) <==> y in x"),
Armin Rigofd163f92005-12-29 15:59:19 +00005109 SQSLOT("__iadd__", sq_inplace_concat, NULL,
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005110 wrap_binaryfunc, "x.__iadd__(y) <==> x+=y"),
Armin Rigofd163f92005-12-29 15:59:19 +00005111 SQSLOT("__imul__", sq_inplace_repeat, NULL,
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005112 wrap_indexargfunc, "x.__imul__(y) <==> x*=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005113
Martin v. Löwis18e16552006-02-15 17:27:45 +00005114 MPSLOT("__len__", mp_length, slot_mp_length, wrap_lenfunc,
Guido van Rossum6d204072001-10-21 00:44:31 +00005115 "x.__len__() <==> len(x)"),
Guido van Rossumfd38f8e2001-10-09 20:17:57 +00005116 MPSLOT("__getitem__", mp_subscript, slot_mp_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00005117 wrap_binaryfunc,
5118 "x.__getitem__(y) <==> x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005119 MPSLOT("__setitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00005120 wrap_objobjargproc,
5121 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005122 MPSLOT("__delitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00005123 wrap_delitem,
5124 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005125
Guido van Rossum6d204072001-10-21 00:44:31 +00005126 BINSLOT("__add__", nb_add, slot_nb_add,
5127 "+"),
5128 RBINSLOT("__radd__", nb_add, slot_nb_add,
5129 "+"),
5130 BINSLOT("__sub__", nb_subtract, slot_nb_subtract,
5131 "-"),
5132 RBINSLOT("__rsub__", nb_subtract, slot_nb_subtract,
5133 "-"),
5134 BINSLOT("__mul__", nb_multiply, slot_nb_multiply,
5135 "*"),
5136 RBINSLOT("__rmul__", nb_multiply, slot_nb_multiply,
5137 "*"),
5138 BINSLOT("__div__", nb_divide, slot_nb_divide,
5139 "/"),
5140 RBINSLOT("__rdiv__", nb_divide, slot_nb_divide,
5141 "/"),
5142 BINSLOT("__mod__", nb_remainder, slot_nb_remainder,
5143 "%"),
5144 RBINSLOT("__rmod__", nb_remainder, slot_nb_remainder,
5145 "%"),
Anthony Baxter56616992005-06-03 14:12:21 +00005146 BINSLOTNOTINFIX("__divmod__", nb_divmod, slot_nb_divmod,
Guido van Rossum6d204072001-10-21 00:44:31 +00005147 "divmod(x, y)"),
Anthony Baxter56616992005-06-03 14:12:21 +00005148 RBINSLOTNOTINFIX("__rdivmod__", nb_divmod, slot_nb_divmod,
Guido van Rossum6d204072001-10-21 00:44:31 +00005149 "divmod(y, x)"),
5150 NBSLOT("__pow__", nb_power, slot_nb_power, wrap_ternaryfunc,
5151 "x.__pow__(y[, z]) <==> pow(x, y[, z])"),
5152 NBSLOT("__rpow__", nb_power, slot_nb_power, wrap_ternaryfunc_r,
5153 "y.__rpow__(x[, z]) <==> pow(x, y[, z])"),
5154 UNSLOT("__neg__", nb_negative, slot_nb_negative, wrap_unaryfunc, "-x"),
5155 UNSLOT("__pos__", nb_positive, slot_nb_positive, wrap_unaryfunc, "+x"),
5156 UNSLOT("__abs__", nb_absolute, slot_nb_absolute, wrap_unaryfunc,
5157 "abs(x)"),
Raymond Hettingerf34f2642003-10-11 17:29:04 +00005158 UNSLOT("__nonzero__", nb_nonzero, slot_nb_nonzero, wrap_inquirypred,
Guido van Rossum6d204072001-10-21 00:44:31 +00005159 "x != 0"),
5160 UNSLOT("__invert__", nb_invert, slot_nb_invert, wrap_unaryfunc, "~x"),
5161 BINSLOT("__lshift__", nb_lshift, slot_nb_lshift, "<<"),
5162 RBINSLOT("__rlshift__", nb_lshift, slot_nb_lshift, "<<"),
5163 BINSLOT("__rshift__", nb_rshift, slot_nb_rshift, ">>"),
5164 RBINSLOT("__rrshift__", nb_rshift, slot_nb_rshift, ">>"),
5165 BINSLOT("__and__", nb_and, slot_nb_and, "&"),
5166 RBINSLOT("__rand__", nb_and, slot_nb_and, "&"),
5167 BINSLOT("__xor__", nb_xor, slot_nb_xor, "^"),
5168 RBINSLOT("__rxor__", nb_xor, slot_nb_xor, "^"),
5169 BINSLOT("__or__", nb_or, slot_nb_or, "|"),
5170 RBINSLOT("__ror__", nb_or, slot_nb_or, "|"),
5171 NBSLOT("__coerce__", nb_coerce, slot_nb_coerce, wrap_coercefunc,
5172 "x.__coerce__(y) <==> coerce(x, y)"),
5173 UNSLOT("__int__", nb_int, slot_nb_int, wrap_unaryfunc,
5174 "int(x)"),
5175 UNSLOT("__long__", nb_long, slot_nb_long, wrap_unaryfunc,
5176 "long(x)"),
5177 UNSLOT("__float__", nb_float, slot_nb_float, wrap_unaryfunc,
5178 "float(x)"),
5179 UNSLOT("__oct__", nb_oct, slot_nb_oct, wrap_unaryfunc,
5180 "oct(x)"),
5181 UNSLOT("__hex__", nb_hex, slot_nb_hex, wrap_unaryfunc,
5182 "hex(x)"),
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00005183 NBSLOT("__index__", nb_index, slot_nb_index, wrap_unaryfunc,
Guido van Rossum38fff8c2006-03-07 18:50:55 +00005184 "x[y:z] <==> x[y.__index__():z.__index__()]"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005185 IBSLOT("__iadd__", nb_inplace_add, slot_nb_inplace_add,
5186 wrap_binaryfunc, "+"),
5187 IBSLOT("__isub__", nb_inplace_subtract, slot_nb_inplace_subtract,
5188 wrap_binaryfunc, "-"),
5189 IBSLOT("__imul__", nb_inplace_multiply, slot_nb_inplace_multiply,
5190 wrap_binaryfunc, "*"),
5191 IBSLOT("__idiv__", nb_inplace_divide, slot_nb_inplace_divide,
5192 wrap_binaryfunc, "/"),
5193 IBSLOT("__imod__", nb_inplace_remainder, slot_nb_inplace_remainder,
5194 wrap_binaryfunc, "%"),
5195 IBSLOT("__ipow__", nb_inplace_power, slot_nb_inplace_power,
Guido van Rossum6e5680f2002-10-15 01:01:53 +00005196 wrap_binaryfunc, "**"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005197 IBSLOT("__ilshift__", nb_inplace_lshift, slot_nb_inplace_lshift,
5198 wrap_binaryfunc, "<<"),
5199 IBSLOT("__irshift__", nb_inplace_rshift, slot_nb_inplace_rshift,
5200 wrap_binaryfunc, ">>"),
5201 IBSLOT("__iand__", nb_inplace_and, slot_nb_inplace_and,
5202 wrap_binaryfunc, "&"),
5203 IBSLOT("__ixor__", nb_inplace_xor, slot_nb_inplace_xor,
5204 wrap_binaryfunc, "^"),
5205 IBSLOT("__ior__", nb_inplace_or, slot_nb_inplace_or,
5206 wrap_binaryfunc, "|"),
5207 BINSLOT("__floordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
5208 RBINSLOT("__rfloordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
5209 BINSLOT("__truediv__", nb_true_divide, slot_nb_true_divide, "/"),
5210 RBINSLOT("__rtruediv__", nb_true_divide, slot_nb_true_divide, "/"),
5211 IBSLOT("__ifloordiv__", nb_inplace_floor_divide,
5212 slot_nb_inplace_floor_divide, wrap_binaryfunc, "//"),
5213 IBSLOT("__itruediv__", nb_inplace_true_divide,
5214 slot_nb_inplace_true_divide, wrap_binaryfunc, "/"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005215
Guido van Rossum6d204072001-10-21 00:44:31 +00005216 TPSLOT("__str__", tp_str, slot_tp_str, wrap_unaryfunc,
5217 "x.__str__() <==> str(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00005218 TPSLOT("__str__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00005219 TPSLOT("__repr__", tp_repr, slot_tp_repr, wrap_unaryfunc,
5220 "x.__repr__() <==> repr(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00005221 TPSLOT("__repr__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00005222 TPSLOT("__cmp__", tp_compare, _PyObject_SlotCompare, wrap_cmpfunc,
5223 "x.__cmp__(y) <==> cmp(x,y)"),
5224 TPSLOT("__hash__", tp_hash, slot_tp_hash, wrap_hashfunc,
5225 "x.__hash__() <==> hash(x)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00005226 FLSLOT("__call__", tp_call, slot_tp_call, (wrapperfunc)wrap_call,
5227 "x.__call__(...) <==> x(...)", PyWrapperFlag_KEYWORDS),
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005228 TPSLOT("__getattribute__", tp_getattro, slot_tp_getattr_hook,
Guido van Rossum6d204072001-10-21 00:44:31 +00005229 wrap_binaryfunc, "x.__getattribute__('name') <==> x.name"),
5230 TPSLOT("__getattribute__", tp_getattr, NULL, NULL, ""),
5231 TPSLOT("__getattr__", tp_getattro, slot_tp_getattr_hook, NULL, ""),
5232 TPSLOT("__getattr__", tp_getattr, NULL, NULL, ""),
5233 TPSLOT("__setattr__", tp_setattro, slot_tp_setattro, wrap_setattr,
5234 "x.__setattr__('name', value) <==> x.name = value"),
5235 TPSLOT("__setattr__", tp_setattr, NULL, NULL, ""),
5236 TPSLOT("__delattr__", tp_setattro, slot_tp_setattro, wrap_delattr,
5237 "x.__delattr__('name') <==> del x.name"),
5238 TPSLOT("__delattr__", tp_setattr, NULL, NULL, ""),
5239 TPSLOT("__lt__", tp_richcompare, slot_tp_richcompare, richcmp_lt,
5240 "x.__lt__(y) <==> x<y"),
5241 TPSLOT("__le__", tp_richcompare, slot_tp_richcompare, richcmp_le,
5242 "x.__le__(y) <==> x<=y"),
5243 TPSLOT("__eq__", tp_richcompare, slot_tp_richcompare, richcmp_eq,
5244 "x.__eq__(y) <==> x==y"),
5245 TPSLOT("__ne__", tp_richcompare, slot_tp_richcompare, richcmp_ne,
5246 "x.__ne__(y) <==> x!=y"),
5247 TPSLOT("__gt__", tp_richcompare, slot_tp_richcompare, richcmp_gt,
5248 "x.__gt__(y) <==> x>y"),
5249 TPSLOT("__ge__", tp_richcompare, slot_tp_richcompare, richcmp_ge,
5250 "x.__ge__(y) <==> x>=y"),
5251 TPSLOT("__iter__", tp_iter, slot_tp_iter, wrap_unaryfunc,
5252 "x.__iter__() <==> iter(x)"),
5253 TPSLOT("next", tp_iternext, slot_tp_iternext, wrap_next,
5254 "x.next() -> the next value, or raise StopIteration"),
5255 TPSLOT("__get__", tp_descr_get, slot_tp_descr_get, wrap_descr_get,
5256 "descr.__get__(obj[, type]) -> value"),
5257 TPSLOT("__set__", tp_descr_set, slot_tp_descr_set, wrap_descr_set,
5258 "descr.__set__(obj, value)"),
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00005259 TPSLOT("__delete__", tp_descr_set, slot_tp_descr_set,
5260 wrap_descr_delete, "descr.__delete__(obj)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00005261 FLSLOT("__init__", tp_init, slot_tp_init, (wrapperfunc)wrap_init,
Guido van Rossum6d204072001-10-21 00:44:31 +00005262 "x.__init__(...) initializes x; "
Guido van Rossumc8e56452001-10-22 00:43:43 +00005263 "see x.__class__.__doc__ for signature",
5264 PyWrapperFlag_KEYWORDS),
5265 TPSLOT("__new__", tp_new, slot_tp_new, NULL, ""),
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005266 TPSLOT("__del__", tp_del, slot_tp_del, NULL, ""),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005267 {NULL}
5268};
5269
Guido van Rossumc334df52002-04-04 23:44:47 +00005270/* Given a type pointer and an offset gotten from a slotdef entry, return a
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005271 pointer to the actual slot. This is not quite the same as simply adding
Guido van Rossumc334df52002-04-04 23:44:47 +00005272 the offset to the type pointer, since it takes care to indirect through the
5273 proper indirection pointer (as_buffer, etc.); it returns NULL if the
5274 indirection pointer is NULL. */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005275static void **
Martin v. Löwis18e16552006-02-15 17:27:45 +00005276slotptr(PyTypeObject *type, int ioffset)
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005277{
5278 char *ptr;
Martin v. Löwis18e16552006-02-15 17:27:45 +00005279 long offset = ioffset;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005280
Guido van Rossume5c691a2003-03-07 15:13:17 +00005281 /* Note: this depends on the order of the members of PyHeapTypeObject! */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005282 assert(offset >= 0);
Skip Montanaro429433b2006-04-18 00:35:43 +00005283 assert((size_t)offset < offsetof(PyHeapTypeObject, as_buffer));
5284 if ((size_t)offset >= offsetof(PyHeapTypeObject, as_sequence)) {
Martin v. Löwisee36d652006-04-11 09:08:02 +00005285 ptr = (char *)type->tp_as_sequence;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005286 offset -= offsetof(PyHeapTypeObject, as_sequence);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005287 }
Skip Montanaro429433b2006-04-18 00:35:43 +00005288 else if ((size_t)offset >= offsetof(PyHeapTypeObject, as_mapping)) {
Martin v. Löwisee36d652006-04-11 09:08:02 +00005289 ptr = (char *)type->tp_as_mapping;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005290 offset -= offsetof(PyHeapTypeObject, as_mapping);
Guido van Rossum09638c12002-06-13 19:17:46 +00005291 }
Skip Montanaro429433b2006-04-18 00:35:43 +00005292 else if ((size_t)offset >= offsetof(PyHeapTypeObject, as_number)) {
Martin v. Löwisee36d652006-04-11 09:08:02 +00005293 ptr = (char *)type->tp_as_number;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005294 offset -= offsetof(PyHeapTypeObject, as_number);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005295 }
5296 else {
Martin v. Löwisee36d652006-04-11 09:08:02 +00005297 ptr = (char *)type;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005298 }
5299 if (ptr != NULL)
5300 ptr += offset;
5301 return (void **)ptr;
5302}
Guido van Rossumf040ede2001-08-07 16:40:56 +00005303
Guido van Rossumc334df52002-04-04 23:44:47 +00005304/* Length of array of slotdef pointers used to store slots with the
5305 same __name__. There should be at most MAX_EQUIV-1 slotdef entries with
5306 the same __name__, for any __name__. Since that's a static property, it is
5307 appropriate to declare fixed-size arrays for this. */
5308#define MAX_EQUIV 10
5309
5310/* Return a slot pointer for a given name, but ONLY if the attribute has
5311 exactly one slot function. The name must be an interned string. */
5312static void **
5313resolve_slotdups(PyTypeObject *type, PyObject *name)
5314{
5315 /* XXX Maybe this could be optimized more -- but is it worth it? */
5316
5317 /* pname and ptrs act as a little cache */
5318 static PyObject *pname;
5319 static slotdef *ptrs[MAX_EQUIV];
5320 slotdef *p, **pp;
5321 void **res, **ptr;
5322
5323 if (pname != name) {
5324 /* Collect all slotdefs that match name into ptrs. */
5325 pname = name;
5326 pp = ptrs;
5327 for (p = slotdefs; p->name_strobj; p++) {
5328 if (p->name_strobj == name)
5329 *pp++ = p;
5330 }
5331 *pp = NULL;
5332 }
5333
5334 /* Look in all matching slots of the type; if exactly one of these has
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005335 a filled-in slot, return its value. Otherwise return NULL. */
Guido van Rossumc334df52002-04-04 23:44:47 +00005336 res = NULL;
5337 for (pp = ptrs; *pp; pp++) {
5338 ptr = slotptr(type, (*pp)->offset);
5339 if (ptr == NULL || *ptr == NULL)
5340 continue;
5341 if (res != NULL)
5342 return NULL;
5343 res = ptr;
5344 }
5345 return res;
5346}
5347
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005348/* Common code for update_slots_callback() and fixup_slot_dispatchers(). This
Guido van Rossumc334df52002-04-04 23:44:47 +00005349 does some incredibly complex thinking and then sticks something into the
5350 slot. (It sees if the adjacent slotdefs for the same slot have conflicting
5351 interests, and then stores a generic wrapper or a specific function into
5352 the slot.) Return a pointer to the next slotdef with a different offset,
5353 because that's convenient for fixup_slot_dispatchers(). */
5354static slotdef *
5355update_one_slot(PyTypeObject *type, slotdef *p)
5356{
5357 PyObject *descr;
5358 PyWrapperDescrObject *d;
5359 void *generic = NULL, *specific = NULL;
5360 int use_generic = 0;
5361 int offset = p->offset;
5362 void **ptr = slotptr(type, offset);
5363
5364 if (ptr == NULL) {
5365 do {
5366 ++p;
5367 } while (p->offset == offset);
5368 return p;
5369 }
5370 do {
5371 descr = _PyType_Lookup(type, p->name_strobj);
5372 if (descr == NULL)
5373 continue;
5374 if (descr->ob_type == &PyWrapperDescr_Type) {
5375 void **tptr = resolve_slotdups(type, p->name_strobj);
5376 if (tptr == NULL || tptr == ptr)
5377 generic = p->function;
5378 d = (PyWrapperDescrObject *)descr;
5379 if (d->d_base->wrapper == p->wrapper &&
5380 PyType_IsSubtype(type, d->d_type))
5381 {
5382 if (specific == NULL ||
5383 specific == d->d_wrapped)
5384 specific = d->d_wrapped;
5385 else
5386 use_generic = 1;
5387 }
5388 }
Guido van Rossum721f62e2002-08-09 02:14:34 +00005389 else if (descr->ob_type == &PyCFunction_Type &&
5390 PyCFunction_GET_FUNCTION(descr) ==
5391 (PyCFunction)tp_new_wrapper &&
5392 strcmp(p->name, "__new__") == 0)
5393 {
5394 /* The __new__ wrapper is not a wrapper descriptor,
5395 so must be special-cased differently.
5396 If we don't do this, creating an instance will
5397 always use slot_tp_new which will look up
5398 __new__ in the MRO which will call tp_new_wrapper
5399 which will look through the base classes looking
5400 for a static base and call its tp_new (usually
5401 PyType_GenericNew), after performing various
5402 sanity checks and constructing a new argument
5403 list. Cut all that nonsense short -- this speeds
5404 up instance creation tremendously. */
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005405 specific = (void *)type->tp_new;
Guido van Rossum721f62e2002-08-09 02:14:34 +00005406 /* XXX I'm not 100% sure that there isn't a hole
5407 in this reasoning that requires additional
5408 sanity checks. I'll buy the first person to
5409 point out a bug in this reasoning a beer. */
5410 }
Guido van Rossumc334df52002-04-04 23:44:47 +00005411 else {
5412 use_generic = 1;
5413 generic = p->function;
5414 }
5415 } while ((++p)->offset == offset);
5416 if (specific && !use_generic)
5417 *ptr = specific;
5418 else
5419 *ptr = generic;
5420 return p;
5421}
5422
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005423/* In the type, update the slots whose slotdefs are gathered in the pp array.
5424 This is a callback for update_subclasses(). */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005425static int
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005426update_slots_callback(PyTypeObject *type, void *data)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005427{
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005428 slotdef **pp = (slotdef **)data;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005429
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005430 for (; *pp; pp++)
Guido van Rossumc334df52002-04-04 23:44:47 +00005431 update_one_slot(type, *pp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005432 return 0;
5433}
5434
Guido van Rossumc334df52002-04-04 23:44:47 +00005435/* Comparison function for qsort() to compare slotdefs by their offset, and
5436 for equal offset by their address (to force a stable sort). */
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005437static int
5438slotdef_cmp(const void *aa, const void *bb)
5439{
5440 const slotdef *a = (const slotdef *)aa, *b = (const slotdef *)bb;
5441 int c = a->offset - b->offset;
5442 if (c != 0)
5443 return c;
5444 else
Martin v. Löwis18e16552006-02-15 17:27:45 +00005445 /* Cannot use a-b, as this gives off_t,
5446 which may lose precision when converted to int. */
5447 return (a > b) ? 1 : (a < b) ? -1 : 0;
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005448}
5449
Guido van Rossumc334df52002-04-04 23:44:47 +00005450/* Initialize the slotdefs table by adding interned string objects for the
5451 names and sorting the entries. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005452static void
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005453init_slotdefs(void)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005454{
5455 slotdef *p;
5456 static int initialized = 0;
5457
5458 if (initialized)
5459 return;
5460 for (p = slotdefs; p->name; p++) {
5461 p->name_strobj = PyString_InternFromString(p->name);
5462 if (!p->name_strobj)
Guido van Rossumc334df52002-04-04 23:44:47 +00005463 Py_FatalError("Out of memory interning slotdef names");
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005464 }
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005465 qsort((void *)slotdefs, (size_t)(p-slotdefs), sizeof(slotdef),
5466 slotdef_cmp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005467 initialized = 1;
5468}
5469
Guido van Rossumc334df52002-04-04 23:44:47 +00005470/* Update the slots after assignment to a class (type) attribute. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005471static int
5472update_slot(PyTypeObject *type, PyObject *name)
5473{
Guido van Rossumc334df52002-04-04 23:44:47 +00005474 slotdef *ptrs[MAX_EQUIV];
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005475 slotdef *p;
5476 slotdef **pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005477 int offset;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005478
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005479 init_slotdefs();
5480 pp = ptrs;
5481 for (p = slotdefs; p->name; p++) {
5482 /* XXX assume name is interned! */
5483 if (p->name_strobj == name)
5484 *pp++ = p;
5485 }
5486 *pp = NULL;
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005487 for (pp = ptrs; *pp; pp++) {
5488 p = *pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005489 offset = p->offset;
5490 while (p > slotdefs && (p-1)->offset == offset)
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005491 --p;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005492 *pp = p;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005493 }
Guido van Rossumc334df52002-04-04 23:44:47 +00005494 if (ptrs[0] == NULL)
5495 return 0; /* Not an attribute that affects any slots */
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005496 return update_subclasses(type, name,
5497 update_slots_callback, (void *)ptrs);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005498}
5499
Guido van Rossumc334df52002-04-04 23:44:47 +00005500/* Store the proper functions in the slot dispatches at class (type)
5501 definition time, based upon which operations the class overrides in its
5502 dict. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00005503static void
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005504fixup_slot_dispatchers(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00005505{
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005506 slotdef *p;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005507
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005508 init_slotdefs();
Guido van Rossumc334df52002-04-04 23:44:47 +00005509 for (p = slotdefs; p->name; )
5510 p = update_one_slot(type, p);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005511}
Guido van Rossum705f0f52001-08-24 16:47:00 +00005512
Michael W. Hudson98bbc492002-11-26 14:47:27 +00005513static void
5514update_all_slots(PyTypeObject* type)
5515{
5516 slotdef *p;
5517
5518 init_slotdefs();
5519 for (p = slotdefs; p->name; p++) {
5520 /* update_slot returns int but can't actually fail */
5521 update_slot(type, p->name_strobj);
5522 }
5523}
5524
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005525/* recurse_down_subclasses() and update_subclasses() are mutually
5526 recursive functions to call a callback for all subclasses,
5527 but refraining from recursing into subclasses that define 'name'. */
5528
5529static int
5530update_subclasses(PyTypeObject *type, PyObject *name,
5531 update_callback callback, void *data)
5532{
5533 if (callback(type, data) < 0)
5534 return -1;
5535 return recurse_down_subclasses(type, name, callback, data);
5536}
5537
5538static int
5539recurse_down_subclasses(PyTypeObject *type, PyObject *name,
5540 update_callback callback, void *data)
5541{
5542 PyTypeObject *subclass;
5543 PyObject *ref, *subclasses, *dict;
Martin v. Löwis18e16552006-02-15 17:27:45 +00005544 Py_ssize_t i, n;
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005545
5546 subclasses = type->tp_subclasses;
5547 if (subclasses == NULL)
5548 return 0;
5549 assert(PyList_Check(subclasses));
5550 n = PyList_GET_SIZE(subclasses);
5551 for (i = 0; i < n; i++) {
5552 ref = PyList_GET_ITEM(subclasses, i);
5553 assert(PyWeakref_CheckRef(ref));
5554 subclass = (PyTypeObject *)PyWeakref_GET_OBJECT(ref);
5555 assert(subclass != NULL);
5556 if ((PyObject *)subclass == Py_None)
5557 continue;
5558 assert(PyType_Check(subclass));
5559 /* Avoid recursing down into unaffected classes */
5560 dict = subclass->tp_dict;
5561 if (dict != NULL && PyDict_Check(dict) &&
5562 PyDict_GetItem(dict, name) != NULL)
5563 continue;
5564 if (update_subclasses(subclass, name, callback, data) < 0)
5565 return -1;
5566 }
5567 return 0;
5568}
5569
Guido van Rossum6d204072001-10-21 00:44:31 +00005570/* This function is called by PyType_Ready() to populate the type's
5571 dictionary with method descriptors for function slots. For each
Guido van Rossum09638c12002-06-13 19:17:46 +00005572 function slot (like tp_repr) that's defined in the type, one or more
5573 corresponding descriptors are added in the type's tp_dict dictionary
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005574 under the appropriate name (like __repr__). Some function slots
Guido van Rossum09638c12002-06-13 19:17:46 +00005575 cause more than one descriptor to be added (for example, the nb_add
5576 slot adds both __add__ and __radd__ descriptors) and some function
5577 slots compete for the same descriptor (for example both sq_item and
5578 mp_subscript generate a __getitem__ descriptor).
5579
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005580 In the latter case, the first slotdef entry encoutered wins. Since
Tim Petersbf9b2442003-03-23 05:35:36 +00005581 slotdef entries are sorted by the offset of the slot in the
Guido van Rossume5c691a2003-03-07 15:13:17 +00005582 PyHeapTypeObject, this gives us some control over disambiguating
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005583 between competing slots: the members of PyHeapTypeObject are listed
5584 from most general to least general, so the most general slot is
5585 preferred. In particular, because as_mapping comes before as_sequence,
5586 for a type that defines both mp_subscript and sq_item, mp_subscript
5587 wins.
Guido van Rossum09638c12002-06-13 19:17:46 +00005588
5589 This only adds new descriptors and doesn't overwrite entries in
5590 tp_dict that were previously defined. The descriptors contain a
5591 reference to the C function they must call, so that it's safe if they
5592 are copied into a subtype's __dict__ and the subtype has a different
5593 C function in its slot -- calling the method defined by the
5594 descriptor will call the C function that was used to create it,
5595 rather than the C function present in the slot when it is called.
5596 (This is important because a subtype may have a C function in the
5597 slot that calls the method from the dictionary, and we want to avoid
5598 infinite recursion here.) */
Guido van Rossum6d204072001-10-21 00:44:31 +00005599
5600static int
5601add_operators(PyTypeObject *type)
5602{
5603 PyObject *dict = type->tp_dict;
5604 slotdef *p;
5605 PyObject *descr;
5606 void **ptr;
5607
5608 init_slotdefs();
5609 for (p = slotdefs; p->name; p++) {
5610 if (p->wrapper == NULL)
5611 continue;
5612 ptr = slotptr(type, p->offset);
5613 if (!ptr || !*ptr)
5614 continue;
5615 if (PyDict_GetItem(dict, p->name_strobj))
5616 continue;
5617 descr = PyDescr_NewWrapper(type, p, *ptr);
5618 if (descr == NULL)
5619 return -1;
5620 if (PyDict_SetItem(dict, p->name_strobj, descr) < 0)
5621 return -1;
5622 Py_DECREF(descr);
5623 }
5624 if (type->tp_new != NULL) {
5625 if (add_tp_new_wrapper(type) < 0)
5626 return -1;
5627 }
5628 return 0;
5629}
5630
Guido van Rossum705f0f52001-08-24 16:47:00 +00005631
5632/* Cooperative 'super' */
5633
5634typedef struct {
5635 PyObject_HEAD
Guido van Rossume705ef12001-08-29 15:47:06 +00005636 PyTypeObject *type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005637 PyObject *obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005638 PyTypeObject *obj_type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005639} superobject;
5640
Guido van Rossum6f799372001-09-20 20:46:19 +00005641static PyMemberDef super_members[] = {
5642 {"__thisclass__", T_OBJECT, offsetof(superobject, type), READONLY,
5643 "the class invoking super()"},
5644 {"__self__", T_OBJECT, offsetof(superobject, obj), READONLY,
5645 "the instance invoking super(); may be None"},
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005646 {"__self_class__", T_OBJECT, offsetof(superobject, obj_type), READONLY,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +00005647 "the type of the instance invoking super(); may be None"},
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005648 {0}
5649};
5650
Guido van Rossum705f0f52001-08-24 16:47:00 +00005651static void
5652super_dealloc(PyObject *self)
5653{
5654 superobject *su = (superobject *)self;
5655
Guido van Rossum048eb752001-10-02 21:24:57 +00005656 _PyObject_GC_UNTRACK(self);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005657 Py_XDECREF(su->obj);
5658 Py_XDECREF(su->type);
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005659 Py_XDECREF(su->obj_type);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005660 self->ob_type->tp_free(self);
5661}
5662
5663static PyObject *
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005664super_repr(PyObject *self)
5665{
5666 superobject *su = (superobject *)self;
5667
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005668 if (su->obj_type)
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005669 return PyString_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00005670 "<super: <class '%s'>, <%s object>>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005671 su->type ? su->type->tp_name : "NULL",
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005672 su->obj_type->tp_name);
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005673 else
5674 return PyString_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00005675 "<super: <class '%s'>, NULL>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005676 su->type ? su->type->tp_name : "NULL");
5677}
5678
5679static PyObject *
Guido van Rossum705f0f52001-08-24 16:47:00 +00005680super_getattro(PyObject *self, PyObject *name)
5681{
5682 superobject *su = (superobject *)self;
Guido van Rossum76ba09f2003-04-16 19:40:58 +00005683 int skip = su->obj_type == NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005684
Guido van Rossum76ba09f2003-04-16 19:40:58 +00005685 if (!skip) {
5686 /* We want __class__ to return the class of the super object
5687 (i.e. super, or a subclass), not the class of su->obj. */
5688 skip = (PyString_Check(name) &&
5689 PyString_GET_SIZE(name) == 9 &&
5690 strcmp(PyString_AS_STRING(name), "__class__") == 0);
5691 }
5692
5693 if (!skip) {
Tim Petersa91e9642001-11-14 23:32:33 +00005694 PyObject *mro, *res, *tmp, *dict;
Guido van Rossum155db9a2002-04-02 17:53:47 +00005695 PyTypeObject *starttype;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005696 descrgetfunc f;
Martin v. Löwis18e16552006-02-15 17:27:45 +00005697 Py_ssize_t i, n;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005698
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005699 starttype = su->obj_type;
Guido van Rossum155db9a2002-04-02 17:53:47 +00005700 mro = starttype->tp_mro;
5701
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005702 if (mro == NULL)
5703 n = 0;
5704 else {
5705 assert(PyTuple_Check(mro));
5706 n = PyTuple_GET_SIZE(mro);
5707 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005708 for (i = 0; i < n; i++) {
Guido van Rossume705ef12001-08-29 15:47:06 +00005709 if ((PyObject *)(su->type) == PyTuple_GET_ITEM(mro, i))
Guido van Rossum705f0f52001-08-24 16:47:00 +00005710 break;
5711 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005712 i++;
5713 res = NULL;
5714 for (; i < n; i++) {
5715 tmp = PyTuple_GET_ITEM(mro, i);
Tim Petersa91e9642001-11-14 23:32:33 +00005716 if (PyType_Check(tmp))
5717 dict = ((PyTypeObject *)tmp)->tp_dict;
5718 else if (PyClass_Check(tmp))
5719 dict = ((PyClassObject *)tmp)->cl_dict;
5720 else
5721 continue;
5722 res = PyDict_GetItem(dict, name);
Guido van Rossum6cc5bb62003-04-16 20:01:36 +00005723 if (res != NULL) {
Guido van Rossum705f0f52001-08-24 16:47:00 +00005724 Py_INCREF(res);
5725 f = res->ob_type->tp_descr_get;
5726 if (f != NULL) {
Phillip J. Eby91a968a2004-03-25 02:19:34 +00005727 tmp = f(res,
5728 /* Only pass 'obj' param if
5729 this is instance-mode super
5730 (See SF ID #743627)
5731 */
Hye-Shik Changff365c92004-03-25 16:37:03 +00005732 (su->obj == (PyObject *)
5733 su->obj_type
Phillip J. Eby91a968a2004-03-25 02:19:34 +00005734 ? (PyObject *)NULL
5735 : su->obj),
Guido van Rossumd4641072002-04-03 02:13:37 +00005736 (PyObject *)starttype);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005737 Py_DECREF(res);
5738 res = tmp;
5739 }
5740 return res;
5741 }
5742 }
5743 }
5744 return PyObject_GenericGetAttr(self, name);
5745}
5746
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005747static PyTypeObject *
Guido van Rossum5b443c62001-12-03 15:38:28 +00005748supercheck(PyTypeObject *type, PyObject *obj)
5749{
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005750 /* Check that a super() call makes sense. Return a type object.
5751
5752 obj can be a new-style class, or an instance of one:
5753
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005754 - If it is a class, it must be a subclass of 'type'. This case is
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005755 used for class methods; the return value is obj.
5756
5757 - If it is an instance, it must be an instance of 'type'. This is
5758 the normal case; the return value is obj.__class__.
5759
5760 But... when obj is an instance, we want to allow for the case where
5761 obj->ob_type is not a subclass of type, but obj.__class__ is!
5762 This will allow using super() with a proxy for obj.
5763 */
5764
Guido van Rossum8e80a722003-02-18 19:22:22 +00005765 /* Check for first bullet above (special case) */
5766 if (PyType_Check(obj) && PyType_IsSubtype((PyTypeObject *)obj, type)) {
5767 Py_INCREF(obj);
5768 return (PyTypeObject *)obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005769 }
Guido van Rossum8e80a722003-02-18 19:22:22 +00005770
5771 /* Normal case */
5772 if (PyType_IsSubtype(obj->ob_type, type)) {
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005773 Py_INCREF(obj->ob_type);
5774 return obj->ob_type;
5775 }
5776 else {
5777 /* Try the slow way */
5778 static PyObject *class_str = NULL;
5779 PyObject *class_attr;
5780
5781 if (class_str == NULL) {
5782 class_str = PyString_FromString("__class__");
5783 if (class_str == NULL)
5784 return NULL;
5785 }
5786
5787 class_attr = PyObject_GetAttr(obj, class_str);
5788
5789 if (class_attr != NULL &&
5790 PyType_Check(class_attr) &&
5791 (PyTypeObject *)class_attr != obj->ob_type)
5792 {
5793 int ok = PyType_IsSubtype(
5794 (PyTypeObject *)class_attr, type);
5795 if (ok)
5796 return (PyTypeObject *)class_attr;
5797 }
5798
5799 if (class_attr == NULL)
5800 PyErr_Clear();
5801 else
5802 Py_DECREF(class_attr);
5803 }
5804
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005805 PyErr_SetString(PyExc_TypeError,
Guido van Rossum5b443c62001-12-03 15:38:28 +00005806 "super(type, obj): "
5807 "obj must be an instance or subtype of type");
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005808 return NULL;
Guido van Rossum5b443c62001-12-03 15:38:28 +00005809}
5810
Guido van Rossum705f0f52001-08-24 16:47:00 +00005811static PyObject *
5812super_descr_get(PyObject *self, PyObject *obj, PyObject *type)
5813{
5814 superobject *su = (superobject *)self;
Anthony Baxtera6286212006-04-11 07:42:36 +00005815 superobject *newobj;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005816
5817 if (obj == NULL || obj == Py_None || su->obj != NULL) {
5818 /* Not binding to an object, or already bound */
5819 Py_INCREF(self);
5820 return self;
5821 }
Guido van Rossum5b443c62001-12-03 15:38:28 +00005822 if (su->ob_type != &PySuper_Type)
Armin Rigo7726dc02005-05-15 15:32:08 +00005823 /* If su is an instance of a (strict) subclass of super,
Guido van Rossum5b443c62001-12-03 15:38:28 +00005824 call its type */
Georg Brandl684fd0c2006-05-25 19:15:31 +00005825 return PyObject_CallFunctionObjArgs((PyObject *)su->ob_type,
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005826 su->type, obj, NULL);
Guido van Rossum5b443c62001-12-03 15:38:28 +00005827 else {
5828 /* Inline the common case */
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005829 PyTypeObject *obj_type = supercheck(su->type, obj);
5830 if (obj_type == NULL)
Guido van Rossum5b443c62001-12-03 15:38:28 +00005831 return NULL;
Anthony Baxtera6286212006-04-11 07:42:36 +00005832 newobj = (superobject *)PySuper_Type.tp_new(&PySuper_Type,
Guido van Rossum5b443c62001-12-03 15:38:28 +00005833 NULL, NULL);
Anthony Baxtera6286212006-04-11 07:42:36 +00005834 if (newobj == NULL)
Guido van Rossum5b443c62001-12-03 15:38:28 +00005835 return NULL;
5836 Py_INCREF(su->type);
5837 Py_INCREF(obj);
Anthony Baxtera6286212006-04-11 07:42:36 +00005838 newobj->type = su->type;
5839 newobj->obj = obj;
5840 newobj->obj_type = obj_type;
5841 return (PyObject *)newobj;
Guido van Rossum5b443c62001-12-03 15:38:28 +00005842 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005843}
5844
5845static int
5846super_init(PyObject *self, PyObject *args, PyObject *kwds)
5847{
5848 superobject *su = (superobject *)self;
Guido van Rossume705ef12001-08-29 15:47:06 +00005849 PyTypeObject *type;
5850 PyObject *obj = NULL;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005851 PyTypeObject *obj_type = NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005852
Georg Brandl5d59c092006-09-30 08:43:30 +00005853 if (!_PyArg_NoKeywords("super", kwds))
5854 return -1;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005855 if (!PyArg_ParseTuple(args, "O!|O:super", &PyType_Type, &type, &obj))
5856 return -1;
5857 if (obj == Py_None)
5858 obj = NULL;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005859 if (obj != NULL) {
5860 obj_type = supercheck(type, obj);
5861 if (obj_type == NULL)
5862 return -1;
5863 Py_INCREF(obj);
5864 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005865 Py_INCREF(type);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005866 su->type = type;
5867 su->obj = obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005868 su->obj_type = obj_type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005869 return 0;
5870}
5871
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005872PyDoc_STRVAR(super_doc,
Guido van Rossum705f0f52001-08-24 16:47:00 +00005873"super(type) -> unbound super object\n"
5874"super(type, obj) -> bound super object; requires isinstance(obj, type)\n"
Guido van Rossume705ef12001-08-29 15:47:06 +00005875"super(type, type2) -> bound super object; requires issubclass(type2, type)\n"
Guido van Rossum705f0f52001-08-24 16:47:00 +00005876"Typical use to call a cooperative superclass method:\n"
5877"class C(B):\n"
5878" def meth(self, arg):\n"
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005879" super(C, self).meth(arg)");
Guido van Rossum705f0f52001-08-24 16:47:00 +00005880
Guido van Rossum048eb752001-10-02 21:24:57 +00005881static int
5882super_traverse(PyObject *self, visitproc visit, void *arg)
5883{
5884 superobject *su = (superobject *)self;
Guido van Rossum048eb752001-10-02 21:24:57 +00005885
Thomas Woutersc6e55062006-04-15 21:47:09 +00005886 Py_VISIT(su->obj);
5887 Py_VISIT(su->type);
5888 Py_VISIT(su->obj_type);
Guido van Rossum048eb752001-10-02 21:24:57 +00005889
5890 return 0;
5891}
5892
Guido van Rossum705f0f52001-08-24 16:47:00 +00005893PyTypeObject PySuper_Type = {
5894 PyObject_HEAD_INIT(&PyType_Type)
5895 0, /* ob_size */
5896 "super", /* tp_name */
5897 sizeof(superobject), /* tp_basicsize */
5898 0, /* tp_itemsize */
5899 /* methods */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005900 super_dealloc, /* tp_dealloc */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005901 0, /* tp_print */
5902 0, /* tp_getattr */
5903 0, /* tp_setattr */
5904 0, /* tp_compare */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005905 super_repr, /* tp_repr */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005906 0, /* tp_as_number */
5907 0, /* tp_as_sequence */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005908 0, /* tp_as_mapping */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005909 0, /* tp_hash */
5910 0, /* tp_call */
5911 0, /* tp_str */
5912 super_getattro, /* tp_getattro */
5913 0, /* tp_setattro */
5914 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00005915 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
5916 Py_TPFLAGS_BASETYPE, /* tp_flags */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005917 super_doc, /* tp_doc */
5918 super_traverse, /* tp_traverse */
5919 0, /* tp_clear */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005920 0, /* tp_richcompare */
5921 0, /* tp_weaklistoffset */
5922 0, /* tp_iter */
5923 0, /* tp_iternext */
5924 0, /* tp_methods */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005925 super_members, /* tp_members */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005926 0, /* tp_getset */
5927 0, /* tp_base */
5928 0, /* tp_dict */
5929 super_descr_get, /* tp_descr_get */
5930 0, /* tp_descr_set */
5931 0, /* tp_dictoffset */
5932 super_init, /* tp_init */
5933 PyType_GenericAlloc, /* tp_alloc */
5934 PyType_GenericNew, /* tp_new */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005935 PyObject_GC_Del, /* tp_free */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005936};