blob: a254a2a673f3750ac605b203d5290400f36286bc [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) {
422 Py_INCREF(Py_None);
423 return Py_None;
424 }
425 return PyUnicode_FromString(descr->d_member->doc);
Guido van Rossum6f799372001-09-20 20:46:19 +0000426}
427
Guido van Rossum32d34c82001-09-20 21:45:26 +0000428static PyGetSetDef member_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000429 {"__doc__", (getter)member_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100430 {"__qualname__", (getter)descr_get_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000431 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000432};
433
434static PyObject *
Guido van Rossum32d34c82001-09-20 21:45:26 +0000435getset_get_doc(PyGetSetDescrObject *descr, void *closure)
436{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000437 if (descr->d_getset->doc == NULL) {
438 Py_INCREF(Py_None);
439 return Py_None;
440 }
441 return PyUnicode_FromString(descr->d_getset->doc);
Guido van Rossum32d34c82001-09-20 21:45:26 +0000442}
443
444static PyGetSetDef getset_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000445 {"__doc__", (getter)getset_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100446 {"__qualname__", (getter)descr_get_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000447 {0}
Guido van Rossum32d34c82001-09-20 21:45:26 +0000448};
449
450static PyObject *
Armin Rigoc6686b72005-11-07 08:38:00 +0000451wrapperdescr_get_doc(PyWrapperDescrObject *descr, void *closure)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000452{
Larry Hastings2623c8c2014-02-08 22:15:29 -0800453 return _PyType_GetDocFromInternalDoc(descr->d_base->name, descr->d_base->doc);
Larry Hastings5c661892014-01-24 06:17:25 -0800454}
455
456static PyObject *
457wrapperdescr_get_text_signature(PyWrapperDescrObject *descr, void *closure)
458{
Larry Hastings2623c8c2014-02-08 22:15:29 -0800459 return _PyType_GetTextSignatureFromInternalDoc(descr->d_base->name, descr->d_base->doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000460}
461
Armin Rigoc6686b72005-11-07 08:38:00 +0000462static PyGetSetDef wrapperdescr_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000463 {"__doc__", (getter)wrapperdescr_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100464 {"__qualname__", (getter)descr_get_qualname},
Larry Hastings5c661892014-01-24 06:17:25 -0800465 {"__text_signature__", (getter)wrapperdescr_get_text_signature},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000466 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000467};
468
Guido van Rossum048eb752001-10-02 21:24:57 +0000469static int
470descr_traverse(PyObject *self, visitproc visit, void *arg)
471{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000472 PyDescrObject *descr = (PyDescrObject *)self;
473 Py_VISIT(descr->d_type);
474 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +0000475}
476
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000477PyTypeObject PyMethodDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000478 PyVarObject_HEAD_INIT(&PyType_Type, 0)
479 "method_descriptor",
480 sizeof(PyMethodDescrObject),
481 0,
482 (destructor)descr_dealloc, /* tp_dealloc */
483 0, /* tp_print */
484 0, /* tp_getattr */
485 0, /* tp_setattr */
486 0, /* tp_reserved */
487 (reprfunc)method_repr, /* tp_repr */
488 0, /* tp_as_number */
489 0, /* tp_as_sequence */
490 0, /* tp_as_mapping */
491 0, /* tp_hash */
492 (ternaryfunc)methoddescr_call, /* tp_call */
493 0, /* tp_str */
494 PyObject_GenericGetAttr, /* tp_getattro */
495 0, /* tp_setattro */
496 0, /* tp_as_buffer */
497 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
498 0, /* tp_doc */
499 descr_traverse, /* tp_traverse */
500 0, /* tp_clear */
501 0, /* tp_richcompare */
502 0, /* tp_weaklistoffset */
503 0, /* tp_iter */
504 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100505 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000506 descr_members, /* tp_members */
507 method_getset, /* tp_getset */
508 0, /* tp_base */
509 0, /* tp_dict */
510 (descrgetfunc)method_get, /* tp_descr_get */
511 0, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000512};
513
Guido van Rossumb6e5a0c2003-02-11 18:44:42 +0000514/* This is for METH_CLASS in C, not for "f = classmethod(f)" in Python! */
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000515PyTypeObject PyClassMethodDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000516 PyVarObject_HEAD_INIT(&PyType_Type, 0)
517 "classmethod_descriptor",
518 sizeof(PyMethodDescrObject),
519 0,
520 (destructor)descr_dealloc, /* tp_dealloc */
521 0, /* tp_print */
522 0, /* tp_getattr */
523 0, /* tp_setattr */
524 0, /* tp_reserved */
525 (reprfunc)method_repr, /* tp_repr */
526 0, /* tp_as_number */
527 0, /* tp_as_sequence */
528 0, /* tp_as_mapping */
529 0, /* tp_hash */
530 (ternaryfunc)classmethoddescr_call, /* tp_call */
531 0, /* tp_str */
532 PyObject_GenericGetAttr, /* tp_getattro */
533 0, /* tp_setattro */
534 0, /* tp_as_buffer */
535 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
536 0, /* tp_doc */
537 descr_traverse, /* tp_traverse */
538 0, /* tp_clear */
539 0, /* tp_richcompare */
540 0, /* tp_weaklistoffset */
541 0, /* tp_iter */
542 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100543 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000544 descr_members, /* tp_members */
545 method_getset, /* tp_getset */
546 0, /* tp_base */
547 0, /* tp_dict */
548 (descrgetfunc)classmethod_get, /* tp_descr_get */
549 0, /* tp_descr_set */
Tim Petersbca1cbc2002-12-09 22:56:13 +0000550};
551
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000552PyTypeObject PyMemberDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000553 PyVarObject_HEAD_INIT(&PyType_Type, 0)
554 "member_descriptor",
555 sizeof(PyMemberDescrObject),
556 0,
557 (destructor)descr_dealloc, /* tp_dealloc */
558 0, /* tp_print */
559 0, /* tp_getattr */
560 0, /* tp_setattr */
561 0, /* tp_reserved */
562 (reprfunc)member_repr, /* tp_repr */
563 0, /* tp_as_number */
564 0, /* tp_as_sequence */
565 0, /* tp_as_mapping */
566 0, /* tp_hash */
567 0, /* tp_call */
568 0, /* tp_str */
569 PyObject_GenericGetAttr, /* tp_getattro */
570 0, /* tp_setattro */
571 0, /* tp_as_buffer */
572 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
573 0, /* tp_doc */
574 descr_traverse, /* tp_traverse */
575 0, /* tp_clear */
576 0, /* tp_richcompare */
577 0, /* tp_weaklistoffset */
578 0, /* tp_iter */
579 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100580 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000581 descr_members, /* tp_members */
582 member_getset, /* tp_getset */
583 0, /* tp_base */
584 0, /* tp_dict */
585 (descrgetfunc)member_get, /* tp_descr_get */
586 (descrsetfunc)member_set, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000587};
588
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000589PyTypeObject PyGetSetDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000590 PyVarObject_HEAD_INIT(&PyType_Type, 0)
591 "getset_descriptor",
592 sizeof(PyGetSetDescrObject),
593 0,
594 (destructor)descr_dealloc, /* tp_dealloc */
595 0, /* tp_print */
596 0, /* tp_getattr */
597 0, /* tp_setattr */
598 0, /* tp_reserved */
599 (reprfunc)getset_repr, /* tp_repr */
600 0, /* tp_as_number */
601 0, /* tp_as_sequence */
602 0, /* tp_as_mapping */
603 0, /* tp_hash */
604 0, /* tp_call */
605 0, /* tp_str */
606 PyObject_GenericGetAttr, /* tp_getattro */
607 0, /* tp_setattro */
608 0, /* tp_as_buffer */
609 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
610 0, /* tp_doc */
611 descr_traverse, /* tp_traverse */
612 0, /* tp_clear */
613 0, /* tp_richcompare */
614 0, /* tp_weaklistoffset */
615 0, /* tp_iter */
616 0, /* tp_iternext */
617 0, /* tp_methods */
618 descr_members, /* tp_members */
619 getset_getset, /* tp_getset */
620 0, /* tp_base */
621 0, /* tp_dict */
622 (descrgetfunc)getset_get, /* tp_descr_get */
623 (descrsetfunc)getset_set, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000624};
625
Guido van Rossumf4593e02001-10-03 12:09:30 +0000626PyTypeObject PyWrapperDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000627 PyVarObject_HEAD_INIT(&PyType_Type, 0)
628 "wrapper_descriptor",
629 sizeof(PyWrapperDescrObject),
630 0,
631 (destructor)descr_dealloc, /* tp_dealloc */
632 0, /* tp_print */
633 0, /* tp_getattr */
634 0, /* tp_setattr */
635 0, /* tp_reserved */
636 (reprfunc)wrapperdescr_repr, /* tp_repr */
637 0, /* tp_as_number */
638 0, /* tp_as_sequence */
639 0, /* tp_as_mapping */
640 0, /* tp_hash */
641 (ternaryfunc)wrapperdescr_call, /* tp_call */
642 0, /* tp_str */
643 PyObject_GenericGetAttr, /* tp_getattro */
644 0, /* tp_setattro */
645 0, /* tp_as_buffer */
646 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
647 0, /* tp_doc */
648 descr_traverse, /* tp_traverse */
649 0, /* tp_clear */
650 0, /* tp_richcompare */
651 0, /* tp_weaklistoffset */
652 0, /* tp_iter */
653 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100654 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000655 descr_members, /* tp_members */
656 wrapperdescr_getset, /* tp_getset */
657 0, /* tp_base */
658 0, /* tp_dict */
659 (descrgetfunc)wrapperdescr_get, /* tp_descr_get */
660 0, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000661};
662
663static PyDescrObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000664descr_new(PyTypeObject *descrtype, PyTypeObject *type, const char *name)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000665{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000666 PyDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000667
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000668 descr = (PyDescrObject *)PyType_GenericAlloc(descrtype, 0);
669 if (descr != NULL) {
670 Py_XINCREF(type);
671 descr->d_type = type;
672 descr->d_name = PyUnicode_InternFromString(name);
673 if (descr->d_name == NULL) {
674 Py_DECREF(descr);
675 descr = NULL;
676 }
Benjamin Petersonf2fe7f02011-12-17 08:02:20 -0500677 else {
678 descr->d_qualname = NULL;
679 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000680 }
681 return descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000682}
683
684PyObject *
685PyDescr_NewMethod(PyTypeObject *type, PyMethodDef *method)
686{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000687 PyMethodDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000688
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000689 descr = (PyMethodDescrObject *)descr_new(&PyMethodDescr_Type,
690 type, method->ml_name);
691 if (descr != NULL)
692 descr->d_method = method;
693 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000694}
695
696PyObject *
Tim Petersbca1cbc2002-12-09 22:56:13 +0000697PyDescr_NewClassMethod(PyTypeObject *type, PyMethodDef *method)
698{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000699 PyMethodDescrObject *descr;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000700
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000701 descr = (PyMethodDescrObject *)descr_new(&PyClassMethodDescr_Type,
702 type, method->ml_name);
703 if (descr != NULL)
704 descr->d_method = method;
705 return (PyObject *)descr;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000706}
707
708PyObject *
Guido van Rossum6f799372001-09-20 20:46:19 +0000709PyDescr_NewMember(PyTypeObject *type, PyMemberDef *member)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000710{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000711 PyMemberDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000712
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000713 descr = (PyMemberDescrObject *)descr_new(&PyMemberDescr_Type,
714 type, member->name);
715 if (descr != NULL)
716 descr->d_member = member;
717 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000718}
719
720PyObject *
Guido van Rossum32d34c82001-09-20 21:45:26 +0000721PyDescr_NewGetSet(PyTypeObject *type, PyGetSetDef *getset)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000722{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000723 PyGetSetDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000724
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000725 descr = (PyGetSetDescrObject *)descr_new(&PyGetSetDescr_Type,
726 type, getset->name);
727 if (descr != NULL)
728 descr->d_getset = getset;
729 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000730}
731
732PyObject *
733PyDescr_NewWrapper(PyTypeObject *type, struct wrapperbase *base, void *wrapped)
734{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000735 PyWrapperDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000736
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000737 descr = (PyWrapperDescrObject *)descr_new(&PyWrapperDescr_Type,
738 type, base->name);
739 if (descr != NULL) {
740 descr->d_base = base;
741 descr->d_wrapped = wrapped;
742 }
743 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000744}
745
Tim Peters6d6c1a32001-08-02 04:15:00 +0000746
Victor Stinner0db176f2012-04-16 00:16:30 +0200747/* --- mappingproxy: read-only proxy for mappings --- */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000748
749/* This has no reason to be in this file except that adding new files is a
750 bit of a pain */
751
752typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000753 PyObject_HEAD
Victor Stinner0db176f2012-04-16 00:16:30 +0200754 PyObject *mapping;
755} mappingproxyobject;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000756
Martin v. Löwis18e16552006-02-15 17:27:45 +0000757static Py_ssize_t
Victor Stinner0db176f2012-04-16 00:16:30 +0200758mappingproxy_len(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000759{
Victor Stinner0db176f2012-04-16 00:16:30 +0200760 return PyObject_Size(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000761}
762
763static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200764mappingproxy_getitem(mappingproxyobject *pp, PyObject *key)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000765{
Victor Stinner0db176f2012-04-16 00:16:30 +0200766 return PyObject_GetItem(pp->mapping, key);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000767}
768
Victor Stinner0db176f2012-04-16 00:16:30 +0200769static PyMappingMethods mappingproxy_as_mapping = {
770 (lenfunc)mappingproxy_len, /* mp_length */
771 (binaryfunc)mappingproxy_getitem, /* mp_subscript */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000772 0, /* mp_ass_subscript */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000773};
774
775static int
Victor Stinner0db176f2012-04-16 00:16:30 +0200776mappingproxy_contains(mappingproxyobject *pp, PyObject *key)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000777{
Victor Stinner0db176f2012-04-16 00:16:30 +0200778 if (PyDict_CheckExact(pp->mapping))
779 return PyDict_Contains(pp->mapping, key);
780 else
781 return PySequence_Contains(pp->mapping, key);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000782}
783
Victor Stinner0db176f2012-04-16 00:16:30 +0200784static PySequenceMethods mappingproxy_as_sequence = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000785 0, /* sq_length */
786 0, /* sq_concat */
787 0, /* sq_repeat */
788 0, /* sq_item */
789 0, /* sq_slice */
790 0, /* sq_ass_item */
791 0, /* sq_ass_slice */
Victor Stinner0db176f2012-04-16 00:16:30 +0200792 (objobjproc)mappingproxy_contains, /* sq_contains */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000793 0, /* sq_inplace_concat */
794 0, /* sq_inplace_repeat */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000795};
796
797static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200798mappingproxy_get(mappingproxyobject *pp, PyObject *args)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000799{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000800 PyObject *key, *def = Py_None;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200801 _Py_IDENTIFIER(get);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000802
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000803 if (!PyArg_UnpackTuple(args, "get", 1, 2, &key, &def))
804 return NULL;
Victor Stinner7e425412016-12-09 00:36:19 +0100805 return _PyObject_CallMethodIdObjArgs(pp->mapping, &PyId_get,
806 key, def, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000807}
808
809static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200810mappingproxy_keys(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000811{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200812 _Py_IDENTIFIER(keys);
Victor Stinner0db176f2012-04-16 00:16:30 +0200813 return _PyObject_CallMethodId(pp->mapping, &PyId_keys, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000814}
815
816static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200817mappingproxy_values(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000818{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200819 _Py_IDENTIFIER(values);
Victor Stinner0db176f2012-04-16 00:16:30 +0200820 return _PyObject_CallMethodId(pp->mapping, &PyId_values, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000821}
822
823static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200824mappingproxy_items(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000825{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200826 _Py_IDENTIFIER(items);
Victor Stinner0db176f2012-04-16 00:16:30 +0200827 return _PyObject_CallMethodId(pp->mapping, &PyId_items, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000828}
829
830static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200831mappingproxy_copy(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000832{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200833 _Py_IDENTIFIER(copy);
Victor Stinner0db176f2012-04-16 00:16:30 +0200834 return _PyObject_CallMethodId(pp->mapping, &PyId_copy, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000835}
836
Victor Stinner0db176f2012-04-16 00:16:30 +0200837/* WARNING: mappingproxy methods must not give access
838 to the underlying mapping */
839
840static PyMethodDef mappingproxy_methods[] = {
841 {"get", (PyCFunction)mappingproxy_get, METH_VARARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000842 PyDoc_STR("D.get(k[,d]) -> D[k] if k in D, else d."
Victor Stinner0db176f2012-04-16 00:16:30 +0200843 " d defaults to None.")},
844 {"keys", (PyCFunction)mappingproxy_keys, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000845 PyDoc_STR("D.keys() -> list of D's keys")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200846 {"values", (PyCFunction)mappingproxy_values, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000847 PyDoc_STR("D.values() -> list of D's values")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200848 {"items", (PyCFunction)mappingproxy_items, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000849 PyDoc_STR("D.items() -> list of D's (key, value) pairs, as 2-tuples")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200850 {"copy", (PyCFunction)mappingproxy_copy, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000851 PyDoc_STR("D.copy() -> a shallow copy of D")},
852 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000853};
854
855static void
Victor Stinner0db176f2012-04-16 00:16:30 +0200856mappingproxy_dealloc(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000857{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000858 _PyObject_GC_UNTRACK(pp);
Victor Stinner0db176f2012-04-16 00:16:30 +0200859 Py_DECREF(pp->mapping);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000860 PyObject_GC_Del(pp);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000861}
862
863static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200864mappingproxy_getiter(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000865{
Victor Stinner0db176f2012-04-16 00:16:30 +0200866 return PyObject_GetIter(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000867}
868
Neil Schemenauer26775122001-10-21 22:26:43 +0000869static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200870mappingproxy_str(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000871{
Victor Stinner0db176f2012-04-16 00:16:30 +0200872 return PyObject_Str(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000873}
874
Ezio Melottiac53ab62010-12-18 14:59:43 +0000875static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200876mappingproxy_repr(mappingproxyobject *pp)
Ezio Melottiac53ab62010-12-18 14:59:43 +0000877{
Victor Stinner0db176f2012-04-16 00:16:30 +0200878 return PyUnicode_FromFormat("mappingproxy(%R)", pp->mapping);
Ezio Melottiac53ab62010-12-18 14:59:43 +0000879}
880
Guido van Rossum048eb752001-10-02 21:24:57 +0000881static int
Victor Stinner0db176f2012-04-16 00:16:30 +0200882mappingproxy_traverse(PyObject *self, visitproc visit, void *arg)
Guido van Rossum048eb752001-10-02 21:24:57 +0000883{
Victor Stinner0db176f2012-04-16 00:16:30 +0200884 mappingproxyobject *pp = (mappingproxyobject *)self;
885 Py_VISIT(pp->mapping);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000886 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +0000887}
888
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000889static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200890mappingproxy_richcompare(mappingproxyobject *v, PyObject *w, int op)
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000891{
Victor Stinner0db176f2012-04-16 00:16:30 +0200892 return PyObject_RichCompare(v->mapping, w, op);
893}
894
895static int
896mappingproxy_check_mapping(PyObject *mapping)
897{
898 if (!PyMapping_Check(mapping)
899 || PyList_Check(mapping)
900 || PyTuple_Check(mapping)) {
901 PyErr_Format(PyExc_TypeError,
902 "mappingproxy() argument must be a mapping, not %s",
903 Py_TYPE(mapping)->tp_name);
904 return -1;
905 }
906 return 0;
907}
908
909static PyObject*
910mappingproxy_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
911{
912 static char *kwlist[] = {"mapping", NULL};
913 PyObject *mapping;
914 mappingproxyobject *mappingproxy;
915
916 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O:mappingproxy",
917 kwlist, &mapping))
918 return NULL;
919
920 if (mappingproxy_check_mapping(mapping) == -1)
921 return NULL;
922
923 mappingproxy = PyObject_GC_New(mappingproxyobject, &PyDictProxy_Type);
924 if (mappingproxy == NULL)
925 return NULL;
926 Py_INCREF(mapping);
927 mappingproxy->mapping = mapping;
928 _PyObject_GC_TRACK(mappingproxy);
929 return (PyObject *)mappingproxy;
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000930}
931
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000932PyTypeObject PyDictProxy_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000933 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Victor Stinner0db176f2012-04-16 00:16:30 +0200934 "mappingproxy", /* tp_name */
935 sizeof(mappingproxyobject), /* tp_basicsize */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000936 0, /* tp_itemsize */
937 /* methods */
Victor Stinner0db176f2012-04-16 00:16:30 +0200938 (destructor)mappingproxy_dealloc, /* tp_dealloc */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000939 0, /* tp_print */
940 0, /* tp_getattr */
941 0, /* tp_setattr */
942 0, /* tp_reserved */
Victor Stinner0db176f2012-04-16 00:16:30 +0200943 (reprfunc)mappingproxy_repr, /* tp_repr */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000944 0, /* tp_as_number */
Victor Stinner0db176f2012-04-16 00:16:30 +0200945 &mappingproxy_as_sequence, /* tp_as_sequence */
946 &mappingproxy_as_mapping, /* tp_as_mapping */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000947 0, /* tp_hash */
948 0, /* tp_call */
Victor Stinner0db176f2012-04-16 00:16:30 +0200949 (reprfunc)mappingproxy_str, /* tp_str */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000950 PyObject_GenericGetAttr, /* tp_getattro */
951 0, /* tp_setattro */
952 0, /* tp_as_buffer */
953 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
954 0, /* tp_doc */
Victor Stinner0db176f2012-04-16 00:16:30 +0200955 mappingproxy_traverse, /* tp_traverse */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000956 0, /* tp_clear */
Victor Stinner0db176f2012-04-16 00:16:30 +0200957 (richcmpfunc)mappingproxy_richcompare, /* tp_richcompare */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 0, /* tp_weaklistoffset */
Victor Stinner0db176f2012-04-16 00:16:30 +0200959 (getiterfunc)mappingproxy_getiter, /* tp_iter */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000960 0, /* tp_iternext */
Victor Stinner0db176f2012-04-16 00:16:30 +0200961 mappingproxy_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000962 0, /* tp_members */
963 0, /* tp_getset */
964 0, /* tp_base */
965 0, /* tp_dict */
966 0, /* tp_descr_get */
967 0, /* tp_descr_set */
Victor Stinner0db176f2012-04-16 00:16:30 +0200968 0, /* tp_dictoffset */
969 0, /* tp_init */
970 0, /* tp_alloc */
971 mappingproxy_new, /* tp_new */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000972};
973
974PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200975PyDictProxy_New(PyObject *mapping)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000976{
Victor Stinner0db176f2012-04-16 00:16:30 +0200977 mappingproxyobject *pp;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000978
Victor Stinner0db176f2012-04-16 00:16:30 +0200979 if (mappingproxy_check_mapping(mapping) == -1)
980 return NULL;
981
982 pp = PyObject_GC_New(mappingproxyobject, &PyDictProxy_Type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000983 if (pp != NULL) {
Victor Stinner0db176f2012-04-16 00:16:30 +0200984 Py_INCREF(mapping);
985 pp->mapping = mapping;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000986 _PyObject_GC_TRACK(pp);
987 }
988 return (PyObject *)pp;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000989}
990
991
992/* --- Wrapper object for "slot" methods --- */
993
994/* This has no reason to be in this file except that adding new files is a
995 bit of a pain */
996
997typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000998 PyObject_HEAD
999 PyWrapperDescrObject *descr;
1000 PyObject *self;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001001} wrapperobject;
1002
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001003#define Wrapper_Check(v) (Py_TYPE(v) == &_PyMethodWrapper_Type)
Mark Dickinson211c6252009-02-01 10:28:51 +00001004
Tim Peters6d6c1a32001-08-02 04:15:00 +00001005static void
1006wrapper_dealloc(wrapperobject *wp)
1007{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001008 PyObject_GC_UnTrack(wp);
1009 Py_TRASHCAN_SAFE_BEGIN(wp)
1010 Py_XDECREF(wp->descr);
1011 Py_XDECREF(wp->self);
1012 PyObject_GC_Del(wp);
1013 Py_TRASHCAN_SAFE_END(wp)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001014}
1015
Mark Dickinson211c6252009-02-01 10:28:51 +00001016#define TEST_COND(cond) ((cond) ? Py_True : Py_False)
1017
1018static PyObject *
1019wrapper_richcompare(PyObject *a, PyObject *b, int op)
Armin Rigoc6686b72005-11-07 08:38:00 +00001020{
Benjamin Petersonca470632016-09-06 13:47:26 -07001021 intptr_t result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001022 PyObject *v;
1023 PyWrapperDescrObject *a_descr, *b_descr;
Mark Dickinson211c6252009-02-01 10:28:51 +00001024
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001025 assert(a != NULL && b != NULL);
Mark Dickinson211c6252009-02-01 10:28:51 +00001026
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001027 /* both arguments should be wrapperobjects */
1028 if (!Wrapper_Check(a) || !Wrapper_Check(b)) {
1029 v = Py_NotImplemented;
1030 Py_INCREF(v);
1031 return v;
1032 }
Mark Dickinson211c6252009-02-01 10:28:51 +00001033
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001034 /* compare by descriptor address; if the descriptors are the same,
1035 compare by the objects they're bound to */
1036 a_descr = ((wrapperobject *)a)->descr;
1037 b_descr = ((wrapperobject *)b)->descr;
1038 if (a_descr == b_descr) {
1039 a = ((wrapperobject *)a)->self;
1040 b = ((wrapperobject *)b)->self;
1041 return PyObject_RichCompare(a, b, op);
1042 }
Mark Dickinson211c6252009-02-01 10:28:51 +00001043
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001044 result = a_descr - b_descr;
1045 switch (op) {
1046 case Py_EQ:
1047 v = TEST_COND(result == 0);
1048 break;
1049 case Py_NE:
1050 v = TEST_COND(result != 0);
1051 break;
1052 case Py_LE:
1053 v = TEST_COND(result <= 0);
1054 break;
1055 case Py_GE:
1056 v = TEST_COND(result >= 0);
1057 break;
1058 case Py_LT:
1059 v = TEST_COND(result < 0);
1060 break;
1061 case Py_GT:
1062 v = TEST_COND(result > 0);
1063 break;
1064 default:
1065 PyErr_BadArgument();
1066 return NULL;
1067 }
1068 Py_INCREF(v);
1069 return v;
Armin Rigoc6686b72005-11-07 08:38:00 +00001070}
1071
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001072static Py_hash_t
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001073wrapper_hash(wrapperobject *wp)
1074{
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001075 Py_hash_t x, y;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001076 x = _Py_HashPointer(wp->descr);
1077 if (x == -1)
1078 return -1;
1079 y = PyObject_Hash(wp->self);
1080 if (y == -1)
1081 return -1;
1082 x = x ^ y;
1083 if (x == -1)
1084 x = -2;
1085 return x;
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001086}
1087
Armin Rigoc6686b72005-11-07 08:38:00 +00001088static PyObject *
1089wrapper_repr(wrapperobject *wp)
1090{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001091 return PyUnicode_FromFormat("<method-wrapper '%s' of %s object at %p>",
1092 wp->descr->d_base->name,
1093 wp->self->ob_type->tp_name,
1094 wp->self);
Armin Rigoc6686b72005-11-07 08:38:00 +00001095}
1096
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001097static PyObject *
1098wrapper_reduce(wrapperobject *wp)
1099{
1100 PyObject *builtins;
1101 PyObject *getattr;
1102 _Py_IDENTIFIER(getattr);
1103
1104 builtins = PyEval_GetBuiltins();
1105 getattr = _PyDict_GetItemId(builtins, &PyId_getattr);
1106 return Py_BuildValue("O(OO)", getattr, wp->self, PyDescr_NAME(wp->descr));
1107}
1108
1109static PyMethodDef wrapper_methods[] = {
1110 {"__reduce__", (PyCFunction)wrapper_reduce, METH_NOARGS, NULL},
1111 {NULL, NULL}
1112};
1113
Armin Rigoc6686b72005-11-07 08:38:00 +00001114static PyMemberDef wrapper_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001115 {"__self__", T_OBJECT, offsetof(wrapperobject, self), READONLY},
1116 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001117};
1118
1119static PyObject *
Armin Rigoc6686b72005-11-07 08:38:00 +00001120wrapper_objclass(wrapperobject *wp)
1121{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001122 PyObject *c = (PyObject *)PyDescr_TYPE(wp->descr);
Armin Rigoc6686b72005-11-07 08:38:00 +00001123
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001124 Py_INCREF(c);
1125 return c;
Armin Rigoc6686b72005-11-07 08:38:00 +00001126}
1127
1128static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001129wrapper_name(wrapperobject *wp)
1130{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001131 const char *s = wp->descr->d_base->name;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001132
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001133 return PyUnicode_FromString(s);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001134}
1135
1136static PyObject *
Larry Hastings5c661892014-01-24 06:17:25 -08001137wrapper_doc(wrapperobject *wp, void *closure)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001138{
Larry Hastings2623c8c2014-02-08 22:15:29 -08001139 return _PyType_GetDocFromInternalDoc(wp->descr->d_base->name, wp->descr->d_base->doc);
Larry Hastings5c661892014-01-24 06:17:25 -08001140}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001141
Larry Hastings5c661892014-01-24 06:17:25 -08001142static PyObject *
1143wrapper_text_signature(wrapperobject *wp, void *closure)
1144{
Larry Hastings2623c8c2014-02-08 22:15:29 -08001145 return _PyType_GetTextSignatureFromInternalDoc(wp->descr->d_base->name, wp->descr->d_base->doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001146}
1147
Antoine Pitrou9d574812011-12-12 13:47:25 +01001148static PyObject *
1149wrapper_qualname(wrapperobject *wp)
1150{
1151 return descr_get_qualname((PyDescrObject *)wp->descr);
1152}
1153
Guido van Rossum32d34c82001-09-20 21:45:26 +00001154static PyGetSetDef wrapper_getsets[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001155 {"__objclass__", (getter)wrapper_objclass},
1156 {"__name__", (getter)wrapper_name},
Antoine Pitrou9d574812011-12-12 13:47:25 +01001157 {"__qualname__", (getter)wrapper_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001158 {"__doc__", (getter)wrapper_doc},
Larry Hastings5c661892014-01-24 06:17:25 -08001159 {"__text_signature__", (getter)wrapper_text_signature},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001160 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001161};
1162
1163static PyObject *
1164wrapper_call(wrapperobject *wp, PyObject *args, PyObject *kwds)
1165{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001166 wrapperfunc wrapper = wp->descr->d_base->wrapper;
1167 PyObject *self = wp->self;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001168
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001169 if (wp->descr->d_base->flags & PyWrapperFlag_KEYWORDS) {
1170 wrapperfunc_kwds wk = (wrapperfunc_kwds)wrapper;
1171 return (*wk)(self, args, wp->descr->d_wrapped, kwds);
1172 }
Guido van Rossumc8e56452001-10-22 00:43:43 +00001173
Serhiy Storchaka5ab81d72016-12-16 16:18:57 +02001174 if (kwds != NULL && (!PyDict_Check(kwds) || PyDict_GET_SIZE(kwds) != 0)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001175 PyErr_Format(PyExc_TypeError,
1176 "wrapper %s doesn't take keyword arguments",
1177 wp->descr->d_base->name);
1178 return NULL;
1179 }
1180 return (*wrapper)(self, args, wp->descr->d_wrapped);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001181}
1182
Guido van Rossum048eb752001-10-02 21:24:57 +00001183static int
1184wrapper_traverse(PyObject *self, visitproc visit, void *arg)
1185{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001186 wrapperobject *wp = (wrapperobject *)self;
1187 Py_VISIT(wp->descr);
1188 Py_VISIT(wp->self);
1189 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +00001190}
1191
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001192PyTypeObject _PyMethodWrapper_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001193 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1194 "method-wrapper", /* tp_name */
1195 sizeof(wrapperobject), /* tp_basicsize */
1196 0, /* tp_itemsize */
1197 /* methods */
1198 (destructor)wrapper_dealloc, /* tp_dealloc */
1199 0, /* tp_print */
1200 0, /* tp_getattr */
1201 0, /* tp_setattr */
1202 0, /* tp_reserved */
1203 (reprfunc)wrapper_repr, /* tp_repr */
1204 0, /* tp_as_number */
1205 0, /* tp_as_sequence */
1206 0, /* tp_as_mapping */
1207 (hashfunc)wrapper_hash, /* tp_hash */
1208 (ternaryfunc)wrapper_call, /* tp_call */
1209 0, /* tp_str */
1210 PyObject_GenericGetAttr, /* tp_getattro */
1211 0, /* tp_setattro */
1212 0, /* tp_as_buffer */
1213 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
1214 0, /* tp_doc */
1215 wrapper_traverse, /* tp_traverse */
1216 0, /* tp_clear */
1217 wrapper_richcompare, /* tp_richcompare */
1218 0, /* tp_weaklistoffset */
1219 0, /* tp_iter */
1220 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001221 wrapper_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001222 wrapper_members, /* tp_members */
1223 wrapper_getsets, /* tp_getset */
1224 0, /* tp_base */
1225 0, /* tp_dict */
1226 0, /* tp_descr_get */
1227 0, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001228};
1229
1230PyObject *
1231PyWrapper_New(PyObject *d, PyObject *self)
1232{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001233 wrapperobject *wp;
1234 PyWrapperDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001235
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001236 assert(PyObject_TypeCheck(d, &PyWrapperDescr_Type));
1237 descr = (PyWrapperDescrObject *)d;
Victor Stinner3249dec2011-05-01 23:19:15 +02001238 assert(_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self),
Victor Stinnerd9561312011-05-01 23:31:36 +02001239 (PyObject *)PyDescr_TYPE(descr)));
Tim Peters6d6c1a32001-08-02 04:15:00 +00001240
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001241 wp = PyObject_GC_New(wrapperobject, &_PyMethodWrapper_Type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001242 if (wp != NULL) {
1243 Py_INCREF(descr);
1244 wp->descr = descr;
1245 Py_INCREF(self);
1246 wp->self = self;
1247 _PyObject_GC_TRACK(wp);
1248 }
1249 return (PyObject *)wp;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001250}
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001251
1252
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001253/* A built-in 'property' type */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001254
1255/*
Serhiy Storchakad741a882015-06-11 00:06:39 +03001256class property(object):
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001257
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001258 def __init__(self, fget=None, fset=None, fdel=None, doc=None):
1259 if doc is None and fget is not None and hasattr(fget, "__doc__"):
Serhiy Storchakad741a882015-06-11 00:06:39 +03001260 doc = fget.__doc__
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001261 self.__get = fget
1262 self.__set = fset
1263 self.__del = fdel
1264 self.__doc__ = doc
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001265
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001266 def __get__(self, inst, type=None):
1267 if inst is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001268 return self
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001269 if self.__get is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001270 raise AttributeError, "unreadable attribute"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001271 return self.__get(inst)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001272
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001273 def __set__(self, inst, value):
1274 if self.__set is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001275 raise AttributeError, "can't set attribute"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001276 return self.__set(inst, value)
Guido van Rossumba2485f2001-12-10 18:03:34 +00001277
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001278 def __delete__(self, inst):
1279 if self.__del is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001280 raise AttributeError, "can't delete attribute"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001281 return self.__del(inst)
Guido van Rossumba2485f2001-12-10 18:03:34 +00001282
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001283*/
1284
1285typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001286 PyObject_HEAD
1287 PyObject *prop_get;
1288 PyObject *prop_set;
1289 PyObject *prop_del;
1290 PyObject *prop_doc;
1291 int getter_doc;
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001292} propertyobject;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001293
Christian Heimes0449f632007-12-15 01:27:15 +00001294static PyObject * property_copy(PyObject *, PyObject *, PyObject *,
Benjamin Peterson93964832010-06-28 03:07:10 +00001295 PyObject *);
Christian Heimes0449f632007-12-15 01:27:15 +00001296
Tim Peters66c1a522001-09-24 21:17:50 +00001297static PyMemberDef property_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001298 {"fget", T_OBJECT, offsetof(propertyobject, prop_get), READONLY},
1299 {"fset", T_OBJECT, offsetof(propertyobject, prop_set), READONLY},
1300 {"fdel", T_OBJECT, offsetof(propertyobject, prop_del), READONLY},
Raymond Hettingereac503a2015-05-13 01:09:59 -07001301 {"__doc__", T_OBJECT, offsetof(propertyobject, prop_doc), 0},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001302 {0}
Tim Peters66c1a522001-09-24 21:17:50 +00001303};
1304
Christian Heimes0449f632007-12-15 01:27:15 +00001305
Guido van Rossum58da9312007-11-10 23:39:45 +00001306PyDoc_STRVAR(getter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001307 "Descriptor to change the getter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001308
Neal Norwitz32dde222008-04-15 06:43:13 +00001309static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001310property_getter(PyObject *self, PyObject *getter)
1311{
Benjamin Peterson93964832010-06-28 03:07:10 +00001312 return property_copy(self, getter, NULL, NULL);
Guido van Rossum58da9312007-11-10 23:39:45 +00001313}
1314
Christian Heimes0449f632007-12-15 01:27:15 +00001315
Guido van Rossum58da9312007-11-10 23:39:45 +00001316PyDoc_STRVAR(setter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001317 "Descriptor to change the setter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001318
Neal Norwitz32dde222008-04-15 06:43:13 +00001319static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001320property_setter(PyObject *self, PyObject *setter)
1321{
Benjamin Peterson93964832010-06-28 03:07:10 +00001322 return property_copy(self, NULL, setter, NULL);
Guido van Rossum58da9312007-11-10 23:39:45 +00001323}
1324
Christian Heimes0449f632007-12-15 01:27:15 +00001325
Guido van Rossum58da9312007-11-10 23:39:45 +00001326PyDoc_STRVAR(deleter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001327 "Descriptor to change the deleter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001328
Neal Norwitz32dde222008-04-15 06:43:13 +00001329static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001330property_deleter(PyObject *self, PyObject *deleter)
1331{
Benjamin Peterson93964832010-06-28 03:07:10 +00001332 return property_copy(self, NULL, NULL, deleter);
Guido van Rossum58da9312007-11-10 23:39:45 +00001333}
1334
1335
Guido van Rossum58da9312007-11-10 23:39:45 +00001336static PyMethodDef property_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001337 {"getter", property_getter, METH_O, getter_doc},
1338 {"setter", property_setter, METH_O, setter_doc},
1339 {"deleter", property_deleter, METH_O, deleter_doc},
1340 {0}
Guido van Rossum58da9312007-11-10 23:39:45 +00001341};
1342
Tim Peters66c1a522001-09-24 21:17:50 +00001343
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001344static void
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001345property_dealloc(PyObject *self)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001346{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001347 propertyobject *gs = (propertyobject *)self;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001348
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001349 _PyObject_GC_UNTRACK(self);
1350 Py_XDECREF(gs->prop_get);
1351 Py_XDECREF(gs->prop_set);
1352 Py_XDECREF(gs->prop_del);
1353 Py_XDECREF(gs->prop_doc);
1354 self->ob_type->tp_free(self);
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001355}
1356
1357static PyObject *
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001358property_descr_get(PyObject *self, PyObject *obj, PyObject *type)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001359{
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001360 static PyObject * volatile cached_args = NULL;
1361 PyObject *args;
Raymond Hettingerc4e335b2015-04-30 08:08:13 -07001362 PyObject *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001363 propertyobject *gs = (propertyobject *)self;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001364
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001365 if (obj == NULL || obj == Py_None) {
1366 Py_INCREF(self);
1367 return self;
1368 }
1369 if (gs->prop_get == NULL) {
1370 PyErr_SetString(PyExc_AttributeError, "unreadable attribute");
1371 return NULL;
1372 }
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001373 args = cached_args;
Serhiy Storchaka7822f152016-05-04 21:42:05 +03001374 cached_args = NULL;
1375 if (!args) {
1376 args = PyTuple_New(1);
1377 if (!args)
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001378 return NULL;
Serhiy Storchaka7822f152016-05-04 21:42:05 +03001379 _PyObject_GC_UNTRACK(args);
Raymond Hettingerc4e335b2015-04-30 08:08:13 -07001380 }
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001381 Py_INCREF(obj);
Raymond Hettingerc4e335b2015-04-30 08:08:13 -07001382 PyTuple_SET_ITEM(args, 0, obj);
1383 ret = PyObject_Call(gs->prop_get, args, NULL);
Serhiy Storchaka7822f152016-05-04 21:42:05 +03001384 if (cached_args == NULL && Py_REFCNT(args) == 1) {
1385 assert(Py_SIZE(args) == 1);
1386 assert(PyTuple_GET_ITEM(args, 0) == obj);
1387 cached_args = args;
1388 Py_DECREF(obj);
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001389 }
Serhiy Storchaka7822f152016-05-04 21:42:05 +03001390 else {
1391 assert(Py_REFCNT(args) >= 1);
1392 _PyObject_GC_TRACK(args);
1393 Py_DECREF(args);
1394 }
Raymond Hettingerc4e335b2015-04-30 08:08:13 -07001395 return ret;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001396}
1397
1398static int
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001399property_descr_set(PyObject *self, PyObject *obj, PyObject *value)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001400{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001401 propertyobject *gs = (propertyobject *)self;
1402 PyObject *func, *res;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001403
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001404 if (value == NULL)
1405 func = gs->prop_del;
1406 else
1407 func = gs->prop_set;
1408 if (func == NULL) {
1409 PyErr_SetString(PyExc_AttributeError,
1410 value == NULL ?
1411 "can't delete attribute" :
1412 "can't set attribute");
1413 return -1;
1414 }
1415 if (value == NULL)
Victor Stinnerde4ae3d2016-12-04 22:59:09 +01001416 res = PyObject_CallFunctionObjArgs(func, obj, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001417 else
Benjamin Peterson9b955de2010-12-07 04:04:02 +00001418 res = PyObject_CallFunctionObjArgs(func, obj, value, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001419 if (res == NULL)
1420 return -1;
1421 Py_DECREF(res);
1422 return 0;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001423}
1424
Christian Heimes0449f632007-12-15 01:27:15 +00001425static PyObject *
Benjamin Peterson93964832010-06-28 03:07:10 +00001426property_copy(PyObject *old, PyObject *get, PyObject *set, PyObject *del)
Christian Heimes0449f632007-12-15 01:27:15 +00001427{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001428 propertyobject *pold = (propertyobject *)old;
Benjamin Peterson93964832010-06-28 03:07:10 +00001429 PyObject *new, *type, *doc;
Christian Heimes0449f632007-12-15 01:27:15 +00001430
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001431 type = PyObject_Type(old);
1432 if (type == NULL)
1433 return NULL;
Christian Heimes0449f632007-12-15 01:27:15 +00001434
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001435 if (get == NULL || get == Py_None) {
1436 Py_XDECREF(get);
1437 get = pold->prop_get ? pold->prop_get : Py_None;
1438 }
1439 if (set == NULL || set == Py_None) {
1440 Py_XDECREF(set);
1441 set = pold->prop_set ? pold->prop_set : Py_None;
1442 }
1443 if (del == NULL || del == Py_None) {
1444 Py_XDECREF(del);
1445 del = pold->prop_del ? pold->prop_del : Py_None;
1446 }
Benjamin Peterson93964832010-06-28 03:07:10 +00001447 if (pold->getter_doc && get != Py_None) {
1448 /* make _init use __doc__ from getter */
1449 doc = Py_None;
1450 }
1451 else {
1452 doc = pold->prop_doc ? pold->prop_doc : Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001453 }
R. David Murrayb18500d2009-05-04 22:59:07 +00001454
Victor Stinner5abaa2b2016-12-09 16:22:32 +01001455 new = PyObject_CallFunctionObjArgs(type, get, set, del, doc, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001456 Py_DECREF(type);
1457 if (new == NULL)
1458 return NULL;
1459 return new;
Christian Heimes0449f632007-12-15 01:27:15 +00001460}
1461
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001462static int
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001463property_init(PyObject *self, PyObject *args, PyObject *kwds)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001464{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001465 PyObject *get = NULL, *set = NULL, *del = NULL, *doc = NULL;
1466 static char *kwlist[] = {"fget", "fset", "fdel", "doc", 0};
1467 propertyobject *prop = (propertyobject *)self;
Tim Peters66c1a522001-09-24 21:17:50 +00001468
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001469 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OOOO:property",
1470 kwlist, &get, &set, &del, &doc))
1471 return -1;
Tim Peters66c1a522001-09-24 21:17:50 +00001472
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001473 if (get == Py_None)
1474 get = NULL;
1475 if (set == Py_None)
1476 set = NULL;
1477 if (del == Py_None)
1478 del = NULL;
Tim Peters66c1a522001-09-24 21:17:50 +00001479
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001480 Py_XINCREF(get);
1481 Py_XINCREF(set);
1482 Py_XINCREF(del);
1483 Py_XINCREF(doc);
Christian Heimes0449f632007-12-15 01:27:15 +00001484
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001485 prop->prop_get = get;
1486 prop->prop_set = set;
1487 prop->prop_del = del;
1488 prop->prop_doc = doc;
1489 prop->getter_doc = 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001490
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001491 /* if no docstring given and the getter has one, use that one */
1492 if ((doc == NULL || doc == Py_None) && get != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001493 _Py_IDENTIFIER(__doc__);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02001494 PyObject *get_doc = _PyObject_GetAttrId(get, &PyId___doc__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001495 if (get_doc) {
1496 if (Py_TYPE(self) == &PyProperty_Type) {
Serhiy Storchaka48842712016-04-06 09:45:48 +03001497 Py_XSETREF(prop->prop_doc, get_doc);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001498 }
1499 else {
1500 /* If this is a property subclass, put __doc__
1501 in dict of the subclass instance instead,
1502 otherwise it gets shadowed by __doc__ in the
1503 class's dict. */
Martin v. Löwis1c67dd92011-10-14 15:16:45 +02001504 int err = _PyObject_SetAttrId(self, &PyId___doc__, get_doc);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001505 Py_DECREF(get_doc);
1506 if (err < 0)
1507 return -1;
1508 }
1509 prop->getter_doc = 1;
1510 }
1511 else if (PyErr_ExceptionMatches(PyExc_Exception)) {
1512 PyErr_Clear();
1513 }
1514 else {
1515 return -1;
1516 }
1517 }
1518
1519 return 0;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001520}
1521
Benjamin Petersonbfebb7b2011-12-15 15:34:02 -05001522static PyObject *
1523property_get___isabstractmethod__(propertyobject *prop, void *closure)
1524{
1525 int res = _PyObject_IsAbstract(prop->prop_get);
1526 if (res == -1) {
1527 return NULL;
1528 }
1529 else if (res) {
1530 Py_RETURN_TRUE;
1531 }
1532
1533 res = _PyObject_IsAbstract(prop->prop_set);
1534 if (res == -1) {
1535 return NULL;
1536 }
1537 else if (res) {
1538 Py_RETURN_TRUE;
1539 }
1540
1541 res = _PyObject_IsAbstract(prop->prop_del);
1542 if (res == -1) {
1543 return NULL;
1544 }
1545 else if (res) {
1546 Py_RETURN_TRUE;
1547 }
1548 Py_RETURN_FALSE;
1549}
1550
1551static PyGetSetDef property_getsetlist[] = {
1552 {"__isabstractmethod__",
1553 (getter)property_get___isabstractmethod__, NULL,
1554 NULL,
1555 NULL},
1556 {NULL} /* Sentinel */
1557};
1558
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001559PyDoc_STRVAR(property_doc,
Tim Peters66c1a522001-09-24 21:17:50 +00001560"property(fget=None, fset=None, fdel=None, doc=None) -> property attribute\n"
1561"\n"
1562"fget is a function to be used for getting an attribute value, and likewise\n"
1563"fset is a function for setting, and fdel a function for del'ing, an\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001564"attribute. Typical use is to define a managed attribute x:\n\n"
Guido van Rossum91c0d8a2001-08-24 09:55:51 +00001565"class C(object):\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001566" def getx(self): return self._x\n"
1567" def setx(self, value): self._x = value\n"
1568" def delx(self): del self._x\n"
1569" x = property(getx, setx, delx, \"I'm the 'x' property.\")\n"
1570"\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001571"Decorators make defining new properties or modifying existing ones easy:\n\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001572"class C(object):\n"
1573" @property\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001574" def x(self):\n"
Gregory P. Smith0e524042013-11-25 00:30:56 -08001575" \"I am the 'x' property.\"\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001576" return self._x\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001577" @x.setter\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001578" def x(self, value):\n"
1579" self._x = value\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001580" @x.deleter\n"
Raymond Hettinger97fc2ba2013-11-24 14:53:29 -08001581" def x(self):\n"
1582" del self._x\n"
Christian Heimes96f31632007-11-12 01:32:03 +00001583);
Guido van Rossum91c0d8a2001-08-24 09:55:51 +00001584
Guido van Rossum048eb752001-10-02 21:24:57 +00001585static int
1586property_traverse(PyObject *self, visitproc visit, void *arg)
1587{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001588 propertyobject *pp = (propertyobject *)self;
1589 Py_VISIT(pp->prop_get);
1590 Py_VISIT(pp->prop_set);
1591 Py_VISIT(pp->prop_del);
1592 Py_VISIT(pp->prop_doc);
1593 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +00001594}
1595
Raymond Hettingerd4be6912015-05-13 11:12:33 -07001596static int
1597property_clear(PyObject *self)
1598{
1599 propertyobject *pp = (propertyobject *)self;
1600 Py_CLEAR(pp->prop_doc);
1601 return 0;
1602}
1603
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001604PyTypeObject PyProperty_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001605 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1606 "property", /* tp_name */
1607 sizeof(propertyobject), /* tp_basicsize */
1608 0, /* tp_itemsize */
1609 /* methods */
1610 property_dealloc, /* tp_dealloc */
1611 0, /* tp_print */
1612 0, /* tp_getattr */
1613 0, /* tp_setattr */
1614 0, /* tp_reserved */
1615 0, /* tp_repr */
1616 0, /* tp_as_number */
1617 0, /* tp_as_sequence */
1618 0, /* tp_as_mapping */
1619 0, /* tp_hash */
1620 0, /* tp_call */
1621 0, /* tp_str */
1622 PyObject_GenericGetAttr, /* tp_getattro */
1623 0, /* tp_setattro */
1624 0, /* tp_as_buffer */
1625 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
1626 Py_TPFLAGS_BASETYPE, /* tp_flags */
1627 property_doc, /* tp_doc */
1628 property_traverse, /* tp_traverse */
Raymond Hettingerd4be6912015-05-13 11:12:33 -07001629 (inquiry)property_clear, /* tp_clear */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001630 0, /* tp_richcompare */
1631 0, /* tp_weaklistoffset */
1632 0, /* tp_iter */
1633 0, /* tp_iternext */
1634 property_methods, /* tp_methods */
1635 property_members, /* tp_members */
Benjamin Petersonbfebb7b2011-12-15 15:34:02 -05001636 property_getsetlist, /* tp_getset */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001637 0, /* tp_base */
1638 0, /* tp_dict */
1639 property_descr_get, /* tp_descr_get */
1640 property_descr_set, /* tp_descr_set */
1641 0, /* tp_dictoffset */
1642 property_init, /* tp_init */
1643 PyType_GenericAlloc, /* tp_alloc */
1644 PyType_GenericNew, /* tp_new */
1645 PyObject_GC_Del, /* tp_free */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001646};