blob: 3fb34a3d7b0640dc78c6a646971d8dc61e061b2a [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 *
Victor Stinnerc5257232017-01-18 10:38:09 +0100213methoddescr_call(PyMethodDescrObject *descr, PyObject *args, PyObject *kwargs)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000214{
Victor Stinnerc5257232017-01-18 10:38:09 +0100215 Py_ssize_t nargs;
216 PyObject *self, *result;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000217
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000218 /* Make sure that the first argument is acceptable as 'self' */
219 assert(PyTuple_Check(args));
Victor Stinnerc5257232017-01-18 10:38:09 +0100220 nargs = PyTuple_GET_SIZE(args);
221 if (nargs < 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000222 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
Victor Stinnerc5257232017-01-18 10:38:09 +0100242 result = _PyMethodDef_RawFastCallDict(descr->d_method, self,
243 &PyTuple_GET_ITEM(args, 1), nargs - 1,
244 kwargs);
245 result = _Py_CheckFunctionResult((PyObject *)descr, result, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000246 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000247}
248
249static PyObject *
Tim Petersbca1cbc2002-12-09 22:56:13 +0000250classmethoddescr_call(PyMethodDescrObject *descr, PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000251 PyObject *kwds)
Tim Petersbca1cbc2002-12-09 22:56:13 +0000252{
Benjamin Peterson7295c6a2012-05-01 09:51:09 -0400253 Py_ssize_t argc;
Victor Stinner2990fa12016-08-22 23:21:55 +0200254 PyObject *self, *func, *result, **stack;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000255
Benjamin Peterson7295c6a2012-05-01 09:51:09 -0400256 /* Make sure that the first argument is acceptable as 'self' */
257 assert(PyTuple_Check(args));
258 argc = PyTuple_GET_SIZE(args);
259 if (argc < 1) {
260 PyErr_Format(PyExc_TypeError,
261 "descriptor '%V' of '%.100s' "
262 "object needs an argument",
263 descr_name((PyDescrObject *)descr), "?",
264 PyDescr_TYPE(descr)->tp_name);
265 return NULL;
266 }
267 self = PyTuple_GET_ITEM(args, 0);
268 if (!PyType_Check(self)) {
269 PyErr_Format(PyExc_TypeError,
270 "descriptor '%V' requires a type "
271 "but received a '%.100s'",
272 descr_name((PyDescrObject *)descr), "?",
273 PyDescr_TYPE(descr)->tp_name,
274 self->ob_type->tp_name);
275 return NULL;
276 }
277 if (!PyType_IsSubtype((PyTypeObject *)self, PyDescr_TYPE(descr))) {
278 PyErr_Format(PyExc_TypeError,
279 "descriptor '%V' "
280 "requires a subtype of '%.100s' "
281 "but received '%.100s",
282 descr_name((PyDescrObject *)descr), "?",
283 PyDescr_TYPE(descr)->tp_name,
284 self->ob_type->tp_name);
285 return NULL;
286 }
287
Andrew Svetlov3ba3a3e2012-12-25 13:32:35 +0200288 func = PyCFunction_NewEx(descr->d_method, self, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000289 if (func == NULL)
290 return NULL;
Victor Stinner2990fa12016-08-22 23:21:55 +0200291 stack = &PyTuple_GET_ITEM(args, 1);
292 result = _PyObject_FastCallDict(func, stack, argc - 1, kwds);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000293 Py_DECREF(func);
294 return result;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000295}
296
297static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000298wrapperdescr_call(PyWrapperDescrObject *descr, PyObject *args, PyObject *kwds)
299{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000300 Py_ssize_t argc;
Victor Stinner2990fa12016-08-22 23:21:55 +0200301 PyObject *self, *func, *result, **stack;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000302
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000303 /* Make sure that the first argument is acceptable as 'self' */
304 assert(PyTuple_Check(args));
305 argc = PyTuple_GET_SIZE(args);
306 if (argc < 1) {
307 PyErr_Format(PyExc_TypeError,
308 "descriptor '%V' of '%.100s' "
309 "object needs an argument",
310 descr_name((PyDescrObject *)descr), "?",
311 PyDescr_TYPE(descr)->tp_name);
312 return NULL;
313 }
314 self = PyTuple_GET_ITEM(args, 0);
Victor Stinner3249dec2011-05-01 23:19:15 +0200315 if (!_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self),
Victor Stinnerd9561312011-05-01 23:31:36 +0200316 (PyObject *)PyDescr_TYPE(descr))) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000317 PyErr_Format(PyExc_TypeError,
318 "descriptor '%V' "
319 "requires a '%.100s' object "
320 "but received a '%.100s'",
321 descr_name((PyDescrObject *)descr), "?",
322 PyDescr_TYPE(descr)->tp_name,
323 self->ob_type->tp_name);
324 return NULL;
325 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000326
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000327 func = PyWrapper_New((PyObject *)descr, self);
328 if (func == NULL)
329 return NULL;
Victor Stinner2990fa12016-08-22 23:21:55 +0200330
331 stack = &PyTuple_GET_ITEM(args, 1);
332 result = _PyObject_FastCallDict(func, stack, argc - 1, kwds);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000333 Py_DECREF(func);
334 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000335}
336
337static PyObject *
Guido van Rossum6f799372001-09-20 20:46:19 +0000338method_get_doc(PyMethodDescrObject *descr, void *closure)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000339{
Larry Hastings2623c8c2014-02-08 22:15:29 -0800340 return _PyType_GetDocFromInternalDoc(descr->d_method->ml_name, descr->d_method->ml_doc);
Larry Hastings5c661892014-01-24 06:17:25 -0800341}
342
343static PyObject *
344method_get_text_signature(PyMethodDescrObject *descr, void *closure)
345{
Larry Hastings2623c8c2014-02-08 22:15:29 -0800346 return _PyType_GetTextSignatureFromInternalDoc(descr->d_method->ml_name, descr->d_method->ml_doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000347}
348
Antoine Pitrou9d574812011-12-12 13:47:25 +0100349static PyObject *
350calculate_qualname(PyDescrObject *descr)
351{
352 PyObject *type_qualname, *res;
353 _Py_IDENTIFIER(__qualname__);
354
355 if (descr->d_name == NULL || !PyUnicode_Check(descr->d_name)) {
356 PyErr_SetString(PyExc_TypeError,
357 "<descriptor>.__name__ is not a unicode object");
358 return NULL;
359 }
360
361 type_qualname = _PyObject_GetAttrId((PyObject *)descr->d_type,
362 &PyId___qualname__);
363 if (type_qualname == NULL)
364 return NULL;
365
366 if (!PyUnicode_Check(type_qualname)) {
367 PyErr_SetString(PyExc_TypeError, "<descriptor>.__objclass__."
368 "__qualname__ is not a unicode object");
369 Py_XDECREF(type_qualname);
370 return NULL;
371 }
372
373 res = PyUnicode_FromFormat("%S.%S", type_qualname, descr->d_name);
374 Py_DECREF(type_qualname);
375 return res;
376}
377
378static PyObject *
379descr_get_qualname(PyDescrObject *descr)
380{
381 if (descr->d_qualname == NULL)
382 descr->d_qualname = calculate_qualname(descr);
383 Py_XINCREF(descr->d_qualname);
384 return descr->d_qualname;
385}
386
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100387static PyObject *
388descr_reduce(PyDescrObject *descr)
389{
390 PyObject *builtins;
391 PyObject *getattr;
392 _Py_IDENTIFIER(getattr);
393
394 builtins = PyEval_GetBuiltins();
395 getattr = _PyDict_GetItemId(builtins, &PyId_getattr);
396 return Py_BuildValue("O(OO)", getattr, PyDescr_TYPE(descr),
397 PyDescr_NAME(descr));
398}
399
400static PyMethodDef descr_methods[] = {
401 {"__reduce__", (PyCFunction)descr_reduce, METH_NOARGS, NULL},
402 {NULL, NULL}
403};
404
Guido van Rossum6f799372001-09-20 20:46:19 +0000405static PyMemberDef descr_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000406 {"__objclass__", T_OBJECT, offsetof(PyDescrObject, d_type), READONLY},
407 {"__name__", T_OBJECT, offsetof(PyDescrObject, d_name), READONLY},
408 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000409};
410
Guido van Rossum32d34c82001-09-20 21:45:26 +0000411static PyGetSetDef method_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000412 {"__doc__", (getter)method_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100413 {"__qualname__", (getter)descr_get_qualname},
Larry Hastings5c661892014-01-24 06:17:25 -0800414 {"__text_signature__", (getter)method_get_text_signature},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000415 {0}
Guido van Rossum6f799372001-09-20 20:46:19 +0000416};
417
418static PyObject *
419member_get_doc(PyMemberDescrObject *descr, void *closure)
420{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000421 if (descr->d_member->doc == NULL) {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200422 Py_RETURN_NONE;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000423 }
424 return PyUnicode_FromString(descr->d_member->doc);
Guido van Rossum6f799372001-09-20 20:46:19 +0000425}
426
Guido van Rossum32d34c82001-09-20 21:45:26 +0000427static PyGetSetDef member_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000428 {"__doc__", (getter)member_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100429 {"__qualname__", (getter)descr_get_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000430 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000431};
432
433static PyObject *
Guido van Rossum32d34c82001-09-20 21:45:26 +0000434getset_get_doc(PyGetSetDescrObject *descr, void *closure)
435{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000436 if (descr->d_getset->doc == NULL) {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200437 Py_RETURN_NONE;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000438 }
439 return PyUnicode_FromString(descr->d_getset->doc);
Guido van Rossum32d34c82001-09-20 21:45:26 +0000440}
441
442static PyGetSetDef getset_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000443 {"__doc__", (getter)getset_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100444 {"__qualname__", (getter)descr_get_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000445 {0}
Guido van Rossum32d34c82001-09-20 21:45:26 +0000446};
447
448static PyObject *
Armin Rigoc6686b72005-11-07 08:38:00 +0000449wrapperdescr_get_doc(PyWrapperDescrObject *descr, void *closure)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000450{
Larry Hastings2623c8c2014-02-08 22:15:29 -0800451 return _PyType_GetDocFromInternalDoc(descr->d_base->name, descr->d_base->doc);
Larry Hastings5c661892014-01-24 06:17:25 -0800452}
453
454static PyObject *
455wrapperdescr_get_text_signature(PyWrapperDescrObject *descr, void *closure)
456{
Larry Hastings2623c8c2014-02-08 22:15:29 -0800457 return _PyType_GetTextSignatureFromInternalDoc(descr->d_base->name, descr->d_base->doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000458}
459
Armin Rigoc6686b72005-11-07 08:38:00 +0000460static PyGetSetDef wrapperdescr_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000461 {"__doc__", (getter)wrapperdescr_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100462 {"__qualname__", (getter)descr_get_qualname},
Larry Hastings5c661892014-01-24 06:17:25 -0800463 {"__text_signature__", (getter)wrapperdescr_get_text_signature},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000464 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000465};
466
Guido van Rossum048eb752001-10-02 21:24:57 +0000467static int
468descr_traverse(PyObject *self, visitproc visit, void *arg)
469{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000470 PyDescrObject *descr = (PyDescrObject *)self;
471 Py_VISIT(descr->d_type);
472 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +0000473}
474
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000475PyTypeObject PyMethodDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000476 PyVarObject_HEAD_INIT(&PyType_Type, 0)
477 "method_descriptor",
478 sizeof(PyMethodDescrObject),
479 0,
480 (destructor)descr_dealloc, /* tp_dealloc */
481 0, /* tp_print */
482 0, /* tp_getattr */
483 0, /* tp_setattr */
484 0, /* tp_reserved */
485 (reprfunc)method_repr, /* tp_repr */
486 0, /* tp_as_number */
487 0, /* tp_as_sequence */
488 0, /* tp_as_mapping */
489 0, /* tp_hash */
490 (ternaryfunc)methoddescr_call, /* tp_call */
491 0, /* tp_str */
492 PyObject_GenericGetAttr, /* tp_getattro */
493 0, /* tp_setattro */
494 0, /* tp_as_buffer */
495 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
496 0, /* tp_doc */
497 descr_traverse, /* tp_traverse */
498 0, /* tp_clear */
499 0, /* tp_richcompare */
500 0, /* tp_weaklistoffset */
501 0, /* tp_iter */
502 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100503 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000504 descr_members, /* tp_members */
505 method_getset, /* tp_getset */
506 0, /* tp_base */
507 0, /* tp_dict */
508 (descrgetfunc)method_get, /* tp_descr_get */
509 0, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000510};
511
Guido van Rossumb6e5a0c2003-02-11 18:44:42 +0000512/* This is for METH_CLASS in C, not for "f = classmethod(f)" in Python! */
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000513PyTypeObject PyClassMethodDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000514 PyVarObject_HEAD_INIT(&PyType_Type, 0)
515 "classmethod_descriptor",
516 sizeof(PyMethodDescrObject),
517 0,
518 (destructor)descr_dealloc, /* tp_dealloc */
519 0, /* tp_print */
520 0, /* tp_getattr */
521 0, /* tp_setattr */
522 0, /* tp_reserved */
523 (reprfunc)method_repr, /* tp_repr */
524 0, /* tp_as_number */
525 0, /* tp_as_sequence */
526 0, /* tp_as_mapping */
527 0, /* tp_hash */
528 (ternaryfunc)classmethoddescr_call, /* tp_call */
529 0, /* tp_str */
530 PyObject_GenericGetAttr, /* tp_getattro */
531 0, /* tp_setattro */
532 0, /* tp_as_buffer */
533 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
534 0, /* tp_doc */
535 descr_traverse, /* tp_traverse */
536 0, /* tp_clear */
537 0, /* tp_richcompare */
538 0, /* tp_weaklistoffset */
539 0, /* tp_iter */
540 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100541 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000542 descr_members, /* tp_members */
543 method_getset, /* tp_getset */
544 0, /* tp_base */
545 0, /* tp_dict */
546 (descrgetfunc)classmethod_get, /* tp_descr_get */
547 0, /* tp_descr_set */
Tim Petersbca1cbc2002-12-09 22:56:13 +0000548};
549
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000550PyTypeObject PyMemberDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000551 PyVarObject_HEAD_INIT(&PyType_Type, 0)
552 "member_descriptor",
553 sizeof(PyMemberDescrObject),
554 0,
555 (destructor)descr_dealloc, /* tp_dealloc */
556 0, /* tp_print */
557 0, /* tp_getattr */
558 0, /* tp_setattr */
559 0, /* tp_reserved */
560 (reprfunc)member_repr, /* tp_repr */
561 0, /* tp_as_number */
562 0, /* tp_as_sequence */
563 0, /* tp_as_mapping */
564 0, /* tp_hash */
565 0, /* tp_call */
566 0, /* tp_str */
567 PyObject_GenericGetAttr, /* tp_getattro */
568 0, /* tp_setattro */
569 0, /* tp_as_buffer */
570 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
571 0, /* tp_doc */
572 descr_traverse, /* tp_traverse */
573 0, /* tp_clear */
574 0, /* tp_richcompare */
575 0, /* tp_weaklistoffset */
576 0, /* tp_iter */
577 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100578 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000579 descr_members, /* tp_members */
580 member_getset, /* tp_getset */
581 0, /* tp_base */
582 0, /* tp_dict */
583 (descrgetfunc)member_get, /* tp_descr_get */
584 (descrsetfunc)member_set, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000585};
586
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000587PyTypeObject PyGetSetDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000588 PyVarObject_HEAD_INIT(&PyType_Type, 0)
589 "getset_descriptor",
590 sizeof(PyGetSetDescrObject),
591 0,
592 (destructor)descr_dealloc, /* tp_dealloc */
593 0, /* tp_print */
594 0, /* tp_getattr */
595 0, /* tp_setattr */
596 0, /* tp_reserved */
597 (reprfunc)getset_repr, /* tp_repr */
598 0, /* tp_as_number */
599 0, /* tp_as_sequence */
600 0, /* tp_as_mapping */
601 0, /* tp_hash */
602 0, /* tp_call */
603 0, /* tp_str */
604 PyObject_GenericGetAttr, /* tp_getattro */
605 0, /* tp_setattro */
606 0, /* tp_as_buffer */
607 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
608 0, /* tp_doc */
609 descr_traverse, /* tp_traverse */
610 0, /* tp_clear */
611 0, /* tp_richcompare */
612 0, /* tp_weaklistoffset */
613 0, /* tp_iter */
614 0, /* tp_iternext */
615 0, /* tp_methods */
616 descr_members, /* tp_members */
617 getset_getset, /* tp_getset */
618 0, /* tp_base */
619 0, /* tp_dict */
620 (descrgetfunc)getset_get, /* tp_descr_get */
621 (descrsetfunc)getset_set, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000622};
623
Guido van Rossumf4593e02001-10-03 12:09:30 +0000624PyTypeObject PyWrapperDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000625 PyVarObject_HEAD_INIT(&PyType_Type, 0)
626 "wrapper_descriptor",
627 sizeof(PyWrapperDescrObject),
628 0,
629 (destructor)descr_dealloc, /* tp_dealloc */
630 0, /* tp_print */
631 0, /* tp_getattr */
632 0, /* tp_setattr */
633 0, /* tp_reserved */
634 (reprfunc)wrapperdescr_repr, /* tp_repr */
635 0, /* tp_as_number */
636 0, /* tp_as_sequence */
637 0, /* tp_as_mapping */
638 0, /* tp_hash */
639 (ternaryfunc)wrapperdescr_call, /* tp_call */
640 0, /* tp_str */
641 PyObject_GenericGetAttr, /* tp_getattro */
642 0, /* tp_setattro */
643 0, /* tp_as_buffer */
644 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
645 0, /* tp_doc */
646 descr_traverse, /* tp_traverse */
647 0, /* tp_clear */
648 0, /* tp_richcompare */
649 0, /* tp_weaklistoffset */
650 0, /* tp_iter */
651 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100652 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000653 descr_members, /* tp_members */
654 wrapperdescr_getset, /* tp_getset */
655 0, /* tp_base */
656 0, /* tp_dict */
657 (descrgetfunc)wrapperdescr_get, /* tp_descr_get */
658 0, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000659};
660
661static PyDescrObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000662descr_new(PyTypeObject *descrtype, PyTypeObject *type, const char *name)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000663{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000664 PyDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000665
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000666 descr = (PyDescrObject *)PyType_GenericAlloc(descrtype, 0);
667 if (descr != NULL) {
668 Py_XINCREF(type);
669 descr->d_type = type;
670 descr->d_name = PyUnicode_InternFromString(name);
671 if (descr->d_name == NULL) {
672 Py_DECREF(descr);
673 descr = NULL;
674 }
Benjamin Petersonf2fe7f02011-12-17 08:02:20 -0500675 else {
676 descr->d_qualname = NULL;
677 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000678 }
679 return descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000680}
681
682PyObject *
683PyDescr_NewMethod(PyTypeObject *type, PyMethodDef *method)
684{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000685 PyMethodDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000686
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000687 descr = (PyMethodDescrObject *)descr_new(&PyMethodDescr_Type,
688 type, method->ml_name);
689 if (descr != NULL)
690 descr->d_method = method;
691 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000692}
693
694PyObject *
Tim Petersbca1cbc2002-12-09 22:56:13 +0000695PyDescr_NewClassMethod(PyTypeObject *type, PyMethodDef *method)
696{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000697 PyMethodDescrObject *descr;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000698
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000699 descr = (PyMethodDescrObject *)descr_new(&PyClassMethodDescr_Type,
700 type, method->ml_name);
701 if (descr != NULL)
702 descr->d_method = method;
703 return (PyObject *)descr;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000704}
705
706PyObject *
Guido van Rossum6f799372001-09-20 20:46:19 +0000707PyDescr_NewMember(PyTypeObject *type, PyMemberDef *member)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000708{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000709 PyMemberDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000710
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000711 descr = (PyMemberDescrObject *)descr_new(&PyMemberDescr_Type,
712 type, member->name);
713 if (descr != NULL)
714 descr->d_member = member;
715 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000716}
717
718PyObject *
Guido van Rossum32d34c82001-09-20 21:45:26 +0000719PyDescr_NewGetSet(PyTypeObject *type, PyGetSetDef *getset)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000720{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000721 PyGetSetDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000722
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000723 descr = (PyGetSetDescrObject *)descr_new(&PyGetSetDescr_Type,
724 type, getset->name);
725 if (descr != NULL)
726 descr->d_getset = getset;
727 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000728}
729
730PyObject *
731PyDescr_NewWrapper(PyTypeObject *type, struct wrapperbase *base, void *wrapped)
732{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000733 PyWrapperDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000734
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000735 descr = (PyWrapperDescrObject *)descr_new(&PyWrapperDescr_Type,
736 type, base->name);
737 if (descr != NULL) {
738 descr->d_base = base;
739 descr->d_wrapped = wrapped;
740 }
741 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000742}
743
Tim Peters6d6c1a32001-08-02 04:15:00 +0000744
Victor Stinner0db176f2012-04-16 00:16:30 +0200745/* --- mappingproxy: read-only proxy for mappings --- */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000746
747/* This has no reason to be in this file except that adding new files is a
748 bit of a pain */
749
750typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000751 PyObject_HEAD
Victor Stinner0db176f2012-04-16 00:16:30 +0200752 PyObject *mapping;
753} mappingproxyobject;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000754
Martin v. Löwis18e16552006-02-15 17:27:45 +0000755static Py_ssize_t
Victor Stinner0db176f2012-04-16 00:16:30 +0200756mappingproxy_len(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000757{
Victor Stinner0db176f2012-04-16 00:16:30 +0200758 return PyObject_Size(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000759}
760
761static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200762mappingproxy_getitem(mappingproxyobject *pp, PyObject *key)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000763{
Victor Stinner0db176f2012-04-16 00:16:30 +0200764 return PyObject_GetItem(pp->mapping, key);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000765}
766
Victor Stinner0db176f2012-04-16 00:16:30 +0200767static PyMappingMethods mappingproxy_as_mapping = {
768 (lenfunc)mappingproxy_len, /* mp_length */
769 (binaryfunc)mappingproxy_getitem, /* mp_subscript */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000770 0, /* mp_ass_subscript */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000771};
772
773static int
Victor Stinner0db176f2012-04-16 00:16:30 +0200774mappingproxy_contains(mappingproxyobject *pp, PyObject *key)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000775{
Victor Stinner0db176f2012-04-16 00:16:30 +0200776 if (PyDict_CheckExact(pp->mapping))
777 return PyDict_Contains(pp->mapping, key);
778 else
779 return PySequence_Contains(pp->mapping, key);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000780}
781
Victor Stinner0db176f2012-04-16 00:16:30 +0200782static PySequenceMethods mappingproxy_as_sequence = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000783 0, /* sq_length */
784 0, /* sq_concat */
785 0, /* sq_repeat */
786 0, /* sq_item */
787 0, /* sq_slice */
788 0, /* sq_ass_item */
789 0, /* sq_ass_slice */
Victor Stinner0db176f2012-04-16 00:16:30 +0200790 (objobjproc)mappingproxy_contains, /* sq_contains */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000791 0, /* sq_inplace_concat */
792 0, /* sq_inplace_repeat */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000793};
794
795static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200796mappingproxy_get(mappingproxyobject *pp, PyObject *args)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000797{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000798 PyObject *key, *def = Py_None;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200799 _Py_IDENTIFIER(get);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000800
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000801 if (!PyArg_UnpackTuple(args, "get", 1, 2, &key, &def))
802 return NULL;
Victor Stinner7e425412016-12-09 00:36:19 +0100803 return _PyObject_CallMethodIdObjArgs(pp->mapping, &PyId_get,
804 key, def, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000805}
806
807static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200808mappingproxy_keys(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000809{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200810 _Py_IDENTIFIER(keys);
Victor Stinner0db176f2012-04-16 00:16:30 +0200811 return _PyObject_CallMethodId(pp->mapping, &PyId_keys, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000812}
813
814static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200815mappingproxy_values(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000816{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200817 _Py_IDENTIFIER(values);
Victor Stinner0db176f2012-04-16 00:16:30 +0200818 return _PyObject_CallMethodId(pp->mapping, &PyId_values, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000819}
820
821static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200822mappingproxy_items(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000823{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200824 _Py_IDENTIFIER(items);
Victor Stinner0db176f2012-04-16 00:16:30 +0200825 return _PyObject_CallMethodId(pp->mapping, &PyId_items, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000826}
827
828static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200829mappingproxy_copy(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000830{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200831 _Py_IDENTIFIER(copy);
Victor Stinner0db176f2012-04-16 00:16:30 +0200832 return _PyObject_CallMethodId(pp->mapping, &PyId_copy, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000833}
834
Victor Stinner0db176f2012-04-16 00:16:30 +0200835/* WARNING: mappingproxy methods must not give access
836 to the underlying mapping */
837
838static PyMethodDef mappingproxy_methods[] = {
839 {"get", (PyCFunction)mappingproxy_get, METH_VARARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000840 PyDoc_STR("D.get(k[,d]) -> D[k] if k in D, else d."
Victor Stinner0db176f2012-04-16 00:16:30 +0200841 " d defaults to None.")},
842 {"keys", (PyCFunction)mappingproxy_keys, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000843 PyDoc_STR("D.keys() -> list of D's keys")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200844 {"values", (PyCFunction)mappingproxy_values, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000845 PyDoc_STR("D.values() -> list of D's values")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200846 {"items", (PyCFunction)mappingproxy_items, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000847 PyDoc_STR("D.items() -> list of D's (key, value) pairs, as 2-tuples")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200848 {"copy", (PyCFunction)mappingproxy_copy, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000849 PyDoc_STR("D.copy() -> a shallow copy of D")},
850 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000851};
852
853static void
Victor Stinner0db176f2012-04-16 00:16:30 +0200854mappingproxy_dealloc(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000855{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000856 _PyObject_GC_UNTRACK(pp);
Victor Stinner0db176f2012-04-16 00:16:30 +0200857 Py_DECREF(pp->mapping);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000858 PyObject_GC_Del(pp);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000859}
860
861static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200862mappingproxy_getiter(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000863{
Victor Stinner0db176f2012-04-16 00:16:30 +0200864 return PyObject_GetIter(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000865}
866
Neil Schemenauer26775122001-10-21 22:26:43 +0000867static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200868mappingproxy_str(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000869{
Victor Stinner0db176f2012-04-16 00:16:30 +0200870 return PyObject_Str(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000871}
872
Ezio Melottiac53ab62010-12-18 14:59:43 +0000873static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200874mappingproxy_repr(mappingproxyobject *pp)
Ezio Melottiac53ab62010-12-18 14:59:43 +0000875{
Victor Stinner0db176f2012-04-16 00:16:30 +0200876 return PyUnicode_FromFormat("mappingproxy(%R)", pp->mapping);
Ezio Melottiac53ab62010-12-18 14:59:43 +0000877}
878
Guido van Rossum048eb752001-10-02 21:24:57 +0000879static int
Victor Stinner0db176f2012-04-16 00:16:30 +0200880mappingproxy_traverse(PyObject *self, visitproc visit, void *arg)
Guido van Rossum048eb752001-10-02 21:24:57 +0000881{
Victor Stinner0db176f2012-04-16 00:16:30 +0200882 mappingproxyobject *pp = (mappingproxyobject *)self;
883 Py_VISIT(pp->mapping);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000884 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +0000885}
886
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000887static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200888mappingproxy_richcompare(mappingproxyobject *v, PyObject *w, int op)
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000889{
Victor Stinner0db176f2012-04-16 00:16:30 +0200890 return PyObject_RichCompare(v->mapping, w, op);
891}
892
893static int
894mappingproxy_check_mapping(PyObject *mapping)
895{
896 if (!PyMapping_Check(mapping)
897 || PyList_Check(mapping)
898 || PyTuple_Check(mapping)) {
899 PyErr_Format(PyExc_TypeError,
900 "mappingproxy() argument must be a mapping, not %s",
901 Py_TYPE(mapping)->tp_name);
902 return -1;
903 }
904 return 0;
905}
906
907static PyObject*
908mappingproxy_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
909{
910 static char *kwlist[] = {"mapping", NULL};
911 PyObject *mapping;
912 mappingproxyobject *mappingproxy;
913
914 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O:mappingproxy",
915 kwlist, &mapping))
916 return NULL;
917
918 if (mappingproxy_check_mapping(mapping) == -1)
919 return NULL;
920
921 mappingproxy = PyObject_GC_New(mappingproxyobject, &PyDictProxy_Type);
922 if (mappingproxy == NULL)
923 return NULL;
924 Py_INCREF(mapping);
925 mappingproxy->mapping = mapping;
926 _PyObject_GC_TRACK(mappingproxy);
927 return (PyObject *)mappingproxy;
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000928}
929
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000930PyTypeObject PyDictProxy_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000931 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Victor Stinner0db176f2012-04-16 00:16:30 +0200932 "mappingproxy", /* tp_name */
933 sizeof(mappingproxyobject), /* tp_basicsize */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000934 0, /* tp_itemsize */
935 /* methods */
Victor Stinner0db176f2012-04-16 00:16:30 +0200936 (destructor)mappingproxy_dealloc, /* tp_dealloc */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000937 0, /* tp_print */
938 0, /* tp_getattr */
939 0, /* tp_setattr */
940 0, /* tp_reserved */
Victor Stinner0db176f2012-04-16 00:16:30 +0200941 (reprfunc)mappingproxy_repr, /* tp_repr */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000942 0, /* tp_as_number */
Victor Stinner0db176f2012-04-16 00:16:30 +0200943 &mappingproxy_as_sequence, /* tp_as_sequence */
944 &mappingproxy_as_mapping, /* tp_as_mapping */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000945 0, /* tp_hash */
946 0, /* tp_call */
Victor Stinner0db176f2012-04-16 00:16:30 +0200947 (reprfunc)mappingproxy_str, /* tp_str */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000948 PyObject_GenericGetAttr, /* tp_getattro */
949 0, /* tp_setattro */
950 0, /* tp_as_buffer */
951 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
952 0, /* tp_doc */
Victor Stinner0db176f2012-04-16 00:16:30 +0200953 mappingproxy_traverse, /* tp_traverse */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000954 0, /* tp_clear */
Victor Stinner0db176f2012-04-16 00:16:30 +0200955 (richcmpfunc)mappingproxy_richcompare, /* tp_richcompare */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000956 0, /* tp_weaklistoffset */
Victor Stinner0db176f2012-04-16 00:16:30 +0200957 (getiterfunc)mappingproxy_getiter, /* tp_iter */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 0, /* tp_iternext */
Victor Stinner0db176f2012-04-16 00:16:30 +0200959 mappingproxy_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000960 0, /* tp_members */
961 0, /* tp_getset */
962 0, /* tp_base */
963 0, /* tp_dict */
964 0, /* tp_descr_get */
965 0, /* tp_descr_set */
Victor Stinner0db176f2012-04-16 00:16:30 +0200966 0, /* tp_dictoffset */
967 0, /* tp_init */
968 0, /* tp_alloc */
969 mappingproxy_new, /* tp_new */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000970};
971
972PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200973PyDictProxy_New(PyObject *mapping)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000974{
Victor Stinner0db176f2012-04-16 00:16:30 +0200975 mappingproxyobject *pp;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000976
Victor Stinner0db176f2012-04-16 00:16:30 +0200977 if (mappingproxy_check_mapping(mapping) == -1)
978 return NULL;
979
980 pp = PyObject_GC_New(mappingproxyobject, &PyDictProxy_Type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000981 if (pp != NULL) {
Victor Stinner0db176f2012-04-16 00:16:30 +0200982 Py_INCREF(mapping);
983 pp->mapping = mapping;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000984 _PyObject_GC_TRACK(pp);
985 }
986 return (PyObject *)pp;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000987}
988
989
990/* --- Wrapper object for "slot" methods --- */
991
992/* This has no reason to be in this file except that adding new files is a
993 bit of a pain */
994
995typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000996 PyObject_HEAD
997 PyWrapperDescrObject *descr;
998 PyObject *self;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000999} wrapperobject;
1000
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001001#define Wrapper_Check(v) (Py_TYPE(v) == &_PyMethodWrapper_Type)
Mark Dickinson211c6252009-02-01 10:28:51 +00001002
Tim Peters6d6c1a32001-08-02 04:15:00 +00001003static void
1004wrapper_dealloc(wrapperobject *wp)
1005{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001006 PyObject_GC_UnTrack(wp);
1007 Py_TRASHCAN_SAFE_BEGIN(wp)
1008 Py_XDECREF(wp->descr);
1009 Py_XDECREF(wp->self);
1010 PyObject_GC_Del(wp);
1011 Py_TRASHCAN_SAFE_END(wp)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001012}
1013
Mark Dickinson211c6252009-02-01 10:28:51 +00001014#define TEST_COND(cond) ((cond) ? Py_True : Py_False)
1015
1016static PyObject *
1017wrapper_richcompare(PyObject *a, PyObject *b, int op)
Armin Rigoc6686b72005-11-07 08:38:00 +00001018{
Benjamin Petersonca470632016-09-06 13:47:26 -07001019 intptr_t result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001020 PyObject *v;
1021 PyWrapperDescrObject *a_descr, *b_descr;
Mark Dickinson211c6252009-02-01 10:28:51 +00001022
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001023 assert(a != NULL && b != NULL);
Mark Dickinson211c6252009-02-01 10:28:51 +00001024
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001025 /* both arguments should be wrapperobjects */
1026 if (!Wrapper_Check(a) || !Wrapper_Check(b)) {
1027 v = Py_NotImplemented;
1028 Py_INCREF(v);
1029 return v;
1030 }
Mark Dickinson211c6252009-02-01 10:28:51 +00001031
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001032 /* compare by descriptor address; if the descriptors are the same,
1033 compare by the objects they're bound to */
1034 a_descr = ((wrapperobject *)a)->descr;
1035 b_descr = ((wrapperobject *)b)->descr;
1036 if (a_descr == b_descr) {
1037 a = ((wrapperobject *)a)->self;
1038 b = ((wrapperobject *)b)->self;
1039 return PyObject_RichCompare(a, b, op);
1040 }
Mark Dickinson211c6252009-02-01 10:28:51 +00001041
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001042 result = a_descr - b_descr;
1043 switch (op) {
1044 case Py_EQ:
1045 v = TEST_COND(result == 0);
1046 break;
1047 case Py_NE:
1048 v = TEST_COND(result != 0);
1049 break;
1050 case Py_LE:
1051 v = TEST_COND(result <= 0);
1052 break;
1053 case Py_GE:
1054 v = TEST_COND(result >= 0);
1055 break;
1056 case Py_LT:
1057 v = TEST_COND(result < 0);
1058 break;
1059 case Py_GT:
1060 v = TEST_COND(result > 0);
1061 break;
1062 default:
1063 PyErr_BadArgument();
1064 return NULL;
1065 }
1066 Py_INCREF(v);
1067 return v;
Armin Rigoc6686b72005-11-07 08:38:00 +00001068}
1069
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001070static Py_hash_t
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001071wrapper_hash(wrapperobject *wp)
1072{
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001073 Py_hash_t x, y;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001074 x = _Py_HashPointer(wp->descr);
1075 if (x == -1)
1076 return -1;
1077 y = PyObject_Hash(wp->self);
1078 if (y == -1)
1079 return -1;
1080 x = x ^ y;
1081 if (x == -1)
1082 x = -2;
1083 return x;
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001084}
1085
Armin Rigoc6686b72005-11-07 08:38:00 +00001086static PyObject *
1087wrapper_repr(wrapperobject *wp)
1088{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001089 return PyUnicode_FromFormat("<method-wrapper '%s' of %s object at %p>",
1090 wp->descr->d_base->name,
1091 wp->self->ob_type->tp_name,
1092 wp->self);
Armin Rigoc6686b72005-11-07 08:38:00 +00001093}
1094
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001095static PyObject *
1096wrapper_reduce(wrapperobject *wp)
1097{
1098 PyObject *builtins;
1099 PyObject *getattr;
1100 _Py_IDENTIFIER(getattr);
1101
1102 builtins = PyEval_GetBuiltins();
1103 getattr = _PyDict_GetItemId(builtins, &PyId_getattr);
1104 return Py_BuildValue("O(OO)", getattr, wp->self, PyDescr_NAME(wp->descr));
1105}
1106
1107static PyMethodDef wrapper_methods[] = {
1108 {"__reduce__", (PyCFunction)wrapper_reduce, METH_NOARGS, NULL},
1109 {NULL, NULL}
1110};
1111
Armin Rigoc6686b72005-11-07 08:38:00 +00001112static PyMemberDef wrapper_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001113 {"__self__", T_OBJECT, offsetof(wrapperobject, self), READONLY},
1114 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001115};
1116
1117static PyObject *
Armin Rigoc6686b72005-11-07 08:38:00 +00001118wrapper_objclass(wrapperobject *wp)
1119{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001120 PyObject *c = (PyObject *)PyDescr_TYPE(wp->descr);
Armin Rigoc6686b72005-11-07 08:38:00 +00001121
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001122 Py_INCREF(c);
1123 return c;
Armin Rigoc6686b72005-11-07 08:38:00 +00001124}
1125
1126static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001127wrapper_name(wrapperobject *wp)
1128{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001129 const char *s = wp->descr->d_base->name;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001130
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001131 return PyUnicode_FromString(s);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001132}
1133
1134static PyObject *
Larry Hastings5c661892014-01-24 06:17:25 -08001135wrapper_doc(wrapperobject *wp, void *closure)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001136{
Larry Hastings2623c8c2014-02-08 22:15:29 -08001137 return _PyType_GetDocFromInternalDoc(wp->descr->d_base->name, wp->descr->d_base->doc);
Larry Hastings5c661892014-01-24 06:17:25 -08001138}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001139
Larry Hastings5c661892014-01-24 06:17:25 -08001140static PyObject *
1141wrapper_text_signature(wrapperobject *wp, void *closure)
1142{
Larry Hastings2623c8c2014-02-08 22:15:29 -08001143 return _PyType_GetTextSignatureFromInternalDoc(wp->descr->d_base->name, wp->descr->d_base->doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001144}
1145
Antoine Pitrou9d574812011-12-12 13:47:25 +01001146static PyObject *
1147wrapper_qualname(wrapperobject *wp)
1148{
1149 return descr_get_qualname((PyDescrObject *)wp->descr);
1150}
1151
Guido van Rossum32d34c82001-09-20 21:45:26 +00001152static PyGetSetDef wrapper_getsets[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001153 {"__objclass__", (getter)wrapper_objclass},
1154 {"__name__", (getter)wrapper_name},
Antoine Pitrou9d574812011-12-12 13:47:25 +01001155 {"__qualname__", (getter)wrapper_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001156 {"__doc__", (getter)wrapper_doc},
Larry Hastings5c661892014-01-24 06:17:25 -08001157 {"__text_signature__", (getter)wrapper_text_signature},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001158 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001159};
1160
1161static PyObject *
1162wrapper_call(wrapperobject *wp, PyObject *args, PyObject *kwds)
1163{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001164 wrapperfunc wrapper = wp->descr->d_base->wrapper;
1165 PyObject *self = wp->self;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001166
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001167 if (wp->descr->d_base->flags & PyWrapperFlag_KEYWORDS) {
1168 wrapperfunc_kwds wk = (wrapperfunc_kwds)wrapper;
1169 return (*wk)(self, args, wp->descr->d_wrapped, kwds);
1170 }
Guido van Rossumc8e56452001-10-22 00:43:43 +00001171
Serhiy Storchaka5ab81d72016-12-16 16:18:57 +02001172 if (kwds != NULL && (!PyDict_Check(kwds) || PyDict_GET_SIZE(kwds) != 0)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001173 PyErr_Format(PyExc_TypeError,
1174 "wrapper %s doesn't take keyword arguments",
1175 wp->descr->d_base->name);
1176 return NULL;
1177 }
1178 return (*wrapper)(self, args, wp->descr->d_wrapped);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001179}
1180
Guido van Rossum048eb752001-10-02 21:24:57 +00001181static int
1182wrapper_traverse(PyObject *self, visitproc visit, void *arg)
1183{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001184 wrapperobject *wp = (wrapperobject *)self;
1185 Py_VISIT(wp->descr);
1186 Py_VISIT(wp->self);
1187 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +00001188}
1189
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001190PyTypeObject _PyMethodWrapper_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001191 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1192 "method-wrapper", /* tp_name */
1193 sizeof(wrapperobject), /* tp_basicsize */
1194 0, /* tp_itemsize */
1195 /* methods */
1196 (destructor)wrapper_dealloc, /* tp_dealloc */
1197 0, /* tp_print */
1198 0, /* tp_getattr */
1199 0, /* tp_setattr */
1200 0, /* tp_reserved */
1201 (reprfunc)wrapper_repr, /* tp_repr */
1202 0, /* tp_as_number */
1203 0, /* tp_as_sequence */
1204 0, /* tp_as_mapping */
1205 (hashfunc)wrapper_hash, /* tp_hash */
1206 (ternaryfunc)wrapper_call, /* tp_call */
1207 0, /* tp_str */
1208 PyObject_GenericGetAttr, /* tp_getattro */
1209 0, /* tp_setattro */
1210 0, /* tp_as_buffer */
1211 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
1212 0, /* tp_doc */
1213 wrapper_traverse, /* tp_traverse */
1214 0, /* tp_clear */
1215 wrapper_richcompare, /* tp_richcompare */
1216 0, /* tp_weaklistoffset */
1217 0, /* tp_iter */
1218 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001219 wrapper_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001220 wrapper_members, /* tp_members */
1221 wrapper_getsets, /* tp_getset */
1222 0, /* tp_base */
1223 0, /* tp_dict */
1224 0, /* tp_descr_get */
1225 0, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001226};
1227
1228PyObject *
1229PyWrapper_New(PyObject *d, PyObject *self)
1230{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001231 wrapperobject *wp;
1232 PyWrapperDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001233
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001234 assert(PyObject_TypeCheck(d, &PyWrapperDescr_Type));
1235 descr = (PyWrapperDescrObject *)d;
Victor Stinner3249dec2011-05-01 23:19:15 +02001236 assert(_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self),
Victor Stinnerd9561312011-05-01 23:31:36 +02001237 (PyObject *)PyDescr_TYPE(descr)));
Tim Peters6d6c1a32001-08-02 04:15:00 +00001238
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001239 wp = PyObject_GC_New(wrapperobject, &_PyMethodWrapper_Type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001240 if (wp != NULL) {
1241 Py_INCREF(descr);
1242 wp->descr = descr;
1243 Py_INCREF(self);
1244 wp->self = self;
1245 _PyObject_GC_TRACK(wp);
1246 }
1247 return (PyObject *)wp;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001248}
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001249
1250
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001251/* A built-in 'property' type */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001252
1253/*
Serhiy Storchakad741a882015-06-11 00:06:39 +03001254class property(object):
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001255
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001256 def __init__(self, fget=None, fset=None, fdel=None, doc=None):
1257 if doc is None and fget is not None and hasattr(fget, "__doc__"):
Serhiy Storchakad741a882015-06-11 00:06:39 +03001258 doc = fget.__doc__
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001259 self.__get = fget
1260 self.__set = fset
1261 self.__del = fdel
1262 self.__doc__ = doc
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001263
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001264 def __get__(self, inst, type=None):
1265 if inst is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001266 return self
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001267 if self.__get is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001268 raise AttributeError, "unreadable attribute"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001269 return self.__get(inst)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001270
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001271 def __set__(self, inst, value):
1272 if self.__set is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001273 raise AttributeError, "can't set attribute"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001274 return self.__set(inst, value)
Guido van Rossumba2485f2001-12-10 18:03:34 +00001275
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001276 def __delete__(self, inst):
1277 if self.__del is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001278 raise AttributeError, "can't delete attribute"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001279 return self.__del(inst)
Guido van Rossumba2485f2001-12-10 18:03:34 +00001280
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001281*/
1282
1283typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001284 PyObject_HEAD
1285 PyObject *prop_get;
1286 PyObject *prop_set;
1287 PyObject *prop_del;
1288 PyObject *prop_doc;
1289 int getter_doc;
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001290} propertyobject;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001291
Christian Heimes0449f632007-12-15 01:27:15 +00001292static PyObject * property_copy(PyObject *, PyObject *, PyObject *,
Benjamin Peterson93964832010-06-28 03:07:10 +00001293 PyObject *);
Christian Heimes0449f632007-12-15 01:27:15 +00001294
Tim Peters66c1a522001-09-24 21:17:50 +00001295static PyMemberDef property_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001296 {"fget", T_OBJECT, offsetof(propertyobject, prop_get), READONLY},
1297 {"fset", T_OBJECT, offsetof(propertyobject, prop_set), READONLY},
1298 {"fdel", T_OBJECT, offsetof(propertyobject, prop_del), READONLY},
Raymond Hettingereac503a2015-05-13 01:09:59 -07001299 {"__doc__", T_OBJECT, offsetof(propertyobject, prop_doc), 0},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001300 {0}
Tim Peters66c1a522001-09-24 21:17:50 +00001301};
1302
Christian Heimes0449f632007-12-15 01:27:15 +00001303
Guido van Rossum58da9312007-11-10 23:39:45 +00001304PyDoc_STRVAR(getter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001305 "Descriptor to change the getter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001306
Neal Norwitz32dde222008-04-15 06:43:13 +00001307static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001308property_getter(PyObject *self, PyObject *getter)
1309{
Benjamin Peterson93964832010-06-28 03:07:10 +00001310 return property_copy(self, getter, NULL, NULL);
Guido van Rossum58da9312007-11-10 23:39:45 +00001311}
1312
Christian Heimes0449f632007-12-15 01:27:15 +00001313
Guido van Rossum58da9312007-11-10 23:39:45 +00001314PyDoc_STRVAR(setter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001315 "Descriptor to change the setter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001316
Neal Norwitz32dde222008-04-15 06:43:13 +00001317static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001318property_setter(PyObject *self, PyObject *setter)
1319{
Benjamin Peterson93964832010-06-28 03:07:10 +00001320 return property_copy(self, NULL, setter, NULL);
Guido van Rossum58da9312007-11-10 23:39:45 +00001321}
1322
Christian Heimes0449f632007-12-15 01:27:15 +00001323
Guido van Rossum58da9312007-11-10 23:39:45 +00001324PyDoc_STRVAR(deleter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001325 "Descriptor to change the deleter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001326
Neal Norwitz32dde222008-04-15 06:43:13 +00001327static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001328property_deleter(PyObject *self, PyObject *deleter)
1329{
Benjamin Peterson93964832010-06-28 03:07:10 +00001330 return property_copy(self, NULL, NULL, deleter);
Guido van Rossum58da9312007-11-10 23:39:45 +00001331}
1332
1333
Guido van Rossum58da9312007-11-10 23:39:45 +00001334static PyMethodDef property_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001335 {"getter", property_getter, METH_O, getter_doc},
1336 {"setter", property_setter, METH_O, setter_doc},
1337 {"deleter", property_deleter, METH_O, deleter_doc},
1338 {0}
Guido van Rossum58da9312007-11-10 23:39:45 +00001339};
1340
Tim Peters66c1a522001-09-24 21:17:50 +00001341
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001342static void
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001343property_dealloc(PyObject *self)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001344{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001345 propertyobject *gs = (propertyobject *)self;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001346
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001347 _PyObject_GC_UNTRACK(self);
1348 Py_XDECREF(gs->prop_get);
1349 Py_XDECREF(gs->prop_set);
1350 Py_XDECREF(gs->prop_del);
1351 Py_XDECREF(gs->prop_doc);
1352 self->ob_type->tp_free(self);
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001353}
1354
1355static PyObject *
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001356property_descr_get(PyObject *self, PyObject *obj, PyObject *type)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001357{
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001358 static PyObject * volatile cached_args = NULL;
1359 PyObject *args;
Raymond Hettingerc4e335b2015-04-30 08:08:13 -07001360 PyObject *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001361 propertyobject *gs = (propertyobject *)self;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001362
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001363 if (obj == NULL || obj == Py_None) {
1364 Py_INCREF(self);
1365 return self;
1366 }
1367 if (gs->prop_get == NULL) {
1368 PyErr_SetString(PyExc_AttributeError, "unreadable attribute");
1369 return NULL;
1370 }
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001371 args = cached_args;
Serhiy Storchaka7822f152016-05-04 21:42:05 +03001372 cached_args = NULL;
1373 if (!args) {
1374 args = PyTuple_New(1);
1375 if (!args)
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001376 return NULL;
Serhiy Storchaka7822f152016-05-04 21:42:05 +03001377 _PyObject_GC_UNTRACK(args);
Raymond Hettingerc4e335b2015-04-30 08:08:13 -07001378 }
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001379 Py_INCREF(obj);
Raymond Hettingerc4e335b2015-04-30 08:08:13 -07001380 PyTuple_SET_ITEM(args, 0, obj);
1381 ret = PyObject_Call(gs->prop_get, args, NULL);
Serhiy Storchaka7822f152016-05-04 21:42:05 +03001382 if (cached_args == NULL && Py_REFCNT(args) == 1) {
1383 assert(Py_SIZE(args) == 1);
1384 assert(PyTuple_GET_ITEM(args, 0) == obj);
1385 cached_args = args;
1386 Py_DECREF(obj);
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001387 }
Serhiy Storchaka7822f152016-05-04 21:42:05 +03001388 else {
1389 assert(Py_REFCNT(args) >= 1);
1390 _PyObject_GC_TRACK(args);
1391 Py_DECREF(args);
1392 }
Raymond Hettingerc4e335b2015-04-30 08:08:13 -07001393 return ret;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001394}
1395
1396static int
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001397property_descr_set(PyObject *self, PyObject *obj, PyObject *value)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001398{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001399 propertyobject *gs = (propertyobject *)self;
1400 PyObject *func, *res;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001401
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001402 if (value == NULL)
1403 func = gs->prop_del;
1404 else
1405 func = gs->prop_set;
1406 if (func == NULL) {
1407 PyErr_SetString(PyExc_AttributeError,
1408 value == NULL ?
1409 "can't delete attribute" :
1410 "can't set attribute");
1411 return -1;
1412 }
1413 if (value == NULL)
Victor Stinnerde4ae3d2016-12-04 22:59:09 +01001414 res = PyObject_CallFunctionObjArgs(func, obj, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001415 else
Benjamin Peterson9b955de2010-12-07 04:04:02 +00001416 res = PyObject_CallFunctionObjArgs(func, obj, value, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001417 if (res == NULL)
1418 return -1;
1419 Py_DECREF(res);
1420 return 0;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001421}
1422
Christian Heimes0449f632007-12-15 01:27:15 +00001423static PyObject *
Benjamin Peterson93964832010-06-28 03:07:10 +00001424property_copy(PyObject *old, PyObject *get, PyObject *set, PyObject *del)
Christian Heimes0449f632007-12-15 01:27:15 +00001425{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001426 propertyobject *pold = (propertyobject *)old;
Benjamin Peterson93964832010-06-28 03:07:10 +00001427 PyObject *new, *type, *doc;
Christian Heimes0449f632007-12-15 01:27:15 +00001428
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001429 type = PyObject_Type(old);
1430 if (type == NULL)
1431 return NULL;
Christian Heimes0449f632007-12-15 01:27:15 +00001432
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001433 if (get == NULL || get == Py_None) {
1434 Py_XDECREF(get);
1435 get = pold->prop_get ? pold->prop_get : Py_None;
1436 }
1437 if (set == NULL || set == Py_None) {
1438 Py_XDECREF(set);
1439 set = pold->prop_set ? pold->prop_set : Py_None;
1440 }
1441 if (del == NULL || del == Py_None) {
1442 Py_XDECREF(del);
1443 del = pold->prop_del ? pold->prop_del : Py_None;
1444 }
Benjamin Peterson93964832010-06-28 03:07:10 +00001445 if (pold->getter_doc && get != Py_None) {
1446 /* make _init use __doc__ from getter */
1447 doc = Py_None;
1448 }
1449 else {
1450 doc = pold->prop_doc ? pold->prop_doc : Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001451 }
R. David Murrayb18500d2009-05-04 22:59:07 +00001452
Victor Stinner5abaa2b2016-12-09 16:22:32 +01001453 new = PyObject_CallFunctionObjArgs(type, get, set, del, doc, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001454 Py_DECREF(type);
1455 if (new == NULL)
1456 return NULL;
1457 return new;
Christian Heimes0449f632007-12-15 01:27:15 +00001458}
1459
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001460static int
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001461property_init(PyObject *self, PyObject *args, PyObject *kwds)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001462{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001463 PyObject *get = NULL, *set = NULL, *del = NULL, *doc = NULL;
1464 static char *kwlist[] = {"fget", "fset", "fdel", "doc", 0};
1465 propertyobject *prop = (propertyobject *)self;
Tim Peters66c1a522001-09-24 21:17:50 +00001466
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001467 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OOOO:property",
1468 kwlist, &get, &set, &del, &doc))
1469 return -1;
Tim Peters66c1a522001-09-24 21:17:50 +00001470
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001471 if (get == Py_None)
1472 get = NULL;
1473 if (set == Py_None)
1474 set = NULL;
1475 if (del == Py_None)
1476 del = NULL;
Tim Peters66c1a522001-09-24 21:17:50 +00001477
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001478 Py_XINCREF(get);
1479 Py_XINCREF(set);
1480 Py_XINCREF(del);
1481 Py_XINCREF(doc);
Christian Heimes0449f632007-12-15 01:27:15 +00001482
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001483 prop->prop_get = get;
1484 prop->prop_set = set;
1485 prop->prop_del = del;
1486 prop->prop_doc = doc;
1487 prop->getter_doc = 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001488
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001489 /* if no docstring given and the getter has one, use that one */
1490 if ((doc == NULL || doc == Py_None) && get != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001491 _Py_IDENTIFIER(__doc__);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02001492 PyObject *get_doc = _PyObject_GetAttrId(get, &PyId___doc__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001493 if (get_doc) {
1494 if (Py_TYPE(self) == &PyProperty_Type) {
Serhiy Storchaka48842712016-04-06 09:45:48 +03001495 Py_XSETREF(prop->prop_doc, get_doc);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001496 }
1497 else {
1498 /* If this is a property subclass, put __doc__
1499 in dict of the subclass instance instead,
1500 otherwise it gets shadowed by __doc__ in the
1501 class's dict. */
Martin v. Löwis1c67dd92011-10-14 15:16:45 +02001502 int err = _PyObject_SetAttrId(self, &PyId___doc__, get_doc);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001503 Py_DECREF(get_doc);
1504 if (err < 0)
1505 return -1;
1506 }
1507 prop->getter_doc = 1;
1508 }
1509 else if (PyErr_ExceptionMatches(PyExc_Exception)) {
1510 PyErr_Clear();
1511 }
1512 else {
1513 return -1;
1514 }
1515 }
1516
1517 return 0;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001518}
1519
Benjamin Petersonbfebb7b2011-12-15 15:34:02 -05001520static PyObject *
1521property_get___isabstractmethod__(propertyobject *prop, void *closure)
1522{
1523 int res = _PyObject_IsAbstract(prop->prop_get);
1524 if (res == -1) {
1525 return NULL;
1526 }
1527 else if (res) {
1528 Py_RETURN_TRUE;
1529 }
1530
1531 res = _PyObject_IsAbstract(prop->prop_set);
1532 if (res == -1) {
1533 return NULL;
1534 }
1535 else if (res) {
1536 Py_RETURN_TRUE;
1537 }
1538
1539 res = _PyObject_IsAbstract(prop->prop_del);
1540 if (res == -1) {
1541 return NULL;
1542 }
1543 else if (res) {
1544 Py_RETURN_TRUE;
1545 }
1546 Py_RETURN_FALSE;
1547}
1548
1549static PyGetSetDef property_getsetlist[] = {
1550 {"__isabstractmethod__",
1551 (getter)property_get___isabstractmethod__, NULL,
1552 NULL,
1553 NULL},
1554 {NULL} /* Sentinel */
1555};
1556
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001557PyDoc_STRVAR(property_doc,
Tim Peters66c1a522001-09-24 21:17:50 +00001558"property(fget=None, fset=None, fdel=None, doc=None) -> property attribute\n"
1559"\n"
1560"fget is a function to be used for getting an attribute value, and likewise\n"
1561"fset is a function for setting, and fdel a function for del'ing, an\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001562"attribute. Typical use is to define a managed attribute x:\n\n"
Guido van Rossum91c0d8a2001-08-24 09:55:51 +00001563"class C(object):\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001564" def getx(self): return self._x\n"
1565" def setx(self, value): self._x = value\n"
1566" def delx(self): del self._x\n"
1567" x = property(getx, setx, delx, \"I'm the 'x' property.\")\n"
1568"\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001569"Decorators make defining new properties or modifying existing ones easy:\n\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001570"class C(object):\n"
1571" @property\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001572" def x(self):\n"
Gregory P. Smith0e524042013-11-25 00:30:56 -08001573" \"I am the 'x' property.\"\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001574" return self._x\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001575" @x.setter\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001576" def x(self, value):\n"
1577" self._x = value\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001578" @x.deleter\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001579" def x(self):\n"
1580" del self._x\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001581);
Guido van Rossum91c0d8a2001-08-24 09:55:51 +00001582
Guido van Rossum048eb752001-10-02 21:24:57 +00001583static int
1584property_traverse(PyObject *self, visitproc visit, void *arg)
1585{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001586 propertyobject *pp = (propertyobject *)self;
1587 Py_VISIT(pp->prop_get);
1588 Py_VISIT(pp->prop_set);
1589 Py_VISIT(pp->prop_del);
1590 Py_VISIT(pp->prop_doc);
1591 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +00001592}
1593
Raymond Hettingerd4be6912015-05-13 11:12:33 -07001594static int
1595property_clear(PyObject *self)
1596{
1597 propertyobject *pp = (propertyobject *)self;
1598 Py_CLEAR(pp->prop_doc);
1599 return 0;
1600}
1601
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001602PyTypeObject PyProperty_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001603 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1604 "property", /* tp_name */
1605 sizeof(propertyobject), /* tp_basicsize */
1606 0, /* tp_itemsize */
1607 /* methods */
1608 property_dealloc, /* tp_dealloc */
1609 0, /* tp_print */
1610 0, /* tp_getattr */
1611 0, /* tp_setattr */
1612 0, /* tp_reserved */
1613 0, /* tp_repr */
1614 0, /* tp_as_number */
1615 0, /* tp_as_sequence */
1616 0, /* tp_as_mapping */
1617 0, /* tp_hash */
1618 0, /* tp_call */
1619 0, /* tp_str */
1620 PyObject_GenericGetAttr, /* tp_getattro */
1621 0, /* tp_setattro */
1622 0, /* tp_as_buffer */
1623 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
1624 Py_TPFLAGS_BASETYPE, /* tp_flags */
1625 property_doc, /* tp_doc */
1626 property_traverse, /* tp_traverse */
Raymond Hettingerd4be6912015-05-13 11:12:33 -07001627 (inquiry)property_clear, /* tp_clear */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001628 0, /* tp_richcompare */
1629 0, /* tp_weaklistoffset */
1630 0, /* tp_iter */
1631 0, /* tp_iternext */
1632 property_methods, /* tp_methods */
1633 property_members, /* tp_members */
Benjamin Petersonbfebb7b2011-12-15 15:34:02 -05001634 property_getsetlist, /* tp_getset */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001635 0, /* tp_base */
1636 0, /* tp_dict */
1637 property_descr_get, /* tp_descr_get */
1638 property_descr_set, /* tp_descr_set */
1639 0, /* tp_dictoffset */
1640 property_init, /* tp_init */
1641 PyType_GenericAlloc, /* tp_alloc */
1642 PyType_GenericNew, /* tp_new */
1643 PyObject_GC_Del, /* tp_free */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001644};