blob: e790c0486dbf9c30e5e4bcf7433229452e7c77ef [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'",
Christian Heimese93237d2007-12-19 02:37:44 +000060 type->tp_name, Py_TYPE(value)->tp_name);
Michael W. Hudson98bbc492002-11-26 14:47:27 +000061 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
130static PyTypeObject *best_base(PyObject *);
131static int mro_internal(PyTypeObject *);
132static int compatible_for_assignment(PyTypeObject *, PyTypeObject *, char *);
133static int add_subclass(PyTypeObject*, PyTypeObject*);
134static void remove_subclass(PyTypeObject *, PyTypeObject *);
135static void update_all_slots(PyTypeObject *);
136
Guido van Rossum8d24ee92003-03-24 23:49:49 +0000137typedef int (*update_callback)(PyTypeObject *, void *);
138static int update_subclasses(PyTypeObject *type, PyObject *name,
139 update_callback callback, void *data);
140static int recurse_down_subclasses(PyTypeObject *type, PyObject *name,
141 update_callback callback, void *data);
142
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000143static int
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000144mro_subclasses(PyTypeObject *type, PyObject* temp)
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000145{
146 PyTypeObject *subclass;
147 PyObject *ref, *subclasses, *old_mro;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000148 Py_ssize_t i, n;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000149
150 subclasses = type->tp_subclasses;
151 if (subclasses == NULL)
152 return 0;
153 assert(PyList_Check(subclasses));
154 n = PyList_GET_SIZE(subclasses);
155 for (i = 0; i < n; i++) {
156 ref = PyList_GET_ITEM(subclasses, i);
157 assert(PyWeakref_CheckRef(ref));
158 subclass = (PyTypeObject *)PyWeakref_GET_OBJECT(ref);
159 assert(subclass != NULL);
160 if ((PyObject *)subclass == Py_None)
161 continue;
162 assert(PyType_Check(subclass));
163 old_mro = subclass->tp_mro;
164 if (mro_internal(subclass) < 0) {
165 subclass->tp_mro = old_mro;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000166 return -1;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000167 }
168 else {
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000169 PyObject* tuple;
Raymond Hettinger8ae46892003-10-12 19:09:37 +0000170 tuple = PyTuple_Pack(2, subclass, old_mro);
Guido van Rossum19a02ba2003-04-15 22:09:45 +0000171 Py_DECREF(old_mro);
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000172 if (!tuple)
173 return -1;
174 if (PyList_Append(temp, tuple) < 0)
175 return -1;
Guido van Rossum19a02ba2003-04-15 22:09:45 +0000176 Py_DECREF(tuple);
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000177 }
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000178 if (mro_subclasses(subclass, temp) < 0)
179 return -1;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000180 }
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000181 return 0;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000182}
183
184static int
185type_set_bases(PyTypeObject *type, PyObject *value, void *context)
186{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000187 Py_ssize_t i;
188 int r = 0;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000189 PyObject *ob, *temp;
Armin Rigoc0ba52d2007-04-19 14:44:48 +0000190 PyTypeObject *new_base, *old_base;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000191 PyObject *old_bases, *old_mro;
192
193 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
194 PyErr_Format(PyExc_TypeError,
195 "can't set %s.__bases__", type->tp_name);
196 return -1;
197 }
198 if (!value) {
199 PyErr_Format(PyExc_TypeError,
200 "can't delete %s.__bases__", type->tp_name);
201 return -1;
202 }
203 if (!PyTuple_Check(value)) {
204 PyErr_Format(PyExc_TypeError,
205 "can only assign tuple to %s.__bases__, not %s",
Christian Heimese93237d2007-12-19 02:37:44 +0000206 type->tp_name, Py_TYPE(value)->tp_name);
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000207 return -1;
208 }
Guido van Rossum3bbc0ee2002-12-13 17:49:38 +0000209 if (PyTuple_GET_SIZE(value) == 0) {
210 PyErr_Format(PyExc_TypeError,
211 "can only assign non-empty tuple to %s.__bases__, not ()",
212 type->tp_name);
213 return -1;
214 }
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000215 for (i = 0; i < PyTuple_GET_SIZE(value); i++) {
216 ob = PyTuple_GET_ITEM(value, i);
217 if (!PyClass_Check(ob) && !PyType_Check(ob)) {
218 PyErr_Format(
219 PyExc_TypeError,
220 "%s.__bases__ must be tuple of old- or new-style classes, not '%s'",
Christian Heimese93237d2007-12-19 02:37:44 +0000221 type->tp_name, Py_TYPE(ob)->tp_name);
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000222 return -1;
223 }
Michael W. Hudsoncaf17be2002-11-27 10:24:44 +0000224 if (PyType_Check(ob)) {
225 if (PyType_IsSubtype((PyTypeObject*)ob, type)) {
226 PyErr_SetString(PyExc_TypeError,
227 "a __bases__ item causes an inheritance cycle");
228 return -1;
229 }
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000230 }
231 }
232
233 new_base = best_base(value);
234
235 if (!new_base) {
236 return -1;
237 }
238
239 if (!compatible_for_assignment(type->tp_base, new_base, "__bases__"))
240 return -1;
241
242 Py_INCREF(new_base);
243 Py_INCREF(value);
244
245 old_bases = type->tp_bases;
246 old_base = type->tp_base;
247 old_mro = type->tp_mro;
248
249 type->tp_bases = value;
250 type->tp_base = new_base;
251
252 if (mro_internal(type) < 0) {
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000253 goto bail;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000254 }
255
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000256 temp = PyList_New(0);
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000257 if (!temp)
258 goto bail;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000259
260 r = mro_subclasses(type, temp);
261
262 if (r < 0) {
263 for (i = 0; i < PyList_Size(temp); i++) {
264 PyTypeObject* cls;
265 PyObject* mro;
Raymond Hettinger8ae46892003-10-12 19:09:37 +0000266 PyArg_UnpackTuple(PyList_GET_ITEM(temp, i),
267 "", 2, 2, &cls, &mro);
Armin Rigo796fc992007-04-19 14:56:48 +0000268 Py_INCREF(mro);
269 ob = cls->tp_mro;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000270 cls->tp_mro = mro;
Armin Rigo796fc992007-04-19 14:56:48 +0000271 Py_DECREF(ob);
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000272 }
273 Py_DECREF(temp);
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000274 goto bail;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000275 }
276
277 Py_DECREF(temp);
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000278
279 /* any base that was in __bases__ but now isn't, we
Raymond Hettingera8285862002-12-14 17:17:56 +0000280 need to remove |type| from its tp_subclasses.
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000281 conversely, any class now in __bases__ that wasn't
Raymond Hettingera8285862002-12-14 17:17:56 +0000282 needs to have |type| added to its subclasses. */
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000283
284 /* for now, sod that: just remove from all old_bases,
285 add to all new_bases */
286
287 for (i = PyTuple_GET_SIZE(old_bases) - 1; i >= 0; i--) {
288 ob = PyTuple_GET_ITEM(old_bases, i);
289 if (PyType_Check(ob)) {
290 remove_subclass(
291 (PyTypeObject*)ob, type);
292 }
293 }
294
295 for (i = PyTuple_GET_SIZE(value) - 1; i >= 0; i--) {
296 ob = PyTuple_GET_ITEM(value, i);
297 if (PyType_Check(ob)) {
298 if (add_subclass((PyTypeObject*)ob, type) < 0)
299 r = -1;
300 }
301 }
302
303 update_all_slots(type);
304
305 Py_DECREF(old_bases);
306 Py_DECREF(old_base);
307 Py_DECREF(old_mro);
308
309 return r;
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000310
311 bail:
Michael W. Hudsone723e452003-08-07 14:58:10 +0000312 Py_DECREF(type->tp_bases);
313 Py_DECREF(type->tp_base);
314 if (type->tp_mro != old_mro) {
315 Py_DECREF(type->tp_mro);
316 }
317
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000318 type->tp_bases = old_bases;
319 type->tp_base = old_base;
320 type->tp_mro = old_mro;
Tim Petersea7f75d2002-12-07 21:39:16 +0000321
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000322 return -1;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000323}
324
325static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000326type_dict(PyTypeObject *type, void *context)
327{
328 if (type->tp_dict == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000329 Py_INCREF(Py_None);
330 return Py_None;
Guido van Rossum29ca26e1995-01-07 11:58:15 +0000331 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000332 return PyDictProxy_New(type->tp_dict);
Guido van Rossum29ca26e1995-01-07 11:58:15 +0000333}
334
Tim Peters24008312002-03-17 18:56:20 +0000335static PyObject *
336type_get_doc(PyTypeObject *type, void *context)
337{
338 PyObject *result;
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000339 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE) && type->tp_doc != NULL)
Tim Peters24008312002-03-17 18:56:20 +0000340 return PyString_FromString(type->tp_doc);
Tim Peters24008312002-03-17 18:56:20 +0000341 result = PyDict_GetItemString(type->tp_dict, "__doc__");
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000342 if (result == NULL) {
343 result = Py_None;
344 Py_INCREF(result);
345 }
Christian Heimese93237d2007-12-19 02:37:44 +0000346 else if (Py_TYPE(result)->tp_descr_get) {
347 result = Py_TYPE(result)->tp_descr_get(result, NULL,
Tim Peters2b858972002-04-18 04:12:28 +0000348 (PyObject *)type);
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000349 }
350 else {
351 Py_INCREF(result);
352 }
Tim Peters24008312002-03-17 18:56:20 +0000353 return result;
354}
355
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000356static PyGetSetDef type_getsets[] = {
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000357 {"__name__", (getter)type_name, (setter)type_set_name, NULL},
358 {"__bases__", (getter)type_get_bases, (setter)type_set_bases, NULL},
Guido van Rossum3926a632001-09-25 16:25:58 +0000359 {"__module__", (getter)type_module, (setter)type_set_module, NULL},
Tim Peters6d6c1a32001-08-02 04:15:00 +0000360 {"__dict__", (getter)type_dict, NULL, NULL},
Tim Peters24008312002-03-17 18:56:20 +0000361 {"__doc__", (getter)type_get_doc, NULL, NULL},
Tim Peters6d6c1a32001-08-02 04:15:00 +0000362 {0}
363};
364
Martin v. Löwis0163d6d2001-06-09 07:34:05 +0000365static int
366type_compare(PyObject *v, PyObject *w)
367{
368 /* This is called with type objects only. So we
369 can just compare the addresses. */
370 Py_uintptr_t vv = (Py_uintptr_t)v;
371 Py_uintptr_t ww = (Py_uintptr_t)w;
372 return (vv < ww) ? -1 : (vv > ww) ? 1 : 0;
373}
374
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000375static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000376type_repr(PyTypeObject *type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000377{
Barry Warsaw7ce36942001-08-24 18:34:26 +0000378 PyObject *mod, *name, *rtn;
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000379 char *kind;
Guido van Rossumc3542212001-08-16 09:18:56 +0000380
381 mod = type_module(type, NULL);
382 if (mod == NULL)
383 PyErr_Clear();
384 else if (!PyString_Check(mod)) {
385 Py_DECREF(mod);
386 mod = NULL;
387 }
388 name = type_name(type, NULL);
389 if (name == NULL)
390 return NULL;
Barry Warsaw7ce36942001-08-24 18:34:26 +0000391
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000392 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
393 kind = "class";
394 else
395 kind = "type";
396
Barry Warsaw7ce36942001-08-24 18:34:26 +0000397 if (mod != NULL && strcmp(PyString_AS_STRING(mod), "__builtin__")) {
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000398 rtn = PyString_FromFormat("<%s '%s.%s'>",
399 kind,
Barry Warsaw7ce36942001-08-24 18:34:26 +0000400 PyString_AS_STRING(mod),
401 PyString_AS_STRING(name));
402 }
Guido van Rossumc3542212001-08-16 09:18:56 +0000403 else
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000404 rtn = PyString_FromFormat("<%s '%s'>", kind, type->tp_name);
Barry Warsaw7ce36942001-08-24 18:34:26 +0000405
Guido van Rossumc3542212001-08-16 09:18:56 +0000406 Py_XDECREF(mod);
407 Py_DECREF(name);
Barry Warsaw7ce36942001-08-24 18:34:26 +0000408 return rtn;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000409}
410
Tim Peters6d6c1a32001-08-02 04:15:00 +0000411static PyObject *
412type_call(PyTypeObject *type, PyObject *args, PyObject *kwds)
413{
414 PyObject *obj;
415
416 if (type->tp_new == NULL) {
417 PyErr_Format(PyExc_TypeError,
418 "cannot create '%.100s' instances",
419 type->tp_name);
420 return NULL;
421 }
422
Tim Peters3f996e72001-09-13 19:18:27 +0000423 obj = type->tp_new(type, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000424 if (obj != NULL) {
Guido van Rossumf76de622001-10-18 15:49:21 +0000425 /* Ugly exception: when the call was type(something),
426 don't call tp_init on the result. */
427 if (type == &PyType_Type &&
428 PyTuple_Check(args) && PyTuple_GET_SIZE(args) == 1 &&
429 (kwds == NULL ||
430 (PyDict_Check(kwds) && PyDict_Size(kwds) == 0)))
431 return obj;
Guido van Rossum8ace1ab2002-04-06 01:05:01 +0000432 /* If the returned object is not an instance of type,
433 it won't be initialized. */
434 if (!PyType_IsSubtype(obj->ob_type, type))
435 return obj;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000436 type = obj->ob_type;
Jeremy Hylton719841e2002-07-16 19:39:38 +0000437 if (PyType_HasFeature(type, Py_TPFLAGS_HAVE_CLASS) &&
438 type->tp_init != NULL &&
Tim Peters6d6c1a32001-08-02 04:15:00 +0000439 type->tp_init(obj, args, kwds) < 0) {
440 Py_DECREF(obj);
441 obj = NULL;
442 }
443 }
444 return obj;
445}
446
447PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000448PyType_GenericAlloc(PyTypeObject *type, Py_ssize_t nitems)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000449{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000450 PyObject *obj;
Guido van Rossume5c691a2003-03-07 15:13:17 +0000451 const size_t size = _PyObject_VAR_SIZE(type, nitems+1);
452 /* note that we need to add one, for the sentinel */
Tim Peters406fe3b2001-10-06 19:04:01 +0000453
454 if (PyType_IS_GC(type))
Neil Schemenauer09a2ae52002-04-12 03:06:53 +0000455 obj = _PyObject_GC_Malloc(size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000456 else
Anthony Baxtera6286212006-04-11 07:42:36 +0000457 obj = (PyObject *)PyObject_MALLOC(size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000458
Neil Schemenauerc806c882001-08-29 23:54:54 +0000459 if (obj == NULL)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000460 return PyErr_NoMemory();
Tim Peters406fe3b2001-10-06 19:04:01 +0000461
Neil Schemenauerc806c882001-08-29 23:54:54 +0000462 memset(obj, '\0', size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000463
Tim Peters6d6c1a32001-08-02 04:15:00 +0000464 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
465 Py_INCREF(type);
Tim Peters406fe3b2001-10-06 19:04:01 +0000466
Tim Peters6d6c1a32001-08-02 04:15:00 +0000467 if (type->tp_itemsize == 0)
468 PyObject_INIT(obj, type);
469 else
470 (void) PyObject_INIT_VAR((PyVarObject *)obj, type, nitems);
Tim Peters406fe3b2001-10-06 19:04:01 +0000471
Tim Peters6d6c1a32001-08-02 04:15:00 +0000472 if (PyType_IS_GC(type))
Neil Schemenauerc806c882001-08-29 23:54:54 +0000473 _PyObject_GC_TRACK(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000474 return obj;
475}
476
477PyObject *
478PyType_GenericNew(PyTypeObject *type, PyObject *args, PyObject *kwds)
479{
480 return type->tp_alloc(type, 0);
481}
482
Guido van Rossum9475a232001-10-05 20:51:39 +0000483/* Helpers for subtyping */
484
485static int
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000486traverse_slots(PyTypeObject *type, PyObject *self, visitproc visit, void *arg)
487{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000488 Py_ssize_t i, n;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000489 PyMemberDef *mp;
490
Christian Heimese93237d2007-12-19 02:37:44 +0000491 n = Py_SIZE(type);
Guido van Rossume5c691a2003-03-07 15:13:17 +0000492 mp = PyHeapType_GET_MEMBERS((PyHeapTypeObject *)type);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000493 for (i = 0; i < n; i++, mp++) {
494 if (mp->type == T_OBJECT_EX) {
495 char *addr = (char *)self + mp->offset;
496 PyObject *obj = *(PyObject **)addr;
497 if (obj != NULL) {
498 int err = visit(obj, arg);
499 if (err)
500 return err;
501 }
502 }
503 }
504 return 0;
505}
506
507static int
Guido van Rossum9475a232001-10-05 20:51:39 +0000508subtype_traverse(PyObject *self, visitproc visit, void *arg)
509{
510 PyTypeObject *type, *base;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000511 traverseproc basetraverse;
Guido van Rossum9475a232001-10-05 20:51:39 +0000512
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000513 /* Find the nearest base with a different tp_traverse,
514 and traverse slots while we're at it */
Christian Heimese93237d2007-12-19 02:37:44 +0000515 type = Py_TYPE(self);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000516 base = type;
517 while ((basetraverse = base->tp_traverse) == subtype_traverse) {
Christian Heimese93237d2007-12-19 02:37:44 +0000518 if (Py_SIZE(base)) {
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000519 int err = traverse_slots(base, self, visit, arg);
520 if (err)
521 return err;
522 }
Guido van Rossum9475a232001-10-05 20:51:39 +0000523 base = base->tp_base;
524 assert(base);
525 }
526
527 if (type->tp_dictoffset != base->tp_dictoffset) {
528 PyObject **dictptr = _PyObject_GetDictPtr(self);
Thomas Woutersc6e55062006-04-15 21:47:09 +0000529 if (dictptr && *dictptr)
530 Py_VISIT(*dictptr);
Guido van Rossum9475a232001-10-05 20:51:39 +0000531 }
532
Thomas Woutersc6e55062006-04-15 21:47:09 +0000533 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
Guido van Rossuma3862092002-06-10 15:24:42 +0000534 /* For a heaptype, the instances count as references
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000535 to the type. Traverse the type so the collector
Guido van Rossuma3862092002-06-10 15:24:42 +0000536 can find cycles involving this link. */
Thomas Woutersc6e55062006-04-15 21:47:09 +0000537 Py_VISIT(type);
Guido van Rossuma3862092002-06-10 15:24:42 +0000538
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000539 if (basetraverse)
540 return basetraverse(self, visit, arg);
541 return 0;
542}
543
544static void
545clear_slots(PyTypeObject *type, PyObject *self)
546{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000547 Py_ssize_t i, n;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000548 PyMemberDef *mp;
549
Christian Heimese93237d2007-12-19 02:37:44 +0000550 n = Py_SIZE(type);
Guido van Rossume5c691a2003-03-07 15:13:17 +0000551 mp = PyHeapType_GET_MEMBERS((PyHeapTypeObject *)type);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000552 for (i = 0; i < n; i++, mp++) {
553 if (mp->type == T_OBJECT_EX && !(mp->flags & READONLY)) {
554 char *addr = (char *)self + mp->offset;
555 PyObject *obj = *(PyObject **)addr;
556 if (obj != NULL) {
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000557 *(PyObject **)addr = NULL;
Thomas Woutersedf17d82006-04-15 17:28:34 +0000558 Py_DECREF(obj);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000559 }
560 }
561 }
562}
563
564static int
565subtype_clear(PyObject *self)
566{
567 PyTypeObject *type, *base;
568 inquiry baseclear;
569
570 /* Find the nearest base with a different tp_clear
571 and clear slots while we're at it */
Christian Heimese93237d2007-12-19 02:37:44 +0000572 type = Py_TYPE(self);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000573 base = type;
574 while ((baseclear = base->tp_clear) == subtype_clear) {
Christian Heimese93237d2007-12-19 02:37:44 +0000575 if (Py_SIZE(base))
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000576 clear_slots(base, self);
577 base = base->tp_base;
578 assert(base);
579 }
580
Guido van Rossuma3862092002-06-10 15:24:42 +0000581 /* There's no need to clear the instance dict (if any);
582 the collector will call its tp_clear handler. */
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000583
584 if (baseclear)
585 return baseclear(self);
Guido van Rossum9475a232001-10-05 20:51:39 +0000586 return 0;
587}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000588
589static void
590subtype_dealloc(PyObject *self)
591{
Guido van Rossum14227b42001-12-06 02:35:58 +0000592 PyTypeObject *type, *base;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000593 destructor basedealloc;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000594
Guido van Rossum22b13872002-08-06 21:41:44 +0000595 /* Extract the type; we expect it to be a heap type */
Christian Heimese93237d2007-12-19 02:37:44 +0000596 type = Py_TYPE(self);
Guido van Rossum22b13872002-08-06 21:41:44 +0000597 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000598
Guido van Rossum22b13872002-08-06 21:41:44 +0000599 /* Test whether the type has GC exactly once */
600
601 if (!PyType_IS_GC(type)) {
602 /* It's really rare to find a dynamic type that doesn't have
603 GC; it can only happen when deriving from 'object' and not
604 adding any slots or instance variables. This allows
605 certain simplifications: there's no need to call
606 clear_slots(), or DECREF the dict, or clear weakrefs. */
607
608 /* Maybe call finalizer; exit early if resurrected */
Guido van Rossumfebd61d2002-08-08 20:55:20 +0000609 if (type->tp_del) {
610 type->tp_del(self);
611 if (self->ob_refcnt > 0)
612 return;
613 }
Guido van Rossum22b13872002-08-06 21:41:44 +0000614
615 /* Find the nearest base with a different tp_dealloc */
616 base = type;
617 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
Christian Heimese93237d2007-12-19 02:37:44 +0000618 assert(Py_SIZE(base) == 0);
Guido van Rossum22b13872002-08-06 21:41:44 +0000619 base = base->tp_base;
620 assert(base);
621 }
622
623 /* Call the base tp_dealloc() */
624 assert(basedealloc);
625 basedealloc(self);
626
627 /* Can't reference self beyond this point */
628 Py_DECREF(type);
629
630 /* Done */
631 return;
632 }
633
634 /* We get here only if the type has GC */
635
636 /* UnTrack and re-Track around the trashcan macro, alas */
Andrew M. Kuchlingc9172d32003-02-06 15:22:49 +0000637 /* See explanation at end of function for full disclosure */
Guido van Rossum0906e072002-08-07 20:42:09 +0000638 PyObject_GC_UnTrack(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000639 ++_PyTrash_delete_nesting;
Guido van Rossum22b13872002-08-06 21:41:44 +0000640 Py_TRASHCAN_SAFE_BEGIN(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000641 --_PyTrash_delete_nesting;
Tim Petersf7f9e992003-11-13 21:59:32 +0000642 /* DO NOT restore GC tracking at this point. weakref callbacks
643 * (if any, and whether directly here or indirectly in something we
644 * call) may trigger GC, and if self is tracked at that point, it
645 * will look like trash to GC and GC will try to delete self again.
Tim Petersadd09b42003-11-12 20:43:28 +0000646 */
Guido van Rossum22b13872002-08-06 21:41:44 +0000647
Guido van Rossum59195fd2003-06-13 20:54:40 +0000648 /* Find the nearest base with a different tp_dealloc */
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000649 base = type;
650 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000651 base = base->tp_base;
652 assert(base);
Guido van Rossum14227b42001-12-06 02:35:58 +0000653 }
654
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000655 /* If we added a weaklist, we clear it. Do this *before* calling
Guido van Rossum59195fd2003-06-13 20:54:40 +0000656 the finalizer (__del__), clearing slots, or clearing the instance
657 dict. */
658
Guido van Rossum1987c662003-05-29 14:29:23 +0000659 if (type->tp_weaklistoffset && !base->tp_weaklistoffset)
660 PyObject_ClearWeakRefs(self);
661
662 /* Maybe call finalizer; exit early if resurrected */
663 if (type->tp_del) {
Tim Petersf7f9e992003-11-13 21:59:32 +0000664 _PyObject_GC_TRACK(self);
Guido van Rossum1987c662003-05-29 14:29:23 +0000665 type->tp_del(self);
666 if (self->ob_refcnt > 0)
Tim Petersf7f9e992003-11-13 21:59:32 +0000667 goto endlabel; /* resurrected */
668 else
669 _PyObject_GC_UNTRACK(self);
Brett Cannonf5bee302007-01-23 23:21:22 +0000670 /* New weakrefs could be created during the finalizer call.
671 If this occurs, clear them out without calling their
672 finalizers since they might rely on part of the object
673 being finalized that has already been destroyed. */
674 if (type->tp_weaklistoffset && !base->tp_weaklistoffset) {
675 /* Modeled after GET_WEAKREFS_LISTPTR() */
676 PyWeakReference **list = (PyWeakReference **) \
677 PyObject_GET_WEAKREFS_LISTPTR(self);
678 while (*list)
679 _PyWeakref_ClearRef(*list);
680 }
Guido van Rossum1987c662003-05-29 14:29:23 +0000681 }
682
Guido van Rossum59195fd2003-06-13 20:54:40 +0000683 /* Clear slots up to the nearest base with a different tp_dealloc */
684 base = type;
685 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
Christian Heimese93237d2007-12-19 02:37:44 +0000686 if (Py_SIZE(base))
Guido van Rossum59195fd2003-06-13 20:54:40 +0000687 clear_slots(base, self);
688 base = base->tp_base;
689 assert(base);
690 }
691
Tim Peters6d6c1a32001-08-02 04:15:00 +0000692 /* If we added a dict, DECREF it */
Guido van Rossum6fb3fde2001-08-30 20:00:07 +0000693 if (type->tp_dictoffset && !base->tp_dictoffset) {
694 PyObject **dictptr = _PyObject_GetDictPtr(self);
695 if (dictptr != NULL) {
696 PyObject *dict = *dictptr;
697 if (dict != NULL) {
698 Py_DECREF(dict);
699 *dictptr = NULL;
700 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000701 }
702 }
703
Tim Peters0bd743c2003-11-13 22:50:00 +0000704 /* Call the base tp_dealloc(); first retrack self if
705 * basedealloc knows about gc.
706 */
707 if (PyType_IS_GC(base))
708 _PyObject_GC_TRACK(self);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000709 assert(basedealloc);
710 basedealloc(self);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000711
712 /* Can't reference self beyond this point */
Guido van Rossum22b13872002-08-06 21:41:44 +0000713 Py_DECREF(type);
714
Guido van Rossum0906e072002-08-07 20:42:09 +0000715 endlabel:
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000716 ++_PyTrash_delete_nesting;
Guido van Rossum22b13872002-08-06 21:41:44 +0000717 Py_TRASHCAN_SAFE_END(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000718 --_PyTrash_delete_nesting;
719
720 /* Explanation of the weirdness around the trashcan macros:
721
722 Q. What do the trashcan macros do?
723
724 A. Read the comment titled "Trashcan mechanism" in object.h.
725 For one, this explains why there must be a call to GC-untrack
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000726 before the trashcan begin macro. Without understanding the
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000727 trashcan code, the answers to the following questions don't make
728 sense.
729
730 Q. Why do we GC-untrack before the trashcan and then immediately
731 GC-track again afterward?
732
733 A. In the case that the base class is GC-aware, the base class
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000734 probably GC-untracks the object. If it does that using the
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000735 UNTRACK macro, this will crash when the object is already
736 untracked. Because we don't know what the base class does, the
737 only safe thing is to make sure the object is tracked when we
738 call the base class dealloc. But... The trashcan begin macro
739 requires that the object is *untracked* before it is called. So
740 the dance becomes:
741
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000742 GC untrack
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000743 trashcan begin
744 GC track
745
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000746 Q. Why did the last question say "immediately GC-track again"?
747 It's nowhere near immediately.
Tim Petersf7f9e992003-11-13 21:59:32 +0000748
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000749 A. Because the code *used* to re-track immediately. Bad Idea.
750 self has a refcount of 0, and if gc ever gets its hands on it
751 (which can happen if any weakref callback gets invoked), it
752 looks like trash to gc too, and gc also tries to delete self
753 then. But we're already deleting self. Double dealloction is
754 a subtle disaster.
Tim Petersf7f9e992003-11-13 21:59:32 +0000755
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000756 Q. Why the bizarre (net-zero) manipulation of
757 _PyTrash_delete_nesting around the trashcan macros?
758
759 A. Some base classes (e.g. list) also use the trashcan mechanism.
760 The following scenario used to be possible:
761
762 - suppose the trashcan level is one below the trashcan limit
763
764 - subtype_dealloc() is called
765
766 - the trashcan limit is not yet reached, so the trashcan level
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000767 is incremented and the code between trashcan begin and end is
768 executed
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000769
770 - this destroys much of the object's contents, including its
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000771 slots and __dict__
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000772
773 - basedealloc() is called; this is really list_dealloc(), or
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000774 some other type which also uses the trashcan macros
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000775
776 - the trashcan limit is now reached, so the object is put on the
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000777 trashcan's to-be-deleted-later list
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000778
779 - basedealloc() returns
780
781 - subtype_dealloc() decrefs the object's type
782
783 - subtype_dealloc() returns
784
785 - later, the trashcan code starts deleting the objects from its
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000786 to-be-deleted-later list
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000787
788 - subtype_dealloc() is called *AGAIN* for the same object
789
790 - at the very least (if the destroyed slots and __dict__ don't
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000791 cause problems) the object's type gets decref'ed a second
792 time, which is *BAD*!!!
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000793
794 The remedy is to make sure that if the code between trashcan
795 begin and end in subtype_dealloc() is called, the code between
796 trashcan begin and end in basedealloc() will also be called.
797 This is done by decrementing the level after passing into the
798 trashcan block, and incrementing it just before leaving the
799 block.
800
801 But now it's possible that a chain of objects consisting solely
802 of objects whose deallocator is subtype_dealloc() will defeat
803 the trashcan mechanism completely: the decremented level means
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000804 that the effective level never reaches the limit. Therefore, we
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000805 *increment* the level *before* entering the trashcan block, and
806 matchingly decrement it after leaving. This means the trashcan
807 code will trigger a little early, but that's no big deal.
808
809 Q. Are there any live examples of code in need of all this
810 complexity?
811
812 A. Yes. See SF bug 668433 for code that crashed (when Python was
813 compiled in debug mode) before the trashcan level manipulations
814 were added. For more discussion, see SF patches 581742, 575073
815 and bug 574207.
816 */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000817}
818
Jeremy Hylton938ace62002-07-17 16:30:39 +0000819static PyTypeObject *solid_base(PyTypeObject *type);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000820
Tim Peters6d6c1a32001-08-02 04:15:00 +0000821/* type test with subclassing support */
822
823int
824PyType_IsSubtype(PyTypeObject *a, PyTypeObject *b)
825{
826 PyObject *mro;
827
Guido van Rossum9478d072001-09-07 18:52:13 +0000828 if (!(a->tp_flags & Py_TPFLAGS_HAVE_CLASS))
829 return b == a || b == &PyBaseObject_Type;
830
Tim Peters6d6c1a32001-08-02 04:15:00 +0000831 mro = a->tp_mro;
832 if (mro != NULL) {
833 /* Deal with multiple inheritance without recursion
834 by walking the MRO tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000835 Py_ssize_t i, n;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000836 assert(PyTuple_Check(mro));
837 n = PyTuple_GET_SIZE(mro);
838 for (i = 0; i < n; i++) {
839 if (PyTuple_GET_ITEM(mro, i) == (PyObject *)b)
840 return 1;
841 }
842 return 0;
843 }
844 else {
845 /* a is not completely initilized yet; follow tp_base */
846 do {
847 if (a == b)
848 return 1;
849 a = a->tp_base;
850 } while (a != NULL);
851 return b == &PyBaseObject_Type;
852 }
853}
854
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000855/* Internal routines to do a method lookup in the type
Guido van Rossum60718732001-08-28 17:47:51 +0000856 without looking in the instance dictionary
857 (so we can't use PyObject_GetAttr) but still binding
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000858 it to the instance. The arguments are the object,
Guido van Rossum60718732001-08-28 17:47:51 +0000859 the method name as a C string, and the address of a
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000860 static variable used to cache the interned Python string.
861
862 Two variants:
863
864 - lookup_maybe() returns NULL without raising an exception
865 when the _PyType_Lookup() call fails;
866
867 - lookup_method() always raises an exception upon errors.
868*/
Guido van Rossum60718732001-08-28 17:47:51 +0000869
870static PyObject *
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000871lookup_maybe(PyObject *self, char *attrstr, PyObject **attrobj)
Guido van Rossum60718732001-08-28 17:47:51 +0000872{
873 PyObject *res;
874
875 if (*attrobj == NULL) {
876 *attrobj = PyString_InternFromString(attrstr);
877 if (*attrobj == NULL)
878 return NULL;
879 }
Christian Heimese93237d2007-12-19 02:37:44 +0000880 res = _PyType_Lookup(Py_TYPE(self), *attrobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000881 if (res != NULL) {
Guido van Rossum60718732001-08-28 17:47:51 +0000882 descrgetfunc f;
Christian Heimese93237d2007-12-19 02:37:44 +0000883 if ((f = Py_TYPE(res)->tp_descr_get) == NULL)
Guido van Rossum60718732001-08-28 17:47:51 +0000884 Py_INCREF(res);
885 else
Christian Heimese93237d2007-12-19 02:37:44 +0000886 res = f(res, self, (PyObject *)(Py_TYPE(self)));
Guido van Rossum60718732001-08-28 17:47:51 +0000887 }
888 return res;
889}
890
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000891static PyObject *
892lookup_method(PyObject *self, char *attrstr, PyObject **attrobj)
893{
894 PyObject *res = lookup_maybe(self, attrstr, attrobj);
895 if (res == NULL && !PyErr_Occurred())
896 PyErr_SetObject(PyExc_AttributeError, *attrobj);
897 return res;
898}
899
Guido van Rossum2730b132001-08-28 18:22:14 +0000900/* A variation of PyObject_CallMethod that uses lookup_method()
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +0000901 instead of PyObject_GetAttrString(). This uses the same convention
Guido van Rossum2730b132001-08-28 18:22:14 +0000902 as lookup_method to cache the interned name string object. */
903
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000904static PyObject *
Guido van Rossum2730b132001-08-28 18:22:14 +0000905call_method(PyObject *o, char *name, PyObject **nameobj, char *format, ...)
906{
907 va_list va;
908 PyObject *args, *func = 0, *retval;
Guido van Rossum2730b132001-08-28 18:22:14 +0000909 va_start(va, format);
910
Guido van Rossumda21c012001-10-03 00:50:18 +0000911 func = lookup_maybe(o, name, nameobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000912 if (func == NULL) {
913 va_end(va);
914 if (!PyErr_Occurred())
Guido van Rossumda21c012001-10-03 00:50:18 +0000915 PyErr_SetObject(PyExc_AttributeError, *nameobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000916 return NULL;
917 }
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000918
919 if (format && *format)
920 args = Py_VaBuildValue(format, va);
921 else
922 args = PyTuple_New(0);
923
924 va_end(va);
925
926 if (args == NULL)
927 return NULL;
928
929 assert(PyTuple_Check(args));
930 retval = PyObject_Call(func, args, NULL);
931
932 Py_DECREF(args);
933 Py_DECREF(func);
934
935 return retval;
936}
937
938/* Clone of call_method() that returns NotImplemented when the lookup fails. */
939
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000940static PyObject *
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000941call_maybe(PyObject *o, char *name, PyObject **nameobj, char *format, ...)
942{
943 va_list va;
944 PyObject *args, *func = 0, *retval;
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000945 va_start(va, format);
946
Guido van Rossumda21c012001-10-03 00:50:18 +0000947 func = lookup_maybe(o, name, nameobj);
Guido van Rossum2730b132001-08-28 18:22:14 +0000948 if (func == NULL) {
949 va_end(va);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000950 if (!PyErr_Occurred()) {
951 Py_INCREF(Py_NotImplemented);
952 return Py_NotImplemented;
953 }
Guido van Rossum717ce002001-09-14 16:58:08 +0000954 return NULL;
Guido van Rossum2730b132001-08-28 18:22:14 +0000955 }
956
957 if (format && *format)
958 args = Py_VaBuildValue(format, va);
959 else
960 args = PyTuple_New(0);
961
962 va_end(va);
963
Guido van Rossum717ce002001-09-14 16:58:08 +0000964 if (args == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +0000965 return NULL;
966
Guido van Rossum717ce002001-09-14 16:58:08 +0000967 assert(PyTuple_Check(args));
968 retval = PyObject_Call(func, args, NULL);
Guido van Rossum2730b132001-08-28 18:22:14 +0000969
970 Py_DECREF(args);
971 Py_DECREF(func);
972
973 return retval;
974}
975
Tim Petersa91e9642001-11-14 23:32:33 +0000976static int
977fill_classic_mro(PyObject *mro, PyObject *cls)
978{
979 PyObject *bases, *base;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000980 Py_ssize_t i, n;
Tim Petersa91e9642001-11-14 23:32:33 +0000981
982 assert(PyList_Check(mro));
983 assert(PyClass_Check(cls));
984 i = PySequence_Contains(mro, cls);
985 if (i < 0)
986 return -1;
987 if (!i) {
988 if (PyList_Append(mro, cls) < 0)
989 return -1;
990 }
991 bases = ((PyClassObject *)cls)->cl_bases;
992 assert(bases && PyTuple_Check(bases));
993 n = PyTuple_GET_SIZE(bases);
994 for (i = 0; i < n; i++) {
995 base = PyTuple_GET_ITEM(bases, i);
996 if (fill_classic_mro(mro, base) < 0)
997 return -1;
998 }
999 return 0;
1000}
1001
1002static PyObject *
1003classic_mro(PyObject *cls)
1004{
1005 PyObject *mro;
1006
1007 assert(PyClass_Check(cls));
1008 mro = PyList_New(0);
1009 if (mro != NULL) {
1010 if (fill_classic_mro(mro, cls) == 0)
1011 return mro;
1012 Py_DECREF(mro);
1013 }
1014 return NULL;
1015}
1016
Tim Petersea7f75d2002-12-07 21:39:16 +00001017/*
Guido van Rossum1f121312002-11-14 19:49:16 +00001018 Method resolution order algorithm C3 described in
1019 "A Monotonic Superclass Linearization for Dylan",
1020 by Kim Barrett, Bob Cassel, Paul Haahr,
Tim Petersea7f75d2002-12-07 21:39:16 +00001021 David A. Moon, Keith Playford, and P. Tucker Withington.
Guido van Rossum1f121312002-11-14 19:49:16 +00001022 (OOPSLA 1996)
1023
Guido van Rossum98f33732002-11-25 21:36:54 +00001024 Some notes about the rules implied by C3:
1025
Tim Petersea7f75d2002-12-07 21:39:16 +00001026 No duplicate bases.
Guido van Rossum98f33732002-11-25 21:36:54 +00001027 It isn't legal to repeat a class in a list of base classes.
1028
1029 The next three properties are the 3 constraints in "C3".
1030
Tim Petersea7f75d2002-12-07 21:39:16 +00001031 Local precendece order.
Guido van Rossum98f33732002-11-25 21:36:54 +00001032 If A precedes B in C's MRO, then A will precede B in the MRO of all
1033 subclasses of C.
1034
1035 Monotonicity.
1036 The MRO of a class must be an extension without reordering of the
1037 MRO of each of its superclasses.
1038
1039 Extended Precedence Graph (EPG).
1040 Linearization is consistent if there is a path in the EPG from
1041 each class to all its successors in the linearization. See
1042 the paper for definition of EPG.
Guido van Rossum1f121312002-11-14 19:49:16 +00001043 */
1044
Tim Petersea7f75d2002-12-07 21:39:16 +00001045static int
Guido van Rossum1f121312002-11-14 19:49:16 +00001046tail_contains(PyObject *list, int whence, PyObject *o) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001047 Py_ssize_t j, size;
Guido van Rossum1f121312002-11-14 19:49:16 +00001048 size = PyList_GET_SIZE(list);
1049
1050 for (j = whence+1; j < size; j++) {
1051 if (PyList_GET_ITEM(list, j) == o)
1052 return 1;
1053 }
1054 return 0;
1055}
1056
Guido van Rossum98f33732002-11-25 21:36:54 +00001057static PyObject *
1058class_name(PyObject *cls)
1059{
1060 PyObject *name = PyObject_GetAttrString(cls, "__name__");
1061 if (name == NULL) {
1062 PyErr_Clear();
1063 Py_XDECREF(name);
1064 name = PyObject_Repr(cls);
1065 }
1066 if (name == NULL)
1067 return NULL;
1068 if (!PyString_Check(name)) {
1069 Py_DECREF(name);
1070 return NULL;
1071 }
1072 return name;
1073}
1074
1075static int
1076check_duplicates(PyObject *list)
1077{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001078 Py_ssize_t i, j, n;
Guido van Rossum98f33732002-11-25 21:36:54 +00001079 /* Let's use a quadratic time algorithm,
1080 assuming that the bases lists is short.
1081 */
1082 n = PyList_GET_SIZE(list);
1083 for (i = 0; i < n; i++) {
1084 PyObject *o = PyList_GET_ITEM(list, i);
1085 for (j = i + 1; j < n; j++) {
1086 if (PyList_GET_ITEM(list, j) == o) {
1087 o = class_name(o);
1088 PyErr_Format(PyExc_TypeError,
1089 "duplicate base class %s",
1090 o ? PyString_AS_STRING(o) : "?");
1091 Py_XDECREF(o);
1092 return -1;
1093 }
1094 }
1095 }
1096 return 0;
1097}
1098
1099/* Raise a TypeError for an MRO order disagreement.
1100
1101 It's hard to produce a good error message. In the absence of better
1102 insight into error reporting, report the classes that were candidates
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001103 to be put next into the MRO. There is some conflict between the
Guido van Rossum98f33732002-11-25 21:36:54 +00001104 order in which they should be put in the MRO, but it's hard to
1105 diagnose what constraint can't be satisfied.
1106*/
1107
1108static void
1109set_mro_error(PyObject *to_merge, int *remain)
1110{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001111 Py_ssize_t i, n, off, to_merge_size;
Guido van Rossum98f33732002-11-25 21:36:54 +00001112 char buf[1000];
1113 PyObject *k, *v;
1114 PyObject *set = PyDict_New();
Georg Brandl5c170fd2006-03-17 19:03:25 +00001115 if (!set) return;
Guido van Rossum98f33732002-11-25 21:36:54 +00001116
1117 to_merge_size = PyList_GET_SIZE(to_merge);
1118 for (i = 0; i < to_merge_size; i++) {
1119 PyObject *L = PyList_GET_ITEM(to_merge, i);
1120 if (remain[i] < PyList_GET_SIZE(L)) {
1121 PyObject *c = PyList_GET_ITEM(L, remain[i]);
Georg Brandl5c170fd2006-03-17 19:03:25 +00001122 if (PyDict_SetItem(set, c, Py_None) < 0) {
1123 Py_DECREF(set);
Guido van Rossum98f33732002-11-25 21:36:54 +00001124 return;
Georg Brandl5c170fd2006-03-17 19:03:25 +00001125 }
Guido van Rossum98f33732002-11-25 21:36:54 +00001126 }
1127 }
1128 n = PyDict_Size(set);
1129
Raymond Hettingerf394df42003-04-06 19:13:41 +00001130 off = PyOS_snprintf(buf, sizeof(buf), "Cannot create a \
1131consistent method resolution\norder (MRO) for bases");
Guido van Rossum98f33732002-11-25 21:36:54 +00001132 i = 0;
Skip Montanaro429433b2006-04-18 00:35:43 +00001133 while (PyDict_Next(set, &i, &k, &v) && (size_t)off < sizeof(buf)) {
Guido van Rossum98f33732002-11-25 21:36:54 +00001134 PyObject *name = class_name(k);
1135 off += PyOS_snprintf(buf + off, sizeof(buf) - off, " %s",
1136 name ? PyString_AS_STRING(name) : "?");
1137 Py_XDECREF(name);
Skip Montanaro429433b2006-04-18 00:35:43 +00001138 if (--n && (size_t)(off+1) < sizeof(buf)) {
Guido van Rossum98f33732002-11-25 21:36:54 +00001139 buf[off++] = ',';
1140 buf[off] = '\0';
1141 }
1142 }
1143 PyErr_SetString(PyExc_TypeError, buf);
1144 Py_DECREF(set);
1145}
1146
Tim Petersea7f75d2002-12-07 21:39:16 +00001147static int
Guido van Rossum1f121312002-11-14 19:49:16 +00001148pmerge(PyObject *acc, PyObject* to_merge) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001149 Py_ssize_t i, j, to_merge_size, empty_cnt;
Guido van Rossum1f121312002-11-14 19:49:16 +00001150 int *remain;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001151 int ok;
Tim Petersea7f75d2002-12-07 21:39:16 +00001152
Guido van Rossum1f121312002-11-14 19:49:16 +00001153 to_merge_size = PyList_GET_SIZE(to_merge);
1154
Guido van Rossum98f33732002-11-25 21:36:54 +00001155 /* remain stores an index into each sublist of to_merge.
1156 remain[i] is the index of the next base in to_merge[i]
1157 that is not included in acc.
1158 */
Anthony Baxtera6286212006-04-11 07:42:36 +00001159 remain = (int *)PyMem_MALLOC(SIZEOF_INT*to_merge_size);
Guido van Rossum1f121312002-11-14 19:49:16 +00001160 if (remain == NULL)
1161 return -1;
1162 for (i = 0; i < to_merge_size; i++)
1163 remain[i] = 0;
1164
1165 again:
1166 empty_cnt = 0;
1167 for (i = 0; i < to_merge_size; i++) {
1168 PyObject *candidate;
Tim Petersea7f75d2002-12-07 21:39:16 +00001169
Guido van Rossum1f121312002-11-14 19:49:16 +00001170 PyObject *cur_list = PyList_GET_ITEM(to_merge, i);
1171
1172 if (remain[i] >= PyList_GET_SIZE(cur_list)) {
1173 empty_cnt++;
1174 continue;
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001175 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001176
Guido van Rossum98f33732002-11-25 21:36:54 +00001177 /* Choose next candidate for MRO.
1178
1179 The input sequences alone can determine the choice.
1180 If not, choose the class which appears in the MRO
1181 of the earliest direct superclass of the new class.
1182 */
1183
Guido van Rossum1f121312002-11-14 19:49:16 +00001184 candidate = PyList_GET_ITEM(cur_list, remain[i]);
1185 for (j = 0; j < to_merge_size; j++) {
1186 PyObject *j_lst = PyList_GET_ITEM(to_merge, j);
Guido van Rossum98f33732002-11-25 21:36:54 +00001187 if (tail_contains(j_lst, remain[j], candidate)) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001188 goto skip; /* continue outer loop */
Guido van Rossum98f33732002-11-25 21:36:54 +00001189 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001190 }
1191 ok = PyList_Append(acc, candidate);
1192 if (ok < 0) {
1193 PyMem_Free(remain);
1194 return -1;
1195 }
1196 for (j = 0; j < to_merge_size; j++) {
1197 PyObject *j_lst = PyList_GET_ITEM(to_merge, j);
Guido van Rossum768158c2002-12-31 16:33:01 +00001198 if (remain[j] < PyList_GET_SIZE(j_lst) &&
1199 PyList_GET_ITEM(j_lst, remain[j]) == candidate) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001200 remain[j]++;
1201 }
1202 }
1203 goto again;
Tim Peters9a6b8d82002-11-14 23:22:33 +00001204 skip: ;
Guido van Rossum1f121312002-11-14 19:49:16 +00001205 }
1206
Guido van Rossum98f33732002-11-25 21:36:54 +00001207 if (empty_cnt == to_merge_size) {
1208 PyMem_FREE(remain);
Guido van Rossum1f121312002-11-14 19:49:16 +00001209 return 0;
Guido van Rossum98f33732002-11-25 21:36:54 +00001210 }
1211 set_mro_error(to_merge, remain);
1212 PyMem_FREE(remain);
Guido van Rossum1f121312002-11-14 19:49:16 +00001213 return -1;
1214}
1215
Tim Peters6d6c1a32001-08-02 04:15:00 +00001216static PyObject *
1217mro_implementation(PyTypeObject *type)
1218{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001219 Py_ssize_t i, n;
1220 int ok;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001221 PyObject *bases, *result;
Guido van Rossum1f121312002-11-14 19:49:16 +00001222 PyObject *to_merge, *bases_aslist;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001223
Guido van Rossum63517572002-06-18 16:44:57 +00001224 if(type->tp_dict == NULL) {
1225 if(PyType_Ready(type) < 0)
1226 return NULL;
1227 }
1228
Guido van Rossum98f33732002-11-25 21:36:54 +00001229 /* Find a superclass linearization that honors the constraints
1230 of the explicit lists of bases and the constraints implied by
Tim Petersea7f75d2002-12-07 21:39:16 +00001231 each base class.
Guido van Rossum98f33732002-11-25 21:36:54 +00001232
1233 to_merge is a list of lists, where each list is a superclass
1234 linearization implied by a base class. The last element of
1235 to_merge is the declared list of bases.
1236 */
1237
Tim Peters6d6c1a32001-08-02 04:15:00 +00001238 bases = type->tp_bases;
1239 n = PyTuple_GET_SIZE(bases);
Guido van Rossum1f121312002-11-14 19:49:16 +00001240
1241 to_merge = PyList_New(n+1);
1242 if (to_merge == NULL)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001243 return NULL;
Guido van Rossum1f121312002-11-14 19:49:16 +00001244
Tim Peters6d6c1a32001-08-02 04:15:00 +00001245 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00001246 PyObject *base = PyTuple_GET_ITEM(bases, i);
1247 PyObject *parentMRO;
1248 if (PyType_Check(base))
1249 parentMRO = PySequence_List(
1250 ((PyTypeObject*)base)->tp_mro);
1251 else
1252 parentMRO = classic_mro(base);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001253 if (parentMRO == NULL) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001254 Py_DECREF(to_merge);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001255 return NULL;
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001256 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001257
1258 PyList_SET_ITEM(to_merge, i, parentMRO);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001259 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001260
1261 bases_aslist = PySequence_List(bases);
1262 if (bases_aslist == NULL) {
1263 Py_DECREF(to_merge);
1264 return NULL;
1265 }
Guido van Rossum98f33732002-11-25 21:36:54 +00001266 /* This is just a basic sanity check. */
1267 if (check_duplicates(bases_aslist) < 0) {
1268 Py_DECREF(to_merge);
1269 Py_DECREF(bases_aslist);
1270 return NULL;
1271 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001272 PyList_SET_ITEM(to_merge, n, bases_aslist);
1273
1274 result = Py_BuildValue("[O]", (PyObject *)type);
1275 if (result == NULL) {
1276 Py_DECREF(to_merge);
1277 return NULL;
1278 }
1279
1280 ok = pmerge(result, to_merge);
1281 Py_DECREF(to_merge);
1282 if (ok < 0) {
1283 Py_DECREF(result);
1284 return NULL;
1285 }
1286
Tim Peters6d6c1a32001-08-02 04:15:00 +00001287 return result;
1288}
1289
1290static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001291mro_external(PyObject *self)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001292{
1293 PyTypeObject *type = (PyTypeObject *)self;
1294
Tim Peters6d6c1a32001-08-02 04:15:00 +00001295 return mro_implementation(type);
1296}
1297
1298static int
1299mro_internal(PyTypeObject *type)
1300{
1301 PyObject *mro, *result, *tuple;
Armin Rigo037d1e02005-12-29 17:07:39 +00001302 int checkit = 0;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001303
Christian Heimese93237d2007-12-19 02:37:44 +00001304 if (Py_TYPE(type) == &PyType_Type) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001305 result = mro_implementation(type);
1306 }
1307 else {
Guido van Rossum60718732001-08-28 17:47:51 +00001308 static PyObject *mro_str;
Armin Rigo037d1e02005-12-29 17:07:39 +00001309 checkit = 1;
Guido van Rossum60718732001-08-28 17:47:51 +00001310 mro = lookup_method((PyObject *)type, "mro", &mro_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001311 if (mro == NULL)
1312 return -1;
1313 result = PyObject_CallObject(mro, NULL);
1314 Py_DECREF(mro);
1315 }
1316 if (result == NULL)
1317 return -1;
1318 tuple = PySequence_Tuple(result);
1319 Py_DECREF(result);
Armin Rigo037d1e02005-12-29 17:07:39 +00001320 if (tuple == NULL)
1321 return -1;
1322 if (checkit) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001323 Py_ssize_t i, len;
Armin Rigo037d1e02005-12-29 17:07:39 +00001324 PyObject *cls;
1325 PyTypeObject *solid;
1326
1327 solid = solid_base(type);
1328
1329 len = PyTuple_GET_SIZE(tuple);
1330
1331 for (i = 0; i < len; i++) {
1332 PyTypeObject *t;
1333 cls = PyTuple_GET_ITEM(tuple, i);
1334 if (PyClass_Check(cls))
1335 continue;
1336 else if (!PyType_Check(cls)) {
1337 PyErr_Format(PyExc_TypeError,
1338 "mro() returned a non-class ('%.500s')",
Christian Heimese93237d2007-12-19 02:37:44 +00001339 Py_TYPE(cls)->tp_name);
Neal Norwitz50bf51a2006-01-02 02:46:54 +00001340 Py_DECREF(tuple);
Armin Rigo037d1e02005-12-29 17:07:39 +00001341 return -1;
1342 }
1343 t = (PyTypeObject*)cls;
1344 if (!PyType_IsSubtype(solid, solid_base(t))) {
1345 PyErr_Format(PyExc_TypeError,
1346 "mro() returned base with unsuitable layout ('%.500s')",
1347 t->tp_name);
Neal Norwitz50bf51a2006-01-02 02:46:54 +00001348 Py_DECREF(tuple);
Armin Rigo037d1e02005-12-29 17:07:39 +00001349 return -1;
1350 }
1351 }
1352 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001353 type->tp_mro = tuple;
1354 return 0;
1355}
1356
1357
1358/* Calculate the best base amongst multiple base classes.
Armin Rigoc0ba52d2007-04-19 14:44:48 +00001359 This is the first one that's on the path to the "solid base". */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001360
1361static PyTypeObject *
1362best_base(PyObject *bases)
1363{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001364 Py_ssize_t i, n;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001365 PyTypeObject *base, *winner, *candidate, *base_i;
Tim Petersa91e9642001-11-14 23:32:33 +00001366 PyObject *base_proto;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001367
1368 assert(PyTuple_Check(bases));
1369 n = PyTuple_GET_SIZE(bases);
1370 assert(n > 0);
Tim Petersa91e9642001-11-14 23:32:33 +00001371 base = NULL;
1372 winner = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001373 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00001374 base_proto = PyTuple_GET_ITEM(bases, i);
1375 if (PyClass_Check(base_proto))
1376 continue;
Armin Rigoc0ba52d2007-04-19 14:44:48 +00001377 if (!PyType_Check(base_proto)) {
1378 PyErr_SetString(
1379 PyExc_TypeError,
1380 "bases must be types");
1381 return NULL;
1382 }
Tim Petersa91e9642001-11-14 23:32:33 +00001383 base_i = (PyTypeObject *)base_proto;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001384 if (base_i->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001385 if (PyType_Ready(base_i) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001386 return NULL;
1387 }
1388 candidate = solid_base(base_i);
Tim Petersa91e9642001-11-14 23:32:33 +00001389 if (winner == NULL) {
1390 winner = candidate;
1391 base = base_i;
1392 }
1393 else if (PyType_IsSubtype(winner, candidate))
Tim Peters6d6c1a32001-08-02 04:15:00 +00001394 ;
1395 else if (PyType_IsSubtype(candidate, winner)) {
1396 winner = candidate;
1397 base = base_i;
1398 }
1399 else {
1400 PyErr_SetString(
1401 PyExc_TypeError,
1402 "multiple bases have "
1403 "instance lay-out conflict");
1404 return NULL;
1405 }
1406 }
Guido van Rossume54616c2001-12-14 04:19:56 +00001407 if (base == NULL)
1408 PyErr_SetString(PyExc_TypeError,
1409 "a new-style class can't have only classic bases");
Tim Peters6d6c1a32001-08-02 04:15:00 +00001410 return base;
1411}
1412
1413static int
1414extra_ivars(PyTypeObject *type, PyTypeObject *base)
1415{
Neil Schemenauerc806c882001-08-29 23:54:54 +00001416 size_t t_size = type->tp_basicsize;
1417 size_t b_size = base->tp_basicsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001418
Guido van Rossum9676b222001-08-17 20:32:36 +00001419 assert(t_size >= b_size); /* Else type smaller than base! */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001420 if (type->tp_itemsize || base->tp_itemsize) {
1421 /* If itemsize is involved, stricter rules */
1422 return t_size != b_size ||
1423 type->tp_itemsize != base->tp_itemsize;
1424 }
Guido van Rossum9676b222001-08-17 20:32:36 +00001425 if (type->tp_weaklistoffset && base->tp_weaklistoffset == 0 &&
Armin Rigo9790a272007-05-02 19:23:31 +00001426 type->tp_weaklistoffset + sizeof(PyObject *) == t_size &&
1427 type->tp_flags & Py_TPFLAGS_HEAPTYPE)
Guido van Rossum9676b222001-08-17 20:32:36 +00001428 t_size -= sizeof(PyObject *);
1429 if (type->tp_dictoffset && base->tp_dictoffset == 0 &&
Armin Rigo9790a272007-05-02 19:23:31 +00001430 type->tp_dictoffset + sizeof(PyObject *) == t_size &&
1431 type->tp_flags & Py_TPFLAGS_HEAPTYPE)
Guido van Rossum9676b222001-08-17 20:32:36 +00001432 t_size -= sizeof(PyObject *);
1433
1434 return t_size != b_size;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001435}
1436
1437static PyTypeObject *
1438solid_base(PyTypeObject *type)
1439{
1440 PyTypeObject *base;
1441
1442 if (type->tp_base)
1443 base = solid_base(type->tp_base);
1444 else
1445 base = &PyBaseObject_Type;
1446 if (extra_ivars(type, base))
1447 return type;
1448 else
1449 return base;
1450}
1451
Jeremy Hylton938ace62002-07-17 16:30:39 +00001452static void object_dealloc(PyObject *);
1453static int object_init(PyObject *, PyObject *, PyObject *);
1454static int update_slot(PyTypeObject *, PyObject *);
1455static void fixup_slot_dispatchers(PyTypeObject *);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001456
Armin Rigo9790a272007-05-02 19:23:31 +00001457/*
1458 * Helpers for __dict__ descriptor. We don't want to expose the dicts
1459 * inherited from various builtin types. The builtin base usually provides
1460 * its own __dict__ descriptor, so we use that when we can.
1461 */
1462static PyTypeObject *
1463get_builtin_base_with_dict(PyTypeObject *type)
1464{
1465 while (type->tp_base != NULL) {
1466 if (type->tp_dictoffset != 0 &&
1467 !(type->tp_flags & Py_TPFLAGS_HEAPTYPE))
1468 return type;
1469 type = type->tp_base;
1470 }
1471 return NULL;
1472}
1473
1474static PyObject *
1475get_dict_descriptor(PyTypeObject *type)
1476{
1477 static PyObject *dict_str;
1478 PyObject *descr;
1479
1480 if (dict_str == NULL) {
1481 dict_str = PyString_InternFromString("__dict__");
1482 if (dict_str == NULL)
1483 return NULL;
1484 }
1485 descr = _PyType_Lookup(type, dict_str);
1486 if (descr == NULL || !PyDescr_IsData(descr))
1487 return NULL;
1488
1489 return descr;
1490}
1491
1492static void
1493raise_dict_descr_error(PyObject *obj)
1494{
1495 PyErr_Format(PyExc_TypeError,
1496 "this __dict__ descriptor does not support "
1497 "'%.200s' objects", obj->ob_type->tp_name);
1498}
1499
Tim Peters6d6c1a32001-08-02 04:15:00 +00001500static PyObject *
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001501subtype_dict(PyObject *obj, void *context)
1502{
Armin Rigo9790a272007-05-02 19:23:31 +00001503 PyObject **dictptr;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001504 PyObject *dict;
Armin Rigo9790a272007-05-02 19:23:31 +00001505 PyTypeObject *base;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001506
Armin Rigo9790a272007-05-02 19:23:31 +00001507 base = get_builtin_base_with_dict(obj->ob_type);
1508 if (base != NULL) {
1509 descrgetfunc func;
1510 PyObject *descr = get_dict_descriptor(base);
1511 if (descr == NULL) {
1512 raise_dict_descr_error(obj);
1513 return NULL;
1514 }
1515 func = descr->ob_type->tp_descr_get;
1516 if (func == NULL) {
1517 raise_dict_descr_error(obj);
1518 return NULL;
1519 }
1520 return func(descr, obj, (PyObject *)(obj->ob_type));
1521 }
1522
1523 dictptr = _PyObject_GetDictPtr(obj);
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001524 if (dictptr == NULL) {
1525 PyErr_SetString(PyExc_AttributeError,
1526 "This object has no __dict__");
1527 return NULL;
1528 }
1529 dict = *dictptr;
Guido van Rossum3926a632001-09-25 16:25:58 +00001530 if (dict == NULL)
1531 *dictptr = dict = PyDict_New();
1532 Py_XINCREF(dict);
1533 return dict;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001534}
1535
Guido van Rossum6661be32001-10-26 04:26:12 +00001536static int
1537subtype_setdict(PyObject *obj, PyObject *value, void *context)
1538{
Armin Rigo9790a272007-05-02 19:23:31 +00001539 PyObject **dictptr;
Guido van Rossum6661be32001-10-26 04:26:12 +00001540 PyObject *dict;
Armin Rigo9790a272007-05-02 19:23:31 +00001541 PyTypeObject *base;
Guido van Rossum6661be32001-10-26 04:26:12 +00001542
Armin Rigo9790a272007-05-02 19:23:31 +00001543 base = get_builtin_base_with_dict(obj->ob_type);
1544 if (base != NULL) {
1545 descrsetfunc func;
1546 PyObject *descr = get_dict_descriptor(base);
1547 if (descr == NULL) {
1548 raise_dict_descr_error(obj);
1549 return -1;
1550 }
1551 func = descr->ob_type->tp_descr_set;
1552 if (func == NULL) {
1553 raise_dict_descr_error(obj);
1554 return -1;
1555 }
1556 return func(descr, obj, value);
1557 }
1558
1559 dictptr = _PyObject_GetDictPtr(obj);
Guido van Rossum6661be32001-10-26 04:26:12 +00001560 if (dictptr == NULL) {
1561 PyErr_SetString(PyExc_AttributeError,
1562 "This object has no __dict__");
1563 return -1;
1564 }
Guido van Rossumd331cb52001-12-05 19:46:42 +00001565 if (value != NULL && !PyDict_Check(value)) {
Georg Brandlccff7852006-06-18 22:17:29 +00001566 PyErr_Format(PyExc_TypeError,
1567 "__dict__ must be set to a dictionary, "
Christian Heimese93237d2007-12-19 02:37:44 +00001568 "not a '%.200s'", Py_TYPE(value)->tp_name);
Guido van Rossum6661be32001-10-26 04:26:12 +00001569 return -1;
1570 }
1571 dict = *dictptr;
Guido van Rossumd331cb52001-12-05 19:46:42 +00001572 Py_XINCREF(value);
Guido van Rossum6661be32001-10-26 04:26:12 +00001573 *dictptr = value;
1574 Py_XDECREF(dict);
1575 return 0;
1576}
1577
Guido van Rossumad47da02002-08-12 19:05:44 +00001578static PyObject *
1579subtype_getweakref(PyObject *obj, void *context)
1580{
1581 PyObject **weaklistptr;
1582 PyObject *result;
1583
Christian Heimese93237d2007-12-19 02:37:44 +00001584 if (Py_TYPE(obj)->tp_weaklistoffset == 0) {
Guido van Rossumad47da02002-08-12 19:05:44 +00001585 PyErr_SetString(PyExc_AttributeError,
Fred Drake7a36f5f2006-08-04 05:17:21 +00001586 "This object has no __weakref__");
Guido van Rossumad47da02002-08-12 19:05:44 +00001587 return NULL;
1588 }
Christian Heimese93237d2007-12-19 02:37:44 +00001589 assert(Py_TYPE(obj)->tp_weaklistoffset > 0);
1590 assert(Py_TYPE(obj)->tp_weaklistoffset + sizeof(PyObject *) <=
1591 (size_t)(Py_TYPE(obj)->tp_basicsize));
Guido van Rossumad47da02002-08-12 19:05:44 +00001592 weaklistptr = (PyObject **)
Christian Heimese93237d2007-12-19 02:37:44 +00001593 ((char *)obj + Py_TYPE(obj)->tp_weaklistoffset);
Guido van Rossumad47da02002-08-12 19:05:44 +00001594 if (*weaklistptr == NULL)
1595 result = Py_None;
1596 else
1597 result = *weaklistptr;
1598 Py_INCREF(result);
1599 return result;
1600}
1601
Guido van Rossum373c7412003-01-07 13:41:37 +00001602/* Three variants on the subtype_getsets list. */
1603
1604static PyGetSetDef subtype_getsets_full[] = {
Guido van Rossumad47da02002-08-12 19:05:44 +00001605 {"__dict__", subtype_dict, subtype_setdict,
Neal Norwitz858e34f2002-08-13 17:18:45 +00001606 PyDoc_STR("dictionary for instance variables (if defined)")},
Guido van Rossumad47da02002-08-12 19:05:44 +00001607 {"__weakref__", subtype_getweakref, NULL,
Neal Norwitz858e34f2002-08-13 17:18:45 +00001608 PyDoc_STR("list of weak references to the object (if defined)")},
Guido van Rossumad47da02002-08-12 19:05:44 +00001609 {0}
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001610};
1611
Guido van Rossum373c7412003-01-07 13:41:37 +00001612static PyGetSetDef subtype_getsets_dict_only[] = {
1613 {"__dict__", subtype_dict, subtype_setdict,
1614 PyDoc_STR("dictionary for instance variables (if defined)")},
1615 {0}
1616};
1617
1618static PyGetSetDef subtype_getsets_weakref_only[] = {
1619 {"__weakref__", subtype_getweakref, NULL,
1620 PyDoc_STR("list of weak references to the object (if defined)")},
1621 {0}
1622};
1623
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001624static int
1625valid_identifier(PyObject *s)
1626{
Guido van Rossum03013a02002-07-16 14:30:28 +00001627 unsigned char *p;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001628 Py_ssize_t i, n;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001629
1630 if (!PyString_Check(s)) {
Georg Brandlccff7852006-06-18 22:17:29 +00001631 PyErr_Format(PyExc_TypeError,
1632 "__slots__ items must be strings, not '%.200s'",
Christian Heimese93237d2007-12-19 02:37:44 +00001633 Py_TYPE(s)->tp_name);
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001634 return 0;
1635 }
Guido van Rossum03013a02002-07-16 14:30:28 +00001636 p = (unsigned char *) PyString_AS_STRING(s);
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001637 n = PyString_GET_SIZE(s);
1638 /* We must reject an empty name. As a hack, we bump the
1639 length to 1 so that the loop will balk on the trailing \0. */
1640 if (n == 0)
1641 n = 1;
1642 for (i = 0; i < n; i++, p++) {
1643 if (!(i == 0 ? isalpha(*p) : isalnum(*p)) && *p != '_') {
1644 PyErr_SetString(PyExc_TypeError,
1645 "__slots__ must be identifiers");
1646 return 0;
1647 }
1648 }
1649 return 1;
1650}
1651
Martin v. Löwisd919a592002-10-14 21:07:28 +00001652#ifdef Py_USING_UNICODE
1653/* Replace Unicode objects in slots. */
1654
1655static PyObject *
Martin v. Löwiseb079f12006-02-16 14:32:27 +00001656_unicode_to_string(PyObject *slots, Py_ssize_t nslots)
Martin v. Löwisd919a592002-10-14 21:07:28 +00001657{
Žiga Seilnacht71436f02007-03-14 12:24:09 +00001658 PyObject *tmp = NULL;
1659 PyObject *slot_name, *new_name;
Martin v. Löwiseb079f12006-02-16 14:32:27 +00001660 Py_ssize_t i;
Žiga Seilnacht71436f02007-03-14 12:24:09 +00001661
Martin v. Löwisd919a592002-10-14 21:07:28 +00001662 for (i = 0; i < nslots; i++) {
Žiga Seilnacht71436f02007-03-14 12:24:09 +00001663 if (PyUnicode_Check(slot_name = PyTuple_GET_ITEM(slots, i))) {
1664 if (tmp == NULL) {
1665 tmp = PySequence_List(slots);
Martin v. Löwisd919a592002-10-14 21:07:28 +00001666 if (tmp == NULL)
1667 return NULL;
1668 }
Žiga Seilnacht71436f02007-03-14 12:24:09 +00001669 new_name = _PyUnicode_AsDefaultEncodedString(slot_name,
1670 NULL);
1671 if (new_name == NULL) {
Martin v. Löwisd919a592002-10-14 21:07:28 +00001672 Py_DECREF(tmp);
Žiga Seilnacht71436f02007-03-14 12:24:09 +00001673 return NULL;
Martin v. Löwisd919a592002-10-14 21:07:28 +00001674 }
Žiga Seilnacht71436f02007-03-14 12:24:09 +00001675 Py_INCREF(new_name);
1676 PyList_SET_ITEM(tmp, i, new_name);
1677 Py_DECREF(slot_name);
Martin v. Löwisd919a592002-10-14 21:07:28 +00001678 }
1679 }
Žiga Seilnacht71436f02007-03-14 12:24:09 +00001680 if (tmp != NULL) {
1681 slots = PyList_AsTuple(tmp);
1682 Py_DECREF(tmp);
1683 }
1684 return slots;
Martin v. Löwisd919a592002-10-14 21:07:28 +00001685}
1686#endif
1687
Guido van Rossumf102e242007-03-23 18:53:03 +00001688/* Forward */
1689static int
1690object_init(PyObject *self, PyObject *args, PyObject *kwds);
1691
1692static int
1693type_init(PyObject *cls, PyObject *args, PyObject *kwds)
1694{
1695 int res;
1696
1697 assert(args != NULL && PyTuple_Check(args));
1698 assert(kwds == NULL || PyDict_Check(kwds));
1699
1700 if (kwds != NULL && PyDict_Check(kwds) && PyDict_Size(kwds) != 0) {
1701 PyErr_SetString(PyExc_TypeError,
1702 "type.__init__() takes no keyword arguments");
1703 return -1;
1704 }
1705
1706 if (args != NULL && PyTuple_Check(args) &&
1707 (PyTuple_GET_SIZE(args) != 1 && PyTuple_GET_SIZE(args) != 3)) {
1708 PyErr_SetString(PyExc_TypeError,
1709 "type.__init__() takes 1 or 3 arguments");
1710 return -1;
1711 }
1712
1713 /* Call object.__init__(self) now. */
1714 /* XXX Could call super(type, cls).__init__() but what's the point? */
1715 args = PyTuple_GetSlice(args, 0, 0);
1716 res = object_init(cls, args, NULL);
1717 Py_DECREF(args);
1718 return res;
1719}
1720
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001721static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001722type_new(PyTypeObject *metatype, PyObject *args, PyObject *kwds)
1723{
1724 PyObject *name, *bases, *dict;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001725 static char *kwlist[] = {"name", "bases", "dict", 0};
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001726 PyObject *slots, *tmp, *newslots;
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001727 PyTypeObject *type, *base, *tmptype, *winner;
Guido van Rossume5c691a2003-03-07 15:13:17 +00001728 PyHeapTypeObject *et;
Guido van Rossum6f799372001-09-20 20:46:19 +00001729 PyMemberDef *mp;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001730 Py_ssize_t i, nbases, nslots, slotoffset, add_dict, add_weak;
Guido van Rossumad47da02002-08-12 19:05:44 +00001731 int j, may_add_dict, may_add_weak;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001732
Tim Peters3abca122001-10-27 19:37:48 +00001733 assert(args != NULL && PyTuple_Check(args));
1734 assert(kwds == NULL || PyDict_Check(kwds));
1735
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001736 /* Special case: type(x) should return x->ob_type */
Tim Peters3abca122001-10-27 19:37:48 +00001737 {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001738 const Py_ssize_t nargs = PyTuple_GET_SIZE(args);
1739 const Py_ssize_t nkwds = kwds == NULL ? 0 : PyDict_Size(kwds);
Tim Peters3abca122001-10-27 19:37:48 +00001740
1741 if (PyType_CheckExact(metatype) && nargs == 1 && nkwds == 0) {
1742 PyObject *x = PyTuple_GET_ITEM(args, 0);
Christian Heimese93237d2007-12-19 02:37:44 +00001743 Py_INCREF(Py_TYPE(x));
1744 return (PyObject *) Py_TYPE(x);
Tim Peters3abca122001-10-27 19:37:48 +00001745 }
1746
1747 /* SF bug 475327 -- if that didn't trigger, we need 3
1748 arguments. but PyArg_ParseTupleAndKeywords below may give
1749 a msg saying type() needs exactly 3. */
1750 if (nargs + nkwds != 3) {
1751 PyErr_SetString(PyExc_TypeError,
1752 "type() takes 1 or 3 arguments");
1753 return NULL;
1754 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001755 }
1756
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001757 /* Check arguments: (name, bases, dict) */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001758 if (!PyArg_ParseTupleAndKeywords(args, kwds, "SO!O!:type", kwlist,
1759 &name,
1760 &PyTuple_Type, &bases,
1761 &PyDict_Type, &dict))
1762 return NULL;
1763
Armin Rigoc0ba52d2007-04-19 14:44:48 +00001764 /* Determine the proper metatype to deal with this,
1765 and check for metatype conflicts while we're at it.
1766 Note that if some other metatype wins to contract,
1767 it's possible that its instances are not types. */
1768 nbases = PyTuple_GET_SIZE(bases);
1769 winner = metatype;
1770 for (i = 0; i < nbases; i++) {
1771 tmp = PyTuple_GET_ITEM(bases, i);
1772 tmptype = tmp->ob_type;
1773 if (tmptype == &PyClass_Type)
1774 continue; /* Special case classic classes */
1775 if (PyType_IsSubtype(winner, tmptype))
1776 continue;
1777 if (PyType_IsSubtype(tmptype, winner)) {
1778 winner = tmptype;
1779 continue;
Jeremy Hyltonfa955692007-02-27 18:29:45 +00001780 }
Armin Rigoc0ba52d2007-04-19 14:44:48 +00001781 PyErr_SetString(PyExc_TypeError,
1782 "metaclass conflict: "
1783 "the metaclass of a derived class "
1784 "must be a (non-strict) subclass "
1785 "of the metaclasses of all its bases");
1786 return NULL;
1787 }
1788 if (winner != metatype) {
1789 if (winner->tp_new != type_new) /* Pass it to the winner */
1790 return winner->tp_new(winner, args, kwds);
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001791 metatype = winner;
1792 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001793
1794 /* Adjust for empty tuple bases */
1795 if (nbases == 0) {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00001796 bases = PyTuple_Pack(1, &PyBaseObject_Type);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001797 if (bases == NULL)
1798 return NULL;
1799 nbases = 1;
1800 }
1801 else
1802 Py_INCREF(bases);
1803
1804 /* XXX From here until type is allocated, "return NULL" leaks bases! */
1805
1806 /* Calculate best base, and check that all bases are type objects */
1807 base = best_base(bases);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001808 if (base == NULL) {
1809 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001810 return NULL;
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001811 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001812 if (!PyType_HasFeature(base, Py_TPFLAGS_BASETYPE)) {
1813 PyErr_Format(PyExc_TypeError,
1814 "type '%.100s' is not an acceptable base type",
1815 base->tp_name);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001816 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001817 return NULL;
1818 }
1819
Tim Peters6d6c1a32001-08-02 04:15:00 +00001820 /* Check for a __slots__ sequence variable in dict, and count it */
1821 slots = PyDict_GetItemString(dict, "__slots__");
1822 nslots = 0;
Guido van Rossum9676b222001-08-17 20:32:36 +00001823 add_dict = 0;
1824 add_weak = 0;
Guido van Rossumad47da02002-08-12 19:05:44 +00001825 may_add_dict = base->tp_dictoffset == 0;
1826 may_add_weak = base->tp_weaklistoffset == 0 && base->tp_itemsize == 0;
1827 if (slots == NULL) {
1828 if (may_add_dict) {
1829 add_dict++;
1830 }
1831 if (may_add_weak) {
1832 add_weak++;
1833 }
1834 }
1835 else {
1836 /* Have slots */
1837
Tim Peters6d6c1a32001-08-02 04:15:00 +00001838 /* Make it into a tuple */
Neal Norwitzcbd9ee62007-04-14 05:25:50 +00001839 if (PyString_Check(slots) || PyUnicode_Check(slots))
Raymond Hettinger8ae46892003-10-12 19:09:37 +00001840 slots = PyTuple_Pack(1, slots);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001841 else
1842 slots = PySequence_Tuple(slots);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001843 if (slots == NULL) {
1844 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001845 return NULL;
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001846 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001847 assert(PyTuple_Check(slots));
1848
1849 /* Are slots allowed? */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001850 nslots = PyTuple_GET_SIZE(slots);
Jeremy Hylton1c7a0ea2003-07-16 16:08:23 +00001851 if (nslots > 0 && base->tp_itemsize != 0) {
Guido van Rossumc4141872001-08-30 04:43:35 +00001852 PyErr_Format(PyExc_TypeError,
1853 "nonempty __slots__ "
1854 "not supported for subtype of '%s'",
1855 base->tp_name);
Guido van Rossumad47da02002-08-12 19:05:44 +00001856 bad_slots:
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001857 Py_DECREF(bases);
Guido van Rossumad47da02002-08-12 19:05:44 +00001858 Py_DECREF(slots);
Guido van Rossumc4141872001-08-30 04:43:35 +00001859 return NULL;
1860 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001861
Martin v. Löwisd919a592002-10-14 21:07:28 +00001862#ifdef Py_USING_UNICODE
1863 tmp = _unicode_to_string(slots, nslots);
Žiga Seilnacht71436f02007-03-14 12:24:09 +00001864 if (tmp == NULL)
1865 goto bad_slots;
Martin v. Löwis13b1a5c2002-10-14 21:11:34 +00001866 if (tmp != slots) {
1867 Py_DECREF(slots);
1868 slots = tmp;
1869 }
Martin v. Löwisd919a592002-10-14 21:07:28 +00001870#endif
Guido van Rossumad47da02002-08-12 19:05:44 +00001871 /* Check for valid slot names and two special cases */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001872 for (i = 0; i < nslots; i++) {
Guido van Rossumad47da02002-08-12 19:05:44 +00001873 PyObject *tmp = PyTuple_GET_ITEM(slots, i);
1874 char *s;
1875 if (!valid_identifier(tmp))
1876 goto bad_slots;
1877 assert(PyString_Check(tmp));
1878 s = PyString_AS_STRING(tmp);
1879 if (strcmp(s, "__dict__") == 0) {
1880 if (!may_add_dict || add_dict) {
1881 PyErr_SetString(PyExc_TypeError,
1882 "__dict__ slot disallowed: "
1883 "we already got one");
1884 goto bad_slots;
1885 }
1886 add_dict++;
1887 }
1888 if (strcmp(s, "__weakref__") == 0) {
1889 if (!may_add_weak || add_weak) {
1890 PyErr_SetString(PyExc_TypeError,
1891 "__weakref__ slot disallowed: "
1892 "either we already got one, "
1893 "or __itemsize__ != 0");
1894 goto bad_slots;
1895 }
1896 add_weak++;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001897 }
1898 }
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001899
Žiga Seilnacht6f2d09c2007-03-16 11:59:38 +00001900 /* Copy slots into a list, mangle names and sort them.
1901 Sorted names are needed for __class__ assignment.
1902 Convert them back to tuple at the end.
1903 */
1904 newslots = PyList_New(nslots - add_dict - add_weak);
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001905 if (newslots == NULL)
Guido van Rossumad47da02002-08-12 19:05:44 +00001906 goto bad_slots;
1907 for (i = j = 0; i < nslots; i++) {
1908 char *s;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001909 tmp = PyTuple_GET_ITEM(slots, i);
Guido van Rossumad47da02002-08-12 19:05:44 +00001910 s = PyString_AS_STRING(tmp);
1911 if ((add_dict && strcmp(s, "__dict__") == 0) ||
1912 (add_weak && strcmp(s, "__weakref__") == 0))
1913 continue;
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001914 tmp =_Py_Mangle(name, tmp);
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00001915 if (!tmp)
1916 goto bad_slots;
Žiga Seilnacht6f2d09c2007-03-16 11:59:38 +00001917 PyList_SET_ITEM(newslots, j, tmp);
Guido van Rossumad47da02002-08-12 19:05:44 +00001918 j++;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001919 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001920 assert(j == nslots - add_dict - add_weak);
1921 nslots = j;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001922 Py_DECREF(slots);
Žiga Seilnacht6f2d09c2007-03-16 11:59:38 +00001923 if (PyList_Sort(newslots) == -1) {
1924 Py_DECREF(bases);
1925 Py_DECREF(newslots);
1926 return NULL;
1927 }
1928 slots = PyList_AsTuple(newslots);
1929 Py_DECREF(newslots);
1930 if (slots == NULL) {
1931 Py_DECREF(bases);
1932 return NULL;
1933 }
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001934
Guido van Rossumad47da02002-08-12 19:05:44 +00001935 /* Secondary bases may provide weakrefs or dict */
1936 if (nbases > 1 &&
1937 ((may_add_dict && !add_dict) ||
1938 (may_add_weak && !add_weak))) {
1939 for (i = 0; i < nbases; i++) {
1940 tmp = PyTuple_GET_ITEM(bases, i);
1941 if (tmp == (PyObject *)base)
1942 continue; /* Skip primary base */
1943 if (PyClass_Check(tmp)) {
1944 /* Classic base class provides both */
1945 if (may_add_dict && !add_dict)
1946 add_dict++;
1947 if (may_add_weak && !add_weak)
1948 add_weak++;
1949 break;
1950 }
1951 assert(PyType_Check(tmp));
1952 tmptype = (PyTypeObject *)tmp;
1953 if (may_add_dict && !add_dict &&
1954 tmptype->tp_dictoffset != 0)
1955 add_dict++;
1956 if (may_add_weak && !add_weak &&
1957 tmptype->tp_weaklistoffset != 0)
1958 add_weak++;
1959 if (may_add_dict && !add_dict)
1960 continue;
1961 if (may_add_weak && !add_weak)
1962 continue;
1963 /* Nothing more to check */
1964 break;
1965 }
1966 }
Guido van Rossum9676b222001-08-17 20:32:36 +00001967 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001968
1969 /* XXX From here until type is safely allocated,
1970 "return NULL" may leak slots! */
1971
1972 /* Allocate the type object */
1973 type = (PyTypeObject *)metatype->tp_alloc(metatype, nslots);
Guido van Rossumad47da02002-08-12 19:05:44 +00001974 if (type == NULL) {
1975 Py_XDECREF(slots);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001976 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001977 return NULL;
Guido van Rossumad47da02002-08-12 19:05:44 +00001978 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001979
1980 /* Keep name and slots alive in the extended type object */
Guido van Rossume5c691a2003-03-07 15:13:17 +00001981 et = (PyHeapTypeObject *)type;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001982 Py_INCREF(name);
Georg Brandlc255c7b2006-02-20 22:27:28 +00001983 et->ht_name = name;
1984 et->ht_slots = slots;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001985
Guido van Rossumdc91b992001-08-08 22:26:22 +00001986 /* Initialize tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001987 type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HEAPTYPE |
1988 Py_TPFLAGS_BASETYPE;
Guido van Rossum048eb752001-10-02 21:24:57 +00001989 if (base->tp_flags & Py_TPFLAGS_HAVE_GC)
1990 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
Guido van Rossumdc91b992001-08-08 22:26:22 +00001991
1992 /* It's a new-style number unless it specifically inherits any
1993 old-style numeric behavior */
1994 if ((base->tp_flags & Py_TPFLAGS_CHECKTYPES) ||
1995 (base->tp_as_number == NULL))
1996 type->tp_flags |= Py_TPFLAGS_CHECKTYPES;
1997
1998 /* Initialize essential fields */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001999 type->tp_as_number = &et->as_number;
2000 type->tp_as_sequence = &et->as_sequence;
2001 type->tp_as_mapping = &et->as_mapping;
2002 type->tp_as_buffer = &et->as_buffer;
2003 type->tp_name = PyString_AS_STRING(name);
2004
2005 /* Set tp_base and tp_bases */
2006 type->tp_bases = bases;
2007 Py_INCREF(base);
2008 type->tp_base = base;
2009
Guido van Rossum687ae002001-10-15 22:03:32 +00002010 /* Initialize tp_dict from passed-in dict */
2011 type->tp_dict = dict = PyDict_Copy(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002012 if (dict == NULL) {
2013 Py_DECREF(type);
2014 return NULL;
2015 }
2016
Guido van Rossumc3542212001-08-16 09:18:56 +00002017 /* Set __module__ in the dict */
2018 if (PyDict_GetItemString(dict, "__module__") == NULL) {
2019 tmp = PyEval_GetGlobals();
2020 if (tmp != NULL) {
2021 tmp = PyDict_GetItemString(tmp, "__name__");
2022 if (tmp != NULL) {
2023 if (PyDict_SetItemString(dict, "__module__",
2024 tmp) < 0)
2025 return NULL;
2026 }
2027 }
2028 }
2029
Tim Peters2f93e282001-10-04 05:27:00 +00002030 /* Set tp_doc to a copy of dict['__doc__'], if the latter is there
Tim Peters24008312002-03-17 18:56:20 +00002031 and is a string. The __doc__ accessor will first look for tp_doc;
2032 if that fails, it will still look into __dict__.
Tim Peters2f93e282001-10-04 05:27:00 +00002033 */
2034 {
2035 PyObject *doc = PyDict_GetItemString(dict, "__doc__");
2036 if (doc != NULL && PyString_Check(doc)) {
2037 const size_t n = (size_t)PyString_GET_SIZE(doc);
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002038 char *tp_doc = (char *)PyObject_MALLOC(n+1);
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002039 if (tp_doc == NULL) {
Tim Peters2f93e282001-10-04 05:27:00 +00002040 Py_DECREF(type);
2041 return NULL;
2042 }
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002043 memcpy(tp_doc, PyString_AS_STRING(doc), n+1);
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002044 type->tp_doc = tp_doc;
Tim Peters2f93e282001-10-04 05:27:00 +00002045 }
2046 }
2047
Tim Peters6d6c1a32001-08-02 04:15:00 +00002048 /* Special-case __new__: if it's a plain function,
2049 make it a static function */
2050 tmp = PyDict_GetItemString(dict, "__new__");
2051 if (tmp != NULL && PyFunction_Check(tmp)) {
2052 tmp = PyStaticMethod_New(tmp);
2053 if (tmp == NULL) {
2054 Py_DECREF(type);
2055 return NULL;
2056 }
2057 PyDict_SetItemString(dict, "__new__", tmp);
2058 Py_DECREF(tmp);
2059 }
2060
2061 /* Add descriptors for custom slots from __slots__, or for __dict__ */
Guido van Rossume5c691a2003-03-07 15:13:17 +00002062 mp = PyHeapType_GET_MEMBERS(et);
Neil Schemenauerc806c882001-08-29 23:54:54 +00002063 slotoffset = base->tp_basicsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002064 if (slots != NULL) {
2065 for (i = 0; i < nslots; i++, mp++) {
2066 mp->name = PyString_AS_STRING(
2067 PyTuple_GET_ITEM(slots, i));
Guido van Rossum64b206c2001-12-04 17:13:22 +00002068 mp->type = T_OBJECT_EX;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002069 mp->offset = slotoffset;
Žiga Seilnacht89032082007-03-11 15:54:54 +00002070
2071 /* __dict__ and __weakref__ are already filtered out */
2072 assert(strcmp(mp->name, "__dict__") != 0);
2073 assert(strcmp(mp->name, "__weakref__") != 0);
2074
Tim Peters6d6c1a32001-08-02 04:15:00 +00002075 slotoffset += sizeof(PyObject *);
2076 }
2077 }
Guido van Rossumad47da02002-08-12 19:05:44 +00002078 if (add_dict) {
2079 if (base->tp_itemsize)
2080 type->tp_dictoffset = -(long)sizeof(PyObject *);
2081 else
2082 type->tp_dictoffset = slotoffset;
2083 slotoffset += sizeof(PyObject *);
2084 }
2085 if (add_weak) {
2086 assert(!base->tp_itemsize);
2087 type->tp_weaklistoffset = slotoffset;
2088 slotoffset += sizeof(PyObject *);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002089 }
2090 type->tp_basicsize = slotoffset;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00002091 type->tp_itemsize = base->tp_itemsize;
Guido van Rossume5c691a2003-03-07 15:13:17 +00002092 type->tp_members = PyHeapType_GET_MEMBERS(et);
Guido van Rossum373c7412003-01-07 13:41:37 +00002093
2094 if (type->tp_weaklistoffset && type->tp_dictoffset)
2095 type->tp_getset = subtype_getsets_full;
2096 else if (type->tp_weaklistoffset && !type->tp_dictoffset)
2097 type->tp_getset = subtype_getsets_weakref_only;
2098 else if (!type->tp_weaklistoffset && type->tp_dictoffset)
2099 type->tp_getset = subtype_getsets_dict_only;
2100 else
2101 type->tp_getset = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002102
2103 /* Special case some slots */
2104 if (type->tp_dictoffset != 0 || nslots > 0) {
2105 if (base->tp_getattr == NULL && base->tp_getattro == NULL)
2106 type->tp_getattro = PyObject_GenericGetAttr;
2107 if (base->tp_setattr == NULL && base->tp_setattro == NULL)
2108 type->tp_setattro = PyObject_GenericSetAttr;
2109 }
2110 type->tp_dealloc = subtype_dealloc;
2111
Guido van Rossum9475a232001-10-05 20:51:39 +00002112 /* Enable GC unless there are really no instance variables possible */
2113 if (!(type->tp_basicsize == sizeof(PyObject) &&
2114 type->tp_itemsize == 0))
2115 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
2116
Tim Peters6d6c1a32001-08-02 04:15:00 +00002117 /* Always override allocation strategy to use regular heap */
2118 type->tp_alloc = PyType_GenericAlloc;
Guido van Rossum048eb752001-10-02 21:24:57 +00002119 if (type->tp_flags & Py_TPFLAGS_HAVE_GC) {
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00002120 type->tp_free = PyObject_GC_Del;
Guido van Rossum9475a232001-10-05 20:51:39 +00002121 type->tp_traverse = subtype_traverse;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00002122 type->tp_clear = subtype_clear;
Guido van Rossum048eb752001-10-02 21:24:57 +00002123 }
2124 else
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00002125 type->tp_free = PyObject_Del;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002126
2127 /* Initialize the rest */
Guido van Rossum528b7eb2001-08-07 17:24:28 +00002128 if (PyType_Ready(type) < 0) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00002129 Py_DECREF(type);
2130 return NULL;
2131 }
2132
Guido van Rossum7b9144b2001-10-09 19:39:46 +00002133 /* Put the proper slots in place */
2134 fixup_slot_dispatchers(type);
Guido van Rossumf040ede2001-08-07 16:40:56 +00002135
Tim Peters6d6c1a32001-08-02 04:15:00 +00002136 return (PyObject *)type;
2137}
2138
2139/* Internal API to look for a name through the MRO.
2140 This returns a borrowed reference, and doesn't set an exception! */
2141PyObject *
2142_PyType_Lookup(PyTypeObject *type, PyObject *name)
2143{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002144 Py_ssize_t i, n;
Tim Petersa91e9642001-11-14 23:32:33 +00002145 PyObject *mro, *res, *base, *dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002146
Guido van Rossum687ae002001-10-15 22:03:32 +00002147 /* Look in tp_dict of types in MRO */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002148 mro = type->tp_mro;
Guido van Rossum23094982002-06-10 14:30:43 +00002149
2150 /* If mro is NULL, the type is either not yet initialized
2151 by PyType_Ready(), or already cleared by type_clear().
2152 Either way the safest thing to do is to return NULL. */
2153 if (mro == NULL)
2154 return NULL;
2155
Tim Peters6d6c1a32001-08-02 04:15:00 +00002156 assert(PyTuple_Check(mro));
2157 n = PyTuple_GET_SIZE(mro);
2158 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00002159 base = PyTuple_GET_ITEM(mro, i);
2160 if (PyClass_Check(base))
2161 dict = ((PyClassObject *)base)->cl_dict;
2162 else {
2163 assert(PyType_Check(base));
2164 dict = ((PyTypeObject *)base)->tp_dict;
2165 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002166 assert(dict && PyDict_Check(dict));
2167 res = PyDict_GetItem(dict, name);
2168 if (res != NULL)
2169 return res;
2170 }
2171 return NULL;
2172}
2173
2174/* This is similar to PyObject_GenericGetAttr(),
2175 but uses _PyType_Lookup() instead of just looking in type->tp_dict. */
2176static PyObject *
2177type_getattro(PyTypeObject *type, PyObject *name)
2178{
Christian Heimese93237d2007-12-19 02:37:44 +00002179 PyTypeObject *metatype = Py_TYPE(type);
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002180 PyObject *meta_attribute, *attribute;
2181 descrgetfunc meta_get;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002182
2183 /* Initialize this type (we'll assume the metatype is initialized) */
2184 if (type->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00002185 if (PyType_Ready(type) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002186 return NULL;
2187 }
2188
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002189 /* No readable descriptor found yet */
2190 meta_get = NULL;
Tim Peters34592512002-07-11 06:23:50 +00002191
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002192 /* Look for the attribute in the metatype */
2193 meta_attribute = _PyType_Lookup(metatype, name);
2194
2195 if (meta_attribute != NULL) {
Christian Heimese93237d2007-12-19 02:37:44 +00002196 meta_get = Py_TYPE(meta_attribute)->tp_descr_get;
Tim Peters34592512002-07-11 06:23:50 +00002197
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002198 if (meta_get != NULL && PyDescr_IsData(meta_attribute)) {
2199 /* Data descriptors implement tp_descr_set to intercept
2200 * writes. Assume the attribute is not overridden in
2201 * type's tp_dict (and bases): call the descriptor now.
2202 */
2203 return meta_get(meta_attribute, (PyObject *)type,
2204 (PyObject *)metatype);
2205 }
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002206 Py_INCREF(meta_attribute);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002207 }
2208
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002209 /* No data descriptor found on metatype. Look in tp_dict of this
2210 * type and its bases */
2211 attribute = _PyType_Lookup(type, name);
2212 if (attribute != NULL) {
2213 /* Implement descriptor functionality, if any */
Christian Heimese93237d2007-12-19 02:37:44 +00002214 descrgetfunc local_get = Py_TYPE(attribute)->tp_descr_get;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002215
2216 Py_XDECREF(meta_attribute);
2217
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002218 if (local_get != NULL) {
2219 /* NULL 2nd argument indicates the descriptor was
2220 * found on the target object itself (or a base) */
2221 return local_get(attribute, (PyObject *)NULL,
2222 (PyObject *)type);
2223 }
Tim Peters34592512002-07-11 06:23:50 +00002224
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002225 Py_INCREF(attribute);
2226 return attribute;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002227 }
2228
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002229 /* No attribute found in local __dict__ (or bases): use the
2230 * descriptor from the metatype, if any */
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002231 if (meta_get != NULL) {
2232 PyObject *res;
2233 res = meta_get(meta_attribute, (PyObject *)type,
2234 (PyObject *)metatype);
2235 Py_DECREF(meta_attribute);
2236 return res;
2237 }
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002238
2239 /* If an ordinary attribute was found on the metatype, return it now */
2240 if (meta_attribute != NULL) {
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002241 return meta_attribute;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002242 }
2243
2244 /* Give up */
2245 PyErr_Format(PyExc_AttributeError,
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002246 "type object '%.50s' has no attribute '%.400s'",
2247 type->tp_name, PyString_AS_STRING(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +00002248 return NULL;
2249}
2250
2251static int
2252type_setattro(PyTypeObject *type, PyObject *name, PyObject *value)
2253{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00002254 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
2255 PyErr_Format(
2256 PyExc_TypeError,
2257 "can't set attributes of built-in/extension type '%s'",
2258 type->tp_name);
2259 return -1;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00002260 }
Guido van Rossum8d24ee92003-03-24 23:49:49 +00002261 /* XXX Example of how I expect this to be used...
2262 if (update_subclasses(type, name, invalidate_cache, NULL) < 0)
2263 return -1;
2264 */
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00002265 if (PyObject_GenericSetAttr((PyObject *)type, name, value) < 0)
2266 return -1;
2267 return update_slot(type, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002268}
2269
2270static void
2271type_dealloc(PyTypeObject *type)
2272{
Guido van Rossume5c691a2003-03-07 15:13:17 +00002273 PyHeapTypeObject *et;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002274
2275 /* Assert this is a heap-allocated type object */
2276 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002277 _PyObject_GC_UNTRACK(type);
Guido van Rossum1c450732001-10-08 15:18:27 +00002278 PyObject_ClearWeakRefs((PyObject *)type);
Guido van Rossume5c691a2003-03-07 15:13:17 +00002279 et = (PyHeapTypeObject *)type;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002280 Py_XDECREF(type->tp_base);
2281 Py_XDECREF(type->tp_dict);
2282 Py_XDECREF(type->tp_bases);
2283 Py_XDECREF(type->tp_mro);
Guido van Rossum687ae002001-10-15 22:03:32 +00002284 Py_XDECREF(type->tp_cache);
Guido van Rossum1c450732001-10-08 15:18:27 +00002285 Py_XDECREF(type->tp_subclasses);
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002286 /* A type's tp_doc is heap allocated, unlike the tp_doc slots
2287 * of most other objects. It's okay to cast it to char *.
2288 */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002289 PyObject_Free((char *)type->tp_doc);
Georg Brandlc255c7b2006-02-20 22:27:28 +00002290 Py_XDECREF(et->ht_name);
2291 Py_XDECREF(et->ht_slots);
Christian Heimese93237d2007-12-19 02:37:44 +00002292 Py_TYPE(type)->tp_free((PyObject *)type);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002293}
2294
Guido van Rossum1c450732001-10-08 15:18:27 +00002295static PyObject *
2296type_subclasses(PyTypeObject *type, PyObject *args_ignored)
2297{
2298 PyObject *list, *raw, *ref;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002299 Py_ssize_t i, n;
Guido van Rossum1c450732001-10-08 15:18:27 +00002300
2301 list = PyList_New(0);
2302 if (list == NULL)
2303 return NULL;
2304 raw = type->tp_subclasses;
2305 if (raw == NULL)
2306 return list;
2307 assert(PyList_Check(raw));
2308 n = PyList_GET_SIZE(raw);
2309 for (i = 0; i < n; i++) {
2310 ref = PyList_GET_ITEM(raw, i);
Tim Peters44383382001-10-08 16:49:26 +00002311 assert(PyWeakref_CheckRef(ref));
Guido van Rossum1c450732001-10-08 15:18:27 +00002312 ref = PyWeakref_GET_OBJECT(ref);
2313 if (ref != Py_None) {
2314 if (PyList_Append(list, ref) < 0) {
2315 Py_DECREF(list);
2316 return NULL;
2317 }
2318 }
2319 }
2320 return list;
2321}
2322
Tim Peters6d6c1a32001-08-02 04:15:00 +00002323static PyMethodDef type_methods[] = {
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002324 {"mro", (PyCFunction)mro_external, METH_NOARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002325 PyDoc_STR("mro() -> list\nreturn a type's method resolution order")},
Guido van Rossum1c450732001-10-08 15:18:27 +00002326 {"__subclasses__", (PyCFunction)type_subclasses, METH_NOARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002327 PyDoc_STR("__subclasses__() -> list of immediate subclasses")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00002328 {0}
2329};
2330
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002331PyDoc_STRVAR(type_doc,
Tim Peters6d6c1a32001-08-02 04:15:00 +00002332"type(object) -> the object's type\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002333"type(name, bases, dict) -> a new type");
Tim Peters6d6c1a32001-08-02 04:15:00 +00002334
Guido van Rossum048eb752001-10-02 21:24:57 +00002335static int
2336type_traverse(PyTypeObject *type, visitproc visit, void *arg)
2337{
Guido van Rossuma3862092002-06-10 15:24:42 +00002338 /* Because of type_is_gc(), the collector only calls this
2339 for heaptypes. */
2340 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002341
Thomas Woutersc6e55062006-04-15 21:47:09 +00002342 Py_VISIT(type->tp_dict);
2343 Py_VISIT(type->tp_cache);
2344 Py_VISIT(type->tp_mro);
2345 Py_VISIT(type->tp_bases);
2346 Py_VISIT(type->tp_base);
Guido van Rossuma3862092002-06-10 15:24:42 +00002347
2348 /* There's no need to visit type->tp_subclasses or
Georg Brandlc255c7b2006-02-20 22:27:28 +00002349 ((PyHeapTypeObject *)type)->ht_slots, because they can't be involved
Guido van Rossuma3862092002-06-10 15:24:42 +00002350 in cycles; tp_subclasses is a list of weak references,
2351 and slots is a tuple of strings. */
Guido van Rossum048eb752001-10-02 21:24:57 +00002352
Guido van Rossum048eb752001-10-02 21:24:57 +00002353 return 0;
2354}
2355
2356static int
2357type_clear(PyTypeObject *type)
2358{
Guido van Rossuma3862092002-06-10 15:24:42 +00002359 /* Because of type_is_gc(), the collector only calls this
2360 for heaptypes. */
2361 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002362
Guido van Rossuma3862092002-06-10 15:24:42 +00002363 /* The only field we need to clear is tp_mro, which is part of a
2364 hard cycle (its first element is the class itself) that won't
2365 be broken otherwise (it's a tuple and tuples don't have a
2366 tp_clear handler). None of the other fields need to be
2367 cleared, and here's why:
Guido van Rossum048eb752001-10-02 21:24:57 +00002368
Guido van Rossuma3862092002-06-10 15:24:42 +00002369 tp_dict:
2370 It is a dict, so the collector will call its tp_clear.
2371
2372 tp_cache:
2373 Not used; if it were, it would be a dict.
2374
2375 tp_bases, tp_base:
2376 If these are involved in a cycle, there must be at least
2377 one other, mutable object in the cycle, e.g. a base
2378 class's dict; the cycle will be broken that way.
2379
2380 tp_subclasses:
2381 A list of weak references can't be part of a cycle; and
2382 lists have their own tp_clear.
2383
Guido van Rossume5c691a2003-03-07 15:13:17 +00002384 slots (in PyHeapTypeObject):
Guido van Rossuma3862092002-06-10 15:24:42 +00002385 A tuple of strings can't be part of a cycle.
2386 */
2387
Thomas Woutersedf17d82006-04-15 17:28:34 +00002388 Py_CLEAR(type->tp_mro);
Guido van Rossum048eb752001-10-02 21:24:57 +00002389
2390 return 0;
2391}
2392
2393static int
2394type_is_gc(PyTypeObject *type)
2395{
2396 return type->tp_flags & Py_TPFLAGS_HEAPTYPE;
2397}
2398
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002399PyTypeObject PyType_Type = {
Martin v. Löwis68192102007-07-21 06:55:02 +00002400 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002401 "type", /* tp_name */
Guido van Rossume5c691a2003-03-07 15:13:17 +00002402 sizeof(PyHeapTypeObject), /* tp_basicsize */
Guido van Rossum6f799372001-09-20 20:46:19 +00002403 sizeof(PyMemberDef), /* tp_itemsize */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002404 (destructor)type_dealloc, /* tp_dealloc */
2405 0, /* tp_print */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002406 0, /* tp_getattr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002407 0, /* tp_setattr */
2408 type_compare, /* tp_compare */
2409 (reprfunc)type_repr, /* tp_repr */
2410 0, /* tp_as_number */
2411 0, /* tp_as_sequence */
2412 0, /* tp_as_mapping */
2413 (hashfunc)_Py_HashPointer, /* tp_hash */
2414 (ternaryfunc)type_call, /* tp_call */
2415 0, /* tp_str */
2416 (getattrofunc)type_getattro, /* tp_getattro */
2417 (setattrofunc)type_setattro, /* tp_setattro */
2418 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00002419 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
Neal Norwitzee3a1b52007-02-25 19:44:48 +00002420 Py_TPFLAGS_BASETYPE | Py_TPFLAGS_TYPE_SUBCLASS, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002421 type_doc, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +00002422 (traverseproc)type_traverse, /* tp_traverse */
2423 (inquiry)type_clear, /* tp_clear */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002424 0, /* tp_richcompare */
Guido van Rossum1c450732001-10-08 15:18:27 +00002425 offsetof(PyTypeObject, tp_weaklist), /* tp_weaklistoffset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002426 0, /* tp_iter */
2427 0, /* tp_iternext */
2428 type_methods, /* tp_methods */
2429 type_members, /* tp_members */
2430 type_getsets, /* tp_getset */
2431 0, /* tp_base */
2432 0, /* tp_dict */
2433 0, /* tp_descr_get */
2434 0, /* tp_descr_set */
2435 offsetof(PyTypeObject, tp_dict), /* tp_dictoffset */
Guido van Rossumf102e242007-03-23 18:53:03 +00002436 type_init, /* tp_init */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002437 0, /* tp_alloc */
2438 type_new, /* tp_new */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00002439 PyObject_GC_Del, /* tp_free */
Guido van Rossum048eb752001-10-02 21:24:57 +00002440 (inquiry)type_is_gc, /* tp_is_gc */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002441};
Tim Peters6d6c1a32001-08-02 04:15:00 +00002442
2443
2444/* The base type of all types (eventually)... except itself. */
2445
Guido van Rossum143b5642007-03-23 04:58:42 +00002446/* You may wonder why object.__new__() only complains about arguments
2447 when object.__init__() is not overridden, and vice versa.
2448
2449 Consider the use cases:
2450
2451 1. When neither is overridden, we want to hear complaints about
2452 excess (i.e., any) arguments, since their presence could
2453 indicate there's a bug.
2454
2455 2. When defining an Immutable type, we are likely to override only
2456 __new__(), since __init__() is called too late to initialize an
2457 Immutable object. Since __new__() defines the signature for the
2458 type, it would be a pain to have to override __init__() just to
2459 stop it from complaining about excess arguments.
2460
2461 3. When defining a Mutable type, we are likely to override only
2462 __init__(). So here the converse reasoning applies: we don't
2463 want to have to override __new__() just to stop it from
2464 complaining.
2465
2466 4. When __init__() is overridden, and the subclass __init__() calls
2467 object.__init__(), the latter should complain about excess
2468 arguments; ditto for __new__().
2469
2470 Use cases 2 and 3 make it unattractive to unconditionally check for
2471 excess arguments. The best solution that addresses all four use
2472 cases is as follows: __init__() complains about excess arguments
2473 unless __new__() is overridden and __init__() is not overridden
2474 (IOW, if __init__() is overridden or __new__() is not overridden);
2475 symmetrically, __new__() complains about excess arguments unless
2476 __init__() is overridden and __new__() is not overridden
2477 (IOW, if __new__() is overridden or __init__() is not overridden).
2478
2479 However, for backwards compatibility, this breaks too much code.
2480 Therefore, in 2.6, we'll *warn* about excess arguments when both
2481 methods are overridden; for all other cases we'll use the above
2482 rules.
2483
2484*/
2485
2486/* Forward */
2487static PyObject *
2488object_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
2489
2490static int
2491excess_args(PyObject *args, PyObject *kwds)
2492{
2493 return PyTuple_GET_SIZE(args) ||
2494 (kwds && PyDict_Check(kwds) && PyDict_Size(kwds));
2495}
2496
Tim Peters6d6c1a32001-08-02 04:15:00 +00002497static int
2498object_init(PyObject *self, PyObject *args, PyObject *kwds)
2499{
Guido van Rossum143b5642007-03-23 04:58:42 +00002500 int err = 0;
2501 if (excess_args(args, kwds)) {
Christian Heimese93237d2007-12-19 02:37:44 +00002502 PyTypeObject *type = Py_TYPE(self);
Guido van Rossum143b5642007-03-23 04:58:42 +00002503 if (type->tp_init != object_init &&
2504 type->tp_new != object_new)
2505 {
2506 err = PyErr_WarnEx(PyExc_DeprecationWarning,
2507 "object.__init__() takes no parameters",
2508 1);
2509 }
2510 else if (type->tp_init != object_init ||
2511 type->tp_new == object_new)
2512 {
2513 PyErr_SetString(PyExc_TypeError,
2514 "object.__init__() takes no parameters");
2515 err = -1;
2516 }
2517 }
2518 return err;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002519}
2520
Guido van Rossum298e4212003-02-13 16:30:16 +00002521static PyObject *
2522object_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
2523{
Guido van Rossum143b5642007-03-23 04:58:42 +00002524 int err = 0;
2525 if (excess_args(args, kwds)) {
2526 if (type->tp_new != object_new &&
2527 type->tp_init != object_init)
2528 {
2529 err = PyErr_WarnEx(PyExc_DeprecationWarning,
2530 "object.__new__() takes no parameters",
2531 1);
2532 }
2533 else if (type->tp_new != object_new ||
2534 type->tp_init == object_init)
2535 {
2536 PyErr_SetString(PyExc_TypeError,
2537 "object.__new__() takes no parameters");
2538 err = -1;
2539 }
Guido van Rossum298e4212003-02-13 16:30:16 +00002540 }
Guido van Rossum143b5642007-03-23 04:58:42 +00002541 if (err < 0)
2542 return NULL;
Guido van Rossum298e4212003-02-13 16:30:16 +00002543 return type->tp_alloc(type, 0);
2544}
2545
Tim Peters6d6c1a32001-08-02 04:15:00 +00002546static void
2547object_dealloc(PyObject *self)
2548{
Christian Heimese93237d2007-12-19 02:37:44 +00002549 Py_TYPE(self)->tp_free(self);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002550}
2551
Guido van Rossum8e248182001-08-12 05:17:56 +00002552static PyObject *
2553object_repr(PyObject *self)
2554{
Guido van Rossum76e69632001-08-16 18:52:43 +00002555 PyTypeObject *type;
Barry Warsaw7ce36942001-08-24 18:34:26 +00002556 PyObject *mod, *name, *rtn;
Guido van Rossum8e248182001-08-12 05:17:56 +00002557
Christian Heimese93237d2007-12-19 02:37:44 +00002558 type = Py_TYPE(self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002559 mod = type_module(type, NULL);
2560 if (mod == NULL)
2561 PyErr_Clear();
2562 else if (!PyString_Check(mod)) {
2563 Py_DECREF(mod);
2564 mod = NULL;
2565 }
2566 name = type_name(type, NULL);
2567 if (name == NULL)
2568 return NULL;
2569 if (mod != NULL && strcmp(PyString_AS_STRING(mod), "__builtin__"))
Guido van Rossumff0e6d62001-09-24 16:03:59 +00002570 rtn = PyString_FromFormat("<%s.%s object at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +00002571 PyString_AS_STRING(mod),
2572 PyString_AS_STRING(name),
2573 self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002574 else
Guido van Rossumff0e6d62001-09-24 16:03:59 +00002575 rtn = PyString_FromFormat("<%s object at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +00002576 type->tp_name, self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002577 Py_XDECREF(mod);
2578 Py_DECREF(name);
Barry Warsaw7ce36942001-08-24 18:34:26 +00002579 return rtn;
Guido van Rossum8e248182001-08-12 05:17:56 +00002580}
2581
Guido van Rossumb8f63662001-08-15 23:57:02 +00002582static PyObject *
2583object_str(PyObject *self)
2584{
2585 unaryfunc f;
2586
Christian Heimese93237d2007-12-19 02:37:44 +00002587 f = Py_TYPE(self)->tp_repr;
Guido van Rossumb8f63662001-08-15 23:57:02 +00002588 if (f == NULL)
2589 f = object_repr;
2590 return f(self);
2591}
2592
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002593static PyObject *
2594object_get_class(PyObject *self, void *closure)
2595{
Christian Heimese93237d2007-12-19 02:37:44 +00002596 Py_INCREF(Py_TYPE(self));
2597 return (PyObject *)(Py_TYPE(self));
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002598}
2599
2600static int
2601equiv_structs(PyTypeObject *a, PyTypeObject *b)
2602{
2603 return a == b ||
2604 (a != NULL &&
2605 b != NULL &&
2606 a->tp_basicsize == b->tp_basicsize &&
2607 a->tp_itemsize == b->tp_itemsize &&
2608 a->tp_dictoffset == b->tp_dictoffset &&
2609 a->tp_weaklistoffset == b->tp_weaklistoffset &&
2610 ((a->tp_flags & Py_TPFLAGS_HAVE_GC) ==
2611 (b->tp_flags & Py_TPFLAGS_HAVE_GC)));
2612}
2613
2614static int
2615same_slots_added(PyTypeObject *a, PyTypeObject *b)
2616{
2617 PyTypeObject *base = a->tp_base;
Martin v. Löwiseb079f12006-02-16 14:32:27 +00002618 Py_ssize_t size;
Žiga Seilnacht6f2d09c2007-03-16 11:59:38 +00002619 PyObject *slots_a, *slots_b;
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002620
2621 if (base != b->tp_base)
2622 return 0;
2623 if (equiv_structs(a, base) && equiv_structs(b, base))
2624 return 1;
2625 size = base->tp_basicsize;
2626 if (a->tp_dictoffset == size && b->tp_dictoffset == size)
2627 size += sizeof(PyObject *);
2628 if (a->tp_weaklistoffset == size && b->tp_weaklistoffset == size)
2629 size += sizeof(PyObject *);
Žiga Seilnacht6f2d09c2007-03-16 11:59:38 +00002630
2631 /* Check slots compliance */
2632 slots_a = ((PyHeapTypeObject *)a)->ht_slots;
2633 slots_b = ((PyHeapTypeObject *)b)->ht_slots;
2634 if (slots_a && slots_b) {
2635 if (PyObject_Compare(slots_a, slots_b) != 0)
2636 return 0;
2637 size += sizeof(PyObject *) * PyTuple_GET_SIZE(slots_a);
2638 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002639 return size == a->tp_basicsize && size == b->tp_basicsize;
2640}
2641
2642static int
Anthony Baxtera6286212006-04-11 07:42:36 +00002643compatible_for_assignment(PyTypeObject* oldto, PyTypeObject* newto, char* attr)
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002644{
2645 PyTypeObject *newbase, *oldbase;
2646
Anthony Baxtera6286212006-04-11 07:42:36 +00002647 if (newto->tp_dealloc != oldto->tp_dealloc ||
2648 newto->tp_free != oldto->tp_free)
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002649 {
2650 PyErr_Format(PyExc_TypeError,
2651 "%s assignment: "
2652 "'%s' deallocator differs from '%s'",
2653 attr,
Anthony Baxtera6286212006-04-11 07:42:36 +00002654 newto->tp_name,
2655 oldto->tp_name);
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002656 return 0;
2657 }
Anthony Baxtera6286212006-04-11 07:42:36 +00002658 newbase = newto;
2659 oldbase = oldto;
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002660 while (equiv_structs(newbase, newbase->tp_base))
2661 newbase = newbase->tp_base;
2662 while (equiv_structs(oldbase, oldbase->tp_base))
2663 oldbase = oldbase->tp_base;
2664 if (newbase != oldbase &&
2665 (newbase->tp_base != oldbase->tp_base ||
2666 !same_slots_added(newbase, oldbase))) {
2667 PyErr_Format(PyExc_TypeError,
2668 "%s assignment: "
2669 "'%s' object layout differs from '%s'",
2670 attr,
Anthony Baxtera6286212006-04-11 07:42:36 +00002671 newto->tp_name,
2672 oldto->tp_name);
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002673 return 0;
2674 }
Tim Petersea7f75d2002-12-07 21:39:16 +00002675
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002676 return 1;
2677}
2678
2679static int
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002680object_set_class(PyObject *self, PyObject *value, void *closure)
2681{
Christian Heimese93237d2007-12-19 02:37:44 +00002682 PyTypeObject *oldto = Py_TYPE(self);
Anthony Baxtera6286212006-04-11 07:42:36 +00002683 PyTypeObject *newto;
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002684
Guido van Rossumb6b89422002-04-15 01:03:30 +00002685 if (value == NULL) {
2686 PyErr_SetString(PyExc_TypeError,
2687 "can't delete __class__ attribute");
2688 return -1;
2689 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002690 if (!PyType_Check(value)) {
2691 PyErr_Format(PyExc_TypeError,
2692 "__class__ must be set to new-style class, not '%s' object",
Christian Heimese93237d2007-12-19 02:37:44 +00002693 Py_TYPE(value)->tp_name);
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002694 return -1;
2695 }
Anthony Baxtera6286212006-04-11 07:42:36 +00002696 newto = (PyTypeObject *)value;
2697 if (!(newto->tp_flags & Py_TPFLAGS_HEAPTYPE) ||
2698 !(oldto->tp_flags & Py_TPFLAGS_HEAPTYPE))
Guido van Rossum40af8892002-08-10 05:42:07 +00002699 {
2700 PyErr_Format(PyExc_TypeError,
2701 "__class__ assignment: only for heap types");
2702 return -1;
2703 }
Anthony Baxtera6286212006-04-11 07:42:36 +00002704 if (compatible_for_assignment(newto, oldto, "__class__")) {
2705 Py_INCREF(newto);
Christian Heimese93237d2007-12-19 02:37:44 +00002706 Py_TYPE(self) = newto;
Anthony Baxtera6286212006-04-11 07:42:36 +00002707 Py_DECREF(oldto);
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002708 return 0;
2709 }
2710 else {
Guido van Rossum9ee4b942002-05-24 18:47:47 +00002711 return -1;
2712 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002713}
2714
2715static PyGetSetDef object_getsets[] = {
2716 {"__class__", object_get_class, object_set_class,
Neal Norwitz858e34f2002-08-13 17:18:45 +00002717 PyDoc_STR("the object's class")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00002718 {0}
2719};
2720
Guido van Rossumc53f0092003-02-18 22:05:12 +00002721
Guido van Rossum036f9992003-02-21 22:02:54 +00002722/* Stuff to implement __reduce_ex__ for pickle protocols >= 2.
2723 We fall back to helpers in copy_reg for:
2724 - pickle protocols < 2
2725 - calculating the list of slot names (done only once per class)
2726 - the __newobj__ function (which is used as a token but never called)
2727*/
2728
2729static PyObject *
2730import_copy_reg(void)
2731{
2732 static PyObject *copy_reg_str;
Guido van Rossum3926a632001-09-25 16:25:58 +00002733
2734 if (!copy_reg_str) {
2735 copy_reg_str = PyString_InternFromString("copy_reg");
2736 if (copy_reg_str == NULL)
2737 return NULL;
2738 }
Guido van Rossum036f9992003-02-21 22:02:54 +00002739
2740 return PyImport_Import(copy_reg_str);
2741}
2742
2743static PyObject *
2744slotnames(PyObject *cls)
2745{
2746 PyObject *clsdict;
2747 PyObject *copy_reg;
2748 PyObject *slotnames;
2749
2750 if (!PyType_Check(cls)) {
2751 Py_INCREF(Py_None);
2752 return Py_None;
2753 }
2754
2755 clsdict = ((PyTypeObject *)cls)->tp_dict;
2756 slotnames = PyDict_GetItemString(clsdict, "__slotnames__");
Armin Rigoec862b92005-09-24 22:58:41 +00002757 if (slotnames != NULL && PyList_Check(slotnames)) {
Guido van Rossum036f9992003-02-21 22:02:54 +00002758 Py_INCREF(slotnames);
2759 return slotnames;
2760 }
2761
2762 copy_reg = import_copy_reg();
2763 if (copy_reg == NULL)
2764 return NULL;
2765
2766 slotnames = PyObject_CallMethod(copy_reg, "_slotnames", "O", cls);
2767 Py_DECREF(copy_reg);
2768 if (slotnames != NULL &&
2769 slotnames != Py_None &&
2770 !PyList_Check(slotnames))
2771 {
2772 PyErr_SetString(PyExc_TypeError,
2773 "copy_reg._slotnames didn't return a list or None");
2774 Py_DECREF(slotnames);
2775 slotnames = NULL;
2776 }
2777
2778 return slotnames;
2779}
2780
2781static PyObject *
2782reduce_2(PyObject *obj)
2783{
2784 PyObject *cls, *getnewargs;
2785 PyObject *args = NULL, *args2 = NULL;
2786 PyObject *getstate = NULL, *state = NULL, *names = NULL;
2787 PyObject *slots = NULL, *listitems = NULL, *dictitems = NULL;
2788 PyObject *copy_reg = NULL, *newobj = NULL, *res = NULL;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002789 Py_ssize_t i, n;
Guido van Rossum036f9992003-02-21 22:02:54 +00002790
2791 cls = PyObject_GetAttrString(obj, "__class__");
2792 if (cls == NULL)
2793 return NULL;
2794
2795 getnewargs = PyObject_GetAttrString(obj, "__getnewargs__");
2796 if (getnewargs != NULL) {
2797 args = PyObject_CallObject(getnewargs, NULL);
2798 Py_DECREF(getnewargs);
2799 if (args != NULL && !PyTuple_Check(args)) {
Georg Brandlccff7852006-06-18 22:17:29 +00002800 PyErr_Format(PyExc_TypeError,
2801 "__getnewargs__ should return a tuple, "
Christian Heimese93237d2007-12-19 02:37:44 +00002802 "not '%.200s'", Py_TYPE(args)->tp_name);
Guido van Rossum036f9992003-02-21 22:02:54 +00002803 goto end;
2804 }
2805 }
2806 else {
2807 PyErr_Clear();
2808 args = PyTuple_New(0);
2809 }
2810 if (args == NULL)
2811 goto end;
2812
2813 getstate = PyObject_GetAttrString(obj, "__getstate__");
2814 if (getstate != NULL) {
2815 state = PyObject_CallObject(getstate, NULL);
2816 Py_DECREF(getstate);
Neal Norwitze2fdc612003-06-08 13:19:58 +00002817 if (state == NULL)
2818 goto end;
Guido van Rossum036f9992003-02-21 22:02:54 +00002819 }
2820 else {
Jim Fulton8a1a5942004-02-08 04:21:26 +00002821 PyErr_Clear();
Guido van Rossum036f9992003-02-21 22:02:54 +00002822 state = PyObject_GetAttrString(obj, "__dict__");
2823 if (state == NULL) {
2824 PyErr_Clear();
2825 state = Py_None;
2826 Py_INCREF(state);
2827 }
2828 names = slotnames(cls);
2829 if (names == NULL)
2830 goto end;
2831 if (names != Py_None) {
2832 assert(PyList_Check(names));
2833 slots = PyDict_New();
2834 if (slots == NULL)
2835 goto end;
2836 n = 0;
2837 /* Can't pre-compute the list size; the list
2838 is stored on the class so accessible to other
2839 threads, which may be run by DECREF */
2840 for (i = 0; i < PyList_GET_SIZE(names); i++) {
2841 PyObject *name, *value;
2842 name = PyList_GET_ITEM(names, i);
2843 value = PyObject_GetAttr(obj, name);
2844 if (value == NULL)
2845 PyErr_Clear();
2846 else {
2847 int err = PyDict_SetItem(slots, name,
2848 value);
2849 Py_DECREF(value);
2850 if (err)
2851 goto end;
2852 n++;
2853 }
2854 }
2855 if (n) {
2856 state = Py_BuildValue("(NO)", state, slots);
2857 if (state == NULL)
2858 goto end;
2859 }
2860 }
2861 }
2862
2863 if (!PyList_Check(obj)) {
2864 listitems = Py_None;
2865 Py_INCREF(listitems);
2866 }
2867 else {
2868 listitems = PyObject_GetIter(obj);
2869 if (listitems == NULL)
2870 goto end;
2871 }
2872
2873 if (!PyDict_Check(obj)) {
2874 dictitems = Py_None;
2875 Py_INCREF(dictitems);
2876 }
2877 else {
2878 dictitems = PyObject_CallMethod(obj, "iteritems", "");
2879 if (dictitems == NULL)
2880 goto end;
2881 }
2882
2883 copy_reg = import_copy_reg();
2884 if (copy_reg == NULL)
2885 goto end;
2886 newobj = PyObject_GetAttrString(copy_reg, "__newobj__");
2887 if (newobj == NULL)
2888 goto end;
2889
2890 n = PyTuple_GET_SIZE(args);
2891 args2 = PyTuple_New(n+1);
2892 if (args2 == NULL)
2893 goto end;
2894 PyTuple_SET_ITEM(args2, 0, cls);
2895 cls = NULL;
2896 for (i = 0; i < n; i++) {
2897 PyObject *v = PyTuple_GET_ITEM(args, i);
2898 Py_INCREF(v);
2899 PyTuple_SET_ITEM(args2, i+1, v);
2900 }
2901
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002902 res = PyTuple_Pack(5, newobj, args2, state, listitems, dictitems);
Guido van Rossum036f9992003-02-21 22:02:54 +00002903
2904 end:
2905 Py_XDECREF(cls);
2906 Py_XDECREF(args);
2907 Py_XDECREF(args2);
Jeremy Hyltond06483c2003-04-09 21:01:42 +00002908 Py_XDECREF(slots);
Guido van Rossum036f9992003-02-21 22:02:54 +00002909 Py_XDECREF(state);
2910 Py_XDECREF(names);
2911 Py_XDECREF(listitems);
2912 Py_XDECREF(dictitems);
2913 Py_XDECREF(copy_reg);
2914 Py_XDECREF(newobj);
2915 return res;
2916}
2917
Žiga Seilnacht20f43d32007-03-15 11:44:55 +00002918/*
2919 * There were two problems when object.__reduce__ and object.__reduce_ex__
2920 * were implemented in the same function:
2921 * - trying to pickle an object with a custom __reduce__ method that
2922 * fell back to object.__reduce__ in certain circumstances led to
2923 * infinite recursion at Python level and eventual RuntimeError.
2924 * - Pickling objects that lied about their type by overwriting the
2925 * __class__ descriptor could lead to infinite recursion at C level
2926 * and eventual segfault.
2927 *
2928 * Because of backwards compatibility, the two methods still have to
2929 * behave in the same way, even if this is not required by the pickle
2930 * protocol. This common functionality was moved to the _common_reduce
2931 * function.
2932 */
2933static PyObject *
2934_common_reduce(PyObject *self, int proto)
2935{
2936 PyObject *copy_reg, *res;
2937
2938 if (proto >= 2)
2939 return reduce_2(self);
2940
2941 copy_reg = import_copy_reg();
2942 if (!copy_reg)
2943 return NULL;
2944
2945 res = PyEval_CallMethod(copy_reg, "_reduce_ex", "(Oi)", self, proto);
2946 Py_DECREF(copy_reg);
2947
2948 return res;
2949}
2950
2951static PyObject *
2952object_reduce(PyObject *self, PyObject *args)
2953{
2954 int proto = 0;
2955
2956 if (!PyArg_ParseTuple(args, "|i:__reduce__", &proto))
2957 return NULL;
2958
2959 return _common_reduce(self, proto);
2960}
2961
Guido van Rossum036f9992003-02-21 22:02:54 +00002962static PyObject *
2963object_reduce_ex(PyObject *self, PyObject *args)
2964{
Žiga Seilnacht20f43d32007-03-15 11:44:55 +00002965 PyObject *reduce, *res;
Guido van Rossum036f9992003-02-21 22:02:54 +00002966 int proto = 0;
2967
2968 if (!PyArg_ParseTuple(args, "|i:__reduce_ex__", &proto))
2969 return NULL;
2970
2971 reduce = PyObject_GetAttrString(self, "__reduce__");
2972 if (reduce == NULL)
2973 PyErr_Clear();
2974 else {
2975 PyObject *cls, *clsreduce, *objreduce;
2976 int override;
2977 cls = PyObject_GetAttrString(self, "__class__");
2978 if (cls == NULL) {
2979 Py_DECREF(reduce);
2980 return NULL;
2981 }
2982 clsreduce = PyObject_GetAttrString(cls, "__reduce__");
2983 Py_DECREF(cls);
2984 if (clsreduce == NULL) {
2985 Py_DECREF(reduce);
2986 return NULL;
2987 }
2988 objreduce = PyDict_GetItemString(PyBaseObject_Type.tp_dict,
2989 "__reduce__");
2990 override = (clsreduce != objreduce);
2991 Py_DECREF(clsreduce);
2992 if (override) {
2993 res = PyObject_CallObject(reduce, NULL);
2994 Py_DECREF(reduce);
2995 return res;
2996 }
2997 else
2998 Py_DECREF(reduce);
2999 }
3000
Žiga Seilnacht20f43d32007-03-15 11:44:55 +00003001 return _common_reduce(self, proto);
Guido van Rossum3926a632001-09-25 16:25:58 +00003002}
3003
3004static PyMethodDef object_methods[] = {
Guido van Rossumc53f0092003-02-18 22:05:12 +00003005 {"__reduce_ex__", object_reduce_ex, METH_VARARGS,
3006 PyDoc_STR("helper for pickle")},
Žiga Seilnacht20f43d32007-03-15 11:44:55 +00003007 {"__reduce__", object_reduce, METH_VARARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00003008 PyDoc_STR("helper for pickle")},
Guido van Rossum3926a632001-09-25 16:25:58 +00003009 {0}
3010};
3011
Guido van Rossum036f9992003-02-21 22:02:54 +00003012
Tim Peters6d6c1a32001-08-02 04:15:00 +00003013PyTypeObject PyBaseObject_Type = {
Martin v. Löwis68192102007-07-21 06:55:02 +00003014 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003015 "object", /* tp_name */
3016 sizeof(PyObject), /* tp_basicsize */
3017 0, /* tp_itemsize */
Georg Brandl347b3002006-03-30 11:57:00 +00003018 object_dealloc, /* tp_dealloc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003019 0, /* tp_print */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003020 0, /* tp_getattr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003021 0, /* tp_setattr */
3022 0, /* tp_compare */
Guido van Rossumb8f63662001-08-15 23:57:02 +00003023 object_repr, /* tp_repr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003024 0, /* tp_as_number */
3025 0, /* tp_as_sequence */
3026 0, /* tp_as_mapping */
Guido van Rossum64c06e32007-11-22 00:55:51 +00003027 (hashfunc)_Py_HashPointer, /* tp_hash */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003028 0, /* tp_call */
Guido van Rossumb8f63662001-08-15 23:57:02 +00003029 object_str, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003030 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum13d52f02001-08-10 21:24:08 +00003031 PyObject_GenericSetAttr, /* tp_setattro */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003032 0, /* tp_as_buffer */
3033 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Neal Norwitz5dc2a372002-08-13 22:19:13 +00003034 PyDoc_STR("The most base type"), /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003035 0, /* tp_traverse */
3036 0, /* tp_clear */
3037 0, /* tp_richcompare */
3038 0, /* tp_weaklistoffset */
3039 0, /* tp_iter */
3040 0, /* tp_iternext */
Guido van Rossum3926a632001-09-25 16:25:58 +00003041 object_methods, /* tp_methods */
Guido van Rossum5c294fb2001-09-25 03:43:42 +00003042 0, /* tp_members */
3043 object_getsets, /* tp_getset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003044 0, /* tp_base */
3045 0, /* tp_dict */
3046 0, /* tp_descr_get */
3047 0, /* tp_descr_set */
3048 0, /* tp_dictoffset */
3049 object_init, /* tp_init */
3050 PyType_GenericAlloc, /* tp_alloc */
Guido van Rossum298e4212003-02-13 16:30:16 +00003051 object_new, /* tp_new */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003052 PyObject_Del, /* tp_free */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003053};
3054
3055
3056/* Initialize the __dict__ in a type object */
3057
3058static int
3059add_methods(PyTypeObject *type, PyMethodDef *meth)
3060{
Guido van Rossum687ae002001-10-15 22:03:32 +00003061 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003062
3063 for (; meth->ml_name != NULL; meth++) {
3064 PyObject *descr;
Raymond Hettinger8f5cdaa2003-12-13 11:26:12 +00003065 if (PyDict_GetItemString(dict, meth->ml_name) &&
3066 !(meth->ml_flags & METH_COEXIST))
3067 continue;
Fred Drake7bf97152002-03-28 05:33:33 +00003068 if (meth->ml_flags & METH_CLASS) {
3069 if (meth->ml_flags & METH_STATIC) {
3070 PyErr_SetString(PyExc_ValueError,
3071 "method cannot be both class and static");
3072 return -1;
3073 }
Tim Petersbca1cbc2002-12-09 22:56:13 +00003074 descr = PyDescr_NewClassMethod(type, meth);
Fred Drake7bf97152002-03-28 05:33:33 +00003075 }
3076 else if (meth->ml_flags & METH_STATIC) {
Guido van Rossum9af48ff2003-02-11 17:12:46 +00003077 PyObject *cfunc = PyCFunction_New(meth, NULL);
3078 if (cfunc == NULL)
3079 return -1;
3080 descr = PyStaticMethod_New(cfunc);
3081 Py_DECREF(cfunc);
Fred Drake7bf97152002-03-28 05:33:33 +00003082 }
3083 else {
3084 descr = PyDescr_NewMethod(type, meth);
3085 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003086 if (descr == NULL)
3087 return -1;
Fred Drake7bf97152002-03-28 05:33:33 +00003088 if (PyDict_SetItemString(dict, meth->ml_name, descr) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003089 return -1;
3090 Py_DECREF(descr);
3091 }
3092 return 0;
3093}
3094
3095static int
Guido van Rossum6f799372001-09-20 20:46:19 +00003096add_members(PyTypeObject *type, PyMemberDef *memb)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003097{
Guido van Rossum687ae002001-10-15 22:03:32 +00003098 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003099
3100 for (; memb->name != NULL; memb++) {
3101 PyObject *descr;
3102 if (PyDict_GetItemString(dict, memb->name))
3103 continue;
3104 descr = PyDescr_NewMember(type, memb);
3105 if (descr == NULL)
3106 return -1;
3107 if (PyDict_SetItemString(dict, memb->name, descr) < 0)
3108 return -1;
3109 Py_DECREF(descr);
3110 }
3111 return 0;
3112}
3113
3114static int
Guido van Rossum32d34c82001-09-20 21:45:26 +00003115add_getset(PyTypeObject *type, PyGetSetDef *gsp)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003116{
Guido van Rossum687ae002001-10-15 22:03:32 +00003117 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003118
3119 for (; gsp->name != NULL; gsp++) {
3120 PyObject *descr;
3121 if (PyDict_GetItemString(dict, gsp->name))
3122 continue;
3123 descr = PyDescr_NewGetSet(type, gsp);
3124
3125 if (descr == NULL)
3126 return -1;
3127 if (PyDict_SetItemString(dict, gsp->name, descr) < 0)
3128 return -1;
3129 Py_DECREF(descr);
3130 }
3131 return 0;
3132}
3133
Guido van Rossum13d52f02001-08-10 21:24:08 +00003134static void
3135inherit_special(PyTypeObject *type, PyTypeObject *base)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003136{
Martin v. Löwiseb079f12006-02-16 14:32:27 +00003137 Py_ssize_t oldsize, newsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003138
Guido van Rossum13d52f02001-08-10 21:24:08 +00003139 /* Special flag magic */
3140 if (!type->tp_as_buffer && base->tp_as_buffer) {
3141 type->tp_flags &= ~Py_TPFLAGS_HAVE_GETCHARBUFFER;
3142 type->tp_flags |=
3143 base->tp_flags & Py_TPFLAGS_HAVE_GETCHARBUFFER;
3144 }
3145 if (!type->tp_as_sequence && base->tp_as_sequence) {
3146 type->tp_flags &= ~Py_TPFLAGS_HAVE_SEQUENCE_IN;
3147 type->tp_flags |= base->tp_flags & Py_TPFLAGS_HAVE_SEQUENCE_IN;
3148 }
3149 if ((type->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS) !=
3150 (base->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS)) {
3151 if ((!type->tp_as_number && base->tp_as_number) ||
3152 (!type->tp_as_sequence && base->tp_as_sequence)) {
3153 type->tp_flags &= ~Py_TPFLAGS_HAVE_INPLACEOPS;
3154 if (!type->tp_as_number && !type->tp_as_sequence) {
3155 type->tp_flags |= base->tp_flags &
3156 Py_TPFLAGS_HAVE_INPLACEOPS;
3157 }
3158 }
3159 /* Wow */
3160 }
3161 if (!type->tp_as_number && base->tp_as_number) {
3162 type->tp_flags &= ~Py_TPFLAGS_CHECKTYPES;
3163 type->tp_flags |= base->tp_flags & Py_TPFLAGS_CHECKTYPES;
3164 }
3165
3166 /* Copying basicsize is connected to the GC flags */
Neil Schemenauerc806c882001-08-29 23:54:54 +00003167 oldsize = base->tp_basicsize;
3168 newsize = type->tp_basicsize ? type->tp_basicsize : oldsize;
3169 if (!(type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
3170 (base->tp_flags & Py_TPFLAGS_HAVE_GC) &&
Guido van Rossum13d52f02001-08-10 21:24:08 +00003171 (type->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE/*GC slots exist*/) &&
3172 (!type->tp_traverse && !type->tp_clear)) {
Neil Schemenauerc806c882001-08-29 23:54:54 +00003173 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
Guido van Rossum13d52f02001-08-10 21:24:08 +00003174 if (type->tp_traverse == NULL)
3175 type->tp_traverse = base->tp_traverse;
3176 if (type->tp_clear == NULL)
3177 type->tp_clear = base->tp_clear;
3178 }
3179 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
Guido van Rossumf884b742001-12-17 17:14:22 +00003180 /* The condition below could use some explanation.
3181 It appears that tp_new is not inherited for static types
3182 whose base class is 'object'; this seems to be a precaution
3183 so that old extension types don't suddenly become
3184 callable (object.__new__ wouldn't insure the invariants
3185 that the extension type's own factory function ensures).
3186 Heap types, of course, are under our control, so they do
3187 inherit tp_new; static extension types that specify some
3188 other built-in type as the default are considered
3189 new-style-aware so they also inherit object.__new__. */
Guido van Rossum13d52f02001-08-10 21:24:08 +00003190 if (base != &PyBaseObject_Type ||
3191 (type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
3192 if (type->tp_new == NULL)
3193 type->tp_new = base->tp_new;
3194 }
3195 }
Neil Schemenauerc806c882001-08-29 23:54:54 +00003196 type->tp_basicsize = newsize;
Guido van Rossum4dd64ab2001-08-14 20:04:48 +00003197
3198 /* Copy other non-function slots */
3199
3200#undef COPYVAL
3201#define COPYVAL(SLOT) \
3202 if (type->SLOT == 0) type->SLOT = base->SLOT
3203
3204 COPYVAL(tp_itemsize);
3205 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_WEAKREFS) {
3206 COPYVAL(tp_weaklistoffset);
3207 }
3208 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
3209 COPYVAL(tp_dictoffset);
3210 }
Neal Norwitzee3a1b52007-02-25 19:44:48 +00003211
3212 /* Setup fast subclass flags */
3213 if (PyType_IsSubtype(base, (PyTypeObject*)PyExc_BaseException))
3214 type->tp_flags |= Py_TPFLAGS_BASE_EXC_SUBCLASS;
3215 else if (PyType_IsSubtype(base, &PyType_Type))
3216 type->tp_flags |= Py_TPFLAGS_TYPE_SUBCLASS;
3217 else if (PyType_IsSubtype(base, &PyInt_Type))
3218 type->tp_flags |= Py_TPFLAGS_INT_SUBCLASS;
3219 else if (PyType_IsSubtype(base, &PyLong_Type))
3220 type->tp_flags |= Py_TPFLAGS_LONG_SUBCLASS;
3221 else if (PyType_IsSubtype(base, &PyString_Type))
3222 type->tp_flags |= Py_TPFLAGS_STRING_SUBCLASS;
3223 else if (PyType_IsSubtype(base, &PyUnicode_Type))
3224 type->tp_flags |= Py_TPFLAGS_UNICODE_SUBCLASS;
3225 else if (PyType_IsSubtype(base, &PyTuple_Type))
3226 type->tp_flags |= Py_TPFLAGS_TUPLE_SUBCLASS;
3227 else if (PyType_IsSubtype(base, &PyList_Type))
3228 type->tp_flags |= Py_TPFLAGS_LIST_SUBCLASS;
3229 else if (PyType_IsSubtype(base, &PyDict_Type))
3230 type->tp_flags |= Py_TPFLAGS_DICT_SUBCLASS;
Guido van Rossum13d52f02001-08-10 21:24:08 +00003231}
3232
Guido van Rossum0b7b6fd2007-12-19 22:51:13 +00003233static char *hash_name_op[] = {
3234 "__eq__",
3235 "__cmp__",
3236 "__hash__",
3237 NULL
Guido van Rossum64c06e32007-11-22 00:55:51 +00003238};
3239
3240static int
3241overrides_hash(PyTypeObject *type)
3242{
Guido van Rossum0b7b6fd2007-12-19 22:51:13 +00003243 char **p;
Guido van Rossum64c06e32007-11-22 00:55:51 +00003244 PyObject *dict = type->tp_dict;
3245
3246 assert(dict != NULL);
Guido van Rossum0b7b6fd2007-12-19 22:51:13 +00003247 for (p = hash_name_op; *p; p++) {
3248 if (PyDict_GetItemString(dict, *p) != NULL)
Guido van Rossum64c06e32007-11-22 00:55:51 +00003249 return 1;
3250 }
3251 return 0;
3252}
3253
Guido van Rossum13d52f02001-08-10 21:24:08 +00003254static void
3255inherit_slots(PyTypeObject *type, PyTypeObject *base)
3256{
3257 PyTypeObject *basebase;
3258
3259#undef SLOTDEFINED
Tim Peters6d6c1a32001-08-02 04:15:00 +00003260#undef COPYSLOT
3261#undef COPYNUM
3262#undef COPYSEQ
3263#undef COPYMAP
Guido van Rossum5af588b2001-10-12 14:13:21 +00003264#undef COPYBUF
Guido van Rossum13d52f02001-08-10 21:24:08 +00003265
3266#define SLOTDEFINED(SLOT) \
3267 (base->SLOT != 0 && \
3268 (basebase == NULL || base->SLOT != basebase->SLOT))
3269
Tim Peters6d6c1a32001-08-02 04:15:00 +00003270#define COPYSLOT(SLOT) \
Guido van Rossum13d52f02001-08-10 21:24:08 +00003271 if (!type->SLOT && SLOTDEFINED(SLOT)) type->SLOT = base->SLOT
Tim Peters6d6c1a32001-08-02 04:15:00 +00003272
3273#define COPYNUM(SLOT) COPYSLOT(tp_as_number->SLOT)
3274#define COPYSEQ(SLOT) COPYSLOT(tp_as_sequence->SLOT)
3275#define COPYMAP(SLOT) COPYSLOT(tp_as_mapping->SLOT)
Tim Petersfc57ccb2001-10-12 02:38:24 +00003276#define COPYBUF(SLOT) COPYSLOT(tp_as_buffer->SLOT)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003277
Guido van Rossum13d52f02001-08-10 21:24:08 +00003278 /* This won't inherit indirect slots (from tp_as_number etc.)
3279 if type doesn't provide the space. */
3280
3281 if (type->tp_as_number != NULL && base->tp_as_number != NULL) {
3282 basebase = base->tp_base;
3283 if (basebase->tp_as_number == NULL)
3284 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003285 COPYNUM(nb_add);
3286 COPYNUM(nb_subtract);
3287 COPYNUM(nb_multiply);
3288 COPYNUM(nb_divide);
3289 COPYNUM(nb_remainder);
3290 COPYNUM(nb_divmod);
3291 COPYNUM(nb_power);
3292 COPYNUM(nb_negative);
3293 COPYNUM(nb_positive);
3294 COPYNUM(nb_absolute);
3295 COPYNUM(nb_nonzero);
3296 COPYNUM(nb_invert);
3297 COPYNUM(nb_lshift);
3298 COPYNUM(nb_rshift);
3299 COPYNUM(nb_and);
3300 COPYNUM(nb_xor);
3301 COPYNUM(nb_or);
3302 COPYNUM(nb_coerce);
3303 COPYNUM(nb_int);
3304 COPYNUM(nb_long);
3305 COPYNUM(nb_float);
3306 COPYNUM(nb_oct);
3307 COPYNUM(nb_hex);
3308 COPYNUM(nb_inplace_add);
3309 COPYNUM(nb_inplace_subtract);
3310 COPYNUM(nb_inplace_multiply);
3311 COPYNUM(nb_inplace_divide);
3312 COPYNUM(nb_inplace_remainder);
3313 COPYNUM(nb_inplace_power);
3314 COPYNUM(nb_inplace_lshift);
3315 COPYNUM(nb_inplace_rshift);
3316 COPYNUM(nb_inplace_and);
3317 COPYNUM(nb_inplace_xor);
3318 COPYNUM(nb_inplace_or);
Guido van Rossumdc91b992001-08-08 22:26:22 +00003319 if (base->tp_flags & Py_TPFLAGS_CHECKTYPES) {
3320 COPYNUM(nb_true_divide);
3321 COPYNUM(nb_floor_divide);
3322 COPYNUM(nb_inplace_true_divide);
3323 COPYNUM(nb_inplace_floor_divide);
3324 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +00003325 if (base->tp_flags & Py_TPFLAGS_HAVE_INDEX) {
3326 COPYNUM(nb_index);
3327 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003328 }
3329
Guido van Rossum13d52f02001-08-10 21:24:08 +00003330 if (type->tp_as_sequence != NULL && base->tp_as_sequence != NULL) {
3331 basebase = base->tp_base;
3332 if (basebase->tp_as_sequence == NULL)
3333 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003334 COPYSEQ(sq_length);
3335 COPYSEQ(sq_concat);
3336 COPYSEQ(sq_repeat);
3337 COPYSEQ(sq_item);
3338 COPYSEQ(sq_slice);
3339 COPYSEQ(sq_ass_item);
3340 COPYSEQ(sq_ass_slice);
3341 COPYSEQ(sq_contains);
3342 COPYSEQ(sq_inplace_concat);
3343 COPYSEQ(sq_inplace_repeat);
3344 }
3345
Guido van Rossum13d52f02001-08-10 21:24:08 +00003346 if (type->tp_as_mapping != NULL && base->tp_as_mapping != NULL) {
3347 basebase = base->tp_base;
3348 if (basebase->tp_as_mapping == NULL)
3349 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003350 COPYMAP(mp_length);
3351 COPYMAP(mp_subscript);
3352 COPYMAP(mp_ass_subscript);
3353 }
3354
Tim Petersfc57ccb2001-10-12 02:38:24 +00003355 if (type->tp_as_buffer != NULL && base->tp_as_buffer != NULL) {
3356 basebase = base->tp_base;
3357 if (basebase->tp_as_buffer == NULL)
3358 basebase = NULL;
3359 COPYBUF(bf_getreadbuffer);
3360 COPYBUF(bf_getwritebuffer);
3361 COPYBUF(bf_getsegcount);
3362 COPYBUF(bf_getcharbuffer);
3363 }
3364
Guido van Rossum13d52f02001-08-10 21:24:08 +00003365 basebase = base->tp_base;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003366
Tim Peters6d6c1a32001-08-02 04:15:00 +00003367 COPYSLOT(tp_dealloc);
3368 COPYSLOT(tp_print);
3369 if (type->tp_getattr == NULL && type->tp_getattro == NULL) {
3370 type->tp_getattr = base->tp_getattr;
3371 type->tp_getattro = base->tp_getattro;
3372 }
3373 if (type->tp_setattr == NULL && type->tp_setattro == NULL) {
3374 type->tp_setattr = base->tp_setattr;
3375 type->tp_setattro = base->tp_setattro;
3376 }
3377 /* tp_compare see tp_richcompare */
3378 COPYSLOT(tp_repr);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003379 /* tp_hash see tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003380 COPYSLOT(tp_call);
3381 COPYSLOT(tp_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003382 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00003383 if (type->tp_compare == NULL &&
3384 type->tp_richcompare == NULL &&
Guido van Rossum64c06e32007-11-22 00:55:51 +00003385 type->tp_hash == NULL &&
3386 !overrides_hash(type))
Guido van Rossumb8f63662001-08-15 23:57:02 +00003387 {
Tim Peters6d6c1a32001-08-02 04:15:00 +00003388 type->tp_compare = base->tp_compare;
3389 type->tp_richcompare = base->tp_richcompare;
Guido van Rossumb8f63662001-08-15 23:57:02 +00003390 type->tp_hash = base->tp_hash;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003391 }
3392 }
3393 else {
3394 COPYSLOT(tp_compare);
3395 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003396 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_ITER) {
3397 COPYSLOT(tp_iter);
3398 COPYSLOT(tp_iternext);
3399 }
3400 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
3401 COPYSLOT(tp_descr_get);
3402 COPYSLOT(tp_descr_set);
3403 COPYSLOT(tp_dictoffset);
3404 COPYSLOT(tp_init);
3405 COPYSLOT(tp_alloc);
Guido van Rossumcc8fe042002-04-05 17:10:16 +00003406 COPYSLOT(tp_is_gc);
Tim Peters3cfe7542003-05-21 21:29:48 +00003407 if ((type->tp_flags & Py_TPFLAGS_HAVE_GC) ==
3408 (base->tp_flags & Py_TPFLAGS_HAVE_GC)) {
3409 /* They agree about gc. */
3410 COPYSLOT(tp_free);
3411 }
3412 else if ((type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
3413 type->tp_free == NULL &&
3414 base->tp_free == _PyObject_Del) {
3415 /* A bit of magic to plug in the correct default
3416 * tp_free function when a derived class adds gc,
3417 * didn't define tp_free, and the base uses the
3418 * default non-gc tp_free.
3419 */
3420 type->tp_free = PyObject_GC_Del;
3421 }
3422 /* else they didn't agree about gc, and there isn't something
3423 * obvious to be done -- the type is on its own.
3424 */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003425 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003426}
3427
Jeremy Hylton938ace62002-07-17 16:30:39 +00003428static int add_operators(PyTypeObject *);
Guido van Rossum13d52f02001-08-10 21:24:08 +00003429
Tim Peters6d6c1a32001-08-02 04:15:00 +00003430int
Guido van Rossum528b7eb2001-08-07 17:24:28 +00003431PyType_Ready(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003432{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00003433 PyObject *dict, *bases;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003434 PyTypeObject *base;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003435 Py_ssize_t i, n;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003436
Guido van Rossumcab05802002-06-10 15:29:03 +00003437 if (type->tp_flags & Py_TPFLAGS_READY) {
3438 assert(type->tp_dict != NULL);
Guido van Rossumd614f972001-08-10 17:39:49 +00003439 return 0;
Guido van Rossumcab05802002-06-10 15:29:03 +00003440 }
Guido van Rossumd614f972001-08-10 17:39:49 +00003441 assert((type->tp_flags & Py_TPFLAGS_READYING) == 0);
Guido van Rossumd614f972001-08-10 17:39:49 +00003442
3443 type->tp_flags |= Py_TPFLAGS_READYING;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003444
Tim Peters36eb4df2003-03-23 03:33:13 +00003445#ifdef Py_TRACE_REFS
3446 /* PyType_Ready is the closest thing we have to a choke point
3447 * for type objects, so is the best place I can think of to try
3448 * to get type objects into the doubly-linked list of all objects.
3449 * Still, not all type objects go thru PyType_Ready.
3450 */
Tim Peters7571a0f2003-03-23 17:52:28 +00003451 _Py_AddToAllObjects((PyObject *)type, 0);
Tim Peters36eb4df2003-03-23 03:33:13 +00003452#endif
3453
Tim Peters6d6c1a32001-08-02 04:15:00 +00003454 /* Initialize tp_base (defaults to BaseObject unless that's us) */
3455 base = type->tp_base;
Martin v. Löwisbf608752004-08-18 13:16:54 +00003456 if (base == NULL && type != &PyBaseObject_Type) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00003457 base = type->tp_base = &PyBaseObject_Type;
Martin v. Löwisbf608752004-08-18 13:16:54 +00003458 Py_INCREF(base);
3459 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003460
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003461 /* Now the only way base can still be NULL is if type is
3462 * &PyBaseObject_Type.
3463 */
Guido van Rossum692cdbc2006-03-10 02:04:28 +00003464
Guido van Rossum323a9cf2002-08-14 17:26:30 +00003465 /* Initialize the base class */
3466 if (base && base->tp_dict == NULL) {
3467 if (PyType_Ready(base) < 0)
3468 goto error;
3469 }
3470
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003471 /* Initialize ob_type if NULL. This means extensions that want to be
Guido van Rossum0986d822002-04-08 01:38:42 +00003472 compilable separately on Windows can call PyType_Ready() instead of
3473 initializing the ob_type field of their type objects. */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003474 /* The test for base != NULL is really unnecessary, since base is only
3475 NULL when type is &PyBaseObject_Type, and we know its ob_type is
3476 not NULL (it's initialized to &PyType_Type). But coverity doesn't
3477 know that. */
Christian Heimese93237d2007-12-19 02:37:44 +00003478 if (Py_TYPE(type) == NULL && base != NULL)
3479 Py_TYPE(type) = Py_TYPE(base);
Guido van Rossum0986d822002-04-08 01:38:42 +00003480
Tim Peters6d6c1a32001-08-02 04:15:00 +00003481 /* Initialize tp_bases */
3482 bases = type->tp_bases;
3483 if (bases == NULL) {
3484 if (base == NULL)
3485 bases = PyTuple_New(0);
3486 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003487 bases = PyTuple_Pack(1, base);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003488 if (bases == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00003489 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003490 type->tp_bases = bases;
3491 }
3492
Guido van Rossum687ae002001-10-15 22:03:32 +00003493 /* Initialize tp_dict */
3494 dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003495 if (dict == NULL) {
3496 dict = PyDict_New();
3497 if (dict == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00003498 goto error;
Guido van Rossum687ae002001-10-15 22:03:32 +00003499 type->tp_dict = dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003500 }
3501
Guido van Rossum687ae002001-10-15 22:03:32 +00003502 /* Add type-specific descriptors to tp_dict */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003503 if (add_operators(type) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003504 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003505 if (type->tp_methods != NULL) {
3506 if (add_methods(type, type->tp_methods) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003507 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003508 }
3509 if (type->tp_members != NULL) {
3510 if (add_members(type, type->tp_members) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003511 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003512 }
3513 if (type->tp_getset != NULL) {
3514 if (add_getset(type, type->tp_getset) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003515 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003516 }
3517
Tim Peters6d6c1a32001-08-02 04:15:00 +00003518 /* Calculate method resolution order */
3519 if (mro_internal(type) < 0) {
Guido van Rossumd614f972001-08-10 17:39:49 +00003520 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003521 }
3522
Guido van Rossum13d52f02001-08-10 21:24:08 +00003523 /* Inherit special flags from dominant base */
3524 if (type->tp_base != NULL)
3525 inherit_special(type, type->tp_base);
3526
Tim Peters6d6c1a32001-08-02 04:15:00 +00003527 /* Initialize tp_dict properly */
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00003528 bases = type->tp_mro;
3529 assert(bases != NULL);
3530 assert(PyTuple_Check(bases));
3531 n = PyTuple_GET_SIZE(bases);
3532 for (i = 1; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00003533 PyObject *b = PyTuple_GET_ITEM(bases, i);
3534 if (PyType_Check(b))
3535 inherit_slots(type, (PyTypeObject *)b);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003536 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003537
Tim Peters3cfe7542003-05-21 21:29:48 +00003538 /* Sanity check for tp_free. */
3539 if (PyType_IS_GC(type) && (type->tp_flags & Py_TPFLAGS_BASETYPE) &&
3540 (type->tp_free == NULL || type->tp_free == PyObject_Del)) {
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003541 /* This base class needs to call tp_free, but doesn't have
3542 * one, or its tp_free is for non-gc'ed objects.
3543 */
Tim Peters3cfe7542003-05-21 21:29:48 +00003544 PyErr_Format(PyExc_TypeError, "type '%.100s' participates in "
3545 "gc and is a base type but has inappropriate "
3546 "tp_free slot",
3547 type->tp_name);
3548 goto error;
3549 }
3550
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003551 /* if the type dictionary doesn't contain a __doc__, set it from
3552 the tp_doc slot.
3553 */
3554 if (PyDict_GetItemString(type->tp_dict, "__doc__") == NULL) {
3555 if (type->tp_doc != NULL) {
3556 PyObject *doc = PyString_FromString(type->tp_doc);
Neal Norwitze1fdb322006-07-21 05:32:28 +00003557 if (doc == NULL)
3558 goto error;
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003559 PyDict_SetItemString(type->tp_dict, "__doc__", doc);
3560 Py_DECREF(doc);
3561 } else {
Guido van Rossumd4641072002-04-03 02:13:37 +00003562 PyDict_SetItemString(type->tp_dict,
3563 "__doc__", Py_None);
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003564 }
3565 }
3566
Guido van Rossum64c06e32007-11-22 00:55:51 +00003567 /* Hack for tp_hash and __hash__.
3568 If after all that, tp_hash is still NULL, and __hash__ is not in
3569 tp_dict, set tp_dict['__hash__'] equal to None.
3570 This signals that __hash__ is not inherited.
3571 */
3572 if (type->tp_hash == NULL &&
3573 PyDict_GetItemString(type->tp_dict, "__hash__") == NULL &&
3574 PyDict_SetItemString(type->tp_dict, "__hash__", Py_None) < 0)
3575 {
3576 goto error;
3577 }
3578
Guido van Rossum13d52f02001-08-10 21:24:08 +00003579 /* Some more special stuff */
3580 base = type->tp_base;
3581 if (base != NULL) {
3582 if (type->tp_as_number == NULL)
3583 type->tp_as_number = base->tp_as_number;
3584 if (type->tp_as_sequence == NULL)
3585 type->tp_as_sequence = base->tp_as_sequence;
3586 if (type->tp_as_mapping == NULL)
3587 type->tp_as_mapping = base->tp_as_mapping;
Guido van Rossumeea47182003-02-11 20:39:59 +00003588 if (type->tp_as_buffer == NULL)
3589 type->tp_as_buffer = base->tp_as_buffer;
Guido van Rossum13d52f02001-08-10 21:24:08 +00003590 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003591
Guido van Rossum1c450732001-10-08 15:18:27 +00003592 /* Link into each base class's list of subclasses */
3593 bases = type->tp_bases;
3594 n = PyTuple_GET_SIZE(bases);
3595 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00003596 PyObject *b = PyTuple_GET_ITEM(bases, i);
3597 if (PyType_Check(b) &&
3598 add_subclass((PyTypeObject *)b, type) < 0)
Guido van Rossum1c450732001-10-08 15:18:27 +00003599 goto error;
3600 }
3601
Guido van Rossum13d52f02001-08-10 21:24:08 +00003602 /* All done -- set the ready flag */
Guido van Rossumd614f972001-08-10 17:39:49 +00003603 assert(type->tp_dict != NULL);
3604 type->tp_flags =
3605 (type->tp_flags & ~Py_TPFLAGS_READYING) | Py_TPFLAGS_READY;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003606 return 0;
Guido van Rossumd614f972001-08-10 17:39:49 +00003607
3608 error:
3609 type->tp_flags &= ~Py_TPFLAGS_READYING;
3610 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003611}
3612
Guido van Rossum1c450732001-10-08 15:18:27 +00003613static int
3614add_subclass(PyTypeObject *base, PyTypeObject *type)
3615{
Martin v. Löwiseb079f12006-02-16 14:32:27 +00003616 Py_ssize_t i;
3617 int result;
Anthony Baxtera6286212006-04-11 07:42:36 +00003618 PyObject *list, *ref, *newobj;
Guido van Rossum1c450732001-10-08 15:18:27 +00003619
3620 list = base->tp_subclasses;
3621 if (list == NULL) {
3622 base->tp_subclasses = list = PyList_New(0);
3623 if (list == NULL)
3624 return -1;
3625 }
3626 assert(PyList_Check(list));
Anthony Baxtera6286212006-04-11 07:42:36 +00003627 newobj = PyWeakref_NewRef((PyObject *)type, NULL);
Guido van Rossum1c450732001-10-08 15:18:27 +00003628 i = PyList_GET_SIZE(list);
3629 while (--i >= 0) {
3630 ref = PyList_GET_ITEM(list, i);
3631 assert(PyWeakref_CheckRef(ref));
Guido van Rossum3930bc32002-10-18 13:51:49 +00003632 if (PyWeakref_GET_OBJECT(ref) == Py_None)
Anthony Baxtera6286212006-04-11 07:42:36 +00003633 return PyList_SetItem(list, i, newobj);
Guido van Rossum1c450732001-10-08 15:18:27 +00003634 }
Anthony Baxtera6286212006-04-11 07:42:36 +00003635 result = PyList_Append(list, newobj);
3636 Py_DECREF(newobj);
Martin v. Löwiseb079f12006-02-16 14:32:27 +00003637 return result;
Guido van Rossum1c450732001-10-08 15:18:27 +00003638}
3639
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003640static void
3641remove_subclass(PyTypeObject *base, PyTypeObject *type)
3642{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003643 Py_ssize_t i;
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003644 PyObject *list, *ref;
3645
3646 list = base->tp_subclasses;
3647 if (list == NULL) {
3648 return;
3649 }
3650 assert(PyList_Check(list));
3651 i = PyList_GET_SIZE(list);
3652 while (--i >= 0) {
3653 ref = PyList_GET_ITEM(list, i);
3654 assert(PyWeakref_CheckRef(ref));
3655 if (PyWeakref_GET_OBJECT(ref) == (PyObject*)type) {
3656 /* this can't fail, right? */
3657 PySequence_DelItem(list, i);
3658 return;
3659 }
3660 }
3661}
Tim Peters6d6c1a32001-08-02 04:15:00 +00003662
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003663static int
3664check_num_args(PyObject *ob, int n)
3665{
3666 if (!PyTuple_CheckExact(ob)) {
3667 PyErr_SetString(PyExc_SystemError,
3668 "PyArg_UnpackTuple() argument list is not a tuple");
3669 return 0;
3670 }
3671 if (n == PyTuple_GET_SIZE(ob))
3672 return 1;
3673 PyErr_Format(
3674 PyExc_TypeError,
Martin v. Löwis2c95cc62006-02-16 06:54:25 +00003675 "expected %d arguments, got %zd", n, PyTuple_GET_SIZE(ob));
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003676 return 0;
3677}
3678
Tim Peters6d6c1a32001-08-02 04:15:00 +00003679/* Generic wrappers for overloadable 'operators' such as __getitem__ */
3680
3681/* There's a wrapper *function* for each distinct function typedef used
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00003682 for type object slots (e.g. binaryfunc, ternaryfunc, etc.). There's a
Tim Peters6d6c1a32001-08-02 04:15:00 +00003683 wrapper *table* for each distinct operation (e.g. __len__, __add__).
3684 Most tables have only one entry; the tables for binary operators have two
3685 entries, one regular and one with reversed arguments. */
3686
3687static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00003688wrap_lenfunc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003689{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003690 lenfunc func = (lenfunc)wrapped;
3691 Py_ssize_t res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003692
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003693 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003694 return NULL;
3695 res = (*func)(self);
3696 if (res == -1 && PyErr_Occurred())
3697 return NULL;
3698 return PyInt_FromLong((long)res);
3699}
3700
Tim Peters6d6c1a32001-08-02 04:15:00 +00003701static PyObject *
Raymond Hettingerf34f2642003-10-11 17:29:04 +00003702wrap_inquirypred(PyObject *self, PyObject *args, void *wrapped)
3703{
3704 inquiry func = (inquiry)wrapped;
3705 int res;
3706
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003707 if (!check_num_args(args, 0))
Raymond Hettingerf34f2642003-10-11 17:29:04 +00003708 return NULL;
3709 res = (*func)(self);
3710 if (res == -1 && PyErr_Occurred())
3711 return NULL;
3712 return PyBool_FromLong((long)res);
3713}
3714
3715static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00003716wrap_binaryfunc(PyObject *self, PyObject *args, void *wrapped)
3717{
3718 binaryfunc func = (binaryfunc)wrapped;
3719 PyObject *other;
3720
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003721 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003722 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003723 other = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003724 return (*func)(self, other);
3725}
3726
3727static PyObject *
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003728wrap_binaryfunc_l(PyObject *self, PyObject *args, void *wrapped)
3729{
3730 binaryfunc func = (binaryfunc)wrapped;
3731 PyObject *other;
3732
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003733 if (!check_num_args(args, 1))
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003734 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003735 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003736 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003737 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003738 Py_INCREF(Py_NotImplemented);
3739 return Py_NotImplemented;
3740 }
3741 return (*func)(self, other);
3742}
3743
3744static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00003745wrap_binaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
3746{
3747 binaryfunc func = (binaryfunc)wrapped;
3748 PyObject *other;
3749
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003750 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003751 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003752 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003753 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003754 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003755 Py_INCREF(Py_NotImplemented);
3756 return Py_NotImplemented;
3757 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003758 return (*func)(other, self);
3759}
3760
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003761static PyObject *
3762wrap_coercefunc(PyObject *self, PyObject *args, void *wrapped)
3763{
3764 coercion func = (coercion)wrapped;
3765 PyObject *other, *res;
3766 int ok;
3767
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003768 if (!check_num_args(args, 1))
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003769 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003770 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003771 ok = func(&self, &other);
3772 if (ok < 0)
3773 return NULL;
3774 if (ok > 0) {
3775 Py_INCREF(Py_NotImplemented);
3776 return Py_NotImplemented;
3777 }
3778 res = PyTuple_New(2);
3779 if (res == NULL) {
3780 Py_DECREF(self);
3781 Py_DECREF(other);
3782 return NULL;
3783 }
3784 PyTuple_SET_ITEM(res, 0, self);
3785 PyTuple_SET_ITEM(res, 1, other);
3786 return res;
3787}
3788
Tim Peters6d6c1a32001-08-02 04:15:00 +00003789static PyObject *
3790wrap_ternaryfunc(PyObject *self, PyObject *args, void *wrapped)
3791{
3792 ternaryfunc func = (ternaryfunc)wrapped;
3793 PyObject *other;
3794 PyObject *third = Py_None;
3795
3796 /* Note: This wrapper only works for __pow__() */
3797
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003798 if (!PyArg_UnpackTuple(args, "", 1, 2, &other, &third))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003799 return NULL;
3800 return (*func)(self, other, third);
3801}
3802
Guido van Rossum9bea3ab2001-09-28 22:58:52 +00003803static PyObject *
3804wrap_ternaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
3805{
3806 ternaryfunc func = (ternaryfunc)wrapped;
3807 PyObject *other;
3808 PyObject *third = Py_None;
3809
3810 /* Note: This wrapper only works for __pow__() */
3811
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003812 if (!PyArg_UnpackTuple(args, "", 1, 2, &other, &third))
Guido van Rossum9bea3ab2001-09-28 22:58:52 +00003813 return NULL;
3814 return (*func)(other, self, third);
3815}
3816
Tim Peters6d6c1a32001-08-02 04:15:00 +00003817static PyObject *
3818wrap_unaryfunc(PyObject *self, PyObject *args, void *wrapped)
3819{
3820 unaryfunc func = (unaryfunc)wrapped;
3821
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003822 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003823 return NULL;
3824 return (*func)(self);
3825}
3826
Tim Peters6d6c1a32001-08-02 04:15:00 +00003827static PyObject *
Armin Rigo314861c2006-03-30 14:04:02 +00003828wrap_indexargfunc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003829{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003830 ssizeargfunc func = (ssizeargfunc)wrapped;
Armin Rigo314861c2006-03-30 14:04:02 +00003831 PyObject* o;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003832 Py_ssize_t i;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003833
Armin Rigo314861c2006-03-30 14:04:02 +00003834 if (!PyArg_UnpackTuple(args, "", 1, 1, &o))
3835 return NULL;
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00003836 i = PyNumber_AsSsize_t(o, PyExc_OverflowError);
Armin Rigo314861c2006-03-30 14:04:02 +00003837 if (i == -1 && PyErr_Occurred())
Tim Peters6d6c1a32001-08-02 04:15:00 +00003838 return NULL;
3839 return (*func)(self, i);
3840}
3841
Martin v. Löwis18e16552006-02-15 17:27:45 +00003842static Py_ssize_t
Guido van Rossum5d815f32001-08-17 21:57:47 +00003843getindex(PyObject *self, PyObject *arg)
3844{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003845 Py_ssize_t i;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003846
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00003847 i = PyNumber_AsSsize_t(arg, PyExc_OverflowError);
Guido van Rossum5d815f32001-08-17 21:57:47 +00003848 if (i == -1 && PyErr_Occurred())
3849 return -1;
3850 if (i < 0) {
Christian Heimese93237d2007-12-19 02:37:44 +00003851 PySequenceMethods *sq = Py_TYPE(self)->tp_as_sequence;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003852 if (sq && sq->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00003853 Py_ssize_t n = (*sq->sq_length)(self);
Guido van Rossum5d815f32001-08-17 21:57:47 +00003854 if (n < 0)
3855 return -1;
3856 i += n;
3857 }
3858 }
3859 return i;
3860}
3861
3862static PyObject *
3863wrap_sq_item(PyObject *self, PyObject *args, void *wrapped)
3864{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003865 ssizeargfunc func = (ssizeargfunc)wrapped;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003866 PyObject *arg;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003867 Py_ssize_t i;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003868
Guido van Rossumf4593e02001-10-03 12:09:30 +00003869 if (PyTuple_GET_SIZE(args) == 1) {
3870 arg = PyTuple_GET_ITEM(args, 0);
3871 i = getindex(self, arg);
3872 if (i == -1 && PyErr_Occurred())
3873 return NULL;
3874 return (*func)(self, i);
3875 }
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003876 check_num_args(args, 1);
Guido van Rossumf4593e02001-10-03 12:09:30 +00003877 assert(PyErr_Occurred());
3878 return NULL;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003879}
3880
Tim Peters6d6c1a32001-08-02 04:15:00 +00003881static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00003882wrap_ssizessizeargfunc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003883{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003884 ssizessizeargfunc func = (ssizessizeargfunc)wrapped;
3885 Py_ssize_t i, j;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003886
Martin v. Löwis18e16552006-02-15 17:27:45 +00003887 if (!PyArg_ParseTuple(args, "nn", &i, &j))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003888 return NULL;
3889 return (*func)(self, i, j);
3890}
3891
Tim Peters6d6c1a32001-08-02 04:15:00 +00003892static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00003893wrap_sq_setitem(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003894{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003895 ssizeobjargproc func = (ssizeobjargproc)wrapped;
3896 Py_ssize_t i;
3897 int res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003898 PyObject *arg, *value;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003899
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003900 if (!PyArg_UnpackTuple(args, "", 2, 2, &arg, &value))
Guido van Rossum5d815f32001-08-17 21:57:47 +00003901 return NULL;
3902 i = getindex(self, arg);
3903 if (i == -1 && PyErr_Occurred())
Tim Peters6d6c1a32001-08-02 04:15:00 +00003904 return NULL;
3905 res = (*func)(self, i, value);
3906 if (res == -1 && PyErr_Occurred())
3907 return NULL;
3908 Py_INCREF(Py_None);
3909 return Py_None;
3910}
3911
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003912static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00003913wrap_sq_delitem(PyObject *self, PyObject *args, void *wrapped)
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003914{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003915 ssizeobjargproc func = (ssizeobjargproc)wrapped;
3916 Py_ssize_t i;
3917 int res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003918 PyObject *arg;
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003919
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003920 if (!check_num_args(args, 1))
Guido van Rossum5d815f32001-08-17 21:57:47 +00003921 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003922 arg = PyTuple_GET_ITEM(args, 0);
Guido van Rossum5d815f32001-08-17 21:57:47 +00003923 i = getindex(self, arg);
3924 if (i == -1 && PyErr_Occurred())
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003925 return NULL;
3926 res = (*func)(self, i, NULL);
3927 if (res == -1 && PyErr_Occurred())
3928 return NULL;
3929 Py_INCREF(Py_None);
3930 return Py_None;
3931}
3932
Tim Peters6d6c1a32001-08-02 04:15:00 +00003933static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00003934wrap_ssizessizeobjargproc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003935{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003936 ssizessizeobjargproc func = (ssizessizeobjargproc)wrapped;
3937 Py_ssize_t i, j;
3938 int res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003939 PyObject *value;
3940
Martin v. Löwis18e16552006-02-15 17:27:45 +00003941 if (!PyArg_ParseTuple(args, "nnO", &i, &j, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003942 return NULL;
3943 res = (*func)(self, i, j, value);
3944 if (res == -1 && PyErr_Occurred())
3945 return NULL;
3946 Py_INCREF(Py_None);
3947 return Py_None;
3948}
3949
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003950static PyObject *
3951wrap_delslice(PyObject *self, PyObject *args, void *wrapped)
3952{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003953 ssizessizeobjargproc func = (ssizessizeobjargproc)wrapped;
3954 Py_ssize_t i, j;
3955 int res;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003956
Martin v. Löwis18e16552006-02-15 17:27:45 +00003957 if (!PyArg_ParseTuple(args, "nn", &i, &j))
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003958 return NULL;
3959 res = (*func)(self, i, j, NULL);
3960 if (res == -1 && PyErr_Occurred())
3961 return NULL;
3962 Py_INCREF(Py_None);
3963 return Py_None;
3964}
3965
Tim Peters6d6c1a32001-08-02 04:15:00 +00003966/* XXX objobjproc is a misnomer; should be objargpred */
3967static PyObject *
3968wrap_objobjproc(PyObject *self, PyObject *args, void *wrapped)
3969{
3970 objobjproc func = (objobjproc)wrapped;
3971 int res;
Guido van Rossum22c3dda2003-10-09 03:46:35 +00003972 PyObject *value;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003973
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003974 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003975 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003976 value = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003977 res = (*func)(self, value);
3978 if (res == -1 && PyErr_Occurred())
3979 return NULL;
Guido van Rossum22c3dda2003-10-09 03:46:35 +00003980 else
3981 return PyBool_FromLong(res);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003982}
3983
Tim Peters6d6c1a32001-08-02 04:15:00 +00003984static PyObject *
3985wrap_objobjargproc(PyObject *self, PyObject *args, void *wrapped)
3986{
3987 objobjargproc func = (objobjargproc)wrapped;
3988 int res;
3989 PyObject *key, *value;
3990
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003991 if (!PyArg_UnpackTuple(args, "", 2, 2, &key, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003992 return NULL;
3993 res = (*func)(self, key, value);
3994 if (res == -1 && PyErr_Occurred())
3995 return NULL;
3996 Py_INCREF(Py_None);
3997 return Py_None;
3998}
3999
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00004000static PyObject *
4001wrap_delitem(PyObject *self, PyObject *args, void *wrapped)
4002{
4003 objobjargproc func = (objobjargproc)wrapped;
4004 int res;
4005 PyObject *key;
4006
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004007 if (!check_num_args(args, 1))
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00004008 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004009 key = PyTuple_GET_ITEM(args, 0);
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00004010 res = (*func)(self, key, NULL);
4011 if (res == -1 && PyErr_Occurred())
4012 return NULL;
4013 Py_INCREF(Py_None);
4014 return Py_None;
4015}
4016
Tim Peters6d6c1a32001-08-02 04:15:00 +00004017static PyObject *
4018wrap_cmpfunc(PyObject *self, PyObject *args, void *wrapped)
4019{
4020 cmpfunc func = (cmpfunc)wrapped;
4021 int res;
4022 PyObject *other;
4023
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004024 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004025 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004026 other = PyTuple_GET_ITEM(args, 0);
Christian Heimese93237d2007-12-19 02:37:44 +00004027 if (Py_TYPE(other)->tp_compare != func &&
4028 !PyType_IsSubtype(Py_TYPE(other), Py_TYPE(self))) {
Guido van Rossumceccae52001-09-18 20:03:57 +00004029 PyErr_Format(
4030 PyExc_TypeError,
4031 "%s.__cmp__(x,y) requires y to be a '%s', not a '%s'",
Christian Heimese93237d2007-12-19 02:37:44 +00004032 Py_TYPE(self)->tp_name,
4033 Py_TYPE(self)->tp_name,
4034 Py_TYPE(other)->tp_name);
Guido van Rossumceccae52001-09-18 20:03:57 +00004035 return NULL;
4036 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004037 res = (*func)(self, other);
4038 if (PyErr_Occurred())
4039 return NULL;
4040 return PyInt_FromLong((long)res);
4041}
4042
Guido van Rossum4dcdb782003-04-14 21:46:03 +00004043/* Helper to check for object.__setattr__ or __delattr__ applied to a type.
Guido van Rossum52b27052003-04-15 20:05:10 +00004044 This is called the Carlo Verre hack after its discoverer. */
Guido van Rossum4dcdb782003-04-14 21:46:03 +00004045static int
4046hackcheck(PyObject *self, setattrofunc func, char *what)
4047{
Christian Heimese93237d2007-12-19 02:37:44 +00004048 PyTypeObject *type = Py_TYPE(self);
Guido van Rossum4dcdb782003-04-14 21:46:03 +00004049 while (type && type->tp_flags & Py_TPFLAGS_HEAPTYPE)
4050 type = type->tp_base;
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00004051 /* If type is NULL now, this is a really weird type.
4052 In the spirit of backwards compatibility (?), just shut up. */
Guido van Rossum692cdbc2006-03-10 02:04:28 +00004053 if (type && type->tp_setattro != func) {
Guido van Rossum4dcdb782003-04-14 21:46:03 +00004054 PyErr_Format(PyExc_TypeError,
4055 "can't apply this %s to %s object",
4056 what,
4057 type->tp_name);
4058 return 0;
4059 }
4060 return 1;
4061}
4062
Tim Peters6d6c1a32001-08-02 04:15:00 +00004063static PyObject *
4064wrap_setattr(PyObject *self, PyObject *args, void *wrapped)
4065{
4066 setattrofunc func = (setattrofunc)wrapped;
4067 int res;
4068 PyObject *name, *value;
4069
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00004070 if (!PyArg_UnpackTuple(args, "", 2, 2, &name, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004071 return NULL;
Guido van Rossum4dcdb782003-04-14 21:46:03 +00004072 if (!hackcheck(self, func, "__setattr__"))
4073 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004074 res = (*func)(self, name, value);
4075 if (res < 0)
4076 return NULL;
4077 Py_INCREF(Py_None);
4078 return Py_None;
4079}
4080
4081static PyObject *
4082wrap_delattr(PyObject *self, PyObject *args, void *wrapped)
4083{
4084 setattrofunc func = (setattrofunc)wrapped;
4085 int res;
4086 PyObject *name;
4087
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004088 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004089 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004090 name = PyTuple_GET_ITEM(args, 0);
Guido van Rossum4dcdb782003-04-14 21:46:03 +00004091 if (!hackcheck(self, func, "__delattr__"))
4092 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004093 res = (*func)(self, name, NULL);
4094 if (res < 0)
4095 return NULL;
4096 Py_INCREF(Py_None);
4097 return Py_None;
4098}
4099
Tim Peters6d6c1a32001-08-02 04:15:00 +00004100static PyObject *
4101wrap_hashfunc(PyObject *self, PyObject *args, void *wrapped)
4102{
4103 hashfunc func = (hashfunc)wrapped;
4104 long res;
4105
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004106 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004107 return NULL;
4108 res = (*func)(self);
4109 if (res == -1 && PyErr_Occurred())
4110 return NULL;
4111 return PyInt_FromLong(res);
4112}
4113
Tim Peters6d6c1a32001-08-02 04:15:00 +00004114static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00004115wrap_call(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004116{
4117 ternaryfunc func = (ternaryfunc)wrapped;
4118
Guido van Rossumc8e56452001-10-22 00:43:43 +00004119 return (*func)(self, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004120}
4121
Tim Peters6d6c1a32001-08-02 04:15:00 +00004122static PyObject *
4123wrap_richcmpfunc(PyObject *self, PyObject *args, void *wrapped, int op)
4124{
4125 richcmpfunc func = (richcmpfunc)wrapped;
4126 PyObject *other;
4127
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004128 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004129 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004130 other = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004131 return (*func)(self, other, op);
4132}
4133
4134#undef RICHCMP_WRAPPER
4135#define RICHCMP_WRAPPER(NAME, OP) \
4136static PyObject * \
4137richcmp_##NAME(PyObject *self, PyObject *args, void *wrapped) \
4138{ \
4139 return wrap_richcmpfunc(self, args, wrapped, OP); \
4140}
4141
Jack Jansen8e938b42001-08-08 15:29:49 +00004142RICHCMP_WRAPPER(lt, Py_LT)
4143RICHCMP_WRAPPER(le, Py_LE)
4144RICHCMP_WRAPPER(eq, Py_EQ)
4145RICHCMP_WRAPPER(ne, Py_NE)
4146RICHCMP_WRAPPER(gt, Py_GT)
4147RICHCMP_WRAPPER(ge, Py_GE)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004148
Tim Peters6d6c1a32001-08-02 04:15:00 +00004149static PyObject *
4150wrap_next(PyObject *self, PyObject *args, void *wrapped)
4151{
4152 unaryfunc func = (unaryfunc)wrapped;
4153 PyObject *res;
4154
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004155 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004156 return NULL;
4157 res = (*func)(self);
4158 if (res == NULL && !PyErr_Occurred())
4159 PyErr_SetNone(PyExc_StopIteration);
4160 return res;
4161}
4162
Tim Peters6d6c1a32001-08-02 04:15:00 +00004163static PyObject *
4164wrap_descr_get(PyObject *self, PyObject *args, void *wrapped)
4165{
4166 descrgetfunc func = (descrgetfunc)wrapped;
4167 PyObject *obj;
4168 PyObject *type = NULL;
4169
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00004170 if (!PyArg_UnpackTuple(args, "", 1, 2, &obj, &type))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004171 return NULL;
Guido van Rossum82ed25c2003-02-11 16:25:43 +00004172 if (obj == Py_None)
4173 obj = NULL;
4174 if (type == Py_None)
4175 type = NULL;
4176 if (type == NULL &&obj == NULL) {
4177 PyErr_SetString(PyExc_TypeError,
4178 "__get__(None, None) is invalid");
4179 return NULL;
4180 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004181 return (*func)(self, obj, type);
4182}
4183
Tim Peters6d6c1a32001-08-02 04:15:00 +00004184static PyObject *
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004185wrap_descr_set(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004186{
4187 descrsetfunc func = (descrsetfunc)wrapped;
4188 PyObject *obj, *value;
4189 int ret;
4190
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00004191 if (!PyArg_UnpackTuple(args, "", 2, 2, &obj, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00004192 return NULL;
4193 ret = (*func)(self, obj, value);
4194 if (ret < 0)
4195 return NULL;
4196 Py_INCREF(Py_None);
4197 return Py_None;
4198}
Guido van Rossum22b13872002-08-06 21:41:44 +00004199
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00004200static PyObject *
4201wrap_descr_delete(PyObject *self, PyObject *args, void *wrapped)
4202{
4203 descrsetfunc func = (descrsetfunc)wrapped;
4204 PyObject *obj;
4205 int ret;
4206
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004207 if (!check_num_args(args, 1))
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00004208 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00004209 obj = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00004210 ret = (*func)(self, obj, NULL);
4211 if (ret < 0)
4212 return NULL;
4213 Py_INCREF(Py_None);
4214 return Py_None;
4215}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004216
Tim Peters6d6c1a32001-08-02 04:15:00 +00004217static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00004218wrap_init(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004219{
4220 initproc func = (initproc)wrapped;
4221
Guido van Rossumc8e56452001-10-22 00:43:43 +00004222 if (func(self, args, kwds) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004223 return NULL;
4224 Py_INCREF(Py_None);
4225 return Py_None;
4226}
4227
Tim Peters6d6c1a32001-08-02 04:15:00 +00004228static PyObject *
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004229tp_new_wrapper(PyObject *self, PyObject *args, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004230{
Barry Warsaw60f01882001-08-22 19:24:42 +00004231 PyTypeObject *type, *subtype, *staticbase;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004232 PyObject *arg0, *res;
4233
4234 if (self == NULL || !PyType_Check(self))
4235 Py_FatalError("__new__() called with non-type 'self'");
4236 type = (PyTypeObject *)self;
4237 if (!PyTuple_Check(args) || PyTuple_GET_SIZE(args) < 1) {
Barry Warsaw60f01882001-08-22 19:24:42 +00004238 PyErr_Format(PyExc_TypeError,
4239 "%s.__new__(): not enough arguments",
4240 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004241 return NULL;
4242 }
4243 arg0 = PyTuple_GET_ITEM(args, 0);
4244 if (!PyType_Check(arg0)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00004245 PyErr_Format(PyExc_TypeError,
4246 "%s.__new__(X): X is not a type object (%s)",
4247 type->tp_name,
Christian Heimese93237d2007-12-19 02:37:44 +00004248 Py_TYPE(arg0)->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004249 return NULL;
4250 }
4251 subtype = (PyTypeObject *)arg0;
4252 if (!PyType_IsSubtype(subtype, type)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00004253 PyErr_Format(PyExc_TypeError,
4254 "%s.__new__(%s): %s is not a subtype of %s",
4255 type->tp_name,
4256 subtype->tp_name,
4257 subtype->tp_name,
4258 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004259 return NULL;
4260 }
Barry Warsaw60f01882001-08-22 19:24:42 +00004261
4262 /* Check that the use doesn't do something silly and unsafe like
Tim Petersa427a2b2001-10-29 22:25:45 +00004263 object.__new__(dict). To do this, we check that the
Barry Warsaw60f01882001-08-22 19:24:42 +00004264 most derived base that's not a heap type is this type. */
4265 staticbase = subtype;
4266 while (staticbase && (staticbase->tp_flags & Py_TPFLAGS_HEAPTYPE))
4267 staticbase = staticbase->tp_base;
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00004268 /* If staticbase is NULL now, it is a really weird type.
4269 In the spirit of backwards compatibility (?), just shut up. */
Guido van Rossum692cdbc2006-03-10 02:04:28 +00004270 if (staticbase && staticbase->tp_new != type->tp_new) {
Barry Warsaw60f01882001-08-22 19:24:42 +00004271 PyErr_Format(PyExc_TypeError,
4272 "%s.__new__(%s) is not safe, use %s.__new__()",
4273 type->tp_name,
4274 subtype->tp_name,
4275 staticbase == NULL ? "?" : staticbase->tp_name);
4276 return NULL;
4277 }
4278
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004279 args = PyTuple_GetSlice(args, 1, PyTuple_GET_SIZE(args));
4280 if (args == NULL)
4281 return NULL;
4282 res = type->tp_new(subtype, args, kwds);
4283 Py_DECREF(args);
4284 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004285}
4286
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004287static struct PyMethodDef tp_new_methoddef[] = {
Neal Norwitza84dcd72007-05-22 07:16:44 +00004288 {"__new__", (PyCFunction)tp_new_wrapper, METH_VARARGS|METH_KEYWORDS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00004289 PyDoc_STR("T.__new__(S, ...) -> "
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00004290 "a new object with type S, a subtype of T")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00004291 {0}
4292};
4293
4294static int
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004295add_tp_new_wrapper(PyTypeObject *type)
4296{
Guido van Rossumf040ede2001-08-07 16:40:56 +00004297 PyObject *func;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004298
Guido van Rossum687ae002001-10-15 22:03:32 +00004299 if (PyDict_GetItemString(type->tp_dict, "__new__") != NULL)
Guido van Rossumf040ede2001-08-07 16:40:56 +00004300 return 0;
4301 func = PyCFunction_New(tp_new_methoddef, (PyObject *)type);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004302 if (func == NULL)
4303 return -1;
Raymond Hettinger8d726ee2004-06-25 22:24:35 +00004304 if (PyDict_SetItemString(type->tp_dict, "__new__", func)) {
Raymond Hettingerd56cbe52004-06-25 22:17:39 +00004305 Py_DECREF(func);
4306 return -1;
4307 }
4308 Py_DECREF(func);
4309 return 0;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004310}
4311
Guido van Rossumf040ede2001-08-07 16:40:56 +00004312/* Slot wrappers that call the corresponding __foo__ slot. See comments
4313 below at override_slots() for more explanation. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004314
Guido van Rossumdc91b992001-08-08 22:26:22 +00004315#define SLOT0(FUNCNAME, OPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004316static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004317FUNCNAME(PyObject *self) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004318{ \
Guido van Rossum5592e4d2001-08-28 18:28:21 +00004319 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00004320 return call_method(self, OPSTR, &cache_str, "()"); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004321}
4322
Guido van Rossumdc91b992001-08-08 22:26:22 +00004323#define SLOT1(FUNCNAME, OPSTR, ARG1TYPE, ARGCODES) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004324static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004325FUNCNAME(PyObject *self, ARG1TYPE arg1) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004326{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004327 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00004328 return call_method(self, OPSTR, &cache_str, "(" ARGCODES ")", arg1); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004329}
4330
Guido van Rossumcd118802003-01-06 22:57:47 +00004331/* Boolean helper for SLOT1BINFULL().
4332 right.__class__ is a nontrivial subclass of left.__class__. */
4333static int
4334method_is_overloaded(PyObject *left, PyObject *right, char *name)
4335{
4336 PyObject *a, *b;
4337 int ok;
4338
Christian Heimese93237d2007-12-19 02:37:44 +00004339 b = PyObject_GetAttrString((PyObject *)(Py_TYPE(right)), name);
Guido van Rossumcd118802003-01-06 22:57:47 +00004340 if (b == NULL) {
4341 PyErr_Clear();
4342 /* If right doesn't have it, it's not overloaded */
4343 return 0;
4344 }
4345
Christian Heimese93237d2007-12-19 02:37:44 +00004346 a = PyObject_GetAttrString((PyObject *)(Py_TYPE(left)), name);
Guido van Rossumcd118802003-01-06 22:57:47 +00004347 if (a == NULL) {
4348 PyErr_Clear();
4349 Py_DECREF(b);
4350 /* If right has it but left doesn't, it's overloaded */
4351 return 1;
4352 }
4353
4354 ok = PyObject_RichCompareBool(a, b, Py_NE);
4355 Py_DECREF(a);
4356 Py_DECREF(b);
4357 if (ok < 0) {
4358 PyErr_Clear();
4359 return 0;
4360 }
4361
4362 return ok;
4363}
4364
Guido van Rossumdc91b992001-08-08 22:26:22 +00004365
4366#define SLOT1BINFULL(FUNCNAME, TESTFUNC, SLOTNAME, OPSTR, ROPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004367static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004368FUNCNAME(PyObject *self, PyObject *other) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004369{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004370 static PyObject *cache_str, *rcache_str; \
Christian Heimese93237d2007-12-19 02:37:44 +00004371 int do_other = Py_TYPE(self) != Py_TYPE(other) && \
4372 Py_TYPE(other)->tp_as_number != NULL && \
4373 Py_TYPE(other)->tp_as_number->SLOTNAME == TESTFUNC; \
4374 if (Py_TYPE(self)->tp_as_number != NULL && \
4375 Py_TYPE(self)->tp_as_number->SLOTNAME == TESTFUNC) { \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004376 PyObject *r; \
Guido van Rossum55f20992001-10-01 17:18:22 +00004377 if (do_other && \
Christian Heimese93237d2007-12-19 02:37:44 +00004378 PyType_IsSubtype(Py_TYPE(other), Py_TYPE(self)) && \
Guido van Rossumcd118802003-01-06 22:57:47 +00004379 method_is_overloaded(self, other, ROPSTR)) { \
Guido van Rossum55f20992001-10-01 17:18:22 +00004380 r = call_maybe( \
4381 other, ROPSTR, &rcache_str, "(O)", self); \
4382 if (r != Py_NotImplemented) \
4383 return r; \
4384 Py_DECREF(r); \
4385 do_other = 0; \
4386 } \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00004387 r = call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00004388 self, OPSTR, &cache_str, "(O)", other); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004389 if (r != Py_NotImplemented || \
Christian Heimese93237d2007-12-19 02:37:44 +00004390 Py_TYPE(other) == Py_TYPE(self)) \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004391 return r; \
4392 Py_DECREF(r); \
4393 } \
Guido van Rossum55f20992001-10-01 17:18:22 +00004394 if (do_other) { \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00004395 return call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00004396 other, ROPSTR, &rcache_str, "(O)", self); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004397 } \
4398 Py_INCREF(Py_NotImplemented); \
4399 return Py_NotImplemented; \
4400}
4401
4402#define SLOT1BIN(FUNCNAME, SLOTNAME, OPSTR, ROPSTR) \
4403 SLOT1BINFULL(FUNCNAME, FUNCNAME, SLOTNAME, OPSTR, ROPSTR)
4404
4405#define SLOT2(FUNCNAME, OPSTR, ARG1TYPE, ARG2TYPE, ARGCODES) \
4406static PyObject * \
4407FUNCNAME(PyObject *self, ARG1TYPE arg1, ARG2TYPE arg2) \
4408{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004409 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00004410 return call_method(self, OPSTR, &cache_str, \
4411 "(" ARGCODES ")", arg1, arg2); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004412}
4413
Martin v. Löwis18e16552006-02-15 17:27:45 +00004414static Py_ssize_t
Tim Peters6d6c1a32001-08-02 04:15:00 +00004415slot_sq_length(PyObject *self)
4416{
Guido van Rossum2730b132001-08-28 18:22:14 +00004417 static PyObject *len_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00004418 PyObject *res = call_method(self, "__len__", &len_str, "()");
Martin v. Löwis18e16552006-02-15 17:27:45 +00004419 Py_ssize_t len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004420
4421 if (res == NULL)
4422 return -1;
Neal Norwitz1872b1c2006-08-12 18:44:06 +00004423 len = PyInt_AsSsize_t(res);
Guido van Rossum26111622001-10-01 16:42:49 +00004424 Py_DECREF(res);
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00004425 if (len < 0) {
Armin Rigo7ccbca92006-10-04 12:17:45 +00004426 if (!PyErr_Occurred())
4427 PyErr_SetString(PyExc_ValueError,
4428 "__len__() should return >= 0");
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00004429 return -1;
4430 }
Guido van Rossum26111622001-10-01 16:42:49 +00004431 return len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004432}
4433
Guido van Rossumf4593e02001-10-03 12:09:30 +00004434/* Super-optimized version of slot_sq_item.
4435 Other slots could do the same... */
4436static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00004437slot_sq_item(PyObject *self, Py_ssize_t i)
Guido van Rossumf4593e02001-10-03 12:09:30 +00004438{
4439 static PyObject *getitem_str;
4440 PyObject *func, *args = NULL, *ival = NULL, *retval = NULL;
4441 descrgetfunc f;
4442
4443 if (getitem_str == NULL) {
4444 getitem_str = PyString_InternFromString("__getitem__");
4445 if (getitem_str == NULL)
4446 return NULL;
4447 }
Christian Heimese93237d2007-12-19 02:37:44 +00004448 func = _PyType_Lookup(Py_TYPE(self), getitem_str);
Guido van Rossumf4593e02001-10-03 12:09:30 +00004449 if (func != NULL) {
Christian Heimese93237d2007-12-19 02:37:44 +00004450 if ((f = Py_TYPE(func)->tp_descr_get) == NULL)
Guido van Rossumf4593e02001-10-03 12:09:30 +00004451 Py_INCREF(func);
Neal Norwitz673cd822002-10-18 16:33:13 +00004452 else {
Christian Heimese93237d2007-12-19 02:37:44 +00004453 func = f(func, self, (PyObject *)(Py_TYPE(self)));
Neal Norwitz673cd822002-10-18 16:33:13 +00004454 if (func == NULL) {
4455 return NULL;
4456 }
4457 }
Martin v. Löwiseb079f12006-02-16 14:32:27 +00004458 ival = PyInt_FromSsize_t(i);
Guido van Rossumf4593e02001-10-03 12:09:30 +00004459 if (ival != NULL) {
4460 args = PyTuple_New(1);
4461 if (args != NULL) {
4462 PyTuple_SET_ITEM(args, 0, ival);
4463 retval = PyObject_Call(func, args, NULL);
4464 Py_XDECREF(args);
4465 Py_XDECREF(func);
4466 return retval;
4467 }
4468 }
4469 }
4470 else {
4471 PyErr_SetObject(PyExc_AttributeError, getitem_str);
4472 }
4473 Py_XDECREF(args);
4474 Py_XDECREF(ival);
4475 Py_XDECREF(func);
4476 return NULL;
4477}
4478
Martin v. Löwis18e16552006-02-15 17:27:45 +00004479SLOT2(slot_sq_slice, "__getslice__", Py_ssize_t, Py_ssize_t, "nn")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004480
4481static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00004482slot_sq_ass_item(PyObject *self, Py_ssize_t index, PyObject *value)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004483{
4484 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004485 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004486
4487 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004488 res = call_method(self, "__delitem__", &delitem_str,
Thomas Wouters4e908102006-04-21 11:26:56 +00004489 "(n)", index);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004490 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004491 res = call_method(self, "__setitem__", &setitem_str,
Thomas Wouters4e908102006-04-21 11:26:56 +00004492 "(nO)", index, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004493 if (res == NULL)
4494 return -1;
4495 Py_DECREF(res);
4496 return 0;
4497}
4498
4499static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00004500slot_sq_ass_slice(PyObject *self, Py_ssize_t i, Py_ssize_t j, PyObject *value)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004501{
4502 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004503 static PyObject *delslice_str, *setslice_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004504
4505 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004506 res = call_method(self, "__delslice__", &delslice_str,
Thomas Wouters4e908102006-04-21 11:26:56 +00004507 "(nn)", i, j);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004508 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004509 res = call_method(self, "__setslice__", &setslice_str,
Thomas Wouters4e908102006-04-21 11:26:56 +00004510 "(nnO)", i, j, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004511 if (res == NULL)
4512 return -1;
4513 Py_DECREF(res);
4514 return 0;
4515}
4516
4517static int
4518slot_sq_contains(PyObject *self, PyObject *value)
4519{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004520 PyObject *func, *res, *args;
Tim Petersbf9b2442003-03-23 05:35:36 +00004521 int result = -1;
4522
Guido van Rossum60718732001-08-28 17:47:51 +00004523 static PyObject *contains_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004524
Guido van Rossum55f20992001-10-01 17:18:22 +00004525 func = lookup_maybe(self, "__contains__", &contains_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004526 if (func != NULL) {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004527 args = PyTuple_Pack(1, value);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004528 if (args == NULL)
4529 res = NULL;
4530 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004531 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004532 Py_DECREF(args);
4533 }
4534 Py_DECREF(func);
Tim Petersbf9b2442003-03-23 05:35:36 +00004535 if (res != NULL) {
4536 result = PyObject_IsTrue(res);
4537 Py_DECREF(res);
4538 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00004539 }
Tim Petersbf9b2442003-03-23 05:35:36 +00004540 else if (! PyErr_Occurred()) {
Martin v. Löwis725507b2006-03-07 12:08:51 +00004541 /* Possible results: -1 and 1 */
4542 result = (int)_PySequence_IterSearch(self, value,
Tim Petersbf9b2442003-03-23 05:35:36 +00004543 PY_ITERSEARCH_CONTAINS);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004544 }
Tim Petersbf9b2442003-03-23 05:35:36 +00004545 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004546}
4547
Tim Peters6d6c1a32001-08-02 04:15:00 +00004548#define slot_mp_length slot_sq_length
4549
Guido van Rossumdc91b992001-08-08 22:26:22 +00004550SLOT1(slot_mp_subscript, "__getitem__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004551
4552static int
4553slot_mp_ass_subscript(PyObject *self, PyObject *key, PyObject *value)
4554{
4555 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004556 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004557
4558 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004559 res = call_method(self, "__delitem__", &delitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004560 "(O)", key);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004561 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004562 res = call_method(self, "__setitem__", &setitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004563 "(OO)", key, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004564 if (res == NULL)
4565 return -1;
4566 Py_DECREF(res);
4567 return 0;
4568}
4569
Guido van Rossumdc91b992001-08-08 22:26:22 +00004570SLOT1BIN(slot_nb_add, nb_add, "__add__", "__radd__")
4571SLOT1BIN(slot_nb_subtract, nb_subtract, "__sub__", "__rsub__")
4572SLOT1BIN(slot_nb_multiply, nb_multiply, "__mul__", "__rmul__")
4573SLOT1BIN(slot_nb_divide, nb_divide, "__div__", "__rdiv__")
4574SLOT1BIN(slot_nb_remainder, nb_remainder, "__mod__", "__rmod__")
4575SLOT1BIN(slot_nb_divmod, nb_divmod, "__divmod__", "__rdivmod__")
4576
Jeremy Hylton938ace62002-07-17 16:30:39 +00004577static PyObject *slot_nb_power(PyObject *, PyObject *, PyObject *);
Guido van Rossumdc91b992001-08-08 22:26:22 +00004578
4579SLOT1BINFULL(slot_nb_power_binary, slot_nb_power,
4580 nb_power, "__pow__", "__rpow__")
4581
4582static PyObject *
4583slot_nb_power(PyObject *self, PyObject *other, PyObject *modulus)
4584{
Guido van Rossum2730b132001-08-28 18:22:14 +00004585 static PyObject *pow_str;
4586
Guido van Rossumdc91b992001-08-08 22:26:22 +00004587 if (modulus == Py_None)
4588 return slot_nb_power_binary(self, other);
Guido van Rossum23094982002-06-10 14:30:43 +00004589 /* Three-arg power doesn't use __rpow__. But ternary_op
4590 can call this when the second argument's type uses
4591 slot_nb_power, so check before calling self.__pow__. */
Christian Heimese93237d2007-12-19 02:37:44 +00004592 if (Py_TYPE(self)->tp_as_number != NULL &&
4593 Py_TYPE(self)->tp_as_number->nb_power == slot_nb_power) {
Guido van Rossum23094982002-06-10 14:30:43 +00004594 return call_method(self, "__pow__", &pow_str,
4595 "(OO)", other, modulus);
4596 }
4597 Py_INCREF(Py_NotImplemented);
4598 return Py_NotImplemented;
Guido van Rossumdc91b992001-08-08 22:26:22 +00004599}
4600
4601SLOT0(slot_nb_negative, "__neg__")
4602SLOT0(slot_nb_positive, "__pos__")
4603SLOT0(slot_nb_absolute, "__abs__")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004604
4605static int
4606slot_nb_nonzero(PyObject *self)
4607{
Tim Petersea7f75d2002-12-07 21:39:16 +00004608 PyObject *func, *args;
Guido van Rossum60718732001-08-28 17:47:51 +00004609 static PyObject *nonzero_str, *len_str;
Tim Petersea7f75d2002-12-07 21:39:16 +00004610 int result = -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004611
Guido van Rossum55f20992001-10-01 17:18:22 +00004612 func = lookup_maybe(self, "__nonzero__", &nonzero_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004613 if (func == NULL) {
Guido van Rossum55f20992001-10-01 17:18:22 +00004614 if (PyErr_Occurred())
Guido van Rossumb8f63662001-08-15 23:57:02 +00004615 return -1;
Guido van Rossum55f20992001-10-01 17:18:22 +00004616 func = lookup_maybe(self, "__len__", &len_str);
Tim Petersea7f75d2002-12-07 21:39:16 +00004617 if (func == NULL)
4618 return PyErr_Occurred() ? -1 : 1;
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00004619 }
Tim Petersea7f75d2002-12-07 21:39:16 +00004620 args = PyTuple_New(0);
4621 if (args != NULL) {
4622 PyObject *temp = PyObject_Call(func, args, NULL);
4623 Py_DECREF(args);
4624 if (temp != NULL) {
Jeremy Hylton3e3159c2003-06-27 17:38:27 +00004625 if (PyInt_CheckExact(temp) || PyBool_Check(temp))
Jeremy Hylton090a3492003-06-27 16:46:45 +00004626 result = PyObject_IsTrue(temp);
4627 else {
4628 PyErr_Format(PyExc_TypeError,
4629 "__nonzero__ should return "
4630 "bool or int, returned %s",
4631 temp->ob_type->tp_name);
Jeremy Hylton3e3159c2003-06-27 17:38:27 +00004632 result = -1;
Jeremy Hylton090a3492003-06-27 16:46:45 +00004633 }
Tim Petersea7f75d2002-12-07 21:39:16 +00004634 Py_DECREF(temp);
Guido van Rossum55f20992001-10-01 17:18:22 +00004635 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00004636 }
Guido van Rossum55f20992001-10-01 17:18:22 +00004637 Py_DECREF(func);
Tim Petersea7f75d2002-12-07 21:39:16 +00004638 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004639}
4640
Guido van Rossum38fff8c2006-03-07 18:50:55 +00004641
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00004642static PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00004643slot_nb_index(PyObject *self)
4644{
Guido van Rossum38fff8c2006-03-07 18:50:55 +00004645 static PyObject *index_str;
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00004646 return call_method(self, "__index__", &index_str, "()");
Guido van Rossum38fff8c2006-03-07 18:50:55 +00004647}
4648
4649
Guido van Rossumdc91b992001-08-08 22:26:22 +00004650SLOT0(slot_nb_invert, "__invert__")
4651SLOT1BIN(slot_nb_lshift, nb_lshift, "__lshift__", "__rlshift__")
4652SLOT1BIN(slot_nb_rshift, nb_rshift, "__rshift__", "__rrshift__")
4653SLOT1BIN(slot_nb_and, nb_and, "__and__", "__rand__")
4654SLOT1BIN(slot_nb_xor, nb_xor, "__xor__", "__rxor__")
4655SLOT1BIN(slot_nb_or, nb_or, "__or__", "__ror__")
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004656
4657static int
4658slot_nb_coerce(PyObject **a, PyObject **b)
4659{
4660 static PyObject *coerce_str;
4661 PyObject *self = *a, *other = *b;
4662
4663 if (self->ob_type->tp_as_number != NULL &&
4664 self->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
4665 PyObject *r;
4666 r = call_maybe(
4667 self, "__coerce__", &coerce_str, "(O)", other);
4668 if (r == NULL)
4669 return -1;
4670 if (r == Py_NotImplemented) {
4671 Py_DECREF(r);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004672 }
Guido van Rossum55f20992001-10-01 17:18:22 +00004673 else {
4674 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
4675 PyErr_SetString(PyExc_TypeError,
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004676 "__coerce__ didn't return a 2-tuple");
Guido van Rossum55f20992001-10-01 17:18:22 +00004677 Py_DECREF(r);
4678 return -1;
4679 }
4680 *a = PyTuple_GET_ITEM(r, 0);
4681 Py_INCREF(*a);
4682 *b = PyTuple_GET_ITEM(r, 1);
4683 Py_INCREF(*b);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004684 Py_DECREF(r);
Guido van Rossum55f20992001-10-01 17:18:22 +00004685 return 0;
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004686 }
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004687 }
4688 if (other->ob_type->tp_as_number != NULL &&
4689 other->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
4690 PyObject *r;
4691 r = call_maybe(
4692 other, "__coerce__", &coerce_str, "(O)", self);
4693 if (r == NULL)
4694 return -1;
4695 if (r == Py_NotImplemented) {
4696 Py_DECREF(r);
4697 return 1;
4698 }
4699 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
4700 PyErr_SetString(PyExc_TypeError,
4701 "__coerce__ didn't return a 2-tuple");
4702 Py_DECREF(r);
4703 return -1;
4704 }
4705 *a = PyTuple_GET_ITEM(r, 1);
4706 Py_INCREF(*a);
4707 *b = PyTuple_GET_ITEM(r, 0);
4708 Py_INCREF(*b);
4709 Py_DECREF(r);
4710 return 0;
4711 }
4712 return 1;
4713}
4714
Guido van Rossumdc91b992001-08-08 22:26:22 +00004715SLOT0(slot_nb_int, "__int__")
4716SLOT0(slot_nb_long, "__long__")
4717SLOT0(slot_nb_float, "__float__")
4718SLOT0(slot_nb_oct, "__oct__")
4719SLOT0(slot_nb_hex, "__hex__")
4720SLOT1(slot_nb_inplace_add, "__iadd__", PyObject *, "O")
4721SLOT1(slot_nb_inplace_subtract, "__isub__", PyObject *, "O")
4722SLOT1(slot_nb_inplace_multiply, "__imul__", PyObject *, "O")
4723SLOT1(slot_nb_inplace_divide, "__idiv__", PyObject *, "O")
4724SLOT1(slot_nb_inplace_remainder, "__imod__", PyObject *, "O")
Martin v. Löwisfd963262007-02-09 12:19:32 +00004725/* Can't use SLOT1 here, because nb_inplace_power is ternary */
4726static PyObject *
4727slot_nb_inplace_power(PyObject *self, PyObject * arg1, PyObject *arg2)
4728{
4729 static PyObject *cache_str;
4730 return call_method(self, "__ipow__", &cache_str, "(" "O" ")", arg1);
4731}
Guido van Rossumdc91b992001-08-08 22:26:22 +00004732SLOT1(slot_nb_inplace_lshift, "__ilshift__", PyObject *, "O")
4733SLOT1(slot_nb_inplace_rshift, "__irshift__", PyObject *, "O")
4734SLOT1(slot_nb_inplace_and, "__iand__", PyObject *, "O")
4735SLOT1(slot_nb_inplace_xor, "__ixor__", PyObject *, "O")
4736SLOT1(slot_nb_inplace_or, "__ior__", PyObject *, "O")
4737SLOT1BIN(slot_nb_floor_divide, nb_floor_divide,
4738 "__floordiv__", "__rfloordiv__")
4739SLOT1BIN(slot_nb_true_divide, nb_true_divide, "__truediv__", "__rtruediv__")
4740SLOT1(slot_nb_inplace_floor_divide, "__ifloordiv__", PyObject *, "O")
4741SLOT1(slot_nb_inplace_true_divide, "__itruediv__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004742
4743static int
Guido van Rossumb8f63662001-08-15 23:57:02 +00004744half_compare(PyObject *self, PyObject *other)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004745{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004746 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004747 static PyObject *cmp_str;
Martin v. Löwis18e16552006-02-15 17:27:45 +00004748 Py_ssize_t c;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004749
Guido van Rossum60718732001-08-28 17:47:51 +00004750 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004751 if (func == NULL) {
4752 PyErr_Clear();
4753 }
4754 else {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004755 args = PyTuple_Pack(1, other);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004756 if (args == NULL)
4757 res = NULL;
4758 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004759 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004760 Py_DECREF(args);
4761 }
Raymond Hettingerab5dae32002-06-24 13:08:16 +00004762 Py_DECREF(func);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004763 if (res != Py_NotImplemented) {
4764 if (res == NULL)
4765 return -2;
4766 c = PyInt_AsLong(res);
4767 Py_DECREF(res);
4768 if (c == -1 && PyErr_Occurred())
4769 return -2;
4770 return (c < 0) ? -1 : (c > 0) ? 1 : 0;
4771 }
4772 Py_DECREF(res);
4773 }
4774 return 2;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004775}
4776
Guido van Rossumab3b0342001-09-18 20:38:53 +00004777/* This slot is published for the benefit of try_3way_compare in object.c */
4778int
4779_PyObject_SlotCompare(PyObject *self, PyObject *other)
Guido van Rossumb8f63662001-08-15 23:57:02 +00004780{
4781 int c;
4782
Christian Heimese93237d2007-12-19 02:37:44 +00004783 if (Py_TYPE(self)->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00004784 c = half_compare(self, other);
4785 if (c <= 1)
4786 return c;
4787 }
Christian Heimese93237d2007-12-19 02:37:44 +00004788 if (Py_TYPE(other)->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00004789 c = half_compare(other, self);
4790 if (c < -1)
4791 return -2;
4792 if (c <= 1)
4793 return -c;
4794 }
4795 return (void *)self < (void *)other ? -1 :
4796 (void *)self > (void *)other ? 1 : 0;
4797}
4798
4799static PyObject *
4800slot_tp_repr(PyObject *self)
4801{
4802 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004803 static PyObject *repr_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004804
Guido van Rossum60718732001-08-28 17:47:51 +00004805 func = lookup_method(self, "__repr__", &repr_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004806 if (func != NULL) {
4807 res = PyEval_CallObject(func, NULL);
4808 Py_DECREF(func);
4809 return res;
4810 }
Barry Warsaw7ce36942001-08-24 18:34:26 +00004811 PyErr_Clear();
4812 return PyString_FromFormat("<%s object at %p>",
Christian Heimese93237d2007-12-19 02:37:44 +00004813 Py_TYPE(self)->tp_name, self);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004814}
4815
4816static PyObject *
4817slot_tp_str(PyObject *self)
4818{
4819 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004820 static PyObject *str_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004821
Guido van Rossum60718732001-08-28 17:47:51 +00004822 func = lookup_method(self, "__str__", &str_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004823 if (func != NULL) {
4824 res = PyEval_CallObject(func, NULL);
4825 Py_DECREF(func);
4826 return res;
4827 }
4828 else {
4829 PyErr_Clear();
4830 return slot_tp_repr(self);
4831 }
4832}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004833
4834static long
4835slot_tp_hash(PyObject *self)
4836{
Tim Peters61ce0a92002-12-06 23:38:02 +00004837 PyObject *func;
Guido van Rossum60718732001-08-28 17:47:51 +00004838 static PyObject *hash_str, *eq_str, *cmp_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004839 long h;
4840
Guido van Rossum60718732001-08-28 17:47:51 +00004841 func = lookup_method(self, "__hash__", &hash_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004842
Guido van Rossum0b7b6fd2007-12-19 22:51:13 +00004843 if (func != NULL && func != Py_None) {
Tim Peters61ce0a92002-12-06 23:38:02 +00004844 PyObject *res = PyEval_CallObject(func, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004845 Py_DECREF(func);
4846 if (res == NULL)
4847 return -1;
Martin v. Löwisab2f8f72006-08-09 07:57:39 +00004848 if (PyLong_Check(res))
Armin Rigo51fc8c42006-08-09 14:55:26 +00004849 h = PyLong_Type.tp_hash(res);
Martin v. Löwisab2f8f72006-08-09 07:57:39 +00004850 else
4851 h = PyInt_AsLong(res);
Tim Peters61ce0a92002-12-06 23:38:02 +00004852 Py_DECREF(res);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004853 }
4854 else {
Georg Brandl30b78042007-12-20 21:03:02 +00004855 Py_XDECREF(func); /* may be None */
Guido van Rossumb8f63662001-08-15 23:57:02 +00004856 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004857 func = lookup_method(self, "__eq__", &eq_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004858 if (func == NULL) {
4859 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004860 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004861 }
4862 if (func != NULL) {
Georg Brandlccff7852006-06-18 22:17:29 +00004863 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
4864 self->ob_type->tp_name);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004865 Py_DECREF(func);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004866 return -1;
4867 }
4868 PyErr_Clear();
4869 h = _Py_HashPointer((void *)self);
4870 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004871 if (h == -1 && !PyErr_Occurred())
4872 h = -2;
4873 return h;
4874}
4875
4876static PyObject *
4877slot_tp_call(PyObject *self, PyObject *args, PyObject *kwds)
4878{
Guido van Rossum60718732001-08-28 17:47:51 +00004879 static PyObject *call_str;
4880 PyObject *meth = lookup_method(self, "__call__", &call_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004881 PyObject *res;
4882
4883 if (meth == NULL)
4884 return NULL;
Armin Rigo53c1692f2006-06-21 21:58:50 +00004885
Tim Peters6d6c1a32001-08-02 04:15:00 +00004886 res = PyObject_Call(meth, args, kwds);
Armin Rigo53c1692f2006-06-21 21:58:50 +00004887
Tim Peters6d6c1a32001-08-02 04:15:00 +00004888 Py_DECREF(meth);
4889 return res;
4890}
4891
Guido van Rossum14a6f832001-10-17 13:59:09 +00004892/* There are two slot dispatch functions for tp_getattro.
4893
4894 - slot_tp_getattro() is used when __getattribute__ is overridden
4895 but no __getattr__ hook is present;
4896
4897 - slot_tp_getattr_hook() is used when a __getattr__ hook is present.
4898
Guido van Rossumc334df52002-04-04 23:44:47 +00004899 The code in update_one_slot() always installs slot_tp_getattr_hook(); this
4900 detects the absence of __getattr__ and then installs the simpler slot if
4901 necessary. */
Guido van Rossum14a6f832001-10-17 13:59:09 +00004902
Tim Peters6d6c1a32001-08-02 04:15:00 +00004903static PyObject *
4904slot_tp_getattro(PyObject *self, PyObject *name)
4905{
Guido van Rossum14a6f832001-10-17 13:59:09 +00004906 static PyObject *getattribute_str = NULL;
4907 return call_method(self, "__getattribute__", &getattribute_str,
4908 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004909}
4910
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004911static PyObject *
4912slot_tp_getattr_hook(PyObject *self, PyObject *name)
4913{
Christian Heimese93237d2007-12-19 02:37:44 +00004914 PyTypeObject *tp = Py_TYPE(self);
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004915 PyObject *getattr, *getattribute, *res;
4916 static PyObject *getattribute_str = NULL;
4917 static PyObject *getattr_str = NULL;
4918
4919 if (getattr_str == NULL) {
4920 getattr_str = PyString_InternFromString("__getattr__");
4921 if (getattr_str == NULL)
4922 return NULL;
4923 }
4924 if (getattribute_str == NULL) {
4925 getattribute_str =
4926 PyString_InternFromString("__getattribute__");
4927 if (getattribute_str == NULL)
4928 return NULL;
4929 }
4930 getattr = _PyType_Lookup(tp, getattr_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004931 if (getattr == NULL) {
Guido van Rossumd396b9c2001-10-13 20:02:41 +00004932 /* No __getattr__ hook: use a simpler dispatcher */
4933 tp->tp_getattro = slot_tp_getattro;
4934 return slot_tp_getattro(self, name);
4935 }
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004936 getattribute = _PyType_Lookup(tp, getattribute_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004937 if (getattribute == NULL ||
Christian Heimese93237d2007-12-19 02:37:44 +00004938 (Py_TYPE(getattribute) == &PyWrapperDescr_Type &&
Guido van Rossum14a6f832001-10-17 13:59:09 +00004939 ((PyWrapperDescrObject *)getattribute)->d_wrapped ==
4940 (void *)PyObject_GenericGetAttr))
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004941 res = PyObject_GenericGetAttr(self, name);
4942 else
Georg Brandl684fd0c2006-05-25 19:15:31 +00004943 res = PyObject_CallFunctionObjArgs(getattribute, self, name, NULL);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004944 if (res == NULL && PyErr_ExceptionMatches(PyExc_AttributeError)) {
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004945 PyErr_Clear();
Georg Brandl684fd0c2006-05-25 19:15:31 +00004946 res = PyObject_CallFunctionObjArgs(getattr, self, name, NULL);
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004947 }
4948 return res;
4949}
4950
Tim Peters6d6c1a32001-08-02 04:15:00 +00004951static int
4952slot_tp_setattro(PyObject *self, PyObject *name, PyObject *value)
4953{
4954 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004955 static PyObject *delattr_str, *setattr_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004956
4957 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004958 res = call_method(self, "__delattr__", &delattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004959 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004960 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004961 res = call_method(self, "__setattr__", &setattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004962 "(OO)", name, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004963 if (res == NULL)
4964 return -1;
4965 Py_DECREF(res);
4966 return 0;
4967}
4968
Guido van Rossum0b7b6fd2007-12-19 22:51:13 +00004969static char *name_op[] = {
4970 "__lt__",
4971 "__le__",
4972 "__eq__",
4973 "__ne__",
4974 "__gt__",
4975 "__ge__",
4976};
4977
Tim Peters6d6c1a32001-08-02 04:15:00 +00004978static PyObject *
Guido van Rossumb8f63662001-08-15 23:57:02 +00004979half_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004980{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004981 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004982 static PyObject *op_str[6];
Tim Peters6d6c1a32001-08-02 04:15:00 +00004983
Guido van Rossum60718732001-08-28 17:47:51 +00004984 func = lookup_method(self, name_op[op], &op_str[op]);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004985 if (func == NULL) {
4986 PyErr_Clear();
4987 Py_INCREF(Py_NotImplemented);
4988 return Py_NotImplemented;
4989 }
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004990 args = PyTuple_Pack(1, other);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004991 if (args == NULL)
4992 res = NULL;
4993 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004994 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004995 Py_DECREF(args);
4996 }
4997 Py_DECREF(func);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004998 return res;
4999}
5000
Guido van Rossumb8f63662001-08-15 23:57:02 +00005001static PyObject *
5002slot_tp_richcompare(PyObject *self, PyObject *other, int op)
5003{
5004 PyObject *res;
5005
Christian Heimese93237d2007-12-19 02:37:44 +00005006 if (Py_TYPE(self)->tp_richcompare == slot_tp_richcompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00005007 res = half_richcompare(self, other, op);
5008 if (res != Py_NotImplemented)
5009 return res;
5010 Py_DECREF(res);
5011 }
Christian Heimese93237d2007-12-19 02:37:44 +00005012 if (Py_TYPE(other)->tp_richcompare == slot_tp_richcompare) {
Tim Petersf4aca752004-09-23 02:39:37 +00005013 res = half_richcompare(other, self, _Py_SwappedOp[op]);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005014 if (res != Py_NotImplemented) {
5015 return res;
5016 }
5017 Py_DECREF(res);
5018 }
5019 Py_INCREF(Py_NotImplemented);
5020 return Py_NotImplemented;
5021}
5022
5023static PyObject *
5024slot_tp_iter(PyObject *self)
5025{
5026 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00005027 static PyObject *iter_str, *getitem_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00005028
Guido van Rossum60718732001-08-28 17:47:51 +00005029 func = lookup_method(self, "__iter__", &iter_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005030 if (func != NULL) {
Guido van Rossum84b2bed2002-08-16 17:01:09 +00005031 PyObject *args;
5032 args = res = PyTuple_New(0);
5033 if (args != NULL) {
5034 res = PyObject_Call(func, args, NULL);
5035 Py_DECREF(args);
5036 }
5037 Py_DECREF(func);
5038 return res;
Guido van Rossumb8f63662001-08-15 23:57:02 +00005039 }
5040 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00005041 func = lookup_method(self, "__getitem__", &getitem_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005042 if (func == NULL) {
Georg Brandlccff7852006-06-18 22:17:29 +00005043 PyErr_Format(PyExc_TypeError,
5044 "'%.200s' object is not iterable",
Christian Heimese93237d2007-12-19 02:37:44 +00005045 Py_TYPE(self)->tp_name);
Guido van Rossumb8f63662001-08-15 23:57:02 +00005046 return NULL;
5047 }
5048 Py_DECREF(func);
5049 return PySeqIter_New(self);
5050}
Tim Peters6d6c1a32001-08-02 04:15:00 +00005051
5052static PyObject *
5053slot_tp_iternext(PyObject *self)
5054{
Guido van Rossum2730b132001-08-28 18:22:14 +00005055 static PyObject *next_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00005056 return call_method(self, "next", &next_str, "()");
Tim Peters6d6c1a32001-08-02 04:15:00 +00005057}
5058
Guido van Rossum1a493502001-08-17 16:47:50 +00005059static PyObject *
5060slot_tp_descr_get(PyObject *self, PyObject *obj, PyObject *type)
5061{
Christian Heimese93237d2007-12-19 02:37:44 +00005062 PyTypeObject *tp = Py_TYPE(self);
Guido van Rossum1a493502001-08-17 16:47:50 +00005063 PyObject *get;
5064 static PyObject *get_str = NULL;
5065
5066 if (get_str == NULL) {
5067 get_str = PyString_InternFromString("__get__");
5068 if (get_str == NULL)
5069 return NULL;
5070 }
5071 get = _PyType_Lookup(tp, get_str);
5072 if (get == NULL) {
5073 /* Avoid further slowdowns */
5074 if (tp->tp_descr_get == slot_tp_descr_get)
5075 tp->tp_descr_get = NULL;
5076 Py_INCREF(self);
5077 return self;
5078 }
Guido van Rossum2c252392001-08-24 10:13:31 +00005079 if (obj == NULL)
5080 obj = Py_None;
5081 if (type == NULL)
5082 type = Py_None;
Georg Brandl684fd0c2006-05-25 19:15:31 +00005083 return PyObject_CallFunctionObjArgs(get, self, obj, type, NULL);
Guido van Rossum1a493502001-08-17 16:47:50 +00005084}
Tim Peters6d6c1a32001-08-02 04:15:00 +00005085
5086static int
5087slot_tp_descr_set(PyObject *self, PyObject *target, PyObject *value)
5088{
Guido van Rossum2c252392001-08-24 10:13:31 +00005089 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00005090 static PyObject *del_str, *set_str;
Guido van Rossum2c252392001-08-24 10:13:31 +00005091
5092 if (value == NULL)
Guido van Rossum1d5b3f22001-12-03 00:08:33 +00005093 res = call_method(self, "__delete__", &del_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00005094 "(O)", target);
Guido van Rossum2c252392001-08-24 10:13:31 +00005095 else
Guido van Rossum2730b132001-08-28 18:22:14 +00005096 res = call_method(self, "__set__", &set_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00005097 "(OO)", target, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005098 if (res == NULL)
5099 return -1;
5100 Py_DECREF(res);
5101 return 0;
5102}
5103
5104static int
5105slot_tp_init(PyObject *self, PyObject *args, PyObject *kwds)
5106{
Guido van Rossum60718732001-08-28 17:47:51 +00005107 static PyObject *init_str;
5108 PyObject *meth = lookup_method(self, "__init__", &init_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005109 PyObject *res;
5110
5111 if (meth == NULL)
5112 return -1;
5113 res = PyObject_Call(meth, args, kwds);
5114 Py_DECREF(meth);
5115 if (res == NULL)
5116 return -1;
Raymond Hettingerb67cc802005-03-03 16:45:19 +00005117 if (res != Py_None) {
Georg Brandlccff7852006-06-18 22:17:29 +00005118 PyErr_Format(PyExc_TypeError,
5119 "__init__() should return None, not '%.200s'",
Christian Heimese93237d2007-12-19 02:37:44 +00005120 Py_TYPE(res)->tp_name);
Raymond Hettingerb67cc802005-03-03 16:45:19 +00005121 Py_DECREF(res);
5122 return -1;
5123 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00005124 Py_DECREF(res);
5125 return 0;
5126}
5127
5128static PyObject *
5129slot_tp_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
5130{
Guido van Rossum7bed2132002-08-08 21:57:53 +00005131 static PyObject *new_str;
5132 PyObject *func;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005133 PyObject *newargs, *x;
Martin v. Löwis18e16552006-02-15 17:27:45 +00005134 Py_ssize_t i, n;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005135
Guido van Rossum7bed2132002-08-08 21:57:53 +00005136 if (new_str == NULL) {
5137 new_str = PyString_InternFromString("__new__");
5138 if (new_str == NULL)
5139 return NULL;
5140 }
5141 func = PyObject_GetAttr((PyObject *)type, new_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005142 if (func == NULL)
5143 return NULL;
5144 assert(PyTuple_Check(args));
5145 n = PyTuple_GET_SIZE(args);
5146 newargs = PyTuple_New(n+1);
5147 if (newargs == NULL)
5148 return NULL;
5149 Py_INCREF(type);
5150 PyTuple_SET_ITEM(newargs, 0, (PyObject *)type);
5151 for (i = 0; i < n; i++) {
5152 x = PyTuple_GET_ITEM(args, i);
5153 Py_INCREF(x);
5154 PyTuple_SET_ITEM(newargs, i+1, x);
5155 }
5156 x = PyObject_Call(func, newargs, kwds);
Guido van Rossum25d18072001-10-01 15:55:28 +00005157 Py_DECREF(newargs);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005158 Py_DECREF(func);
5159 return x;
5160}
5161
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005162static void
5163slot_tp_del(PyObject *self)
5164{
5165 static PyObject *del_str = NULL;
5166 PyObject *del, *res;
5167 PyObject *error_type, *error_value, *error_traceback;
5168
5169 /* Temporarily resurrect the object. */
5170 assert(self->ob_refcnt == 0);
5171 self->ob_refcnt = 1;
5172
5173 /* Save the current exception, if any. */
5174 PyErr_Fetch(&error_type, &error_value, &error_traceback);
5175
5176 /* Execute __del__ method, if any. */
5177 del = lookup_maybe(self, "__del__", &del_str);
5178 if (del != NULL) {
5179 res = PyEval_CallObject(del, NULL);
5180 if (res == NULL)
5181 PyErr_WriteUnraisable(del);
5182 else
5183 Py_DECREF(res);
5184 Py_DECREF(del);
5185 }
5186
5187 /* Restore the saved exception. */
5188 PyErr_Restore(error_type, error_value, error_traceback);
5189
5190 /* Undo the temporary resurrection; can't use DECREF here, it would
5191 * cause a recursive call.
5192 */
5193 assert(self->ob_refcnt > 0);
5194 if (--self->ob_refcnt == 0)
5195 return; /* this is the normal path out */
5196
5197 /* __del__ resurrected it! Make it look like the original Py_DECREF
5198 * never happened.
5199 */
5200 {
Martin v. Löwis725507b2006-03-07 12:08:51 +00005201 Py_ssize_t refcnt = self->ob_refcnt;
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005202 _Py_NewReference(self);
5203 self->ob_refcnt = refcnt;
5204 }
Christian Heimese93237d2007-12-19 02:37:44 +00005205 assert(!PyType_IS_GC(Py_TYPE(self)) ||
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005206 _Py_AS_GC(self)->gc.gc_refs != _PyGC_REFS_UNTRACKED);
Michael W. Hudson3f3b6682004-08-03 10:21:03 +00005207 /* If Py_REF_DEBUG, _Py_NewReference bumped _Py_RefTotal, so
5208 * we need to undo that. */
5209 _Py_DEC_REFTOTAL;
5210 /* If Py_TRACE_REFS, _Py_NewReference re-added self to the object
5211 * chain, so no more to do there.
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005212 * If COUNT_ALLOCS, the original decref bumped tp_frees, and
5213 * _Py_NewReference bumped tp_allocs: both of those need to be
5214 * undone.
5215 */
5216#ifdef COUNT_ALLOCS
Christian Heimese93237d2007-12-19 02:37:44 +00005217 --Py_TYPE(self)->tp_frees;
5218 --Py_TYPE(self)->tp_allocs;
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005219#endif
5220}
5221
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005222
5223/* Table mapping __foo__ names to tp_foo offsets and slot_tp_foo wrapper
Tim Petersbf9b2442003-03-23 05:35:36 +00005224 functions. The offsets here are relative to the 'PyHeapTypeObject'
Guido van Rossume5c691a2003-03-07 15:13:17 +00005225 structure, which incorporates the additional structures used for numbers,
5226 sequences and mappings.
5227 Note that multiple names may map to the same slot (e.g. __eq__,
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005228 __ne__ etc. all map to tp_richcompare) and one name may map to multiple
Guido van Rossumc334df52002-04-04 23:44:47 +00005229 slots (e.g. __str__ affects tp_str as well as tp_repr). The table is
5230 terminated with an all-zero entry. (This table is further initialized and
5231 sorted in init_slotdefs() below.) */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005232
Guido van Rossum6d204072001-10-21 00:44:31 +00005233typedef struct wrapperbase slotdef;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005234
5235#undef TPSLOT
Guido van Rossumc8e56452001-10-22 00:43:43 +00005236#undef FLSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005237#undef ETSLOT
5238#undef SQSLOT
5239#undef MPSLOT
5240#undef NBSLOT
Guido van Rossum6d204072001-10-21 00:44:31 +00005241#undef UNSLOT
5242#undef IBSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005243#undef BINSLOT
5244#undef RBINSLOT
5245
Guido van Rossum6d204072001-10-21 00:44:31 +00005246#define TPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Neal Norwitzd47714a2002-08-13 19:01:38 +00005247 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
5248 PyDoc_STR(DOC)}
Guido van Rossumc8e56452001-10-22 00:43:43 +00005249#define FLSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC, FLAGS) \
5250 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00005251 PyDoc_STR(DOC), FLAGS}
Guido van Rossum6d204072001-10-21 00:44:31 +00005252#define ETSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Guido van Rossume5c691a2003-03-07 15:13:17 +00005253 {NAME, offsetof(PyHeapTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00005254 PyDoc_STR(DOC)}
Guido van Rossum6d204072001-10-21 00:44:31 +00005255#define SQSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
5256 ETSLOT(NAME, as_sequence.SLOT, FUNCTION, WRAPPER, DOC)
5257#define MPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
5258 ETSLOT(NAME, as_mapping.SLOT, FUNCTION, WRAPPER, DOC)
5259#define NBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
5260 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, DOC)
5261#define UNSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
5262 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
5263 "x." NAME "() <==> " DOC)
5264#define IBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
5265 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
5266 "x." NAME "(y) <==> x" DOC "y")
5267#define BINSLOT(NAME, SLOT, FUNCTION, DOC) \
5268 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_l, \
5269 "x." NAME "(y) <==> x" DOC "y")
5270#define RBINSLOT(NAME, SLOT, FUNCTION, DOC) \
5271 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_r, \
5272 "x." NAME "(y) <==> y" DOC "x")
Anthony Baxter56616992005-06-03 14:12:21 +00005273#define BINSLOTNOTINFIX(NAME, SLOT, FUNCTION, DOC) \
5274 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_l, \
5275 "x." NAME "(y) <==> " DOC)
5276#define RBINSLOTNOTINFIX(NAME, SLOT, FUNCTION, DOC) \
5277 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_r, \
5278 "x." NAME "(y) <==> " DOC)
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005279
5280static slotdef slotdefs[] = {
Martin v. Löwis18e16552006-02-15 17:27:45 +00005281 SQSLOT("__len__", sq_length, slot_sq_length, wrap_lenfunc,
Guido van Rossum6d204072001-10-21 00:44:31 +00005282 "x.__len__() <==> len(x)"),
Armin Rigofd163f92005-12-29 15:59:19 +00005283 /* Heap types defining __add__/__mul__ have sq_concat/sq_repeat == NULL.
5284 The logic in abstract.c always falls back to nb_add/nb_multiply in
5285 this case. Defining both the nb_* and the sq_* slots to call the
5286 user-defined methods has unexpected side-effects, as shown by
5287 test_descr.notimplemented() */
5288 SQSLOT("__add__", sq_concat, NULL, wrap_binaryfunc,
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005289 "x.__add__(y) <==> x+y"),
Armin Rigo314861c2006-03-30 14:04:02 +00005290 SQSLOT("__mul__", sq_repeat, NULL, wrap_indexargfunc,
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005291 "x.__mul__(n) <==> x*n"),
Armin Rigo314861c2006-03-30 14:04:02 +00005292 SQSLOT("__rmul__", sq_repeat, NULL, wrap_indexargfunc,
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005293 "x.__rmul__(n) <==> n*x"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005294 SQSLOT("__getitem__", sq_item, slot_sq_item, wrap_sq_item,
5295 "x.__getitem__(y) <==> x[y]"),
Martin v. Löwis18e16552006-02-15 17:27:45 +00005296 SQSLOT("__getslice__", sq_slice, slot_sq_slice, wrap_ssizessizeargfunc,
Brett Cannon154da9b2003-05-20 02:30:04 +00005297 "x.__getslice__(i, j) <==> x[i:j]\n\
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005298 \n\
5299 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00005300 SQSLOT("__setitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_setitem,
Brett Cannonbe67d872003-05-20 02:40:12 +00005301 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005302 SQSLOT("__delitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_delitem,
Brett Cannonbe67d872003-05-20 02:40:12 +00005303 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005304 SQSLOT("__setslice__", sq_ass_slice, slot_sq_ass_slice,
Martin v. Löwis18e16552006-02-15 17:27:45 +00005305 wrap_ssizessizeobjargproc,
Brett Cannonbe67d872003-05-20 02:40:12 +00005306 "x.__setslice__(i, j, y) <==> x[i:j]=y\n\
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005307 \n\
5308 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00005309 SQSLOT("__delslice__", sq_ass_slice, slot_sq_ass_slice, wrap_delslice,
Brett Cannonbe67d872003-05-20 02:40:12 +00005310 "x.__delslice__(i, j) <==> del x[i:j]\n\
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005311 \n\
5312 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00005313 SQSLOT("__contains__", sq_contains, slot_sq_contains, wrap_objobjproc,
5314 "x.__contains__(y) <==> y in x"),
Armin Rigofd163f92005-12-29 15:59:19 +00005315 SQSLOT("__iadd__", sq_inplace_concat, NULL,
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005316 wrap_binaryfunc, "x.__iadd__(y) <==> x+=y"),
Armin Rigofd163f92005-12-29 15:59:19 +00005317 SQSLOT("__imul__", sq_inplace_repeat, NULL,
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005318 wrap_indexargfunc, "x.__imul__(y) <==> x*=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005319
Martin v. Löwis18e16552006-02-15 17:27:45 +00005320 MPSLOT("__len__", mp_length, slot_mp_length, wrap_lenfunc,
Guido van Rossum6d204072001-10-21 00:44:31 +00005321 "x.__len__() <==> len(x)"),
Guido van Rossumfd38f8e2001-10-09 20:17:57 +00005322 MPSLOT("__getitem__", mp_subscript, slot_mp_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00005323 wrap_binaryfunc,
5324 "x.__getitem__(y) <==> x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005325 MPSLOT("__setitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00005326 wrap_objobjargproc,
5327 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005328 MPSLOT("__delitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00005329 wrap_delitem,
5330 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005331
Guido van Rossum6d204072001-10-21 00:44:31 +00005332 BINSLOT("__add__", nb_add, slot_nb_add,
5333 "+"),
5334 RBINSLOT("__radd__", nb_add, slot_nb_add,
5335 "+"),
5336 BINSLOT("__sub__", nb_subtract, slot_nb_subtract,
5337 "-"),
5338 RBINSLOT("__rsub__", nb_subtract, slot_nb_subtract,
5339 "-"),
5340 BINSLOT("__mul__", nb_multiply, slot_nb_multiply,
5341 "*"),
5342 RBINSLOT("__rmul__", nb_multiply, slot_nb_multiply,
5343 "*"),
5344 BINSLOT("__div__", nb_divide, slot_nb_divide,
5345 "/"),
5346 RBINSLOT("__rdiv__", nb_divide, slot_nb_divide,
5347 "/"),
5348 BINSLOT("__mod__", nb_remainder, slot_nb_remainder,
5349 "%"),
5350 RBINSLOT("__rmod__", nb_remainder, slot_nb_remainder,
5351 "%"),
Anthony Baxter56616992005-06-03 14:12:21 +00005352 BINSLOTNOTINFIX("__divmod__", nb_divmod, slot_nb_divmod,
Guido van Rossum6d204072001-10-21 00:44:31 +00005353 "divmod(x, y)"),
Anthony Baxter56616992005-06-03 14:12:21 +00005354 RBINSLOTNOTINFIX("__rdivmod__", nb_divmod, slot_nb_divmod,
Guido van Rossum6d204072001-10-21 00:44:31 +00005355 "divmod(y, x)"),
5356 NBSLOT("__pow__", nb_power, slot_nb_power, wrap_ternaryfunc,
5357 "x.__pow__(y[, z]) <==> pow(x, y[, z])"),
5358 NBSLOT("__rpow__", nb_power, slot_nb_power, wrap_ternaryfunc_r,
5359 "y.__rpow__(x[, z]) <==> pow(x, y[, z])"),
5360 UNSLOT("__neg__", nb_negative, slot_nb_negative, wrap_unaryfunc, "-x"),
5361 UNSLOT("__pos__", nb_positive, slot_nb_positive, wrap_unaryfunc, "+x"),
5362 UNSLOT("__abs__", nb_absolute, slot_nb_absolute, wrap_unaryfunc,
5363 "abs(x)"),
Raymond Hettingerf34f2642003-10-11 17:29:04 +00005364 UNSLOT("__nonzero__", nb_nonzero, slot_nb_nonzero, wrap_inquirypred,
Guido van Rossum6d204072001-10-21 00:44:31 +00005365 "x != 0"),
5366 UNSLOT("__invert__", nb_invert, slot_nb_invert, wrap_unaryfunc, "~x"),
5367 BINSLOT("__lshift__", nb_lshift, slot_nb_lshift, "<<"),
5368 RBINSLOT("__rlshift__", nb_lshift, slot_nb_lshift, "<<"),
5369 BINSLOT("__rshift__", nb_rshift, slot_nb_rshift, ">>"),
5370 RBINSLOT("__rrshift__", nb_rshift, slot_nb_rshift, ">>"),
5371 BINSLOT("__and__", nb_and, slot_nb_and, "&"),
5372 RBINSLOT("__rand__", nb_and, slot_nb_and, "&"),
5373 BINSLOT("__xor__", nb_xor, slot_nb_xor, "^"),
5374 RBINSLOT("__rxor__", nb_xor, slot_nb_xor, "^"),
5375 BINSLOT("__or__", nb_or, slot_nb_or, "|"),
5376 RBINSLOT("__ror__", nb_or, slot_nb_or, "|"),
5377 NBSLOT("__coerce__", nb_coerce, slot_nb_coerce, wrap_coercefunc,
5378 "x.__coerce__(y) <==> coerce(x, y)"),
5379 UNSLOT("__int__", nb_int, slot_nb_int, wrap_unaryfunc,
5380 "int(x)"),
5381 UNSLOT("__long__", nb_long, slot_nb_long, wrap_unaryfunc,
5382 "long(x)"),
5383 UNSLOT("__float__", nb_float, slot_nb_float, wrap_unaryfunc,
5384 "float(x)"),
5385 UNSLOT("__oct__", nb_oct, slot_nb_oct, wrap_unaryfunc,
5386 "oct(x)"),
5387 UNSLOT("__hex__", nb_hex, slot_nb_hex, wrap_unaryfunc,
5388 "hex(x)"),
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00005389 NBSLOT("__index__", nb_index, slot_nb_index, wrap_unaryfunc,
Guido van Rossum38fff8c2006-03-07 18:50:55 +00005390 "x[y:z] <==> x[y.__index__():z.__index__()]"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005391 IBSLOT("__iadd__", nb_inplace_add, slot_nb_inplace_add,
5392 wrap_binaryfunc, "+"),
5393 IBSLOT("__isub__", nb_inplace_subtract, slot_nb_inplace_subtract,
5394 wrap_binaryfunc, "-"),
5395 IBSLOT("__imul__", nb_inplace_multiply, slot_nb_inplace_multiply,
5396 wrap_binaryfunc, "*"),
5397 IBSLOT("__idiv__", nb_inplace_divide, slot_nb_inplace_divide,
5398 wrap_binaryfunc, "/"),
5399 IBSLOT("__imod__", nb_inplace_remainder, slot_nb_inplace_remainder,
5400 wrap_binaryfunc, "%"),
5401 IBSLOT("__ipow__", nb_inplace_power, slot_nb_inplace_power,
Guido van Rossum6e5680f2002-10-15 01:01:53 +00005402 wrap_binaryfunc, "**"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005403 IBSLOT("__ilshift__", nb_inplace_lshift, slot_nb_inplace_lshift,
5404 wrap_binaryfunc, "<<"),
5405 IBSLOT("__irshift__", nb_inplace_rshift, slot_nb_inplace_rshift,
5406 wrap_binaryfunc, ">>"),
5407 IBSLOT("__iand__", nb_inplace_and, slot_nb_inplace_and,
5408 wrap_binaryfunc, "&"),
5409 IBSLOT("__ixor__", nb_inplace_xor, slot_nb_inplace_xor,
5410 wrap_binaryfunc, "^"),
5411 IBSLOT("__ior__", nb_inplace_or, slot_nb_inplace_or,
5412 wrap_binaryfunc, "|"),
5413 BINSLOT("__floordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
5414 RBINSLOT("__rfloordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
5415 BINSLOT("__truediv__", nb_true_divide, slot_nb_true_divide, "/"),
5416 RBINSLOT("__rtruediv__", nb_true_divide, slot_nb_true_divide, "/"),
5417 IBSLOT("__ifloordiv__", nb_inplace_floor_divide,
5418 slot_nb_inplace_floor_divide, wrap_binaryfunc, "//"),
5419 IBSLOT("__itruediv__", nb_inplace_true_divide,
5420 slot_nb_inplace_true_divide, wrap_binaryfunc, "/"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005421
Guido van Rossum6d204072001-10-21 00:44:31 +00005422 TPSLOT("__str__", tp_str, slot_tp_str, wrap_unaryfunc,
5423 "x.__str__() <==> str(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00005424 TPSLOT("__str__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00005425 TPSLOT("__repr__", tp_repr, slot_tp_repr, wrap_unaryfunc,
5426 "x.__repr__() <==> repr(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00005427 TPSLOT("__repr__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00005428 TPSLOT("__cmp__", tp_compare, _PyObject_SlotCompare, wrap_cmpfunc,
5429 "x.__cmp__(y) <==> cmp(x,y)"),
5430 TPSLOT("__hash__", tp_hash, slot_tp_hash, wrap_hashfunc,
5431 "x.__hash__() <==> hash(x)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00005432 FLSLOT("__call__", tp_call, slot_tp_call, (wrapperfunc)wrap_call,
5433 "x.__call__(...) <==> x(...)", PyWrapperFlag_KEYWORDS),
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005434 TPSLOT("__getattribute__", tp_getattro, slot_tp_getattr_hook,
Guido van Rossum6d204072001-10-21 00:44:31 +00005435 wrap_binaryfunc, "x.__getattribute__('name') <==> x.name"),
5436 TPSLOT("__getattribute__", tp_getattr, NULL, NULL, ""),
5437 TPSLOT("__getattr__", tp_getattro, slot_tp_getattr_hook, NULL, ""),
5438 TPSLOT("__getattr__", tp_getattr, NULL, NULL, ""),
5439 TPSLOT("__setattr__", tp_setattro, slot_tp_setattro, wrap_setattr,
5440 "x.__setattr__('name', value) <==> x.name = value"),
5441 TPSLOT("__setattr__", tp_setattr, NULL, NULL, ""),
5442 TPSLOT("__delattr__", tp_setattro, slot_tp_setattro, wrap_delattr,
5443 "x.__delattr__('name') <==> del x.name"),
5444 TPSLOT("__delattr__", tp_setattr, NULL, NULL, ""),
5445 TPSLOT("__lt__", tp_richcompare, slot_tp_richcompare, richcmp_lt,
5446 "x.__lt__(y) <==> x<y"),
5447 TPSLOT("__le__", tp_richcompare, slot_tp_richcompare, richcmp_le,
5448 "x.__le__(y) <==> x<=y"),
5449 TPSLOT("__eq__", tp_richcompare, slot_tp_richcompare, richcmp_eq,
5450 "x.__eq__(y) <==> x==y"),
5451 TPSLOT("__ne__", tp_richcompare, slot_tp_richcompare, richcmp_ne,
5452 "x.__ne__(y) <==> x!=y"),
5453 TPSLOT("__gt__", tp_richcompare, slot_tp_richcompare, richcmp_gt,
5454 "x.__gt__(y) <==> x>y"),
5455 TPSLOT("__ge__", tp_richcompare, slot_tp_richcompare, richcmp_ge,
5456 "x.__ge__(y) <==> x>=y"),
5457 TPSLOT("__iter__", tp_iter, slot_tp_iter, wrap_unaryfunc,
5458 "x.__iter__() <==> iter(x)"),
5459 TPSLOT("next", tp_iternext, slot_tp_iternext, wrap_next,
5460 "x.next() -> the next value, or raise StopIteration"),
5461 TPSLOT("__get__", tp_descr_get, slot_tp_descr_get, wrap_descr_get,
5462 "descr.__get__(obj[, type]) -> value"),
5463 TPSLOT("__set__", tp_descr_set, slot_tp_descr_set, wrap_descr_set,
5464 "descr.__set__(obj, value)"),
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00005465 TPSLOT("__delete__", tp_descr_set, slot_tp_descr_set,
5466 wrap_descr_delete, "descr.__delete__(obj)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00005467 FLSLOT("__init__", tp_init, slot_tp_init, (wrapperfunc)wrap_init,
Guido van Rossum6d204072001-10-21 00:44:31 +00005468 "x.__init__(...) initializes x; "
Guido van Rossumc8e56452001-10-22 00:43:43 +00005469 "see x.__class__.__doc__ for signature",
5470 PyWrapperFlag_KEYWORDS),
5471 TPSLOT("__new__", tp_new, slot_tp_new, NULL, ""),
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005472 TPSLOT("__del__", tp_del, slot_tp_del, NULL, ""),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005473 {NULL}
5474};
5475
Guido van Rossumc334df52002-04-04 23:44:47 +00005476/* Given a type pointer and an offset gotten from a slotdef entry, return a
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005477 pointer to the actual slot. This is not quite the same as simply adding
Guido van Rossumc334df52002-04-04 23:44:47 +00005478 the offset to the type pointer, since it takes care to indirect through the
5479 proper indirection pointer (as_buffer, etc.); it returns NULL if the
5480 indirection pointer is NULL. */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005481static void **
Martin v. Löwis18e16552006-02-15 17:27:45 +00005482slotptr(PyTypeObject *type, int ioffset)
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005483{
5484 char *ptr;
Martin v. Löwis18e16552006-02-15 17:27:45 +00005485 long offset = ioffset;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005486
Guido van Rossume5c691a2003-03-07 15:13:17 +00005487 /* Note: this depends on the order of the members of PyHeapTypeObject! */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005488 assert(offset >= 0);
Skip Montanaro429433b2006-04-18 00:35:43 +00005489 assert((size_t)offset < offsetof(PyHeapTypeObject, as_buffer));
5490 if ((size_t)offset >= offsetof(PyHeapTypeObject, as_sequence)) {
Martin v. Löwisee36d652006-04-11 09:08:02 +00005491 ptr = (char *)type->tp_as_sequence;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005492 offset -= offsetof(PyHeapTypeObject, as_sequence);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005493 }
Skip Montanaro429433b2006-04-18 00:35:43 +00005494 else if ((size_t)offset >= offsetof(PyHeapTypeObject, as_mapping)) {
Martin v. Löwisee36d652006-04-11 09:08:02 +00005495 ptr = (char *)type->tp_as_mapping;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005496 offset -= offsetof(PyHeapTypeObject, as_mapping);
Guido van Rossum09638c12002-06-13 19:17:46 +00005497 }
Skip Montanaro429433b2006-04-18 00:35:43 +00005498 else if ((size_t)offset >= offsetof(PyHeapTypeObject, as_number)) {
Martin v. Löwisee36d652006-04-11 09:08:02 +00005499 ptr = (char *)type->tp_as_number;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005500 offset -= offsetof(PyHeapTypeObject, as_number);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005501 }
5502 else {
Martin v. Löwisee36d652006-04-11 09:08:02 +00005503 ptr = (char *)type;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005504 }
5505 if (ptr != NULL)
5506 ptr += offset;
5507 return (void **)ptr;
5508}
Guido van Rossumf040ede2001-08-07 16:40:56 +00005509
Guido van Rossumc334df52002-04-04 23:44:47 +00005510/* Length of array of slotdef pointers used to store slots with the
5511 same __name__. There should be at most MAX_EQUIV-1 slotdef entries with
5512 the same __name__, for any __name__. Since that's a static property, it is
5513 appropriate to declare fixed-size arrays for this. */
5514#define MAX_EQUIV 10
5515
5516/* Return a slot pointer for a given name, but ONLY if the attribute has
5517 exactly one slot function. The name must be an interned string. */
5518static void **
5519resolve_slotdups(PyTypeObject *type, PyObject *name)
5520{
5521 /* XXX Maybe this could be optimized more -- but is it worth it? */
5522
5523 /* pname and ptrs act as a little cache */
5524 static PyObject *pname;
5525 static slotdef *ptrs[MAX_EQUIV];
5526 slotdef *p, **pp;
5527 void **res, **ptr;
5528
5529 if (pname != name) {
5530 /* Collect all slotdefs that match name into ptrs. */
5531 pname = name;
5532 pp = ptrs;
5533 for (p = slotdefs; p->name_strobj; p++) {
5534 if (p->name_strobj == name)
5535 *pp++ = p;
5536 }
5537 *pp = NULL;
5538 }
5539
5540 /* Look in all matching slots of the type; if exactly one of these has
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005541 a filled-in slot, return its value. Otherwise return NULL. */
Guido van Rossumc334df52002-04-04 23:44:47 +00005542 res = NULL;
5543 for (pp = ptrs; *pp; pp++) {
5544 ptr = slotptr(type, (*pp)->offset);
5545 if (ptr == NULL || *ptr == NULL)
5546 continue;
5547 if (res != NULL)
5548 return NULL;
5549 res = ptr;
5550 }
5551 return res;
5552}
5553
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005554/* Common code for update_slots_callback() and fixup_slot_dispatchers(). This
Guido van Rossumc334df52002-04-04 23:44:47 +00005555 does some incredibly complex thinking and then sticks something into the
5556 slot. (It sees if the adjacent slotdefs for the same slot have conflicting
5557 interests, and then stores a generic wrapper or a specific function into
5558 the slot.) Return a pointer to the next slotdef with a different offset,
5559 because that's convenient for fixup_slot_dispatchers(). */
5560static slotdef *
5561update_one_slot(PyTypeObject *type, slotdef *p)
5562{
5563 PyObject *descr;
5564 PyWrapperDescrObject *d;
5565 void *generic = NULL, *specific = NULL;
5566 int use_generic = 0;
5567 int offset = p->offset;
5568 void **ptr = slotptr(type, offset);
5569
5570 if (ptr == NULL) {
5571 do {
5572 ++p;
5573 } while (p->offset == offset);
5574 return p;
5575 }
5576 do {
5577 descr = _PyType_Lookup(type, p->name_strobj);
5578 if (descr == NULL)
5579 continue;
Christian Heimese93237d2007-12-19 02:37:44 +00005580 if (Py_TYPE(descr) == &PyWrapperDescr_Type) {
Guido van Rossumc334df52002-04-04 23:44:47 +00005581 void **tptr = resolve_slotdups(type, p->name_strobj);
5582 if (tptr == NULL || tptr == ptr)
5583 generic = p->function;
5584 d = (PyWrapperDescrObject *)descr;
5585 if (d->d_base->wrapper == p->wrapper &&
5586 PyType_IsSubtype(type, d->d_type))
5587 {
5588 if (specific == NULL ||
5589 specific == d->d_wrapped)
5590 specific = d->d_wrapped;
5591 else
5592 use_generic = 1;
5593 }
5594 }
Christian Heimese93237d2007-12-19 02:37:44 +00005595 else if (Py_TYPE(descr) == &PyCFunction_Type &&
Guido van Rossum721f62e2002-08-09 02:14:34 +00005596 PyCFunction_GET_FUNCTION(descr) ==
5597 (PyCFunction)tp_new_wrapper &&
5598 strcmp(p->name, "__new__") == 0)
5599 {
5600 /* The __new__ wrapper is not a wrapper descriptor,
5601 so must be special-cased differently.
5602 If we don't do this, creating an instance will
5603 always use slot_tp_new which will look up
5604 __new__ in the MRO which will call tp_new_wrapper
5605 which will look through the base classes looking
5606 for a static base and call its tp_new (usually
5607 PyType_GenericNew), after performing various
5608 sanity checks and constructing a new argument
5609 list. Cut all that nonsense short -- this speeds
5610 up instance creation tremendously. */
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005611 specific = (void *)type->tp_new;
Guido van Rossum721f62e2002-08-09 02:14:34 +00005612 /* XXX I'm not 100% sure that there isn't a hole
5613 in this reasoning that requires additional
5614 sanity checks. I'll buy the first person to
5615 point out a bug in this reasoning a beer. */
5616 }
Guido van Rossumc334df52002-04-04 23:44:47 +00005617 else {
5618 use_generic = 1;
5619 generic = p->function;
5620 }
5621 } while ((++p)->offset == offset);
5622 if (specific && !use_generic)
5623 *ptr = specific;
5624 else
5625 *ptr = generic;
5626 return p;
5627}
5628
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005629/* In the type, update the slots whose slotdefs are gathered in the pp array.
5630 This is a callback for update_subclasses(). */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005631static int
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005632update_slots_callback(PyTypeObject *type, void *data)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005633{
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005634 slotdef **pp = (slotdef **)data;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005635
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005636 for (; *pp; pp++)
Guido van Rossumc334df52002-04-04 23:44:47 +00005637 update_one_slot(type, *pp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005638 return 0;
5639}
5640
Guido van Rossumc334df52002-04-04 23:44:47 +00005641/* Comparison function for qsort() to compare slotdefs by their offset, and
5642 for equal offset by their address (to force a stable sort). */
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005643static int
5644slotdef_cmp(const void *aa, const void *bb)
5645{
5646 const slotdef *a = (const slotdef *)aa, *b = (const slotdef *)bb;
5647 int c = a->offset - b->offset;
5648 if (c != 0)
5649 return c;
5650 else
Martin v. Löwis18e16552006-02-15 17:27:45 +00005651 /* Cannot use a-b, as this gives off_t,
5652 which may lose precision when converted to int. */
5653 return (a > b) ? 1 : (a < b) ? -1 : 0;
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005654}
5655
Guido van Rossumc334df52002-04-04 23:44:47 +00005656/* Initialize the slotdefs table by adding interned string objects for the
5657 names and sorting the entries. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005658static void
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005659init_slotdefs(void)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005660{
5661 slotdef *p;
5662 static int initialized = 0;
5663
5664 if (initialized)
5665 return;
5666 for (p = slotdefs; p->name; p++) {
5667 p->name_strobj = PyString_InternFromString(p->name);
5668 if (!p->name_strobj)
Guido van Rossumc334df52002-04-04 23:44:47 +00005669 Py_FatalError("Out of memory interning slotdef names");
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005670 }
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005671 qsort((void *)slotdefs, (size_t)(p-slotdefs), sizeof(slotdef),
5672 slotdef_cmp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005673 initialized = 1;
5674}
5675
Guido van Rossumc334df52002-04-04 23:44:47 +00005676/* Update the slots after assignment to a class (type) attribute. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005677static int
5678update_slot(PyTypeObject *type, PyObject *name)
5679{
Guido van Rossumc334df52002-04-04 23:44:47 +00005680 slotdef *ptrs[MAX_EQUIV];
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005681 slotdef *p;
5682 slotdef **pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005683 int offset;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005684
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005685 init_slotdefs();
5686 pp = ptrs;
5687 for (p = slotdefs; p->name; p++) {
5688 /* XXX assume name is interned! */
5689 if (p->name_strobj == name)
5690 *pp++ = p;
5691 }
5692 *pp = NULL;
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005693 for (pp = ptrs; *pp; pp++) {
5694 p = *pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005695 offset = p->offset;
5696 while (p > slotdefs && (p-1)->offset == offset)
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005697 --p;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005698 *pp = p;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005699 }
Guido van Rossumc334df52002-04-04 23:44:47 +00005700 if (ptrs[0] == NULL)
5701 return 0; /* Not an attribute that affects any slots */
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005702 return update_subclasses(type, name,
5703 update_slots_callback, (void *)ptrs);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005704}
5705
Guido van Rossumc334df52002-04-04 23:44:47 +00005706/* Store the proper functions in the slot dispatches at class (type)
5707 definition time, based upon which operations the class overrides in its
5708 dict. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00005709static void
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005710fixup_slot_dispatchers(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00005711{
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005712 slotdef *p;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005713
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005714 init_slotdefs();
Guido van Rossumc334df52002-04-04 23:44:47 +00005715 for (p = slotdefs; p->name; )
5716 p = update_one_slot(type, p);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005717}
Guido van Rossum705f0f52001-08-24 16:47:00 +00005718
Michael W. Hudson98bbc492002-11-26 14:47:27 +00005719static void
5720update_all_slots(PyTypeObject* type)
5721{
5722 slotdef *p;
5723
5724 init_slotdefs();
5725 for (p = slotdefs; p->name; p++) {
5726 /* update_slot returns int but can't actually fail */
5727 update_slot(type, p->name_strobj);
5728 }
5729}
5730
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005731/* recurse_down_subclasses() and update_subclasses() are mutually
5732 recursive functions to call a callback for all subclasses,
5733 but refraining from recursing into subclasses that define 'name'. */
5734
5735static int
5736update_subclasses(PyTypeObject *type, PyObject *name,
5737 update_callback callback, void *data)
5738{
5739 if (callback(type, data) < 0)
5740 return -1;
5741 return recurse_down_subclasses(type, name, callback, data);
5742}
5743
5744static int
5745recurse_down_subclasses(PyTypeObject *type, PyObject *name,
5746 update_callback callback, void *data)
5747{
5748 PyTypeObject *subclass;
5749 PyObject *ref, *subclasses, *dict;
Martin v. Löwis18e16552006-02-15 17:27:45 +00005750 Py_ssize_t i, n;
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005751
5752 subclasses = type->tp_subclasses;
5753 if (subclasses == NULL)
5754 return 0;
5755 assert(PyList_Check(subclasses));
5756 n = PyList_GET_SIZE(subclasses);
5757 for (i = 0; i < n; i++) {
5758 ref = PyList_GET_ITEM(subclasses, i);
5759 assert(PyWeakref_CheckRef(ref));
5760 subclass = (PyTypeObject *)PyWeakref_GET_OBJECT(ref);
5761 assert(subclass != NULL);
5762 if ((PyObject *)subclass == Py_None)
5763 continue;
5764 assert(PyType_Check(subclass));
5765 /* Avoid recursing down into unaffected classes */
5766 dict = subclass->tp_dict;
5767 if (dict != NULL && PyDict_Check(dict) &&
5768 PyDict_GetItem(dict, name) != NULL)
5769 continue;
5770 if (update_subclasses(subclass, name, callback, data) < 0)
5771 return -1;
5772 }
5773 return 0;
5774}
5775
Guido van Rossum6d204072001-10-21 00:44:31 +00005776/* This function is called by PyType_Ready() to populate the type's
5777 dictionary with method descriptors for function slots. For each
Guido van Rossum09638c12002-06-13 19:17:46 +00005778 function slot (like tp_repr) that's defined in the type, one or more
5779 corresponding descriptors are added in the type's tp_dict dictionary
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005780 under the appropriate name (like __repr__). Some function slots
Guido van Rossum09638c12002-06-13 19:17:46 +00005781 cause more than one descriptor to be added (for example, the nb_add
5782 slot adds both __add__ and __radd__ descriptors) and some function
5783 slots compete for the same descriptor (for example both sq_item and
5784 mp_subscript generate a __getitem__ descriptor).
5785
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005786 In the latter case, the first slotdef entry encoutered wins. Since
Tim Petersbf9b2442003-03-23 05:35:36 +00005787 slotdef entries are sorted by the offset of the slot in the
Guido van Rossume5c691a2003-03-07 15:13:17 +00005788 PyHeapTypeObject, this gives us some control over disambiguating
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005789 between competing slots: the members of PyHeapTypeObject are listed
5790 from most general to least general, so the most general slot is
5791 preferred. In particular, because as_mapping comes before as_sequence,
5792 for a type that defines both mp_subscript and sq_item, mp_subscript
5793 wins.
Guido van Rossum09638c12002-06-13 19:17:46 +00005794
5795 This only adds new descriptors and doesn't overwrite entries in
5796 tp_dict that were previously defined. The descriptors contain a
5797 reference to the C function they must call, so that it's safe if they
5798 are copied into a subtype's __dict__ and the subtype has a different
5799 C function in its slot -- calling the method defined by the
5800 descriptor will call the C function that was used to create it,
5801 rather than the C function present in the slot when it is called.
5802 (This is important because a subtype may have a C function in the
5803 slot that calls the method from the dictionary, and we want to avoid
5804 infinite recursion here.) */
Guido van Rossum6d204072001-10-21 00:44:31 +00005805
5806static int
5807add_operators(PyTypeObject *type)
5808{
5809 PyObject *dict = type->tp_dict;
5810 slotdef *p;
5811 PyObject *descr;
5812 void **ptr;
5813
5814 init_slotdefs();
5815 for (p = slotdefs; p->name; p++) {
5816 if (p->wrapper == NULL)
5817 continue;
5818 ptr = slotptr(type, p->offset);
5819 if (!ptr || !*ptr)
5820 continue;
5821 if (PyDict_GetItem(dict, p->name_strobj))
5822 continue;
5823 descr = PyDescr_NewWrapper(type, p, *ptr);
5824 if (descr == NULL)
5825 return -1;
5826 if (PyDict_SetItem(dict, p->name_strobj, descr) < 0)
5827 return -1;
5828 Py_DECREF(descr);
5829 }
5830 if (type->tp_new != NULL) {
5831 if (add_tp_new_wrapper(type) < 0)
5832 return -1;
5833 }
5834 return 0;
5835}
5836
Guido van Rossum705f0f52001-08-24 16:47:00 +00005837
5838/* Cooperative 'super' */
5839
5840typedef struct {
5841 PyObject_HEAD
Guido van Rossume705ef12001-08-29 15:47:06 +00005842 PyTypeObject *type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005843 PyObject *obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005844 PyTypeObject *obj_type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005845} superobject;
5846
Guido van Rossum6f799372001-09-20 20:46:19 +00005847static PyMemberDef super_members[] = {
5848 {"__thisclass__", T_OBJECT, offsetof(superobject, type), READONLY,
5849 "the class invoking super()"},
5850 {"__self__", T_OBJECT, offsetof(superobject, obj), READONLY,
5851 "the instance invoking super(); may be None"},
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005852 {"__self_class__", T_OBJECT, offsetof(superobject, obj_type), READONLY,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +00005853 "the type of the instance invoking super(); may be None"},
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005854 {0}
5855};
5856
Guido van Rossum705f0f52001-08-24 16:47:00 +00005857static void
5858super_dealloc(PyObject *self)
5859{
5860 superobject *su = (superobject *)self;
5861
Guido van Rossum048eb752001-10-02 21:24:57 +00005862 _PyObject_GC_UNTRACK(self);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005863 Py_XDECREF(su->obj);
5864 Py_XDECREF(su->type);
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005865 Py_XDECREF(su->obj_type);
Christian Heimese93237d2007-12-19 02:37:44 +00005866 Py_TYPE(self)->tp_free(self);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005867}
5868
5869static PyObject *
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005870super_repr(PyObject *self)
5871{
5872 superobject *su = (superobject *)self;
5873
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005874 if (su->obj_type)
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005875 return PyString_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00005876 "<super: <class '%s'>, <%s object>>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005877 su->type ? su->type->tp_name : "NULL",
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005878 su->obj_type->tp_name);
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005879 else
5880 return PyString_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00005881 "<super: <class '%s'>, NULL>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005882 su->type ? su->type->tp_name : "NULL");
5883}
5884
5885static PyObject *
Guido van Rossum705f0f52001-08-24 16:47:00 +00005886super_getattro(PyObject *self, PyObject *name)
5887{
5888 superobject *su = (superobject *)self;
Guido van Rossum76ba09f2003-04-16 19:40:58 +00005889 int skip = su->obj_type == NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005890
Guido van Rossum76ba09f2003-04-16 19:40:58 +00005891 if (!skip) {
5892 /* We want __class__ to return the class of the super object
5893 (i.e. super, or a subclass), not the class of su->obj. */
5894 skip = (PyString_Check(name) &&
5895 PyString_GET_SIZE(name) == 9 &&
5896 strcmp(PyString_AS_STRING(name), "__class__") == 0);
5897 }
5898
5899 if (!skip) {
Tim Petersa91e9642001-11-14 23:32:33 +00005900 PyObject *mro, *res, *tmp, *dict;
Guido van Rossum155db9a2002-04-02 17:53:47 +00005901 PyTypeObject *starttype;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005902 descrgetfunc f;
Martin v. Löwis18e16552006-02-15 17:27:45 +00005903 Py_ssize_t i, n;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005904
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005905 starttype = su->obj_type;
Guido van Rossum155db9a2002-04-02 17:53:47 +00005906 mro = starttype->tp_mro;
5907
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005908 if (mro == NULL)
5909 n = 0;
5910 else {
5911 assert(PyTuple_Check(mro));
5912 n = PyTuple_GET_SIZE(mro);
5913 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005914 for (i = 0; i < n; i++) {
Guido van Rossume705ef12001-08-29 15:47:06 +00005915 if ((PyObject *)(su->type) == PyTuple_GET_ITEM(mro, i))
Guido van Rossum705f0f52001-08-24 16:47:00 +00005916 break;
5917 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005918 i++;
5919 res = NULL;
5920 for (; i < n; i++) {
5921 tmp = PyTuple_GET_ITEM(mro, i);
Tim Petersa91e9642001-11-14 23:32:33 +00005922 if (PyType_Check(tmp))
5923 dict = ((PyTypeObject *)tmp)->tp_dict;
5924 else if (PyClass_Check(tmp))
5925 dict = ((PyClassObject *)tmp)->cl_dict;
5926 else
5927 continue;
5928 res = PyDict_GetItem(dict, name);
Guido van Rossum6cc5bb62003-04-16 20:01:36 +00005929 if (res != NULL) {
Guido van Rossum705f0f52001-08-24 16:47:00 +00005930 Py_INCREF(res);
Christian Heimese93237d2007-12-19 02:37:44 +00005931 f = Py_TYPE(res)->tp_descr_get;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005932 if (f != NULL) {
Phillip J. Eby91a968a2004-03-25 02:19:34 +00005933 tmp = f(res,
5934 /* Only pass 'obj' param if
5935 this is instance-mode super
5936 (See SF ID #743627)
5937 */
Hye-Shik Changff365c92004-03-25 16:37:03 +00005938 (su->obj == (PyObject *)
5939 su->obj_type
Phillip J. Eby91a968a2004-03-25 02:19:34 +00005940 ? (PyObject *)NULL
5941 : su->obj),
Guido van Rossumd4641072002-04-03 02:13:37 +00005942 (PyObject *)starttype);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005943 Py_DECREF(res);
5944 res = tmp;
5945 }
5946 return res;
5947 }
5948 }
5949 }
5950 return PyObject_GenericGetAttr(self, name);
5951}
5952
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005953static PyTypeObject *
Guido van Rossum5b443c62001-12-03 15:38:28 +00005954supercheck(PyTypeObject *type, PyObject *obj)
5955{
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005956 /* Check that a super() call makes sense. Return a type object.
5957
5958 obj can be a new-style class, or an instance of one:
5959
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00005960 - If it is a class, it must be a subclass of 'type'. This case is
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005961 used for class methods; the return value is obj.
5962
5963 - If it is an instance, it must be an instance of 'type'. This is
5964 the normal case; the return value is obj.__class__.
5965
5966 But... when obj is an instance, we want to allow for the case where
Christian Heimese93237d2007-12-19 02:37:44 +00005967 Py_TYPE(obj) is not a subclass of type, but obj.__class__ is!
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005968 This will allow using super() with a proxy for obj.
5969 */
5970
Guido van Rossum8e80a722003-02-18 19:22:22 +00005971 /* Check for first bullet above (special case) */
5972 if (PyType_Check(obj) && PyType_IsSubtype((PyTypeObject *)obj, type)) {
5973 Py_INCREF(obj);
5974 return (PyTypeObject *)obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005975 }
Guido van Rossum8e80a722003-02-18 19:22:22 +00005976
5977 /* Normal case */
Christian Heimese93237d2007-12-19 02:37:44 +00005978 if (PyType_IsSubtype(Py_TYPE(obj), type)) {
5979 Py_INCREF(Py_TYPE(obj));
5980 return Py_TYPE(obj);
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005981 }
5982 else {
5983 /* Try the slow way */
5984 static PyObject *class_str = NULL;
5985 PyObject *class_attr;
5986
5987 if (class_str == NULL) {
5988 class_str = PyString_FromString("__class__");
5989 if (class_str == NULL)
5990 return NULL;
5991 }
5992
5993 class_attr = PyObject_GetAttr(obj, class_str);
5994
5995 if (class_attr != NULL &&
5996 PyType_Check(class_attr) &&
Christian Heimese93237d2007-12-19 02:37:44 +00005997 (PyTypeObject *)class_attr != Py_TYPE(obj))
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005998 {
5999 int ok = PyType_IsSubtype(
6000 (PyTypeObject *)class_attr, type);
6001 if (ok)
6002 return (PyTypeObject *)class_attr;
6003 }
6004
6005 if (class_attr == NULL)
6006 PyErr_Clear();
6007 else
6008 Py_DECREF(class_attr);
6009 }
6010
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006011 PyErr_SetString(PyExc_TypeError,
Guido van Rossum5b443c62001-12-03 15:38:28 +00006012 "super(type, obj): "
6013 "obj must be an instance or subtype of type");
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006014 return NULL;
Guido van Rossum5b443c62001-12-03 15:38:28 +00006015}
6016
Guido van Rossum705f0f52001-08-24 16:47:00 +00006017static PyObject *
6018super_descr_get(PyObject *self, PyObject *obj, PyObject *type)
6019{
6020 superobject *su = (superobject *)self;
Anthony Baxtera6286212006-04-11 07:42:36 +00006021 superobject *newobj;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006022
6023 if (obj == NULL || obj == Py_None || su->obj != NULL) {
6024 /* Not binding to an object, or already bound */
6025 Py_INCREF(self);
6026 return self;
6027 }
Christian Heimese93237d2007-12-19 02:37:44 +00006028 if (Py_TYPE(su) != &PySuper_Type)
Armin Rigo7726dc02005-05-15 15:32:08 +00006029 /* If su is an instance of a (strict) subclass of super,
Guido van Rossum5b443c62001-12-03 15:38:28 +00006030 call its type */
Christian Heimese93237d2007-12-19 02:37:44 +00006031 return PyObject_CallFunctionObjArgs((PyObject *)Py_TYPE(su),
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006032 su->type, obj, NULL);
Guido van Rossum5b443c62001-12-03 15:38:28 +00006033 else {
6034 /* Inline the common case */
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006035 PyTypeObject *obj_type = supercheck(su->type, obj);
6036 if (obj_type == NULL)
Guido van Rossum5b443c62001-12-03 15:38:28 +00006037 return NULL;
Anthony Baxtera6286212006-04-11 07:42:36 +00006038 newobj = (superobject *)PySuper_Type.tp_new(&PySuper_Type,
Guido van Rossum5b443c62001-12-03 15:38:28 +00006039 NULL, NULL);
Anthony Baxtera6286212006-04-11 07:42:36 +00006040 if (newobj == NULL)
Guido van Rossum5b443c62001-12-03 15:38:28 +00006041 return NULL;
6042 Py_INCREF(su->type);
6043 Py_INCREF(obj);
Anthony Baxtera6286212006-04-11 07:42:36 +00006044 newobj->type = su->type;
6045 newobj->obj = obj;
6046 newobj->obj_type = obj_type;
6047 return (PyObject *)newobj;
Guido van Rossum5b443c62001-12-03 15:38:28 +00006048 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00006049}
6050
6051static int
6052super_init(PyObject *self, PyObject *args, PyObject *kwds)
6053{
6054 superobject *su = (superobject *)self;
Guido van Rossume705ef12001-08-29 15:47:06 +00006055 PyTypeObject *type;
6056 PyObject *obj = NULL;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006057 PyTypeObject *obj_type = NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006058
Georg Brandl5d59c092006-09-30 08:43:30 +00006059 if (!_PyArg_NoKeywords("super", kwds))
6060 return -1;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006061 if (!PyArg_ParseTuple(args, "O!|O:super", &PyType_Type, &type, &obj))
6062 return -1;
6063 if (obj == Py_None)
6064 obj = NULL;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006065 if (obj != NULL) {
6066 obj_type = supercheck(type, obj);
6067 if (obj_type == NULL)
6068 return -1;
6069 Py_INCREF(obj);
6070 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00006071 Py_INCREF(type);
Guido van Rossum705f0f52001-08-24 16:47:00 +00006072 su->type = type;
6073 su->obj = obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00006074 su->obj_type = obj_type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00006075 return 0;
6076}
6077
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00006078PyDoc_STRVAR(super_doc,
Guido van Rossum705f0f52001-08-24 16:47:00 +00006079"super(type) -> unbound super object\n"
6080"super(type, obj) -> bound super object; requires isinstance(obj, type)\n"
Guido van Rossume705ef12001-08-29 15:47:06 +00006081"super(type, type2) -> bound super object; requires issubclass(type2, type)\n"
Guido van Rossum705f0f52001-08-24 16:47:00 +00006082"Typical use to call a cooperative superclass method:\n"
6083"class C(B):\n"
6084" def meth(self, arg):\n"
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006085" super(C, self).meth(arg)");
Guido van Rossum705f0f52001-08-24 16:47:00 +00006086
Guido van Rossum048eb752001-10-02 21:24:57 +00006087static int
6088super_traverse(PyObject *self, visitproc visit, void *arg)
6089{
6090 superobject *su = (superobject *)self;
Guido van Rossum048eb752001-10-02 21:24:57 +00006091
Thomas Woutersc6e55062006-04-15 21:47:09 +00006092 Py_VISIT(su->obj);
6093 Py_VISIT(su->type);
6094 Py_VISIT(su->obj_type);
Guido van Rossum048eb752001-10-02 21:24:57 +00006095
6096 return 0;
6097}
6098
Guido van Rossum705f0f52001-08-24 16:47:00 +00006099PyTypeObject PySuper_Type = {
Martin v. Löwis68192102007-07-21 06:55:02 +00006100 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossum705f0f52001-08-24 16:47:00 +00006101 "super", /* tp_name */
6102 sizeof(superobject), /* tp_basicsize */
6103 0, /* tp_itemsize */
6104 /* methods */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006105 super_dealloc, /* tp_dealloc */
Guido van Rossum705f0f52001-08-24 16:47:00 +00006106 0, /* tp_print */
6107 0, /* tp_getattr */
6108 0, /* tp_setattr */
6109 0, /* tp_compare */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00006110 super_repr, /* tp_repr */
Guido van Rossum705f0f52001-08-24 16:47:00 +00006111 0, /* tp_as_number */
6112 0, /* tp_as_sequence */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006113 0, /* tp_as_mapping */
Guido van Rossum705f0f52001-08-24 16:47:00 +00006114 0, /* tp_hash */
6115 0, /* tp_call */
6116 0, /* tp_str */
6117 super_getattro, /* tp_getattro */
6118 0, /* tp_setattro */
6119 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00006120 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
6121 Py_TPFLAGS_BASETYPE, /* tp_flags */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006122 super_doc, /* tp_doc */
6123 super_traverse, /* tp_traverse */
6124 0, /* tp_clear */
Guido van Rossum705f0f52001-08-24 16:47:00 +00006125 0, /* tp_richcompare */
6126 0, /* tp_weaklistoffset */
6127 0, /* tp_iter */
6128 0, /* tp_iternext */
6129 0, /* tp_methods */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00006130 super_members, /* tp_members */
Guido van Rossum705f0f52001-08-24 16:47:00 +00006131 0, /* tp_getset */
6132 0, /* tp_base */
6133 0, /* tp_dict */
6134 super_descr_get, /* tp_descr_get */
6135 0, /* tp_descr_set */
6136 0, /* tp_dictoffset */
6137 super_init, /* tp_init */
6138 PyType_GenericAlloc, /* tp_alloc */
6139 PyType_GenericNew, /* tp_new */
Jeremy Hylton2d1f5c92007-02-27 17:24:48 +00006140 PyObject_GC_Del, /* tp_free */
Guido van Rossum705f0f52001-08-24 16:47:00 +00006141};