blob: ed398919a34f662ce9dede644bb716ac6679f49c [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 *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020025descr_repr(PyDescrObject *descr, const char *format)
Tim Peters6d6c1a32001-08-02 04:15:00 +000026{
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;
Victor Stinner2990fa12016-08-22 23:21:55 +0200216 PyObject *self, *func, *result, **stack;
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;
Victor Stinner2990fa12016-08-22 23:21:55 +0200245 stack = &PyTuple_GET_ITEM(args, 1);
246 result = _PyObject_FastCallDict(func, stack, argc - 1, kwds);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000247 Py_DECREF(func);
248 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000249}
250
251static PyObject *
Tim Petersbca1cbc2002-12-09 22:56:13 +0000252classmethoddescr_call(PyMethodDescrObject *descr, PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000253 PyObject *kwds)
Tim Petersbca1cbc2002-12-09 22:56:13 +0000254{
Benjamin Peterson7295c6a2012-05-01 09:51:09 -0400255 Py_ssize_t argc;
Victor Stinner2990fa12016-08-22 23:21:55 +0200256 PyObject *self, *func, *result, **stack;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000257
Benjamin Peterson7295c6a2012-05-01 09:51:09 -0400258 /* Make sure that the first argument is acceptable as 'self' */
259 assert(PyTuple_Check(args));
260 argc = PyTuple_GET_SIZE(args);
261 if (argc < 1) {
262 PyErr_Format(PyExc_TypeError,
263 "descriptor '%V' of '%.100s' "
264 "object needs an argument",
265 descr_name((PyDescrObject *)descr), "?",
266 PyDescr_TYPE(descr)->tp_name);
267 return NULL;
268 }
269 self = PyTuple_GET_ITEM(args, 0);
270 if (!PyType_Check(self)) {
271 PyErr_Format(PyExc_TypeError,
272 "descriptor '%V' requires a type "
273 "but received a '%.100s'",
274 descr_name((PyDescrObject *)descr), "?",
275 PyDescr_TYPE(descr)->tp_name,
276 self->ob_type->tp_name);
277 return NULL;
278 }
279 if (!PyType_IsSubtype((PyTypeObject *)self, PyDescr_TYPE(descr))) {
280 PyErr_Format(PyExc_TypeError,
281 "descriptor '%V' "
282 "requires a subtype of '%.100s' "
283 "but received '%.100s",
284 descr_name((PyDescrObject *)descr), "?",
285 PyDescr_TYPE(descr)->tp_name,
286 self->ob_type->tp_name);
287 return NULL;
288 }
289
Andrew Svetlov3ba3a3e2012-12-25 13:32:35 +0200290 func = PyCFunction_NewEx(descr->d_method, self, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000291 if (func == NULL)
292 return NULL;
Victor Stinner2990fa12016-08-22 23:21:55 +0200293 stack = &PyTuple_GET_ITEM(args, 1);
294 result = _PyObject_FastCallDict(func, stack, argc - 1, kwds);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000295 Py_DECREF(func);
296 return result;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000297}
298
299static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000300wrapperdescr_call(PyWrapperDescrObject *descr, PyObject *args, PyObject *kwds)
301{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000302 Py_ssize_t argc;
Victor Stinner2990fa12016-08-22 23:21:55 +0200303 PyObject *self, *func, *result, **stack;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000304
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000305 /* Make sure that the first argument is acceptable as 'self' */
306 assert(PyTuple_Check(args));
307 argc = PyTuple_GET_SIZE(args);
308 if (argc < 1) {
309 PyErr_Format(PyExc_TypeError,
310 "descriptor '%V' of '%.100s' "
311 "object needs an argument",
312 descr_name((PyDescrObject *)descr), "?",
313 PyDescr_TYPE(descr)->tp_name);
314 return NULL;
315 }
316 self = PyTuple_GET_ITEM(args, 0);
Victor Stinner3249dec2011-05-01 23:19:15 +0200317 if (!_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self),
Victor Stinnerd9561312011-05-01 23:31:36 +0200318 (PyObject *)PyDescr_TYPE(descr))) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000319 PyErr_Format(PyExc_TypeError,
320 "descriptor '%V' "
321 "requires a '%.100s' object "
322 "but received a '%.100s'",
323 descr_name((PyDescrObject *)descr), "?",
324 PyDescr_TYPE(descr)->tp_name,
325 self->ob_type->tp_name);
326 return NULL;
327 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000328
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000329 func = PyWrapper_New((PyObject *)descr, self);
330 if (func == NULL)
331 return NULL;
Victor Stinner2990fa12016-08-22 23:21:55 +0200332
333 stack = &PyTuple_GET_ITEM(args, 1);
334 result = _PyObject_FastCallDict(func, stack, argc - 1, kwds);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000335 Py_DECREF(func);
336 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000337}
338
339static PyObject *
Guido van Rossum6f799372001-09-20 20:46:19 +0000340method_get_doc(PyMethodDescrObject *descr, void *closure)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000341{
Larry Hastings2623c8c2014-02-08 22:15:29 -0800342 return _PyType_GetDocFromInternalDoc(descr->d_method->ml_name, descr->d_method->ml_doc);
Larry Hastings5c661892014-01-24 06:17:25 -0800343}
344
345static PyObject *
346method_get_text_signature(PyMethodDescrObject *descr, void *closure)
347{
Larry Hastings2623c8c2014-02-08 22:15:29 -0800348 return _PyType_GetTextSignatureFromInternalDoc(descr->d_method->ml_name, descr->d_method->ml_doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000349}
350
Antoine Pitrou9d574812011-12-12 13:47:25 +0100351static PyObject *
352calculate_qualname(PyDescrObject *descr)
353{
354 PyObject *type_qualname, *res;
355 _Py_IDENTIFIER(__qualname__);
356
357 if (descr->d_name == NULL || !PyUnicode_Check(descr->d_name)) {
358 PyErr_SetString(PyExc_TypeError,
359 "<descriptor>.__name__ is not a unicode object");
360 return NULL;
361 }
362
363 type_qualname = _PyObject_GetAttrId((PyObject *)descr->d_type,
364 &PyId___qualname__);
365 if (type_qualname == NULL)
366 return NULL;
367
368 if (!PyUnicode_Check(type_qualname)) {
369 PyErr_SetString(PyExc_TypeError, "<descriptor>.__objclass__."
370 "__qualname__ is not a unicode object");
371 Py_XDECREF(type_qualname);
372 return NULL;
373 }
374
375 res = PyUnicode_FromFormat("%S.%S", type_qualname, descr->d_name);
376 Py_DECREF(type_qualname);
377 return res;
378}
379
380static PyObject *
381descr_get_qualname(PyDescrObject *descr)
382{
383 if (descr->d_qualname == NULL)
384 descr->d_qualname = calculate_qualname(descr);
385 Py_XINCREF(descr->d_qualname);
386 return descr->d_qualname;
387}
388
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100389static PyObject *
390descr_reduce(PyDescrObject *descr)
391{
392 PyObject *builtins;
393 PyObject *getattr;
394 _Py_IDENTIFIER(getattr);
395
396 builtins = PyEval_GetBuiltins();
397 getattr = _PyDict_GetItemId(builtins, &PyId_getattr);
398 return Py_BuildValue("O(OO)", getattr, PyDescr_TYPE(descr),
399 PyDescr_NAME(descr));
400}
401
402static PyMethodDef descr_methods[] = {
403 {"__reduce__", (PyCFunction)descr_reduce, METH_NOARGS, NULL},
404 {NULL, NULL}
405};
406
Guido van Rossum6f799372001-09-20 20:46:19 +0000407static PyMemberDef descr_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000408 {"__objclass__", T_OBJECT, offsetof(PyDescrObject, d_type), READONLY},
409 {"__name__", T_OBJECT, offsetof(PyDescrObject, d_name), READONLY},
410 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000411};
412
Guido van Rossum32d34c82001-09-20 21:45:26 +0000413static PyGetSetDef method_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000414 {"__doc__", (getter)method_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100415 {"__qualname__", (getter)descr_get_qualname},
Larry Hastings5c661892014-01-24 06:17:25 -0800416 {"__text_signature__", (getter)method_get_text_signature},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000417 {0}
Guido van Rossum6f799372001-09-20 20:46:19 +0000418};
419
420static PyObject *
421member_get_doc(PyMemberDescrObject *descr, void *closure)
422{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000423 if (descr->d_member->doc == NULL) {
424 Py_INCREF(Py_None);
425 return Py_None;
426 }
427 return PyUnicode_FromString(descr->d_member->doc);
Guido van Rossum6f799372001-09-20 20:46:19 +0000428}
429
Guido van Rossum32d34c82001-09-20 21:45:26 +0000430static PyGetSetDef member_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000431 {"__doc__", (getter)member_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100432 {"__qualname__", (getter)descr_get_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000433 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000434};
435
436static PyObject *
Guido van Rossum32d34c82001-09-20 21:45:26 +0000437getset_get_doc(PyGetSetDescrObject *descr, void *closure)
438{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000439 if (descr->d_getset->doc == NULL) {
440 Py_INCREF(Py_None);
441 return Py_None;
442 }
443 return PyUnicode_FromString(descr->d_getset->doc);
Guido van Rossum32d34c82001-09-20 21:45:26 +0000444}
445
446static PyGetSetDef getset_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000447 {"__doc__", (getter)getset_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100448 {"__qualname__", (getter)descr_get_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000449 {0}
Guido van Rossum32d34c82001-09-20 21:45:26 +0000450};
451
452static PyObject *
Armin Rigoc6686b72005-11-07 08:38:00 +0000453wrapperdescr_get_doc(PyWrapperDescrObject *descr, void *closure)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000454{
Larry Hastings2623c8c2014-02-08 22:15:29 -0800455 return _PyType_GetDocFromInternalDoc(descr->d_base->name, descr->d_base->doc);
Larry Hastings5c661892014-01-24 06:17:25 -0800456}
457
458static PyObject *
459wrapperdescr_get_text_signature(PyWrapperDescrObject *descr, void *closure)
460{
Larry Hastings2623c8c2014-02-08 22:15:29 -0800461 return _PyType_GetTextSignatureFromInternalDoc(descr->d_base->name, descr->d_base->doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000462}
463
Armin Rigoc6686b72005-11-07 08:38:00 +0000464static PyGetSetDef wrapperdescr_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000465 {"__doc__", (getter)wrapperdescr_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100466 {"__qualname__", (getter)descr_get_qualname},
Larry Hastings5c661892014-01-24 06:17:25 -0800467 {"__text_signature__", (getter)wrapperdescr_get_text_signature},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000468 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000469};
470
Guido van Rossum048eb752001-10-02 21:24:57 +0000471static int
472descr_traverse(PyObject *self, visitproc visit, void *arg)
473{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000474 PyDescrObject *descr = (PyDescrObject *)self;
475 Py_VISIT(descr->d_type);
476 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +0000477}
478
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000479PyTypeObject PyMethodDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000480 PyVarObject_HEAD_INIT(&PyType_Type, 0)
481 "method_descriptor",
482 sizeof(PyMethodDescrObject),
483 0,
484 (destructor)descr_dealloc, /* tp_dealloc */
485 0, /* tp_print */
486 0, /* tp_getattr */
487 0, /* tp_setattr */
488 0, /* tp_reserved */
489 (reprfunc)method_repr, /* tp_repr */
490 0, /* tp_as_number */
491 0, /* tp_as_sequence */
492 0, /* tp_as_mapping */
493 0, /* tp_hash */
494 (ternaryfunc)methoddescr_call, /* tp_call */
495 0, /* tp_str */
496 PyObject_GenericGetAttr, /* tp_getattro */
497 0, /* tp_setattro */
498 0, /* tp_as_buffer */
499 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
500 0, /* tp_doc */
501 descr_traverse, /* tp_traverse */
502 0, /* tp_clear */
503 0, /* tp_richcompare */
504 0, /* tp_weaklistoffset */
505 0, /* tp_iter */
506 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100507 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000508 descr_members, /* tp_members */
509 method_getset, /* tp_getset */
510 0, /* tp_base */
511 0, /* tp_dict */
512 (descrgetfunc)method_get, /* tp_descr_get */
513 0, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000514};
515
Guido van Rossumb6e5a0c2003-02-11 18:44:42 +0000516/* This is for METH_CLASS in C, not for "f = classmethod(f)" in Python! */
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000517PyTypeObject PyClassMethodDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000518 PyVarObject_HEAD_INIT(&PyType_Type, 0)
519 "classmethod_descriptor",
520 sizeof(PyMethodDescrObject),
521 0,
522 (destructor)descr_dealloc, /* tp_dealloc */
523 0, /* tp_print */
524 0, /* tp_getattr */
525 0, /* tp_setattr */
526 0, /* tp_reserved */
527 (reprfunc)method_repr, /* tp_repr */
528 0, /* tp_as_number */
529 0, /* tp_as_sequence */
530 0, /* tp_as_mapping */
531 0, /* tp_hash */
532 (ternaryfunc)classmethoddescr_call, /* tp_call */
533 0, /* tp_str */
534 PyObject_GenericGetAttr, /* tp_getattro */
535 0, /* tp_setattro */
536 0, /* tp_as_buffer */
537 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
538 0, /* tp_doc */
539 descr_traverse, /* tp_traverse */
540 0, /* tp_clear */
541 0, /* tp_richcompare */
542 0, /* tp_weaklistoffset */
543 0, /* tp_iter */
544 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100545 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000546 descr_members, /* tp_members */
547 method_getset, /* tp_getset */
548 0, /* tp_base */
549 0, /* tp_dict */
550 (descrgetfunc)classmethod_get, /* tp_descr_get */
551 0, /* tp_descr_set */
Tim Petersbca1cbc2002-12-09 22:56:13 +0000552};
553
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000554PyTypeObject PyMemberDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000555 PyVarObject_HEAD_INIT(&PyType_Type, 0)
556 "member_descriptor",
557 sizeof(PyMemberDescrObject),
558 0,
559 (destructor)descr_dealloc, /* tp_dealloc */
560 0, /* tp_print */
561 0, /* tp_getattr */
562 0, /* tp_setattr */
563 0, /* tp_reserved */
564 (reprfunc)member_repr, /* tp_repr */
565 0, /* tp_as_number */
566 0, /* tp_as_sequence */
567 0, /* tp_as_mapping */
568 0, /* tp_hash */
569 0, /* tp_call */
570 0, /* tp_str */
571 PyObject_GenericGetAttr, /* tp_getattro */
572 0, /* tp_setattro */
573 0, /* tp_as_buffer */
574 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
575 0, /* tp_doc */
576 descr_traverse, /* tp_traverse */
577 0, /* tp_clear */
578 0, /* tp_richcompare */
579 0, /* tp_weaklistoffset */
580 0, /* tp_iter */
581 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100582 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000583 descr_members, /* tp_members */
584 member_getset, /* tp_getset */
585 0, /* tp_base */
586 0, /* tp_dict */
587 (descrgetfunc)member_get, /* tp_descr_get */
588 (descrsetfunc)member_set, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000589};
590
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000591PyTypeObject PyGetSetDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000592 PyVarObject_HEAD_INIT(&PyType_Type, 0)
593 "getset_descriptor",
594 sizeof(PyGetSetDescrObject),
595 0,
596 (destructor)descr_dealloc, /* tp_dealloc */
597 0, /* tp_print */
598 0, /* tp_getattr */
599 0, /* tp_setattr */
600 0, /* tp_reserved */
601 (reprfunc)getset_repr, /* tp_repr */
602 0, /* tp_as_number */
603 0, /* tp_as_sequence */
604 0, /* tp_as_mapping */
605 0, /* tp_hash */
606 0, /* tp_call */
607 0, /* tp_str */
608 PyObject_GenericGetAttr, /* tp_getattro */
609 0, /* tp_setattro */
610 0, /* tp_as_buffer */
611 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
612 0, /* tp_doc */
613 descr_traverse, /* tp_traverse */
614 0, /* tp_clear */
615 0, /* tp_richcompare */
616 0, /* tp_weaklistoffset */
617 0, /* tp_iter */
618 0, /* tp_iternext */
619 0, /* tp_methods */
620 descr_members, /* tp_members */
621 getset_getset, /* tp_getset */
622 0, /* tp_base */
623 0, /* tp_dict */
624 (descrgetfunc)getset_get, /* tp_descr_get */
625 (descrsetfunc)getset_set, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000626};
627
Guido van Rossumf4593e02001-10-03 12:09:30 +0000628PyTypeObject PyWrapperDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000629 PyVarObject_HEAD_INIT(&PyType_Type, 0)
630 "wrapper_descriptor",
631 sizeof(PyWrapperDescrObject),
632 0,
633 (destructor)descr_dealloc, /* tp_dealloc */
634 0, /* tp_print */
635 0, /* tp_getattr */
636 0, /* tp_setattr */
637 0, /* tp_reserved */
638 (reprfunc)wrapperdescr_repr, /* tp_repr */
639 0, /* tp_as_number */
640 0, /* tp_as_sequence */
641 0, /* tp_as_mapping */
642 0, /* tp_hash */
643 (ternaryfunc)wrapperdescr_call, /* tp_call */
644 0, /* tp_str */
645 PyObject_GenericGetAttr, /* tp_getattro */
646 0, /* tp_setattro */
647 0, /* tp_as_buffer */
648 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
649 0, /* tp_doc */
650 descr_traverse, /* tp_traverse */
651 0, /* tp_clear */
652 0, /* tp_richcompare */
653 0, /* tp_weaklistoffset */
654 0, /* tp_iter */
655 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100656 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000657 descr_members, /* tp_members */
658 wrapperdescr_getset, /* tp_getset */
659 0, /* tp_base */
660 0, /* tp_dict */
661 (descrgetfunc)wrapperdescr_get, /* tp_descr_get */
662 0, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000663};
664
665static PyDescrObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000666descr_new(PyTypeObject *descrtype, PyTypeObject *type, const char *name)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000667{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000668 PyDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000669
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000670 descr = (PyDescrObject *)PyType_GenericAlloc(descrtype, 0);
671 if (descr != NULL) {
672 Py_XINCREF(type);
673 descr->d_type = type;
674 descr->d_name = PyUnicode_InternFromString(name);
675 if (descr->d_name == NULL) {
676 Py_DECREF(descr);
677 descr = NULL;
678 }
Benjamin Petersonf2fe7f02011-12-17 08:02:20 -0500679 else {
680 descr->d_qualname = NULL;
681 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000682 }
683 return descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000684}
685
686PyObject *
687PyDescr_NewMethod(PyTypeObject *type, PyMethodDef *method)
688{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000689 PyMethodDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000690
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000691 descr = (PyMethodDescrObject *)descr_new(&PyMethodDescr_Type,
692 type, method->ml_name);
693 if (descr != NULL)
694 descr->d_method = method;
695 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000696}
697
698PyObject *
Tim Petersbca1cbc2002-12-09 22:56:13 +0000699PyDescr_NewClassMethod(PyTypeObject *type, PyMethodDef *method)
700{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000701 PyMethodDescrObject *descr;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000702
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000703 descr = (PyMethodDescrObject *)descr_new(&PyClassMethodDescr_Type,
704 type, method->ml_name);
705 if (descr != NULL)
706 descr->d_method = method;
707 return (PyObject *)descr;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000708}
709
710PyObject *
Guido van Rossum6f799372001-09-20 20:46:19 +0000711PyDescr_NewMember(PyTypeObject *type, PyMemberDef *member)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000712{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000713 PyMemberDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000714
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000715 descr = (PyMemberDescrObject *)descr_new(&PyMemberDescr_Type,
716 type, member->name);
717 if (descr != NULL)
718 descr->d_member = member;
719 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000720}
721
722PyObject *
Guido van Rossum32d34c82001-09-20 21:45:26 +0000723PyDescr_NewGetSet(PyTypeObject *type, PyGetSetDef *getset)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000724{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000725 PyGetSetDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000726
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000727 descr = (PyGetSetDescrObject *)descr_new(&PyGetSetDescr_Type,
728 type, getset->name);
729 if (descr != NULL)
730 descr->d_getset = getset;
731 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000732}
733
734PyObject *
735PyDescr_NewWrapper(PyTypeObject *type, struct wrapperbase *base, void *wrapped)
736{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000737 PyWrapperDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000738
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000739 descr = (PyWrapperDescrObject *)descr_new(&PyWrapperDescr_Type,
740 type, base->name);
741 if (descr != NULL) {
742 descr->d_base = base;
743 descr->d_wrapped = wrapped;
744 }
745 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000746}
747
Tim Peters6d6c1a32001-08-02 04:15:00 +0000748
Victor Stinner0db176f2012-04-16 00:16:30 +0200749/* --- mappingproxy: read-only proxy for mappings --- */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000750
751/* This has no reason to be in this file except that adding new files is a
752 bit of a pain */
753
754typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000755 PyObject_HEAD
Victor Stinner0db176f2012-04-16 00:16:30 +0200756 PyObject *mapping;
757} mappingproxyobject;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000758
Martin v. Löwis18e16552006-02-15 17:27:45 +0000759static Py_ssize_t
Victor Stinner0db176f2012-04-16 00:16:30 +0200760mappingproxy_len(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000761{
Victor Stinner0db176f2012-04-16 00:16:30 +0200762 return PyObject_Size(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000763}
764
765static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200766mappingproxy_getitem(mappingproxyobject *pp, PyObject *key)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000767{
Victor Stinner0db176f2012-04-16 00:16:30 +0200768 return PyObject_GetItem(pp->mapping, key);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000769}
770
Victor Stinner0db176f2012-04-16 00:16:30 +0200771static PyMappingMethods mappingproxy_as_mapping = {
772 (lenfunc)mappingproxy_len, /* mp_length */
773 (binaryfunc)mappingproxy_getitem, /* mp_subscript */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000774 0, /* mp_ass_subscript */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000775};
776
777static int
Victor Stinner0db176f2012-04-16 00:16:30 +0200778mappingproxy_contains(mappingproxyobject *pp, PyObject *key)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000779{
Victor Stinner0db176f2012-04-16 00:16:30 +0200780 if (PyDict_CheckExact(pp->mapping))
781 return PyDict_Contains(pp->mapping, key);
782 else
783 return PySequence_Contains(pp->mapping, key);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000784}
785
Victor Stinner0db176f2012-04-16 00:16:30 +0200786static PySequenceMethods mappingproxy_as_sequence = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000787 0, /* sq_length */
788 0, /* sq_concat */
789 0, /* sq_repeat */
790 0, /* sq_item */
791 0, /* sq_slice */
792 0, /* sq_ass_item */
793 0, /* sq_ass_slice */
Victor Stinner0db176f2012-04-16 00:16:30 +0200794 (objobjproc)mappingproxy_contains, /* sq_contains */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000795 0, /* sq_inplace_concat */
796 0, /* sq_inplace_repeat */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000797};
798
799static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200800mappingproxy_get(mappingproxyobject *pp, PyObject *args)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000801{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000802 PyObject *key, *def = Py_None;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200803 _Py_IDENTIFIER(get);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000804
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000805 if (!PyArg_UnpackTuple(args, "get", 1, 2, &key, &def))
806 return NULL;
Victor Stinner7e425412016-12-09 00:36:19 +0100807 return _PyObject_CallMethodIdObjArgs(pp->mapping, &PyId_get,
808 key, def, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000809}
810
811static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200812mappingproxy_keys(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000813{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200814 _Py_IDENTIFIER(keys);
Victor Stinner0db176f2012-04-16 00:16:30 +0200815 return _PyObject_CallMethodId(pp->mapping, &PyId_keys, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000816}
817
818static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200819mappingproxy_values(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000820{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200821 _Py_IDENTIFIER(values);
Victor Stinner0db176f2012-04-16 00:16:30 +0200822 return _PyObject_CallMethodId(pp->mapping, &PyId_values, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000823}
824
825static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200826mappingproxy_items(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000827{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200828 _Py_IDENTIFIER(items);
Victor Stinner0db176f2012-04-16 00:16:30 +0200829 return _PyObject_CallMethodId(pp->mapping, &PyId_items, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000830}
831
832static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200833mappingproxy_copy(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000834{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200835 _Py_IDENTIFIER(copy);
Victor Stinner0db176f2012-04-16 00:16:30 +0200836 return _PyObject_CallMethodId(pp->mapping, &PyId_copy, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000837}
838
Victor Stinner0db176f2012-04-16 00:16:30 +0200839/* WARNING: mappingproxy methods must not give access
840 to the underlying mapping */
841
842static PyMethodDef mappingproxy_methods[] = {
843 {"get", (PyCFunction)mappingproxy_get, METH_VARARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000844 PyDoc_STR("D.get(k[,d]) -> D[k] if k in D, else d."
Victor Stinner0db176f2012-04-16 00:16:30 +0200845 " d defaults to None.")},
846 {"keys", (PyCFunction)mappingproxy_keys, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000847 PyDoc_STR("D.keys() -> list of D's keys")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200848 {"values", (PyCFunction)mappingproxy_values, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000849 PyDoc_STR("D.values() -> list of D's values")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200850 {"items", (PyCFunction)mappingproxy_items, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000851 PyDoc_STR("D.items() -> list of D's (key, value) pairs, as 2-tuples")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200852 {"copy", (PyCFunction)mappingproxy_copy, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000853 PyDoc_STR("D.copy() -> a shallow copy of D")},
854 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000855};
856
857static void
Victor Stinner0db176f2012-04-16 00:16:30 +0200858mappingproxy_dealloc(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000859{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000860 _PyObject_GC_UNTRACK(pp);
Victor Stinner0db176f2012-04-16 00:16:30 +0200861 Py_DECREF(pp->mapping);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000862 PyObject_GC_Del(pp);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000863}
864
865static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200866mappingproxy_getiter(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000867{
Victor Stinner0db176f2012-04-16 00:16:30 +0200868 return PyObject_GetIter(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000869}
870
Neil Schemenauer26775122001-10-21 22:26:43 +0000871static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200872mappingproxy_str(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000873{
Victor Stinner0db176f2012-04-16 00:16:30 +0200874 return PyObject_Str(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000875}
876
Ezio Melottiac53ab62010-12-18 14:59:43 +0000877static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200878mappingproxy_repr(mappingproxyobject *pp)
Ezio Melottiac53ab62010-12-18 14:59:43 +0000879{
Victor Stinner0db176f2012-04-16 00:16:30 +0200880 return PyUnicode_FromFormat("mappingproxy(%R)", pp->mapping);
Ezio Melottiac53ab62010-12-18 14:59:43 +0000881}
882
Guido van Rossum048eb752001-10-02 21:24:57 +0000883static int
Victor Stinner0db176f2012-04-16 00:16:30 +0200884mappingproxy_traverse(PyObject *self, visitproc visit, void *arg)
Guido van Rossum048eb752001-10-02 21:24:57 +0000885{
Victor Stinner0db176f2012-04-16 00:16:30 +0200886 mappingproxyobject *pp = (mappingproxyobject *)self;
887 Py_VISIT(pp->mapping);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000888 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +0000889}
890
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000891static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200892mappingproxy_richcompare(mappingproxyobject *v, PyObject *w, int op)
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000893{
Victor Stinner0db176f2012-04-16 00:16:30 +0200894 return PyObject_RichCompare(v->mapping, w, op);
895}
896
897static int
898mappingproxy_check_mapping(PyObject *mapping)
899{
900 if (!PyMapping_Check(mapping)
901 || PyList_Check(mapping)
902 || PyTuple_Check(mapping)) {
903 PyErr_Format(PyExc_TypeError,
904 "mappingproxy() argument must be a mapping, not %s",
905 Py_TYPE(mapping)->tp_name);
906 return -1;
907 }
908 return 0;
909}
910
911static PyObject*
912mappingproxy_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
913{
914 static char *kwlist[] = {"mapping", NULL};
915 PyObject *mapping;
916 mappingproxyobject *mappingproxy;
917
918 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O:mappingproxy",
919 kwlist, &mapping))
920 return NULL;
921
922 if (mappingproxy_check_mapping(mapping) == -1)
923 return NULL;
924
925 mappingproxy = PyObject_GC_New(mappingproxyobject, &PyDictProxy_Type);
926 if (mappingproxy == NULL)
927 return NULL;
928 Py_INCREF(mapping);
929 mappingproxy->mapping = mapping;
930 _PyObject_GC_TRACK(mappingproxy);
931 return (PyObject *)mappingproxy;
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000932}
933
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000934PyTypeObject PyDictProxy_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000935 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Victor Stinner0db176f2012-04-16 00:16:30 +0200936 "mappingproxy", /* tp_name */
937 sizeof(mappingproxyobject), /* tp_basicsize */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000938 0, /* tp_itemsize */
939 /* methods */
Victor Stinner0db176f2012-04-16 00:16:30 +0200940 (destructor)mappingproxy_dealloc, /* tp_dealloc */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000941 0, /* tp_print */
942 0, /* tp_getattr */
943 0, /* tp_setattr */
944 0, /* tp_reserved */
Victor Stinner0db176f2012-04-16 00:16:30 +0200945 (reprfunc)mappingproxy_repr, /* tp_repr */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000946 0, /* tp_as_number */
Victor Stinner0db176f2012-04-16 00:16:30 +0200947 &mappingproxy_as_sequence, /* tp_as_sequence */
948 &mappingproxy_as_mapping, /* tp_as_mapping */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000949 0, /* tp_hash */
950 0, /* tp_call */
Victor Stinner0db176f2012-04-16 00:16:30 +0200951 (reprfunc)mappingproxy_str, /* tp_str */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000952 PyObject_GenericGetAttr, /* tp_getattro */
953 0, /* tp_setattro */
954 0, /* tp_as_buffer */
955 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
956 0, /* tp_doc */
Victor Stinner0db176f2012-04-16 00:16:30 +0200957 mappingproxy_traverse, /* tp_traverse */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 0, /* tp_clear */
Victor Stinner0db176f2012-04-16 00:16:30 +0200959 (richcmpfunc)mappingproxy_richcompare, /* tp_richcompare */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000960 0, /* tp_weaklistoffset */
Victor Stinner0db176f2012-04-16 00:16:30 +0200961 (getiterfunc)mappingproxy_getiter, /* tp_iter */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000962 0, /* tp_iternext */
Victor Stinner0db176f2012-04-16 00:16:30 +0200963 mappingproxy_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000964 0, /* tp_members */
965 0, /* tp_getset */
966 0, /* tp_base */
967 0, /* tp_dict */
968 0, /* tp_descr_get */
969 0, /* tp_descr_set */
Victor Stinner0db176f2012-04-16 00:16:30 +0200970 0, /* tp_dictoffset */
971 0, /* tp_init */
972 0, /* tp_alloc */
973 mappingproxy_new, /* tp_new */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000974};
975
976PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200977PyDictProxy_New(PyObject *mapping)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000978{
Victor Stinner0db176f2012-04-16 00:16:30 +0200979 mappingproxyobject *pp;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000980
Victor Stinner0db176f2012-04-16 00:16:30 +0200981 if (mappingproxy_check_mapping(mapping) == -1)
982 return NULL;
983
984 pp = PyObject_GC_New(mappingproxyobject, &PyDictProxy_Type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000985 if (pp != NULL) {
Victor Stinner0db176f2012-04-16 00:16:30 +0200986 Py_INCREF(mapping);
987 pp->mapping = mapping;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000988 _PyObject_GC_TRACK(pp);
989 }
990 return (PyObject *)pp;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000991}
992
993
994/* --- Wrapper object for "slot" methods --- */
995
996/* This has no reason to be in this file except that adding new files is a
997 bit of a pain */
998
999typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001000 PyObject_HEAD
1001 PyWrapperDescrObject *descr;
1002 PyObject *self;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001003} wrapperobject;
1004
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001005#define Wrapper_Check(v) (Py_TYPE(v) == &_PyMethodWrapper_Type)
Mark Dickinson211c6252009-02-01 10:28:51 +00001006
Tim Peters6d6c1a32001-08-02 04:15:00 +00001007static void
1008wrapper_dealloc(wrapperobject *wp)
1009{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001010 PyObject_GC_UnTrack(wp);
1011 Py_TRASHCAN_SAFE_BEGIN(wp)
1012 Py_XDECREF(wp->descr);
1013 Py_XDECREF(wp->self);
1014 PyObject_GC_Del(wp);
1015 Py_TRASHCAN_SAFE_END(wp)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001016}
1017
Mark Dickinson211c6252009-02-01 10:28:51 +00001018#define TEST_COND(cond) ((cond) ? Py_True : Py_False)
1019
1020static PyObject *
1021wrapper_richcompare(PyObject *a, PyObject *b, int op)
Armin Rigoc6686b72005-11-07 08:38:00 +00001022{
Benjamin Petersonca470632016-09-06 13:47:26 -07001023 intptr_t result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001024 PyObject *v;
1025 PyWrapperDescrObject *a_descr, *b_descr;
Mark Dickinson211c6252009-02-01 10:28:51 +00001026
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001027 assert(a != NULL && b != NULL);
Mark Dickinson211c6252009-02-01 10:28:51 +00001028
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001029 /* both arguments should be wrapperobjects */
1030 if (!Wrapper_Check(a) || !Wrapper_Check(b)) {
1031 v = Py_NotImplemented;
1032 Py_INCREF(v);
1033 return v;
1034 }
Mark Dickinson211c6252009-02-01 10:28:51 +00001035
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001036 /* compare by descriptor address; if the descriptors are the same,
1037 compare by the objects they're bound to */
1038 a_descr = ((wrapperobject *)a)->descr;
1039 b_descr = ((wrapperobject *)b)->descr;
1040 if (a_descr == b_descr) {
1041 a = ((wrapperobject *)a)->self;
1042 b = ((wrapperobject *)b)->self;
1043 return PyObject_RichCompare(a, b, op);
1044 }
Mark Dickinson211c6252009-02-01 10:28:51 +00001045
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001046 result = a_descr - b_descr;
1047 switch (op) {
1048 case Py_EQ:
1049 v = TEST_COND(result == 0);
1050 break;
1051 case Py_NE:
1052 v = TEST_COND(result != 0);
1053 break;
1054 case Py_LE:
1055 v = TEST_COND(result <= 0);
1056 break;
1057 case Py_GE:
1058 v = TEST_COND(result >= 0);
1059 break;
1060 case Py_LT:
1061 v = TEST_COND(result < 0);
1062 break;
1063 case Py_GT:
1064 v = TEST_COND(result > 0);
1065 break;
1066 default:
1067 PyErr_BadArgument();
1068 return NULL;
1069 }
1070 Py_INCREF(v);
1071 return v;
Armin Rigoc6686b72005-11-07 08:38:00 +00001072}
1073
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001074static Py_hash_t
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001075wrapper_hash(wrapperobject *wp)
1076{
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001077 Py_hash_t x, y;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001078 x = _Py_HashPointer(wp->descr);
1079 if (x == -1)
1080 return -1;
1081 y = PyObject_Hash(wp->self);
1082 if (y == -1)
1083 return -1;
1084 x = x ^ y;
1085 if (x == -1)
1086 x = -2;
1087 return x;
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001088}
1089
Armin Rigoc6686b72005-11-07 08:38:00 +00001090static PyObject *
1091wrapper_repr(wrapperobject *wp)
1092{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001093 return PyUnicode_FromFormat("<method-wrapper '%s' of %s object at %p>",
1094 wp->descr->d_base->name,
1095 wp->self->ob_type->tp_name,
1096 wp->self);
Armin Rigoc6686b72005-11-07 08:38:00 +00001097}
1098
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001099static PyObject *
1100wrapper_reduce(wrapperobject *wp)
1101{
1102 PyObject *builtins;
1103 PyObject *getattr;
1104 _Py_IDENTIFIER(getattr);
1105
1106 builtins = PyEval_GetBuiltins();
1107 getattr = _PyDict_GetItemId(builtins, &PyId_getattr);
1108 return Py_BuildValue("O(OO)", getattr, wp->self, PyDescr_NAME(wp->descr));
1109}
1110
1111static PyMethodDef wrapper_methods[] = {
1112 {"__reduce__", (PyCFunction)wrapper_reduce, METH_NOARGS, NULL},
1113 {NULL, NULL}
1114};
1115
Armin Rigoc6686b72005-11-07 08:38:00 +00001116static PyMemberDef wrapper_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001117 {"__self__", T_OBJECT, offsetof(wrapperobject, self), READONLY},
1118 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001119};
1120
1121static PyObject *
Armin Rigoc6686b72005-11-07 08:38:00 +00001122wrapper_objclass(wrapperobject *wp)
1123{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001124 PyObject *c = (PyObject *)PyDescr_TYPE(wp->descr);
Armin Rigoc6686b72005-11-07 08:38:00 +00001125
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001126 Py_INCREF(c);
1127 return c;
Armin Rigoc6686b72005-11-07 08:38:00 +00001128}
1129
1130static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001131wrapper_name(wrapperobject *wp)
1132{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001133 const char *s = wp->descr->d_base->name;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001134
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001135 return PyUnicode_FromString(s);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001136}
1137
1138static PyObject *
Larry Hastings5c661892014-01-24 06:17:25 -08001139wrapper_doc(wrapperobject *wp, void *closure)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001140{
Larry Hastings2623c8c2014-02-08 22:15:29 -08001141 return _PyType_GetDocFromInternalDoc(wp->descr->d_base->name, wp->descr->d_base->doc);
Larry Hastings5c661892014-01-24 06:17:25 -08001142}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001143
Larry Hastings5c661892014-01-24 06:17:25 -08001144static PyObject *
1145wrapper_text_signature(wrapperobject *wp, void *closure)
1146{
Larry Hastings2623c8c2014-02-08 22:15:29 -08001147 return _PyType_GetTextSignatureFromInternalDoc(wp->descr->d_base->name, wp->descr->d_base->doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001148}
1149
Antoine Pitrou9d574812011-12-12 13:47:25 +01001150static PyObject *
1151wrapper_qualname(wrapperobject *wp)
1152{
1153 return descr_get_qualname((PyDescrObject *)wp->descr);
1154}
1155
Guido van Rossum32d34c82001-09-20 21:45:26 +00001156static PyGetSetDef wrapper_getsets[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001157 {"__objclass__", (getter)wrapper_objclass},
1158 {"__name__", (getter)wrapper_name},
Antoine Pitrou9d574812011-12-12 13:47:25 +01001159 {"__qualname__", (getter)wrapper_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001160 {"__doc__", (getter)wrapper_doc},
Larry Hastings5c661892014-01-24 06:17:25 -08001161 {"__text_signature__", (getter)wrapper_text_signature},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001162 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001163};
1164
1165static PyObject *
1166wrapper_call(wrapperobject *wp, PyObject *args, PyObject *kwds)
1167{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001168 wrapperfunc wrapper = wp->descr->d_base->wrapper;
1169 PyObject *self = wp->self;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001170
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001171 if (wp->descr->d_base->flags & PyWrapperFlag_KEYWORDS) {
1172 wrapperfunc_kwds wk = (wrapperfunc_kwds)wrapper;
1173 return (*wk)(self, args, wp->descr->d_wrapped, kwds);
1174 }
Guido van Rossumc8e56452001-10-22 00:43:43 +00001175
Serhiy Storchaka5ab81d72016-12-16 16:18:57 +02001176 if (kwds != NULL && (!PyDict_Check(kwds) || PyDict_GET_SIZE(kwds) != 0)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001177 PyErr_Format(PyExc_TypeError,
1178 "wrapper %s doesn't take keyword arguments",
1179 wp->descr->d_base->name);
1180 return NULL;
1181 }
1182 return (*wrapper)(self, args, wp->descr->d_wrapped);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001183}
1184
Guido van Rossum048eb752001-10-02 21:24:57 +00001185static int
1186wrapper_traverse(PyObject *self, visitproc visit, void *arg)
1187{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001188 wrapperobject *wp = (wrapperobject *)self;
1189 Py_VISIT(wp->descr);
1190 Py_VISIT(wp->self);
1191 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +00001192}
1193
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001194PyTypeObject _PyMethodWrapper_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001195 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1196 "method-wrapper", /* tp_name */
1197 sizeof(wrapperobject), /* tp_basicsize */
1198 0, /* tp_itemsize */
1199 /* methods */
1200 (destructor)wrapper_dealloc, /* tp_dealloc */
1201 0, /* tp_print */
1202 0, /* tp_getattr */
1203 0, /* tp_setattr */
1204 0, /* tp_reserved */
1205 (reprfunc)wrapper_repr, /* tp_repr */
1206 0, /* tp_as_number */
1207 0, /* tp_as_sequence */
1208 0, /* tp_as_mapping */
1209 (hashfunc)wrapper_hash, /* tp_hash */
1210 (ternaryfunc)wrapper_call, /* tp_call */
1211 0, /* tp_str */
1212 PyObject_GenericGetAttr, /* tp_getattro */
1213 0, /* tp_setattro */
1214 0, /* tp_as_buffer */
1215 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
1216 0, /* tp_doc */
1217 wrapper_traverse, /* tp_traverse */
1218 0, /* tp_clear */
1219 wrapper_richcompare, /* tp_richcompare */
1220 0, /* tp_weaklistoffset */
1221 0, /* tp_iter */
1222 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001223 wrapper_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001224 wrapper_members, /* tp_members */
1225 wrapper_getsets, /* tp_getset */
1226 0, /* tp_base */
1227 0, /* tp_dict */
1228 0, /* tp_descr_get */
1229 0, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001230};
1231
1232PyObject *
1233PyWrapper_New(PyObject *d, PyObject *self)
1234{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001235 wrapperobject *wp;
1236 PyWrapperDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001237
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001238 assert(PyObject_TypeCheck(d, &PyWrapperDescr_Type));
1239 descr = (PyWrapperDescrObject *)d;
Victor Stinner3249dec2011-05-01 23:19:15 +02001240 assert(_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self),
Victor Stinnerd9561312011-05-01 23:31:36 +02001241 (PyObject *)PyDescr_TYPE(descr)));
Tim Peters6d6c1a32001-08-02 04:15:00 +00001242
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001243 wp = PyObject_GC_New(wrapperobject, &_PyMethodWrapper_Type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001244 if (wp != NULL) {
1245 Py_INCREF(descr);
1246 wp->descr = descr;
1247 Py_INCREF(self);
1248 wp->self = self;
1249 _PyObject_GC_TRACK(wp);
1250 }
1251 return (PyObject *)wp;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001252}
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001253
1254
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001255/* A built-in 'property' type */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001256
1257/*
Serhiy Storchakad741a882015-06-11 00:06:39 +03001258class property(object):
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001259
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001260 def __init__(self, fget=None, fset=None, fdel=None, doc=None):
1261 if doc is None and fget is not None and hasattr(fget, "__doc__"):
Serhiy Storchakad741a882015-06-11 00:06:39 +03001262 doc = fget.__doc__
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001263 self.__get = fget
1264 self.__set = fset
1265 self.__del = fdel
1266 self.__doc__ = doc
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001267
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001268 def __get__(self, inst, type=None):
1269 if inst is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001270 return self
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001271 if self.__get is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001272 raise AttributeError, "unreadable attribute"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001273 return self.__get(inst)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001274
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001275 def __set__(self, inst, value):
1276 if self.__set is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001277 raise AttributeError, "can't set attribute"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001278 return self.__set(inst, value)
Guido van Rossumba2485f2001-12-10 18:03:34 +00001279
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001280 def __delete__(self, inst):
1281 if self.__del is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001282 raise AttributeError, "can't delete attribute"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001283 return self.__del(inst)
Guido van Rossumba2485f2001-12-10 18:03:34 +00001284
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001285*/
1286
1287typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001288 PyObject_HEAD
1289 PyObject *prop_get;
1290 PyObject *prop_set;
1291 PyObject *prop_del;
1292 PyObject *prop_doc;
1293 int getter_doc;
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001294} propertyobject;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001295
Christian Heimes0449f632007-12-15 01:27:15 +00001296static PyObject * property_copy(PyObject *, PyObject *, PyObject *,
Benjamin Peterson93964832010-06-28 03:07:10 +00001297 PyObject *);
Christian Heimes0449f632007-12-15 01:27:15 +00001298
Tim Peters66c1a522001-09-24 21:17:50 +00001299static PyMemberDef property_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001300 {"fget", T_OBJECT, offsetof(propertyobject, prop_get), READONLY},
1301 {"fset", T_OBJECT, offsetof(propertyobject, prop_set), READONLY},
1302 {"fdel", T_OBJECT, offsetof(propertyobject, prop_del), READONLY},
Raymond Hettingereac503a2015-05-13 01:09:59 -07001303 {"__doc__", T_OBJECT, offsetof(propertyobject, prop_doc), 0},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001304 {0}
Tim Peters66c1a522001-09-24 21:17:50 +00001305};
1306
Christian Heimes0449f632007-12-15 01:27:15 +00001307
Guido van Rossum58da9312007-11-10 23:39:45 +00001308PyDoc_STRVAR(getter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001309 "Descriptor to change the getter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001310
Neal Norwitz32dde222008-04-15 06:43:13 +00001311static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001312property_getter(PyObject *self, PyObject *getter)
1313{
Benjamin Peterson93964832010-06-28 03:07:10 +00001314 return property_copy(self, getter, NULL, NULL);
Guido van Rossum58da9312007-11-10 23:39:45 +00001315}
1316
Christian Heimes0449f632007-12-15 01:27:15 +00001317
Guido van Rossum58da9312007-11-10 23:39:45 +00001318PyDoc_STRVAR(setter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001319 "Descriptor to change the setter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001320
Neal Norwitz32dde222008-04-15 06:43:13 +00001321static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001322property_setter(PyObject *self, PyObject *setter)
1323{
Benjamin Peterson93964832010-06-28 03:07:10 +00001324 return property_copy(self, NULL, setter, NULL);
Guido van Rossum58da9312007-11-10 23:39:45 +00001325}
1326
Christian Heimes0449f632007-12-15 01:27:15 +00001327
Guido van Rossum58da9312007-11-10 23:39:45 +00001328PyDoc_STRVAR(deleter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001329 "Descriptor to change the deleter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001330
Neal Norwitz32dde222008-04-15 06:43:13 +00001331static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001332property_deleter(PyObject *self, PyObject *deleter)
1333{
Benjamin Peterson93964832010-06-28 03:07:10 +00001334 return property_copy(self, NULL, NULL, deleter);
Guido van Rossum58da9312007-11-10 23:39:45 +00001335}
1336
1337
Guido van Rossum58da9312007-11-10 23:39:45 +00001338static PyMethodDef property_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001339 {"getter", property_getter, METH_O, getter_doc},
1340 {"setter", property_setter, METH_O, setter_doc},
1341 {"deleter", property_deleter, METH_O, deleter_doc},
1342 {0}
Guido van Rossum58da9312007-11-10 23:39:45 +00001343};
1344
Tim Peters66c1a522001-09-24 21:17:50 +00001345
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001346static void
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001347property_dealloc(PyObject *self)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001348{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001349 propertyobject *gs = (propertyobject *)self;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001350
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001351 _PyObject_GC_UNTRACK(self);
1352 Py_XDECREF(gs->prop_get);
1353 Py_XDECREF(gs->prop_set);
1354 Py_XDECREF(gs->prop_del);
1355 Py_XDECREF(gs->prop_doc);
1356 self->ob_type->tp_free(self);
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001357}
1358
1359static PyObject *
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001360property_descr_get(PyObject *self, PyObject *obj, PyObject *type)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001361{
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001362 static PyObject * volatile cached_args = NULL;
1363 PyObject *args;
Raymond Hettingerc4e335b2015-04-30 08:08:13 -07001364 PyObject *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001365 propertyobject *gs = (propertyobject *)self;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001366
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001367 if (obj == NULL || obj == Py_None) {
1368 Py_INCREF(self);
1369 return self;
1370 }
1371 if (gs->prop_get == NULL) {
1372 PyErr_SetString(PyExc_AttributeError, "unreadable attribute");
1373 return NULL;
1374 }
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001375 args = cached_args;
Serhiy Storchaka7822f152016-05-04 21:42:05 +03001376 cached_args = NULL;
1377 if (!args) {
1378 args = PyTuple_New(1);
1379 if (!args)
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001380 return NULL;
Serhiy Storchaka7822f152016-05-04 21:42:05 +03001381 _PyObject_GC_UNTRACK(args);
Raymond Hettingerc4e335b2015-04-30 08:08:13 -07001382 }
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001383 Py_INCREF(obj);
Raymond Hettingerc4e335b2015-04-30 08:08:13 -07001384 PyTuple_SET_ITEM(args, 0, obj);
1385 ret = PyObject_Call(gs->prop_get, args, NULL);
Serhiy Storchaka7822f152016-05-04 21:42:05 +03001386 if (cached_args == NULL && Py_REFCNT(args) == 1) {
1387 assert(Py_SIZE(args) == 1);
1388 assert(PyTuple_GET_ITEM(args, 0) == obj);
1389 cached_args = args;
1390 Py_DECREF(obj);
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001391 }
Serhiy Storchaka7822f152016-05-04 21:42:05 +03001392 else {
1393 assert(Py_REFCNT(args) >= 1);
1394 _PyObject_GC_TRACK(args);
1395 Py_DECREF(args);
1396 }
Raymond Hettingerc4e335b2015-04-30 08:08:13 -07001397 return ret;
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)
Victor Stinnerde4ae3d2016-12-04 22:59:09 +01001418 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
Victor Stinner5abaa2b2016-12-09 16:22:32 +01001457 new = PyObject_CallFunctionObjArgs(type, get, set, del, doc, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001458 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) {
Serhiy Storchaka48842712016-04-06 09:45:48 +03001499 Py_XSETREF(prop->prop_doc, get_doc);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001500 }
1501 else {
1502 /* If this is a property subclass, put __doc__
1503 in dict of the subclass instance instead,
1504 otherwise it gets shadowed by __doc__ in the
1505 class's dict. */
Martin v. Löwis1c67dd92011-10-14 15:16:45 +02001506 int err = _PyObject_SetAttrId(self, &PyId___doc__, get_doc);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001507 Py_DECREF(get_doc);
1508 if (err < 0)
1509 return -1;
1510 }
1511 prop->getter_doc = 1;
1512 }
1513 else if (PyErr_ExceptionMatches(PyExc_Exception)) {
1514 PyErr_Clear();
1515 }
1516 else {
1517 return -1;
1518 }
1519 }
1520
1521 return 0;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001522}
1523
Benjamin Petersonbfebb7b2011-12-15 15:34:02 -05001524static PyObject *
1525property_get___isabstractmethod__(propertyobject *prop, void *closure)
1526{
1527 int res = _PyObject_IsAbstract(prop->prop_get);
1528 if (res == -1) {
1529 return NULL;
1530 }
1531 else if (res) {
1532 Py_RETURN_TRUE;
1533 }
1534
1535 res = _PyObject_IsAbstract(prop->prop_set);
1536 if (res == -1) {
1537 return NULL;
1538 }
1539 else if (res) {
1540 Py_RETURN_TRUE;
1541 }
1542
1543 res = _PyObject_IsAbstract(prop->prop_del);
1544 if (res == -1) {
1545 return NULL;
1546 }
1547 else if (res) {
1548 Py_RETURN_TRUE;
1549 }
1550 Py_RETURN_FALSE;
1551}
1552
1553static PyGetSetDef property_getsetlist[] = {
1554 {"__isabstractmethod__",
1555 (getter)property_get___isabstractmethod__, NULL,
1556 NULL,
1557 NULL},
1558 {NULL} /* Sentinel */
1559};
1560
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001561PyDoc_STRVAR(property_doc,
Tim Peters66c1a522001-09-24 21:17:50 +00001562"property(fget=None, fset=None, fdel=None, doc=None) -> property attribute\n"
1563"\n"
1564"fget is a function to be used for getting an attribute value, and likewise\n"
1565"fset is a function for setting, and fdel a function for del'ing, an\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001566"attribute. Typical use is to define a managed attribute x:\n\n"
Guido van Rossum91c0d8a2001-08-24 09:55:51 +00001567"class C(object):\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001568" def getx(self): return self._x\n"
1569" def setx(self, value): self._x = value\n"
1570" def delx(self): del self._x\n"
1571" x = property(getx, setx, delx, \"I'm the 'x' property.\")\n"
1572"\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001573"Decorators make defining new properties or modifying existing ones easy:\n\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001574"class C(object):\n"
1575" @property\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001576" def x(self):\n"
Gregory P. Smith0e524042013-11-25 00:30:56 -08001577" \"I am the 'x' property.\"\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001578" return self._x\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001579" @x.setter\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001580" def x(self, value):\n"
1581" self._x = value\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001582" @x.deleter\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001583" def x(self):\n"
1584" del self._x\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001585);
Guido van Rossum91c0d8a2001-08-24 09:55:51 +00001586
Guido van Rossum048eb752001-10-02 21:24:57 +00001587static int
1588property_traverse(PyObject *self, visitproc visit, void *arg)
1589{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001590 propertyobject *pp = (propertyobject *)self;
1591 Py_VISIT(pp->prop_get);
1592 Py_VISIT(pp->prop_set);
1593 Py_VISIT(pp->prop_del);
1594 Py_VISIT(pp->prop_doc);
1595 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +00001596}
1597
Raymond Hettingerd4be6912015-05-13 11:12:33 -07001598static int
1599property_clear(PyObject *self)
1600{
1601 propertyobject *pp = (propertyobject *)self;
1602 Py_CLEAR(pp->prop_doc);
1603 return 0;
1604}
1605
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001606PyTypeObject PyProperty_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001607 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1608 "property", /* tp_name */
1609 sizeof(propertyobject), /* tp_basicsize */
1610 0, /* tp_itemsize */
1611 /* methods */
1612 property_dealloc, /* tp_dealloc */
1613 0, /* tp_print */
1614 0, /* tp_getattr */
1615 0, /* tp_setattr */
1616 0, /* tp_reserved */
1617 0, /* tp_repr */
1618 0, /* tp_as_number */
1619 0, /* tp_as_sequence */
1620 0, /* tp_as_mapping */
1621 0, /* tp_hash */
1622 0, /* tp_call */
1623 0, /* tp_str */
1624 PyObject_GenericGetAttr, /* tp_getattro */
1625 0, /* tp_setattro */
1626 0, /* tp_as_buffer */
1627 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
1628 Py_TPFLAGS_BASETYPE, /* tp_flags */
1629 property_doc, /* tp_doc */
1630 property_traverse, /* tp_traverse */
Raymond Hettingerd4be6912015-05-13 11:12:33 -07001631 (inquiry)property_clear, /* tp_clear */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001632 0, /* tp_richcompare */
1633 0, /* tp_weaklistoffset */
1634 0, /* tp_iter */
1635 0, /* tp_iternext */
1636 property_methods, /* tp_methods */
1637 property_members, /* tp_members */
Benjamin Petersonbfebb7b2011-12-15 15:34:02 -05001638 property_getsetlist, /* tp_getset */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001639 0, /* tp_base */
1640 0, /* tp_dict */
1641 property_descr_get, /* tp_descr_get */
1642 property_descr_set, /* tp_descr_set */
1643 0, /* tp_dictoffset */
1644 property_init, /* tp_init */
1645 PyType_GenericAlloc, /* tp_alloc */
1646 PyType_GenericNew, /* tp_new */
1647 PyObject_GC_Del, /* tp_free */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001648};