blob: ce1c71beb2c768a1d78d910d43545a09b3eaf5a3 [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 }
Andrew Svetlov3ba3a3e2012-12-25 13:32:35 +0200118 return PyCFunction_NewEx(descr->d_method, type, NULL);
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;
Andrew Svetlov3ba3a3e2012-12-25 13:32:35 +0200128 return PyCFunction_NewEx(descr->d_method, obj, NULL);
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
Andrew Svetlov3ba3a3e2012-12-25 13:32:35 +0200242 func = PyCFunction_NewEx(descr->d_method, self, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000243 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{
Benjamin Peterson7295c6a2012-05-01 09:51:09 -0400260 Py_ssize_t argc;
261 PyObject *self, *func, *result;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000262
Benjamin Peterson7295c6a2012-05-01 09:51:09 -0400263 /* Make sure that the first argument is acceptable as 'self' */
264 assert(PyTuple_Check(args));
265 argc = PyTuple_GET_SIZE(args);
266 if (argc < 1) {
267 PyErr_Format(PyExc_TypeError,
268 "descriptor '%V' of '%.100s' "
269 "object needs an argument",
270 descr_name((PyDescrObject *)descr), "?",
271 PyDescr_TYPE(descr)->tp_name);
272 return NULL;
273 }
274 self = PyTuple_GET_ITEM(args, 0);
275 if (!PyType_Check(self)) {
276 PyErr_Format(PyExc_TypeError,
277 "descriptor '%V' requires a type "
278 "but received a '%.100s'",
279 descr_name((PyDescrObject *)descr), "?",
280 PyDescr_TYPE(descr)->tp_name,
281 self->ob_type->tp_name);
282 return NULL;
283 }
284 if (!PyType_IsSubtype((PyTypeObject *)self, PyDescr_TYPE(descr))) {
285 PyErr_Format(PyExc_TypeError,
286 "descriptor '%V' "
287 "requires a subtype of '%.100s' "
288 "but received '%.100s",
289 descr_name((PyDescrObject *)descr), "?",
290 PyDescr_TYPE(descr)->tp_name,
291 self->ob_type->tp_name);
292 return NULL;
293 }
294
Andrew Svetlov3ba3a3e2012-12-25 13:32:35 +0200295 func = PyCFunction_NewEx(descr->d_method, self, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000296 if (func == NULL)
297 return NULL;
Benjamin Peterson7295c6a2012-05-01 09:51:09 -0400298 args = PyTuple_GetSlice(args, 1, argc);
299 if (args == NULL) {
300 Py_DECREF(func);
301 return NULL;
302 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000303 result = PyEval_CallObjectWithKeywords(func, args, kwds);
304 Py_DECREF(func);
Benjamin Peterson7295c6a2012-05-01 09:51:09 -0400305 Py_DECREF(args);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000306 return result;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000307}
308
309static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000310wrapperdescr_call(PyWrapperDescrObject *descr, PyObject *args, PyObject *kwds)
311{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000312 Py_ssize_t argc;
313 PyObject *self, *func, *result;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000314
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000315 /* Make sure that the first argument is acceptable as 'self' */
316 assert(PyTuple_Check(args));
317 argc = PyTuple_GET_SIZE(args);
318 if (argc < 1) {
319 PyErr_Format(PyExc_TypeError,
320 "descriptor '%V' of '%.100s' "
321 "object needs an argument",
322 descr_name((PyDescrObject *)descr), "?",
323 PyDescr_TYPE(descr)->tp_name);
324 return NULL;
325 }
326 self = PyTuple_GET_ITEM(args, 0);
Victor Stinner3249dec2011-05-01 23:19:15 +0200327 if (!_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self),
Victor Stinnerd9561312011-05-01 23:31:36 +0200328 (PyObject *)PyDescr_TYPE(descr))) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000329 PyErr_Format(PyExc_TypeError,
330 "descriptor '%V' "
331 "requires a '%.100s' object "
332 "but received a '%.100s'",
333 descr_name((PyDescrObject *)descr), "?",
334 PyDescr_TYPE(descr)->tp_name,
335 self->ob_type->tp_name);
336 return NULL;
337 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000338
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000339 func = PyWrapper_New((PyObject *)descr, self);
340 if (func == NULL)
341 return NULL;
342 args = PyTuple_GetSlice(args, 1, argc);
343 if (args == NULL) {
344 Py_DECREF(func);
345 return NULL;
346 }
347 result = PyEval_CallObjectWithKeywords(func, args, kwds);
348 Py_DECREF(args);
349 Py_DECREF(func);
350 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000351}
352
353static PyObject *
Guido van Rossum6f799372001-09-20 20:46:19 +0000354method_get_doc(PyMethodDescrObject *descr, void *closure)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000355{
Larry Hastings5c661892014-01-24 06:17:25 -0800356 const char *name = descr->d_method->ml_name;
357 const char *doc = descr->d_method->ml_doc;
358 return _PyType_GetDocFromInternalDoc(name, doc);
359}
360
361static PyObject *
362method_get_text_signature(PyMethodDescrObject *descr, void *closure)
363{
364 const char *name = descr->d_method->ml_name;
365 const char *doc = descr->d_method->ml_doc;
366 return _PyType_GetTextSignatureFromInternalDoc(name, doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000367}
368
Antoine Pitrou9d574812011-12-12 13:47:25 +0100369static PyObject *
370calculate_qualname(PyDescrObject *descr)
371{
372 PyObject *type_qualname, *res;
373 _Py_IDENTIFIER(__qualname__);
374
375 if (descr->d_name == NULL || !PyUnicode_Check(descr->d_name)) {
376 PyErr_SetString(PyExc_TypeError,
377 "<descriptor>.__name__ is not a unicode object");
378 return NULL;
379 }
380
381 type_qualname = _PyObject_GetAttrId((PyObject *)descr->d_type,
382 &PyId___qualname__);
383 if (type_qualname == NULL)
384 return NULL;
385
386 if (!PyUnicode_Check(type_qualname)) {
387 PyErr_SetString(PyExc_TypeError, "<descriptor>.__objclass__."
388 "__qualname__ is not a unicode object");
389 Py_XDECREF(type_qualname);
390 return NULL;
391 }
392
393 res = PyUnicode_FromFormat("%S.%S", type_qualname, descr->d_name);
394 Py_DECREF(type_qualname);
395 return res;
396}
397
398static PyObject *
399descr_get_qualname(PyDescrObject *descr)
400{
401 if (descr->d_qualname == NULL)
402 descr->d_qualname = calculate_qualname(descr);
403 Py_XINCREF(descr->d_qualname);
404 return descr->d_qualname;
405}
406
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100407static PyObject *
408descr_reduce(PyDescrObject *descr)
409{
410 PyObject *builtins;
411 PyObject *getattr;
412 _Py_IDENTIFIER(getattr);
413
414 builtins = PyEval_GetBuiltins();
415 getattr = _PyDict_GetItemId(builtins, &PyId_getattr);
416 return Py_BuildValue("O(OO)", getattr, PyDescr_TYPE(descr),
417 PyDescr_NAME(descr));
418}
419
420static PyMethodDef descr_methods[] = {
421 {"__reduce__", (PyCFunction)descr_reduce, METH_NOARGS, NULL},
422 {NULL, NULL}
423};
424
Guido van Rossum6f799372001-09-20 20:46:19 +0000425static PyMemberDef descr_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000426 {"__objclass__", T_OBJECT, offsetof(PyDescrObject, d_type), READONLY},
427 {"__name__", T_OBJECT, offsetof(PyDescrObject, d_name), READONLY},
428 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000429};
430
Guido van Rossum32d34c82001-09-20 21:45:26 +0000431static PyGetSetDef method_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000432 {"__doc__", (getter)method_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100433 {"__qualname__", (getter)descr_get_qualname},
Larry Hastings5c661892014-01-24 06:17:25 -0800434 {"__text_signature__", (getter)method_get_text_signature},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000435 {0}
Guido van Rossum6f799372001-09-20 20:46:19 +0000436};
437
438static PyObject *
439member_get_doc(PyMemberDescrObject *descr, void *closure)
440{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000441 if (descr->d_member->doc == NULL) {
442 Py_INCREF(Py_None);
443 return Py_None;
444 }
445 return PyUnicode_FromString(descr->d_member->doc);
Guido van Rossum6f799372001-09-20 20:46:19 +0000446}
447
Guido van Rossum32d34c82001-09-20 21:45:26 +0000448static PyGetSetDef member_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000449 {"__doc__", (getter)member_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100450 {"__qualname__", (getter)descr_get_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000451 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000452};
453
454static PyObject *
Guido van Rossum32d34c82001-09-20 21:45:26 +0000455getset_get_doc(PyGetSetDescrObject *descr, void *closure)
456{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000457 if (descr->d_getset->doc == NULL) {
458 Py_INCREF(Py_None);
459 return Py_None;
460 }
461 return PyUnicode_FromString(descr->d_getset->doc);
Guido van Rossum32d34c82001-09-20 21:45:26 +0000462}
463
464static PyGetSetDef getset_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000465 {"__doc__", (getter)getset_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100466 {"__qualname__", (getter)descr_get_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000467 {0}
Guido van Rossum32d34c82001-09-20 21:45:26 +0000468};
469
470static PyObject *
Armin Rigoc6686b72005-11-07 08:38:00 +0000471wrapperdescr_get_doc(PyWrapperDescrObject *descr, void *closure)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000472{
Larry Hastings5c661892014-01-24 06:17:25 -0800473 const char *name = descr->d_base->name;
474 const char *doc = descr->d_base->doc;
475 return _PyType_GetDocFromInternalDoc(name, doc);
476}
477
478static PyObject *
479wrapperdescr_get_text_signature(PyWrapperDescrObject *descr, void *closure)
480{
481 const char *name = descr->d_base->name;
482 const char *doc = descr->d_base->doc;
483 return _PyType_GetTextSignatureFromInternalDoc(name, doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000484}
485
Armin Rigoc6686b72005-11-07 08:38:00 +0000486static PyGetSetDef wrapperdescr_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000487 {"__doc__", (getter)wrapperdescr_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100488 {"__qualname__", (getter)descr_get_qualname},
Larry Hastings5c661892014-01-24 06:17:25 -0800489 {"__text_signature__", (getter)wrapperdescr_get_text_signature},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000490 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000491};
492
Guido van Rossum048eb752001-10-02 21:24:57 +0000493static int
494descr_traverse(PyObject *self, visitproc visit, void *arg)
495{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000496 PyDescrObject *descr = (PyDescrObject *)self;
497 Py_VISIT(descr->d_type);
498 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +0000499}
500
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000501PyTypeObject PyMethodDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000502 PyVarObject_HEAD_INIT(&PyType_Type, 0)
503 "method_descriptor",
504 sizeof(PyMethodDescrObject),
505 0,
506 (destructor)descr_dealloc, /* tp_dealloc */
507 0, /* tp_print */
508 0, /* tp_getattr */
509 0, /* tp_setattr */
510 0, /* tp_reserved */
511 (reprfunc)method_repr, /* tp_repr */
512 0, /* tp_as_number */
513 0, /* tp_as_sequence */
514 0, /* tp_as_mapping */
515 0, /* tp_hash */
516 (ternaryfunc)methoddescr_call, /* tp_call */
517 0, /* tp_str */
518 PyObject_GenericGetAttr, /* tp_getattro */
519 0, /* tp_setattro */
520 0, /* tp_as_buffer */
521 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
522 0, /* tp_doc */
523 descr_traverse, /* tp_traverse */
524 0, /* tp_clear */
525 0, /* tp_richcompare */
526 0, /* tp_weaklistoffset */
527 0, /* tp_iter */
528 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100529 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000530 descr_members, /* tp_members */
531 method_getset, /* tp_getset */
532 0, /* tp_base */
533 0, /* tp_dict */
534 (descrgetfunc)method_get, /* tp_descr_get */
535 0, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000536};
537
Guido van Rossumb6e5a0c2003-02-11 18:44:42 +0000538/* This is for METH_CLASS in C, not for "f = classmethod(f)" in Python! */
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000539PyTypeObject PyClassMethodDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000540 PyVarObject_HEAD_INIT(&PyType_Type, 0)
541 "classmethod_descriptor",
542 sizeof(PyMethodDescrObject),
543 0,
544 (destructor)descr_dealloc, /* tp_dealloc */
545 0, /* tp_print */
546 0, /* tp_getattr */
547 0, /* tp_setattr */
548 0, /* tp_reserved */
549 (reprfunc)method_repr, /* tp_repr */
550 0, /* tp_as_number */
551 0, /* tp_as_sequence */
552 0, /* tp_as_mapping */
553 0, /* tp_hash */
554 (ternaryfunc)classmethoddescr_call, /* tp_call */
555 0, /* tp_str */
556 PyObject_GenericGetAttr, /* tp_getattro */
557 0, /* tp_setattro */
558 0, /* tp_as_buffer */
559 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
560 0, /* tp_doc */
561 descr_traverse, /* tp_traverse */
562 0, /* tp_clear */
563 0, /* tp_richcompare */
564 0, /* tp_weaklistoffset */
565 0, /* tp_iter */
566 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100567 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000568 descr_members, /* tp_members */
569 method_getset, /* tp_getset */
570 0, /* tp_base */
571 0, /* tp_dict */
572 (descrgetfunc)classmethod_get, /* tp_descr_get */
573 0, /* tp_descr_set */
Tim Petersbca1cbc2002-12-09 22:56:13 +0000574};
575
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000576PyTypeObject PyMemberDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000577 PyVarObject_HEAD_INIT(&PyType_Type, 0)
578 "member_descriptor",
579 sizeof(PyMemberDescrObject),
580 0,
581 (destructor)descr_dealloc, /* tp_dealloc */
582 0, /* tp_print */
583 0, /* tp_getattr */
584 0, /* tp_setattr */
585 0, /* tp_reserved */
586 (reprfunc)member_repr, /* tp_repr */
587 0, /* tp_as_number */
588 0, /* tp_as_sequence */
589 0, /* tp_as_mapping */
590 0, /* tp_hash */
591 0, /* tp_call */
592 0, /* tp_str */
593 PyObject_GenericGetAttr, /* tp_getattro */
594 0, /* tp_setattro */
595 0, /* tp_as_buffer */
596 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
597 0, /* tp_doc */
598 descr_traverse, /* tp_traverse */
599 0, /* tp_clear */
600 0, /* tp_richcompare */
601 0, /* tp_weaklistoffset */
602 0, /* tp_iter */
603 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100604 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000605 descr_members, /* tp_members */
606 member_getset, /* tp_getset */
607 0, /* tp_base */
608 0, /* tp_dict */
609 (descrgetfunc)member_get, /* tp_descr_get */
610 (descrsetfunc)member_set, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000611};
612
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000613PyTypeObject PyGetSetDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000614 PyVarObject_HEAD_INIT(&PyType_Type, 0)
615 "getset_descriptor",
616 sizeof(PyGetSetDescrObject),
617 0,
618 (destructor)descr_dealloc, /* tp_dealloc */
619 0, /* tp_print */
620 0, /* tp_getattr */
621 0, /* tp_setattr */
622 0, /* tp_reserved */
623 (reprfunc)getset_repr, /* tp_repr */
624 0, /* tp_as_number */
625 0, /* tp_as_sequence */
626 0, /* tp_as_mapping */
627 0, /* tp_hash */
628 0, /* tp_call */
629 0, /* tp_str */
630 PyObject_GenericGetAttr, /* tp_getattro */
631 0, /* tp_setattro */
632 0, /* tp_as_buffer */
633 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
634 0, /* tp_doc */
635 descr_traverse, /* tp_traverse */
636 0, /* tp_clear */
637 0, /* tp_richcompare */
638 0, /* tp_weaklistoffset */
639 0, /* tp_iter */
640 0, /* tp_iternext */
641 0, /* tp_methods */
642 descr_members, /* tp_members */
643 getset_getset, /* tp_getset */
644 0, /* tp_base */
645 0, /* tp_dict */
646 (descrgetfunc)getset_get, /* tp_descr_get */
647 (descrsetfunc)getset_set, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000648};
649
Guido van Rossumf4593e02001-10-03 12:09:30 +0000650PyTypeObject PyWrapperDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000651 PyVarObject_HEAD_INIT(&PyType_Type, 0)
652 "wrapper_descriptor",
653 sizeof(PyWrapperDescrObject),
654 0,
655 (destructor)descr_dealloc, /* tp_dealloc */
656 0, /* tp_print */
657 0, /* tp_getattr */
658 0, /* tp_setattr */
659 0, /* tp_reserved */
660 (reprfunc)wrapperdescr_repr, /* tp_repr */
661 0, /* tp_as_number */
662 0, /* tp_as_sequence */
663 0, /* tp_as_mapping */
664 0, /* tp_hash */
665 (ternaryfunc)wrapperdescr_call, /* tp_call */
666 0, /* tp_str */
667 PyObject_GenericGetAttr, /* tp_getattro */
668 0, /* tp_setattro */
669 0, /* tp_as_buffer */
670 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
671 0, /* tp_doc */
672 descr_traverse, /* tp_traverse */
673 0, /* tp_clear */
674 0, /* tp_richcompare */
675 0, /* tp_weaklistoffset */
676 0, /* tp_iter */
677 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100678 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000679 descr_members, /* tp_members */
680 wrapperdescr_getset, /* tp_getset */
681 0, /* tp_base */
682 0, /* tp_dict */
683 (descrgetfunc)wrapperdescr_get, /* tp_descr_get */
684 0, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000685};
686
687static PyDescrObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000688descr_new(PyTypeObject *descrtype, PyTypeObject *type, const char *name)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000689{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000690 PyDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000691
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000692 descr = (PyDescrObject *)PyType_GenericAlloc(descrtype, 0);
693 if (descr != NULL) {
694 Py_XINCREF(type);
695 descr->d_type = type;
696 descr->d_name = PyUnicode_InternFromString(name);
697 if (descr->d_name == NULL) {
698 Py_DECREF(descr);
699 descr = NULL;
700 }
Benjamin Petersonf2fe7f02011-12-17 08:02:20 -0500701 else {
702 descr->d_qualname = NULL;
703 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000704 }
705 return descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000706}
707
708PyObject *
709PyDescr_NewMethod(PyTypeObject *type, PyMethodDef *method)
710{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000711 PyMethodDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000712
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000713 descr = (PyMethodDescrObject *)descr_new(&PyMethodDescr_Type,
714 type, method->ml_name);
715 if (descr != NULL)
716 descr->d_method = method;
717 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000718}
719
720PyObject *
Tim Petersbca1cbc2002-12-09 22:56:13 +0000721PyDescr_NewClassMethod(PyTypeObject *type, PyMethodDef *method)
722{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000723 PyMethodDescrObject *descr;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000724
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000725 descr = (PyMethodDescrObject *)descr_new(&PyClassMethodDescr_Type,
726 type, method->ml_name);
727 if (descr != NULL)
728 descr->d_method = method;
729 return (PyObject *)descr;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000730}
731
732PyObject *
Guido van Rossum6f799372001-09-20 20:46:19 +0000733PyDescr_NewMember(PyTypeObject *type, PyMemberDef *member)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000734{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000735 PyMemberDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000736
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000737 descr = (PyMemberDescrObject *)descr_new(&PyMemberDescr_Type,
738 type, member->name);
739 if (descr != NULL)
740 descr->d_member = member;
741 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000742}
743
744PyObject *
Guido van Rossum32d34c82001-09-20 21:45:26 +0000745PyDescr_NewGetSet(PyTypeObject *type, PyGetSetDef *getset)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000746{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000747 PyGetSetDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000748
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000749 descr = (PyGetSetDescrObject *)descr_new(&PyGetSetDescr_Type,
750 type, getset->name);
751 if (descr != NULL)
752 descr->d_getset = getset;
753 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000754}
755
756PyObject *
757PyDescr_NewWrapper(PyTypeObject *type, struct wrapperbase *base, void *wrapped)
758{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000759 PyWrapperDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000760
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000761 descr = (PyWrapperDescrObject *)descr_new(&PyWrapperDescr_Type,
762 type, base->name);
763 if (descr != NULL) {
764 descr->d_base = base;
765 descr->d_wrapped = wrapped;
766 }
767 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000768}
769
Tim Peters6d6c1a32001-08-02 04:15:00 +0000770
Victor Stinner0db176f2012-04-16 00:16:30 +0200771/* --- mappingproxy: read-only proxy for mappings --- */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000772
773/* This has no reason to be in this file except that adding new files is a
774 bit of a pain */
775
776typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000777 PyObject_HEAD
Victor Stinner0db176f2012-04-16 00:16:30 +0200778 PyObject *mapping;
779} mappingproxyobject;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000780
Martin v. Löwis18e16552006-02-15 17:27:45 +0000781static Py_ssize_t
Victor Stinner0db176f2012-04-16 00:16:30 +0200782mappingproxy_len(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000783{
Victor Stinner0db176f2012-04-16 00:16:30 +0200784 return PyObject_Size(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000785}
786
787static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200788mappingproxy_getitem(mappingproxyobject *pp, PyObject *key)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000789{
Victor Stinner0db176f2012-04-16 00:16:30 +0200790 return PyObject_GetItem(pp->mapping, key);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000791}
792
Victor Stinner0db176f2012-04-16 00:16:30 +0200793static PyMappingMethods mappingproxy_as_mapping = {
794 (lenfunc)mappingproxy_len, /* mp_length */
795 (binaryfunc)mappingproxy_getitem, /* mp_subscript */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000796 0, /* mp_ass_subscript */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000797};
798
799static int
Victor Stinner0db176f2012-04-16 00:16:30 +0200800mappingproxy_contains(mappingproxyobject *pp, PyObject *key)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000801{
Victor Stinner0db176f2012-04-16 00:16:30 +0200802 if (PyDict_CheckExact(pp->mapping))
803 return PyDict_Contains(pp->mapping, key);
804 else
805 return PySequence_Contains(pp->mapping, key);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000806}
807
Victor Stinner0db176f2012-04-16 00:16:30 +0200808static PySequenceMethods mappingproxy_as_sequence = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000809 0, /* sq_length */
810 0, /* sq_concat */
811 0, /* sq_repeat */
812 0, /* sq_item */
813 0, /* sq_slice */
814 0, /* sq_ass_item */
815 0, /* sq_ass_slice */
Victor Stinner0db176f2012-04-16 00:16:30 +0200816 (objobjproc)mappingproxy_contains, /* sq_contains */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000817 0, /* sq_inplace_concat */
818 0, /* sq_inplace_repeat */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000819};
820
821static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200822mappingproxy_get(mappingproxyobject *pp, PyObject *args)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000823{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000824 PyObject *key, *def = Py_None;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200825 _Py_IDENTIFIER(get);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000826
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000827 if (!PyArg_UnpackTuple(args, "get", 1, 2, &key, &def))
828 return NULL;
Victor Stinner0db176f2012-04-16 00:16:30 +0200829 return _PyObject_CallMethodId(pp->mapping, &PyId_get, "(OO)", key, def);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000830}
831
832static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200833mappingproxy_keys(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000834{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200835 _Py_IDENTIFIER(keys);
Victor Stinner0db176f2012-04-16 00:16:30 +0200836 return _PyObject_CallMethodId(pp->mapping, &PyId_keys, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000837}
838
839static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200840mappingproxy_values(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000841{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200842 _Py_IDENTIFIER(values);
Victor Stinner0db176f2012-04-16 00:16:30 +0200843 return _PyObject_CallMethodId(pp->mapping, &PyId_values, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000844}
845
846static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200847mappingproxy_items(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000848{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200849 _Py_IDENTIFIER(items);
Victor Stinner0db176f2012-04-16 00:16:30 +0200850 return _PyObject_CallMethodId(pp->mapping, &PyId_items, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000851}
852
853static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200854mappingproxy_copy(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000855{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200856 _Py_IDENTIFIER(copy);
Victor Stinner0db176f2012-04-16 00:16:30 +0200857 return _PyObject_CallMethodId(pp->mapping, &PyId_copy, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000858}
859
Victor Stinner0db176f2012-04-16 00:16:30 +0200860/* WARNING: mappingproxy methods must not give access
861 to the underlying mapping */
862
863static PyMethodDef mappingproxy_methods[] = {
864 {"get", (PyCFunction)mappingproxy_get, METH_VARARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000865 PyDoc_STR("D.get(k[,d]) -> D[k] if k in D, else d."
Victor Stinner0db176f2012-04-16 00:16:30 +0200866 " d defaults to None.")},
867 {"keys", (PyCFunction)mappingproxy_keys, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000868 PyDoc_STR("D.keys() -> list of D's keys")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200869 {"values", (PyCFunction)mappingproxy_values, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000870 PyDoc_STR("D.values() -> list of D's values")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200871 {"items", (PyCFunction)mappingproxy_items, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000872 PyDoc_STR("D.items() -> list of D's (key, value) pairs, as 2-tuples")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200873 {"copy", (PyCFunction)mappingproxy_copy, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000874 PyDoc_STR("D.copy() -> a shallow copy of D")},
875 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000876};
877
878static void
Victor Stinner0db176f2012-04-16 00:16:30 +0200879mappingproxy_dealloc(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000880{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000881 _PyObject_GC_UNTRACK(pp);
Victor Stinner0db176f2012-04-16 00:16:30 +0200882 Py_DECREF(pp->mapping);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000883 PyObject_GC_Del(pp);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000884}
885
886static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200887mappingproxy_getiter(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000888{
Victor Stinner0db176f2012-04-16 00:16:30 +0200889 return PyObject_GetIter(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000890}
891
Neil Schemenauer26775122001-10-21 22:26:43 +0000892static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200893mappingproxy_str(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000894{
Victor Stinner0db176f2012-04-16 00:16:30 +0200895 return PyObject_Str(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000896}
897
Ezio Melottiac53ab62010-12-18 14:59:43 +0000898static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200899mappingproxy_repr(mappingproxyobject *pp)
Ezio Melottiac53ab62010-12-18 14:59:43 +0000900{
Victor Stinner0db176f2012-04-16 00:16:30 +0200901 return PyUnicode_FromFormat("mappingproxy(%R)", pp->mapping);
Ezio Melottiac53ab62010-12-18 14:59:43 +0000902}
903
Guido van Rossum048eb752001-10-02 21:24:57 +0000904static int
Victor Stinner0db176f2012-04-16 00:16:30 +0200905mappingproxy_traverse(PyObject *self, visitproc visit, void *arg)
Guido van Rossum048eb752001-10-02 21:24:57 +0000906{
Victor Stinner0db176f2012-04-16 00:16:30 +0200907 mappingproxyobject *pp = (mappingproxyobject *)self;
908 Py_VISIT(pp->mapping);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000909 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +0000910}
911
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000912static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200913mappingproxy_richcompare(mappingproxyobject *v, PyObject *w, int op)
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000914{
Victor Stinner0db176f2012-04-16 00:16:30 +0200915 return PyObject_RichCompare(v->mapping, w, op);
916}
917
918static int
919mappingproxy_check_mapping(PyObject *mapping)
920{
921 if (!PyMapping_Check(mapping)
922 || PyList_Check(mapping)
923 || PyTuple_Check(mapping)) {
924 PyErr_Format(PyExc_TypeError,
925 "mappingproxy() argument must be a mapping, not %s",
926 Py_TYPE(mapping)->tp_name);
927 return -1;
928 }
929 return 0;
930}
931
932static PyObject*
933mappingproxy_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
934{
935 static char *kwlist[] = {"mapping", NULL};
936 PyObject *mapping;
937 mappingproxyobject *mappingproxy;
938
939 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O:mappingproxy",
940 kwlist, &mapping))
941 return NULL;
942
943 if (mappingproxy_check_mapping(mapping) == -1)
944 return NULL;
945
946 mappingproxy = PyObject_GC_New(mappingproxyobject, &PyDictProxy_Type);
947 if (mappingproxy == NULL)
948 return NULL;
949 Py_INCREF(mapping);
950 mappingproxy->mapping = mapping;
951 _PyObject_GC_TRACK(mappingproxy);
952 return (PyObject *)mappingproxy;
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000953}
954
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000955PyTypeObject PyDictProxy_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000956 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Victor Stinner0db176f2012-04-16 00:16:30 +0200957 "mappingproxy", /* tp_name */
958 sizeof(mappingproxyobject), /* tp_basicsize */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000959 0, /* tp_itemsize */
960 /* methods */
Victor Stinner0db176f2012-04-16 00:16:30 +0200961 (destructor)mappingproxy_dealloc, /* tp_dealloc */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000962 0, /* tp_print */
963 0, /* tp_getattr */
964 0, /* tp_setattr */
965 0, /* tp_reserved */
Victor Stinner0db176f2012-04-16 00:16:30 +0200966 (reprfunc)mappingproxy_repr, /* tp_repr */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000967 0, /* tp_as_number */
Victor Stinner0db176f2012-04-16 00:16:30 +0200968 &mappingproxy_as_sequence, /* tp_as_sequence */
969 &mappingproxy_as_mapping, /* tp_as_mapping */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000970 0, /* tp_hash */
971 0, /* tp_call */
Victor Stinner0db176f2012-04-16 00:16:30 +0200972 (reprfunc)mappingproxy_str, /* tp_str */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000973 PyObject_GenericGetAttr, /* tp_getattro */
974 0, /* tp_setattro */
975 0, /* tp_as_buffer */
976 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
977 0, /* tp_doc */
Victor Stinner0db176f2012-04-16 00:16:30 +0200978 mappingproxy_traverse, /* tp_traverse */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000979 0, /* tp_clear */
Victor Stinner0db176f2012-04-16 00:16:30 +0200980 (richcmpfunc)mappingproxy_richcompare, /* tp_richcompare */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000981 0, /* tp_weaklistoffset */
Victor Stinner0db176f2012-04-16 00:16:30 +0200982 (getiterfunc)mappingproxy_getiter, /* tp_iter */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000983 0, /* tp_iternext */
Victor Stinner0db176f2012-04-16 00:16:30 +0200984 mappingproxy_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000985 0, /* tp_members */
986 0, /* tp_getset */
987 0, /* tp_base */
988 0, /* tp_dict */
989 0, /* tp_descr_get */
990 0, /* tp_descr_set */
Victor Stinner0db176f2012-04-16 00:16:30 +0200991 0, /* tp_dictoffset */
992 0, /* tp_init */
993 0, /* tp_alloc */
994 mappingproxy_new, /* tp_new */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000995};
996
997PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200998PyDictProxy_New(PyObject *mapping)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000999{
Victor Stinner0db176f2012-04-16 00:16:30 +02001000 mappingproxyobject *pp;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001001
Victor Stinner0db176f2012-04-16 00:16:30 +02001002 if (mappingproxy_check_mapping(mapping) == -1)
1003 return NULL;
1004
1005 pp = PyObject_GC_New(mappingproxyobject, &PyDictProxy_Type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001006 if (pp != NULL) {
Victor Stinner0db176f2012-04-16 00:16:30 +02001007 Py_INCREF(mapping);
1008 pp->mapping = mapping;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001009 _PyObject_GC_TRACK(pp);
1010 }
1011 return (PyObject *)pp;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001012}
1013
1014
1015/* --- Wrapper object for "slot" methods --- */
1016
1017/* This has no reason to be in this file except that adding new files is a
1018 bit of a pain */
1019
1020typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001021 PyObject_HEAD
1022 PyWrapperDescrObject *descr;
1023 PyObject *self;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001024} wrapperobject;
1025
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001026#define Wrapper_Check(v) (Py_TYPE(v) == &_PyMethodWrapper_Type)
Mark Dickinson211c6252009-02-01 10:28:51 +00001027
Tim Peters6d6c1a32001-08-02 04:15:00 +00001028static void
1029wrapper_dealloc(wrapperobject *wp)
1030{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001031 PyObject_GC_UnTrack(wp);
1032 Py_TRASHCAN_SAFE_BEGIN(wp)
1033 Py_XDECREF(wp->descr);
1034 Py_XDECREF(wp->self);
1035 PyObject_GC_Del(wp);
1036 Py_TRASHCAN_SAFE_END(wp)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001037}
1038
Mark Dickinson211c6252009-02-01 10:28:51 +00001039#define TEST_COND(cond) ((cond) ? Py_True : Py_False)
1040
1041static PyObject *
1042wrapper_richcompare(PyObject *a, PyObject *b, int op)
Armin Rigoc6686b72005-11-07 08:38:00 +00001043{
Victor Stinner6f75a3e2013-05-08 00:44:15 +02001044 Py_intptr_t result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001045 PyObject *v;
1046 PyWrapperDescrObject *a_descr, *b_descr;
Mark Dickinson211c6252009-02-01 10:28:51 +00001047
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001048 assert(a != NULL && b != NULL);
Mark Dickinson211c6252009-02-01 10:28:51 +00001049
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001050 /* both arguments should be wrapperobjects */
1051 if (!Wrapper_Check(a) || !Wrapper_Check(b)) {
1052 v = Py_NotImplemented;
1053 Py_INCREF(v);
1054 return v;
1055 }
Mark Dickinson211c6252009-02-01 10:28:51 +00001056
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001057 /* compare by descriptor address; if the descriptors are the same,
1058 compare by the objects they're bound to */
1059 a_descr = ((wrapperobject *)a)->descr;
1060 b_descr = ((wrapperobject *)b)->descr;
1061 if (a_descr == b_descr) {
1062 a = ((wrapperobject *)a)->self;
1063 b = ((wrapperobject *)b)->self;
1064 return PyObject_RichCompare(a, b, op);
1065 }
Mark Dickinson211c6252009-02-01 10:28:51 +00001066
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001067 result = a_descr - b_descr;
1068 switch (op) {
1069 case Py_EQ:
1070 v = TEST_COND(result == 0);
1071 break;
1072 case Py_NE:
1073 v = TEST_COND(result != 0);
1074 break;
1075 case Py_LE:
1076 v = TEST_COND(result <= 0);
1077 break;
1078 case Py_GE:
1079 v = TEST_COND(result >= 0);
1080 break;
1081 case Py_LT:
1082 v = TEST_COND(result < 0);
1083 break;
1084 case Py_GT:
1085 v = TEST_COND(result > 0);
1086 break;
1087 default:
1088 PyErr_BadArgument();
1089 return NULL;
1090 }
1091 Py_INCREF(v);
1092 return v;
Armin Rigoc6686b72005-11-07 08:38:00 +00001093}
1094
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001095static Py_hash_t
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001096wrapper_hash(wrapperobject *wp)
1097{
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001098 Py_hash_t x, y;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001099 x = _Py_HashPointer(wp->descr);
1100 if (x == -1)
1101 return -1;
1102 y = PyObject_Hash(wp->self);
1103 if (y == -1)
1104 return -1;
1105 x = x ^ y;
1106 if (x == -1)
1107 x = -2;
1108 return x;
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001109}
1110
Armin Rigoc6686b72005-11-07 08:38:00 +00001111static PyObject *
1112wrapper_repr(wrapperobject *wp)
1113{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001114 return PyUnicode_FromFormat("<method-wrapper '%s' of %s object at %p>",
1115 wp->descr->d_base->name,
1116 wp->self->ob_type->tp_name,
1117 wp->self);
Armin Rigoc6686b72005-11-07 08:38:00 +00001118}
1119
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001120static PyObject *
1121wrapper_reduce(wrapperobject *wp)
1122{
1123 PyObject *builtins;
1124 PyObject *getattr;
1125 _Py_IDENTIFIER(getattr);
1126
1127 builtins = PyEval_GetBuiltins();
1128 getattr = _PyDict_GetItemId(builtins, &PyId_getattr);
1129 return Py_BuildValue("O(OO)", getattr, wp->self, PyDescr_NAME(wp->descr));
1130}
1131
1132static PyMethodDef wrapper_methods[] = {
1133 {"__reduce__", (PyCFunction)wrapper_reduce, METH_NOARGS, NULL},
1134 {NULL, NULL}
1135};
1136
Armin Rigoc6686b72005-11-07 08:38:00 +00001137static PyMemberDef wrapper_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001138 {"__self__", T_OBJECT, offsetof(wrapperobject, self), READONLY},
1139 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001140};
1141
1142static PyObject *
Armin Rigoc6686b72005-11-07 08:38:00 +00001143wrapper_objclass(wrapperobject *wp)
1144{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001145 PyObject *c = (PyObject *)PyDescr_TYPE(wp->descr);
Armin Rigoc6686b72005-11-07 08:38:00 +00001146
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001147 Py_INCREF(c);
1148 return c;
Armin Rigoc6686b72005-11-07 08:38:00 +00001149}
1150
1151static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001152wrapper_name(wrapperobject *wp)
1153{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001154 const char *s = wp->descr->d_base->name;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001155
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001156 return PyUnicode_FromString(s);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001157}
1158
1159static PyObject *
Larry Hastings5c661892014-01-24 06:17:25 -08001160wrapper_doc(wrapperobject *wp, void *closure)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001161{
Larry Hastings5c661892014-01-24 06:17:25 -08001162 const char *name = wp->descr->d_base->name;
1163 const char *doc = wp->descr->d_base->doc;
1164 return _PyType_GetDocFromInternalDoc(name, doc);
1165}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001166
Larry Hastings5c661892014-01-24 06:17:25 -08001167static PyObject *
1168wrapper_text_signature(wrapperobject *wp, void *closure)
1169{
1170 const char *name = wp->descr->d_base->name;
1171 const char *doc = wp->descr->d_base->doc;
1172 return _PyType_GetTextSignatureFromInternalDoc(name, doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001173}
1174
Antoine Pitrou9d574812011-12-12 13:47:25 +01001175static PyObject *
1176wrapper_qualname(wrapperobject *wp)
1177{
1178 return descr_get_qualname((PyDescrObject *)wp->descr);
1179}
1180
Guido van Rossum32d34c82001-09-20 21:45:26 +00001181static PyGetSetDef wrapper_getsets[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001182 {"__objclass__", (getter)wrapper_objclass},
1183 {"__name__", (getter)wrapper_name},
Antoine Pitrou9d574812011-12-12 13:47:25 +01001184 {"__qualname__", (getter)wrapper_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001185 {"__doc__", (getter)wrapper_doc},
Larry Hastings5c661892014-01-24 06:17:25 -08001186 {"__text_signature__", (getter)wrapper_text_signature},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001187 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001188};
1189
1190static PyObject *
1191wrapper_call(wrapperobject *wp, PyObject *args, PyObject *kwds)
1192{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001193 wrapperfunc wrapper = wp->descr->d_base->wrapper;
1194 PyObject *self = wp->self;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001195
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001196 if (wp->descr->d_base->flags & PyWrapperFlag_KEYWORDS) {
1197 wrapperfunc_kwds wk = (wrapperfunc_kwds)wrapper;
1198 return (*wk)(self, args, wp->descr->d_wrapped, kwds);
1199 }
Guido van Rossumc8e56452001-10-22 00:43:43 +00001200
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001201 if (kwds != NULL && (!PyDict_Check(kwds) || PyDict_Size(kwds) != 0)) {
1202 PyErr_Format(PyExc_TypeError,
1203 "wrapper %s doesn't take keyword arguments",
1204 wp->descr->d_base->name);
1205 return NULL;
1206 }
1207 return (*wrapper)(self, args, wp->descr->d_wrapped);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001208}
1209
Guido van Rossum048eb752001-10-02 21:24:57 +00001210static int
1211wrapper_traverse(PyObject *self, visitproc visit, void *arg)
1212{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001213 wrapperobject *wp = (wrapperobject *)self;
1214 Py_VISIT(wp->descr);
1215 Py_VISIT(wp->self);
1216 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +00001217}
1218
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001219PyTypeObject _PyMethodWrapper_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001220 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1221 "method-wrapper", /* tp_name */
1222 sizeof(wrapperobject), /* tp_basicsize */
1223 0, /* tp_itemsize */
1224 /* methods */
1225 (destructor)wrapper_dealloc, /* tp_dealloc */
1226 0, /* tp_print */
1227 0, /* tp_getattr */
1228 0, /* tp_setattr */
1229 0, /* tp_reserved */
1230 (reprfunc)wrapper_repr, /* tp_repr */
1231 0, /* tp_as_number */
1232 0, /* tp_as_sequence */
1233 0, /* tp_as_mapping */
1234 (hashfunc)wrapper_hash, /* tp_hash */
1235 (ternaryfunc)wrapper_call, /* tp_call */
1236 0, /* tp_str */
1237 PyObject_GenericGetAttr, /* tp_getattro */
1238 0, /* tp_setattro */
1239 0, /* tp_as_buffer */
1240 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
1241 0, /* tp_doc */
1242 wrapper_traverse, /* tp_traverse */
1243 0, /* tp_clear */
1244 wrapper_richcompare, /* tp_richcompare */
1245 0, /* tp_weaklistoffset */
1246 0, /* tp_iter */
1247 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001248 wrapper_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001249 wrapper_members, /* tp_members */
1250 wrapper_getsets, /* tp_getset */
1251 0, /* tp_base */
1252 0, /* tp_dict */
1253 0, /* tp_descr_get */
1254 0, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001255};
1256
1257PyObject *
1258PyWrapper_New(PyObject *d, PyObject *self)
1259{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001260 wrapperobject *wp;
1261 PyWrapperDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001262
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001263 assert(PyObject_TypeCheck(d, &PyWrapperDescr_Type));
1264 descr = (PyWrapperDescrObject *)d;
Victor Stinner3249dec2011-05-01 23:19:15 +02001265 assert(_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self),
Victor Stinnerd9561312011-05-01 23:31:36 +02001266 (PyObject *)PyDescr_TYPE(descr)));
Tim Peters6d6c1a32001-08-02 04:15:00 +00001267
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001268 wp = PyObject_GC_New(wrapperobject, &_PyMethodWrapper_Type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001269 if (wp != NULL) {
1270 Py_INCREF(descr);
1271 wp->descr = descr;
1272 Py_INCREF(self);
1273 wp->self = self;
1274 _PyObject_GC_TRACK(wp);
1275 }
1276 return (PyObject *)wp;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001277}
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001278
1279
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001280/* A built-in 'property' type */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001281
1282/*
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001283 class property(object):
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001284
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001285 def __init__(self, fget=None, fset=None, fdel=None, doc=None):
1286 if doc is None and fget is not None and hasattr(fget, "__doc__"):
1287 doc = fget.__doc__
1288 self.__get = fget
1289 self.__set = fset
1290 self.__del = fdel
1291 self.__doc__ = doc
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001292
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001293 def __get__(self, inst, type=None):
1294 if inst is None:
1295 return self
1296 if self.__get is None:
1297 raise AttributeError, "unreadable attribute"
1298 return self.__get(inst)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001299
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001300 def __set__(self, inst, value):
1301 if self.__set is None:
1302 raise AttributeError, "can't set attribute"
1303 return self.__set(inst, value)
Guido van Rossumba2485f2001-12-10 18:03:34 +00001304
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001305 def __delete__(self, inst):
1306 if self.__del is None:
1307 raise AttributeError, "can't delete attribute"
1308 return self.__del(inst)
Guido van Rossumba2485f2001-12-10 18:03:34 +00001309
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001310*/
1311
1312typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001313 PyObject_HEAD
1314 PyObject *prop_get;
1315 PyObject *prop_set;
1316 PyObject *prop_del;
1317 PyObject *prop_doc;
1318 int getter_doc;
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001319} propertyobject;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001320
Christian Heimes0449f632007-12-15 01:27:15 +00001321static PyObject * property_copy(PyObject *, PyObject *, PyObject *,
Benjamin Peterson93964832010-06-28 03:07:10 +00001322 PyObject *);
Christian Heimes0449f632007-12-15 01:27:15 +00001323
Tim Peters66c1a522001-09-24 21:17:50 +00001324static PyMemberDef property_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001325 {"fget", T_OBJECT, offsetof(propertyobject, prop_get), READONLY},
1326 {"fset", T_OBJECT, offsetof(propertyobject, prop_set), READONLY},
1327 {"fdel", T_OBJECT, offsetof(propertyobject, prop_del), READONLY},
1328 {"__doc__", T_OBJECT, offsetof(propertyobject, prop_doc), READONLY},
1329 {0}
Tim Peters66c1a522001-09-24 21:17:50 +00001330};
1331
Christian Heimes0449f632007-12-15 01:27:15 +00001332
Guido van Rossum58da9312007-11-10 23:39:45 +00001333PyDoc_STRVAR(getter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001334 "Descriptor to change the getter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001335
Neal Norwitz32dde222008-04-15 06:43:13 +00001336static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001337property_getter(PyObject *self, PyObject *getter)
1338{
Benjamin Peterson93964832010-06-28 03:07:10 +00001339 return property_copy(self, getter, NULL, NULL);
Guido van Rossum58da9312007-11-10 23:39:45 +00001340}
1341
Christian Heimes0449f632007-12-15 01:27:15 +00001342
Guido van Rossum58da9312007-11-10 23:39:45 +00001343PyDoc_STRVAR(setter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001344 "Descriptor to change the setter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001345
Neal Norwitz32dde222008-04-15 06:43:13 +00001346static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001347property_setter(PyObject *self, PyObject *setter)
1348{
Benjamin Peterson93964832010-06-28 03:07:10 +00001349 return property_copy(self, NULL, setter, NULL);
Guido van Rossum58da9312007-11-10 23:39:45 +00001350}
1351
Christian Heimes0449f632007-12-15 01:27:15 +00001352
Guido van Rossum58da9312007-11-10 23:39:45 +00001353PyDoc_STRVAR(deleter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001354 "Descriptor to change the deleter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001355
Neal Norwitz32dde222008-04-15 06:43:13 +00001356static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001357property_deleter(PyObject *self, PyObject *deleter)
1358{
Benjamin Peterson93964832010-06-28 03:07:10 +00001359 return property_copy(self, NULL, NULL, deleter);
Guido van Rossum58da9312007-11-10 23:39:45 +00001360}
1361
1362
Guido van Rossum58da9312007-11-10 23:39:45 +00001363static PyMethodDef property_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001364 {"getter", property_getter, METH_O, getter_doc},
1365 {"setter", property_setter, METH_O, setter_doc},
1366 {"deleter", property_deleter, METH_O, deleter_doc},
1367 {0}
Guido van Rossum58da9312007-11-10 23:39:45 +00001368};
1369
Tim Peters66c1a522001-09-24 21:17:50 +00001370
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001371static void
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001372property_dealloc(PyObject *self)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001373{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001374 propertyobject *gs = (propertyobject *)self;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001375
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001376 _PyObject_GC_UNTRACK(self);
1377 Py_XDECREF(gs->prop_get);
1378 Py_XDECREF(gs->prop_set);
1379 Py_XDECREF(gs->prop_del);
1380 Py_XDECREF(gs->prop_doc);
1381 self->ob_type->tp_free(self);
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001382}
1383
1384static PyObject *
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001385property_descr_get(PyObject *self, PyObject *obj, PyObject *type)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001386{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001387 propertyobject *gs = (propertyobject *)self;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001388
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001389 if (obj == NULL || obj == Py_None) {
1390 Py_INCREF(self);
1391 return self;
1392 }
1393 if (gs->prop_get == NULL) {
1394 PyErr_SetString(PyExc_AttributeError, "unreadable attribute");
1395 return NULL;
1396 }
Benjamin Peterson9b955de2010-12-07 04:04:02 +00001397 return PyObject_CallFunctionObjArgs(gs->prop_get, obj, NULL);
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001398}
1399
1400static int
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001401property_descr_set(PyObject *self, PyObject *obj, PyObject *value)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001402{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001403 propertyobject *gs = (propertyobject *)self;
1404 PyObject *func, *res;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001405
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001406 if (value == NULL)
1407 func = gs->prop_del;
1408 else
1409 func = gs->prop_set;
1410 if (func == NULL) {
1411 PyErr_SetString(PyExc_AttributeError,
1412 value == NULL ?
1413 "can't delete attribute" :
1414 "can't set attribute");
1415 return -1;
1416 }
1417 if (value == NULL)
Benjamin Peterson9b955de2010-12-07 04:04:02 +00001418 res = PyObject_CallFunctionObjArgs(func, obj, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001419 else
Benjamin Peterson9b955de2010-12-07 04:04:02 +00001420 res = PyObject_CallFunctionObjArgs(func, obj, value, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001421 if (res == NULL)
1422 return -1;
1423 Py_DECREF(res);
1424 return 0;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001425}
1426
Christian Heimes0449f632007-12-15 01:27:15 +00001427static PyObject *
Benjamin Peterson93964832010-06-28 03:07:10 +00001428property_copy(PyObject *old, PyObject *get, PyObject *set, PyObject *del)
Christian Heimes0449f632007-12-15 01:27:15 +00001429{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001430 propertyobject *pold = (propertyobject *)old;
Benjamin Peterson93964832010-06-28 03:07:10 +00001431 PyObject *new, *type, *doc;
Christian Heimes0449f632007-12-15 01:27:15 +00001432
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001433 type = PyObject_Type(old);
1434 if (type == NULL)
1435 return NULL;
Christian Heimes0449f632007-12-15 01:27:15 +00001436
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001437 if (get == NULL || get == Py_None) {
1438 Py_XDECREF(get);
1439 get = pold->prop_get ? pold->prop_get : Py_None;
1440 }
1441 if (set == NULL || set == Py_None) {
1442 Py_XDECREF(set);
1443 set = pold->prop_set ? pold->prop_set : Py_None;
1444 }
1445 if (del == NULL || del == Py_None) {
1446 Py_XDECREF(del);
1447 del = pold->prop_del ? pold->prop_del : Py_None;
1448 }
Benjamin Peterson93964832010-06-28 03:07:10 +00001449 if (pold->getter_doc && get != Py_None) {
1450 /* make _init use __doc__ from getter */
1451 doc = Py_None;
1452 }
1453 else {
1454 doc = pold->prop_doc ? pold->prop_doc : Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001455 }
R. David Murrayb18500d2009-05-04 22:59:07 +00001456
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001457 new = PyObject_CallFunction(type, "OOOO", get, set, del, doc);
1458 Py_DECREF(type);
1459 if (new == NULL)
1460 return NULL;
1461 return new;
Christian Heimes0449f632007-12-15 01:27:15 +00001462}
1463
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001464static int
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001465property_init(PyObject *self, PyObject *args, PyObject *kwds)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001466{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001467 PyObject *get = NULL, *set = NULL, *del = NULL, *doc = NULL;
1468 static char *kwlist[] = {"fget", "fset", "fdel", "doc", 0};
1469 propertyobject *prop = (propertyobject *)self;
Tim Peters66c1a522001-09-24 21:17:50 +00001470
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001471 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OOOO:property",
1472 kwlist, &get, &set, &del, &doc))
1473 return -1;
Tim Peters66c1a522001-09-24 21:17:50 +00001474
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001475 if (get == Py_None)
1476 get = NULL;
1477 if (set == Py_None)
1478 set = NULL;
1479 if (del == Py_None)
1480 del = NULL;
Tim Peters66c1a522001-09-24 21:17:50 +00001481
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001482 Py_XINCREF(get);
1483 Py_XINCREF(set);
1484 Py_XINCREF(del);
1485 Py_XINCREF(doc);
Christian Heimes0449f632007-12-15 01:27:15 +00001486
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001487 prop->prop_get = get;
1488 prop->prop_set = set;
1489 prop->prop_del = del;
1490 prop->prop_doc = doc;
1491 prop->getter_doc = 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001492
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001493 /* if no docstring given and the getter has one, use that one */
1494 if ((doc == NULL || doc == Py_None) && get != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001495 _Py_IDENTIFIER(__doc__);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02001496 PyObject *get_doc = _PyObject_GetAttrId(get, &PyId___doc__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001497 if (get_doc) {
1498 if (Py_TYPE(self) == &PyProperty_Type) {
1499 Py_XDECREF(prop->prop_doc);
1500 prop->prop_doc = get_doc;
1501 }
1502 else {
1503 /* If this is a property subclass, put __doc__
1504 in dict of the subclass instance instead,
1505 otherwise it gets shadowed by __doc__ in the
1506 class's dict. */
Martin v. Löwis1c67dd92011-10-14 15:16:45 +02001507 int err = _PyObject_SetAttrId(self, &PyId___doc__, get_doc);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001508 Py_DECREF(get_doc);
1509 if (err < 0)
1510 return -1;
1511 }
1512 prop->getter_doc = 1;
1513 }
1514 else if (PyErr_ExceptionMatches(PyExc_Exception)) {
1515 PyErr_Clear();
1516 }
1517 else {
1518 return -1;
1519 }
1520 }
1521
1522 return 0;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001523}
1524
Benjamin Petersonbfebb7b2011-12-15 15:34:02 -05001525static PyObject *
1526property_get___isabstractmethod__(propertyobject *prop, void *closure)
1527{
1528 int res = _PyObject_IsAbstract(prop->prop_get);
1529 if (res == -1) {
1530 return NULL;
1531 }
1532 else if (res) {
1533 Py_RETURN_TRUE;
1534 }
1535
1536 res = _PyObject_IsAbstract(prop->prop_set);
1537 if (res == -1) {
1538 return NULL;
1539 }
1540 else if (res) {
1541 Py_RETURN_TRUE;
1542 }
1543
1544 res = _PyObject_IsAbstract(prop->prop_del);
1545 if (res == -1) {
1546 return NULL;
1547 }
1548 else if (res) {
1549 Py_RETURN_TRUE;
1550 }
1551 Py_RETURN_FALSE;
1552}
1553
1554static PyGetSetDef property_getsetlist[] = {
1555 {"__isabstractmethod__",
1556 (getter)property_get___isabstractmethod__, NULL,
1557 NULL,
1558 NULL},
1559 {NULL} /* Sentinel */
1560};
1561
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001562PyDoc_STRVAR(property_doc,
Tim Peters66c1a522001-09-24 21:17:50 +00001563"property(fget=None, fset=None, fdel=None, doc=None) -> property attribute\n"
1564"\n"
1565"fget is a function to be used for getting an attribute value, and likewise\n"
1566"fset is a function for setting, and fdel a function for del'ing, an\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001567"attribute. Typical use is to define a managed attribute x:\n\n"
Guido van Rossum91c0d8a2001-08-24 09:55:51 +00001568"class C(object):\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001569" def getx(self): return self._x\n"
1570" def setx(self, value): self._x = value\n"
1571" def delx(self): del self._x\n"
1572" x = property(getx, setx, delx, \"I'm the 'x' property.\")\n"
1573"\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001574"Decorators make defining new properties or modifying existing ones easy:\n\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001575"class C(object):\n"
1576" @property\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001577" def x(self):\n"
Gregory P. Smith0e524042013-11-25 00:30:56 -08001578" \"I am the 'x' property.\"\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001579" return self._x\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001580" @x.setter\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001581" def x(self, value):\n"
1582" self._x = value\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001583" @x.deleter\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001584" def x(self):\n"
1585" del self._x\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001586);
Guido van Rossum91c0d8a2001-08-24 09:55:51 +00001587
Guido van Rossum048eb752001-10-02 21:24:57 +00001588static int
1589property_traverse(PyObject *self, visitproc visit, void *arg)
1590{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001591 propertyobject *pp = (propertyobject *)self;
1592 Py_VISIT(pp->prop_get);
1593 Py_VISIT(pp->prop_set);
1594 Py_VISIT(pp->prop_del);
1595 Py_VISIT(pp->prop_doc);
1596 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +00001597}
1598
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001599PyTypeObject PyProperty_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001600 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1601 "property", /* tp_name */
1602 sizeof(propertyobject), /* tp_basicsize */
1603 0, /* tp_itemsize */
1604 /* methods */
1605 property_dealloc, /* tp_dealloc */
1606 0, /* tp_print */
1607 0, /* tp_getattr */
1608 0, /* tp_setattr */
1609 0, /* tp_reserved */
1610 0, /* tp_repr */
1611 0, /* tp_as_number */
1612 0, /* tp_as_sequence */
1613 0, /* tp_as_mapping */
1614 0, /* tp_hash */
1615 0, /* tp_call */
1616 0, /* tp_str */
1617 PyObject_GenericGetAttr, /* tp_getattro */
1618 0, /* tp_setattro */
1619 0, /* tp_as_buffer */
1620 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
1621 Py_TPFLAGS_BASETYPE, /* tp_flags */
1622 property_doc, /* tp_doc */
1623 property_traverse, /* tp_traverse */
1624 0, /* tp_clear */
1625 0, /* tp_richcompare */
1626 0, /* tp_weaklistoffset */
1627 0, /* tp_iter */
1628 0, /* tp_iternext */
1629 property_methods, /* tp_methods */
1630 property_members, /* tp_members */
Benjamin Petersonbfebb7b2011-12-15 15:34:02 -05001631 property_getsetlist, /* tp_getset */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001632 0, /* tp_base */
1633 0, /* tp_dict */
1634 property_descr_get, /* tp_descr_get */
1635 property_descr_set, /* tp_descr_set */
1636 0, /* tp_dictoffset */
1637 property_init, /* tp_init */
1638 PyType_GenericAlloc, /* tp_alloc */
1639 PyType_GenericNew, /* tp_new */
1640 PyObject_GC_Del, /* tp_free */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001641};