blob: b679c4bca5178a26dfbb4259819feb1d73589804 [file] [log] [blame]
Tim Peters6d6c1a32001-08-02 04:15:00 +00001/* Descriptors -- a new, flexible way to describe attributes */
2
3#include "Python.h"
4#include "structmember.h" /* Why is this not included in Python.h? */
5
Tim Peters6d6c1a32001-08-02 04:15:00 +00006static void
7descr_dealloc(PyDescrObject *descr)
8{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00009 _PyObject_GC_UNTRACK(descr);
10 Py_XDECREF(descr->d_type);
11 Py_XDECREF(descr->d_name);
Antoine Pitrou9d574812011-12-12 13:47:25 +010012 Py_XDECREF(descr->d_qualname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000013 PyObject_GC_Del(descr);
Tim Peters6d6c1a32001-08-02 04:15:00 +000014}
15
Walter Dörwaldd7fb7642007-06-11 16:36:59 +000016static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +000017descr_name(PyDescrObject *descr)
18{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000019 if (descr->d_name != NULL && PyUnicode_Check(descr->d_name))
20 return descr->d_name;
21 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +000022}
23
24static PyObject *
25descr_repr(PyDescrObject *descr, char *format)
26{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000027 PyObject *name = NULL;
28 if (descr->d_name != NULL && PyUnicode_Check(descr->d_name))
29 name = descr->d_name;
Walter Dörwaldd7fb7642007-06-11 16:36:59 +000030
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000031 return PyUnicode_FromFormat(format, name, "?", descr->d_type->tp_name);
Tim Peters6d6c1a32001-08-02 04:15:00 +000032}
33
34static PyObject *
35method_repr(PyMethodDescrObject *descr)
36{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000037 return descr_repr((PyDescrObject *)descr,
38 "<method '%V' of '%s' objects>");
Tim Peters6d6c1a32001-08-02 04:15:00 +000039}
40
41static PyObject *
42member_repr(PyMemberDescrObject *descr)
43{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000044 return descr_repr((PyDescrObject *)descr,
45 "<member '%V' of '%s' objects>");
Tim Peters6d6c1a32001-08-02 04:15:00 +000046}
47
48static PyObject *
49getset_repr(PyGetSetDescrObject *descr)
50{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000051 return descr_repr((PyDescrObject *)descr,
52 "<attribute '%V' of '%s' objects>");
Tim Peters6d6c1a32001-08-02 04:15:00 +000053}
54
55static PyObject *
Armin Rigoc6686b72005-11-07 08:38:00 +000056wrapperdescr_repr(PyWrapperDescrObject *descr)
Tim Peters6d6c1a32001-08-02 04:15:00 +000057{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000058 return descr_repr((PyDescrObject *)descr,
59 "<slot wrapper '%V' of '%s' objects>");
Tim Peters6d6c1a32001-08-02 04:15:00 +000060}
61
62static int
Guido van Rossumb6e5a0c2003-02-11 18:44:42 +000063descr_check(PyDescrObject *descr, PyObject *obj, PyObject **pres)
Tim Peters6d6c1a32001-08-02 04:15:00 +000064{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000065 if (obj == NULL) {
66 Py_INCREF(descr);
67 *pres = (PyObject *)descr;
68 return 1;
69 }
70 if (!PyObject_TypeCheck(obj, descr->d_type)) {
71 PyErr_Format(PyExc_TypeError,
72 "descriptor '%V' for '%s' objects "
73 "doesn't apply to '%s' object",
74 descr_name((PyDescrObject *)descr), "?",
75 descr->d_type->tp_name,
76 obj->ob_type->tp_name);
77 *pres = NULL;
78 return 1;
79 }
80 return 0;
Tim Peters6d6c1a32001-08-02 04:15:00 +000081}
82
83static PyObject *
Guido van Rossumb6e5a0c2003-02-11 18:44:42 +000084classmethod_get(PyMethodDescrObject *descr, PyObject *obj, PyObject *type)
Tim Petersbca1cbc2002-12-09 22:56:13 +000085{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000086 /* Ensure a valid type. Class methods ignore obj. */
87 if (type == NULL) {
88 if (obj != NULL)
89 type = (PyObject *)obj->ob_type;
90 else {
91 /* Wot - no type?! */
92 PyErr_Format(PyExc_TypeError,
93 "descriptor '%V' for type '%s' "
94 "needs either an object or a type",
95 descr_name((PyDescrObject *)descr), "?",
96 PyDescr_TYPE(descr)->tp_name);
97 return NULL;
98 }
99 }
100 if (!PyType_Check(type)) {
101 PyErr_Format(PyExc_TypeError,
102 "descriptor '%V' for type '%s' "
103 "needs a type, not a '%s' as arg 2",
104 descr_name((PyDescrObject *)descr), "?",
105 PyDescr_TYPE(descr)->tp_name,
106 type->ob_type->tp_name);
107 return NULL;
108 }
109 if (!PyType_IsSubtype((PyTypeObject *)type, PyDescr_TYPE(descr))) {
110 PyErr_Format(PyExc_TypeError,
111 "descriptor '%V' for type '%s' "
112 "doesn't apply to type '%s'",
113 descr_name((PyDescrObject *)descr), "?",
114 PyDescr_TYPE(descr)->tp_name,
115 ((PyTypeObject *)type)->tp_name);
116 return NULL;
117 }
118 return PyCFunction_New(descr->d_method, type);
Tim Petersbca1cbc2002-12-09 22:56:13 +0000119}
120
121static PyObject *
Guido van Rossumb6e5a0c2003-02-11 18:44:42 +0000122method_get(PyMethodDescrObject *descr, PyObject *obj, PyObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000123{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000124 PyObject *res;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000125
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000126 if (descr_check((PyDescrObject *)descr, obj, &res))
127 return res;
128 return PyCFunction_New(descr->d_method, obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000129}
130
131static PyObject *
Guido van Rossumb6e5a0c2003-02-11 18:44:42 +0000132member_get(PyMemberDescrObject *descr, PyObject *obj, PyObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000133{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000134 PyObject *res;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000135
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000136 if (descr_check((PyDescrObject *)descr, obj, &res))
137 return res;
138 return PyMember_GetOne((char *)obj, descr->d_member);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000139}
140
141static PyObject *
Guido van Rossumb6e5a0c2003-02-11 18:44:42 +0000142getset_get(PyGetSetDescrObject *descr, PyObject *obj, PyObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000143{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000144 PyObject *res;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000145
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000146 if (descr_check((PyDescrObject *)descr, obj, &res))
147 return res;
148 if (descr->d_getset->get != NULL)
149 return descr->d_getset->get(obj, descr->d_getset->closure);
150 PyErr_Format(PyExc_AttributeError,
151 "attribute '%V' of '%.100s' objects is not readable",
152 descr_name((PyDescrObject *)descr), "?",
153 PyDescr_TYPE(descr)->tp_name);
154 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000155}
156
157static PyObject *
Armin Rigoc6686b72005-11-07 08:38:00 +0000158wrapperdescr_get(PyWrapperDescrObject *descr, PyObject *obj, PyObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000159{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000160 PyObject *res;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000161
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000162 if (descr_check((PyDescrObject *)descr, obj, &res))
163 return res;
164 return PyWrapper_New((PyObject *)descr, obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000165}
166
167static int
168descr_setcheck(PyDescrObject *descr, PyObject *obj, PyObject *value,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000169 int *pres)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000170{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000171 assert(obj != NULL);
172 if (!PyObject_TypeCheck(obj, descr->d_type)) {
173 PyErr_Format(PyExc_TypeError,
174 "descriptor '%V' for '%.100s' objects "
175 "doesn't apply to '%.100s' object",
176 descr_name(descr), "?",
177 descr->d_type->tp_name,
178 obj->ob_type->tp_name);
179 *pres = -1;
180 return 1;
181 }
182 return 0;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000183}
184
185static int
186member_set(PyMemberDescrObject *descr, PyObject *obj, PyObject *value)
187{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000188 int res;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000189
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000190 if (descr_setcheck((PyDescrObject *)descr, obj, value, &res))
191 return res;
192 return PyMember_SetOne((char *)obj, descr->d_member, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000193}
194
195static int
196getset_set(PyGetSetDescrObject *descr, PyObject *obj, PyObject *value)
197{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000198 int res;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000199
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000200 if (descr_setcheck((PyDescrObject *)descr, obj, value, &res))
201 return res;
202 if (descr->d_getset->set != NULL)
203 return descr->d_getset->set(obj, value,
204 descr->d_getset->closure);
205 PyErr_Format(PyExc_AttributeError,
206 "attribute '%V' of '%.100s' objects is not writable",
207 descr_name((PyDescrObject *)descr), "?",
208 PyDescr_TYPE(descr)->tp_name);
209 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000210}
211
212static PyObject *
213methoddescr_call(PyMethodDescrObject *descr, PyObject *args, PyObject *kwds)
214{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000215 Py_ssize_t argc;
216 PyObject *self, *func, *result;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000217
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000218 /* Make sure that the first argument is acceptable as 'self' */
219 assert(PyTuple_Check(args));
220 argc = PyTuple_GET_SIZE(args);
221 if (argc < 1) {
222 PyErr_Format(PyExc_TypeError,
223 "descriptor '%V' of '%.100s' "
224 "object needs an argument",
225 descr_name((PyDescrObject *)descr), "?",
226 PyDescr_TYPE(descr)->tp_name);
227 return NULL;
228 }
229 self = PyTuple_GET_ITEM(args, 0);
Victor Stinner3249dec2011-05-01 23:19:15 +0200230 if (!_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self),
Victor Stinnerd9561312011-05-01 23:31:36 +0200231 (PyObject *)PyDescr_TYPE(descr))) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000232 PyErr_Format(PyExc_TypeError,
233 "descriptor '%V' "
234 "requires a '%.100s' object "
235 "but received a '%.100s'",
236 descr_name((PyDescrObject *)descr), "?",
237 PyDescr_TYPE(descr)->tp_name,
238 self->ob_type->tp_name);
239 return NULL;
240 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000241
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000242 func = PyCFunction_New(descr->d_method, self);
243 if (func == NULL)
244 return NULL;
245 args = PyTuple_GetSlice(args, 1, argc);
246 if (args == NULL) {
247 Py_DECREF(func);
248 return NULL;
249 }
250 result = PyEval_CallObjectWithKeywords(func, args, kwds);
251 Py_DECREF(args);
252 Py_DECREF(func);
253 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000254}
255
256static PyObject *
Tim Petersbca1cbc2002-12-09 22:56:13 +0000257classmethoddescr_call(PyMethodDescrObject *descr, PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000258 PyObject *kwds)
Tim Petersbca1cbc2002-12-09 22:56:13 +0000259{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000260 PyObject *func, *result;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000261
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000262 func = PyCFunction_New(descr->d_method, (PyObject *)PyDescr_TYPE(descr));
263 if (func == NULL)
264 return NULL;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000265
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000266 result = PyEval_CallObjectWithKeywords(func, args, kwds);
267 Py_DECREF(func);
268 return result;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000269}
270
271static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000272wrapperdescr_call(PyWrapperDescrObject *descr, PyObject *args, PyObject *kwds)
273{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000274 Py_ssize_t argc;
275 PyObject *self, *func, *result;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000276
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000277 /* Make sure that the first argument is acceptable as 'self' */
278 assert(PyTuple_Check(args));
279 argc = PyTuple_GET_SIZE(args);
280 if (argc < 1) {
281 PyErr_Format(PyExc_TypeError,
282 "descriptor '%V' of '%.100s' "
283 "object needs an argument",
284 descr_name((PyDescrObject *)descr), "?",
285 PyDescr_TYPE(descr)->tp_name);
286 return NULL;
287 }
288 self = PyTuple_GET_ITEM(args, 0);
Victor Stinner3249dec2011-05-01 23:19:15 +0200289 if (!_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self),
Victor Stinnerd9561312011-05-01 23:31:36 +0200290 (PyObject *)PyDescr_TYPE(descr))) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000291 PyErr_Format(PyExc_TypeError,
292 "descriptor '%V' "
293 "requires a '%.100s' object "
294 "but received a '%.100s'",
295 descr_name((PyDescrObject *)descr), "?",
296 PyDescr_TYPE(descr)->tp_name,
297 self->ob_type->tp_name);
298 return NULL;
299 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000300
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000301 func = PyWrapper_New((PyObject *)descr, self);
302 if (func == NULL)
303 return NULL;
304 args = PyTuple_GetSlice(args, 1, argc);
305 if (args == NULL) {
306 Py_DECREF(func);
307 return NULL;
308 }
309 result = PyEval_CallObjectWithKeywords(func, args, kwds);
310 Py_DECREF(args);
311 Py_DECREF(func);
312 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000313}
314
315static PyObject *
Guido van Rossum6f799372001-09-20 20:46:19 +0000316method_get_doc(PyMethodDescrObject *descr, void *closure)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000317{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000318 if (descr->d_method->ml_doc == NULL) {
319 Py_INCREF(Py_None);
320 return Py_None;
321 }
322 return PyUnicode_FromString(descr->d_method->ml_doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000323}
324
Antoine Pitrou9d574812011-12-12 13:47:25 +0100325static PyObject *
326calculate_qualname(PyDescrObject *descr)
327{
328 PyObject *type_qualname, *res;
329 _Py_IDENTIFIER(__qualname__);
330
331 if (descr->d_name == NULL || !PyUnicode_Check(descr->d_name)) {
332 PyErr_SetString(PyExc_TypeError,
333 "<descriptor>.__name__ is not a unicode object");
334 return NULL;
335 }
336
337 type_qualname = _PyObject_GetAttrId((PyObject *)descr->d_type,
338 &PyId___qualname__);
339 if (type_qualname == NULL)
340 return NULL;
341
342 if (!PyUnicode_Check(type_qualname)) {
343 PyErr_SetString(PyExc_TypeError, "<descriptor>.__objclass__."
344 "__qualname__ is not a unicode object");
345 Py_XDECREF(type_qualname);
346 return NULL;
347 }
348
349 res = PyUnicode_FromFormat("%S.%S", type_qualname, descr->d_name);
350 Py_DECREF(type_qualname);
351 return res;
352}
353
354static PyObject *
355descr_get_qualname(PyDescrObject *descr)
356{
357 if (descr->d_qualname == NULL)
358 descr->d_qualname = calculate_qualname(descr);
359 Py_XINCREF(descr->d_qualname);
360 return descr->d_qualname;
361}
362
Guido van Rossum6f799372001-09-20 20:46:19 +0000363static PyMemberDef descr_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000364 {"__objclass__", T_OBJECT, offsetof(PyDescrObject, d_type), READONLY},
365 {"__name__", T_OBJECT, offsetof(PyDescrObject, d_name), READONLY},
366 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000367};
368
Guido van Rossum32d34c82001-09-20 21:45:26 +0000369static PyGetSetDef method_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000370 {"__doc__", (getter)method_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100371 {"__qualname__", (getter)descr_get_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000372 {0}
Guido van Rossum6f799372001-09-20 20:46:19 +0000373};
374
375static PyObject *
376member_get_doc(PyMemberDescrObject *descr, void *closure)
377{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000378 if (descr->d_member->doc == NULL) {
379 Py_INCREF(Py_None);
380 return Py_None;
381 }
382 return PyUnicode_FromString(descr->d_member->doc);
Guido van Rossum6f799372001-09-20 20:46:19 +0000383}
384
Guido van Rossum32d34c82001-09-20 21:45:26 +0000385static PyGetSetDef member_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000386 {"__doc__", (getter)member_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100387 {"__qualname__", (getter)descr_get_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000388 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000389};
390
391static PyObject *
Guido van Rossum32d34c82001-09-20 21:45:26 +0000392getset_get_doc(PyGetSetDescrObject *descr, void *closure)
393{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000394 if (descr->d_getset->doc == NULL) {
395 Py_INCREF(Py_None);
396 return Py_None;
397 }
398 return PyUnicode_FromString(descr->d_getset->doc);
Guido van Rossum32d34c82001-09-20 21:45:26 +0000399}
400
401static PyGetSetDef getset_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000402 {"__doc__", (getter)getset_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100403 {"__qualname__", (getter)descr_get_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000404 {0}
Guido van Rossum32d34c82001-09-20 21:45:26 +0000405};
406
407static PyObject *
Armin Rigoc6686b72005-11-07 08:38:00 +0000408wrapperdescr_get_doc(PyWrapperDescrObject *descr, void *closure)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000409{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000410 if (descr->d_base->doc == NULL) {
411 Py_INCREF(Py_None);
412 return Py_None;
413 }
414 return PyUnicode_FromString(descr->d_base->doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000415}
416
Armin Rigoc6686b72005-11-07 08:38:00 +0000417static PyGetSetDef wrapperdescr_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000418 {"__doc__", (getter)wrapperdescr_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100419 {"__qualname__", (getter)descr_get_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000420 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000421};
422
Guido van Rossum048eb752001-10-02 21:24:57 +0000423static int
424descr_traverse(PyObject *self, visitproc visit, void *arg)
425{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000426 PyDescrObject *descr = (PyDescrObject *)self;
427 Py_VISIT(descr->d_type);
428 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +0000429}
430
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000431PyTypeObject PyMethodDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000432 PyVarObject_HEAD_INIT(&PyType_Type, 0)
433 "method_descriptor",
434 sizeof(PyMethodDescrObject),
435 0,
436 (destructor)descr_dealloc, /* tp_dealloc */
437 0, /* tp_print */
438 0, /* tp_getattr */
439 0, /* tp_setattr */
440 0, /* tp_reserved */
441 (reprfunc)method_repr, /* tp_repr */
442 0, /* tp_as_number */
443 0, /* tp_as_sequence */
444 0, /* tp_as_mapping */
445 0, /* tp_hash */
446 (ternaryfunc)methoddescr_call, /* tp_call */
447 0, /* tp_str */
448 PyObject_GenericGetAttr, /* tp_getattro */
449 0, /* tp_setattro */
450 0, /* tp_as_buffer */
451 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
452 0, /* tp_doc */
453 descr_traverse, /* tp_traverse */
454 0, /* tp_clear */
455 0, /* tp_richcompare */
456 0, /* tp_weaklistoffset */
457 0, /* tp_iter */
458 0, /* tp_iternext */
459 0, /* tp_methods */
460 descr_members, /* tp_members */
461 method_getset, /* tp_getset */
462 0, /* tp_base */
463 0, /* tp_dict */
464 (descrgetfunc)method_get, /* tp_descr_get */
465 0, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000466};
467
Guido van Rossumb6e5a0c2003-02-11 18:44:42 +0000468/* This is for METH_CLASS in C, not for "f = classmethod(f)" in Python! */
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000469PyTypeObject PyClassMethodDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000470 PyVarObject_HEAD_INIT(&PyType_Type, 0)
471 "classmethod_descriptor",
472 sizeof(PyMethodDescrObject),
473 0,
474 (destructor)descr_dealloc, /* tp_dealloc */
475 0, /* tp_print */
476 0, /* tp_getattr */
477 0, /* tp_setattr */
478 0, /* tp_reserved */
479 (reprfunc)method_repr, /* tp_repr */
480 0, /* tp_as_number */
481 0, /* tp_as_sequence */
482 0, /* tp_as_mapping */
483 0, /* tp_hash */
484 (ternaryfunc)classmethoddescr_call, /* tp_call */
485 0, /* tp_str */
486 PyObject_GenericGetAttr, /* tp_getattro */
487 0, /* tp_setattro */
488 0, /* tp_as_buffer */
489 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
490 0, /* tp_doc */
491 descr_traverse, /* tp_traverse */
492 0, /* tp_clear */
493 0, /* tp_richcompare */
494 0, /* tp_weaklistoffset */
495 0, /* tp_iter */
496 0, /* tp_iternext */
497 0, /* tp_methods */
498 descr_members, /* tp_members */
499 method_getset, /* tp_getset */
500 0, /* tp_base */
501 0, /* tp_dict */
502 (descrgetfunc)classmethod_get, /* tp_descr_get */
503 0, /* tp_descr_set */
Tim Petersbca1cbc2002-12-09 22:56:13 +0000504};
505
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000506PyTypeObject PyMemberDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000507 PyVarObject_HEAD_INIT(&PyType_Type, 0)
508 "member_descriptor",
509 sizeof(PyMemberDescrObject),
510 0,
511 (destructor)descr_dealloc, /* tp_dealloc */
512 0, /* tp_print */
513 0, /* tp_getattr */
514 0, /* tp_setattr */
515 0, /* tp_reserved */
516 (reprfunc)member_repr, /* tp_repr */
517 0, /* tp_as_number */
518 0, /* tp_as_sequence */
519 0, /* tp_as_mapping */
520 0, /* tp_hash */
521 0, /* tp_call */
522 0, /* tp_str */
523 PyObject_GenericGetAttr, /* tp_getattro */
524 0, /* tp_setattro */
525 0, /* tp_as_buffer */
526 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
527 0, /* tp_doc */
528 descr_traverse, /* tp_traverse */
529 0, /* tp_clear */
530 0, /* tp_richcompare */
531 0, /* tp_weaklistoffset */
532 0, /* tp_iter */
533 0, /* tp_iternext */
534 0, /* tp_methods */
535 descr_members, /* tp_members */
536 member_getset, /* tp_getset */
537 0, /* tp_base */
538 0, /* tp_dict */
539 (descrgetfunc)member_get, /* tp_descr_get */
540 (descrsetfunc)member_set, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000541};
542
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000543PyTypeObject PyGetSetDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000544 PyVarObject_HEAD_INIT(&PyType_Type, 0)
545 "getset_descriptor",
546 sizeof(PyGetSetDescrObject),
547 0,
548 (destructor)descr_dealloc, /* tp_dealloc */
549 0, /* tp_print */
550 0, /* tp_getattr */
551 0, /* tp_setattr */
552 0, /* tp_reserved */
553 (reprfunc)getset_repr, /* tp_repr */
554 0, /* tp_as_number */
555 0, /* tp_as_sequence */
556 0, /* tp_as_mapping */
557 0, /* tp_hash */
558 0, /* tp_call */
559 0, /* tp_str */
560 PyObject_GenericGetAttr, /* tp_getattro */
561 0, /* tp_setattro */
562 0, /* tp_as_buffer */
563 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
564 0, /* tp_doc */
565 descr_traverse, /* tp_traverse */
566 0, /* tp_clear */
567 0, /* tp_richcompare */
568 0, /* tp_weaklistoffset */
569 0, /* tp_iter */
570 0, /* tp_iternext */
571 0, /* tp_methods */
572 descr_members, /* tp_members */
573 getset_getset, /* tp_getset */
574 0, /* tp_base */
575 0, /* tp_dict */
576 (descrgetfunc)getset_get, /* tp_descr_get */
577 (descrsetfunc)getset_set, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000578};
579
Guido van Rossumf4593e02001-10-03 12:09:30 +0000580PyTypeObject PyWrapperDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000581 PyVarObject_HEAD_INIT(&PyType_Type, 0)
582 "wrapper_descriptor",
583 sizeof(PyWrapperDescrObject),
584 0,
585 (destructor)descr_dealloc, /* tp_dealloc */
586 0, /* tp_print */
587 0, /* tp_getattr */
588 0, /* tp_setattr */
589 0, /* tp_reserved */
590 (reprfunc)wrapperdescr_repr, /* tp_repr */
591 0, /* tp_as_number */
592 0, /* tp_as_sequence */
593 0, /* tp_as_mapping */
594 0, /* tp_hash */
595 (ternaryfunc)wrapperdescr_call, /* tp_call */
596 0, /* tp_str */
597 PyObject_GenericGetAttr, /* tp_getattro */
598 0, /* tp_setattro */
599 0, /* tp_as_buffer */
600 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
601 0, /* tp_doc */
602 descr_traverse, /* tp_traverse */
603 0, /* tp_clear */
604 0, /* tp_richcompare */
605 0, /* tp_weaklistoffset */
606 0, /* tp_iter */
607 0, /* tp_iternext */
608 0, /* tp_methods */
609 descr_members, /* tp_members */
610 wrapperdescr_getset, /* tp_getset */
611 0, /* tp_base */
612 0, /* tp_dict */
613 (descrgetfunc)wrapperdescr_get, /* tp_descr_get */
614 0, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000615};
616
617static PyDescrObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000618descr_new(PyTypeObject *descrtype, PyTypeObject *type, const char *name)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000619{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000620 PyDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000621
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000622 descr = (PyDescrObject *)PyType_GenericAlloc(descrtype, 0);
623 if (descr != NULL) {
624 Py_XINCREF(type);
625 descr->d_type = type;
626 descr->d_name = PyUnicode_InternFromString(name);
627 if (descr->d_name == NULL) {
628 Py_DECREF(descr);
629 descr = NULL;
630 }
Benjamin Petersonf2fe7f02011-12-17 08:02:20 -0500631 else {
632 descr->d_qualname = NULL;
633 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000634 }
635 return descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000636}
637
638PyObject *
639PyDescr_NewMethod(PyTypeObject *type, PyMethodDef *method)
640{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000641 PyMethodDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000642
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000643 descr = (PyMethodDescrObject *)descr_new(&PyMethodDescr_Type,
644 type, method->ml_name);
645 if (descr != NULL)
646 descr->d_method = method;
647 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000648}
649
650PyObject *
Tim Petersbca1cbc2002-12-09 22:56:13 +0000651PyDescr_NewClassMethod(PyTypeObject *type, PyMethodDef *method)
652{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000653 PyMethodDescrObject *descr;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000654
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000655 descr = (PyMethodDescrObject *)descr_new(&PyClassMethodDescr_Type,
656 type, method->ml_name);
657 if (descr != NULL)
658 descr->d_method = method;
659 return (PyObject *)descr;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000660}
661
662PyObject *
Guido van Rossum6f799372001-09-20 20:46:19 +0000663PyDescr_NewMember(PyTypeObject *type, PyMemberDef *member)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000664{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000665 PyMemberDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000666
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000667 descr = (PyMemberDescrObject *)descr_new(&PyMemberDescr_Type,
668 type, member->name);
669 if (descr != NULL)
670 descr->d_member = member;
671 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000672}
673
674PyObject *
Guido van Rossum32d34c82001-09-20 21:45:26 +0000675PyDescr_NewGetSet(PyTypeObject *type, PyGetSetDef *getset)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000676{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000677 PyGetSetDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000678
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000679 descr = (PyGetSetDescrObject *)descr_new(&PyGetSetDescr_Type,
680 type, getset->name);
681 if (descr != NULL)
682 descr->d_getset = getset;
683 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000684}
685
686PyObject *
687PyDescr_NewWrapper(PyTypeObject *type, struct wrapperbase *base, void *wrapped)
688{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000689 PyWrapperDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000690
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000691 descr = (PyWrapperDescrObject *)descr_new(&PyWrapperDescr_Type,
692 type, base->name);
693 if (descr != NULL) {
694 descr->d_base = base;
695 descr->d_wrapped = wrapped;
696 }
697 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000698}
699
Tim Peters6d6c1a32001-08-02 04:15:00 +0000700
Victor Stinner0db176f2012-04-16 00:16:30 +0200701/* --- mappingproxy: read-only proxy for mappings --- */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000702
703/* This has no reason to be in this file except that adding new files is a
704 bit of a pain */
705
706typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000707 PyObject_HEAD
Victor Stinner0db176f2012-04-16 00:16:30 +0200708 PyObject *mapping;
709} mappingproxyobject;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000710
Martin v. Löwis18e16552006-02-15 17:27:45 +0000711static Py_ssize_t
Victor Stinner0db176f2012-04-16 00:16:30 +0200712mappingproxy_len(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000713{
Victor Stinner0db176f2012-04-16 00:16:30 +0200714 return PyObject_Size(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000715}
716
717static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200718mappingproxy_getitem(mappingproxyobject *pp, PyObject *key)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000719{
Victor Stinner0db176f2012-04-16 00:16:30 +0200720 return PyObject_GetItem(pp->mapping, key);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000721}
722
Victor Stinner0db176f2012-04-16 00:16:30 +0200723static PyMappingMethods mappingproxy_as_mapping = {
724 (lenfunc)mappingproxy_len, /* mp_length */
725 (binaryfunc)mappingproxy_getitem, /* mp_subscript */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000726 0, /* mp_ass_subscript */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000727};
728
729static int
Victor Stinner0db176f2012-04-16 00:16:30 +0200730mappingproxy_contains(mappingproxyobject *pp, PyObject *key)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000731{
Victor Stinner0db176f2012-04-16 00:16:30 +0200732 if (PyDict_CheckExact(pp->mapping))
733 return PyDict_Contains(pp->mapping, key);
734 else
735 return PySequence_Contains(pp->mapping, key);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000736}
737
Victor Stinner0db176f2012-04-16 00:16:30 +0200738static PySequenceMethods mappingproxy_as_sequence = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000739 0, /* sq_length */
740 0, /* sq_concat */
741 0, /* sq_repeat */
742 0, /* sq_item */
743 0, /* sq_slice */
744 0, /* sq_ass_item */
745 0, /* sq_ass_slice */
Victor Stinner0db176f2012-04-16 00:16:30 +0200746 (objobjproc)mappingproxy_contains, /* sq_contains */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000747 0, /* sq_inplace_concat */
748 0, /* sq_inplace_repeat */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000749};
750
751static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200752mappingproxy_get(mappingproxyobject *pp, PyObject *args)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000753{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000754 PyObject *key, *def = Py_None;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200755 _Py_IDENTIFIER(get);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000756
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000757 if (!PyArg_UnpackTuple(args, "get", 1, 2, &key, &def))
758 return NULL;
Victor Stinner0db176f2012-04-16 00:16:30 +0200759 return _PyObject_CallMethodId(pp->mapping, &PyId_get, "(OO)", key, def);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000760}
761
762static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200763mappingproxy_keys(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000764{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200765 _Py_IDENTIFIER(keys);
Victor Stinner0db176f2012-04-16 00:16:30 +0200766 return _PyObject_CallMethodId(pp->mapping, &PyId_keys, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000767}
768
769static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200770mappingproxy_values(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000771{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200772 _Py_IDENTIFIER(values);
Victor Stinner0db176f2012-04-16 00:16:30 +0200773 return _PyObject_CallMethodId(pp->mapping, &PyId_values, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000774}
775
776static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200777mappingproxy_items(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000778{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200779 _Py_IDENTIFIER(items);
Victor Stinner0db176f2012-04-16 00:16:30 +0200780 return _PyObject_CallMethodId(pp->mapping, &PyId_items, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000781}
782
783static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200784mappingproxy_copy(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000785{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200786 _Py_IDENTIFIER(copy);
Victor Stinner0db176f2012-04-16 00:16:30 +0200787 return _PyObject_CallMethodId(pp->mapping, &PyId_copy, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000788}
789
Victor Stinner0db176f2012-04-16 00:16:30 +0200790/* WARNING: mappingproxy methods must not give access
791 to the underlying mapping */
792
793static PyMethodDef mappingproxy_methods[] = {
794 {"get", (PyCFunction)mappingproxy_get, METH_VARARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000795 PyDoc_STR("D.get(k[,d]) -> D[k] if k in D, else d."
Victor Stinner0db176f2012-04-16 00:16:30 +0200796 " d defaults to None.")},
797 {"keys", (PyCFunction)mappingproxy_keys, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000798 PyDoc_STR("D.keys() -> list of D's keys")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200799 {"values", (PyCFunction)mappingproxy_values, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000800 PyDoc_STR("D.values() -> list of D's values")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200801 {"items", (PyCFunction)mappingproxy_items, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000802 PyDoc_STR("D.items() -> list of D's (key, value) pairs, as 2-tuples")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200803 {"copy", (PyCFunction)mappingproxy_copy, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000804 PyDoc_STR("D.copy() -> a shallow copy of D")},
805 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000806};
807
808static void
Victor Stinner0db176f2012-04-16 00:16:30 +0200809mappingproxy_dealloc(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000810{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000811 _PyObject_GC_UNTRACK(pp);
Victor Stinner0db176f2012-04-16 00:16:30 +0200812 Py_DECREF(pp->mapping);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000813 PyObject_GC_Del(pp);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000814}
815
816static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200817mappingproxy_getiter(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000818{
Victor Stinner0db176f2012-04-16 00:16:30 +0200819 return PyObject_GetIter(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000820}
821
Neil Schemenauer26775122001-10-21 22:26:43 +0000822static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200823mappingproxy_str(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000824{
Victor Stinner0db176f2012-04-16 00:16:30 +0200825 return PyObject_Str(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000826}
827
Ezio Melottiac53ab62010-12-18 14:59:43 +0000828static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200829mappingproxy_repr(mappingproxyobject *pp)
Ezio Melottiac53ab62010-12-18 14:59:43 +0000830{
Victor Stinner0db176f2012-04-16 00:16:30 +0200831 return PyUnicode_FromFormat("mappingproxy(%R)", pp->mapping);
Ezio Melottiac53ab62010-12-18 14:59:43 +0000832}
833
Guido van Rossum048eb752001-10-02 21:24:57 +0000834static int
Victor Stinner0db176f2012-04-16 00:16:30 +0200835mappingproxy_traverse(PyObject *self, visitproc visit, void *arg)
Guido van Rossum048eb752001-10-02 21:24:57 +0000836{
Victor Stinner0db176f2012-04-16 00:16:30 +0200837 mappingproxyobject *pp = (mappingproxyobject *)self;
838 Py_VISIT(pp->mapping);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000839 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +0000840}
841
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000842static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200843mappingproxy_richcompare(mappingproxyobject *v, PyObject *w, int op)
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000844{
Victor Stinner0db176f2012-04-16 00:16:30 +0200845 return PyObject_RichCompare(v->mapping, w, op);
846}
847
848static int
849mappingproxy_check_mapping(PyObject *mapping)
850{
851 if (!PyMapping_Check(mapping)
852 || PyList_Check(mapping)
853 || PyTuple_Check(mapping)) {
854 PyErr_Format(PyExc_TypeError,
855 "mappingproxy() argument must be a mapping, not %s",
856 Py_TYPE(mapping)->tp_name);
857 return -1;
858 }
859 return 0;
860}
861
862static PyObject*
863mappingproxy_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
864{
865 static char *kwlist[] = {"mapping", NULL};
866 PyObject *mapping;
867 mappingproxyobject *mappingproxy;
868
869 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O:mappingproxy",
870 kwlist, &mapping))
871 return NULL;
872
873 if (mappingproxy_check_mapping(mapping) == -1)
874 return NULL;
875
876 mappingproxy = PyObject_GC_New(mappingproxyobject, &PyDictProxy_Type);
877 if (mappingproxy == NULL)
878 return NULL;
879 Py_INCREF(mapping);
880 mappingproxy->mapping = mapping;
881 _PyObject_GC_TRACK(mappingproxy);
882 return (PyObject *)mappingproxy;
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000883}
884
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000885PyTypeObject PyDictProxy_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000886 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Victor Stinner0db176f2012-04-16 00:16:30 +0200887 "mappingproxy", /* tp_name */
888 sizeof(mappingproxyobject), /* tp_basicsize */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000889 0, /* tp_itemsize */
890 /* methods */
Victor Stinner0db176f2012-04-16 00:16:30 +0200891 (destructor)mappingproxy_dealloc, /* tp_dealloc */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000892 0, /* tp_print */
893 0, /* tp_getattr */
894 0, /* tp_setattr */
895 0, /* tp_reserved */
Victor Stinner0db176f2012-04-16 00:16:30 +0200896 (reprfunc)mappingproxy_repr, /* tp_repr */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000897 0, /* tp_as_number */
Victor Stinner0db176f2012-04-16 00:16:30 +0200898 &mappingproxy_as_sequence, /* tp_as_sequence */
899 &mappingproxy_as_mapping, /* tp_as_mapping */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000900 0, /* tp_hash */
901 0, /* tp_call */
Victor Stinner0db176f2012-04-16 00:16:30 +0200902 (reprfunc)mappingproxy_str, /* tp_str */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000903 PyObject_GenericGetAttr, /* tp_getattro */
904 0, /* tp_setattro */
905 0, /* tp_as_buffer */
906 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
907 0, /* tp_doc */
Victor Stinner0db176f2012-04-16 00:16:30 +0200908 mappingproxy_traverse, /* tp_traverse */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000909 0, /* tp_clear */
Victor Stinner0db176f2012-04-16 00:16:30 +0200910 (richcmpfunc)mappingproxy_richcompare, /* tp_richcompare */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000911 0, /* tp_weaklistoffset */
Victor Stinner0db176f2012-04-16 00:16:30 +0200912 (getiterfunc)mappingproxy_getiter, /* tp_iter */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000913 0, /* tp_iternext */
Victor Stinner0db176f2012-04-16 00:16:30 +0200914 mappingproxy_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000915 0, /* tp_members */
916 0, /* tp_getset */
917 0, /* tp_base */
918 0, /* tp_dict */
919 0, /* tp_descr_get */
920 0, /* tp_descr_set */
Victor Stinner0db176f2012-04-16 00:16:30 +0200921 0, /* tp_dictoffset */
922 0, /* tp_init */
923 0, /* tp_alloc */
924 mappingproxy_new, /* tp_new */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000925};
926
927PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200928PyDictProxy_New(PyObject *mapping)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000929{
Victor Stinner0db176f2012-04-16 00:16:30 +0200930 mappingproxyobject *pp;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000931
Victor Stinner0db176f2012-04-16 00:16:30 +0200932 if (mappingproxy_check_mapping(mapping) == -1)
933 return NULL;
934
935 pp = PyObject_GC_New(mappingproxyobject, &PyDictProxy_Type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000936 if (pp != NULL) {
Victor Stinner0db176f2012-04-16 00:16:30 +0200937 Py_INCREF(mapping);
938 pp->mapping = mapping;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000939 _PyObject_GC_TRACK(pp);
940 }
941 return (PyObject *)pp;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000942}
943
944
945/* --- Wrapper object for "slot" methods --- */
946
947/* This has no reason to be in this file except that adding new files is a
948 bit of a pain */
949
950typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000951 PyObject_HEAD
952 PyWrapperDescrObject *descr;
953 PyObject *self;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000954} wrapperobject;
955
Benjamin Petersoneff61f62011-09-01 16:32:31 -0400956#define Wrapper_Check(v) (Py_TYPE(v) == &_PyMethodWrapper_Type)
Mark Dickinson211c6252009-02-01 10:28:51 +0000957
Tim Peters6d6c1a32001-08-02 04:15:00 +0000958static void
959wrapper_dealloc(wrapperobject *wp)
960{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000961 PyObject_GC_UnTrack(wp);
962 Py_TRASHCAN_SAFE_BEGIN(wp)
963 Py_XDECREF(wp->descr);
964 Py_XDECREF(wp->self);
965 PyObject_GC_Del(wp);
966 Py_TRASHCAN_SAFE_END(wp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000967}
968
Mark Dickinson211c6252009-02-01 10:28:51 +0000969#define TEST_COND(cond) ((cond) ? Py_True : Py_False)
970
971static PyObject *
972wrapper_richcompare(PyObject *a, PyObject *b, int op)
Armin Rigoc6686b72005-11-07 08:38:00 +0000973{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000974 int result;
975 PyObject *v;
976 PyWrapperDescrObject *a_descr, *b_descr;
Mark Dickinson211c6252009-02-01 10:28:51 +0000977
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000978 assert(a != NULL && b != NULL);
Mark Dickinson211c6252009-02-01 10:28:51 +0000979
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000980 /* both arguments should be wrapperobjects */
981 if (!Wrapper_Check(a) || !Wrapper_Check(b)) {
982 v = Py_NotImplemented;
983 Py_INCREF(v);
984 return v;
985 }
Mark Dickinson211c6252009-02-01 10:28:51 +0000986
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000987 /* compare by descriptor address; if the descriptors are the same,
988 compare by the objects they're bound to */
989 a_descr = ((wrapperobject *)a)->descr;
990 b_descr = ((wrapperobject *)b)->descr;
991 if (a_descr == b_descr) {
992 a = ((wrapperobject *)a)->self;
993 b = ((wrapperobject *)b)->self;
994 return PyObject_RichCompare(a, b, op);
995 }
Mark Dickinson211c6252009-02-01 10:28:51 +0000996
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000997 result = a_descr - b_descr;
998 switch (op) {
999 case Py_EQ:
1000 v = TEST_COND(result == 0);
1001 break;
1002 case Py_NE:
1003 v = TEST_COND(result != 0);
1004 break;
1005 case Py_LE:
1006 v = TEST_COND(result <= 0);
1007 break;
1008 case Py_GE:
1009 v = TEST_COND(result >= 0);
1010 break;
1011 case Py_LT:
1012 v = TEST_COND(result < 0);
1013 break;
1014 case Py_GT:
1015 v = TEST_COND(result > 0);
1016 break;
1017 default:
1018 PyErr_BadArgument();
1019 return NULL;
1020 }
1021 Py_INCREF(v);
1022 return v;
Armin Rigoc6686b72005-11-07 08:38:00 +00001023}
1024
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001025static Py_hash_t
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001026wrapper_hash(wrapperobject *wp)
1027{
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001028 Py_hash_t x, y;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001029 x = _Py_HashPointer(wp->descr);
1030 if (x == -1)
1031 return -1;
1032 y = PyObject_Hash(wp->self);
1033 if (y == -1)
1034 return -1;
1035 x = x ^ y;
1036 if (x == -1)
1037 x = -2;
1038 return x;
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001039}
1040
Armin Rigoc6686b72005-11-07 08:38:00 +00001041static PyObject *
1042wrapper_repr(wrapperobject *wp)
1043{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001044 return PyUnicode_FromFormat("<method-wrapper '%s' of %s object at %p>",
1045 wp->descr->d_base->name,
1046 wp->self->ob_type->tp_name,
1047 wp->self);
Armin Rigoc6686b72005-11-07 08:38:00 +00001048}
1049
1050static PyMemberDef wrapper_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001051 {"__self__", T_OBJECT, offsetof(wrapperobject, self), READONLY},
1052 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001053};
1054
1055static PyObject *
Armin Rigoc6686b72005-11-07 08:38:00 +00001056wrapper_objclass(wrapperobject *wp)
1057{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001058 PyObject *c = (PyObject *)PyDescr_TYPE(wp->descr);
Armin Rigoc6686b72005-11-07 08:38:00 +00001059
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001060 Py_INCREF(c);
1061 return c;
Armin Rigoc6686b72005-11-07 08:38:00 +00001062}
1063
1064static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001065wrapper_name(wrapperobject *wp)
1066{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001067 const char *s = wp->descr->d_base->name;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001068
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001069 return PyUnicode_FromString(s);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001070}
1071
1072static PyObject *
1073wrapper_doc(wrapperobject *wp)
1074{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001075 const char *s = wp->descr->d_base->doc;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001076
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001077 if (s == NULL) {
1078 Py_INCREF(Py_None);
1079 return Py_None;
1080 }
1081 else {
1082 return PyUnicode_FromString(s);
1083 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001084}
1085
Antoine Pitrou9d574812011-12-12 13:47:25 +01001086static PyObject *
1087wrapper_qualname(wrapperobject *wp)
1088{
1089 return descr_get_qualname((PyDescrObject *)wp->descr);
1090}
1091
Guido van Rossum32d34c82001-09-20 21:45:26 +00001092static PyGetSetDef wrapper_getsets[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001093 {"__objclass__", (getter)wrapper_objclass},
1094 {"__name__", (getter)wrapper_name},
Antoine Pitrou9d574812011-12-12 13:47:25 +01001095 {"__qualname__", (getter)wrapper_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001096 {"__doc__", (getter)wrapper_doc},
1097 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001098};
1099
1100static PyObject *
1101wrapper_call(wrapperobject *wp, PyObject *args, PyObject *kwds)
1102{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001103 wrapperfunc wrapper = wp->descr->d_base->wrapper;
1104 PyObject *self = wp->self;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001105
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001106 if (wp->descr->d_base->flags & PyWrapperFlag_KEYWORDS) {
1107 wrapperfunc_kwds wk = (wrapperfunc_kwds)wrapper;
1108 return (*wk)(self, args, wp->descr->d_wrapped, kwds);
1109 }
Guido van Rossumc8e56452001-10-22 00:43:43 +00001110
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001111 if (kwds != NULL && (!PyDict_Check(kwds) || PyDict_Size(kwds) != 0)) {
1112 PyErr_Format(PyExc_TypeError,
1113 "wrapper %s doesn't take keyword arguments",
1114 wp->descr->d_base->name);
1115 return NULL;
1116 }
1117 return (*wrapper)(self, args, wp->descr->d_wrapped);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001118}
1119
Guido van Rossum048eb752001-10-02 21:24:57 +00001120static int
1121wrapper_traverse(PyObject *self, visitproc visit, void *arg)
1122{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001123 wrapperobject *wp = (wrapperobject *)self;
1124 Py_VISIT(wp->descr);
1125 Py_VISIT(wp->self);
1126 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +00001127}
1128
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001129PyTypeObject _PyMethodWrapper_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001130 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1131 "method-wrapper", /* tp_name */
1132 sizeof(wrapperobject), /* tp_basicsize */
1133 0, /* tp_itemsize */
1134 /* methods */
1135 (destructor)wrapper_dealloc, /* tp_dealloc */
1136 0, /* tp_print */
1137 0, /* tp_getattr */
1138 0, /* tp_setattr */
1139 0, /* tp_reserved */
1140 (reprfunc)wrapper_repr, /* tp_repr */
1141 0, /* tp_as_number */
1142 0, /* tp_as_sequence */
1143 0, /* tp_as_mapping */
1144 (hashfunc)wrapper_hash, /* tp_hash */
1145 (ternaryfunc)wrapper_call, /* tp_call */
1146 0, /* tp_str */
1147 PyObject_GenericGetAttr, /* tp_getattro */
1148 0, /* tp_setattro */
1149 0, /* tp_as_buffer */
1150 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
1151 0, /* tp_doc */
1152 wrapper_traverse, /* tp_traverse */
1153 0, /* tp_clear */
1154 wrapper_richcompare, /* tp_richcompare */
1155 0, /* tp_weaklistoffset */
1156 0, /* tp_iter */
1157 0, /* tp_iternext */
1158 0, /* tp_methods */
1159 wrapper_members, /* tp_members */
1160 wrapper_getsets, /* tp_getset */
1161 0, /* tp_base */
1162 0, /* tp_dict */
1163 0, /* tp_descr_get */
1164 0, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001165};
1166
1167PyObject *
1168PyWrapper_New(PyObject *d, PyObject *self)
1169{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001170 wrapperobject *wp;
1171 PyWrapperDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001172
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001173 assert(PyObject_TypeCheck(d, &PyWrapperDescr_Type));
1174 descr = (PyWrapperDescrObject *)d;
Victor Stinner3249dec2011-05-01 23:19:15 +02001175 assert(_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self),
Victor Stinnerd9561312011-05-01 23:31:36 +02001176 (PyObject *)PyDescr_TYPE(descr)));
Tim Peters6d6c1a32001-08-02 04:15:00 +00001177
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001178 wp = PyObject_GC_New(wrapperobject, &_PyMethodWrapper_Type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001179 if (wp != NULL) {
1180 Py_INCREF(descr);
1181 wp->descr = descr;
1182 Py_INCREF(self);
1183 wp->self = self;
1184 _PyObject_GC_TRACK(wp);
1185 }
1186 return (PyObject *)wp;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001187}
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001188
1189
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001190/* A built-in 'property' type */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001191
1192/*
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001193 class property(object):
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001194
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001195 def __init__(self, fget=None, fset=None, fdel=None, doc=None):
1196 if doc is None and fget is not None and hasattr(fget, "__doc__"):
1197 doc = fget.__doc__
1198 self.__get = fget
1199 self.__set = fset
1200 self.__del = fdel
1201 self.__doc__ = doc
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001202
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001203 def __get__(self, inst, type=None):
1204 if inst is None:
1205 return self
1206 if self.__get is None:
1207 raise AttributeError, "unreadable attribute"
1208 return self.__get(inst)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001209
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001210 def __set__(self, inst, value):
1211 if self.__set is None:
1212 raise AttributeError, "can't set attribute"
1213 return self.__set(inst, value)
Guido van Rossumba2485f2001-12-10 18:03:34 +00001214
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001215 def __delete__(self, inst):
1216 if self.__del is None:
1217 raise AttributeError, "can't delete attribute"
1218 return self.__del(inst)
Guido van Rossumba2485f2001-12-10 18:03:34 +00001219
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001220*/
1221
1222typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001223 PyObject_HEAD
1224 PyObject *prop_get;
1225 PyObject *prop_set;
1226 PyObject *prop_del;
1227 PyObject *prop_doc;
1228 int getter_doc;
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001229} propertyobject;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001230
Christian Heimes0449f632007-12-15 01:27:15 +00001231static PyObject * property_copy(PyObject *, PyObject *, PyObject *,
Benjamin Peterson93964832010-06-28 03:07:10 +00001232 PyObject *);
Christian Heimes0449f632007-12-15 01:27:15 +00001233
Tim Peters66c1a522001-09-24 21:17:50 +00001234static PyMemberDef property_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001235 {"fget", T_OBJECT, offsetof(propertyobject, prop_get), READONLY},
1236 {"fset", T_OBJECT, offsetof(propertyobject, prop_set), READONLY},
1237 {"fdel", T_OBJECT, offsetof(propertyobject, prop_del), READONLY},
1238 {"__doc__", T_OBJECT, offsetof(propertyobject, prop_doc), READONLY},
1239 {0}
Tim Peters66c1a522001-09-24 21:17:50 +00001240};
1241
Christian Heimes0449f632007-12-15 01:27:15 +00001242
Guido van Rossum58da9312007-11-10 23:39:45 +00001243PyDoc_STRVAR(getter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001244 "Descriptor to change the getter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001245
Neal Norwitz32dde222008-04-15 06:43:13 +00001246static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001247property_getter(PyObject *self, PyObject *getter)
1248{
Benjamin Peterson93964832010-06-28 03:07:10 +00001249 return property_copy(self, getter, NULL, NULL);
Guido van Rossum58da9312007-11-10 23:39:45 +00001250}
1251
Christian Heimes0449f632007-12-15 01:27:15 +00001252
Guido van Rossum58da9312007-11-10 23:39:45 +00001253PyDoc_STRVAR(setter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001254 "Descriptor to change the setter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001255
Neal Norwitz32dde222008-04-15 06:43:13 +00001256static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001257property_setter(PyObject *self, PyObject *setter)
1258{
Benjamin Peterson93964832010-06-28 03:07:10 +00001259 return property_copy(self, NULL, setter, NULL);
Guido van Rossum58da9312007-11-10 23:39:45 +00001260}
1261
Christian Heimes0449f632007-12-15 01:27:15 +00001262
Guido van Rossum58da9312007-11-10 23:39:45 +00001263PyDoc_STRVAR(deleter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001264 "Descriptor to change the deleter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001265
Neal Norwitz32dde222008-04-15 06:43:13 +00001266static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001267property_deleter(PyObject *self, PyObject *deleter)
1268{
Benjamin Peterson93964832010-06-28 03:07:10 +00001269 return property_copy(self, NULL, NULL, deleter);
Guido van Rossum58da9312007-11-10 23:39:45 +00001270}
1271
1272
Guido van Rossum58da9312007-11-10 23:39:45 +00001273static PyMethodDef property_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001274 {"getter", property_getter, METH_O, getter_doc},
1275 {"setter", property_setter, METH_O, setter_doc},
1276 {"deleter", property_deleter, METH_O, deleter_doc},
1277 {0}
Guido van Rossum58da9312007-11-10 23:39:45 +00001278};
1279
Tim Peters66c1a522001-09-24 21:17:50 +00001280
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001281static void
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001282property_dealloc(PyObject *self)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001283{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001284 propertyobject *gs = (propertyobject *)self;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001285
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001286 _PyObject_GC_UNTRACK(self);
1287 Py_XDECREF(gs->prop_get);
1288 Py_XDECREF(gs->prop_set);
1289 Py_XDECREF(gs->prop_del);
1290 Py_XDECREF(gs->prop_doc);
1291 self->ob_type->tp_free(self);
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001292}
1293
1294static PyObject *
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001295property_descr_get(PyObject *self, PyObject *obj, PyObject *type)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001296{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001297 propertyobject *gs = (propertyobject *)self;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001298
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001299 if (obj == NULL || obj == Py_None) {
1300 Py_INCREF(self);
1301 return self;
1302 }
1303 if (gs->prop_get == NULL) {
1304 PyErr_SetString(PyExc_AttributeError, "unreadable attribute");
1305 return NULL;
1306 }
Benjamin Peterson9b955de2010-12-07 04:04:02 +00001307 return PyObject_CallFunctionObjArgs(gs->prop_get, obj, NULL);
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001308}
1309
1310static int
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001311property_descr_set(PyObject *self, PyObject *obj, PyObject *value)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001312{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001313 propertyobject *gs = (propertyobject *)self;
1314 PyObject *func, *res;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001315
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001316 if (value == NULL)
1317 func = gs->prop_del;
1318 else
1319 func = gs->prop_set;
1320 if (func == NULL) {
1321 PyErr_SetString(PyExc_AttributeError,
1322 value == NULL ?
1323 "can't delete attribute" :
1324 "can't set attribute");
1325 return -1;
1326 }
1327 if (value == NULL)
Benjamin Peterson9b955de2010-12-07 04:04:02 +00001328 res = PyObject_CallFunctionObjArgs(func, obj, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001329 else
Benjamin Peterson9b955de2010-12-07 04:04:02 +00001330 res = PyObject_CallFunctionObjArgs(func, obj, value, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001331 if (res == NULL)
1332 return -1;
1333 Py_DECREF(res);
1334 return 0;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001335}
1336
Christian Heimes0449f632007-12-15 01:27:15 +00001337static PyObject *
Benjamin Peterson93964832010-06-28 03:07:10 +00001338property_copy(PyObject *old, PyObject *get, PyObject *set, PyObject *del)
Christian Heimes0449f632007-12-15 01:27:15 +00001339{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001340 propertyobject *pold = (propertyobject *)old;
Benjamin Peterson93964832010-06-28 03:07:10 +00001341 PyObject *new, *type, *doc;
Christian Heimes0449f632007-12-15 01:27:15 +00001342
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001343 type = PyObject_Type(old);
1344 if (type == NULL)
1345 return NULL;
Christian Heimes0449f632007-12-15 01:27:15 +00001346
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001347 if (get == NULL || get == Py_None) {
1348 Py_XDECREF(get);
1349 get = pold->prop_get ? pold->prop_get : Py_None;
1350 }
1351 if (set == NULL || set == Py_None) {
1352 Py_XDECREF(set);
1353 set = pold->prop_set ? pold->prop_set : Py_None;
1354 }
1355 if (del == NULL || del == Py_None) {
1356 Py_XDECREF(del);
1357 del = pold->prop_del ? pold->prop_del : Py_None;
1358 }
Benjamin Peterson93964832010-06-28 03:07:10 +00001359 if (pold->getter_doc && get != Py_None) {
1360 /* make _init use __doc__ from getter */
1361 doc = Py_None;
1362 }
1363 else {
1364 doc = pold->prop_doc ? pold->prop_doc : Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001365 }
R. David Murrayb18500d2009-05-04 22:59:07 +00001366
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001367 new = PyObject_CallFunction(type, "OOOO", get, set, del, doc);
1368 Py_DECREF(type);
1369 if (new == NULL)
1370 return NULL;
1371 return new;
Christian Heimes0449f632007-12-15 01:27:15 +00001372}
1373
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001374static int
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001375property_init(PyObject *self, PyObject *args, PyObject *kwds)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001376{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001377 PyObject *get = NULL, *set = NULL, *del = NULL, *doc = NULL;
1378 static char *kwlist[] = {"fget", "fset", "fdel", "doc", 0};
1379 propertyobject *prop = (propertyobject *)self;
Tim Peters66c1a522001-09-24 21:17:50 +00001380
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001381 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OOOO:property",
1382 kwlist, &get, &set, &del, &doc))
1383 return -1;
Tim Peters66c1a522001-09-24 21:17:50 +00001384
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001385 if (get == Py_None)
1386 get = NULL;
1387 if (set == Py_None)
1388 set = NULL;
1389 if (del == Py_None)
1390 del = NULL;
Tim Peters66c1a522001-09-24 21:17:50 +00001391
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001392 Py_XINCREF(get);
1393 Py_XINCREF(set);
1394 Py_XINCREF(del);
1395 Py_XINCREF(doc);
Christian Heimes0449f632007-12-15 01:27:15 +00001396
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001397 prop->prop_get = get;
1398 prop->prop_set = set;
1399 prop->prop_del = del;
1400 prop->prop_doc = doc;
1401 prop->getter_doc = 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001402
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001403 /* if no docstring given and the getter has one, use that one */
1404 if ((doc == NULL || doc == Py_None) && get != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001405 _Py_IDENTIFIER(__doc__);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02001406 PyObject *get_doc = _PyObject_GetAttrId(get, &PyId___doc__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001407 if (get_doc) {
1408 if (Py_TYPE(self) == &PyProperty_Type) {
1409 Py_XDECREF(prop->prop_doc);
1410 prop->prop_doc = get_doc;
1411 }
1412 else {
1413 /* If this is a property subclass, put __doc__
1414 in dict of the subclass instance instead,
1415 otherwise it gets shadowed by __doc__ in the
1416 class's dict. */
Martin v. Löwis1c67dd92011-10-14 15:16:45 +02001417 int err = _PyObject_SetAttrId(self, &PyId___doc__, get_doc);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001418 Py_DECREF(get_doc);
1419 if (err < 0)
1420 return -1;
1421 }
1422 prop->getter_doc = 1;
1423 }
1424 else if (PyErr_ExceptionMatches(PyExc_Exception)) {
1425 PyErr_Clear();
1426 }
1427 else {
1428 return -1;
1429 }
1430 }
1431
1432 return 0;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001433}
1434
Benjamin Petersonbfebb7b2011-12-15 15:34:02 -05001435static PyObject *
1436property_get___isabstractmethod__(propertyobject *prop, void *closure)
1437{
1438 int res = _PyObject_IsAbstract(prop->prop_get);
1439 if (res == -1) {
1440 return NULL;
1441 }
1442 else if (res) {
1443 Py_RETURN_TRUE;
1444 }
1445
1446 res = _PyObject_IsAbstract(prop->prop_set);
1447 if (res == -1) {
1448 return NULL;
1449 }
1450 else if (res) {
1451 Py_RETURN_TRUE;
1452 }
1453
1454 res = _PyObject_IsAbstract(prop->prop_del);
1455 if (res == -1) {
1456 return NULL;
1457 }
1458 else if (res) {
1459 Py_RETURN_TRUE;
1460 }
1461 Py_RETURN_FALSE;
1462}
1463
1464static PyGetSetDef property_getsetlist[] = {
1465 {"__isabstractmethod__",
1466 (getter)property_get___isabstractmethod__, NULL,
1467 NULL,
1468 NULL},
1469 {NULL} /* Sentinel */
1470};
1471
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001472PyDoc_STRVAR(property_doc,
Tim Peters66c1a522001-09-24 21:17:50 +00001473"property(fget=None, fset=None, fdel=None, doc=None) -> property attribute\n"
1474"\n"
1475"fget is a function to be used for getting an attribute value, and likewise\n"
1476"fset is a function for setting, and fdel a function for del'ing, an\n"
1477"attribute. Typical use is to define a managed attribute x:\n"
Guido van Rossum91c0d8a2001-08-24 09:55:51 +00001478"class C(object):\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001479" def getx(self): return self._x\n"
1480" def setx(self, value): self._x = value\n"
1481" def delx(self): del self._x\n"
1482" x = property(getx, setx, delx, \"I'm the 'x' property.\")\n"
1483"\n"
1484"Decorators make defining new properties or modifying existing ones easy:\n"
1485"class C(object):\n"
1486" @property\n"
1487" def x(self): return self._x\n"
1488" @x.setter\n"
1489" def x(self, value): self._x = value\n"
1490" @x.deleter\n"
1491" def x(self): del self._x\n"
1492);
Guido van Rossum91c0d8a2001-08-24 09:55:51 +00001493
Guido van Rossum048eb752001-10-02 21:24:57 +00001494static int
1495property_traverse(PyObject *self, visitproc visit, void *arg)
1496{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001497 propertyobject *pp = (propertyobject *)self;
1498 Py_VISIT(pp->prop_get);
1499 Py_VISIT(pp->prop_set);
1500 Py_VISIT(pp->prop_del);
1501 Py_VISIT(pp->prop_doc);
1502 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +00001503}
1504
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001505PyTypeObject PyProperty_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001506 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1507 "property", /* tp_name */
1508 sizeof(propertyobject), /* tp_basicsize */
1509 0, /* tp_itemsize */
1510 /* methods */
1511 property_dealloc, /* tp_dealloc */
1512 0, /* tp_print */
1513 0, /* tp_getattr */
1514 0, /* tp_setattr */
1515 0, /* tp_reserved */
1516 0, /* tp_repr */
1517 0, /* tp_as_number */
1518 0, /* tp_as_sequence */
1519 0, /* tp_as_mapping */
1520 0, /* tp_hash */
1521 0, /* tp_call */
1522 0, /* tp_str */
1523 PyObject_GenericGetAttr, /* tp_getattro */
1524 0, /* tp_setattro */
1525 0, /* tp_as_buffer */
1526 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
1527 Py_TPFLAGS_BASETYPE, /* tp_flags */
1528 property_doc, /* tp_doc */
1529 property_traverse, /* tp_traverse */
1530 0, /* tp_clear */
1531 0, /* tp_richcompare */
1532 0, /* tp_weaklistoffset */
1533 0, /* tp_iter */
1534 0, /* tp_iternext */
1535 property_methods, /* tp_methods */
1536 property_members, /* tp_members */
Benjamin Petersonbfebb7b2011-12-15 15:34:02 -05001537 property_getsetlist, /* tp_getset */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001538 0, /* tp_base */
1539 0, /* tp_dict */
1540 property_descr_get, /* tp_descr_get */
1541 property_descr_set, /* tp_descr_set */
1542 0, /* tp_dictoffset */
1543 property_init, /* tp_init */
1544 PyType_GenericAlloc, /* tp_alloc */
1545 PyType_GenericNew, /* tp_new */
1546 PyObject_GC_Del, /* tp_free */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001547};