blob: 076e74148148254333f91eadb78417e296a3d682 [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 Stinner0db176f2012-04-16 00:16:30 +0200807 return _PyObject_CallMethodId(pp->mapping, &PyId_get, "(OO)", key, def);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000808}
809
810static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200811mappingproxy_keys(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000812{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200813 _Py_IDENTIFIER(keys);
Victor Stinner0db176f2012-04-16 00:16:30 +0200814 return _PyObject_CallMethodId(pp->mapping, &PyId_keys, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000815}
816
817static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200818mappingproxy_values(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000819{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200820 _Py_IDENTIFIER(values);
Victor Stinner0db176f2012-04-16 00:16:30 +0200821 return _PyObject_CallMethodId(pp->mapping, &PyId_values, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000822}
823
824static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200825mappingproxy_items(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000826{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200827 _Py_IDENTIFIER(items);
Victor Stinner0db176f2012-04-16 00:16:30 +0200828 return _PyObject_CallMethodId(pp->mapping, &PyId_items, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000829}
830
831static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200832mappingproxy_copy(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000833{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200834 _Py_IDENTIFIER(copy);
Victor Stinner0db176f2012-04-16 00:16:30 +0200835 return _PyObject_CallMethodId(pp->mapping, &PyId_copy, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000836}
837
Victor Stinner0db176f2012-04-16 00:16:30 +0200838/* WARNING: mappingproxy methods must not give access
839 to the underlying mapping */
840
841static PyMethodDef mappingproxy_methods[] = {
842 {"get", (PyCFunction)mappingproxy_get, METH_VARARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000843 PyDoc_STR("D.get(k[,d]) -> D[k] if k in D, else d."
Victor Stinner0db176f2012-04-16 00:16:30 +0200844 " d defaults to None.")},
845 {"keys", (PyCFunction)mappingproxy_keys, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000846 PyDoc_STR("D.keys() -> list of D's keys")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200847 {"values", (PyCFunction)mappingproxy_values, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000848 PyDoc_STR("D.values() -> list of D's values")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200849 {"items", (PyCFunction)mappingproxy_items, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000850 PyDoc_STR("D.items() -> list of D's (key, value) pairs, as 2-tuples")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200851 {"copy", (PyCFunction)mappingproxy_copy, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000852 PyDoc_STR("D.copy() -> a shallow copy of D")},
853 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000854};
855
856static void
Victor Stinner0db176f2012-04-16 00:16:30 +0200857mappingproxy_dealloc(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000858{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000859 _PyObject_GC_UNTRACK(pp);
Victor Stinner0db176f2012-04-16 00:16:30 +0200860 Py_DECREF(pp->mapping);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000861 PyObject_GC_Del(pp);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000862}
863
864static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200865mappingproxy_getiter(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000866{
Victor Stinner0db176f2012-04-16 00:16:30 +0200867 return PyObject_GetIter(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000868}
869
Neil Schemenauer26775122001-10-21 22:26:43 +0000870static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200871mappingproxy_str(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000872{
Victor Stinner0db176f2012-04-16 00:16:30 +0200873 return PyObject_Str(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000874}
875
Ezio Melottiac53ab62010-12-18 14:59:43 +0000876static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200877mappingproxy_repr(mappingproxyobject *pp)
Ezio Melottiac53ab62010-12-18 14:59:43 +0000878{
Victor Stinner0db176f2012-04-16 00:16:30 +0200879 return PyUnicode_FromFormat("mappingproxy(%R)", pp->mapping);
Ezio Melottiac53ab62010-12-18 14:59:43 +0000880}
881
Guido van Rossum048eb752001-10-02 21:24:57 +0000882static int
Victor Stinner0db176f2012-04-16 00:16:30 +0200883mappingproxy_traverse(PyObject *self, visitproc visit, void *arg)
Guido van Rossum048eb752001-10-02 21:24:57 +0000884{
Victor Stinner0db176f2012-04-16 00:16:30 +0200885 mappingproxyobject *pp = (mappingproxyobject *)self;
886 Py_VISIT(pp->mapping);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000887 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +0000888}
889
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000890static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200891mappingproxy_richcompare(mappingproxyobject *v, PyObject *w, int op)
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000892{
Victor Stinner0db176f2012-04-16 00:16:30 +0200893 return PyObject_RichCompare(v->mapping, w, op);
894}
895
896static int
897mappingproxy_check_mapping(PyObject *mapping)
898{
899 if (!PyMapping_Check(mapping)
900 || PyList_Check(mapping)
901 || PyTuple_Check(mapping)) {
902 PyErr_Format(PyExc_TypeError,
903 "mappingproxy() argument must be a mapping, not %s",
904 Py_TYPE(mapping)->tp_name);
905 return -1;
906 }
907 return 0;
908}
909
910static PyObject*
911mappingproxy_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
912{
913 static char *kwlist[] = {"mapping", NULL};
914 PyObject *mapping;
915 mappingproxyobject *mappingproxy;
916
917 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O:mappingproxy",
918 kwlist, &mapping))
919 return NULL;
920
921 if (mappingproxy_check_mapping(mapping) == -1)
922 return NULL;
923
924 mappingproxy = PyObject_GC_New(mappingproxyobject, &PyDictProxy_Type);
925 if (mappingproxy == NULL)
926 return NULL;
927 Py_INCREF(mapping);
928 mappingproxy->mapping = mapping;
929 _PyObject_GC_TRACK(mappingproxy);
930 return (PyObject *)mappingproxy;
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000931}
932
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000933PyTypeObject PyDictProxy_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000934 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Victor Stinner0db176f2012-04-16 00:16:30 +0200935 "mappingproxy", /* tp_name */
936 sizeof(mappingproxyobject), /* tp_basicsize */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000937 0, /* tp_itemsize */
938 /* methods */
Victor Stinner0db176f2012-04-16 00:16:30 +0200939 (destructor)mappingproxy_dealloc, /* tp_dealloc */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000940 0, /* tp_print */
941 0, /* tp_getattr */
942 0, /* tp_setattr */
943 0, /* tp_reserved */
Victor Stinner0db176f2012-04-16 00:16:30 +0200944 (reprfunc)mappingproxy_repr, /* tp_repr */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000945 0, /* tp_as_number */
Victor Stinner0db176f2012-04-16 00:16:30 +0200946 &mappingproxy_as_sequence, /* tp_as_sequence */
947 &mappingproxy_as_mapping, /* tp_as_mapping */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000948 0, /* tp_hash */
949 0, /* tp_call */
Victor Stinner0db176f2012-04-16 00:16:30 +0200950 (reprfunc)mappingproxy_str, /* tp_str */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000951 PyObject_GenericGetAttr, /* tp_getattro */
952 0, /* tp_setattro */
953 0, /* tp_as_buffer */
954 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
955 0, /* tp_doc */
Victor Stinner0db176f2012-04-16 00:16:30 +0200956 mappingproxy_traverse, /* tp_traverse */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000957 0, /* tp_clear */
Victor Stinner0db176f2012-04-16 00:16:30 +0200958 (richcmpfunc)mappingproxy_richcompare, /* tp_richcompare */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000959 0, /* tp_weaklistoffset */
Victor Stinner0db176f2012-04-16 00:16:30 +0200960 (getiterfunc)mappingproxy_getiter, /* tp_iter */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000961 0, /* tp_iternext */
Victor Stinner0db176f2012-04-16 00:16:30 +0200962 mappingproxy_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000963 0, /* tp_members */
964 0, /* tp_getset */
965 0, /* tp_base */
966 0, /* tp_dict */
967 0, /* tp_descr_get */
968 0, /* tp_descr_set */
Victor Stinner0db176f2012-04-16 00:16:30 +0200969 0, /* tp_dictoffset */
970 0, /* tp_init */
971 0, /* tp_alloc */
972 mappingproxy_new, /* tp_new */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000973};
974
975PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200976PyDictProxy_New(PyObject *mapping)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000977{
Victor Stinner0db176f2012-04-16 00:16:30 +0200978 mappingproxyobject *pp;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000979
Victor Stinner0db176f2012-04-16 00:16:30 +0200980 if (mappingproxy_check_mapping(mapping) == -1)
981 return NULL;
982
983 pp = PyObject_GC_New(mappingproxyobject, &PyDictProxy_Type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000984 if (pp != NULL) {
Victor Stinner0db176f2012-04-16 00:16:30 +0200985 Py_INCREF(mapping);
986 pp->mapping = mapping;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000987 _PyObject_GC_TRACK(pp);
988 }
989 return (PyObject *)pp;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000990}
991
992
993/* --- Wrapper object for "slot" methods --- */
994
995/* This has no reason to be in this file except that adding new files is a
996 bit of a pain */
997
998typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000999 PyObject_HEAD
1000 PyWrapperDescrObject *descr;
1001 PyObject *self;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001002} wrapperobject;
1003
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001004#define Wrapper_Check(v) (Py_TYPE(v) == &_PyMethodWrapper_Type)
Mark Dickinson211c6252009-02-01 10:28:51 +00001005
Tim Peters6d6c1a32001-08-02 04:15:00 +00001006static void
1007wrapper_dealloc(wrapperobject *wp)
1008{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001009 PyObject_GC_UnTrack(wp);
1010 Py_TRASHCAN_SAFE_BEGIN(wp)
1011 Py_XDECREF(wp->descr);
1012 Py_XDECREF(wp->self);
1013 PyObject_GC_Del(wp);
1014 Py_TRASHCAN_SAFE_END(wp)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001015}
1016
Mark Dickinson211c6252009-02-01 10:28:51 +00001017#define TEST_COND(cond) ((cond) ? Py_True : Py_False)
1018
1019static PyObject *
1020wrapper_richcompare(PyObject *a, PyObject *b, int op)
Armin Rigoc6686b72005-11-07 08:38:00 +00001021{
Benjamin Petersonca470632016-09-06 13:47:26 -07001022 intptr_t result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001023 PyObject *v;
1024 PyWrapperDescrObject *a_descr, *b_descr;
Mark Dickinson211c6252009-02-01 10:28:51 +00001025
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001026 assert(a != NULL && b != NULL);
Mark Dickinson211c6252009-02-01 10:28:51 +00001027
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001028 /* both arguments should be wrapperobjects */
1029 if (!Wrapper_Check(a) || !Wrapper_Check(b)) {
1030 v = Py_NotImplemented;
1031 Py_INCREF(v);
1032 return v;
1033 }
Mark Dickinson211c6252009-02-01 10:28:51 +00001034
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001035 /* compare by descriptor address; if the descriptors are the same,
1036 compare by the objects they're bound to */
1037 a_descr = ((wrapperobject *)a)->descr;
1038 b_descr = ((wrapperobject *)b)->descr;
1039 if (a_descr == b_descr) {
1040 a = ((wrapperobject *)a)->self;
1041 b = ((wrapperobject *)b)->self;
1042 return PyObject_RichCompare(a, b, op);
1043 }
Mark Dickinson211c6252009-02-01 10:28:51 +00001044
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001045 result = a_descr - b_descr;
1046 switch (op) {
1047 case Py_EQ:
1048 v = TEST_COND(result == 0);
1049 break;
1050 case Py_NE:
1051 v = TEST_COND(result != 0);
1052 break;
1053 case Py_LE:
1054 v = TEST_COND(result <= 0);
1055 break;
1056 case Py_GE:
1057 v = TEST_COND(result >= 0);
1058 break;
1059 case Py_LT:
1060 v = TEST_COND(result < 0);
1061 break;
1062 case Py_GT:
1063 v = TEST_COND(result > 0);
1064 break;
1065 default:
1066 PyErr_BadArgument();
1067 return NULL;
1068 }
1069 Py_INCREF(v);
1070 return v;
Armin Rigoc6686b72005-11-07 08:38:00 +00001071}
1072
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001073static Py_hash_t
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001074wrapper_hash(wrapperobject *wp)
1075{
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001076 Py_hash_t x, y;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001077 x = _Py_HashPointer(wp->descr);
1078 if (x == -1)
1079 return -1;
1080 y = PyObject_Hash(wp->self);
1081 if (y == -1)
1082 return -1;
1083 x = x ^ y;
1084 if (x == -1)
1085 x = -2;
1086 return x;
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001087}
1088
Armin Rigoc6686b72005-11-07 08:38:00 +00001089static PyObject *
1090wrapper_repr(wrapperobject *wp)
1091{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001092 return PyUnicode_FromFormat("<method-wrapper '%s' of %s object at %p>",
1093 wp->descr->d_base->name,
1094 wp->self->ob_type->tp_name,
1095 wp->self);
Armin Rigoc6686b72005-11-07 08:38:00 +00001096}
1097
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001098static PyObject *
1099wrapper_reduce(wrapperobject *wp)
1100{
1101 PyObject *builtins;
1102 PyObject *getattr;
1103 _Py_IDENTIFIER(getattr);
1104
1105 builtins = PyEval_GetBuiltins();
1106 getattr = _PyDict_GetItemId(builtins, &PyId_getattr);
1107 return Py_BuildValue("O(OO)", getattr, wp->self, PyDescr_NAME(wp->descr));
1108}
1109
1110static PyMethodDef wrapper_methods[] = {
1111 {"__reduce__", (PyCFunction)wrapper_reduce, METH_NOARGS, NULL},
1112 {NULL, NULL}
1113};
1114
Armin Rigoc6686b72005-11-07 08:38:00 +00001115static PyMemberDef wrapper_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001116 {"__self__", T_OBJECT, offsetof(wrapperobject, self), READONLY},
1117 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001118};
1119
1120static PyObject *
Armin Rigoc6686b72005-11-07 08:38:00 +00001121wrapper_objclass(wrapperobject *wp)
1122{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001123 PyObject *c = (PyObject *)PyDescr_TYPE(wp->descr);
Armin Rigoc6686b72005-11-07 08:38:00 +00001124
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001125 Py_INCREF(c);
1126 return c;
Armin Rigoc6686b72005-11-07 08:38:00 +00001127}
1128
1129static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001130wrapper_name(wrapperobject *wp)
1131{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001132 const char *s = wp->descr->d_base->name;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001133
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001134 return PyUnicode_FromString(s);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001135}
1136
1137static PyObject *
Larry Hastings5c661892014-01-24 06:17:25 -08001138wrapper_doc(wrapperobject *wp, void *closure)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001139{
Larry Hastings2623c8c2014-02-08 22:15:29 -08001140 return _PyType_GetDocFromInternalDoc(wp->descr->d_base->name, wp->descr->d_base->doc);
Larry Hastings5c661892014-01-24 06:17:25 -08001141}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001142
Larry Hastings5c661892014-01-24 06:17:25 -08001143static PyObject *
1144wrapper_text_signature(wrapperobject *wp, void *closure)
1145{
Larry Hastings2623c8c2014-02-08 22:15:29 -08001146 return _PyType_GetTextSignatureFromInternalDoc(wp->descr->d_base->name, wp->descr->d_base->doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001147}
1148
Antoine Pitrou9d574812011-12-12 13:47:25 +01001149static PyObject *
1150wrapper_qualname(wrapperobject *wp)
1151{
1152 return descr_get_qualname((PyDescrObject *)wp->descr);
1153}
1154
Guido van Rossum32d34c82001-09-20 21:45:26 +00001155static PyGetSetDef wrapper_getsets[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001156 {"__objclass__", (getter)wrapper_objclass},
1157 {"__name__", (getter)wrapper_name},
Antoine Pitrou9d574812011-12-12 13:47:25 +01001158 {"__qualname__", (getter)wrapper_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001159 {"__doc__", (getter)wrapper_doc},
Larry Hastings5c661892014-01-24 06:17:25 -08001160 {"__text_signature__", (getter)wrapper_text_signature},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001161 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001162};
1163
1164static PyObject *
1165wrapper_call(wrapperobject *wp, PyObject *args, PyObject *kwds)
1166{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001167 wrapperfunc wrapper = wp->descr->d_base->wrapper;
1168 PyObject *self = wp->self;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001169
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001170 if (wp->descr->d_base->flags & PyWrapperFlag_KEYWORDS) {
1171 wrapperfunc_kwds wk = (wrapperfunc_kwds)wrapper;
1172 return (*wk)(self, args, wp->descr->d_wrapped, kwds);
1173 }
Guido van Rossumc8e56452001-10-22 00:43:43 +00001174
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001175 if (kwds != NULL && (!PyDict_Check(kwds) || PyDict_Size(kwds) != 0)) {
1176 PyErr_Format(PyExc_TypeError,
1177 "wrapper %s doesn't take keyword arguments",
1178 wp->descr->d_base->name);
1179 return NULL;
1180 }
1181 return (*wrapper)(self, args, wp->descr->d_wrapped);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001182}
1183
Guido van Rossum048eb752001-10-02 21:24:57 +00001184static int
1185wrapper_traverse(PyObject *self, visitproc visit, void *arg)
1186{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001187 wrapperobject *wp = (wrapperobject *)self;
1188 Py_VISIT(wp->descr);
1189 Py_VISIT(wp->self);
1190 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +00001191}
1192
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001193PyTypeObject _PyMethodWrapper_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001194 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1195 "method-wrapper", /* tp_name */
1196 sizeof(wrapperobject), /* tp_basicsize */
1197 0, /* tp_itemsize */
1198 /* methods */
1199 (destructor)wrapper_dealloc, /* tp_dealloc */
1200 0, /* tp_print */
1201 0, /* tp_getattr */
1202 0, /* tp_setattr */
1203 0, /* tp_reserved */
1204 (reprfunc)wrapper_repr, /* tp_repr */
1205 0, /* tp_as_number */
1206 0, /* tp_as_sequence */
1207 0, /* tp_as_mapping */
1208 (hashfunc)wrapper_hash, /* tp_hash */
1209 (ternaryfunc)wrapper_call, /* tp_call */
1210 0, /* tp_str */
1211 PyObject_GenericGetAttr, /* tp_getattro */
1212 0, /* tp_setattro */
1213 0, /* tp_as_buffer */
1214 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
1215 0, /* tp_doc */
1216 wrapper_traverse, /* tp_traverse */
1217 0, /* tp_clear */
1218 wrapper_richcompare, /* tp_richcompare */
1219 0, /* tp_weaklistoffset */
1220 0, /* tp_iter */
1221 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001222 wrapper_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001223 wrapper_members, /* tp_members */
1224 wrapper_getsets, /* tp_getset */
1225 0, /* tp_base */
1226 0, /* tp_dict */
1227 0, /* tp_descr_get */
1228 0, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001229};
1230
1231PyObject *
1232PyWrapper_New(PyObject *d, PyObject *self)
1233{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001234 wrapperobject *wp;
1235 PyWrapperDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001236
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001237 assert(PyObject_TypeCheck(d, &PyWrapperDescr_Type));
1238 descr = (PyWrapperDescrObject *)d;
Victor Stinner3249dec2011-05-01 23:19:15 +02001239 assert(_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self),
Victor Stinnerd9561312011-05-01 23:31:36 +02001240 (PyObject *)PyDescr_TYPE(descr)));
Tim Peters6d6c1a32001-08-02 04:15:00 +00001241
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001242 wp = PyObject_GC_New(wrapperobject, &_PyMethodWrapper_Type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001243 if (wp != NULL) {
1244 Py_INCREF(descr);
1245 wp->descr = descr;
1246 Py_INCREF(self);
1247 wp->self = self;
1248 _PyObject_GC_TRACK(wp);
1249 }
1250 return (PyObject *)wp;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001251}
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001252
1253
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001254/* A built-in 'property' type */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001255
1256/*
Serhiy Storchakad741a882015-06-11 00:06:39 +03001257class property(object):
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001258
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001259 def __init__(self, fget=None, fset=None, fdel=None, doc=None):
1260 if doc is None and fget is not None and hasattr(fget, "__doc__"):
Serhiy Storchakad741a882015-06-11 00:06:39 +03001261 doc = fget.__doc__
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001262 self.__get = fget
1263 self.__set = fset
1264 self.__del = fdel
1265 self.__doc__ = doc
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001266
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001267 def __get__(self, inst, type=None):
1268 if inst is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001269 return self
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001270 if self.__get is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001271 raise AttributeError, "unreadable attribute"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001272 return self.__get(inst)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001273
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001274 def __set__(self, inst, value):
1275 if self.__set is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001276 raise AttributeError, "can't set attribute"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001277 return self.__set(inst, value)
Guido van Rossumba2485f2001-12-10 18:03:34 +00001278
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001279 def __delete__(self, inst):
1280 if self.__del is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001281 raise AttributeError, "can't delete attribute"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001282 return self.__del(inst)
Guido van Rossumba2485f2001-12-10 18:03:34 +00001283
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001284*/
1285
1286typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001287 PyObject_HEAD
1288 PyObject *prop_get;
1289 PyObject *prop_set;
1290 PyObject *prop_del;
1291 PyObject *prop_doc;
1292 int getter_doc;
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001293} propertyobject;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001294
Christian Heimes0449f632007-12-15 01:27:15 +00001295static PyObject * property_copy(PyObject *, PyObject *, PyObject *,
Benjamin Peterson93964832010-06-28 03:07:10 +00001296 PyObject *);
Christian Heimes0449f632007-12-15 01:27:15 +00001297
Tim Peters66c1a522001-09-24 21:17:50 +00001298static PyMemberDef property_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001299 {"fget", T_OBJECT, offsetof(propertyobject, prop_get), READONLY},
1300 {"fset", T_OBJECT, offsetof(propertyobject, prop_set), READONLY},
1301 {"fdel", T_OBJECT, offsetof(propertyobject, prop_del), READONLY},
Raymond Hettingereac503a2015-05-13 01:09:59 -07001302 {"__doc__", T_OBJECT, offsetof(propertyobject, prop_doc), 0},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001303 {0}
Tim Peters66c1a522001-09-24 21:17:50 +00001304};
1305
Christian Heimes0449f632007-12-15 01:27:15 +00001306
Guido van Rossum58da9312007-11-10 23:39:45 +00001307PyDoc_STRVAR(getter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001308 "Descriptor to change the getter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001309
Neal Norwitz32dde222008-04-15 06:43:13 +00001310static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001311property_getter(PyObject *self, PyObject *getter)
1312{
Benjamin Peterson93964832010-06-28 03:07:10 +00001313 return property_copy(self, getter, NULL, NULL);
Guido van Rossum58da9312007-11-10 23:39:45 +00001314}
1315
Christian Heimes0449f632007-12-15 01:27:15 +00001316
Guido van Rossum58da9312007-11-10 23:39:45 +00001317PyDoc_STRVAR(setter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001318 "Descriptor to change the setter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001319
Neal Norwitz32dde222008-04-15 06:43:13 +00001320static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001321property_setter(PyObject *self, PyObject *setter)
1322{
Benjamin Peterson93964832010-06-28 03:07:10 +00001323 return property_copy(self, NULL, setter, NULL);
Guido van Rossum58da9312007-11-10 23:39:45 +00001324}
1325
Christian Heimes0449f632007-12-15 01:27:15 +00001326
Guido van Rossum58da9312007-11-10 23:39:45 +00001327PyDoc_STRVAR(deleter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001328 "Descriptor to change the deleter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001329
Neal Norwitz32dde222008-04-15 06:43:13 +00001330static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001331property_deleter(PyObject *self, PyObject *deleter)
1332{
Benjamin Peterson93964832010-06-28 03:07:10 +00001333 return property_copy(self, NULL, NULL, deleter);
Guido van Rossum58da9312007-11-10 23:39:45 +00001334}
1335
1336
Guido van Rossum58da9312007-11-10 23:39:45 +00001337static PyMethodDef property_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001338 {"getter", property_getter, METH_O, getter_doc},
1339 {"setter", property_setter, METH_O, setter_doc},
1340 {"deleter", property_deleter, METH_O, deleter_doc},
1341 {0}
Guido van Rossum58da9312007-11-10 23:39:45 +00001342};
1343
Tim Peters66c1a522001-09-24 21:17:50 +00001344
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001345static void
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001346property_dealloc(PyObject *self)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001347{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001348 propertyobject *gs = (propertyobject *)self;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001349
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001350 _PyObject_GC_UNTRACK(self);
1351 Py_XDECREF(gs->prop_get);
1352 Py_XDECREF(gs->prop_set);
1353 Py_XDECREF(gs->prop_del);
1354 Py_XDECREF(gs->prop_doc);
1355 self->ob_type->tp_free(self);
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001356}
1357
1358static PyObject *
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001359property_descr_get(PyObject *self, PyObject *obj, PyObject *type)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001360{
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001361 static PyObject * volatile cached_args = NULL;
1362 PyObject *args;
Raymond Hettingerc4e335b2015-04-30 08:08:13 -07001363 PyObject *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001364 propertyobject *gs = (propertyobject *)self;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001365
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001366 if (obj == NULL || obj == Py_None) {
1367 Py_INCREF(self);
1368 return self;
1369 }
1370 if (gs->prop_get == NULL) {
1371 PyErr_SetString(PyExc_AttributeError, "unreadable attribute");
1372 return NULL;
1373 }
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001374 args = cached_args;
Serhiy Storchaka7822f152016-05-04 21:42:05 +03001375 cached_args = NULL;
1376 if (!args) {
1377 args = PyTuple_New(1);
1378 if (!args)
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001379 return NULL;
Serhiy Storchaka7822f152016-05-04 21:42:05 +03001380 _PyObject_GC_UNTRACK(args);
Raymond Hettingerc4e335b2015-04-30 08:08:13 -07001381 }
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001382 Py_INCREF(obj);
Raymond Hettingerc4e335b2015-04-30 08:08:13 -07001383 PyTuple_SET_ITEM(args, 0, obj);
1384 ret = PyObject_Call(gs->prop_get, args, NULL);
Serhiy Storchaka7822f152016-05-04 21:42:05 +03001385 if (cached_args == NULL && Py_REFCNT(args) == 1) {
1386 assert(Py_SIZE(args) == 1);
1387 assert(PyTuple_GET_ITEM(args, 0) == obj);
1388 cached_args = args;
1389 Py_DECREF(obj);
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001390 }
Serhiy Storchaka7822f152016-05-04 21:42:05 +03001391 else {
1392 assert(Py_REFCNT(args) >= 1);
1393 _PyObject_GC_TRACK(args);
1394 Py_DECREF(args);
1395 }
Raymond Hettingerc4e335b2015-04-30 08:08:13 -07001396 return ret;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001397}
1398
1399static int
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001400property_descr_set(PyObject *self, PyObject *obj, PyObject *value)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001401{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001402 propertyobject *gs = (propertyobject *)self;
1403 PyObject *func, *res;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001404
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001405 if (value == NULL)
1406 func = gs->prop_del;
1407 else
1408 func = gs->prop_set;
1409 if (func == NULL) {
1410 PyErr_SetString(PyExc_AttributeError,
1411 value == NULL ?
1412 "can't delete attribute" :
1413 "can't set attribute");
1414 return -1;
1415 }
1416 if (value == NULL)
Benjamin Peterson9b955de2010-12-07 04:04:02 +00001417 res = PyObject_CallFunctionObjArgs(func, obj, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001418 else
Benjamin Peterson9b955de2010-12-07 04:04:02 +00001419 res = PyObject_CallFunctionObjArgs(func, obj, value, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001420 if (res == NULL)
1421 return -1;
1422 Py_DECREF(res);
1423 return 0;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001424}
1425
Christian Heimes0449f632007-12-15 01:27:15 +00001426static PyObject *
Benjamin Peterson93964832010-06-28 03:07:10 +00001427property_copy(PyObject *old, PyObject *get, PyObject *set, PyObject *del)
Christian Heimes0449f632007-12-15 01:27:15 +00001428{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001429 propertyobject *pold = (propertyobject *)old;
Benjamin Peterson93964832010-06-28 03:07:10 +00001430 PyObject *new, *type, *doc;
Christian Heimes0449f632007-12-15 01:27:15 +00001431
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001432 type = PyObject_Type(old);
1433 if (type == NULL)
1434 return NULL;
Christian Heimes0449f632007-12-15 01:27:15 +00001435
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001436 if (get == NULL || get == Py_None) {
1437 Py_XDECREF(get);
1438 get = pold->prop_get ? pold->prop_get : Py_None;
1439 }
1440 if (set == NULL || set == Py_None) {
1441 Py_XDECREF(set);
1442 set = pold->prop_set ? pold->prop_set : Py_None;
1443 }
1444 if (del == NULL || del == Py_None) {
1445 Py_XDECREF(del);
1446 del = pold->prop_del ? pold->prop_del : Py_None;
1447 }
Benjamin Peterson93964832010-06-28 03:07:10 +00001448 if (pold->getter_doc && get != Py_None) {
1449 /* make _init use __doc__ from getter */
1450 doc = Py_None;
1451 }
1452 else {
1453 doc = pold->prop_doc ? pold->prop_doc : Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001454 }
R. David Murrayb18500d2009-05-04 22:59:07 +00001455
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001456 new = PyObject_CallFunction(type, "OOOO", get, set, del, doc);
1457 Py_DECREF(type);
1458 if (new == NULL)
1459 return NULL;
1460 return new;
Christian Heimes0449f632007-12-15 01:27:15 +00001461}
1462
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001463static int
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001464property_init(PyObject *self, PyObject *args, PyObject *kwds)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001465{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001466 PyObject *get = NULL, *set = NULL, *del = NULL, *doc = NULL;
1467 static char *kwlist[] = {"fget", "fset", "fdel", "doc", 0};
1468 propertyobject *prop = (propertyobject *)self;
Tim Peters66c1a522001-09-24 21:17:50 +00001469
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001470 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OOOO:property",
1471 kwlist, &get, &set, &del, &doc))
1472 return -1;
Tim Peters66c1a522001-09-24 21:17:50 +00001473
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001474 if (get == Py_None)
1475 get = NULL;
1476 if (set == Py_None)
1477 set = NULL;
1478 if (del == Py_None)
1479 del = NULL;
Tim Peters66c1a522001-09-24 21:17:50 +00001480
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001481 Py_XINCREF(get);
1482 Py_XINCREF(set);
1483 Py_XINCREF(del);
1484 Py_XINCREF(doc);
Christian Heimes0449f632007-12-15 01:27:15 +00001485
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001486 prop->prop_get = get;
1487 prop->prop_set = set;
1488 prop->prop_del = del;
1489 prop->prop_doc = doc;
1490 prop->getter_doc = 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001491
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001492 /* if no docstring given and the getter has one, use that one */
1493 if ((doc == NULL || doc == Py_None) && get != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001494 _Py_IDENTIFIER(__doc__);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02001495 PyObject *get_doc = _PyObject_GetAttrId(get, &PyId___doc__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001496 if (get_doc) {
1497 if (Py_TYPE(self) == &PyProperty_Type) {
Serhiy Storchaka48842712016-04-06 09:45:48 +03001498 Py_XSETREF(prop->prop_doc, get_doc);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001499 }
1500 else {
1501 /* If this is a property subclass, put __doc__
1502 in dict of the subclass instance instead,
1503 otherwise it gets shadowed by __doc__ in the
1504 class's dict. */
Martin v. Löwis1c67dd92011-10-14 15:16:45 +02001505 int err = _PyObject_SetAttrId(self, &PyId___doc__, get_doc);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001506 Py_DECREF(get_doc);
1507 if (err < 0)
1508 return -1;
1509 }
1510 prop->getter_doc = 1;
1511 }
1512 else if (PyErr_ExceptionMatches(PyExc_Exception)) {
1513 PyErr_Clear();
1514 }
1515 else {
1516 return -1;
1517 }
1518 }
1519
1520 return 0;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001521}
1522
Benjamin Petersonbfebb7b2011-12-15 15:34:02 -05001523static PyObject *
1524property_get___isabstractmethod__(propertyobject *prop, void *closure)
1525{
1526 int res = _PyObject_IsAbstract(prop->prop_get);
1527 if (res == -1) {
1528 return NULL;
1529 }
1530 else if (res) {
1531 Py_RETURN_TRUE;
1532 }
1533
1534 res = _PyObject_IsAbstract(prop->prop_set);
1535 if (res == -1) {
1536 return NULL;
1537 }
1538 else if (res) {
1539 Py_RETURN_TRUE;
1540 }
1541
1542 res = _PyObject_IsAbstract(prop->prop_del);
1543 if (res == -1) {
1544 return NULL;
1545 }
1546 else if (res) {
1547 Py_RETURN_TRUE;
1548 }
1549 Py_RETURN_FALSE;
1550}
1551
1552static PyGetSetDef property_getsetlist[] = {
1553 {"__isabstractmethod__",
1554 (getter)property_get___isabstractmethod__, NULL,
1555 NULL,
1556 NULL},
1557 {NULL} /* Sentinel */
1558};
1559
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001560PyDoc_STRVAR(property_doc,
Tim Peters66c1a522001-09-24 21:17:50 +00001561"property(fget=None, fset=None, fdel=None, doc=None) -> property attribute\n"
1562"\n"
1563"fget is a function to be used for getting an attribute value, and likewise\n"
1564"fset is a function for setting, and fdel a function for del'ing, an\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001565"attribute. Typical use is to define a managed attribute x:\n\n"
Guido van Rossum91c0d8a2001-08-24 09:55:51 +00001566"class C(object):\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001567" def getx(self): return self._x\n"
1568" def setx(self, value): self._x = value\n"
1569" def delx(self): del self._x\n"
1570" x = property(getx, setx, delx, \"I'm the 'x' property.\")\n"
1571"\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001572"Decorators make defining new properties or modifying existing ones easy:\n\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001573"class C(object):\n"
1574" @property\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001575" def x(self):\n"
Gregory P. Smith0e524042013-11-25 00:30:56 -08001576" \"I am the 'x' property.\"\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001577" return self._x\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001578" @x.setter\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001579" def x(self, value):\n"
1580" self._x = value\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001581" @x.deleter\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001582" def x(self):\n"
1583" del self._x\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001584);
Guido van Rossum91c0d8a2001-08-24 09:55:51 +00001585
Guido van Rossum048eb752001-10-02 21:24:57 +00001586static int
1587property_traverse(PyObject *self, visitproc visit, void *arg)
1588{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001589 propertyobject *pp = (propertyobject *)self;
1590 Py_VISIT(pp->prop_get);
1591 Py_VISIT(pp->prop_set);
1592 Py_VISIT(pp->prop_del);
1593 Py_VISIT(pp->prop_doc);
1594 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +00001595}
1596
Raymond Hettingerd4be6912015-05-13 11:12:33 -07001597static int
1598property_clear(PyObject *self)
1599{
1600 propertyobject *pp = (propertyobject *)self;
1601 Py_CLEAR(pp->prop_doc);
1602 return 0;
1603}
1604
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001605PyTypeObject PyProperty_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001606 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1607 "property", /* tp_name */
1608 sizeof(propertyobject), /* tp_basicsize */
1609 0, /* tp_itemsize */
1610 /* methods */
1611 property_dealloc, /* tp_dealloc */
1612 0, /* tp_print */
1613 0, /* tp_getattr */
1614 0, /* tp_setattr */
1615 0, /* tp_reserved */
1616 0, /* tp_repr */
1617 0, /* tp_as_number */
1618 0, /* tp_as_sequence */
1619 0, /* tp_as_mapping */
1620 0, /* tp_hash */
1621 0, /* tp_call */
1622 0, /* tp_str */
1623 PyObject_GenericGetAttr, /* tp_getattro */
1624 0, /* tp_setattro */
1625 0, /* tp_as_buffer */
1626 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
1627 Py_TPFLAGS_BASETYPE, /* tp_flags */
1628 property_doc, /* tp_doc */
1629 property_traverse, /* tp_traverse */
Raymond Hettingerd4be6912015-05-13 11:12:33 -07001630 (inquiry)property_clear, /* tp_clear */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001631 0, /* tp_richcompare */
1632 0, /* tp_weaklistoffset */
1633 0, /* tp_iter */
1634 0, /* tp_iternext */
1635 property_methods, /* tp_methods */
1636 property_members, /* tp_members */
Benjamin Petersonbfebb7b2011-12-15 15:34:02 -05001637 property_getsetlist, /* tp_getset */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001638 0, /* tp_base */
1639 0, /* tp_dict */
1640 property_descr_get, /* tp_descr_get */
1641 property_descr_set, /* tp_descr_set */
1642 0, /* tp_dictoffset */
1643 property_init, /* tp_init */
1644 PyType_GenericAlloc, /* tp_alloc */
1645 PyType_GenericNew, /* tp_new */
1646 PyObject_GC_Del, /* tp_free */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001647};