Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1 | /* Descriptors -- a new, flexible way to describe attributes */ |
| 2 | |
| 3 | #include "Python.h" |
Victor Stinner | bcda8f1 | 2018-11-21 22:27:47 +0100 | [diff] [blame] | 4 | #include "pycore_object.h" |
Victor Stinner | 621cebe | 2018-11-12 16:53:38 +0100 | [diff] [blame] | 5 | #include "pycore_pystate.h" |
Victor Stinner | ec13b93 | 2018-11-25 23:56:17 +0100 | [diff] [blame] | 6 | #include "pycore_tupleobject.h" |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 7 | #include "structmember.h" /* Why is this not included in Python.h? */ |
| 8 | |
Serhiy Storchaka | 18b250f | 2017-03-19 08:51:07 +0200 | [diff] [blame] | 9 | /*[clinic input] |
| 10 | class mappingproxy "mappingproxyobject *" "&PyDictProxy_Type" |
| 11 | class property "propertyobject *" "&PyProperty_Type" |
| 12 | [clinic start generated code]*/ |
| 13 | /*[clinic end generated code: output=da39a3ee5e6b4b0d input=556352653fd4c02e]*/ |
| 14 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 15 | static void |
| 16 | descr_dealloc(PyDescrObject *descr) |
| 17 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 18 | _PyObject_GC_UNTRACK(descr); |
| 19 | Py_XDECREF(descr->d_type); |
| 20 | Py_XDECREF(descr->d_name); |
Antoine Pitrou | 9d57481 | 2011-12-12 13:47:25 +0100 | [diff] [blame] | 21 | Py_XDECREF(descr->d_qualname); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 22 | PyObject_GC_Del(descr); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 23 | } |
| 24 | |
Walter Dörwald | d7fb764 | 2007-06-11 16:36:59 +0000 | [diff] [blame] | 25 | static PyObject * |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 26 | descr_name(PyDescrObject *descr) |
| 27 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 28 | if (descr->d_name != NULL && PyUnicode_Check(descr->d_name)) |
| 29 | return descr->d_name; |
| 30 | return NULL; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 31 | } |
| 32 | |
| 33 | static PyObject * |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 34 | descr_repr(PyDescrObject *descr, const char *format) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 35 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 36 | PyObject *name = NULL; |
| 37 | if (descr->d_name != NULL && PyUnicode_Check(descr->d_name)) |
| 38 | name = descr->d_name; |
Walter Dörwald | d7fb764 | 2007-06-11 16:36:59 +0000 | [diff] [blame] | 39 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 40 | return PyUnicode_FromFormat(format, name, "?", descr->d_type->tp_name); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 41 | } |
| 42 | |
| 43 | static PyObject * |
| 44 | method_repr(PyMethodDescrObject *descr) |
| 45 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 46 | return descr_repr((PyDescrObject *)descr, |
| 47 | "<method '%V' of '%s' objects>"); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 48 | } |
| 49 | |
| 50 | static PyObject * |
| 51 | member_repr(PyMemberDescrObject *descr) |
| 52 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 53 | return descr_repr((PyDescrObject *)descr, |
| 54 | "<member '%V' of '%s' objects>"); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 55 | } |
| 56 | |
| 57 | static PyObject * |
| 58 | getset_repr(PyGetSetDescrObject *descr) |
| 59 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 60 | return descr_repr((PyDescrObject *)descr, |
| 61 | "<attribute '%V' of '%s' objects>"); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 62 | } |
| 63 | |
| 64 | static PyObject * |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 65 | wrapperdescr_repr(PyWrapperDescrObject *descr) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 66 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 67 | return descr_repr((PyDescrObject *)descr, |
| 68 | "<slot wrapper '%V' of '%s' objects>"); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 69 | } |
| 70 | |
| 71 | static int |
Guido van Rossum | b6e5a0c | 2003-02-11 18:44:42 +0000 | [diff] [blame] | 72 | descr_check(PyDescrObject *descr, PyObject *obj, PyObject **pres) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 73 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 74 | 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 Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 90 | } |
| 91 | |
| 92 | static PyObject * |
Guido van Rossum | b6e5a0c | 2003-02-11 18:44:42 +0000 | [diff] [blame] | 93 | classmethod_get(PyMethodDescrObject *descr, PyObject *obj, PyObject *type) |
Tim Peters | bca1cbc | 2002-12-09 22:56:13 +0000 | [diff] [blame] | 94 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 95 | /* 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 Svetlov | 3ba3a3e | 2012-12-25 13:32:35 +0200 | [diff] [blame] | 127 | return PyCFunction_NewEx(descr->d_method, type, NULL); |
Tim Peters | bca1cbc | 2002-12-09 22:56:13 +0000 | [diff] [blame] | 128 | } |
| 129 | |
| 130 | static PyObject * |
Guido van Rossum | b6e5a0c | 2003-02-11 18:44:42 +0000 | [diff] [blame] | 131 | method_get(PyMethodDescrObject *descr, PyObject *obj, PyObject *type) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 132 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 133 | PyObject *res; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 134 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 135 | if (descr_check((PyDescrObject *)descr, obj, &res)) |
| 136 | return res; |
Andrew Svetlov | 3ba3a3e | 2012-12-25 13:32:35 +0200 | [diff] [blame] | 137 | return PyCFunction_NewEx(descr->d_method, obj, NULL); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 138 | } |
| 139 | |
| 140 | static PyObject * |
Guido van Rossum | b6e5a0c | 2003-02-11 18:44:42 +0000 | [diff] [blame] | 141 | member_get(PyMemberDescrObject *descr, PyObject *obj, PyObject *type) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 142 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 143 | PyObject *res; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 144 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 145 | if (descr_check((PyDescrObject *)descr, obj, &res)) |
| 146 | return res; |
| 147 | return PyMember_GetOne((char *)obj, descr->d_member); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 148 | } |
| 149 | |
| 150 | static PyObject * |
Guido van Rossum | b6e5a0c | 2003-02-11 18:44:42 +0000 | [diff] [blame] | 151 | getset_get(PyGetSetDescrObject *descr, PyObject *obj, PyObject *type) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 152 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 153 | PyObject *res; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 154 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 155 | 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 Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 164 | } |
| 165 | |
| 166 | static PyObject * |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 167 | wrapperdescr_get(PyWrapperDescrObject *descr, PyObject *obj, PyObject *type) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 168 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 169 | PyObject *res; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 170 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 171 | if (descr_check((PyDescrObject *)descr, obj, &res)) |
| 172 | return res; |
| 173 | return PyWrapper_New((PyObject *)descr, obj); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 174 | } |
| 175 | |
| 176 | static int |
| 177 | descr_setcheck(PyDescrObject *descr, PyObject *obj, PyObject *value, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 178 | int *pres) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 179 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 180 | 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 Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 192 | } |
| 193 | |
| 194 | static int |
| 195 | member_set(PyMemberDescrObject *descr, PyObject *obj, PyObject *value) |
| 196 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 197 | int res; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 198 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 199 | if (descr_setcheck((PyDescrObject *)descr, obj, value, &res)) |
| 200 | return res; |
| 201 | return PyMember_SetOne((char *)obj, descr->d_member, value); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 202 | } |
| 203 | |
| 204 | static int |
| 205 | getset_set(PyGetSetDescrObject *descr, PyObject *obj, PyObject *value) |
| 206 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 207 | int res; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 208 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 209 | 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 Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 219 | } |
| 220 | |
| 221 | static PyObject * |
Victor Stinner | c525723 | 2017-01-18 10:38:09 +0100 | [diff] [blame] | 222 | methoddescr_call(PyMethodDescrObject *descr, PyObject *args, PyObject *kwargs) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 223 | { |
Victor Stinner | c525723 | 2017-01-18 10:38:09 +0100 | [diff] [blame] | 224 | Py_ssize_t nargs; |
| 225 | PyObject *self, *result; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 226 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 227 | /* Make sure that the first argument is acceptable as 'self' */ |
| 228 | assert(PyTuple_Check(args)); |
Victor Stinner | c525723 | 2017-01-18 10:38:09 +0100 | [diff] [blame] | 229 | nargs = PyTuple_GET_SIZE(args); |
| 230 | if (nargs < 1) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 231 | 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 Stinner | 3249dec | 2011-05-01 23:19:15 +0200 | [diff] [blame] | 239 | if (!_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self), |
Victor Stinner | d956131 | 2011-05-01 23:31:36 +0200 | [diff] [blame] | 240 | (PyObject *)PyDescr_TYPE(descr))) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 241 | 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 Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 250 | |
Victor Stinner | c525723 | 2017-01-18 10:38:09 +0100 | [diff] [blame] | 251 | result = _PyMethodDef_RawFastCallDict(descr->d_method, self, |
Victor Stinner | d17a693 | 2018-11-09 16:56:48 +0100 | [diff] [blame] | 252 | &_PyTuple_ITEMS(args)[1], nargs - 1, |
Victor Stinner | c525723 | 2017-01-18 10:38:09 +0100 | [diff] [blame] | 253 | kwargs); |
| 254 | result = _Py_CheckFunctionResult((PyObject *)descr, result, NULL); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 255 | return result; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 256 | } |
| 257 | |
INADA Naoki | 5566bbb | 2017-02-03 07:43:03 +0900 | [diff] [blame] | 258 | // same to methoddescr_call(), but use FASTCALL convention. |
| 259 | PyObject * |
| 260 | _PyMethodDescr_FastCallKeywords(PyObject *descrobj, |
Serhiy Storchaka | a5552f0 | 2017-12-15 13:11:11 +0200 | [diff] [blame] | 261 | PyObject *const *args, Py_ssize_t nargs, |
INADA Naoki | 5566bbb | 2017-02-03 07:43:03 +0900 | [diff] [blame] | 262 | 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 Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 296 | static PyObject * |
Tim Peters | bca1cbc | 2002-12-09 22:56:13 +0000 | [diff] [blame] | 297 | classmethoddescr_call(PyMethodDescrObject *descr, PyObject *args, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 298 | PyObject *kwds) |
Tim Peters | bca1cbc | 2002-12-09 22:56:13 +0000 | [diff] [blame] | 299 | { |
Benjamin Peterson | 7295c6a | 2012-05-01 09:51:09 -0400 | [diff] [blame] | 300 | Py_ssize_t argc; |
Serhiy Storchaka | 5e02c78 | 2017-09-21 14:25:36 +0300 | [diff] [blame] | 301 | PyObject *self, *result; |
Tim Peters | bca1cbc | 2002-12-09 22:56:13 +0000 | [diff] [blame] | 302 | |
Benjamin Peterson | 7295c6a | 2012-05-01 09:51:09 -0400 | [diff] [blame] | 303 | /* 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 Storchaka | 5e02c78 | 2017-09-21 14:25:36 +0300 | [diff] [blame] | 335 | result = _PyMethodDef_RawFastCallDict(descr->d_method, self, |
Victor Stinner | d17a693 | 2018-11-09 16:56:48 +0100 | [diff] [blame] | 336 | &_PyTuple_ITEMS(args)[1], argc - 1, |
Serhiy Storchaka | 5e02c78 | 2017-09-21 14:25:36 +0300 | [diff] [blame] | 337 | kwds); |
| 338 | result = _Py_CheckFunctionResult((PyObject *)descr, result, NULL); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 339 | return result; |
Tim Peters | bca1cbc | 2002-12-09 22:56:13 +0000 | [diff] [blame] | 340 | } |
| 341 | |
Serhiy Storchaka | 5e02c78 | 2017-09-21 14:25:36 +0300 | [diff] [blame] | 342 | Py_LOCAL_INLINE(PyObject *) |
| 343 | wrapperdescr_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 Storchaka | 1c60715 | 2018-11-27 21:34:27 +0200 | [diff] [blame] | 349 | wrapperfunc_kwds wk = (wrapperfunc_kwds)(void(*)(void))wrapper; |
Serhiy Storchaka | 5e02c78 | 2017-09-21 14:25:36 +0300 | [diff] [blame] | 350 | 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 Peters | bca1cbc | 2002-12-09 22:56:13 +0000 | [diff] [blame] | 362 | static PyObject * |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 363 | wrapperdescr_call(PyWrapperDescrObject *descr, PyObject *args, PyObject *kwds) |
| 364 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 365 | Py_ssize_t argc; |
Serhiy Storchaka | 5e02c78 | 2017-09-21 14:25:36 +0300 | [diff] [blame] | 366 | PyObject *self, *result; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 367 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 368 | /* 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 Stinner | 3249dec | 2011-05-01 23:19:15 +0200 | [diff] [blame] | 380 | if (!_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self), |
Victor Stinner | d956131 | 2011-05-01 23:31:36 +0200 | [diff] [blame] | 381 | (PyObject *)PyDescr_TYPE(descr))) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 382 | 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 Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 391 | |
Serhiy Storchaka | 5e02c78 | 2017-09-21 14:25:36 +0300 | [diff] [blame] | 392 | args = PyTuple_GetSlice(args, 1, argc); |
| 393 | if (args == NULL) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 394 | return NULL; |
Serhiy Storchaka | 5e02c78 | 2017-09-21 14:25:36 +0300 | [diff] [blame] | 395 | } |
| 396 | result = wrapperdescr_raw_call(descr, self, args, kwds); |
| 397 | Py_DECREF(args); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 398 | return result; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 399 | } |
| 400 | |
Serhiy Storchaka | 5e02c78 | 2017-09-21 14:25:36 +0300 | [diff] [blame] | 401 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 402 | static PyObject * |
Guido van Rossum | 6f79937 | 2001-09-20 20:46:19 +0000 | [diff] [blame] | 403 | method_get_doc(PyMethodDescrObject *descr, void *closure) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 404 | { |
Larry Hastings | 2623c8c | 2014-02-08 22:15:29 -0800 | [diff] [blame] | 405 | return _PyType_GetDocFromInternalDoc(descr->d_method->ml_name, descr->d_method->ml_doc); |
Larry Hastings | 5c66189 | 2014-01-24 06:17:25 -0800 | [diff] [blame] | 406 | } |
| 407 | |
| 408 | static PyObject * |
| 409 | method_get_text_signature(PyMethodDescrObject *descr, void *closure) |
| 410 | { |
Larry Hastings | 2623c8c | 2014-02-08 22:15:29 -0800 | [diff] [blame] | 411 | return _PyType_GetTextSignatureFromInternalDoc(descr->d_method->ml_name, descr->d_method->ml_doc); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 412 | } |
| 413 | |
Antoine Pitrou | 9d57481 | 2011-12-12 13:47:25 +0100 | [diff] [blame] | 414 | static PyObject * |
| 415 | calculate_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 | |
| 443 | static PyObject * |
Serhiy Storchaka | d4f9cf5 | 2018-11-27 19:34:35 +0200 | [diff] [blame] | 444 | descr_get_qualname(PyDescrObject *descr, void *Py_UNUSED(ignored)) |
Antoine Pitrou | 9d57481 | 2011-12-12 13:47:25 +0100 | [diff] [blame] | 445 | { |
| 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 Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 452 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 453 | descr_reduce(PyDescrObject *descr, PyObject *Py_UNUSED(ignored)) |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 454 | { |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 455 | _Py_IDENTIFIER(getattr); |
Serhiy Storchaka | bb86bf4 | 2018-12-11 08:28:18 +0200 | [diff] [blame] | 456 | return Py_BuildValue("N(OO)", _PyEval_GetBuiltinId(&PyId_getattr), |
| 457 | PyDescr_TYPE(descr), PyDescr_NAME(descr)); |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 458 | } |
| 459 | |
| 460 | static PyMethodDef descr_methods[] = { |
| 461 | {"__reduce__", (PyCFunction)descr_reduce, METH_NOARGS, NULL}, |
| 462 | {NULL, NULL} |
| 463 | }; |
| 464 | |
Guido van Rossum | 6f79937 | 2001-09-20 20:46:19 +0000 | [diff] [blame] | 465 | static PyMemberDef descr_members[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 466 | {"__objclass__", T_OBJECT, offsetof(PyDescrObject, d_type), READONLY}, |
| 467 | {"__name__", T_OBJECT, offsetof(PyDescrObject, d_name), READONLY}, |
| 468 | {0} |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 469 | }; |
| 470 | |
Guido van Rossum | 32d34c8 | 2001-09-20 21:45:26 +0000 | [diff] [blame] | 471 | static PyGetSetDef method_getset[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 472 | {"__doc__", (getter)method_get_doc}, |
Antoine Pitrou | 9d57481 | 2011-12-12 13:47:25 +0100 | [diff] [blame] | 473 | {"__qualname__", (getter)descr_get_qualname}, |
Larry Hastings | 5c66189 | 2014-01-24 06:17:25 -0800 | [diff] [blame] | 474 | {"__text_signature__", (getter)method_get_text_signature}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 475 | {0} |
Guido van Rossum | 6f79937 | 2001-09-20 20:46:19 +0000 | [diff] [blame] | 476 | }; |
| 477 | |
| 478 | static PyObject * |
| 479 | member_get_doc(PyMemberDescrObject *descr, void *closure) |
| 480 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 481 | if (descr->d_member->doc == NULL) { |
Serhiy Storchaka | 228b12e | 2017-01-23 09:47:21 +0200 | [diff] [blame] | 482 | Py_RETURN_NONE; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 483 | } |
| 484 | return PyUnicode_FromString(descr->d_member->doc); |
Guido van Rossum | 6f79937 | 2001-09-20 20:46:19 +0000 | [diff] [blame] | 485 | } |
| 486 | |
Guido van Rossum | 32d34c8 | 2001-09-20 21:45:26 +0000 | [diff] [blame] | 487 | static PyGetSetDef member_getset[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 488 | {"__doc__", (getter)member_get_doc}, |
Antoine Pitrou | 9d57481 | 2011-12-12 13:47:25 +0100 | [diff] [blame] | 489 | {"__qualname__", (getter)descr_get_qualname}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 490 | {0} |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 491 | }; |
| 492 | |
| 493 | static PyObject * |
Guido van Rossum | 32d34c8 | 2001-09-20 21:45:26 +0000 | [diff] [blame] | 494 | getset_get_doc(PyGetSetDescrObject *descr, void *closure) |
| 495 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 496 | if (descr->d_getset->doc == NULL) { |
Serhiy Storchaka | 228b12e | 2017-01-23 09:47:21 +0200 | [diff] [blame] | 497 | Py_RETURN_NONE; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 498 | } |
| 499 | return PyUnicode_FromString(descr->d_getset->doc); |
Guido van Rossum | 32d34c8 | 2001-09-20 21:45:26 +0000 | [diff] [blame] | 500 | } |
| 501 | |
| 502 | static PyGetSetDef getset_getset[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 503 | {"__doc__", (getter)getset_get_doc}, |
Antoine Pitrou | 9d57481 | 2011-12-12 13:47:25 +0100 | [diff] [blame] | 504 | {"__qualname__", (getter)descr_get_qualname}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 505 | {0} |
Guido van Rossum | 32d34c8 | 2001-09-20 21:45:26 +0000 | [diff] [blame] | 506 | }; |
| 507 | |
| 508 | static PyObject * |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 509 | wrapperdescr_get_doc(PyWrapperDescrObject *descr, void *closure) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 510 | { |
Larry Hastings | 2623c8c | 2014-02-08 22:15:29 -0800 | [diff] [blame] | 511 | return _PyType_GetDocFromInternalDoc(descr->d_base->name, descr->d_base->doc); |
Larry Hastings | 5c66189 | 2014-01-24 06:17:25 -0800 | [diff] [blame] | 512 | } |
| 513 | |
| 514 | static PyObject * |
| 515 | wrapperdescr_get_text_signature(PyWrapperDescrObject *descr, void *closure) |
| 516 | { |
Larry Hastings | 2623c8c | 2014-02-08 22:15:29 -0800 | [diff] [blame] | 517 | return _PyType_GetTextSignatureFromInternalDoc(descr->d_base->name, descr->d_base->doc); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 518 | } |
| 519 | |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 520 | static PyGetSetDef wrapperdescr_getset[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 521 | {"__doc__", (getter)wrapperdescr_get_doc}, |
Antoine Pitrou | 9d57481 | 2011-12-12 13:47:25 +0100 | [diff] [blame] | 522 | {"__qualname__", (getter)descr_get_qualname}, |
Larry Hastings | 5c66189 | 2014-01-24 06:17:25 -0800 | [diff] [blame] | 523 | {"__text_signature__", (getter)wrapperdescr_get_text_signature}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 524 | {0} |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 525 | }; |
| 526 | |
Guido van Rossum | 048eb75 | 2001-10-02 21:24:57 +0000 | [diff] [blame] | 527 | static int |
| 528 | descr_traverse(PyObject *self, visitproc visit, void *arg) |
| 529 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 530 | PyDescrObject *descr = (PyDescrObject *)self; |
| 531 | Py_VISIT(descr->d_type); |
| 532 | return 0; |
Guido van Rossum | 048eb75 | 2001-10-02 21:24:57 +0000 | [diff] [blame] | 533 | } |
| 534 | |
Christian Heimes | a22e8bd | 2007-11-29 22:35:39 +0000 | [diff] [blame] | 535 | PyTypeObject PyMethodDescr_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 536 | 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 Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 563 | descr_methods, /* tp_methods */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 564 | 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 Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 570 | }; |
| 571 | |
Guido van Rossum | b6e5a0c | 2003-02-11 18:44:42 +0000 | [diff] [blame] | 572 | /* This is for METH_CLASS in C, not for "f = classmethod(f)" in Python! */ |
Christian Heimes | a22e8bd | 2007-11-29 22:35:39 +0000 | [diff] [blame] | 573 | PyTypeObject PyClassMethodDescr_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 574 | 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 Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 601 | descr_methods, /* tp_methods */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 602 | 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 Peters | bca1cbc | 2002-12-09 22:56:13 +0000 | [diff] [blame] | 608 | }; |
| 609 | |
Christian Heimes | a22e8bd | 2007-11-29 22:35:39 +0000 | [diff] [blame] | 610 | PyTypeObject PyMemberDescr_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 611 | 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 Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 638 | descr_methods, /* tp_methods */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 639 | 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 Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 645 | }; |
| 646 | |
Christian Heimes | a22e8bd | 2007-11-29 22:35:39 +0000 | [diff] [blame] | 647 | PyTypeObject PyGetSetDescr_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 648 | 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 Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 682 | }; |
| 683 | |
Guido van Rossum | f4593e0 | 2001-10-03 12:09:30 +0000 | [diff] [blame] | 684 | PyTypeObject PyWrapperDescr_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 685 | 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 Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 712 | descr_methods, /* tp_methods */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 713 | 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 Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 719 | }; |
| 720 | |
| 721 | static PyDescrObject * |
Jeremy Hylton | af68c87 | 2005-12-10 18:50:16 +0000 | [diff] [blame] | 722 | descr_new(PyTypeObject *descrtype, PyTypeObject *type, const char *name) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 723 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 724 | PyDescrObject *descr; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 725 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 726 | 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 Peterson | f2fe7f0 | 2011-12-17 08:02:20 -0500 | [diff] [blame] | 735 | else { |
| 736 | descr->d_qualname = NULL; |
| 737 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 738 | } |
| 739 | return descr; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 740 | } |
| 741 | |
| 742 | PyObject * |
| 743 | PyDescr_NewMethod(PyTypeObject *type, PyMethodDef *method) |
| 744 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 745 | PyMethodDescrObject *descr; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 746 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 747 | 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 Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 752 | } |
| 753 | |
| 754 | PyObject * |
Tim Peters | bca1cbc | 2002-12-09 22:56:13 +0000 | [diff] [blame] | 755 | PyDescr_NewClassMethod(PyTypeObject *type, PyMethodDef *method) |
| 756 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 757 | PyMethodDescrObject *descr; |
Tim Peters | bca1cbc | 2002-12-09 22:56:13 +0000 | [diff] [blame] | 758 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 759 | 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 Peters | bca1cbc | 2002-12-09 22:56:13 +0000 | [diff] [blame] | 764 | } |
| 765 | |
| 766 | PyObject * |
Guido van Rossum | 6f79937 | 2001-09-20 20:46:19 +0000 | [diff] [blame] | 767 | PyDescr_NewMember(PyTypeObject *type, PyMemberDef *member) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 768 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 769 | PyMemberDescrObject *descr; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 770 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 771 | descr = (PyMemberDescrObject *)descr_new(&PyMemberDescr_Type, |
| 772 | type, member->name); |
| 773 | if (descr != NULL) |
| 774 | descr->d_member = member; |
| 775 | return (PyObject *)descr; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 776 | } |
| 777 | |
| 778 | PyObject * |
Guido van Rossum | 32d34c8 | 2001-09-20 21:45:26 +0000 | [diff] [blame] | 779 | PyDescr_NewGetSet(PyTypeObject *type, PyGetSetDef *getset) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 780 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 781 | PyGetSetDescrObject *descr; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 782 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 783 | descr = (PyGetSetDescrObject *)descr_new(&PyGetSetDescr_Type, |
| 784 | type, getset->name); |
| 785 | if (descr != NULL) |
| 786 | descr->d_getset = getset; |
| 787 | return (PyObject *)descr; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 788 | } |
| 789 | |
| 790 | PyObject * |
| 791 | PyDescr_NewWrapper(PyTypeObject *type, struct wrapperbase *base, void *wrapped) |
| 792 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 793 | PyWrapperDescrObject *descr; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 794 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 795 | 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 Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 802 | } |
| 803 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 804 | |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 805 | /* --- mappingproxy: read-only proxy for mappings --- */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 806 | |
| 807 | /* This has no reason to be in this file except that adding new files is a |
| 808 | bit of a pain */ |
| 809 | |
| 810 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 811 | PyObject_HEAD |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 812 | PyObject *mapping; |
| 813 | } mappingproxyobject; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 814 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 815 | static Py_ssize_t |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 816 | mappingproxy_len(mappingproxyobject *pp) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 817 | { |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 818 | return PyObject_Size(pp->mapping); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 819 | } |
| 820 | |
| 821 | static PyObject * |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 822 | mappingproxy_getitem(mappingproxyobject *pp, PyObject *key) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 823 | { |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 824 | return PyObject_GetItem(pp->mapping, key); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 825 | } |
| 826 | |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 827 | static PyMappingMethods mappingproxy_as_mapping = { |
| 828 | (lenfunc)mappingproxy_len, /* mp_length */ |
| 829 | (binaryfunc)mappingproxy_getitem, /* mp_subscript */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 830 | 0, /* mp_ass_subscript */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 831 | }; |
| 832 | |
| 833 | static int |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 834 | mappingproxy_contains(mappingproxyobject *pp, PyObject *key) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 835 | { |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 836 | if (PyDict_CheckExact(pp->mapping)) |
| 837 | return PyDict_Contains(pp->mapping, key); |
| 838 | else |
| 839 | return PySequence_Contains(pp->mapping, key); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 840 | } |
| 841 | |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 842 | static PySequenceMethods mappingproxy_as_sequence = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 843 | 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 Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 850 | (objobjproc)mappingproxy_contains, /* sq_contains */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 851 | 0, /* sq_inplace_concat */ |
| 852 | 0, /* sq_inplace_repeat */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 853 | }; |
| 854 | |
| 855 | static PyObject * |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 856 | mappingproxy_get(mappingproxyobject *pp, PyObject *args) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 857 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 858 | PyObject *key, *def = Py_None; |
Martin v. Löwis | bd928fe | 2011-10-14 10:20:37 +0200 | [diff] [blame] | 859 | _Py_IDENTIFIER(get); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 860 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 861 | if (!PyArg_UnpackTuple(args, "get", 1, 2, &key, &def)) |
| 862 | return NULL; |
Victor Stinner | 7e42541 | 2016-12-09 00:36:19 +0100 | [diff] [blame] | 863 | return _PyObject_CallMethodIdObjArgs(pp->mapping, &PyId_get, |
| 864 | key, def, NULL); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 865 | } |
| 866 | |
| 867 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 868 | mappingproxy_keys(mappingproxyobject *pp, PyObject *Py_UNUSED(ignored)) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 869 | { |
Martin v. Löwis | bd928fe | 2011-10-14 10:20:37 +0200 | [diff] [blame] | 870 | _Py_IDENTIFIER(keys); |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 871 | return _PyObject_CallMethodId(pp->mapping, &PyId_keys, NULL); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 872 | } |
| 873 | |
| 874 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 875 | mappingproxy_values(mappingproxyobject *pp, PyObject *Py_UNUSED(ignored)) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 876 | { |
Martin v. Löwis | bd928fe | 2011-10-14 10:20:37 +0200 | [diff] [blame] | 877 | _Py_IDENTIFIER(values); |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 878 | return _PyObject_CallMethodId(pp->mapping, &PyId_values, NULL); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 879 | } |
| 880 | |
| 881 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 882 | mappingproxy_items(mappingproxyobject *pp, PyObject *Py_UNUSED(ignored)) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 883 | { |
Martin v. Löwis | bd928fe | 2011-10-14 10:20:37 +0200 | [diff] [blame] | 884 | _Py_IDENTIFIER(items); |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 885 | return _PyObject_CallMethodId(pp->mapping, &PyId_items, NULL); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 886 | } |
| 887 | |
| 888 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 889 | mappingproxy_copy(mappingproxyobject *pp, PyObject *Py_UNUSED(ignored)) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 890 | { |
Martin v. Löwis | bd928fe | 2011-10-14 10:20:37 +0200 | [diff] [blame] | 891 | _Py_IDENTIFIER(copy); |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 892 | return _PyObject_CallMethodId(pp->mapping, &PyId_copy, NULL); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 893 | } |
| 894 | |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 895 | /* WARNING: mappingproxy methods must not give access |
| 896 | to the underlying mapping */ |
| 897 | |
| 898 | static PyMethodDef mappingproxy_methods[] = { |
| 899 | {"get", (PyCFunction)mappingproxy_get, METH_VARARGS, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 900 | PyDoc_STR("D.get(k[,d]) -> D[k] if k in D, else d." |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 901 | " d defaults to None.")}, |
| 902 | {"keys", (PyCFunction)mappingproxy_keys, METH_NOARGS, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 903 | PyDoc_STR("D.keys() -> list of D's keys")}, |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 904 | {"values", (PyCFunction)mappingproxy_values, METH_NOARGS, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 905 | PyDoc_STR("D.values() -> list of D's values")}, |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 906 | {"items", (PyCFunction)mappingproxy_items, METH_NOARGS, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 907 | PyDoc_STR("D.items() -> list of D's (key, value) pairs, as 2-tuples")}, |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 908 | {"copy", (PyCFunction)mappingproxy_copy, METH_NOARGS, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 909 | PyDoc_STR("D.copy() -> a shallow copy of D")}, |
| 910 | {0} |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 911 | }; |
| 912 | |
| 913 | static void |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 914 | mappingproxy_dealloc(mappingproxyobject *pp) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 915 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 916 | _PyObject_GC_UNTRACK(pp); |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 917 | Py_DECREF(pp->mapping); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 918 | PyObject_GC_Del(pp); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 919 | } |
| 920 | |
| 921 | static PyObject * |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 922 | mappingproxy_getiter(mappingproxyobject *pp) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 923 | { |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 924 | return PyObject_GetIter(pp->mapping); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 925 | } |
| 926 | |
Neil Schemenauer | 2677512 | 2001-10-21 22:26:43 +0000 | [diff] [blame] | 927 | static PyObject * |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 928 | mappingproxy_str(mappingproxyobject *pp) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 929 | { |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 930 | return PyObject_Str(pp->mapping); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 931 | } |
| 932 | |
Ezio Melotti | ac53ab6 | 2010-12-18 14:59:43 +0000 | [diff] [blame] | 933 | static PyObject * |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 934 | mappingproxy_repr(mappingproxyobject *pp) |
Ezio Melotti | ac53ab6 | 2010-12-18 14:59:43 +0000 | [diff] [blame] | 935 | { |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 936 | return PyUnicode_FromFormat("mappingproxy(%R)", pp->mapping); |
Ezio Melotti | ac53ab6 | 2010-12-18 14:59:43 +0000 | [diff] [blame] | 937 | } |
| 938 | |
Guido van Rossum | 048eb75 | 2001-10-02 21:24:57 +0000 | [diff] [blame] | 939 | static int |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 940 | mappingproxy_traverse(PyObject *self, visitproc visit, void *arg) |
Guido van Rossum | 048eb75 | 2001-10-02 21:24:57 +0000 | [diff] [blame] | 941 | { |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 942 | mappingproxyobject *pp = (mappingproxyobject *)self; |
| 943 | Py_VISIT(pp->mapping); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 944 | return 0; |
Guido van Rossum | 048eb75 | 2001-10-02 21:24:57 +0000 | [diff] [blame] | 945 | } |
| 946 | |
Raymond Hettinger | 29a6d44 | 2002-08-31 15:51:04 +0000 | [diff] [blame] | 947 | static PyObject * |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 948 | mappingproxy_richcompare(mappingproxyobject *v, PyObject *w, int op) |
Raymond Hettinger | 29a6d44 | 2002-08-31 15:51:04 +0000 | [diff] [blame] | 949 | { |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 950 | return PyObject_RichCompare(v->mapping, w, op); |
| 951 | } |
| 952 | |
| 953 | static int |
| 954 | mappingproxy_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 Storchaka | 18b250f | 2017-03-19 08:51:07 +0200 | [diff] [blame] | 967 | /*[clinic input] |
| 968 | @classmethod |
| 969 | mappingproxy.__new__ as mappingproxy_new |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 970 | |
Serhiy Storchaka | 18b250f | 2017-03-19 08:51:07 +0200 | [diff] [blame] | 971 | mapping: object |
| 972 | |
| 973 | [clinic start generated code]*/ |
| 974 | |
| 975 | static PyObject * |
| 976 | mappingproxy_new_impl(PyTypeObject *type, PyObject *mapping) |
| 977 | /*[clinic end generated code: output=65f27f02d5b68fa7 input=d2d620d4f598d4f8]*/ |
| 978 | { |
| 979 | mappingproxyobject *mappingproxy; |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 980 | |
| 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 Hettinger | 29a6d44 | 2002-08-31 15:51:04 +0000 | [diff] [blame] | 991 | } |
| 992 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 993 | PyObject * |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 994 | PyDictProxy_New(PyObject *mapping) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 995 | { |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 996 | mappingproxyobject *pp; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 997 | |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 998 | if (mappingproxy_check_mapping(mapping) == -1) |
| 999 | return NULL; |
| 1000 | |
| 1001 | pp = PyObject_GC_New(mappingproxyobject, &PyDictProxy_Type); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1002 | if (pp != NULL) { |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 1003 | Py_INCREF(mapping); |
| 1004 | pp->mapping = mapping; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1005 | _PyObject_GC_TRACK(pp); |
| 1006 | } |
| 1007 | return (PyObject *)pp; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1008 | } |
| 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 | |
| 1016 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1017 | PyObject_HEAD |
| 1018 | PyWrapperDescrObject *descr; |
| 1019 | PyObject *self; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1020 | } wrapperobject; |
| 1021 | |
Benjamin Peterson | eff61f6 | 2011-09-01 16:32:31 -0400 | [diff] [blame] | 1022 | #define Wrapper_Check(v) (Py_TYPE(v) == &_PyMethodWrapper_Type) |
Mark Dickinson | 211c625 | 2009-02-01 10:28:51 +0000 | [diff] [blame] | 1023 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1024 | static void |
| 1025 | wrapper_dealloc(wrapperobject *wp) |
| 1026 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1027 | 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 Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1033 | } |
| 1034 | |
Mark Dickinson | 211c625 | 2009-02-01 10:28:51 +0000 | [diff] [blame] | 1035 | static PyObject * |
| 1036 | wrapper_richcompare(PyObject *a, PyObject *b, int op) |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 1037 | { |
Serhiy Storchaka | ac20e0f | 2018-07-31 09:18:24 +0300 | [diff] [blame] | 1038 | wrapperobject *wa, *wb; |
| 1039 | int eq; |
Mark Dickinson | 211c625 | 2009-02-01 10:28:51 +0000 | [diff] [blame] | 1040 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1041 | assert(a != NULL && b != NULL); |
Mark Dickinson | 211c625 | 2009-02-01 10:28:51 +0000 | [diff] [blame] | 1042 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1043 | /* both arguments should be wrapperobjects */ |
Serhiy Storchaka | ac20e0f | 2018-07-31 09:18:24 +0300 | [diff] [blame] | 1044 | if ((op != Py_EQ && op != Py_NE) |
| 1045 | || !Wrapper_Check(a) || !Wrapper_Check(b)) |
| 1046 | { |
stratakis | e8b1965 | 2017-11-02 11:32:54 +0100 | [diff] [blame] | 1047 | Py_RETURN_NOTIMPLEMENTED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1048 | } |
Mark Dickinson | 211c625 | 2009-02-01 10:28:51 +0000 | [diff] [blame] | 1049 | |
Serhiy Storchaka | ac20e0f | 2018-07-31 09:18:24 +0300 | [diff] [blame] | 1050 | 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 Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1055 | } |
Serhiy Storchaka | ac20e0f | 2018-07-31 09:18:24 +0300 | [diff] [blame] | 1056 | else { |
| 1057 | Py_RETURN_FALSE; |
| 1058 | } |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 1059 | } |
| 1060 | |
Benjamin Peterson | 8f67d08 | 2010-10-17 20:54:53 +0000 | [diff] [blame] | 1061 | static Py_hash_t |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1062 | wrapper_hash(wrapperobject *wp) |
| 1063 | { |
Benjamin Peterson | 8f67d08 | 2010-10-17 20:54:53 +0000 | [diff] [blame] | 1064 | Py_hash_t x, y; |
Serhiy Storchaka | ac20e0f | 2018-07-31 09:18:24 +0300 | [diff] [blame] | 1065 | x = _Py_HashPointer(wp->self); |
| 1066 | y = _Py_HashPointer(wp->descr); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1067 | x = x ^ y; |
| 1068 | if (x == -1) |
| 1069 | x = -2; |
| 1070 | return x; |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1071 | } |
| 1072 | |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 1073 | static PyObject * |
| 1074 | wrapper_repr(wrapperobject *wp) |
| 1075 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1076 | 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 Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 1080 | } |
| 1081 | |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1082 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 1083 | wrapper_reduce(wrapperobject *wp, PyObject *Py_UNUSED(ignored)) |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1084 | { |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1085 | _Py_IDENTIFIER(getattr); |
Serhiy Storchaka | bb86bf4 | 2018-12-11 08:28:18 +0200 | [diff] [blame] | 1086 | return Py_BuildValue("N(OO)", _PyEval_GetBuiltinId(&PyId_getattr), |
| 1087 | wp->self, PyDescr_NAME(wp->descr)); |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1088 | } |
| 1089 | |
| 1090 | static PyMethodDef wrapper_methods[] = { |
| 1091 | {"__reduce__", (PyCFunction)wrapper_reduce, METH_NOARGS, NULL}, |
| 1092 | {NULL, NULL} |
| 1093 | }; |
| 1094 | |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 1095 | static PyMemberDef wrapper_members[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1096 | {"__self__", T_OBJECT, offsetof(wrapperobject, self), READONLY}, |
| 1097 | {0} |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1098 | }; |
| 1099 | |
| 1100 | static PyObject * |
Serhiy Storchaka | d4f9cf5 | 2018-11-27 19:34:35 +0200 | [diff] [blame] | 1101 | wrapper_objclass(wrapperobject *wp, void *Py_UNUSED(ignored)) |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 1102 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1103 | PyObject *c = (PyObject *)PyDescr_TYPE(wp->descr); |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 1104 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1105 | Py_INCREF(c); |
| 1106 | return c; |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 1107 | } |
| 1108 | |
| 1109 | static PyObject * |
Serhiy Storchaka | d4f9cf5 | 2018-11-27 19:34:35 +0200 | [diff] [blame] | 1110 | wrapper_name(wrapperobject *wp, void *Py_UNUSED(ignored)) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1111 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1112 | const char *s = wp->descr->d_base->name; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1113 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1114 | return PyUnicode_FromString(s); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1115 | } |
| 1116 | |
| 1117 | static PyObject * |
Serhiy Storchaka | d4f9cf5 | 2018-11-27 19:34:35 +0200 | [diff] [blame] | 1118 | wrapper_doc(wrapperobject *wp, void *Py_UNUSED(ignored)) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1119 | { |
Larry Hastings | 2623c8c | 2014-02-08 22:15:29 -0800 | [diff] [blame] | 1120 | return _PyType_GetDocFromInternalDoc(wp->descr->d_base->name, wp->descr->d_base->doc); |
Larry Hastings | 5c66189 | 2014-01-24 06:17:25 -0800 | [diff] [blame] | 1121 | } |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1122 | |
Larry Hastings | 5c66189 | 2014-01-24 06:17:25 -0800 | [diff] [blame] | 1123 | static PyObject * |
Serhiy Storchaka | d4f9cf5 | 2018-11-27 19:34:35 +0200 | [diff] [blame] | 1124 | wrapper_text_signature(wrapperobject *wp, void *Py_UNUSED(ignored)) |
Larry Hastings | 5c66189 | 2014-01-24 06:17:25 -0800 | [diff] [blame] | 1125 | { |
Larry Hastings | 2623c8c | 2014-02-08 22:15:29 -0800 | [diff] [blame] | 1126 | return _PyType_GetTextSignatureFromInternalDoc(wp->descr->d_base->name, wp->descr->d_base->doc); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1127 | } |
| 1128 | |
Antoine Pitrou | 9d57481 | 2011-12-12 13:47:25 +0100 | [diff] [blame] | 1129 | static PyObject * |
Serhiy Storchaka | d4f9cf5 | 2018-11-27 19:34:35 +0200 | [diff] [blame] | 1130 | wrapper_qualname(wrapperobject *wp, void *Py_UNUSED(ignored)) |
Antoine Pitrou | 9d57481 | 2011-12-12 13:47:25 +0100 | [diff] [blame] | 1131 | { |
Serhiy Storchaka | d4f9cf5 | 2018-11-27 19:34:35 +0200 | [diff] [blame] | 1132 | return descr_get_qualname((PyDescrObject *)wp->descr, NULL); |
Antoine Pitrou | 9d57481 | 2011-12-12 13:47:25 +0100 | [diff] [blame] | 1133 | } |
| 1134 | |
Guido van Rossum | 32d34c8 | 2001-09-20 21:45:26 +0000 | [diff] [blame] | 1135 | static PyGetSetDef wrapper_getsets[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1136 | {"__objclass__", (getter)wrapper_objclass}, |
| 1137 | {"__name__", (getter)wrapper_name}, |
Antoine Pitrou | 9d57481 | 2011-12-12 13:47:25 +0100 | [diff] [blame] | 1138 | {"__qualname__", (getter)wrapper_qualname}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1139 | {"__doc__", (getter)wrapper_doc}, |
Larry Hastings | 5c66189 | 2014-01-24 06:17:25 -0800 | [diff] [blame] | 1140 | {"__text_signature__", (getter)wrapper_text_signature}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1141 | {0} |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1142 | }; |
| 1143 | |
| 1144 | static PyObject * |
| 1145 | wrapper_call(wrapperobject *wp, PyObject *args, PyObject *kwds) |
| 1146 | { |
Serhiy Storchaka | 5e02c78 | 2017-09-21 14:25:36 +0300 | [diff] [blame] | 1147 | return wrapperdescr_raw_call(wp->descr, wp->self, args, kwds); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1148 | } |
| 1149 | |
Guido van Rossum | 048eb75 | 2001-10-02 21:24:57 +0000 | [diff] [blame] | 1150 | static int |
| 1151 | wrapper_traverse(PyObject *self, visitproc visit, void *arg) |
| 1152 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1153 | wrapperobject *wp = (wrapperobject *)self; |
| 1154 | Py_VISIT(wp->descr); |
| 1155 | Py_VISIT(wp->self); |
| 1156 | return 0; |
Guido van Rossum | 048eb75 | 2001-10-02 21:24:57 +0000 | [diff] [blame] | 1157 | } |
| 1158 | |
Benjamin Peterson | eff61f6 | 2011-09-01 16:32:31 -0400 | [diff] [blame] | 1159 | PyTypeObject _PyMethodWrapper_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1160 | 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 Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1188 | wrapper_methods, /* tp_methods */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1189 | 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 Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1195 | }; |
| 1196 | |
| 1197 | PyObject * |
| 1198 | PyWrapper_New(PyObject *d, PyObject *self) |
| 1199 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1200 | wrapperobject *wp; |
| 1201 | PyWrapperDescrObject *descr; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1202 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1203 | assert(PyObject_TypeCheck(d, &PyWrapperDescr_Type)); |
| 1204 | descr = (PyWrapperDescrObject *)d; |
Victor Stinner | 3249dec | 2011-05-01 23:19:15 +0200 | [diff] [blame] | 1205 | assert(_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self), |
Victor Stinner | d956131 | 2011-05-01 23:31:36 +0200 | [diff] [blame] | 1206 | (PyObject *)PyDescr_TYPE(descr))); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1207 | |
Benjamin Peterson | eff61f6 | 2011-09-01 16:32:31 -0400 | [diff] [blame] | 1208 | wp = PyObject_GC_New(wrapperobject, &_PyMethodWrapper_Type); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1209 | 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 Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1217 | } |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1218 | |
| 1219 | |
Guido van Rossum | 8bce4ac | 2001-09-06 21:56:42 +0000 | [diff] [blame] | 1220 | /* A built-in 'property' type */ |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1221 | |
| 1222 | /* |
Serhiy Storchaka | d741a88 | 2015-06-11 00:06:39 +0300 | [diff] [blame] | 1223 | class property(object): |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1224 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1225 | 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 Storchaka | d741a88 | 2015-06-11 00:06:39 +0300 | [diff] [blame] | 1227 | doc = fget.__doc__ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1228 | self.__get = fget |
| 1229 | self.__set = fset |
| 1230 | self.__del = fdel |
| 1231 | self.__doc__ = doc |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1232 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1233 | def __get__(self, inst, type=None): |
| 1234 | if inst is None: |
Serhiy Storchaka | d741a88 | 2015-06-11 00:06:39 +0300 | [diff] [blame] | 1235 | return self |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1236 | if self.__get is None: |
Serhiy Storchaka | d741a88 | 2015-06-11 00:06:39 +0300 | [diff] [blame] | 1237 | raise AttributeError, "unreadable attribute" |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1238 | return self.__get(inst) |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1239 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1240 | def __set__(self, inst, value): |
| 1241 | if self.__set is None: |
Serhiy Storchaka | d741a88 | 2015-06-11 00:06:39 +0300 | [diff] [blame] | 1242 | raise AttributeError, "can't set attribute" |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1243 | return self.__set(inst, value) |
Guido van Rossum | ba2485f | 2001-12-10 18:03:34 +0000 | [diff] [blame] | 1244 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1245 | def __delete__(self, inst): |
| 1246 | if self.__del is None: |
Serhiy Storchaka | d741a88 | 2015-06-11 00:06:39 +0300 | [diff] [blame] | 1247 | raise AttributeError, "can't delete attribute" |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1248 | return self.__del(inst) |
Guido van Rossum | ba2485f | 2001-12-10 18:03:34 +0000 | [diff] [blame] | 1249 | |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1250 | */ |
| 1251 | |
| 1252 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1253 | PyObject_HEAD |
| 1254 | PyObject *prop_get; |
| 1255 | PyObject *prop_set; |
| 1256 | PyObject *prop_del; |
| 1257 | PyObject *prop_doc; |
| 1258 | int getter_doc; |
Guido van Rossum | 8bce4ac | 2001-09-06 21:56:42 +0000 | [diff] [blame] | 1259 | } propertyobject; |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1260 | |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 1261 | static PyObject * property_copy(PyObject *, PyObject *, PyObject *, |
Benjamin Peterson | 9396483 | 2010-06-28 03:07:10 +0000 | [diff] [blame] | 1262 | PyObject *); |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 1263 | |
Tim Peters | 66c1a52 | 2001-09-24 21:17:50 +0000 | [diff] [blame] | 1264 | static PyMemberDef property_members[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1265 | {"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 Hettinger | eac503a | 2015-05-13 01:09:59 -0700 | [diff] [blame] | 1268 | {"__doc__", T_OBJECT, offsetof(propertyobject, prop_doc), 0}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1269 | {0} |
Tim Peters | 66c1a52 | 2001-09-24 21:17:50 +0000 | [diff] [blame] | 1270 | }; |
| 1271 | |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 1272 | |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1273 | PyDoc_STRVAR(getter_doc, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1274 | "Descriptor to change the getter on a property."); |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1275 | |
Neal Norwitz | 32dde22 | 2008-04-15 06:43:13 +0000 | [diff] [blame] | 1276 | static PyObject * |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1277 | property_getter(PyObject *self, PyObject *getter) |
| 1278 | { |
Benjamin Peterson | 9396483 | 2010-06-28 03:07:10 +0000 | [diff] [blame] | 1279 | return property_copy(self, getter, NULL, NULL); |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1280 | } |
| 1281 | |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 1282 | |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1283 | PyDoc_STRVAR(setter_doc, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1284 | "Descriptor to change the setter on a property."); |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1285 | |
Neal Norwitz | 32dde22 | 2008-04-15 06:43:13 +0000 | [diff] [blame] | 1286 | static PyObject * |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1287 | property_setter(PyObject *self, PyObject *setter) |
| 1288 | { |
Benjamin Peterson | 9396483 | 2010-06-28 03:07:10 +0000 | [diff] [blame] | 1289 | return property_copy(self, NULL, setter, NULL); |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1290 | } |
| 1291 | |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 1292 | |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1293 | PyDoc_STRVAR(deleter_doc, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1294 | "Descriptor to change the deleter on a property."); |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1295 | |
Neal Norwitz | 32dde22 | 2008-04-15 06:43:13 +0000 | [diff] [blame] | 1296 | static PyObject * |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1297 | property_deleter(PyObject *self, PyObject *deleter) |
| 1298 | { |
Benjamin Peterson | 9396483 | 2010-06-28 03:07:10 +0000 | [diff] [blame] | 1299 | return property_copy(self, NULL, NULL, deleter); |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1300 | } |
| 1301 | |
| 1302 | |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1303 | static PyMethodDef property_methods[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1304 | {"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 Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1308 | }; |
| 1309 | |
Tim Peters | 66c1a52 | 2001-09-24 21:17:50 +0000 | [diff] [blame] | 1310 | |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1311 | static void |
Guido van Rossum | 8bce4ac | 2001-09-06 21:56:42 +0000 | [diff] [blame] | 1312 | property_dealloc(PyObject *self) |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1313 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1314 | propertyobject *gs = (propertyobject *)self; |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1315 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1316 | _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 Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1322 | } |
| 1323 | |
| 1324 | static PyObject * |
Guido van Rossum | 8bce4ac | 2001-09-06 21:56:42 +0000 | [diff] [blame] | 1325 | property_descr_get(PyObject *self, PyObject *obj, PyObject *type) |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1326 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1327 | if (obj == NULL || obj == Py_None) { |
| 1328 | Py_INCREF(self); |
| 1329 | return self; |
| 1330 | } |
Victor Stinner | e972c13 | 2018-10-01 03:03:22 -0700 | [diff] [blame] | 1331 | |
| 1332 | propertyobject *gs = (propertyobject *)self; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1333 | if (gs->prop_get == NULL) { |
| 1334 | PyErr_SetString(PyExc_AttributeError, "unreadable attribute"); |
| 1335 | return NULL; |
| 1336 | } |
Victor Stinner | e972c13 | 2018-10-01 03:03:22 -0700 | [diff] [blame] | 1337 | |
| 1338 | PyObject *args[1] = {obj}; |
| 1339 | return _PyObject_FastCall(gs->prop_get, args, 1); |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1340 | } |
| 1341 | |
| 1342 | static int |
Guido van Rossum | 8bce4ac | 2001-09-06 21:56:42 +0000 | [diff] [blame] | 1343 | property_descr_set(PyObject *self, PyObject *obj, PyObject *value) |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1344 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1345 | propertyobject *gs = (propertyobject *)self; |
| 1346 | PyObject *func, *res; |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1347 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1348 | 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 Stinner | de4ae3d | 2016-12-04 22:59:09 +0100 | [diff] [blame] | 1360 | res = PyObject_CallFunctionObjArgs(func, obj, NULL); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1361 | else |
Benjamin Peterson | 9b955de | 2010-12-07 04:04:02 +0000 | [diff] [blame] | 1362 | res = PyObject_CallFunctionObjArgs(func, obj, value, NULL); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1363 | if (res == NULL) |
| 1364 | return -1; |
| 1365 | Py_DECREF(res); |
| 1366 | return 0; |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1367 | } |
| 1368 | |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 1369 | static PyObject * |
Benjamin Peterson | 9396483 | 2010-06-28 03:07:10 +0000 | [diff] [blame] | 1370 | property_copy(PyObject *old, PyObject *get, PyObject *set, PyObject *del) |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 1371 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1372 | propertyobject *pold = (propertyobject *)old; |
Benjamin Peterson | 9396483 | 2010-06-28 03:07:10 +0000 | [diff] [blame] | 1373 | PyObject *new, *type, *doc; |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 1374 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1375 | type = PyObject_Type(old); |
| 1376 | if (type == NULL) |
| 1377 | return NULL; |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 1378 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1379 | 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 Peterson | 9396483 | 2010-06-28 03:07:10 +0000 | [diff] [blame] | 1391 | 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 Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1397 | } |
R. David Murray | b18500d | 2009-05-04 22:59:07 +0000 | [diff] [blame] | 1398 | |
Victor Stinner | 5abaa2b | 2016-12-09 16:22:32 +0100 | [diff] [blame] | 1399 | new = PyObject_CallFunctionObjArgs(type, get, set, del, doc, NULL); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1400 | Py_DECREF(type); |
| 1401 | if (new == NULL) |
| 1402 | return NULL; |
| 1403 | return new; |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 1404 | } |
| 1405 | |
Serhiy Storchaka | 18b250f | 2017-03-19 08:51:07 +0200 | [diff] [blame] | 1406 | /*[clinic input] |
| 1407 | property.__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 | |
| 1418 | Property attribute. |
| 1419 | |
| 1420 | Typical use is to define a managed attribute x: |
| 1421 | |
| 1422 | class 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 | |
| 1428 | Decorators make defining new properties or modifying existing ones easy: |
| 1429 | |
| 1430 | class 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 Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1443 | static int |
Serhiy Storchaka | 18b250f | 2017-03-19 08:51:07 +0200 | [diff] [blame] | 1444 | property_init_impl(propertyobject *self, PyObject *fget, PyObject *fset, |
| 1445 | PyObject *fdel, PyObject *doc) |
| 1446 | /*[clinic end generated code: output=01a960742b692b57 input=dfb5dbbffc6932d5]*/ |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1447 | { |
Serhiy Storchaka | 18b250f | 2017-03-19 08:51:07 +0200 | [diff] [blame] | 1448 | if (fget == Py_None) |
| 1449 | fget = NULL; |
| 1450 | if (fset == Py_None) |
| 1451 | fset = NULL; |
| 1452 | if (fdel == Py_None) |
| 1453 | fdel = NULL; |
Tim Peters | 66c1a52 | 2001-09-24 21:17:50 +0000 | [diff] [blame] | 1454 | |
Serhiy Storchaka | 18b250f | 2017-03-19 08:51:07 +0200 | [diff] [blame] | 1455 | Py_XINCREF(fget); |
| 1456 | Py_XINCREF(fset); |
| 1457 | Py_XINCREF(fdel); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1458 | Py_XINCREF(doc); |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 1459 | |
Oren Milman | d019bc8 | 2018-02-13 12:28:33 +0200 | [diff] [blame] | 1460 | 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 Storchaka | 18b250f | 2017-03-19 08:51:07 +0200 | [diff] [blame] | 1464 | self->getter_doc = 0; |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1465 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1466 | /* if no docstring given and the getter has one, use that one */ |
Serhiy Storchaka | 18b250f | 2017-03-19 08:51:07 +0200 | [diff] [blame] | 1467 | if ((doc == NULL || doc == Py_None) && fget != NULL) { |
Martin v. Löwis | bd928fe | 2011-10-14 10:20:37 +0200 | [diff] [blame] | 1468 | _Py_IDENTIFIER(__doc__); |
Serhiy Storchaka | 18b250f | 2017-03-19 08:51:07 +0200 | [diff] [blame] | 1469 | PyObject *get_doc = _PyObject_GetAttrId(fget, &PyId___doc__); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1470 | if (get_doc) { |
| 1471 | if (Py_TYPE(self) == &PyProperty_Type) { |
Serhiy Storchaka | 18b250f | 2017-03-19 08:51:07 +0200 | [diff] [blame] | 1472 | Py_XSETREF(self->prop_doc, get_doc); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1473 | } |
| 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 Storchaka | 18b250f | 2017-03-19 08:51:07 +0200 | [diff] [blame] | 1479 | int err = _PyObject_SetAttrId((PyObject *)self, &PyId___doc__, get_doc); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1480 | Py_DECREF(get_doc); |
| 1481 | if (err < 0) |
| 1482 | return -1; |
| 1483 | } |
Serhiy Storchaka | 18b250f | 2017-03-19 08:51:07 +0200 | [diff] [blame] | 1484 | self->getter_doc = 1; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1485 | } |
| 1486 | else if (PyErr_ExceptionMatches(PyExc_Exception)) { |
| 1487 | PyErr_Clear(); |
| 1488 | } |
| 1489 | else { |
| 1490 | return -1; |
| 1491 | } |
| 1492 | } |
| 1493 | |
| 1494 | return 0; |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1495 | } |
| 1496 | |
Benjamin Peterson | bfebb7b | 2011-12-15 15:34:02 -0500 | [diff] [blame] | 1497 | static PyObject * |
| 1498 | property_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 | |
| 1526 | static PyGetSetDef property_getsetlist[] = { |
| 1527 | {"__isabstractmethod__", |
| 1528 | (getter)property_get___isabstractmethod__, NULL, |
| 1529 | NULL, |
| 1530 | NULL}, |
| 1531 | {NULL} /* Sentinel */ |
| 1532 | }; |
| 1533 | |
Guido van Rossum | 048eb75 | 2001-10-02 21:24:57 +0000 | [diff] [blame] | 1534 | static int |
| 1535 | property_traverse(PyObject *self, visitproc visit, void *arg) |
| 1536 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1537 | 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 Rossum | 048eb75 | 2001-10-02 21:24:57 +0000 | [diff] [blame] | 1543 | } |
| 1544 | |
Raymond Hettinger | d4be691 | 2015-05-13 11:12:33 -0700 | [diff] [blame] | 1545 | static int |
| 1546 | property_clear(PyObject *self) |
| 1547 | { |
| 1548 | propertyobject *pp = (propertyobject *)self; |
| 1549 | Py_CLEAR(pp->prop_doc); |
| 1550 | return 0; |
| 1551 | } |
| 1552 | |
Serhiy Storchaka | 18b250f | 2017-03-19 08:51:07 +0200 | [diff] [blame] | 1553 | #include "clinic/descrobject.c.h" |
| 1554 | |
| 1555 | PyTypeObject 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 Rossum | 8bce4ac | 2001-09-06 21:56:42 +0000 | [diff] [blame] | 1597 | PyTypeObject PyProperty_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1598 | 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 Storchaka | 18b250f | 2017-03-19 08:51:07 +0200 | [diff] [blame] | 1620 | property_init__doc__, /* tp_doc */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1621 | property_traverse, /* tp_traverse */ |
Raymond Hettinger | d4be691 | 2015-05-13 11:12:33 -0700 | [diff] [blame] | 1622 | (inquiry)property_clear, /* tp_clear */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1623 | 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 Peterson | bfebb7b | 2011-12-15 15:34:02 -0500 | [diff] [blame] | 1629 | property_getsetlist, /* tp_getset */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1630 | 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 Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1639 | }; |