blob: c20ca9be4df60d13f916d86b9f83718f84c4c8b9 [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
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02006/*[clinic input]
7class mappingproxy "mappingproxyobject *" "&PyDictProxy_Type"
8class property "propertyobject *" "&PyProperty_Type"
9[clinic start generated code]*/
10/*[clinic end generated code: output=da39a3ee5e6b4b0d input=556352653fd4c02e]*/
11
Tim Peters6d6c1a32001-08-02 04:15:00 +000012static void
13descr_dealloc(PyDescrObject *descr)
14{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000015 _PyObject_GC_UNTRACK(descr);
16 Py_XDECREF(descr->d_type);
17 Py_XDECREF(descr->d_name);
Antoine Pitrou9d574812011-12-12 13:47:25 +010018 Py_XDECREF(descr->d_qualname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000019 PyObject_GC_Del(descr);
Tim Peters6d6c1a32001-08-02 04:15:00 +000020}
21
Walter Dörwaldd7fb7642007-06-11 16:36:59 +000022static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +000023descr_name(PyDescrObject *descr)
24{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000025 if (descr->d_name != NULL && PyUnicode_Check(descr->d_name))
26 return descr->d_name;
27 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +000028}
29
30static PyObject *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020031descr_repr(PyDescrObject *descr, const char *format)
Tim Peters6d6c1a32001-08-02 04:15:00 +000032{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000033 PyObject *name = NULL;
34 if (descr->d_name != NULL && PyUnicode_Check(descr->d_name))
35 name = descr->d_name;
Walter Dörwaldd7fb7642007-06-11 16:36:59 +000036
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000037 return PyUnicode_FromFormat(format, name, "?", descr->d_type->tp_name);
Tim Peters6d6c1a32001-08-02 04:15:00 +000038}
39
40static PyObject *
41method_repr(PyMethodDescrObject *descr)
42{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000043 return descr_repr((PyDescrObject *)descr,
44 "<method '%V' of '%s' objects>");
Tim Peters6d6c1a32001-08-02 04:15:00 +000045}
46
47static PyObject *
48member_repr(PyMemberDescrObject *descr)
49{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000050 return descr_repr((PyDescrObject *)descr,
51 "<member '%V' of '%s' objects>");
Tim Peters6d6c1a32001-08-02 04:15:00 +000052}
53
54static PyObject *
55getset_repr(PyGetSetDescrObject *descr)
56{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000057 return descr_repr((PyDescrObject *)descr,
58 "<attribute '%V' of '%s' objects>");
Tim Peters6d6c1a32001-08-02 04:15:00 +000059}
60
61static PyObject *
Armin Rigoc6686b72005-11-07 08:38:00 +000062wrapperdescr_repr(PyWrapperDescrObject *descr)
Tim Peters6d6c1a32001-08-02 04:15:00 +000063{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000064 return descr_repr((PyDescrObject *)descr,
65 "<slot wrapper '%V' of '%s' objects>");
Tim Peters6d6c1a32001-08-02 04:15:00 +000066}
67
68static int
Guido van Rossumb6e5a0c2003-02-11 18:44:42 +000069descr_check(PyDescrObject *descr, PyObject *obj, PyObject **pres)
Tim Peters6d6c1a32001-08-02 04:15:00 +000070{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000071 if (obj == NULL) {
72 Py_INCREF(descr);
73 *pres = (PyObject *)descr;
74 return 1;
75 }
76 if (!PyObject_TypeCheck(obj, descr->d_type)) {
77 PyErr_Format(PyExc_TypeError,
78 "descriptor '%V' for '%s' objects "
79 "doesn't apply to '%s' object",
80 descr_name((PyDescrObject *)descr), "?",
81 descr->d_type->tp_name,
82 obj->ob_type->tp_name);
83 *pres = NULL;
84 return 1;
85 }
86 return 0;
Tim Peters6d6c1a32001-08-02 04:15:00 +000087}
88
89static PyObject *
Guido van Rossumb6e5a0c2003-02-11 18:44:42 +000090classmethod_get(PyMethodDescrObject *descr, PyObject *obj, PyObject *type)
Tim Petersbca1cbc2002-12-09 22:56:13 +000091{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000092 /* Ensure a valid type. Class methods ignore obj. */
93 if (type == NULL) {
94 if (obj != NULL)
95 type = (PyObject *)obj->ob_type;
96 else {
97 /* Wot - no type?! */
98 PyErr_Format(PyExc_TypeError,
99 "descriptor '%V' for type '%s' "
100 "needs either an object or a type",
101 descr_name((PyDescrObject *)descr), "?",
102 PyDescr_TYPE(descr)->tp_name);
103 return NULL;
104 }
105 }
106 if (!PyType_Check(type)) {
107 PyErr_Format(PyExc_TypeError,
108 "descriptor '%V' for type '%s' "
109 "needs a type, not a '%s' as arg 2",
110 descr_name((PyDescrObject *)descr), "?",
111 PyDescr_TYPE(descr)->tp_name,
112 type->ob_type->tp_name);
113 return NULL;
114 }
115 if (!PyType_IsSubtype((PyTypeObject *)type, PyDescr_TYPE(descr))) {
116 PyErr_Format(PyExc_TypeError,
117 "descriptor '%V' for type '%s' "
118 "doesn't apply to type '%s'",
119 descr_name((PyDescrObject *)descr), "?",
120 PyDescr_TYPE(descr)->tp_name,
121 ((PyTypeObject *)type)->tp_name);
122 return NULL;
123 }
Andrew Svetlov3ba3a3e2012-12-25 13:32:35 +0200124 return PyCFunction_NewEx(descr->d_method, type, NULL);
Tim Petersbca1cbc2002-12-09 22:56:13 +0000125}
126
127static PyObject *
Guido van Rossumb6e5a0c2003-02-11 18:44:42 +0000128method_get(PyMethodDescrObject *descr, PyObject *obj, PyObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000129{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000130 PyObject *res;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000131
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000132 if (descr_check((PyDescrObject *)descr, obj, &res))
133 return res;
Andrew Svetlov3ba3a3e2012-12-25 13:32:35 +0200134 return PyCFunction_NewEx(descr->d_method, obj, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000135}
136
137static PyObject *
Guido van Rossumb6e5a0c2003-02-11 18:44:42 +0000138member_get(PyMemberDescrObject *descr, PyObject *obj, PyObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000139{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000140 PyObject *res;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000141
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000142 if (descr_check((PyDescrObject *)descr, obj, &res))
143 return res;
144 return PyMember_GetOne((char *)obj, descr->d_member);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000145}
146
147static PyObject *
Guido van Rossumb6e5a0c2003-02-11 18:44:42 +0000148getset_get(PyGetSetDescrObject *descr, PyObject *obj, PyObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000149{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000150 PyObject *res;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000151
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000152 if (descr_check((PyDescrObject *)descr, obj, &res))
153 return res;
154 if (descr->d_getset->get != NULL)
155 return descr->d_getset->get(obj, descr->d_getset->closure);
156 PyErr_Format(PyExc_AttributeError,
157 "attribute '%V' of '%.100s' objects is not readable",
158 descr_name((PyDescrObject *)descr), "?",
159 PyDescr_TYPE(descr)->tp_name);
160 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000161}
162
163static PyObject *
Armin Rigoc6686b72005-11-07 08:38:00 +0000164wrapperdescr_get(PyWrapperDescrObject *descr, PyObject *obj, PyObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000165{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000166 PyObject *res;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000167
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000168 if (descr_check((PyDescrObject *)descr, obj, &res))
169 return res;
170 return PyWrapper_New((PyObject *)descr, obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000171}
172
173static int
174descr_setcheck(PyDescrObject *descr, PyObject *obj, PyObject *value,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000175 int *pres)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000176{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000177 assert(obj != NULL);
178 if (!PyObject_TypeCheck(obj, descr->d_type)) {
179 PyErr_Format(PyExc_TypeError,
180 "descriptor '%V' for '%.100s' objects "
181 "doesn't apply to '%.100s' object",
182 descr_name(descr), "?",
183 descr->d_type->tp_name,
184 obj->ob_type->tp_name);
185 *pres = -1;
186 return 1;
187 }
188 return 0;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000189}
190
191static int
192member_set(PyMemberDescrObject *descr, PyObject *obj, PyObject *value)
193{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000194 int res;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000195
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000196 if (descr_setcheck((PyDescrObject *)descr, obj, value, &res))
197 return res;
198 return PyMember_SetOne((char *)obj, descr->d_member, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000199}
200
201static int
202getset_set(PyGetSetDescrObject *descr, PyObject *obj, PyObject *value)
203{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000204 int res;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000205
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000206 if (descr_setcheck((PyDescrObject *)descr, obj, value, &res))
207 return res;
208 if (descr->d_getset->set != NULL)
209 return descr->d_getset->set(obj, value,
210 descr->d_getset->closure);
211 PyErr_Format(PyExc_AttributeError,
212 "attribute '%V' of '%.100s' objects is not writable",
213 descr_name((PyDescrObject *)descr), "?",
214 PyDescr_TYPE(descr)->tp_name);
215 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000216}
217
218static PyObject *
Victor Stinnerc5257232017-01-18 10:38:09 +0100219methoddescr_call(PyMethodDescrObject *descr, PyObject *args, PyObject *kwargs)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000220{
Victor Stinnerc5257232017-01-18 10:38:09 +0100221 Py_ssize_t nargs;
222 PyObject *self, *result;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000223
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000224 /* Make sure that the first argument is acceptable as 'self' */
225 assert(PyTuple_Check(args));
Victor Stinnerc5257232017-01-18 10:38:09 +0100226 nargs = PyTuple_GET_SIZE(args);
227 if (nargs < 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000228 PyErr_Format(PyExc_TypeError,
229 "descriptor '%V' of '%.100s' "
230 "object needs an argument",
231 descr_name((PyDescrObject *)descr), "?",
232 PyDescr_TYPE(descr)->tp_name);
233 return NULL;
234 }
235 self = PyTuple_GET_ITEM(args, 0);
Victor Stinner3249dec2011-05-01 23:19:15 +0200236 if (!_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self),
Victor Stinnerd9561312011-05-01 23:31:36 +0200237 (PyObject *)PyDescr_TYPE(descr))) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000238 PyErr_Format(PyExc_TypeError,
239 "descriptor '%V' "
240 "requires a '%.100s' object "
241 "but received a '%.100s'",
242 descr_name((PyDescrObject *)descr), "?",
243 PyDescr_TYPE(descr)->tp_name,
244 self->ob_type->tp_name);
245 return NULL;
246 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000247
Victor Stinnerc5257232017-01-18 10:38:09 +0100248 result = _PyMethodDef_RawFastCallDict(descr->d_method, self,
249 &PyTuple_GET_ITEM(args, 1), nargs - 1,
250 kwargs);
251 result = _Py_CheckFunctionResult((PyObject *)descr, result, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000252 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000253}
254
INADA Naoki5566bbb2017-02-03 07:43:03 +0900255// same to methoddescr_call(), but use FASTCALL convention.
256PyObject *
257_PyMethodDescr_FastCallKeywords(PyObject *descrobj,
258 PyObject **args, Py_ssize_t nargs,
259 PyObject *kwnames)
260{
261 assert(Py_TYPE(descrobj) == &PyMethodDescr_Type);
262 PyMethodDescrObject *descr = (PyMethodDescrObject *)descrobj;
263 PyObject *self, *result;
264
265 /* Make sure that the first argument is acceptable as 'self' */
266 if (nargs < 1) {
267 PyErr_Format(PyExc_TypeError,
268 "descriptor '%V' of '%.100s' "
269 "object needs an argument",
270 descr_name((PyDescrObject *)descr), "?",
271 PyDescr_TYPE(descr)->tp_name);
272 return NULL;
273 }
274 self = args[0];
275 if (!_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self),
276 (PyObject *)PyDescr_TYPE(descr))) {
277 PyErr_Format(PyExc_TypeError,
278 "descriptor '%V' "
279 "requires a '%.100s' object "
280 "but received a '%.100s'",
281 descr_name((PyDescrObject *)descr), "?",
282 PyDescr_TYPE(descr)->tp_name,
283 self->ob_type->tp_name);
284 return NULL;
285 }
286
287 result = _PyMethodDef_RawFastCallKeywords(descr->d_method, self,
288 args+1, nargs-1, kwnames);
289 result = _Py_CheckFunctionResult((PyObject *)descr, result, NULL);
290 return result;
291}
292
Tim Peters6d6c1a32001-08-02 04:15:00 +0000293static PyObject *
Tim Petersbca1cbc2002-12-09 22:56:13 +0000294classmethoddescr_call(PyMethodDescrObject *descr, PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000295 PyObject *kwds)
Tim Petersbca1cbc2002-12-09 22:56:13 +0000296{
Benjamin Peterson7295c6a2012-05-01 09:51:09 -0400297 Py_ssize_t argc;
Victor Stinner2990fa12016-08-22 23:21:55 +0200298 PyObject *self, *func, *result, **stack;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000299
Benjamin Peterson7295c6a2012-05-01 09:51:09 -0400300 /* Make sure that the first argument is acceptable as 'self' */
301 assert(PyTuple_Check(args));
302 argc = PyTuple_GET_SIZE(args);
303 if (argc < 1) {
304 PyErr_Format(PyExc_TypeError,
305 "descriptor '%V' of '%.100s' "
306 "object needs an argument",
307 descr_name((PyDescrObject *)descr), "?",
308 PyDescr_TYPE(descr)->tp_name);
309 return NULL;
310 }
311 self = PyTuple_GET_ITEM(args, 0);
312 if (!PyType_Check(self)) {
313 PyErr_Format(PyExc_TypeError,
314 "descriptor '%V' requires a type "
315 "but received a '%.100s'",
316 descr_name((PyDescrObject *)descr), "?",
317 PyDescr_TYPE(descr)->tp_name,
318 self->ob_type->tp_name);
319 return NULL;
320 }
321 if (!PyType_IsSubtype((PyTypeObject *)self, PyDescr_TYPE(descr))) {
322 PyErr_Format(PyExc_TypeError,
323 "descriptor '%V' "
324 "requires a subtype of '%.100s' "
325 "but received '%.100s",
326 descr_name((PyDescrObject *)descr), "?",
327 PyDescr_TYPE(descr)->tp_name,
328 self->ob_type->tp_name);
329 return NULL;
330 }
331
Andrew Svetlov3ba3a3e2012-12-25 13:32:35 +0200332 func = PyCFunction_NewEx(descr->d_method, self, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000333 if (func == NULL)
334 return NULL;
Victor Stinner2990fa12016-08-22 23:21:55 +0200335 stack = &PyTuple_GET_ITEM(args, 1);
336 result = _PyObject_FastCallDict(func, stack, argc - 1, kwds);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000337 Py_DECREF(func);
338 return result;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000339}
340
341static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000342wrapperdescr_call(PyWrapperDescrObject *descr, PyObject *args, PyObject *kwds)
343{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000344 Py_ssize_t argc;
Victor Stinner2990fa12016-08-22 23:21:55 +0200345 PyObject *self, *func, *result, **stack;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000346
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000347 /* Make sure that the first argument is acceptable as 'self' */
348 assert(PyTuple_Check(args));
349 argc = PyTuple_GET_SIZE(args);
350 if (argc < 1) {
351 PyErr_Format(PyExc_TypeError,
352 "descriptor '%V' of '%.100s' "
353 "object needs an argument",
354 descr_name((PyDescrObject *)descr), "?",
355 PyDescr_TYPE(descr)->tp_name);
356 return NULL;
357 }
358 self = PyTuple_GET_ITEM(args, 0);
Victor Stinner3249dec2011-05-01 23:19:15 +0200359 if (!_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self),
Victor Stinnerd9561312011-05-01 23:31:36 +0200360 (PyObject *)PyDescr_TYPE(descr))) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000361 PyErr_Format(PyExc_TypeError,
362 "descriptor '%V' "
363 "requires a '%.100s' object "
364 "but received a '%.100s'",
365 descr_name((PyDescrObject *)descr), "?",
366 PyDescr_TYPE(descr)->tp_name,
367 self->ob_type->tp_name);
368 return NULL;
369 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000370
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000371 func = PyWrapper_New((PyObject *)descr, self);
372 if (func == NULL)
373 return NULL;
Victor Stinner2990fa12016-08-22 23:21:55 +0200374
375 stack = &PyTuple_GET_ITEM(args, 1);
376 result = _PyObject_FastCallDict(func, stack, argc - 1, kwds);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000377 Py_DECREF(func);
378 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000379}
380
381static PyObject *
Guido van Rossum6f799372001-09-20 20:46:19 +0000382method_get_doc(PyMethodDescrObject *descr, void *closure)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000383{
Larry Hastings2623c8c2014-02-08 22:15:29 -0800384 return _PyType_GetDocFromInternalDoc(descr->d_method->ml_name, descr->d_method->ml_doc);
Larry Hastings5c661892014-01-24 06:17:25 -0800385}
386
387static PyObject *
388method_get_text_signature(PyMethodDescrObject *descr, void *closure)
389{
Larry Hastings2623c8c2014-02-08 22:15:29 -0800390 return _PyType_GetTextSignatureFromInternalDoc(descr->d_method->ml_name, descr->d_method->ml_doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000391}
392
Antoine Pitrou9d574812011-12-12 13:47:25 +0100393static PyObject *
394calculate_qualname(PyDescrObject *descr)
395{
396 PyObject *type_qualname, *res;
397 _Py_IDENTIFIER(__qualname__);
398
399 if (descr->d_name == NULL || !PyUnicode_Check(descr->d_name)) {
400 PyErr_SetString(PyExc_TypeError,
401 "<descriptor>.__name__ is not a unicode object");
402 return NULL;
403 }
404
405 type_qualname = _PyObject_GetAttrId((PyObject *)descr->d_type,
406 &PyId___qualname__);
407 if (type_qualname == NULL)
408 return NULL;
409
410 if (!PyUnicode_Check(type_qualname)) {
411 PyErr_SetString(PyExc_TypeError, "<descriptor>.__objclass__."
412 "__qualname__ is not a unicode object");
413 Py_XDECREF(type_qualname);
414 return NULL;
415 }
416
417 res = PyUnicode_FromFormat("%S.%S", type_qualname, descr->d_name);
418 Py_DECREF(type_qualname);
419 return res;
420}
421
422static PyObject *
423descr_get_qualname(PyDescrObject *descr)
424{
425 if (descr->d_qualname == NULL)
426 descr->d_qualname = calculate_qualname(descr);
427 Py_XINCREF(descr->d_qualname);
428 return descr->d_qualname;
429}
430
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100431static PyObject *
432descr_reduce(PyDescrObject *descr)
433{
434 PyObject *builtins;
435 PyObject *getattr;
436 _Py_IDENTIFIER(getattr);
437
438 builtins = PyEval_GetBuiltins();
439 getattr = _PyDict_GetItemId(builtins, &PyId_getattr);
440 return Py_BuildValue("O(OO)", getattr, PyDescr_TYPE(descr),
441 PyDescr_NAME(descr));
442}
443
444static PyMethodDef descr_methods[] = {
445 {"__reduce__", (PyCFunction)descr_reduce, METH_NOARGS, NULL},
446 {NULL, NULL}
447};
448
Guido van Rossum6f799372001-09-20 20:46:19 +0000449static PyMemberDef descr_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000450 {"__objclass__", T_OBJECT, offsetof(PyDescrObject, d_type), READONLY},
451 {"__name__", T_OBJECT, offsetof(PyDescrObject, d_name), READONLY},
452 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000453};
454
Guido van Rossum32d34c82001-09-20 21:45:26 +0000455static PyGetSetDef method_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000456 {"__doc__", (getter)method_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100457 {"__qualname__", (getter)descr_get_qualname},
Larry Hastings5c661892014-01-24 06:17:25 -0800458 {"__text_signature__", (getter)method_get_text_signature},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000459 {0}
Guido van Rossum6f799372001-09-20 20:46:19 +0000460};
461
462static PyObject *
463member_get_doc(PyMemberDescrObject *descr, void *closure)
464{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000465 if (descr->d_member->doc == NULL) {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200466 Py_RETURN_NONE;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000467 }
468 return PyUnicode_FromString(descr->d_member->doc);
Guido van Rossum6f799372001-09-20 20:46:19 +0000469}
470
Guido van Rossum32d34c82001-09-20 21:45:26 +0000471static PyGetSetDef member_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000472 {"__doc__", (getter)member_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100473 {"__qualname__", (getter)descr_get_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000474 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000475};
476
477static PyObject *
Guido van Rossum32d34c82001-09-20 21:45:26 +0000478getset_get_doc(PyGetSetDescrObject *descr, void *closure)
479{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000480 if (descr->d_getset->doc == NULL) {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200481 Py_RETURN_NONE;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000482 }
483 return PyUnicode_FromString(descr->d_getset->doc);
Guido van Rossum32d34c82001-09-20 21:45:26 +0000484}
485
486static PyGetSetDef getset_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000487 {"__doc__", (getter)getset_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100488 {"__qualname__", (getter)descr_get_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000489 {0}
Guido van Rossum32d34c82001-09-20 21:45:26 +0000490};
491
492static PyObject *
Armin Rigoc6686b72005-11-07 08:38:00 +0000493wrapperdescr_get_doc(PyWrapperDescrObject *descr, void *closure)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000494{
Larry Hastings2623c8c2014-02-08 22:15:29 -0800495 return _PyType_GetDocFromInternalDoc(descr->d_base->name, descr->d_base->doc);
Larry Hastings5c661892014-01-24 06:17:25 -0800496}
497
498static PyObject *
499wrapperdescr_get_text_signature(PyWrapperDescrObject *descr, void *closure)
500{
Larry Hastings2623c8c2014-02-08 22:15:29 -0800501 return _PyType_GetTextSignatureFromInternalDoc(descr->d_base->name, descr->d_base->doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000502}
503
Armin Rigoc6686b72005-11-07 08:38:00 +0000504static PyGetSetDef wrapperdescr_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000505 {"__doc__", (getter)wrapperdescr_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100506 {"__qualname__", (getter)descr_get_qualname},
Larry Hastings5c661892014-01-24 06:17:25 -0800507 {"__text_signature__", (getter)wrapperdescr_get_text_signature},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000508 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000509};
510
Guido van Rossum048eb752001-10-02 21:24:57 +0000511static int
512descr_traverse(PyObject *self, visitproc visit, void *arg)
513{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000514 PyDescrObject *descr = (PyDescrObject *)self;
515 Py_VISIT(descr->d_type);
516 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +0000517}
518
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000519PyTypeObject PyMethodDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000520 PyVarObject_HEAD_INIT(&PyType_Type, 0)
521 "method_descriptor",
522 sizeof(PyMethodDescrObject),
523 0,
524 (destructor)descr_dealloc, /* tp_dealloc */
525 0, /* tp_print */
526 0, /* tp_getattr */
527 0, /* tp_setattr */
528 0, /* tp_reserved */
529 (reprfunc)method_repr, /* tp_repr */
530 0, /* tp_as_number */
531 0, /* tp_as_sequence */
532 0, /* tp_as_mapping */
533 0, /* tp_hash */
534 (ternaryfunc)methoddescr_call, /* tp_call */
535 0, /* tp_str */
536 PyObject_GenericGetAttr, /* tp_getattro */
537 0, /* tp_setattro */
538 0, /* tp_as_buffer */
539 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
540 0, /* tp_doc */
541 descr_traverse, /* tp_traverse */
542 0, /* tp_clear */
543 0, /* tp_richcompare */
544 0, /* tp_weaklistoffset */
545 0, /* tp_iter */
546 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100547 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000548 descr_members, /* tp_members */
549 method_getset, /* tp_getset */
550 0, /* tp_base */
551 0, /* tp_dict */
552 (descrgetfunc)method_get, /* tp_descr_get */
553 0, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000554};
555
Guido van Rossumb6e5a0c2003-02-11 18:44:42 +0000556/* This is for METH_CLASS in C, not for "f = classmethod(f)" in Python! */
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000557PyTypeObject PyClassMethodDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000558 PyVarObject_HEAD_INIT(&PyType_Type, 0)
559 "classmethod_descriptor",
560 sizeof(PyMethodDescrObject),
561 0,
562 (destructor)descr_dealloc, /* tp_dealloc */
563 0, /* tp_print */
564 0, /* tp_getattr */
565 0, /* tp_setattr */
566 0, /* tp_reserved */
567 (reprfunc)method_repr, /* tp_repr */
568 0, /* tp_as_number */
569 0, /* tp_as_sequence */
570 0, /* tp_as_mapping */
571 0, /* tp_hash */
572 (ternaryfunc)classmethoddescr_call, /* tp_call */
573 0, /* tp_str */
574 PyObject_GenericGetAttr, /* tp_getattro */
575 0, /* tp_setattro */
576 0, /* tp_as_buffer */
577 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
578 0, /* tp_doc */
579 descr_traverse, /* tp_traverse */
580 0, /* tp_clear */
581 0, /* tp_richcompare */
582 0, /* tp_weaklistoffset */
583 0, /* tp_iter */
584 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100585 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000586 descr_members, /* tp_members */
587 method_getset, /* tp_getset */
588 0, /* tp_base */
589 0, /* tp_dict */
590 (descrgetfunc)classmethod_get, /* tp_descr_get */
591 0, /* tp_descr_set */
Tim Petersbca1cbc2002-12-09 22:56:13 +0000592};
593
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000594PyTypeObject PyMemberDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000595 PyVarObject_HEAD_INIT(&PyType_Type, 0)
596 "member_descriptor",
597 sizeof(PyMemberDescrObject),
598 0,
599 (destructor)descr_dealloc, /* tp_dealloc */
600 0, /* tp_print */
601 0, /* tp_getattr */
602 0, /* tp_setattr */
603 0, /* tp_reserved */
604 (reprfunc)member_repr, /* tp_repr */
605 0, /* tp_as_number */
606 0, /* tp_as_sequence */
607 0, /* tp_as_mapping */
608 0, /* tp_hash */
609 0, /* tp_call */
610 0, /* tp_str */
611 PyObject_GenericGetAttr, /* tp_getattro */
612 0, /* tp_setattro */
613 0, /* tp_as_buffer */
614 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
615 0, /* tp_doc */
616 descr_traverse, /* tp_traverse */
617 0, /* tp_clear */
618 0, /* tp_richcompare */
619 0, /* tp_weaklistoffset */
620 0, /* tp_iter */
621 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100622 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000623 descr_members, /* tp_members */
624 member_getset, /* tp_getset */
625 0, /* tp_base */
626 0, /* tp_dict */
627 (descrgetfunc)member_get, /* tp_descr_get */
628 (descrsetfunc)member_set, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000629};
630
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000631PyTypeObject PyGetSetDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000632 PyVarObject_HEAD_INIT(&PyType_Type, 0)
633 "getset_descriptor",
634 sizeof(PyGetSetDescrObject),
635 0,
636 (destructor)descr_dealloc, /* tp_dealloc */
637 0, /* tp_print */
638 0, /* tp_getattr */
639 0, /* tp_setattr */
640 0, /* tp_reserved */
641 (reprfunc)getset_repr, /* tp_repr */
642 0, /* tp_as_number */
643 0, /* tp_as_sequence */
644 0, /* tp_as_mapping */
645 0, /* tp_hash */
646 0, /* tp_call */
647 0, /* tp_str */
648 PyObject_GenericGetAttr, /* tp_getattro */
649 0, /* tp_setattro */
650 0, /* tp_as_buffer */
651 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
652 0, /* tp_doc */
653 descr_traverse, /* tp_traverse */
654 0, /* tp_clear */
655 0, /* tp_richcompare */
656 0, /* tp_weaklistoffset */
657 0, /* tp_iter */
658 0, /* tp_iternext */
659 0, /* tp_methods */
660 descr_members, /* tp_members */
661 getset_getset, /* tp_getset */
662 0, /* tp_base */
663 0, /* tp_dict */
664 (descrgetfunc)getset_get, /* tp_descr_get */
665 (descrsetfunc)getset_set, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000666};
667
Guido van Rossumf4593e02001-10-03 12:09:30 +0000668PyTypeObject PyWrapperDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000669 PyVarObject_HEAD_INIT(&PyType_Type, 0)
670 "wrapper_descriptor",
671 sizeof(PyWrapperDescrObject),
672 0,
673 (destructor)descr_dealloc, /* tp_dealloc */
674 0, /* tp_print */
675 0, /* tp_getattr */
676 0, /* tp_setattr */
677 0, /* tp_reserved */
678 (reprfunc)wrapperdescr_repr, /* tp_repr */
679 0, /* tp_as_number */
680 0, /* tp_as_sequence */
681 0, /* tp_as_mapping */
682 0, /* tp_hash */
683 (ternaryfunc)wrapperdescr_call, /* tp_call */
684 0, /* tp_str */
685 PyObject_GenericGetAttr, /* tp_getattro */
686 0, /* tp_setattro */
687 0, /* tp_as_buffer */
688 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
689 0, /* tp_doc */
690 descr_traverse, /* tp_traverse */
691 0, /* tp_clear */
692 0, /* tp_richcompare */
693 0, /* tp_weaklistoffset */
694 0, /* tp_iter */
695 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100696 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000697 descr_members, /* tp_members */
698 wrapperdescr_getset, /* tp_getset */
699 0, /* tp_base */
700 0, /* tp_dict */
701 (descrgetfunc)wrapperdescr_get, /* tp_descr_get */
702 0, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000703};
704
705static PyDescrObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000706descr_new(PyTypeObject *descrtype, PyTypeObject *type, const char *name)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000707{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000708 PyDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000709
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000710 descr = (PyDescrObject *)PyType_GenericAlloc(descrtype, 0);
711 if (descr != NULL) {
712 Py_XINCREF(type);
713 descr->d_type = type;
714 descr->d_name = PyUnicode_InternFromString(name);
715 if (descr->d_name == NULL) {
716 Py_DECREF(descr);
717 descr = NULL;
718 }
Benjamin Petersonf2fe7f02011-12-17 08:02:20 -0500719 else {
720 descr->d_qualname = NULL;
721 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000722 }
723 return descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000724}
725
726PyObject *
727PyDescr_NewMethod(PyTypeObject *type, PyMethodDef *method)
728{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000729 PyMethodDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000730
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000731 descr = (PyMethodDescrObject *)descr_new(&PyMethodDescr_Type,
732 type, method->ml_name);
733 if (descr != NULL)
734 descr->d_method = method;
735 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000736}
737
738PyObject *
Tim Petersbca1cbc2002-12-09 22:56:13 +0000739PyDescr_NewClassMethod(PyTypeObject *type, PyMethodDef *method)
740{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000741 PyMethodDescrObject *descr;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000742
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000743 descr = (PyMethodDescrObject *)descr_new(&PyClassMethodDescr_Type,
744 type, method->ml_name);
745 if (descr != NULL)
746 descr->d_method = method;
747 return (PyObject *)descr;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000748}
749
750PyObject *
Guido van Rossum6f799372001-09-20 20:46:19 +0000751PyDescr_NewMember(PyTypeObject *type, PyMemberDef *member)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000752{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000753 PyMemberDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000754
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000755 descr = (PyMemberDescrObject *)descr_new(&PyMemberDescr_Type,
756 type, member->name);
757 if (descr != NULL)
758 descr->d_member = member;
759 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000760}
761
762PyObject *
Guido van Rossum32d34c82001-09-20 21:45:26 +0000763PyDescr_NewGetSet(PyTypeObject *type, PyGetSetDef *getset)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000764{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000765 PyGetSetDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000766
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000767 descr = (PyGetSetDescrObject *)descr_new(&PyGetSetDescr_Type,
768 type, getset->name);
769 if (descr != NULL)
770 descr->d_getset = getset;
771 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000772}
773
774PyObject *
775PyDescr_NewWrapper(PyTypeObject *type, struct wrapperbase *base, void *wrapped)
776{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000777 PyWrapperDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000778
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000779 descr = (PyWrapperDescrObject *)descr_new(&PyWrapperDescr_Type,
780 type, base->name);
781 if (descr != NULL) {
782 descr->d_base = base;
783 descr->d_wrapped = wrapped;
784 }
785 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000786}
787
Tim Peters6d6c1a32001-08-02 04:15:00 +0000788
Victor Stinner0db176f2012-04-16 00:16:30 +0200789/* --- mappingproxy: read-only proxy for mappings --- */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000790
791/* This has no reason to be in this file except that adding new files is a
792 bit of a pain */
793
794typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000795 PyObject_HEAD
Victor Stinner0db176f2012-04-16 00:16:30 +0200796 PyObject *mapping;
797} mappingproxyobject;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000798
Martin v. Löwis18e16552006-02-15 17:27:45 +0000799static Py_ssize_t
Victor Stinner0db176f2012-04-16 00:16:30 +0200800mappingproxy_len(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000801{
Victor Stinner0db176f2012-04-16 00:16:30 +0200802 return PyObject_Size(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000803}
804
805static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200806mappingproxy_getitem(mappingproxyobject *pp, PyObject *key)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000807{
Victor Stinner0db176f2012-04-16 00:16:30 +0200808 return PyObject_GetItem(pp->mapping, key);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000809}
810
Victor Stinner0db176f2012-04-16 00:16:30 +0200811static PyMappingMethods mappingproxy_as_mapping = {
812 (lenfunc)mappingproxy_len, /* mp_length */
813 (binaryfunc)mappingproxy_getitem, /* mp_subscript */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000814 0, /* mp_ass_subscript */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000815};
816
817static int
Victor Stinner0db176f2012-04-16 00:16:30 +0200818mappingproxy_contains(mappingproxyobject *pp, PyObject *key)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000819{
Victor Stinner0db176f2012-04-16 00:16:30 +0200820 if (PyDict_CheckExact(pp->mapping))
821 return PyDict_Contains(pp->mapping, key);
822 else
823 return PySequence_Contains(pp->mapping, key);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000824}
825
Victor Stinner0db176f2012-04-16 00:16:30 +0200826static PySequenceMethods mappingproxy_as_sequence = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000827 0, /* sq_length */
828 0, /* sq_concat */
829 0, /* sq_repeat */
830 0, /* sq_item */
831 0, /* sq_slice */
832 0, /* sq_ass_item */
833 0, /* sq_ass_slice */
Victor Stinner0db176f2012-04-16 00:16:30 +0200834 (objobjproc)mappingproxy_contains, /* sq_contains */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000835 0, /* sq_inplace_concat */
836 0, /* sq_inplace_repeat */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000837};
838
839static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200840mappingproxy_get(mappingproxyobject *pp, PyObject *args)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000841{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000842 PyObject *key, *def = Py_None;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200843 _Py_IDENTIFIER(get);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000844
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000845 if (!PyArg_UnpackTuple(args, "get", 1, 2, &key, &def))
846 return NULL;
Victor Stinner7e425412016-12-09 00:36:19 +0100847 return _PyObject_CallMethodIdObjArgs(pp->mapping, &PyId_get,
848 key, def, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000849}
850
851static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200852mappingproxy_keys(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000853{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200854 _Py_IDENTIFIER(keys);
Victor Stinner0db176f2012-04-16 00:16:30 +0200855 return _PyObject_CallMethodId(pp->mapping, &PyId_keys, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000856}
857
858static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200859mappingproxy_values(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000860{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200861 _Py_IDENTIFIER(values);
Victor Stinner0db176f2012-04-16 00:16:30 +0200862 return _PyObject_CallMethodId(pp->mapping, &PyId_values, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000863}
864
865static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200866mappingproxy_items(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000867{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200868 _Py_IDENTIFIER(items);
Victor Stinner0db176f2012-04-16 00:16:30 +0200869 return _PyObject_CallMethodId(pp->mapping, &PyId_items, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000870}
871
872static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200873mappingproxy_copy(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000874{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200875 _Py_IDENTIFIER(copy);
Victor Stinner0db176f2012-04-16 00:16:30 +0200876 return _PyObject_CallMethodId(pp->mapping, &PyId_copy, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000877}
878
Victor Stinner0db176f2012-04-16 00:16:30 +0200879/* WARNING: mappingproxy methods must not give access
880 to the underlying mapping */
881
882static PyMethodDef mappingproxy_methods[] = {
883 {"get", (PyCFunction)mappingproxy_get, METH_VARARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000884 PyDoc_STR("D.get(k[,d]) -> D[k] if k in D, else d."
Victor Stinner0db176f2012-04-16 00:16:30 +0200885 " d defaults to None.")},
886 {"keys", (PyCFunction)mappingproxy_keys, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000887 PyDoc_STR("D.keys() -> list of D's keys")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200888 {"values", (PyCFunction)mappingproxy_values, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000889 PyDoc_STR("D.values() -> list of D's values")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200890 {"items", (PyCFunction)mappingproxy_items, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000891 PyDoc_STR("D.items() -> list of D's (key, value) pairs, as 2-tuples")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200892 {"copy", (PyCFunction)mappingproxy_copy, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000893 PyDoc_STR("D.copy() -> a shallow copy of D")},
894 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000895};
896
897static void
Victor Stinner0db176f2012-04-16 00:16:30 +0200898mappingproxy_dealloc(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000899{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000900 _PyObject_GC_UNTRACK(pp);
Victor Stinner0db176f2012-04-16 00:16:30 +0200901 Py_DECREF(pp->mapping);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000902 PyObject_GC_Del(pp);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000903}
904
905static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200906mappingproxy_getiter(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000907{
Victor Stinner0db176f2012-04-16 00:16:30 +0200908 return PyObject_GetIter(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000909}
910
Neil Schemenauer26775122001-10-21 22:26:43 +0000911static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200912mappingproxy_str(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000913{
Victor Stinner0db176f2012-04-16 00:16:30 +0200914 return PyObject_Str(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000915}
916
Ezio Melottiac53ab62010-12-18 14:59:43 +0000917static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200918mappingproxy_repr(mappingproxyobject *pp)
Ezio Melottiac53ab62010-12-18 14:59:43 +0000919{
Victor Stinner0db176f2012-04-16 00:16:30 +0200920 return PyUnicode_FromFormat("mappingproxy(%R)", pp->mapping);
Ezio Melottiac53ab62010-12-18 14:59:43 +0000921}
922
Guido van Rossum048eb752001-10-02 21:24:57 +0000923static int
Victor Stinner0db176f2012-04-16 00:16:30 +0200924mappingproxy_traverse(PyObject *self, visitproc visit, void *arg)
Guido van Rossum048eb752001-10-02 21:24:57 +0000925{
Victor Stinner0db176f2012-04-16 00:16:30 +0200926 mappingproxyobject *pp = (mappingproxyobject *)self;
927 Py_VISIT(pp->mapping);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000928 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +0000929}
930
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000931static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200932mappingproxy_richcompare(mappingproxyobject *v, PyObject *w, int op)
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000933{
Victor Stinner0db176f2012-04-16 00:16:30 +0200934 return PyObject_RichCompare(v->mapping, w, op);
935}
936
937static int
938mappingproxy_check_mapping(PyObject *mapping)
939{
940 if (!PyMapping_Check(mapping)
941 || PyList_Check(mapping)
942 || PyTuple_Check(mapping)) {
943 PyErr_Format(PyExc_TypeError,
944 "mappingproxy() argument must be a mapping, not %s",
945 Py_TYPE(mapping)->tp_name);
946 return -1;
947 }
948 return 0;
949}
950
Serhiy Storchaka18b250f2017-03-19 08:51:07 +0200951/*[clinic input]
952@classmethod
953mappingproxy.__new__ as mappingproxy_new
Victor Stinner0db176f2012-04-16 00:16:30 +0200954
Serhiy Storchaka18b250f2017-03-19 08:51:07 +0200955 mapping: object
956
957[clinic start generated code]*/
958
959static PyObject *
960mappingproxy_new_impl(PyTypeObject *type, PyObject *mapping)
961/*[clinic end generated code: output=65f27f02d5b68fa7 input=d2d620d4f598d4f8]*/
962{
963 mappingproxyobject *mappingproxy;
Victor Stinner0db176f2012-04-16 00:16:30 +0200964
965 if (mappingproxy_check_mapping(mapping) == -1)
966 return NULL;
967
968 mappingproxy = PyObject_GC_New(mappingproxyobject, &PyDictProxy_Type);
969 if (mappingproxy == NULL)
970 return NULL;
971 Py_INCREF(mapping);
972 mappingproxy->mapping = mapping;
973 _PyObject_GC_TRACK(mappingproxy);
974 return (PyObject *)mappingproxy;
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000975}
976
Tim Peters6d6c1a32001-08-02 04:15:00 +0000977PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200978PyDictProxy_New(PyObject *mapping)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000979{
Victor Stinner0db176f2012-04-16 00:16:30 +0200980 mappingproxyobject *pp;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000981
Victor Stinner0db176f2012-04-16 00:16:30 +0200982 if (mappingproxy_check_mapping(mapping) == -1)
983 return NULL;
984
985 pp = PyObject_GC_New(mappingproxyobject, &PyDictProxy_Type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000986 if (pp != NULL) {
Victor Stinner0db176f2012-04-16 00:16:30 +0200987 Py_INCREF(mapping);
988 pp->mapping = mapping;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000989 _PyObject_GC_TRACK(pp);
990 }
991 return (PyObject *)pp;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000992}
993
994
995/* --- Wrapper object for "slot" methods --- */
996
997/* This has no reason to be in this file except that adding new files is a
998 bit of a pain */
999
1000typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001001 PyObject_HEAD
1002 PyWrapperDescrObject *descr;
1003 PyObject *self;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001004} wrapperobject;
1005
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001006#define Wrapper_Check(v) (Py_TYPE(v) == &_PyMethodWrapper_Type)
Mark Dickinson211c6252009-02-01 10:28:51 +00001007
Tim Peters6d6c1a32001-08-02 04:15:00 +00001008static void
1009wrapper_dealloc(wrapperobject *wp)
1010{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001011 PyObject_GC_UnTrack(wp);
1012 Py_TRASHCAN_SAFE_BEGIN(wp)
1013 Py_XDECREF(wp->descr);
1014 Py_XDECREF(wp->self);
1015 PyObject_GC_Del(wp);
1016 Py_TRASHCAN_SAFE_END(wp)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001017}
1018
Mark Dickinson211c6252009-02-01 10:28:51 +00001019#define TEST_COND(cond) ((cond) ? Py_True : Py_False)
1020
1021static PyObject *
1022wrapper_richcompare(PyObject *a, PyObject *b, int op)
Armin Rigoc6686b72005-11-07 08:38:00 +00001023{
Benjamin Petersonca470632016-09-06 13:47:26 -07001024 intptr_t result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001025 PyObject *v;
1026 PyWrapperDescrObject *a_descr, *b_descr;
Mark Dickinson211c6252009-02-01 10:28:51 +00001027
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001028 assert(a != NULL && b != NULL);
Mark Dickinson211c6252009-02-01 10:28:51 +00001029
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001030 /* both arguments should be wrapperobjects */
1031 if (!Wrapper_Check(a) || !Wrapper_Check(b)) {
1032 v = Py_NotImplemented;
1033 Py_INCREF(v);
1034 return v;
1035 }
Mark Dickinson211c6252009-02-01 10:28:51 +00001036
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001037 /* compare by descriptor address; if the descriptors are the same,
1038 compare by the objects they're bound to */
1039 a_descr = ((wrapperobject *)a)->descr;
1040 b_descr = ((wrapperobject *)b)->descr;
1041 if (a_descr == b_descr) {
1042 a = ((wrapperobject *)a)->self;
1043 b = ((wrapperobject *)b)->self;
1044 return PyObject_RichCompare(a, b, op);
1045 }
Mark Dickinson211c6252009-02-01 10:28:51 +00001046
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001047 result = a_descr - b_descr;
1048 switch (op) {
1049 case Py_EQ:
1050 v = TEST_COND(result == 0);
1051 break;
1052 case Py_NE:
1053 v = TEST_COND(result != 0);
1054 break;
1055 case Py_LE:
1056 v = TEST_COND(result <= 0);
1057 break;
1058 case Py_GE:
1059 v = TEST_COND(result >= 0);
1060 break;
1061 case Py_LT:
1062 v = TEST_COND(result < 0);
1063 break;
1064 case Py_GT:
1065 v = TEST_COND(result > 0);
1066 break;
1067 default:
1068 PyErr_BadArgument();
1069 return NULL;
1070 }
1071 Py_INCREF(v);
1072 return v;
Armin Rigoc6686b72005-11-07 08:38:00 +00001073}
1074
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001075static Py_hash_t
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001076wrapper_hash(wrapperobject *wp)
1077{
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001078 Py_hash_t x, y;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001079 x = _Py_HashPointer(wp->descr);
1080 if (x == -1)
1081 return -1;
1082 y = PyObject_Hash(wp->self);
1083 if (y == -1)
1084 return -1;
1085 x = x ^ y;
1086 if (x == -1)
1087 x = -2;
1088 return x;
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001089}
1090
Armin Rigoc6686b72005-11-07 08:38:00 +00001091static PyObject *
1092wrapper_repr(wrapperobject *wp)
1093{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001094 return PyUnicode_FromFormat("<method-wrapper '%s' of %s object at %p>",
1095 wp->descr->d_base->name,
1096 wp->self->ob_type->tp_name,
1097 wp->self);
Armin Rigoc6686b72005-11-07 08:38:00 +00001098}
1099
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001100static PyObject *
1101wrapper_reduce(wrapperobject *wp)
1102{
1103 PyObject *builtins;
1104 PyObject *getattr;
1105 _Py_IDENTIFIER(getattr);
1106
1107 builtins = PyEval_GetBuiltins();
1108 getattr = _PyDict_GetItemId(builtins, &PyId_getattr);
1109 return Py_BuildValue("O(OO)", getattr, wp->self, PyDescr_NAME(wp->descr));
1110}
1111
1112static PyMethodDef wrapper_methods[] = {
1113 {"__reduce__", (PyCFunction)wrapper_reduce, METH_NOARGS, NULL},
1114 {NULL, NULL}
1115};
1116
Armin Rigoc6686b72005-11-07 08:38:00 +00001117static PyMemberDef wrapper_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001118 {"__self__", T_OBJECT, offsetof(wrapperobject, self), READONLY},
1119 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001120};
1121
1122static PyObject *
Armin Rigoc6686b72005-11-07 08:38:00 +00001123wrapper_objclass(wrapperobject *wp)
1124{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001125 PyObject *c = (PyObject *)PyDescr_TYPE(wp->descr);
Armin Rigoc6686b72005-11-07 08:38:00 +00001126
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001127 Py_INCREF(c);
1128 return c;
Armin Rigoc6686b72005-11-07 08:38:00 +00001129}
1130
1131static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001132wrapper_name(wrapperobject *wp)
1133{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001134 const char *s = wp->descr->d_base->name;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001135
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001136 return PyUnicode_FromString(s);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001137}
1138
1139static PyObject *
Larry Hastings5c661892014-01-24 06:17:25 -08001140wrapper_doc(wrapperobject *wp, void *closure)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001141{
Larry Hastings2623c8c2014-02-08 22:15:29 -08001142 return _PyType_GetDocFromInternalDoc(wp->descr->d_base->name, wp->descr->d_base->doc);
Larry Hastings5c661892014-01-24 06:17:25 -08001143}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001144
Larry Hastings5c661892014-01-24 06:17:25 -08001145static PyObject *
1146wrapper_text_signature(wrapperobject *wp, void *closure)
1147{
Larry Hastings2623c8c2014-02-08 22:15:29 -08001148 return _PyType_GetTextSignatureFromInternalDoc(wp->descr->d_base->name, wp->descr->d_base->doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001149}
1150
Antoine Pitrou9d574812011-12-12 13:47:25 +01001151static PyObject *
1152wrapper_qualname(wrapperobject *wp)
1153{
1154 return descr_get_qualname((PyDescrObject *)wp->descr);
1155}
1156
Guido van Rossum32d34c82001-09-20 21:45:26 +00001157static PyGetSetDef wrapper_getsets[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001158 {"__objclass__", (getter)wrapper_objclass},
1159 {"__name__", (getter)wrapper_name},
Antoine Pitrou9d574812011-12-12 13:47:25 +01001160 {"__qualname__", (getter)wrapper_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001161 {"__doc__", (getter)wrapper_doc},
Larry Hastings5c661892014-01-24 06:17:25 -08001162 {"__text_signature__", (getter)wrapper_text_signature},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001163 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001164};
1165
1166static PyObject *
1167wrapper_call(wrapperobject *wp, PyObject *args, PyObject *kwds)
1168{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001169 wrapperfunc wrapper = wp->descr->d_base->wrapper;
1170 PyObject *self = wp->self;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001171
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001172 if (wp->descr->d_base->flags & PyWrapperFlag_KEYWORDS) {
1173 wrapperfunc_kwds wk = (wrapperfunc_kwds)wrapper;
1174 return (*wk)(self, args, wp->descr->d_wrapped, kwds);
1175 }
Guido van Rossumc8e56452001-10-22 00:43:43 +00001176
Serhiy Storchaka5ab81d72016-12-16 16:18:57 +02001177 if (kwds != NULL && (!PyDict_Check(kwds) || PyDict_GET_SIZE(kwds) != 0)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001178 PyErr_Format(PyExc_TypeError,
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001179 "wrapper %s() takes no keyword arguments",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001180 wp->descr->d_base->name);
1181 return NULL;
1182 }
1183 return (*wrapper)(self, args, wp->descr->d_wrapped);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001184}
1185
Guido van Rossum048eb752001-10-02 21:24:57 +00001186static int
1187wrapper_traverse(PyObject *self, visitproc visit, void *arg)
1188{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001189 wrapperobject *wp = (wrapperobject *)self;
1190 Py_VISIT(wp->descr);
1191 Py_VISIT(wp->self);
1192 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +00001193}
1194
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001195PyTypeObject _PyMethodWrapper_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001196 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1197 "method-wrapper", /* tp_name */
1198 sizeof(wrapperobject), /* tp_basicsize */
1199 0, /* tp_itemsize */
1200 /* methods */
1201 (destructor)wrapper_dealloc, /* tp_dealloc */
1202 0, /* tp_print */
1203 0, /* tp_getattr */
1204 0, /* tp_setattr */
1205 0, /* tp_reserved */
1206 (reprfunc)wrapper_repr, /* tp_repr */
1207 0, /* tp_as_number */
1208 0, /* tp_as_sequence */
1209 0, /* tp_as_mapping */
1210 (hashfunc)wrapper_hash, /* tp_hash */
1211 (ternaryfunc)wrapper_call, /* tp_call */
1212 0, /* tp_str */
1213 PyObject_GenericGetAttr, /* tp_getattro */
1214 0, /* tp_setattro */
1215 0, /* tp_as_buffer */
1216 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
1217 0, /* tp_doc */
1218 wrapper_traverse, /* tp_traverse */
1219 0, /* tp_clear */
1220 wrapper_richcompare, /* tp_richcompare */
1221 0, /* tp_weaklistoffset */
1222 0, /* tp_iter */
1223 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001224 wrapper_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001225 wrapper_members, /* tp_members */
1226 wrapper_getsets, /* tp_getset */
1227 0, /* tp_base */
1228 0, /* tp_dict */
1229 0, /* tp_descr_get */
1230 0, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001231};
1232
1233PyObject *
1234PyWrapper_New(PyObject *d, PyObject *self)
1235{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001236 wrapperobject *wp;
1237 PyWrapperDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001238
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001239 assert(PyObject_TypeCheck(d, &PyWrapperDescr_Type));
1240 descr = (PyWrapperDescrObject *)d;
Victor Stinner3249dec2011-05-01 23:19:15 +02001241 assert(_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self),
Victor Stinnerd9561312011-05-01 23:31:36 +02001242 (PyObject *)PyDescr_TYPE(descr)));
Tim Peters6d6c1a32001-08-02 04:15:00 +00001243
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001244 wp = PyObject_GC_New(wrapperobject, &_PyMethodWrapper_Type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001245 if (wp != NULL) {
1246 Py_INCREF(descr);
1247 wp->descr = descr;
1248 Py_INCREF(self);
1249 wp->self = self;
1250 _PyObject_GC_TRACK(wp);
1251 }
1252 return (PyObject *)wp;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001253}
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001254
1255
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001256/* A built-in 'property' type */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001257
1258/*
Serhiy Storchakad741a882015-06-11 00:06:39 +03001259class property(object):
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001260
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001261 def __init__(self, fget=None, fset=None, fdel=None, doc=None):
1262 if doc is None and fget is not None and hasattr(fget, "__doc__"):
Serhiy Storchakad741a882015-06-11 00:06:39 +03001263 doc = fget.__doc__
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001264 self.__get = fget
1265 self.__set = fset
1266 self.__del = fdel
1267 self.__doc__ = doc
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001268
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001269 def __get__(self, inst, type=None):
1270 if inst is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001271 return self
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001272 if self.__get is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001273 raise AttributeError, "unreadable attribute"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001274 return self.__get(inst)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001275
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001276 def __set__(self, inst, value):
1277 if self.__set is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001278 raise AttributeError, "can't set attribute"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001279 return self.__set(inst, value)
Guido van Rossumba2485f2001-12-10 18:03:34 +00001280
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001281 def __delete__(self, inst):
1282 if self.__del is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001283 raise AttributeError, "can't delete attribute"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001284 return self.__del(inst)
Guido van Rossumba2485f2001-12-10 18:03:34 +00001285
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001286*/
1287
1288typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001289 PyObject_HEAD
1290 PyObject *prop_get;
1291 PyObject *prop_set;
1292 PyObject *prop_del;
1293 PyObject *prop_doc;
1294 int getter_doc;
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001295} propertyobject;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001296
Christian Heimes0449f632007-12-15 01:27:15 +00001297static PyObject * property_copy(PyObject *, PyObject *, PyObject *,
Benjamin Peterson93964832010-06-28 03:07:10 +00001298 PyObject *);
Christian Heimes0449f632007-12-15 01:27:15 +00001299
Tim Peters66c1a522001-09-24 21:17:50 +00001300static PyMemberDef property_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001301 {"fget", T_OBJECT, offsetof(propertyobject, prop_get), READONLY},
1302 {"fset", T_OBJECT, offsetof(propertyobject, prop_set), READONLY},
1303 {"fdel", T_OBJECT, offsetof(propertyobject, prop_del), READONLY},
Raymond Hettingereac503a2015-05-13 01:09:59 -07001304 {"__doc__", T_OBJECT, offsetof(propertyobject, prop_doc), 0},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001305 {0}
Tim Peters66c1a522001-09-24 21:17:50 +00001306};
1307
Christian Heimes0449f632007-12-15 01:27:15 +00001308
Guido van Rossum58da9312007-11-10 23:39:45 +00001309PyDoc_STRVAR(getter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001310 "Descriptor to change the getter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001311
Neal Norwitz32dde222008-04-15 06:43:13 +00001312static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001313property_getter(PyObject *self, PyObject *getter)
1314{
Benjamin Peterson93964832010-06-28 03:07:10 +00001315 return property_copy(self, getter, NULL, NULL);
Guido van Rossum58da9312007-11-10 23:39:45 +00001316}
1317
Christian Heimes0449f632007-12-15 01:27:15 +00001318
Guido van Rossum58da9312007-11-10 23:39:45 +00001319PyDoc_STRVAR(setter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001320 "Descriptor to change the setter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001321
Neal Norwitz32dde222008-04-15 06:43:13 +00001322static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001323property_setter(PyObject *self, PyObject *setter)
1324{
Benjamin Peterson93964832010-06-28 03:07:10 +00001325 return property_copy(self, NULL, setter, NULL);
Guido van Rossum58da9312007-11-10 23:39:45 +00001326}
1327
Christian Heimes0449f632007-12-15 01:27:15 +00001328
Guido van Rossum58da9312007-11-10 23:39:45 +00001329PyDoc_STRVAR(deleter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001330 "Descriptor to change the deleter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001331
Neal Norwitz32dde222008-04-15 06:43:13 +00001332static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001333property_deleter(PyObject *self, PyObject *deleter)
1334{
Benjamin Peterson93964832010-06-28 03:07:10 +00001335 return property_copy(self, NULL, NULL, deleter);
Guido van Rossum58da9312007-11-10 23:39:45 +00001336}
1337
1338
Guido van Rossum58da9312007-11-10 23:39:45 +00001339static PyMethodDef property_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001340 {"getter", property_getter, METH_O, getter_doc},
1341 {"setter", property_setter, METH_O, setter_doc},
1342 {"deleter", property_deleter, METH_O, deleter_doc},
1343 {0}
Guido van Rossum58da9312007-11-10 23:39:45 +00001344};
1345
Tim Peters66c1a522001-09-24 21:17:50 +00001346
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001347static void
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001348property_dealloc(PyObject *self)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001349{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001350 propertyobject *gs = (propertyobject *)self;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001351
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001352 _PyObject_GC_UNTRACK(self);
1353 Py_XDECREF(gs->prop_get);
1354 Py_XDECREF(gs->prop_set);
1355 Py_XDECREF(gs->prop_del);
1356 Py_XDECREF(gs->prop_doc);
1357 self->ob_type->tp_free(self);
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001358}
1359
1360static PyObject *
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001361property_descr_get(PyObject *self, PyObject *obj, PyObject *type)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001362{
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001363 static PyObject * volatile cached_args = NULL;
1364 PyObject *args;
Raymond Hettingerc4e335b2015-04-30 08:08:13 -07001365 PyObject *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001366 propertyobject *gs = (propertyobject *)self;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001367
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001368 if (obj == NULL || obj == Py_None) {
1369 Py_INCREF(self);
1370 return self;
1371 }
1372 if (gs->prop_get == NULL) {
1373 PyErr_SetString(PyExc_AttributeError, "unreadable attribute");
1374 return NULL;
1375 }
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001376 args = cached_args;
Serhiy Storchaka7822f152016-05-04 21:42:05 +03001377 cached_args = NULL;
1378 if (!args) {
1379 args = PyTuple_New(1);
1380 if (!args)
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001381 return NULL;
Serhiy Storchaka7822f152016-05-04 21:42:05 +03001382 _PyObject_GC_UNTRACK(args);
Raymond Hettingerc4e335b2015-04-30 08:08:13 -07001383 }
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001384 Py_INCREF(obj);
Raymond Hettingerc4e335b2015-04-30 08:08:13 -07001385 PyTuple_SET_ITEM(args, 0, obj);
1386 ret = PyObject_Call(gs->prop_get, args, NULL);
Serhiy Storchaka7822f152016-05-04 21:42:05 +03001387 if (cached_args == NULL && Py_REFCNT(args) == 1) {
Serhiy Storchakafff9a312017-03-21 08:53:25 +02001388 assert(PyTuple_GET_SIZE(args) == 1);
Serhiy Storchaka7822f152016-05-04 21:42:05 +03001389 assert(PyTuple_GET_ITEM(args, 0) == obj);
1390 cached_args = args;
1391 Py_DECREF(obj);
Serhiy Storchakaa7a0ad62015-05-24 21:38:06 +03001392 }
Serhiy Storchaka7822f152016-05-04 21:42:05 +03001393 else {
1394 assert(Py_REFCNT(args) >= 1);
1395 _PyObject_GC_TRACK(args);
1396 Py_DECREF(args);
1397 }
Raymond Hettingerc4e335b2015-04-30 08:08:13 -07001398 return ret;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001399}
1400
1401static int
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001402property_descr_set(PyObject *self, PyObject *obj, PyObject *value)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001403{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001404 propertyobject *gs = (propertyobject *)self;
1405 PyObject *func, *res;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001406
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001407 if (value == NULL)
1408 func = gs->prop_del;
1409 else
1410 func = gs->prop_set;
1411 if (func == NULL) {
1412 PyErr_SetString(PyExc_AttributeError,
1413 value == NULL ?
1414 "can't delete attribute" :
1415 "can't set attribute");
1416 return -1;
1417 }
1418 if (value == NULL)
Victor Stinnerde4ae3d2016-12-04 22:59:09 +01001419 res = PyObject_CallFunctionObjArgs(func, obj, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001420 else
Benjamin Peterson9b955de2010-12-07 04:04:02 +00001421 res = PyObject_CallFunctionObjArgs(func, obj, value, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001422 if (res == NULL)
1423 return -1;
1424 Py_DECREF(res);
1425 return 0;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001426}
1427
Christian Heimes0449f632007-12-15 01:27:15 +00001428static PyObject *
Benjamin Peterson93964832010-06-28 03:07:10 +00001429property_copy(PyObject *old, PyObject *get, PyObject *set, PyObject *del)
Christian Heimes0449f632007-12-15 01:27:15 +00001430{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001431 propertyobject *pold = (propertyobject *)old;
Benjamin Peterson93964832010-06-28 03:07:10 +00001432 PyObject *new, *type, *doc;
Christian Heimes0449f632007-12-15 01:27:15 +00001433
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001434 type = PyObject_Type(old);
1435 if (type == NULL)
1436 return NULL;
Christian Heimes0449f632007-12-15 01:27:15 +00001437
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001438 if (get == NULL || get == Py_None) {
1439 Py_XDECREF(get);
1440 get = pold->prop_get ? pold->prop_get : Py_None;
1441 }
1442 if (set == NULL || set == Py_None) {
1443 Py_XDECREF(set);
1444 set = pold->prop_set ? pold->prop_set : Py_None;
1445 }
1446 if (del == NULL || del == Py_None) {
1447 Py_XDECREF(del);
1448 del = pold->prop_del ? pold->prop_del : Py_None;
1449 }
Benjamin Peterson93964832010-06-28 03:07:10 +00001450 if (pold->getter_doc && get != Py_None) {
1451 /* make _init use __doc__ from getter */
1452 doc = Py_None;
1453 }
1454 else {
1455 doc = pold->prop_doc ? pold->prop_doc : Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001456 }
R. David Murrayb18500d2009-05-04 22:59:07 +00001457
Victor Stinner5abaa2b2016-12-09 16:22:32 +01001458 new = PyObject_CallFunctionObjArgs(type, get, set, del, doc, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001459 Py_DECREF(type);
1460 if (new == NULL)
1461 return NULL;
1462 return new;
Christian Heimes0449f632007-12-15 01:27:15 +00001463}
1464
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001465/*[clinic input]
1466property.__init__ as property_init
1467
1468 fget: object(c_default="NULL") = None
1469 function to be used for getting an attribute value
1470 fset: object(c_default="NULL") = None
1471 function to be used for setting an attribute value
1472 fdel: object(c_default="NULL") = None
1473 function to be used for del'ing an attribute
1474 doc: object(c_default="NULL") = None
1475 docstring
1476
1477Property attribute.
1478
1479Typical use is to define a managed attribute x:
1480
1481class C(object):
1482 def getx(self): return self._x
1483 def setx(self, value): self._x = value
1484 def delx(self): del self._x
1485 x = property(getx, setx, delx, "I'm the 'x' property.")
1486
1487Decorators make defining new properties or modifying existing ones easy:
1488
1489class C(object):
1490 @property
1491 def x(self):
1492 "I am the 'x' property."
1493 return self._x
1494 @x.setter
1495 def x(self, value):
1496 self._x = value
1497 @x.deleter
1498 def x(self):
1499 del self._x
1500[clinic start generated code]*/
1501
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001502static int
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001503property_init_impl(propertyobject *self, PyObject *fget, PyObject *fset,
1504 PyObject *fdel, PyObject *doc)
1505/*[clinic end generated code: output=01a960742b692b57 input=dfb5dbbffc6932d5]*/
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001506{
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001507 if (fget == Py_None)
1508 fget = NULL;
1509 if (fset == Py_None)
1510 fset = NULL;
1511 if (fdel == Py_None)
1512 fdel = NULL;
Tim Peters66c1a522001-09-24 21:17:50 +00001513
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001514 Py_XINCREF(fget);
1515 Py_XINCREF(fset);
1516 Py_XINCREF(fdel);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001517 Py_XINCREF(doc);
Christian Heimes0449f632007-12-15 01:27:15 +00001518
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001519 self->prop_get = fget;
1520 self->prop_set = fset;
1521 self->prop_del = fdel;
1522 self->prop_doc = doc;
1523 self->getter_doc = 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001524
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001525 /* if no docstring given and the getter has one, use that one */
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001526 if ((doc == NULL || doc == Py_None) && fget != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001527 _Py_IDENTIFIER(__doc__);
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001528 PyObject *get_doc = _PyObject_GetAttrId(fget, &PyId___doc__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001529 if (get_doc) {
1530 if (Py_TYPE(self) == &PyProperty_Type) {
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001531 Py_XSETREF(self->prop_doc, get_doc);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001532 }
1533 else {
1534 /* If this is a property subclass, put __doc__
1535 in dict of the subclass instance instead,
1536 otherwise it gets shadowed by __doc__ in the
1537 class's dict. */
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001538 int err = _PyObject_SetAttrId((PyObject *)self, &PyId___doc__, get_doc);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001539 Py_DECREF(get_doc);
1540 if (err < 0)
1541 return -1;
1542 }
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001543 self->getter_doc = 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001544 }
1545 else if (PyErr_ExceptionMatches(PyExc_Exception)) {
1546 PyErr_Clear();
1547 }
1548 else {
1549 return -1;
1550 }
1551 }
1552
1553 return 0;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001554}
1555
Benjamin Petersonbfebb7b2011-12-15 15:34:02 -05001556static PyObject *
1557property_get___isabstractmethod__(propertyobject *prop, void *closure)
1558{
1559 int res = _PyObject_IsAbstract(prop->prop_get);
1560 if (res == -1) {
1561 return NULL;
1562 }
1563 else if (res) {
1564 Py_RETURN_TRUE;
1565 }
1566
1567 res = _PyObject_IsAbstract(prop->prop_set);
1568 if (res == -1) {
1569 return NULL;
1570 }
1571 else if (res) {
1572 Py_RETURN_TRUE;
1573 }
1574
1575 res = _PyObject_IsAbstract(prop->prop_del);
1576 if (res == -1) {
1577 return NULL;
1578 }
1579 else if (res) {
1580 Py_RETURN_TRUE;
1581 }
1582 Py_RETURN_FALSE;
1583}
1584
1585static PyGetSetDef property_getsetlist[] = {
1586 {"__isabstractmethod__",
1587 (getter)property_get___isabstractmethod__, NULL,
1588 NULL,
1589 NULL},
1590 {NULL} /* Sentinel */
1591};
1592
Guido van Rossum048eb752001-10-02 21:24:57 +00001593static int
1594property_traverse(PyObject *self, visitproc visit, void *arg)
1595{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001596 propertyobject *pp = (propertyobject *)self;
1597 Py_VISIT(pp->prop_get);
1598 Py_VISIT(pp->prop_set);
1599 Py_VISIT(pp->prop_del);
1600 Py_VISIT(pp->prop_doc);
1601 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +00001602}
1603
Raymond Hettingerd4be6912015-05-13 11:12:33 -07001604static int
1605property_clear(PyObject *self)
1606{
1607 propertyobject *pp = (propertyobject *)self;
1608 Py_CLEAR(pp->prop_doc);
1609 return 0;
1610}
1611
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001612#include "clinic/descrobject.c.h"
1613
1614PyTypeObject PyDictProxy_Type = {
1615 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1616 "mappingproxy", /* tp_name */
1617 sizeof(mappingproxyobject), /* tp_basicsize */
1618 0, /* tp_itemsize */
1619 /* methods */
1620 (destructor)mappingproxy_dealloc, /* tp_dealloc */
1621 0, /* tp_print */
1622 0, /* tp_getattr */
1623 0, /* tp_setattr */
1624 0, /* tp_reserved */
1625 (reprfunc)mappingproxy_repr, /* tp_repr */
1626 0, /* tp_as_number */
1627 &mappingproxy_as_sequence, /* tp_as_sequence */
1628 &mappingproxy_as_mapping, /* tp_as_mapping */
1629 0, /* tp_hash */
1630 0, /* tp_call */
1631 (reprfunc)mappingproxy_str, /* tp_str */
1632 PyObject_GenericGetAttr, /* tp_getattro */
1633 0, /* tp_setattro */
1634 0, /* tp_as_buffer */
1635 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
1636 0, /* tp_doc */
1637 mappingproxy_traverse, /* tp_traverse */
1638 0, /* tp_clear */
1639 (richcmpfunc)mappingproxy_richcompare, /* tp_richcompare */
1640 0, /* tp_weaklistoffset */
1641 (getiterfunc)mappingproxy_getiter, /* tp_iter */
1642 0, /* tp_iternext */
1643 mappingproxy_methods, /* tp_methods */
1644 0, /* tp_members */
1645 0, /* tp_getset */
1646 0, /* tp_base */
1647 0, /* tp_dict */
1648 0, /* tp_descr_get */
1649 0, /* tp_descr_set */
1650 0, /* tp_dictoffset */
1651 0, /* tp_init */
1652 0, /* tp_alloc */
1653 mappingproxy_new, /* tp_new */
1654};
1655
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001656PyTypeObject PyProperty_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001657 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1658 "property", /* tp_name */
1659 sizeof(propertyobject), /* tp_basicsize */
1660 0, /* tp_itemsize */
1661 /* methods */
1662 property_dealloc, /* tp_dealloc */
1663 0, /* tp_print */
1664 0, /* tp_getattr */
1665 0, /* tp_setattr */
1666 0, /* tp_reserved */
1667 0, /* tp_repr */
1668 0, /* tp_as_number */
1669 0, /* tp_as_sequence */
1670 0, /* tp_as_mapping */
1671 0, /* tp_hash */
1672 0, /* tp_call */
1673 0, /* tp_str */
1674 PyObject_GenericGetAttr, /* tp_getattro */
1675 0, /* tp_setattro */
1676 0, /* tp_as_buffer */
1677 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
1678 Py_TPFLAGS_BASETYPE, /* tp_flags */
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001679 property_init__doc__, /* tp_doc */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001680 property_traverse, /* tp_traverse */
Raymond Hettingerd4be6912015-05-13 11:12:33 -07001681 (inquiry)property_clear, /* tp_clear */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001682 0, /* tp_richcompare */
1683 0, /* tp_weaklistoffset */
1684 0, /* tp_iter */
1685 0, /* tp_iternext */
1686 property_methods, /* tp_methods */
1687 property_members, /* tp_members */
Benjamin Petersonbfebb7b2011-12-15 15:34:02 -05001688 property_getsetlist, /* tp_getset */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001689 0, /* tp_base */
1690 0, /* tp_dict */
1691 property_descr_get, /* tp_descr_get */
1692 property_descr_set, /* tp_descr_set */
1693 0, /* tp_dictoffset */
1694 property_init, /* tp_init */
1695 PyType_GenericAlloc, /* tp_alloc */
1696 PyType_GenericNew, /* tp_new */
1697 PyObject_GC_Del, /* tp_free */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001698};