blob: 22546a563a51c0827bf52d9dfa35363bc4be7057 [file] [log] [blame]
Tim Peters6d6c1a32001-08-02 04:15:00 +00001/* Descriptors -- a new, flexible way to describe attributes */
2
3#include "Python.h"
Victor Stinnerbcda8f12018-11-21 22:27:47 +01004#include "pycore_object.h"
Victor Stinner621cebe2018-11-12 16:53:38 +01005#include "pycore_pystate.h"
Victor Stinnerec13b932018-11-25 23:56:17 +01006#include "pycore_tupleobject.h"
Tim Peters6d6c1a32001-08-02 04:15:00 +00007#include "structmember.h" /* Why is this not included in Python.h? */
8
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02009/*[clinic input]
10class mappingproxy "mappingproxyobject *" "&PyDictProxy_Type"
11class property "propertyobject *" "&PyProperty_Type"
12[clinic start generated code]*/
13/*[clinic end generated code: output=da39a3ee5e6b4b0d input=556352653fd4c02e]*/
14
Tim Peters6d6c1a32001-08-02 04:15:00 +000015static void
16descr_dealloc(PyDescrObject *descr)
17{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000018 _PyObject_GC_UNTRACK(descr);
19 Py_XDECREF(descr->d_type);
20 Py_XDECREF(descr->d_name);
Antoine Pitrou9d574812011-12-12 13:47:25 +010021 Py_XDECREF(descr->d_qualname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000022 PyObject_GC_Del(descr);
Tim Peters6d6c1a32001-08-02 04:15:00 +000023}
24
Walter Dörwaldd7fb7642007-06-11 16:36:59 +000025static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +000026descr_name(PyDescrObject *descr)
27{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000028 if (descr->d_name != NULL && PyUnicode_Check(descr->d_name))
29 return descr->d_name;
30 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +000031}
32
33static PyObject *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020034descr_repr(PyDescrObject *descr, const char *format)
Tim Peters6d6c1a32001-08-02 04:15:00 +000035{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000036 PyObject *name = NULL;
37 if (descr->d_name != NULL && PyUnicode_Check(descr->d_name))
38 name = descr->d_name;
Walter Dörwaldd7fb7642007-06-11 16:36:59 +000039
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000040 return PyUnicode_FromFormat(format, name, "?", descr->d_type->tp_name);
Tim Peters6d6c1a32001-08-02 04:15:00 +000041}
42
43static PyObject *
44method_repr(PyMethodDescrObject *descr)
45{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000046 return descr_repr((PyDescrObject *)descr,
47 "<method '%V' of '%s' objects>");
Tim Peters6d6c1a32001-08-02 04:15:00 +000048}
49
50static PyObject *
51member_repr(PyMemberDescrObject *descr)
52{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000053 return descr_repr((PyDescrObject *)descr,
54 "<member '%V' of '%s' objects>");
Tim Peters6d6c1a32001-08-02 04:15:00 +000055}
56
57static PyObject *
58getset_repr(PyGetSetDescrObject *descr)
59{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000060 return descr_repr((PyDescrObject *)descr,
61 "<attribute '%V' of '%s' objects>");
Tim Peters6d6c1a32001-08-02 04:15:00 +000062}
63
64static PyObject *
Armin Rigoc6686b72005-11-07 08:38:00 +000065wrapperdescr_repr(PyWrapperDescrObject *descr)
Tim Peters6d6c1a32001-08-02 04:15:00 +000066{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000067 return descr_repr((PyDescrObject *)descr,
68 "<slot wrapper '%V' of '%s' objects>");
Tim Peters6d6c1a32001-08-02 04:15:00 +000069}
70
71static int
Guido van Rossumb6e5a0c2003-02-11 18:44:42 +000072descr_check(PyDescrObject *descr, PyObject *obj, PyObject **pres)
Tim Peters6d6c1a32001-08-02 04:15:00 +000073{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000074 if (obj == NULL) {
75 Py_INCREF(descr);
76 *pres = (PyObject *)descr;
77 return 1;
78 }
79 if (!PyObject_TypeCheck(obj, descr->d_type)) {
80 PyErr_Format(PyExc_TypeError,
81 "descriptor '%V' for '%s' objects "
82 "doesn't apply to '%s' object",
83 descr_name((PyDescrObject *)descr), "?",
84 descr->d_type->tp_name,
85 obj->ob_type->tp_name);
86 *pres = NULL;
87 return 1;
88 }
89 return 0;
Tim Peters6d6c1a32001-08-02 04:15:00 +000090}
91
92static PyObject *
Guido van Rossumb6e5a0c2003-02-11 18:44:42 +000093classmethod_get(PyMethodDescrObject *descr, PyObject *obj, PyObject *type)
Tim Petersbca1cbc2002-12-09 22:56:13 +000094{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000095 /* Ensure a valid type. Class methods ignore obj. */
96 if (type == NULL) {
97 if (obj != NULL)
98 type = (PyObject *)obj->ob_type;
99 else {
100 /* Wot - no type?! */
101 PyErr_Format(PyExc_TypeError,
102 "descriptor '%V' for type '%s' "
103 "needs either an object or a type",
104 descr_name((PyDescrObject *)descr), "?",
105 PyDescr_TYPE(descr)->tp_name);
106 return NULL;
107 }
108 }
109 if (!PyType_Check(type)) {
110 PyErr_Format(PyExc_TypeError,
111 "descriptor '%V' for type '%s' "
112 "needs a type, not a '%s' as arg 2",
113 descr_name((PyDescrObject *)descr), "?",
114 PyDescr_TYPE(descr)->tp_name,
115 type->ob_type->tp_name);
116 return NULL;
117 }
118 if (!PyType_IsSubtype((PyTypeObject *)type, PyDescr_TYPE(descr))) {
119 PyErr_Format(PyExc_TypeError,
120 "descriptor '%V' for type '%s' "
121 "doesn't apply to type '%s'",
122 descr_name((PyDescrObject *)descr), "?",
123 PyDescr_TYPE(descr)->tp_name,
124 ((PyTypeObject *)type)->tp_name);
125 return NULL;
126 }
Andrew Svetlov3ba3a3e2012-12-25 13:32:35 +0200127 return PyCFunction_NewEx(descr->d_method, type, NULL);
Tim Petersbca1cbc2002-12-09 22:56:13 +0000128}
129
130static PyObject *
Guido van Rossumb6e5a0c2003-02-11 18:44:42 +0000131method_get(PyMethodDescrObject *descr, PyObject *obj, PyObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000132{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000133 PyObject *res;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000134
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000135 if (descr_check((PyDescrObject *)descr, obj, &res))
136 return res;
Andrew Svetlov3ba3a3e2012-12-25 13:32:35 +0200137 return PyCFunction_NewEx(descr->d_method, obj, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000138}
139
140static PyObject *
Guido van Rossumb6e5a0c2003-02-11 18:44:42 +0000141member_get(PyMemberDescrObject *descr, PyObject *obj, PyObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000142{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000143 PyObject *res;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000144
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000145 if (descr_check((PyDescrObject *)descr, obj, &res))
146 return res;
147 return PyMember_GetOne((char *)obj, descr->d_member);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000148}
149
150static PyObject *
Guido van Rossumb6e5a0c2003-02-11 18:44:42 +0000151getset_get(PyGetSetDescrObject *descr, PyObject *obj, PyObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000152{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000153 PyObject *res;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000154
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000155 if (descr_check((PyDescrObject *)descr, obj, &res))
156 return res;
157 if (descr->d_getset->get != NULL)
158 return descr->d_getset->get(obj, descr->d_getset->closure);
159 PyErr_Format(PyExc_AttributeError,
160 "attribute '%V' of '%.100s' objects is not readable",
161 descr_name((PyDescrObject *)descr), "?",
162 PyDescr_TYPE(descr)->tp_name);
163 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000164}
165
166static PyObject *
Armin Rigoc6686b72005-11-07 08:38:00 +0000167wrapperdescr_get(PyWrapperDescrObject *descr, PyObject *obj, PyObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000168{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000169 PyObject *res;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000170
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000171 if (descr_check((PyDescrObject *)descr, obj, &res))
172 return res;
173 return PyWrapper_New((PyObject *)descr, obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000174}
175
176static int
177descr_setcheck(PyDescrObject *descr, PyObject *obj, PyObject *value,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000178 int *pres)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000179{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000180 assert(obj != NULL);
181 if (!PyObject_TypeCheck(obj, descr->d_type)) {
182 PyErr_Format(PyExc_TypeError,
183 "descriptor '%V' for '%.100s' objects "
184 "doesn't apply to '%.100s' object",
185 descr_name(descr), "?",
186 descr->d_type->tp_name,
187 obj->ob_type->tp_name);
188 *pres = -1;
189 return 1;
190 }
191 return 0;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000192}
193
194static int
195member_set(PyMemberDescrObject *descr, PyObject *obj, PyObject *value)
196{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000197 int res;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000198
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000199 if (descr_setcheck((PyDescrObject *)descr, obj, value, &res))
200 return res;
201 return PyMember_SetOne((char *)obj, descr->d_member, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000202}
203
204static int
205getset_set(PyGetSetDescrObject *descr, PyObject *obj, PyObject *value)
206{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000207 int res;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000208
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000209 if (descr_setcheck((PyDescrObject *)descr, obj, value, &res))
210 return res;
211 if (descr->d_getset->set != NULL)
212 return descr->d_getset->set(obj, value,
213 descr->d_getset->closure);
214 PyErr_Format(PyExc_AttributeError,
215 "attribute '%V' of '%.100s' objects is not writable",
216 descr_name((PyDescrObject *)descr), "?",
217 PyDescr_TYPE(descr)->tp_name);
218 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000219}
220
221static PyObject *
Victor Stinnerc5257232017-01-18 10:38:09 +0100222methoddescr_call(PyMethodDescrObject *descr, PyObject *args, PyObject *kwargs)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000223{
Victor Stinnerc5257232017-01-18 10:38:09 +0100224 Py_ssize_t nargs;
225 PyObject *self, *result;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000226
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000227 /* Make sure that the first argument is acceptable as 'self' */
228 assert(PyTuple_Check(args));
Victor Stinnerc5257232017-01-18 10:38:09 +0100229 nargs = PyTuple_GET_SIZE(args);
230 if (nargs < 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000231 PyErr_Format(PyExc_TypeError,
232 "descriptor '%V' of '%.100s' "
233 "object needs an argument",
234 descr_name((PyDescrObject *)descr), "?",
235 PyDescr_TYPE(descr)->tp_name);
236 return NULL;
237 }
238 self = PyTuple_GET_ITEM(args, 0);
Victor Stinner3249dec2011-05-01 23:19:15 +0200239 if (!_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self),
Victor Stinnerd9561312011-05-01 23:31:36 +0200240 (PyObject *)PyDescr_TYPE(descr))) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000241 PyErr_Format(PyExc_TypeError,
242 "descriptor '%V' "
243 "requires a '%.100s' object "
244 "but received a '%.100s'",
245 descr_name((PyDescrObject *)descr), "?",
246 PyDescr_TYPE(descr)->tp_name,
247 self->ob_type->tp_name);
248 return NULL;
249 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000250
Victor Stinnerc5257232017-01-18 10:38:09 +0100251 result = _PyMethodDef_RawFastCallDict(descr->d_method, self,
Victor Stinnerd17a6932018-11-09 16:56:48 +0100252 &_PyTuple_ITEMS(args)[1], nargs - 1,
Victor Stinnerc5257232017-01-18 10:38:09 +0100253 kwargs);
254 result = _Py_CheckFunctionResult((PyObject *)descr, result, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000255 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000256}
257
INADA Naoki5566bbb2017-02-03 07:43:03 +0900258// same to methoddescr_call(), but use FASTCALL convention.
259PyObject *
260_PyMethodDescr_FastCallKeywords(PyObject *descrobj,
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200261 PyObject *const *args, Py_ssize_t nargs,
INADA Naoki5566bbb2017-02-03 07:43:03 +0900262 PyObject *kwnames)
263{
264 assert(Py_TYPE(descrobj) == &PyMethodDescr_Type);
265 PyMethodDescrObject *descr = (PyMethodDescrObject *)descrobj;
266 PyObject *self, *result;
267
268 /* Make sure that the first argument is acceptable as 'self' */
269 if (nargs < 1) {
270 PyErr_Format(PyExc_TypeError,
271 "descriptor '%V' of '%.100s' "
272 "object needs an argument",
273 descr_name((PyDescrObject *)descr), "?",
274 PyDescr_TYPE(descr)->tp_name);
275 return NULL;
276 }
277 self = args[0];
278 if (!_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self),
279 (PyObject *)PyDescr_TYPE(descr))) {
280 PyErr_Format(PyExc_TypeError,
281 "descriptor '%V' "
282 "requires a '%.100s' object "
283 "but received a '%.100s'",
284 descr_name((PyDescrObject *)descr), "?",
285 PyDescr_TYPE(descr)->tp_name,
286 self->ob_type->tp_name);
287 return NULL;
288 }
289
290 result = _PyMethodDef_RawFastCallKeywords(descr->d_method, self,
291 args+1, nargs-1, kwnames);
292 result = _Py_CheckFunctionResult((PyObject *)descr, result, NULL);
293 return result;
294}
295
Tim Peters6d6c1a32001-08-02 04:15:00 +0000296static PyObject *
Tim Petersbca1cbc2002-12-09 22:56:13 +0000297classmethoddescr_call(PyMethodDescrObject *descr, PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000298 PyObject *kwds)
Tim Petersbca1cbc2002-12-09 22:56:13 +0000299{
Benjamin Peterson7295c6a2012-05-01 09:51:09 -0400300 Py_ssize_t argc;
Serhiy Storchaka5e02c782017-09-21 14:25:36 +0300301 PyObject *self, *result;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000302
Benjamin Peterson7295c6a2012-05-01 09:51:09 -0400303 /* 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);
315 if (!PyType_Check(self)) {
316 PyErr_Format(PyExc_TypeError,
317 "descriptor '%V' requires a type "
318 "but received a '%.100s'",
319 descr_name((PyDescrObject *)descr), "?",
320 PyDescr_TYPE(descr)->tp_name,
321 self->ob_type->tp_name);
322 return NULL;
323 }
324 if (!PyType_IsSubtype((PyTypeObject *)self, PyDescr_TYPE(descr))) {
325 PyErr_Format(PyExc_TypeError,
326 "descriptor '%V' "
327 "requires a subtype of '%.100s' "
328 "but received '%.100s",
329 descr_name((PyDescrObject *)descr), "?",
330 PyDescr_TYPE(descr)->tp_name,
331 self->ob_type->tp_name);
332 return NULL;
333 }
334
Serhiy Storchaka5e02c782017-09-21 14:25:36 +0300335 result = _PyMethodDef_RawFastCallDict(descr->d_method, self,
Victor Stinnerd17a6932018-11-09 16:56:48 +0100336 &_PyTuple_ITEMS(args)[1], argc - 1,
Serhiy Storchaka5e02c782017-09-21 14:25:36 +0300337 kwds);
338 result = _Py_CheckFunctionResult((PyObject *)descr, result, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000339 return result;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000340}
341
Serhiy Storchaka5e02c782017-09-21 14:25:36 +0300342Py_LOCAL_INLINE(PyObject *)
343wrapperdescr_raw_call(PyWrapperDescrObject *descr, PyObject *self,
344 PyObject *args, PyObject *kwds)
345{
346 wrapperfunc wrapper = descr->d_base->wrapper;
347
348 if (descr->d_base->flags & PyWrapperFlag_KEYWORDS) {
Serhiy Storchaka1c607152018-11-27 21:34:27 +0200349 wrapperfunc_kwds wk = (wrapperfunc_kwds)(void(*)(void))wrapper;
Serhiy Storchaka5e02c782017-09-21 14:25:36 +0300350 return (*wk)(self, args, descr->d_wrapped, kwds);
351 }
352
353 if (kwds != NULL && (!PyDict_Check(kwds) || PyDict_GET_SIZE(kwds) != 0)) {
354 PyErr_Format(PyExc_TypeError,
355 "wrapper %s() takes no keyword arguments",
356 descr->d_base->name);
357 return NULL;
358 }
359 return (*wrapper)(self, args, descr->d_wrapped);
360}
361
Tim Petersbca1cbc2002-12-09 22:56:13 +0000362static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000363wrapperdescr_call(PyWrapperDescrObject *descr, PyObject *args, PyObject *kwds)
364{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000365 Py_ssize_t argc;
Serhiy Storchaka5e02c782017-09-21 14:25:36 +0300366 PyObject *self, *result;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000367
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000368 /* Make sure that the first argument is acceptable as 'self' */
369 assert(PyTuple_Check(args));
370 argc = PyTuple_GET_SIZE(args);
371 if (argc < 1) {
372 PyErr_Format(PyExc_TypeError,
373 "descriptor '%V' of '%.100s' "
374 "object needs an argument",
375 descr_name((PyDescrObject *)descr), "?",
376 PyDescr_TYPE(descr)->tp_name);
377 return NULL;
378 }
379 self = PyTuple_GET_ITEM(args, 0);
Victor Stinner3249dec2011-05-01 23:19:15 +0200380 if (!_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self),
Victor Stinnerd9561312011-05-01 23:31:36 +0200381 (PyObject *)PyDescr_TYPE(descr))) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000382 PyErr_Format(PyExc_TypeError,
383 "descriptor '%V' "
384 "requires a '%.100s' object "
385 "but received a '%.100s'",
386 descr_name((PyDescrObject *)descr), "?",
387 PyDescr_TYPE(descr)->tp_name,
388 self->ob_type->tp_name);
389 return NULL;
390 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000391
Serhiy Storchaka5e02c782017-09-21 14:25:36 +0300392 args = PyTuple_GetSlice(args, 1, argc);
393 if (args == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000394 return NULL;
Serhiy Storchaka5e02c782017-09-21 14:25:36 +0300395 }
396 result = wrapperdescr_raw_call(descr, self, args, kwds);
397 Py_DECREF(args);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000398 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000399}
400
Serhiy Storchaka5e02c782017-09-21 14:25:36 +0300401
Tim Peters6d6c1a32001-08-02 04:15:00 +0000402static PyObject *
Guido van Rossum6f799372001-09-20 20:46:19 +0000403method_get_doc(PyMethodDescrObject *descr, void *closure)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000404{
Larry Hastings2623c8c2014-02-08 22:15:29 -0800405 return _PyType_GetDocFromInternalDoc(descr->d_method->ml_name, descr->d_method->ml_doc);
Larry Hastings5c661892014-01-24 06:17:25 -0800406}
407
408static PyObject *
409method_get_text_signature(PyMethodDescrObject *descr, void *closure)
410{
Larry Hastings2623c8c2014-02-08 22:15:29 -0800411 return _PyType_GetTextSignatureFromInternalDoc(descr->d_method->ml_name, descr->d_method->ml_doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000412}
413
Antoine Pitrou9d574812011-12-12 13:47:25 +0100414static PyObject *
415calculate_qualname(PyDescrObject *descr)
416{
417 PyObject *type_qualname, *res;
418 _Py_IDENTIFIER(__qualname__);
419
420 if (descr->d_name == NULL || !PyUnicode_Check(descr->d_name)) {
421 PyErr_SetString(PyExc_TypeError,
422 "<descriptor>.__name__ is not a unicode object");
423 return NULL;
424 }
425
426 type_qualname = _PyObject_GetAttrId((PyObject *)descr->d_type,
427 &PyId___qualname__);
428 if (type_qualname == NULL)
429 return NULL;
430
431 if (!PyUnicode_Check(type_qualname)) {
432 PyErr_SetString(PyExc_TypeError, "<descriptor>.__objclass__."
433 "__qualname__ is not a unicode object");
434 Py_XDECREF(type_qualname);
435 return NULL;
436 }
437
438 res = PyUnicode_FromFormat("%S.%S", type_qualname, descr->d_name);
439 Py_DECREF(type_qualname);
440 return res;
441}
442
443static PyObject *
Serhiy Storchakad4f9cf52018-11-27 19:34:35 +0200444descr_get_qualname(PyDescrObject *descr, void *Py_UNUSED(ignored))
Antoine Pitrou9d574812011-12-12 13:47:25 +0100445{
446 if (descr->d_qualname == NULL)
447 descr->d_qualname = calculate_qualname(descr);
448 Py_XINCREF(descr->d_qualname);
449 return descr->d_qualname;
450}
451
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100452static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +0530453descr_reduce(PyDescrObject *descr, PyObject *Py_UNUSED(ignored))
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100454{
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100455 _Py_IDENTIFIER(getattr);
Serhiy Storchakabb86bf42018-12-11 08:28:18 +0200456 return Py_BuildValue("N(OO)", _PyEval_GetBuiltinId(&PyId_getattr),
457 PyDescr_TYPE(descr), PyDescr_NAME(descr));
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100458}
459
460static PyMethodDef descr_methods[] = {
461 {"__reduce__", (PyCFunction)descr_reduce, METH_NOARGS, NULL},
462 {NULL, NULL}
463};
464
Guido van Rossum6f799372001-09-20 20:46:19 +0000465static PyMemberDef descr_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000466 {"__objclass__", T_OBJECT, offsetof(PyDescrObject, d_type), READONLY},
467 {"__name__", T_OBJECT, offsetof(PyDescrObject, d_name), READONLY},
468 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000469};
470
Guido van Rossum32d34c82001-09-20 21:45:26 +0000471static PyGetSetDef method_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000472 {"__doc__", (getter)method_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100473 {"__qualname__", (getter)descr_get_qualname},
Larry Hastings5c661892014-01-24 06:17:25 -0800474 {"__text_signature__", (getter)method_get_text_signature},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000475 {0}
Guido van Rossum6f799372001-09-20 20:46:19 +0000476};
477
478static PyObject *
479member_get_doc(PyMemberDescrObject *descr, void *closure)
480{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000481 if (descr->d_member->doc == NULL) {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200482 Py_RETURN_NONE;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000483 }
484 return PyUnicode_FromString(descr->d_member->doc);
Guido van Rossum6f799372001-09-20 20:46:19 +0000485}
486
Guido van Rossum32d34c82001-09-20 21:45:26 +0000487static PyGetSetDef member_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000488 {"__doc__", (getter)member_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100489 {"__qualname__", (getter)descr_get_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000490 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000491};
492
493static PyObject *
Guido van Rossum32d34c82001-09-20 21:45:26 +0000494getset_get_doc(PyGetSetDescrObject *descr, void *closure)
495{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000496 if (descr->d_getset->doc == NULL) {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200497 Py_RETURN_NONE;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000498 }
499 return PyUnicode_FromString(descr->d_getset->doc);
Guido van Rossum32d34c82001-09-20 21:45:26 +0000500}
501
502static PyGetSetDef getset_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000503 {"__doc__", (getter)getset_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100504 {"__qualname__", (getter)descr_get_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000505 {0}
Guido van Rossum32d34c82001-09-20 21:45:26 +0000506};
507
508static PyObject *
Armin Rigoc6686b72005-11-07 08:38:00 +0000509wrapperdescr_get_doc(PyWrapperDescrObject *descr, void *closure)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000510{
Larry Hastings2623c8c2014-02-08 22:15:29 -0800511 return _PyType_GetDocFromInternalDoc(descr->d_base->name, descr->d_base->doc);
Larry Hastings5c661892014-01-24 06:17:25 -0800512}
513
514static PyObject *
515wrapperdescr_get_text_signature(PyWrapperDescrObject *descr, void *closure)
516{
Larry Hastings2623c8c2014-02-08 22:15:29 -0800517 return _PyType_GetTextSignatureFromInternalDoc(descr->d_base->name, descr->d_base->doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000518}
519
Armin Rigoc6686b72005-11-07 08:38:00 +0000520static PyGetSetDef wrapperdescr_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000521 {"__doc__", (getter)wrapperdescr_get_doc},
Antoine Pitrou9d574812011-12-12 13:47:25 +0100522 {"__qualname__", (getter)descr_get_qualname},
Larry Hastings5c661892014-01-24 06:17:25 -0800523 {"__text_signature__", (getter)wrapperdescr_get_text_signature},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000524 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000525};
526
Guido van Rossum048eb752001-10-02 21:24:57 +0000527static int
528descr_traverse(PyObject *self, visitproc visit, void *arg)
529{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000530 PyDescrObject *descr = (PyDescrObject *)self;
531 Py_VISIT(descr->d_type);
532 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +0000533}
534
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000535PyTypeObject PyMethodDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000536 PyVarObject_HEAD_INIT(&PyType_Type, 0)
537 "method_descriptor",
538 sizeof(PyMethodDescrObject),
539 0,
540 (destructor)descr_dealloc, /* tp_dealloc */
541 0, /* tp_print */
542 0, /* tp_getattr */
543 0, /* tp_setattr */
544 0, /* tp_reserved */
545 (reprfunc)method_repr, /* tp_repr */
546 0, /* tp_as_number */
547 0, /* tp_as_sequence */
548 0, /* tp_as_mapping */
549 0, /* tp_hash */
550 (ternaryfunc)methoddescr_call, /* tp_call */
551 0, /* tp_str */
552 PyObject_GenericGetAttr, /* tp_getattro */
553 0, /* tp_setattro */
554 0, /* tp_as_buffer */
555 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
556 0, /* tp_doc */
557 descr_traverse, /* tp_traverse */
558 0, /* tp_clear */
559 0, /* tp_richcompare */
560 0, /* tp_weaklistoffset */
561 0, /* tp_iter */
562 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100563 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000564 descr_members, /* tp_members */
565 method_getset, /* tp_getset */
566 0, /* tp_base */
567 0, /* tp_dict */
568 (descrgetfunc)method_get, /* tp_descr_get */
569 0, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000570};
571
Guido van Rossumb6e5a0c2003-02-11 18:44:42 +0000572/* This is for METH_CLASS in C, not for "f = classmethod(f)" in Python! */
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000573PyTypeObject PyClassMethodDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000574 PyVarObject_HEAD_INIT(&PyType_Type, 0)
575 "classmethod_descriptor",
576 sizeof(PyMethodDescrObject),
577 0,
578 (destructor)descr_dealloc, /* tp_dealloc */
579 0, /* tp_print */
580 0, /* tp_getattr */
581 0, /* tp_setattr */
582 0, /* tp_reserved */
583 (reprfunc)method_repr, /* tp_repr */
584 0, /* tp_as_number */
585 0, /* tp_as_sequence */
586 0, /* tp_as_mapping */
587 0, /* tp_hash */
588 (ternaryfunc)classmethoddescr_call, /* tp_call */
589 0, /* tp_str */
590 PyObject_GenericGetAttr, /* tp_getattro */
591 0, /* tp_setattro */
592 0, /* tp_as_buffer */
593 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
594 0, /* tp_doc */
595 descr_traverse, /* tp_traverse */
596 0, /* tp_clear */
597 0, /* tp_richcompare */
598 0, /* tp_weaklistoffset */
599 0, /* tp_iter */
600 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100601 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000602 descr_members, /* tp_members */
603 method_getset, /* tp_getset */
604 0, /* tp_base */
605 0, /* tp_dict */
606 (descrgetfunc)classmethod_get, /* tp_descr_get */
607 0, /* tp_descr_set */
Tim Petersbca1cbc2002-12-09 22:56:13 +0000608};
609
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000610PyTypeObject PyMemberDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000611 PyVarObject_HEAD_INIT(&PyType_Type, 0)
612 "member_descriptor",
613 sizeof(PyMemberDescrObject),
614 0,
615 (destructor)descr_dealloc, /* tp_dealloc */
616 0, /* tp_print */
617 0, /* tp_getattr */
618 0, /* tp_setattr */
619 0, /* tp_reserved */
620 (reprfunc)member_repr, /* tp_repr */
621 0, /* tp_as_number */
622 0, /* tp_as_sequence */
623 0, /* tp_as_mapping */
624 0, /* tp_hash */
625 0, /* tp_call */
626 0, /* tp_str */
627 PyObject_GenericGetAttr, /* tp_getattro */
628 0, /* tp_setattro */
629 0, /* tp_as_buffer */
630 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
631 0, /* tp_doc */
632 descr_traverse, /* tp_traverse */
633 0, /* tp_clear */
634 0, /* tp_richcompare */
635 0, /* tp_weaklistoffset */
636 0, /* tp_iter */
637 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100638 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000639 descr_members, /* tp_members */
640 member_getset, /* tp_getset */
641 0, /* tp_base */
642 0, /* tp_dict */
643 (descrgetfunc)member_get, /* tp_descr_get */
644 (descrsetfunc)member_set, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000645};
646
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000647PyTypeObject PyGetSetDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000648 PyVarObject_HEAD_INIT(&PyType_Type, 0)
649 "getset_descriptor",
650 sizeof(PyGetSetDescrObject),
651 0,
652 (destructor)descr_dealloc, /* tp_dealloc */
653 0, /* tp_print */
654 0, /* tp_getattr */
655 0, /* tp_setattr */
656 0, /* tp_reserved */
657 (reprfunc)getset_repr, /* tp_repr */
658 0, /* tp_as_number */
659 0, /* tp_as_sequence */
660 0, /* tp_as_mapping */
661 0, /* tp_hash */
662 0, /* tp_call */
663 0, /* tp_str */
664 PyObject_GenericGetAttr, /* tp_getattro */
665 0, /* tp_setattro */
666 0, /* tp_as_buffer */
667 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
668 0, /* tp_doc */
669 descr_traverse, /* tp_traverse */
670 0, /* tp_clear */
671 0, /* tp_richcompare */
672 0, /* tp_weaklistoffset */
673 0, /* tp_iter */
674 0, /* tp_iternext */
675 0, /* tp_methods */
676 descr_members, /* tp_members */
677 getset_getset, /* tp_getset */
678 0, /* tp_base */
679 0, /* tp_dict */
680 (descrgetfunc)getset_get, /* tp_descr_get */
681 (descrsetfunc)getset_set, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000682};
683
Guido van Rossumf4593e02001-10-03 12:09:30 +0000684PyTypeObject PyWrapperDescr_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000685 PyVarObject_HEAD_INIT(&PyType_Type, 0)
686 "wrapper_descriptor",
687 sizeof(PyWrapperDescrObject),
688 0,
689 (destructor)descr_dealloc, /* tp_dealloc */
690 0, /* tp_print */
691 0, /* tp_getattr */
692 0, /* tp_setattr */
693 0, /* tp_reserved */
694 (reprfunc)wrapperdescr_repr, /* tp_repr */
695 0, /* tp_as_number */
696 0, /* tp_as_sequence */
697 0, /* tp_as_mapping */
698 0, /* tp_hash */
699 (ternaryfunc)wrapperdescr_call, /* tp_call */
700 0, /* tp_str */
701 PyObject_GenericGetAttr, /* tp_getattro */
702 0, /* tp_setattro */
703 0, /* tp_as_buffer */
704 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
705 0, /* tp_doc */
706 descr_traverse, /* tp_traverse */
707 0, /* tp_clear */
708 0, /* tp_richcompare */
709 0, /* tp_weaklistoffset */
710 0, /* tp_iter */
711 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +0100712 descr_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000713 descr_members, /* tp_members */
714 wrapperdescr_getset, /* tp_getset */
715 0, /* tp_base */
716 0, /* tp_dict */
717 (descrgetfunc)wrapperdescr_get, /* tp_descr_get */
718 0, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000719};
720
721static PyDescrObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000722descr_new(PyTypeObject *descrtype, PyTypeObject *type, const char *name)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000723{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000724 PyDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000725
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000726 descr = (PyDescrObject *)PyType_GenericAlloc(descrtype, 0);
727 if (descr != NULL) {
728 Py_XINCREF(type);
729 descr->d_type = type;
730 descr->d_name = PyUnicode_InternFromString(name);
731 if (descr->d_name == NULL) {
732 Py_DECREF(descr);
733 descr = NULL;
734 }
Benjamin Petersonf2fe7f02011-12-17 08:02:20 -0500735 else {
736 descr->d_qualname = NULL;
737 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000738 }
739 return descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000740}
741
742PyObject *
743PyDescr_NewMethod(PyTypeObject *type, PyMethodDef *method)
744{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000745 PyMethodDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000746
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000747 descr = (PyMethodDescrObject *)descr_new(&PyMethodDescr_Type,
748 type, method->ml_name);
749 if (descr != NULL)
750 descr->d_method = method;
751 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000752}
753
754PyObject *
Tim Petersbca1cbc2002-12-09 22:56:13 +0000755PyDescr_NewClassMethod(PyTypeObject *type, PyMethodDef *method)
756{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000757 PyMethodDescrObject *descr;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000758
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000759 descr = (PyMethodDescrObject *)descr_new(&PyClassMethodDescr_Type,
760 type, method->ml_name);
761 if (descr != NULL)
762 descr->d_method = method;
763 return (PyObject *)descr;
Tim Petersbca1cbc2002-12-09 22:56:13 +0000764}
765
766PyObject *
Guido van Rossum6f799372001-09-20 20:46:19 +0000767PyDescr_NewMember(PyTypeObject *type, PyMemberDef *member)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000768{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000769 PyMemberDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000770
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000771 descr = (PyMemberDescrObject *)descr_new(&PyMemberDescr_Type,
772 type, member->name);
773 if (descr != NULL)
774 descr->d_member = member;
775 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000776}
777
778PyObject *
Guido van Rossum32d34c82001-09-20 21:45:26 +0000779PyDescr_NewGetSet(PyTypeObject *type, PyGetSetDef *getset)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000780{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000781 PyGetSetDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000782
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000783 descr = (PyGetSetDescrObject *)descr_new(&PyGetSetDescr_Type,
784 type, getset->name);
785 if (descr != NULL)
786 descr->d_getset = getset;
787 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000788}
789
790PyObject *
791PyDescr_NewWrapper(PyTypeObject *type, struct wrapperbase *base, void *wrapped)
792{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000793 PyWrapperDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000794
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000795 descr = (PyWrapperDescrObject *)descr_new(&PyWrapperDescr_Type,
796 type, base->name);
797 if (descr != NULL) {
798 descr->d_base = base;
799 descr->d_wrapped = wrapped;
800 }
801 return (PyObject *)descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000802}
803
Tim Peters6d6c1a32001-08-02 04:15:00 +0000804
Victor Stinner0db176f2012-04-16 00:16:30 +0200805/* --- mappingproxy: read-only proxy for mappings --- */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000806
807/* This has no reason to be in this file except that adding new files is a
808 bit of a pain */
809
810typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000811 PyObject_HEAD
Victor Stinner0db176f2012-04-16 00:16:30 +0200812 PyObject *mapping;
813} mappingproxyobject;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000814
Martin v. Löwis18e16552006-02-15 17:27:45 +0000815static Py_ssize_t
Victor Stinner0db176f2012-04-16 00:16:30 +0200816mappingproxy_len(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000817{
Victor Stinner0db176f2012-04-16 00:16:30 +0200818 return PyObject_Size(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000819}
820
821static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200822mappingproxy_getitem(mappingproxyobject *pp, PyObject *key)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000823{
Victor Stinner0db176f2012-04-16 00:16:30 +0200824 return PyObject_GetItem(pp->mapping, key);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000825}
826
Victor Stinner0db176f2012-04-16 00:16:30 +0200827static PyMappingMethods mappingproxy_as_mapping = {
828 (lenfunc)mappingproxy_len, /* mp_length */
829 (binaryfunc)mappingproxy_getitem, /* mp_subscript */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000830 0, /* mp_ass_subscript */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000831};
832
833static int
Victor Stinner0db176f2012-04-16 00:16:30 +0200834mappingproxy_contains(mappingproxyobject *pp, PyObject *key)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000835{
Victor Stinner0db176f2012-04-16 00:16:30 +0200836 if (PyDict_CheckExact(pp->mapping))
837 return PyDict_Contains(pp->mapping, key);
838 else
839 return PySequence_Contains(pp->mapping, key);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000840}
841
Victor Stinner0db176f2012-04-16 00:16:30 +0200842static PySequenceMethods mappingproxy_as_sequence = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000843 0, /* sq_length */
844 0, /* sq_concat */
845 0, /* sq_repeat */
846 0, /* sq_item */
847 0, /* sq_slice */
848 0, /* sq_ass_item */
849 0, /* sq_ass_slice */
Victor Stinner0db176f2012-04-16 00:16:30 +0200850 (objobjproc)mappingproxy_contains, /* sq_contains */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000851 0, /* sq_inplace_concat */
852 0, /* sq_inplace_repeat */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000853};
854
855static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200856mappingproxy_get(mappingproxyobject *pp, PyObject *args)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000857{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000858 PyObject *key, *def = Py_None;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200859 _Py_IDENTIFIER(get);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000860
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000861 if (!PyArg_UnpackTuple(args, "get", 1, 2, &key, &def))
862 return NULL;
Victor Stinner7e425412016-12-09 00:36:19 +0100863 return _PyObject_CallMethodIdObjArgs(pp->mapping, &PyId_get,
864 key, def, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000865}
866
867static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +0530868mappingproxy_keys(mappingproxyobject *pp, PyObject *Py_UNUSED(ignored))
Tim Peters6d6c1a32001-08-02 04:15:00 +0000869{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200870 _Py_IDENTIFIER(keys);
Victor Stinner0db176f2012-04-16 00:16:30 +0200871 return _PyObject_CallMethodId(pp->mapping, &PyId_keys, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000872}
873
874static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +0530875mappingproxy_values(mappingproxyobject *pp, PyObject *Py_UNUSED(ignored))
Tim Peters6d6c1a32001-08-02 04:15:00 +0000876{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200877 _Py_IDENTIFIER(values);
Victor Stinner0db176f2012-04-16 00:16:30 +0200878 return _PyObject_CallMethodId(pp->mapping, &PyId_values, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000879}
880
881static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +0530882mappingproxy_items(mappingproxyobject *pp, PyObject *Py_UNUSED(ignored))
Tim Peters6d6c1a32001-08-02 04:15:00 +0000883{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200884 _Py_IDENTIFIER(items);
Victor Stinner0db176f2012-04-16 00:16:30 +0200885 return _PyObject_CallMethodId(pp->mapping, &PyId_items, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000886}
887
888static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +0530889mappingproxy_copy(mappingproxyobject *pp, PyObject *Py_UNUSED(ignored))
Tim Peters6d6c1a32001-08-02 04:15:00 +0000890{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200891 _Py_IDENTIFIER(copy);
Victor Stinner0db176f2012-04-16 00:16:30 +0200892 return _PyObject_CallMethodId(pp->mapping, &PyId_copy, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000893}
894
Victor Stinner0db176f2012-04-16 00:16:30 +0200895/* WARNING: mappingproxy methods must not give access
896 to the underlying mapping */
897
898static PyMethodDef mappingproxy_methods[] = {
899 {"get", (PyCFunction)mappingproxy_get, METH_VARARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000900 PyDoc_STR("D.get(k[,d]) -> D[k] if k in D, else d."
Victor Stinner0db176f2012-04-16 00:16:30 +0200901 " d defaults to None.")},
902 {"keys", (PyCFunction)mappingproxy_keys, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000903 PyDoc_STR("D.keys() -> list of D's keys")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200904 {"values", (PyCFunction)mappingproxy_values, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000905 PyDoc_STR("D.values() -> list of D's values")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200906 {"items", (PyCFunction)mappingproxy_items, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000907 PyDoc_STR("D.items() -> list of D's (key, value) pairs, as 2-tuples")},
Victor Stinner0db176f2012-04-16 00:16:30 +0200908 {"copy", (PyCFunction)mappingproxy_copy, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000909 PyDoc_STR("D.copy() -> a shallow copy of D")},
910 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000911};
912
913static void
Victor Stinner0db176f2012-04-16 00:16:30 +0200914mappingproxy_dealloc(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000915{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000916 _PyObject_GC_UNTRACK(pp);
Victor Stinner0db176f2012-04-16 00:16:30 +0200917 Py_DECREF(pp->mapping);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000918 PyObject_GC_Del(pp);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000919}
920
921static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200922mappingproxy_getiter(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000923{
Victor Stinner0db176f2012-04-16 00:16:30 +0200924 return PyObject_GetIter(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000925}
926
Neil Schemenauer26775122001-10-21 22:26:43 +0000927static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200928mappingproxy_str(mappingproxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000929{
Victor Stinner0db176f2012-04-16 00:16:30 +0200930 return PyObject_Str(pp->mapping);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000931}
932
Ezio Melottiac53ab62010-12-18 14:59:43 +0000933static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200934mappingproxy_repr(mappingproxyobject *pp)
Ezio Melottiac53ab62010-12-18 14:59:43 +0000935{
Victor Stinner0db176f2012-04-16 00:16:30 +0200936 return PyUnicode_FromFormat("mappingproxy(%R)", pp->mapping);
Ezio Melottiac53ab62010-12-18 14:59:43 +0000937}
938
Guido van Rossum048eb752001-10-02 21:24:57 +0000939static int
Victor Stinner0db176f2012-04-16 00:16:30 +0200940mappingproxy_traverse(PyObject *self, visitproc visit, void *arg)
Guido van Rossum048eb752001-10-02 21:24:57 +0000941{
Victor Stinner0db176f2012-04-16 00:16:30 +0200942 mappingproxyobject *pp = (mappingproxyobject *)self;
943 Py_VISIT(pp->mapping);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000944 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +0000945}
946
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000947static PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200948mappingproxy_richcompare(mappingproxyobject *v, PyObject *w, int op)
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000949{
Victor Stinner0db176f2012-04-16 00:16:30 +0200950 return PyObject_RichCompare(v->mapping, w, op);
951}
952
953static int
954mappingproxy_check_mapping(PyObject *mapping)
955{
956 if (!PyMapping_Check(mapping)
957 || PyList_Check(mapping)
958 || PyTuple_Check(mapping)) {
959 PyErr_Format(PyExc_TypeError,
960 "mappingproxy() argument must be a mapping, not %s",
961 Py_TYPE(mapping)->tp_name);
962 return -1;
963 }
964 return 0;
965}
966
Serhiy Storchaka18b250f2017-03-19 08:51:07 +0200967/*[clinic input]
968@classmethod
969mappingproxy.__new__ as mappingproxy_new
Victor Stinner0db176f2012-04-16 00:16:30 +0200970
Serhiy Storchaka18b250f2017-03-19 08:51:07 +0200971 mapping: object
972
973[clinic start generated code]*/
974
975static PyObject *
976mappingproxy_new_impl(PyTypeObject *type, PyObject *mapping)
977/*[clinic end generated code: output=65f27f02d5b68fa7 input=d2d620d4f598d4f8]*/
978{
979 mappingproxyobject *mappingproxy;
Victor Stinner0db176f2012-04-16 00:16:30 +0200980
981 if (mappingproxy_check_mapping(mapping) == -1)
982 return NULL;
983
984 mappingproxy = PyObject_GC_New(mappingproxyobject, &PyDictProxy_Type);
985 if (mappingproxy == NULL)
986 return NULL;
987 Py_INCREF(mapping);
988 mappingproxy->mapping = mapping;
989 _PyObject_GC_TRACK(mappingproxy);
990 return (PyObject *)mappingproxy;
Raymond Hettinger29a6d442002-08-31 15:51:04 +0000991}
992
Tim Peters6d6c1a32001-08-02 04:15:00 +0000993PyObject *
Victor Stinner0db176f2012-04-16 00:16:30 +0200994PyDictProxy_New(PyObject *mapping)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000995{
Victor Stinner0db176f2012-04-16 00:16:30 +0200996 mappingproxyobject *pp;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000997
Victor Stinner0db176f2012-04-16 00:16:30 +0200998 if (mappingproxy_check_mapping(mapping) == -1)
999 return NULL;
1000
1001 pp = PyObject_GC_New(mappingproxyobject, &PyDictProxy_Type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001002 if (pp != NULL) {
Victor Stinner0db176f2012-04-16 00:16:30 +02001003 Py_INCREF(mapping);
1004 pp->mapping = mapping;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001005 _PyObject_GC_TRACK(pp);
1006 }
1007 return (PyObject *)pp;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001008}
1009
1010
1011/* --- Wrapper object for "slot" methods --- */
1012
1013/* This has no reason to be in this file except that adding new files is a
1014 bit of a pain */
1015
1016typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001017 PyObject_HEAD
1018 PyWrapperDescrObject *descr;
1019 PyObject *self;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001020} wrapperobject;
1021
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001022#define Wrapper_Check(v) (Py_TYPE(v) == &_PyMethodWrapper_Type)
Mark Dickinson211c6252009-02-01 10:28:51 +00001023
Tim Peters6d6c1a32001-08-02 04:15:00 +00001024static void
1025wrapper_dealloc(wrapperobject *wp)
1026{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001027 PyObject_GC_UnTrack(wp);
1028 Py_TRASHCAN_SAFE_BEGIN(wp)
1029 Py_XDECREF(wp->descr);
1030 Py_XDECREF(wp->self);
1031 PyObject_GC_Del(wp);
1032 Py_TRASHCAN_SAFE_END(wp)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001033}
1034
Mark Dickinson211c6252009-02-01 10:28:51 +00001035static PyObject *
1036wrapper_richcompare(PyObject *a, PyObject *b, int op)
Armin Rigoc6686b72005-11-07 08:38:00 +00001037{
Serhiy Storchakaac20e0f2018-07-31 09:18:24 +03001038 wrapperobject *wa, *wb;
1039 int eq;
Mark Dickinson211c6252009-02-01 10:28:51 +00001040
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001041 assert(a != NULL && b != NULL);
Mark Dickinson211c6252009-02-01 10:28:51 +00001042
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001043 /* both arguments should be wrapperobjects */
Serhiy Storchakaac20e0f2018-07-31 09:18:24 +03001044 if ((op != Py_EQ && op != Py_NE)
1045 || !Wrapper_Check(a) || !Wrapper_Check(b))
1046 {
stratakise8b19652017-11-02 11:32:54 +01001047 Py_RETURN_NOTIMPLEMENTED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001048 }
Mark Dickinson211c6252009-02-01 10:28:51 +00001049
Serhiy Storchakaac20e0f2018-07-31 09:18:24 +03001050 wa = (wrapperobject *)a;
1051 wb = (wrapperobject *)b;
1052 eq = (wa->descr == wb->descr && wa->self == wb->self);
1053 if (eq == (op == Py_EQ)) {
1054 Py_RETURN_TRUE;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001055 }
Serhiy Storchakaac20e0f2018-07-31 09:18:24 +03001056 else {
1057 Py_RETURN_FALSE;
1058 }
Armin Rigoc6686b72005-11-07 08:38:00 +00001059}
1060
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001061static Py_hash_t
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001062wrapper_hash(wrapperobject *wp)
1063{
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001064 Py_hash_t x, y;
Serhiy Storchakaac20e0f2018-07-31 09:18:24 +03001065 x = _Py_HashPointer(wp->self);
1066 y = _Py_HashPointer(wp->descr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001067 x = x ^ y;
1068 if (x == -1)
1069 x = -2;
1070 return x;
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001071}
1072
Armin Rigoc6686b72005-11-07 08:38:00 +00001073static PyObject *
1074wrapper_repr(wrapperobject *wp)
1075{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001076 return PyUnicode_FromFormat("<method-wrapper '%s' of %s object at %p>",
1077 wp->descr->d_base->name,
1078 wp->self->ob_type->tp_name,
1079 wp->self);
Armin Rigoc6686b72005-11-07 08:38:00 +00001080}
1081
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001082static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05301083wrapper_reduce(wrapperobject *wp, PyObject *Py_UNUSED(ignored))
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001084{
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001085 _Py_IDENTIFIER(getattr);
Serhiy Storchakabb86bf42018-12-11 08:28:18 +02001086 return Py_BuildValue("N(OO)", _PyEval_GetBuiltinId(&PyId_getattr),
1087 wp->self, PyDescr_NAME(wp->descr));
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001088}
1089
1090static PyMethodDef wrapper_methods[] = {
1091 {"__reduce__", (PyCFunction)wrapper_reduce, METH_NOARGS, NULL},
1092 {NULL, NULL}
1093};
1094
Armin Rigoc6686b72005-11-07 08:38:00 +00001095static PyMemberDef wrapper_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001096 {"__self__", T_OBJECT, offsetof(wrapperobject, self), READONLY},
1097 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001098};
1099
1100static PyObject *
Serhiy Storchakad4f9cf52018-11-27 19:34:35 +02001101wrapper_objclass(wrapperobject *wp, void *Py_UNUSED(ignored))
Armin Rigoc6686b72005-11-07 08:38:00 +00001102{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001103 PyObject *c = (PyObject *)PyDescr_TYPE(wp->descr);
Armin Rigoc6686b72005-11-07 08:38:00 +00001104
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001105 Py_INCREF(c);
1106 return c;
Armin Rigoc6686b72005-11-07 08:38:00 +00001107}
1108
1109static PyObject *
Serhiy Storchakad4f9cf52018-11-27 19:34:35 +02001110wrapper_name(wrapperobject *wp, void *Py_UNUSED(ignored))
Tim Peters6d6c1a32001-08-02 04:15:00 +00001111{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001112 const char *s = wp->descr->d_base->name;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001113
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001114 return PyUnicode_FromString(s);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001115}
1116
1117static PyObject *
Serhiy Storchakad4f9cf52018-11-27 19:34:35 +02001118wrapper_doc(wrapperobject *wp, void *Py_UNUSED(ignored))
Tim Peters6d6c1a32001-08-02 04:15:00 +00001119{
Larry Hastings2623c8c2014-02-08 22:15:29 -08001120 return _PyType_GetDocFromInternalDoc(wp->descr->d_base->name, wp->descr->d_base->doc);
Larry Hastings5c661892014-01-24 06:17:25 -08001121}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001122
Larry Hastings5c661892014-01-24 06:17:25 -08001123static PyObject *
Serhiy Storchakad4f9cf52018-11-27 19:34:35 +02001124wrapper_text_signature(wrapperobject *wp, void *Py_UNUSED(ignored))
Larry Hastings5c661892014-01-24 06:17:25 -08001125{
Larry Hastings2623c8c2014-02-08 22:15:29 -08001126 return _PyType_GetTextSignatureFromInternalDoc(wp->descr->d_base->name, wp->descr->d_base->doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001127}
1128
Antoine Pitrou9d574812011-12-12 13:47:25 +01001129static PyObject *
Serhiy Storchakad4f9cf52018-11-27 19:34:35 +02001130wrapper_qualname(wrapperobject *wp, void *Py_UNUSED(ignored))
Antoine Pitrou9d574812011-12-12 13:47:25 +01001131{
Serhiy Storchakad4f9cf52018-11-27 19:34:35 +02001132 return descr_get_qualname((PyDescrObject *)wp->descr, NULL);
Antoine Pitrou9d574812011-12-12 13:47:25 +01001133}
1134
Guido van Rossum32d34c82001-09-20 21:45:26 +00001135static PyGetSetDef wrapper_getsets[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001136 {"__objclass__", (getter)wrapper_objclass},
1137 {"__name__", (getter)wrapper_name},
Antoine Pitrou9d574812011-12-12 13:47:25 +01001138 {"__qualname__", (getter)wrapper_qualname},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001139 {"__doc__", (getter)wrapper_doc},
Larry Hastings5c661892014-01-24 06:17:25 -08001140 {"__text_signature__", (getter)wrapper_text_signature},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001141 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +00001142};
1143
1144static PyObject *
1145wrapper_call(wrapperobject *wp, PyObject *args, PyObject *kwds)
1146{
Serhiy Storchaka5e02c782017-09-21 14:25:36 +03001147 return wrapperdescr_raw_call(wp->descr, wp->self, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001148}
1149
Guido van Rossum048eb752001-10-02 21:24:57 +00001150static int
1151wrapper_traverse(PyObject *self, visitproc visit, void *arg)
1152{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001153 wrapperobject *wp = (wrapperobject *)self;
1154 Py_VISIT(wp->descr);
1155 Py_VISIT(wp->self);
1156 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +00001157}
1158
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001159PyTypeObject _PyMethodWrapper_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001160 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1161 "method-wrapper", /* tp_name */
1162 sizeof(wrapperobject), /* tp_basicsize */
1163 0, /* tp_itemsize */
1164 /* methods */
1165 (destructor)wrapper_dealloc, /* tp_dealloc */
1166 0, /* tp_print */
1167 0, /* tp_getattr */
1168 0, /* tp_setattr */
1169 0, /* tp_reserved */
1170 (reprfunc)wrapper_repr, /* tp_repr */
1171 0, /* tp_as_number */
1172 0, /* tp_as_sequence */
1173 0, /* tp_as_mapping */
1174 (hashfunc)wrapper_hash, /* tp_hash */
1175 (ternaryfunc)wrapper_call, /* tp_call */
1176 0, /* tp_str */
1177 PyObject_GenericGetAttr, /* tp_getattro */
1178 0, /* tp_setattro */
1179 0, /* tp_as_buffer */
1180 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
1181 0, /* tp_doc */
1182 wrapper_traverse, /* tp_traverse */
1183 0, /* tp_clear */
1184 wrapper_richcompare, /* tp_richcompare */
1185 0, /* tp_weaklistoffset */
1186 0, /* tp_iter */
1187 0, /* tp_iternext */
Antoine Pitrouc9dc4a22013-11-23 18:59:12 +01001188 wrapper_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001189 wrapper_members, /* tp_members */
1190 wrapper_getsets, /* tp_getset */
1191 0, /* tp_base */
1192 0, /* tp_dict */
1193 0, /* tp_descr_get */
1194 0, /* tp_descr_set */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001195};
1196
1197PyObject *
1198PyWrapper_New(PyObject *d, PyObject *self)
1199{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001200 wrapperobject *wp;
1201 PyWrapperDescrObject *descr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001202
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001203 assert(PyObject_TypeCheck(d, &PyWrapperDescr_Type));
1204 descr = (PyWrapperDescrObject *)d;
Victor Stinner3249dec2011-05-01 23:19:15 +02001205 assert(_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self),
Victor Stinnerd9561312011-05-01 23:31:36 +02001206 (PyObject *)PyDescr_TYPE(descr)));
Tim Peters6d6c1a32001-08-02 04:15:00 +00001207
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001208 wp = PyObject_GC_New(wrapperobject, &_PyMethodWrapper_Type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001209 if (wp != NULL) {
1210 Py_INCREF(descr);
1211 wp->descr = descr;
1212 Py_INCREF(self);
1213 wp->self = self;
1214 _PyObject_GC_TRACK(wp);
1215 }
1216 return (PyObject *)wp;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001217}
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001218
1219
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001220/* A built-in 'property' type */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001221
1222/*
Serhiy Storchakad741a882015-06-11 00:06:39 +03001223class property(object):
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001224
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001225 def __init__(self, fget=None, fset=None, fdel=None, doc=None):
1226 if doc is None and fget is not None and hasattr(fget, "__doc__"):
Serhiy Storchakad741a882015-06-11 00:06:39 +03001227 doc = fget.__doc__
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001228 self.__get = fget
1229 self.__set = fset
1230 self.__del = fdel
1231 self.__doc__ = doc
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001232
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001233 def __get__(self, inst, type=None):
1234 if inst is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001235 return self
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001236 if self.__get is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001237 raise AttributeError, "unreadable attribute"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001238 return self.__get(inst)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001239
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001240 def __set__(self, inst, value):
1241 if self.__set is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001242 raise AttributeError, "can't set attribute"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001243 return self.__set(inst, value)
Guido van Rossumba2485f2001-12-10 18:03:34 +00001244
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001245 def __delete__(self, inst):
1246 if self.__del is None:
Serhiy Storchakad741a882015-06-11 00:06:39 +03001247 raise AttributeError, "can't delete attribute"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001248 return self.__del(inst)
Guido van Rossumba2485f2001-12-10 18:03:34 +00001249
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001250*/
1251
1252typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001253 PyObject_HEAD
1254 PyObject *prop_get;
1255 PyObject *prop_set;
1256 PyObject *prop_del;
1257 PyObject *prop_doc;
1258 int getter_doc;
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001259} propertyobject;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001260
Christian Heimes0449f632007-12-15 01:27:15 +00001261static PyObject * property_copy(PyObject *, PyObject *, PyObject *,
Benjamin Peterson93964832010-06-28 03:07:10 +00001262 PyObject *);
Christian Heimes0449f632007-12-15 01:27:15 +00001263
Tim Peters66c1a522001-09-24 21:17:50 +00001264static PyMemberDef property_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001265 {"fget", T_OBJECT, offsetof(propertyobject, prop_get), READONLY},
1266 {"fset", T_OBJECT, offsetof(propertyobject, prop_set), READONLY},
1267 {"fdel", T_OBJECT, offsetof(propertyobject, prop_del), READONLY},
Raymond Hettingereac503a2015-05-13 01:09:59 -07001268 {"__doc__", T_OBJECT, offsetof(propertyobject, prop_doc), 0},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001269 {0}
Tim Peters66c1a522001-09-24 21:17:50 +00001270};
1271
Christian Heimes0449f632007-12-15 01:27:15 +00001272
Guido van Rossum58da9312007-11-10 23:39:45 +00001273PyDoc_STRVAR(getter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001274 "Descriptor to change the getter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001275
Neal Norwitz32dde222008-04-15 06:43:13 +00001276static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001277property_getter(PyObject *self, PyObject *getter)
1278{
Benjamin Peterson93964832010-06-28 03:07:10 +00001279 return property_copy(self, getter, NULL, NULL);
Guido van Rossum58da9312007-11-10 23:39:45 +00001280}
1281
Christian Heimes0449f632007-12-15 01:27:15 +00001282
Guido van Rossum58da9312007-11-10 23:39:45 +00001283PyDoc_STRVAR(setter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001284 "Descriptor to change the setter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001285
Neal Norwitz32dde222008-04-15 06:43:13 +00001286static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001287property_setter(PyObject *self, PyObject *setter)
1288{
Benjamin Peterson93964832010-06-28 03:07:10 +00001289 return property_copy(self, NULL, setter, NULL);
Guido van Rossum58da9312007-11-10 23:39:45 +00001290}
1291
Christian Heimes0449f632007-12-15 01:27:15 +00001292
Guido van Rossum58da9312007-11-10 23:39:45 +00001293PyDoc_STRVAR(deleter_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001294 "Descriptor to change the deleter on a property.");
Guido van Rossum58da9312007-11-10 23:39:45 +00001295
Neal Norwitz32dde222008-04-15 06:43:13 +00001296static PyObject *
Guido van Rossum58da9312007-11-10 23:39:45 +00001297property_deleter(PyObject *self, PyObject *deleter)
1298{
Benjamin Peterson93964832010-06-28 03:07:10 +00001299 return property_copy(self, NULL, NULL, deleter);
Guido van Rossum58da9312007-11-10 23:39:45 +00001300}
1301
1302
Guido van Rossum58da9312007-11-10 23:39:45 +00001303static PyMethodDef property_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001304 {"getter", property_getter, METH_O, getter_doc},
1305 {"setter", property_setter, METH_O, setter_doc},
1306 {"deleter", property_deleter, METH_O, deleter_doc},
1307 {0}
Guido van Rossum58da9312007-11-10 23:39:45 +00001308};
1309
Tim Peters66c1a522001-09-24 21:17:50 +00001310
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001311static void
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001312property_dealloc(PyObject *self)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001313{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001314 propertyobject *gs = (propertyobject *)self;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001315
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001316 _PyObject_GC_UNTRACK(self);
1317 Py_XDECREF(gs->prop_get);
1318 Py_XDECREF(gs->prop_set);
1319 Py_XDECREF(gs->prop_del);
1320 Py_XDECREF(gs->prop_doc);
1321 self->ob_type->tp_free(self);
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001322}
1323
1324static PyObject *
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001325property_descr_get(PyObject *self, PyObject *obj, PyObject *type)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001326{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001327 if (obj == NULL || obj == Py_None) {
1328 Py_INCREF(self);
1329 return self;
1330 }
Victor Stinnere972c132018-10-01 03:03:22 -07001331
1332 propertyobject *gs = (propertyobject *)self;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001333 if (gs->prop_get == NULL) {
1334 PyErr_SetString(PyExc_AttributeError, "unreadable attribute");
1335 return NULL;
1336 }
Victor Stinnere972c132018-10-01 03:03:22 -07001337
1338 PyObject *args[1] = {obj};
1339 return _PyObject_FastCall(gs->prop_get, args, 1);
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001340}
1341
1342static int
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001343property_descr_set(PyObject *self, PyObject *obj, PyObject *value)
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001344{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001345 propertyobject *gs = (propertyobject *)self;
1346 PyObject *func, *res;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001347
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001348 if (value == NULL)
1349 func = gs->prop_del;
1350 else
1351 func = gs->prop_set;
1352 if (func == NULL) {
1353 PyErr_SetString(PyExc_AttributeError,
1354 value == NULL ?
1355 "can't delete attribute" :
1356 "can't set attribute");
1357 return -1;
1358 }
1359 if (value == NULL)
Victor Stinnerde4ae3d2016-12-04 22:59:09 +01001360 res = PyObject_CallFunctionObjArgs(func, obj, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001361 else
Benjamin Peterson9b955de2010-12-07 04:04:02 +00001362 res = PyObject_CallFunctionObjArgs(func, obj, value, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001363 if (res == NULL)
1364 return -1;
1365 Py_DECREF(res);
1366 return 0;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001367}
1368
Christian Heimes0449f632007-12-15 01:27:15 +00001369static PyObject *
Benjamin Peterson93964832010-06-28 03:07:10 +00001370property_copy(PyObject *old, PyObject *get, PyObject *set, PyObject *del)
Christian Heimes0449f632007-12-15 01:27:15 +00001371{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001372 propertyobject *pold = (propertyobject *)old;
Benjamin Peterson93964832010-06-28 03:07:10 +00001373 PyObject *new, *type, *doc;
Christian Heimes0449f632007-12-15 01:27:15 +00001374
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001375 type = PyObject_Type(old);
1376 if (type == NULL)
1377 return NULL;
Christian Heimes0449f632007-12-15 01:27:15 +00001378
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001379 if (get == NULL || get == Py_None) {
1380 Py_XDECREF(get);
1381 get = pold->prop_get ? pold->prop_get : Py_None;
1382 }
1383 if (set == NULL || set == Py_None) {
1384 Py_XDECREF(set);
1385 set = pold->prop_set ? pold->prop_set : Py_None;
1386 }
1387 if (del == NULL || del == Py_None) {
1388 Py_XDECREF(del);
1389 del = pold->prop_del ? pold->prop_del : Py_None;
1390 }
Benjamin Peterson93964832010-06-28 03:07:10 +00001391 if (pold->getter_doc && get != Py_None) {
1392 /* make _init use __doc__ from getter */
1393 doc = Py_None;
1394 }
1395 else {
1396 doc = pold->prop_doc ? pold->prop_doc : Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001397 }
R. David Murrayb18500d2009-05-04 22:59:07 +00001398
Victor Stinner5abaa2b2016-12-09 16:22:32 +01001399 new = PyObject_CallFunctionObjArgs(type, get, set, del, doc, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001400 Py_DECREF(type);
1401 if (new == NULL)
1402 return NULL;
1403 return new;
Christian Heimes0449f632007-12-15 01:27:15 +00001404}
1405
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001406/*[clinic input]
1407property.__init__ as property_init
1408
1409 fget: object(c_default="NULL") = None
1410 function to be used for getting an attribute value
1411 fset: object(c_default="NULL") = None
1412 function to be used for setting an attribute value
1413 fdel: object(c_default="NULL") = None
1414 function to be used for del'ing an attribute
1415 doc: object(c_default="NULL") = None
1416 docstring
1417
1418Property attribute.
1419
1420Typical use is to define a managed attribute x:
1421
1422class C(object):
1423 def getx(self): return self._x
1424 def setx(self, value): self._x = value
1425 def delx(self): del self._x
1426 x = property(getx, setx, delx, "I'm the 'x' property.")
1427
1428Decorators make defining new properties or modifying existing ones easy:
1429
1430class C(object):
1431 @property
1432 def x(self):
1433 "I am the 'x' property."
1434 return self._x
1435 @x.setter
1436 def x(self, value):
1437 self._x = value
1438 @x.deleter
1439 def x(self):
1440 del self._x
1441[clinic start generated code]*/
1442
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001443static int
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001444property_init_impl(propertyobject *self, PyObject *fget, PyObject *fset,
1445 PyObject *fdel, PyObject *doc)
1446/*[clinic end generated code: output=01a960742b692b57 input=dfb5dbbffc6932d5]*/
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001447{
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001448 if (fget == Py_None)
1449 fget = NULL;
1450 if (fset == Py_None)
1451 fset = NULL;
1452 if (fdel == Py_None)
1453 fdel = NULL;
Tim Peters66c1a522001-09-24 21:17:50 +00001454
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001455 Py_XINCREF(fget);
1456 Py_XINCREF(fset);
1457 Py_XINCREF(fdel);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001458 Py_XINCREF(doc);
Christian Heimes0449f632007-12-15 01:27:15 +00001459
Oren Milmand019bc82018-02-13 12:28:33 +02001460 Py_XSETREF(self->prop_get, fget);
1461 Py_XSETREF(self->prop_set, fset);
1462 Py_XSETREF(self->prop_del, fdel);
1463 Py_XSETREF(self->prop_doc, doc);
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001464 self->getter_doc = 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001465
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001466 /* if no docstring given and the getter has one, use that one */
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001467 if ((doc == NULL || doc == Py_None) && fget != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001468 _Py_IDENTIFIER(__doc__);
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001469 PyObject *get_doc = _PyObject_GetAttrId(fget, &PyId___doc__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001470 if (get_doc) {
1471 if (Py_TYPE(self) == &PyProperty_Type) {
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001472 Py_XSETREF(self->prop_doc, get_doc);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001473 }
1474 else {
1475 /* If this is a property subclass, put __doc__
1476 in dict of the subclass instance instead,
1477 otherwise it gets shadowed by __doc__ in the
1478 class's dict. */
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001479 int err = _PyObject_SetAttrId((PyObject *)self, &PyId___doc__, get_doc);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001480 Py_DECREF(get_doc);
1481 if (err < 0)
1482 return -1;
1483 }
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001484 self->getter_doc = 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001485 }
1486 else if (PyErr_ExceptionMatches(PyExc_Exception)) {
1487 PyErr_Clear();
1488 }
1489 else {
1490 return -1;
1491 }
1492 }
1493
1494 return 0;
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001495}
1496
Benjamin Petersonbfebb7b2011-12-15 15:34:02 -05001497static PyObject *
1498property_get___isabstractmethod__(propertyobject *prop, void *closure)
1499{
1500 int res = _PyObject_IsAbstract(prop->prop_get);
1501 if (res == -1) {
1502 return NULL;
1503 }
1504 else if (res) {
1505 Py_RETURN_TRUE;
1506 }
1507
1508 res = _PyObject_IsAbstract(prop->prop_set);
1509 if (res == -1) {
1510 return NULL;
1511 }
1512 else if (res) {
1513 Py_RETURN_TRUE;
1514 }
1515
1516 res = _PyObject_IsAbstract(prop->prop_del);
1517 if (res == -1) {
1518 return NULL;
1519 }
1520 else if (res) {
1521 Py_RETURN_TRUE;
1522 }
1523 Py_RETURN_FALSE;
1524}
1525
1526static PyGetSetDef property_getsetlist[] = {
1527 {"__isabstractmethod__",
1528 (getter)property_get___isabstractmethod__, NULL,
1529 NULL,
1530 NULL},
1531 {NULL} /* Sentinel */
1532};
1533
Guido van Rossum048eb752001-10-02 21:24:57 +00001534static int
1535property_traverse(PyObject *self, visitproc visit, void *arg)
1536{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001537 propertyobject *pp = (propertyobject *)self;
1538 Py_VISIT(pp->prop_get);
1539 Py_VISIT(pp->prop_set);
1540 Py_VISIT(pp->prop_del);
1541 Py_VISIT(pp->prop_doc);
1542 return 0;
Guido van Rossum048eb752001-10-02 21:24:57 +00001543}
1544
Raymond Hettingerd4be6912015-05-13 11:12:33 -07001545static int
1546property_clear(PyObject *self)
1547{
1548 propertyobject *pp = (propertyobject *)self;
1549 Py_CLEAR(pp->prop_doc);
1550 return 0;
1551}
1552
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001553#include "clinic/descrobject.c.h"
1554
1555PyTypeObject PyDictProxy_Type = {
1556 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1557 "mappingproxy", /* tp_name */
1558 sizeof(mappingproxyobject), /* tp_basicsize */
1559 0, /* tp_itemsize */
1560 /* methods */
1561 (destructor)mappingproxy_dealloc, /* tp_dealloc */
1562 0, /* tp_print */
1563 0, /* tp_getattr */
1564 0, /* tp_setattr */
1565 0, /* tp_reserved */
1566 (reprfunc)mappingproxy_repr, /* tp_repr */
1567 0, /* tp_as_number */
1568 &mappingproxy_as_sequence, /* tp_as_sequence */
1569 &mappingproxy_as_mapping, /* tp_as_mapping */
1570 0, /* tp_hash */
1571 0, /* tp_call */
1572 (reprfunc)mappingproxy_str, /* tp_str */
1573 PyObject_GenericGetAttr, /* tp_getattro */
1574 0, /* tp_setattro */
1575 0, /* tp_as_buffer */
1576 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
1577 0, /* tp_doc */
1578 mappingproxy_traverse, /* tp_traverse */
1579 0, /* tp_clear */
1580 (richcmpfunc)mappingproxy_richcompare, /* tp_richcompare */
1581 0, /* tp_weaklistoffset */
1582 (getiterfunc)mappingproxy_getiter, /* tp_iter */
1583 0, /* tp_iternext */
1584 mappingproxy_methods, /* tp_methods */
1585 0, /* tp_members */
1586 0, /* tp_getset */
1587 0, /* tp_base */
1588 0, /* tp_dict */
1589 0, /* tp_descr_get */
1590 0, /* tp_descr_set */
1591 0, /* tp_dictoffset */
1592 0, /* tp_init */
1593 0, /* tp_alloc */
1594 mappingproxy_new, /* tp_new */
1595};
1596
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001597PyTypeObject PyProperty_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001598 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1599 "property", /* tp_name */
1600 sizeof(propertyobject), /* tp_basicsize */
1601 0, /* tp_itemsize */
1602 /* methods */
1603 property_dealloc, /* tp_dealloc */
1604 0, /* tp_print */
1605 0, /* tp_getattr */
1606 0, /* tp_setattr */
1607 0, /* tp_reserved */
1608 0, /* tp_repr */
1609 0, /* tp_as_number */
1610 0, /* tp_as_sequence */
1611 0, /* tp_as_mapping */
1612 0, /* tp_hash */
1613 0, /* tp_call */
1614 0, /* tp_str */
1615 PyObject_GenericGetAttr, /* tp_getattro */
1616 0, /* tp_setattro */
1617 0, /* tp_as_buffer */
1618 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
1619 Py_TPFLAGS_BASETYPE, /* tp_flags */
Serhiy Storchaka18b250f2017-03-19 08:51:07 +02001620 property_init__doc__, /* tp_doc */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001621 property_traverse, /* tp_traverse */
Raymond Hettingerd4be6912015-05-13 11:12:33 -07001622 (inquiry)property_clear, /* tp_clear */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001623 0, /* tp_richcompare */
1624 0, /* tp_weaklistoffset */
1625 0, /* tp_iter */
1626 0, /* tp_iternext */
1627 property_methods, /* tp_methods */
1628 property_members, /* tp_members */
Benjamin Petersonbfebb7b2011-12-15 15:34:02 -05001629 property_getsetlist, /* tp_getset */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001630 0, /* tp_base */
1631 0, /* tp_dict */
1632 property_descr_get, /* tp_descr_get */
1633 property_descr_set, /* tp_descr_set */
1634 0, /* tp_dictoffset */
1635 property_init, /* tp_init */
1636 PyType_GenericAlloc, /* tp_alloc */
1637 PyType_GenericNew, /* tp_new */
1638 PyObject_GC_Del, /* tp_free */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001639};