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" |
| 4 | #include "structmember.h" /* Why is this not included in Python.h? */ |
| 5 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 6 | static void |
| 7 | descr_dealloc(PyDescrObject *descr) |
| 8 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 9 | _PyObject_GC_UNTRACK(descr); |
| 10 | Py_XDECREF(descr->d_type); |
| 11 | Py_XDECREF(descr->d_name); |
Antoine Pitrou | 9d57481 | 2011-12-12 13:47:25 +0100 | [diff] [blame] | 12 | Py_XDECREF(descr->d_qualname); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 13 | PyObject_GC_Del(descr); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 14 | } |
| 15 | |
Walter Dörwald | d7fb764 | 2007-06-11 16:36:59 +0000 | [diff] [blame] | 16 | static PyObject * |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 17 | descr_name(PyDescrObject *descr) |
| 18 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 19 | if (descr->d_name != NULL && PyUnicode_Check(descr->d_name)) |
| 20 | return descr->d_name; |
| 21 | return NULL; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 22 | } |
| 23 | |
| 24 | static PyObject * |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 25 | descr_repr(PyDescrObject *descr, const char *format) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 26 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 27 | PyObject *name = NULL; |
| 28 | if (descr->d_name != NULL && PyUnicode_Check(descr->d_name)) |
| 29 | name = descr->d_name; |
Walter Dörwald | d7fb764 | 2007-06-11 16:36:59 +0000 | [diff] [blame] | 30 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 31 | return PyUnicode_FromFormat(format, name, "?", descr->d_type->tp_name); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 32 | } |
| 33 | |
| 34 | static PyObject * |
| 35 | method_repr(PyMethodDescrObject *descr) |
| 36 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 37 | return descr_repr((PyDescrObject *)descr, |
| 38 | "<method '%V' of '%s' objects>"); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 39 | } |
| 40 | |
| 41 | static PyObject * |
| 42 | member_repr(PyMemberDescrObject *descr) |
| 43 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 44 | return descr_repr((PyDescrObject *)descr, |
| 45 | "<member '%V' of '%s' objects>"); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 46 | } |
| 47 | |
| 48 | static PyObject * |
| 49 | getset_repr(PyGetSetDescrObject *descr) |
| 50 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 51 | return descr_repr((PyDescrObject *)descr, |
| 52 | "<attribute '%V' of '%s' objects>"); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 53 | } |
| 54 | |
| 55 | static PyObject * |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 56 | wrapperdescr_repr(PyWrapperDescrObject *descr) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 57 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 58 | return descr_repr((PyDescrObject *)descr, |
| 59 | "<slot wrapper '%V' of '%s' objects>"); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 60 | } |
| 61 | |
| 62 | static int |
Guido van Rossum | b6e5a0c | 2003-02-11 18:44:42 +0000 | [diff] [blame] | 63 | descr_check(PyDescrObject *descr, PyObject *obj, PyObject **pres) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 64 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 65 | if (obj == NULL) { |
| 66 | Py_INCREF(descr); |
| 67 | *pres = (PyObject *)descr; |
| 68 | return 1; |
| 69 | } |
| 70 | if (!PyObject_TypeCheck(obj, descr->d_type)) { |
| 71 | PyErr_Format(PyExc_TypeError, |
| 72 | "descriptor '%V' for '%s' objects " |
| 73 | "doesn't apply to '%s' object", |
| 74 | descr_name((PyDescrObject *)descr), "?", |
| 75 | descr->d_type->tp_name, |
| 76 | obj->ob_type->tp_name); |
| 77 | *pres = NULL; |
| 78 | return 1; |
| 79 | } |
| 80 | return 0; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 81 | } |
| 82 | |
| 83 | static PyObject * |
Guido van Rossum | b6e5a0c | 2003-02-11 18:44:42 +0000 | [diff] [blame] | 84 | classmethod_get(PyMethodDescrObject *descr, PyObject *obj, PyObject *type) |
Tim Peters | bca1cbc | 2002-12-09 22:56:13 +0000 | [diff] [blame] | 85 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 86 | /* Ensure a valid type. Class methods ignore obj. */ |
| 87 | if (type == NULL) { |
| 88 | if (obj != NULL) |
| 89 | type = (PyObject *)obj->ob_type; |
| 90 | else { |
| 91 | /* Wot - no type?! */ |
| 92 | PyErr_Format(PyExc_TypeError, |
| 93 | "descriptor '%V' for type '%s' " |
| 94 | "needs either an object or a type", |
| 95 | descr_name((PyDescrObject *)descr), "?", |
| 96 | PyDescr_TYPE(descr)->tp_name); |
| 97 | return NULL; |
| 98 | } |
| 99 | } |
| 100 | if (!PyType_Check(type)) { |
| 101 | PyErr_Format(PyExc_TypeError, |
| 102 | "descriptor '%V' for type '%s' " |
| 103 | "needs a type, not a '%s' as arg 2", |
| 104 | descr_name((PyDescrObject *)descr), "?", |
| 105 | PyDescr_TYPE(descr)->tp_name, |
| 106 | type->ob_type->tp_name); |
| 107 | return NULL; |
| 108 | } |
| 109 | if (!PyType_IsSubtype((PyTypeObject *)type, PyDescr_TYPE(descr))) { |
| 110 | PyErr_Format(PyExc_TypeError, |
| 111 | "descriptor '%V' for type '%s' " |
| 112 | "doesn't apply to type '%s'", |
| 113 | descr_name((PyDescrObject *)descr), "?", |
| 114 | PyDescr_TYPE(descr)->tp_name, |
| 115 | ((PyTypeObject *)type)->tp_name); |
| 116 | return NULL; |
| 117 | } |
Andrew Svetlov | 3ba3a3e | 2012-12-25 13:32:35 +0200 | [diff] [blame] | 118 | return PyCFunction_NewEx(descr->d_method, type, NULL); |
Tim Peters | bca1cbc | 2002-12-09 22:56:13 +0000 | [diff] [blame] | 119 | } |
| 120 | |
| 121 | static PyObject * |
Guido van Rossum | b6e5a0c | 2003-02-11 18:44:42 +0000 | [diff] [blame] | 122 | method_get(PyMethodDescrObject *descr, PyObject *obj, PyObject *type) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 123 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 124 | PyObject *res; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 125 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 126 | if (descr_check((PyDescrObject *)descr, obj, &res)) |
| 127 | return res; |
Andrew Svetlov | 3ba3a3e | 2012-12-25 13:32:35 +0200 | [diff] [blame] | 128 | return PyCFunction_NewEx(descr->d_method, obj, NULL); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 129 | } |
| 130 | |
| 131 | static PyObject * |
Guido van Rossum | b6e5a0c | 2003-02-11 18:44:42 +0000 | [diff] [blame] | 132 | member_get(PyMemberDescrObject *descr, PyObject *obj, PyObject *type) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 133 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 134 | PyObject *res; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 135 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 136 | if (descr_check((PyDescrObject *)descr, obj, &res)) |
| 137 | return res; |
| 138 | return PyMember_GetOne((char *)obj, descr->d_member); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 139 | } |
| 140 | |
| 141 | static PyObject * |
Guido van Rossum | b6e5a0c | 2003-02-11 18:44:42 +0000 | [diff] [blame] | 142 | getset_get(PyGetSetDescrObject *descr, PyObject *obj, PyObject *type) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 143 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 144 | PyObject *res; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 145 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 146 | if (descr_check((PyDescrObject *)descr, obj, &res)) |
| 147 | return res; |
| 148 | if (descr->d_getset->get != NULL) |
| 149 | return descr->d_getset->get(obj, descr->d_getset->closure); |
| 150 | PyErr_Format(PyExc_AttributeError, |
| 151 | "attribute '%V' of '%.100s' objects is not readable", |
| 152 | descr_name((PyDescrObject *)descr), "?", |
| 153 | PyDescr_TYPE(descr)->tp_name); |
| 154 | return NULL; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 155 | } |
| 156 | |
| 157 | static PyObject * |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 158 | wrapperdescr_get(PyWrapperDescrObject *descr, PyObject *obj, PyObject *type) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 159 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 160 | PyObject *res; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 161 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 162 | if (descr_check((PyDescrObject *)descr, obj, &res)) |
| 163 | return res; |
| 164 | return PyWrapper_New((PyObject *)descr, obj); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 165 | } |
| 166 | |
| 167 | static int |
| 168 | descr_setcheck(PyDescrObject *descr, PyObject *obj, PyObject *value, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 169 | int *pres) |
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 | assert(obj != NULL); |
| 172 | if (!PyObject_TypeCheck(obj, descr->d_type)) { |
| 173 | PyErr_Format(PyExc_TypeError, |
| 174 | "descriptor '%V' for '%.100s' objects " |
| 175 | "doesn't apply to '%.100s' object", |
| 176 | descr_name(descr), "?", |
| 177 | descr->d_type->tp_name, |
| 178 | obj->ob_type->tp_name); |
| 179 | *pres = -1; |
| 180 | return 1; |
| 181 | } |
| 182 | return 0; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 183 | } |
| 184 | |
| 185 | static int |
| 186 | member_set(PyMemberDescrObject *descr, PyObject *obj, PyObject *value) |
| 187 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 188 | int res; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 189 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 190 | if (descr_setcheck((PyDescrObject *)descr, obj, value, &res)) |
| 191 | return res; |
| 192 | return PyMember_SetOne((char *)obj, descr->d_member, value); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 193 | } |
| 194 | |
| 195 | static int |
| 196 | getset_set(PyGetSetDescrObject *descr, PyObject *obj, PyObject *value) |
| 197 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 198 | int res; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 199 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 200 | if (descr_setcheck((PyDescrObject *)descr, obj, value, &res)) |
| 201 | return res; |
| 202 | if (descr->d_getset->set != NULL) |
| 203 | return descr->d_getset->set(obj, value, |
| 204 | descr->d_getset->closure); |
| 205 | PyErr_Format(PyExc_AttributeError, |
| 206 | "attribute '%V' of '%.100s' objects is not writable", |
| 207 | descr_name((PyDescrObject *)descr), "?", |
| 208 | PyDescr_TYPE(descr)->tp_name); |
| 209 | return -1; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 210 | } |
| 211 | |
| 212 | static PyObject * |
| 213 | methoddescr_call(PyMethodDescrObject *descr, PyObject *args, PyObject *kwds) |
| 214 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 215 | Py_ssize_t argc; |
Victor Stinner | 2990fa1 | 2016-08-22 23:21:55 +0200 | [diff] [blame] | 216 | PyObject *self, *func, *result, **stack; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 217 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 218 | /* Make sure that the first argument is acceptable as 'self' */ |
| 219 | assert(PyTuple_Check(args)); |
| 220 | argc = PyTuple_GET_SIZE(args); |
| 221 | if (argc < 1) { |
| 222 | PyErr_Format(PyExc_TypeError, |
| 223 | "descriptor '%V' of '%.100s' " |
| 224 | "object needs an argument", |
| 225 | descr_name((PyDescrObject *)descr), "?", |
| 226 | PyDescr_TYPE(descr)->tp_name); |
| 227 | return NULL; |
| 228 | } |
| 229 | self = PyTuple_GET_ITEM(args, 0); |
Victor Stinner | 3249dec | 2011-05-01 23:19:15 +0200 | [diff] [blame] | 230 | if (!_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self), |
Victor Stinner | d956131 | 2011-05-01 23:31:36 +0200 | [diff] [blame] | 231 | (PyObject *)PyDescr_TYPE(descr))) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 232 | PyErr_Format(PyExc_TypeError, |
| 233 | "descriptor '%V' " |
| 234 | "requires a '%.100s' object " |
| 235 | "but received a '%.100s'", |
| 236 | descr_name((PyDescrObject *)descr), "?", |
| 237 | PyDescr_TYPE(descr)->tp_name, |
| 238 | self->ob_type->tp_name); |
| 239 | return NULL; |
| 240 | } |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 241 | |
Andrew Svetlov | 3ba3a3e | 2012-12-25 13:32:35 +0200 | [diff] [blame] | 242 | func = PyCFunction_NewEx(descr->d_method, self, NULL); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 243 | if (func == NULL) |
| 244 | return NULL; |
Victor Stinner | 2990fa1 | 2016-08-22 23:21:55 +0200 | [diff] [blame] | 245 | stack = &PyTuple_GET_ITEM(args, 1); |
| 246 | result = _PyObject_FastCallDict(func, stack, argc - 1, kwds); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 247 | Py_DECREF(func); |
| 248 | return result; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 249 | } |
| 250 | |
| 251 | static PyObject * |
Tim Peters | bca1cbc | 2002-12-09 22:56:13 +0000 | [diff] [blame] | 252 | classmethoddescr_call(PyMethodDescrObject *descr, PyObject *args, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 253 | PyObject *kwds) |
Tim Peters | bca1cbc | 2002-12-09 22:56:13 +0000 | [diff] [blame] | 254 | { |
Benjamin Peterson | 7295c6a | 2012-05-01 09:51:09 -0400 | [diff] [blame] | 255 | Py_ssize_t argc; |
Victor Stinner | 2990fa1 | 2016-08-22 23:21:55 +0200 | [diff] [blame] | 256 | PyObject *self, *func, *result, **stack; |
Tim Peters | bca1cbc | 2002-12-09 22:56:13 +0000 | [diff] [blame] | 257 | |
Benjamin Peterson | 7295c6a | 2012-05-01 09:51:09 -0400 | [diff] [blame] | 258 | /* Make sure that the first argument is acceptable as 'self' */ |
| 259 | assert(PyTuple_Check(args)); |
| 260 | argc = PyTuple_GET_SIZE(args); |
| 261 | if (argc < 1) { |
| 262 | PyErr_Format(PyExc_TypeError, |
| 263 | "descriptor '%V' of '%.100s' " |
| 264 | "object needs an argument", |
| 265 | descr_name((PyDescrObject *)descr), "?", |
| 266 | PyDescr_TYPE(descr)->tp_name); |
| 267 | return NULL; |
| 268 | } |
| 269 | self = PyTuple_GET_ITEM(args, 0); |
| 270 | if (!PyType_Check(self)) { |
| 271 | PyErr_Format(PyExc_TypeError, |
| 272 | "descriptor '%V' requires a type " |
| 273 | "but received a '%.100s'", |
| 274 | descr_name((PyDescrObject *)descr), "?", |
| 275 | PyDescr_TYPE(descr)->tp_name, |
| 276 | self->ob_type->tp_name); |
| 277 | return NULL; |
| 278 | } |
| 279 | if (!PyType_IsSubtype((PyTypeObject *)self, PyDescr_TYPE(descr))) { |
| 280 | PyErr_Format(PyExc_TypeError, |
| 281 | "descriptor '%V' " |
| 282 | "requires a subtype of '%.100s' " |
| 283 | "but received '%.100s", |
| 284 | descr_name((PyDescrObject *)descr), "?", |
| 285 | PyDescr_TYPE(descr)->tp_name, |
| 286 | self->ob_type->tp_name); |
| 287 | return NULL; |
| 288 | } |
| 289 | |
Andrew Svetlov | 3ba3a3e | 2012-12-25 13:32:35 +0200 | [diff] [blame] | 290 | func = PyCFunction_NewEx(descr->d_method, self, NULL); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 291 | if (func == NULL) |
| 292 | return NULL; |
Victor Stinner | 2990fa1 | 2016-08-22 23:21:55 +0200 | [diff] [blame] | 293 | stack = &PyTuple_GET_ITEM(args, 1); |
| 294 | result = _PyObject_FastCallDict(func, stack, argc - 1, kwds); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 295 | Py_DECREF(func); |
| 296 | return result; |
Tim Peters | bca1cbc | 2002-12-09 22:56:13 +0000 | [diff] [blame] | 297 | } |
| 298 | |
| 299 | static PyObject * |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 300 | wrapperdescr_call(PyWrapperDescrObject *descr, PyObject *args, PyObject *kwds) |
| 301 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 302 | Py_ssize_t argc; |
Victor Stinner | 2990fa1 | 2016-08-22 23:21:55 +0200 | [diff] [blame] | 303 | PyObject *self, *func, *result, **stack; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 304 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 305 | /* Make sure that the first argument is acceptable as 'self' */ |
| 306 | assert(PyTuple_Check(args)); |
| 307 | argc = PyTuple_GET_SIZE(args); |
| 308 | if (argc < 1) { |
| 309 | PyErr_Format(PyExc_TypeError, |
| 310 | "descriptor '%V' of '%.100s' " |
| 311 | "object needs an argument", |
| 312 | descr_name((PyDescrObject *)descr), "?", |
| 313 | PyDescr_TYPE(descr)->tp_name); |
| 314 | return NULL; |
| 315 | } |
| 316 | self = PyTuple_GET_ITEM(args, 0); |
Victor Stinner | 3249dec | 2011-05-01 23:19:15 +0200 | [diff] [blame] | 317 | if (!_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self), |
Victor Stinner | d956131 | 2011-05-01 23:31:36 +0200 | [diff] [blame] | 318 | (PyObject *)PyDescr_TYPE(descr))) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 319 | PyErr_Format(PyExc_TypeError, |
| 320 | "descriptor '%V' " |
| 321 | "requires a '%.100s' object " |
| 322 | "but received a '%.100s'", |
| 323 | descr_name((PyDescrObject *)descr), "?", |
| 324 | PyDescr_TYPE(descr)->tp_name, |
| 325 | self->ob_type->tp_name); |
| 326 | return NULL; |
| 327 | } |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 328 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 329 | func = PyWrapper_New((PyObject *)descr, self); |
| 330 | if (func == NULL) |
| 331 | return NULL; |
Victor Stinner | 2990fa1 | 2016-08-22 23:21:55 +0200 | [diff] [blame] | 332 | |
| 333 | stack = &PyTuple_GET_ITEM(args, 1); |
| 334 | result = _PyObject_FastCallDict(func, stack, argc - 1, kwds); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 335 | Py_DECREF(func); |
| 336 | return result; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 337 | } |
| 338 | |
| 339 | static PyObject * |
Guido van Rossum | 6f79937 | 2001-09-20 20:46:19 +0000 | [diff] [blame] | 340 | method_get_doc(PyMethodDescrObject *descr, void *closure) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 341 | { |
Larry Hastings | 2623c8c | 2014-02-08 22:15:29 -0800 | [diff] [blame] | 342 | 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] | 343 | } |
| 344 | |
| 345 | static PyObject * |
| 346 | method_get_text_signature(PyMethodDescrObject *descr, void *closure) |
| 347 | { |
Larry Hastings | 2623c8c | 2014-02-08 22:15:29 -0800 | [diff] [blame] | 348 | 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] | 349 | } |
| 350 | |
Antoine Pitrou | 9d57481 | 2011-12-12 13:47:25 +0100 | [diff] [blame] | 351 | static PyObject * |
| 352 | calculate_qualname(PyDescrObject *descr) |
| 353 | { |
| 354 | PyObject *type_qualname, *res; |
| 355 | _Py_IDENTIFIER(__qualname__); |
| 356 | |
| 357 | if (descr->d_name == NULL || !PyUnicode_Check(descr->d_name)) { |
| 358 | PyErr_SetString(PyExc_TypeError, |
| 359 | "<descriptor>.__name__ is not a unicode object"); |
| 360 | return NULL; |
| 361 | } |
| 362 | |
| 363 | type_qualname = _PyObject_GetAttrId((PyObject *)descr->d_type, |
| 364 | &PyId___qualname__); |
| 365 | if (type_qualname == NULL) |
| 366 | return NULL; |
| 367 | |
| 368 | if (!PyUnicode_Check(type_qualname)) { |
| 369 | PyErr_SetString(PyExc_TypeError, "<descriptor>.__objclass__." |
| 370 | "__qualname__ is not a unicode object"); |
| 371 | Py_XDECREF(type_qualname); |
| 372 | return NULL; |
| 373 | } |
| 374 | |
| 375 | res = PyUnicode_FromFormat("%S.%S", type_qualname, descr->d_name); |
| 376 | Py_DECREF(type_qualname); |
| 377 | return res; |
| 378 | } |
| 379 | |
| 380 | static PyObject * |
| 381 | descr_get_qualname(PyDescrObject *descr) |
| 382 | { |
| 383 | if (descr->d_qualname == NULL) |
| 384 | descr->d_qualname = calculate_qualname(descr); |
| 385 | Py_XINCREF(descr->d_qualname); |
| 386 | return descr->d_qualname; |
| 387 | } |
| 388 | |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 389 | static PyObject * |
| 390 | descr_reduce(PyDescrObject *descr) |
| 391 | { |
| 392 | PyObject *builtins; |
| 393 | PyObject *getattr; |
| 394 | _Py_IDENTIFIER(getattr); |
| 395 | |
| 396 | builtins = PyEval_GetBuiltins(); |
| 397 | getattr = _PyDict_GetItemId(builtins, &PyId_getattr); |
| 398 | return Py_BuildValue("O(OO)", getattr, PyDescr_TYPE(descr), |
| 399 | PyDescr_NAME(descr)); |
| 400 | } |
| 401 | |
| 402 | static PyMethodDef descr_methods[] = { |
| 403 | {"__reduce__", (PyCFunction)descr_reduce, METH_NOARGS, NULL}, |
| 404 | {NULL, NULL} |
| 405 | }; |
| 406 | |
Guido van Rossum | 6f79937 | 2001-09-20 20:46:19 +0000 | [diff] [blame] | 407 | static PyMemberDef descr_members[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 408 | {"__objclass__", T_OBJECT, offsetof(PyDescrObject, d_type), READONLY}, |
| 409 | {"__name__", T_OBJECT, offsetof(PyDescrObject, d_name), READONLY}, |
| 410 | {0} |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 411 | }; |
| 412 | |
Guido van Rossum | 32d34c8 | 2001-09-20 21:45:26 +0000 | [diff] [blame] | 413 | static PyGetSetDef method_getset[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 414 | {"__doc__", (getter)method_get_doc}, |
Antoine Pitrou | 9d57481 | 2011-12-12 13:47:25 +0100 | [diff] [blame] | 415 | {"__qualname__", (getter)descr_get_qualname}, |
Larry Hastings | 5c66189 | 2014-01-24 06:17:25 -0800 | [diff] [blame] | 416 | {"__text_signature__", (getter)method_get_text_signature}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 417 | {0} |
Guido van Rossum | 6f79937 | 2001-09-20 20:46:19 +0000 | [diff] [blame] | 418 | }; |
| 419 | |
| 420 | static PyObject * |
| 421 | member_get_doc(PyMemberDescrObject *descr, void *closure) |
| 422 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 423 | if (descr->d_member->doc == NULL) { |
| 424 | Py_INCREF(Py_None); |
| 425 | return Py_None; |
| 426 | } |
| 427 | return PyUnicode_FromString(descr->d_member->doc); |
Guido van Rossum | 6f79937 | 2001-09-20 20:46:19 +0000 | [diff] [blame] | 428 | } |
| 429 | |
Guido van Rossum | 32d34c8 | 2001-09-20 21:45:26 +0000 | [diff] [blame] | 430 | static PyGetSetDef member_getset[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 431 | {"__doc__", (getter)member_get_doc}, |
Antoine Pitrou | 9d57481 | 2011-12-12 13:47:25 +0100 | [diff] [blame] | 432 | {"__qualname__", (getter)descr_get_qualname}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 433 | {0} |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 434 | }; |
| 435 | |
| 436 | static PyObject * |
Guido van Rossum | 32d34c8 | 2001-09-20 21:45:26 +0000 | [diff] [blame] | 437 | getset_get_doc(PyGetSetDescrObject *descr, void *closure) |
| 438 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 439 | if (descr->d_getset->doc == NULL) { |
| 440 | Py_INCREF(Py_None); |
| 441 | return Py_None; |
| 442 | } |
| 443 | return PyUnicode_FromString(descr->d_getset->doc); |
Guido van Rossum | 32d34c8 | 2001-09-20 21:45:26 +0000 | [diff] [blame] | 444 | } |
| 445 | |
| 446 | static PyGetSetDef getset_getset[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 447 | {"__doc__", (getter)getset_get_doc}, |
Antoine Pitrou | 9d57481 | 2011-12-12 13:47:25 +0100 | [diff] [blame] | 448 | {"__qualname__", (getter)descr_get_qualname}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 449 | {0} |
Guido van Rossum | 32d34c8 | 2001-09-20 21:45:26 +0000 | [diff] [blame] | 450 | }; |
| 451 | |
| 452 | static PyObject * |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 453 | wrapperdescr_get_doc(PyWrapperDescrObject *descr, void *closure) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 454 | { |
Larry Hastings | 2623c8c | 2014-02-08 22:15:29 -0800 | [diff] [blame] | 455 | return _PyType_GetDocFromInternalDoc(descr->d_base->name, descr->d_base->doc); |
Larry Hastings | 5c66189 | 2014-01-24 06:17:25 -0800 | [diff] [blame] | 456 | } |
| 457 | |
| 458 | static PyObject * |
| 459 | wrapperdescr_get_text_signature(PyWrapperDescrObject *descr, void *closure) |
| 460 | { |
Larry Hastings | 2623c8c | 2014-02-08 22:15:29 -0800 | [diff] [blame] | 461 | return _PyType_GetTextSignatureFromInternalDoc(descr->d_base->name, descr->d_base->doc); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 462 | } |
| 463 | |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 464 | static PyGetSetDef wrapperdescr_getset[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 465 | {"__doc__", (getter)wrapperdescr_get_doc}, |
Antoine Pitrou | 9d57481 | 2011-12-12 13:47:25 +0100 | [diff] [blame] | 466 | {"__qualname__", (getter)descr_get_qualname}, |
Larry Hastings | 5c66189 | 2014-01-24 06:17:25 -0800 | [diff] [blame] | 467 | {"__text_signature__", (getter)wrapperdescr_get_text_signature}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 468 | {0} |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 469 | }; |
| 470 | |
Guido van Rossum | 048eb75 | 2001-10-02 21:24:57 +0000 | [diff] [blame] | 471 | static int |
| 472 | descr_traverse(PyObject *self, visitproc visit, void *arg) |
| 473 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 474 | PyDescrObject *descr = (PyDescrObject *)self; |
| 475 | Py_VISIT(descr->d_type); |
| 476 | return 0; |
Guido van Rossum | 048eb75 | 2001-10-02 21:24:57 +0000 | [diff] [blame] | 477 | } |
| 478 | |
Christian Heimes | a22e8bd | 2007-11-29 22:35:39 +0000 | [diff] [blame] | 479 | PyTypeObject PyMethodDescr_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 480 | PyVarObject_HEAD_INIT(&PyType_Type, 0) |
| 481 | "method_descriptor", |
| 482 | sizeof(PyMethodDescrObject), |
| 483 | 0, |
| 484 | (destructor)descr_dealloc, /* tp_dealloc */ |
| 485 | 0, /* tp_print */ |
| 486 | 0, /* tp_getattr */ |
| 487 | 0, /* tp_setattr */ |
| 488 | 0, /* tp_reserved */ |
| 489 | (reprfunc)method_repr, /* tp_repr */ |
| 490 | 0, /* tp_as_number */ |
| 491 | 0, /* tp_as_sequence */ |
| 492 | 0, /* tp_as_mapping */ |
| 493 | 0, /* tp_hash */ |
| 494 | (ternaryfunc)methoddescr_call, /* tp_call */ |
| 495 | 0, /* tp_str */ |
| 496 | PyObject_GenericGetAttr, /* tp_getattro */ |
| 497 | 0, /* tp_setattro */ |
| 498 | 0, /* tp_as_buffer */ |
| 499 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */ |
| 500 | 0, /* tp_doc */ |
| 501 | descr_traverse, /* tp_traverse */ |
| 502 | 0, /* tp_clear */ |
| 503 | 0, /* tp_richcompare */ |
| 504 | 0, /* tp_weaklistoffset */ |
| 505 | 0, /* tp_iter */ |
| 506 | 0, /* tp_iternext */ |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 507 | descr_methods, /* tp_methods */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 508 | descr_members, /* tp_members */ |
| 509 | method_getset, /* tp_getset */ |
| 510 | 0, /* tp_base */ |
| 511 | 0, /* tp_dict */ |
| 512 | (descrgetfunc)method_get, /* tp_descr_get */ |
| 513 | 0, /* tp_descr_set */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 514 | }; |
| 515 | |
Guido van Rossum | b6e5a0c | 2003-02-11 18:44:42 +0000 | [diff] [blame] | 516 | /* 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] | 517 | PyTypeObject PyClassMethodDescr_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 518 | PyVarObject_HEAD_INIT(&PyType_Type, 0) |
| 519 | "classmethod_descriptor", |
| 520 | sizeof(PyMethodDescrObject), |
| 521 | 0, |
| 522 | (destructor)descr_dealloc, /* tp_dealloc */ |
| 523 | 0, /* tp_print */ |
| 524 | 0, /* tp_getattr */ |
| 525 | 0, /* tp_setattr */ |
| 526 | 0, /* tp_reserved */ |
| 527 | (reprfunc)method_repr, /* tp_repr */ |
| 528 | 0, /* tp_as_number */ |
| 529 | 0, /* tp_as_sequence */ |
| 530 | 0, /* tp_as_mapping */ |
| 531 | 0, /* tp_hash */ |
| 532 | (ternaryfunc)classmethoddescr_call, /* tp_call */ |
| 533 | 0, /* tp_str */ |
| 534 | PyObject_GenericGetAttr, /* tp_getattro */ |
| 535 | 0, /* tp_setattro */ |
| 536 | 0, /* tp_as_buffer */ |
| 537 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */ |
| 538 | 0, /* tp_doc */ |
| 539 | descr_traverse, /* tp_traverse */ |
| 540 | 0, /* tp_clear */ |
| 541 | 0, /* tp_richcompare */ |
| 542 | 0, /* tp_weaklistoffset */ |
| 543 | 0, /* tp_iter */ |
| 544 | 0, /* tp_iternext */ |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 545 | descr_methods, /* tp_methods */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 546 | descr_members, /* tp_members */ |
| 547 | method_getset, /* tp_getset */ |
| 548 | 0, /* tp_base */ |
| 549 | 0, /* tp_dict */ |
| 550 | (descrgetfunc)classmethod_get, /* tp_descr_get */ |
| 551 | 0, /* tp_descr_set */ |
Tim Peters | bca1cbc | 2002-12-09 22:56:13 +0000 | [diff] [blame] | 552 | }; |
| 553 | |
Christian Heimes | a22e8bd | 2007-11-29 22:35:39 +0000 | [diff] [blame] | 554 | PyTypeObject PyMemberDescr_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 555 | PyVarObject_HEAD_INIT(&PyType_Type, 0) |
| 556 | "member_descriptor", |
| 557 | sizeof(PyMemberDescrObject), |
| 558 | 0, |
| 559 | (destructor)descr_dealloc, /* tp_dealloc */ |
| 560 | 0, /* tp_print */ |
| 561 | 0, /* tp_getattr */ |
| 562 | 0, /* tp_setattr */ |
| 563 | 0, /* tp_reserved */ |
| 564 | (reprfunc)member_repr, /* tp_repr */ |
| 565 | 0, /* tp_as_number */ |
| 566 | 0, /* tp_as_sequence */ |
| 567 | 0, /* tp_as_mapping */ |
| 568 | 0, /* tp_hash */ |
| 569 | 0, /* tp_call */ |
| 570 | 0, /* tp_str */ |
| 571 | PyObject_GenericGetAttr, /* tp_getattro */ |
| 572 | 0, /* tp_setattro */ |
| 573 | 0, /* tp_as_buffer */ |
| 574 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */ |
| 575 | 0, /* tp_doc */ |
| 576 | descr_traverse, /* tp_traverse */ |
| 577 | 0, /* tp_clear */ |
| 578 | 0, /* tp_richcompare */ |
| 579 | 0, /* tp_weaklistoffset */ |
| 580 | 0, /* tp_iter */ |
| 581 | 0, /* tp_iternext */ |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 582 | descr_methods, /* tp_methods */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 583 | descr_members, /* tp_members */ |
| 584 | member_getset, /* tp_getset */ |
| 585 | 0, /* tp_base */ |
| 586 | 0, /* tp_dict */ |
| 587 | (descrgetfunc)member_get, /* tp_descr_get */ |
| 588 | (descrsetfunc)member_set, /* tp_descr_set */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 589 | }; |
| 590 | |
Christian Heimes | a22e8bd | 2007-11-29 22:35:39 +0000 | [diff] [blame] | 591 | PyTypeObject PyGetSetDescr_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 592 | PyVarObject_HEAD_INIT(&PyType_Type, 0) |
| 593 | "getset_descriptor", |
| 594 | sizeof(PyGetSetDescrObject), |
| 595 | 0, |
| 596 | (destructor)descr_dealloc, /* tp_dealloc */ |
| 597 | 0, /* tp_print */ |
| 598 | 0, /* tp_getattr */ |
| 599 | 0, /* tp_setattr */ |
| 600 | 0, /* tp_reserved */ |
| 601 | (reprfunc)getset_repr, /* tp_repr */ |
| 602 | 0, /* tp_as_number */ |
| 603 | 0, /* tp_as_sequence */ |
| 604 | 0, /* tp_as_mapping */ |
| 605 | 0, /* tp_hash */ |
| 606 | 0, /* tp_call */ |
| 607 | 0, /* tp_str */ |
| 608 | PyObject_GenericGetAttr, /* tp_getattro */ |
| 609 | 0, /* tp_setattro */ |
| 610 | 0, /* tp_as_buffer */ |
| 611 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */ |
| 612 | 0, /* tp_doc */ |
| 613 | descr_traverse, /* tp_traverse */ |
| 614 | 0, /* tp_clear */ |
| 615 | 0, /* tp_richcompare */ |
| 616 | 0, /* tp_weaklistoffset */ |
| 617 | 0, /* tp_iter */ |
| 618 | 0, /* tp_iternext */ |
| 619 | 0, /* tp_methods */ |
| 620 | descr_members, /* tp_members */ |
| 621 | getset_getset, /* tp_getset */ |
| 622 | 0, /* tp_base */ |
| 623 | 0, /* tp_dict */ |
| 624 | (descrgetfunc)getset_get, /* tp_descr_get */ |
| 625 | (descrsetfunc)getset_set, /* tp_descr_set */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 626 | }; |
| 627 | |
Guido van Rossum | f4593e0 | 2001-10-03 12:09:30 +0000 | [diff] [blame] | 628 | PyTypeObject PyWrapperDescr_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 629 | PyVarObject_HEAD_INIT(&PyType_Type, 0) |
| 630 | "wrapper_descriptor", |
| 631 | sizeof(PyWrapperDescrObject), |
| 632 | 0, |
| 633 | (destructor)descr_dealloc, /* tp_dealloc */ |
| 634 | 0, /* tp_print */ |
| 635 | 0, /* tp_getattr */ |
| 636 | 0, /* tp_setattr */ |
| 637 | 0, /* tp_reserved */ |
| 638 | (reprfunc)wrapperdescr_repr, /* tp_repr */ |
| 639 | 0, /* tp_as_number */ |
| 640 | 0, /* tp_as_sequence */ |
| 641 | 0, /* tp_as_mapping */ |
| 642 | 0, /* tp_hash */ |
| 643 | (ternaryfunc)wrapperdescr_call, /* tp_call */ |
| 644 | 0, /* tp_str */ |
| 645 | PyObject_GenericGetAttr, /* tp_getattro */ |
| 646 | 0, /* tp_setattro */ |
| 647 | 0, /* tp_as_buffer */ |
| 648 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */ |
| 649 | 0, /* tp_doc */ |
| 650 | descr_traverse, /* tp_traverse */ |
| 651 | 0, /* tp_clear */ |
| 652 | 0, /* tp_richcompare */ |
| 653 | 0, /* tp_weaklistoffset */ |
| 654 | 0, /* tp_iter */ |
| 655 | 0, /* tp_iternext */ |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 656 | descr_methods, /* tp_methods */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 657 | descr_members, /* tp_members */ |
| 658 | wrapperdescr_getset, /* tp_getset */ |
| 659 | 0, /* tp_base */ |
| 660 | 0, /* tp_dict */ |
| 661 | (descrgetfunc)wrapperdescr_get, /* tp_descr_get */ |
| 662 | 0, /* tp_descr_set */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 663 | }; |
| 664 | |
| 665 | static PyDescrObject * |
Jeremy Hylton | af68c87 | 2005-12-10 18:50:16 +0000 | [diff] [blame] | 666 | descr_new(PyTypeObject *descrtype, PyTypeObject *type, const char *name) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 667 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 668 | PyDescrObject *descr; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 669 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 670 | descr = (PyDescrObject *)PyType_GenericAlloc(descrtype, 0); |
| 671 | if (descr != NULL) { |
| 672 | Py_XINCREF(type); |
| 673 | descr->d_type = type; |
| 674 | descr->d_name = PyUnicode_InternFromString(name); |
| 675 | if (descr->d_name == NULL) { |
| 676 | Py_DECREF(descr); |
| 677 | descr = NULL; |
| 678 | } |
Benjamin Peterson | f2fe7f0 | 2011-12-17 08:02:20 -0500 | [diff] [blame] | 679 | else { |
| 680 | descr->d_qualname = NULL; |
| 681 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 682 | } |
| 683 | return descr; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 684 | } |
| 685 | |
| 686 | PyObject * |
| 687 | PyDescr_NewMethod(PyTypeObject *type, PyMethodDef *method) |
| 688 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 689 | PyMethodDescrObject *descr; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 690 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 691 | descr = (PyMethodDescrObject *)descr_new(&PyMethodDescr_Type, |
| 692 | type, method->ml_name); |
| 693 | if (descr != NULL) |
| 694 | descr->d_method = method; |
| 695 | return (PyObject *)descr; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 696 | } |
| 697 | |
| 698 | PyObject * |
Tim Peters | bca1cbc | 2002-12-09 22:56:13 +0000 | [diff] [blame] | 699 | PyDescr_NewClassMethod(PyTypeObject *type, PyMethodDef *method) |
| 700 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 701 | PyMethodDescrObject *descr; |
Tim Peters | bca1cbc | 2002-12-09 22:56:13 +0000 | [diff] [blame] | 702 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 703 | descr = (PyMethodDescrObject *)descr_new(&PyClassMethodDescr_Type, |
| 704 | type, method->ml_name); |
| 705 | if (descr != NULL) |
| 706 | descr->d_method = method; |
| 707 | return (PyObject *)descr; |
Tim Peters | bca1cbc | 2002-12-09 22:56:13 +0000 | [diff] [blame] | 708 | } |
| 709 | |
| 710 | PyObject * |
Guido van Rossum | 6f79937 | 2001-09-20 20:46:19 +0000 | [diff] [blame] | 711 | PyDescr_NewMember(PyTypeObject *type, PyMemberDef *member) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 712 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 713 | PyMemberDescrObject *descr; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 714 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 715 | descr = (PyMemberDescrObject *)descr_new(&PyMemberDescr_Type, |
| 716 | type, member->name); |
| 717 | if (descr != NULL) |
| 718 | descr->d_member = member; |
| 719 | return (PyObject *)descr; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 720 | } |
| 721 | |
| 722 | PyObject * |
Guido van Rossum | 32d34c8 | 2001-09-20 21:45:26 +0000 | [diff] [blame] | 723 | PyDescr_NewGetSet(PyTypeObject *type, PyGetSetDef *getset) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 724 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 725 | PyGetSetDescrObject *descr; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 726 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 727 | descr = (PyGetSetDescrObject *)descr_new(&PyGetSetDescr_Type, |
| 728 | type, getset->name); |
| 729 | if (descr != NULL) |
| 730 | descr->d_getset = getset; |
| 731 | return (PyObject *)descr; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 732 | } |
| 733 | |
| 734 | PyObject * |
| 735 | PyDescr_NewWrapper(PyTypeObject *type, struct wrapperbase *base, void *wrapped) |
| 736 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 737 | PyWrapperDescrObject *descr; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 738 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 739 | descr = (PyWrapperDescrObject *)descr_new(&PyWrapperDescr_Type, |
| 740 | type, base->name); |
| 741 | if (descr != NULL) { |
| 742 | descr->d_base = base; |
| 743 | descr->d_wrapped = wrapped; |
| 744 | } |
| 745 | return (PyObject *)descr; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 746 | } |
| 747 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 748 | |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 749 | /* --- mappingproxy: read-only proxy for mappings --- */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 750 | |
| 751 | /* This has no reason to be in this file except that adding new files is a |
| 752 | bit of a pain */ |
| 753 | |
| 754 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 755 | PyObject_HEAD |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 756 | PyObject *mapping; |
| 757 | } mappingproxyobject; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 758 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 759 | static Py_ssize_t |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 760 | mappingproxy_len(mappingproxyobject *pp) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 761 | { |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 762 | return PyObject_Size(pp->mapping); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 763 | } |
| 764 | |
| 765 | static PyObject * |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 766 | mappingproxy_getitem(mappingproxyobject *pp, PyObject *key) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 767 | { |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 768 | return PyObject_GetItem(pp->mapping, key); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 769 | } |
| 770 | |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 771 | static PyMappingMethods mappingproxy_as_mapping = { |
| 772 | (lenfunc)mappingproxy_len, /* mp_length */ |
| 773 | (binaryfunc)mappingproxy_getitem, /* mp_subscript */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 774 | 0, /* mp_ass_subscript */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 775 | }; |
| 776 | |
| 777 | static int |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 778 | mappingproxy_contains(mappingproxyobject *pp, PyObject *key) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 779 | { |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 780 | if (PyDict_CheckExact(pp->mapping)) |
| 781 | return PyDict_Contains(pp->mapping, key); |
| 782 | else |
| 783 | return PySequence_Contains(pp->mapping, key); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 784 | } |
| 785 | |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 786 | static PySequenceMethods mappingproxy_as_sequence = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 787 | 0, /* sq_length */ |
| 788 | 0, /* sq_concat */ |
| 789 | 0, /* sq_repeat */ |
| 790 | 0, /* sq_item */ |
| 791 | 0, /* sq_slice */ |
| 792 | 0, /* sq_ass_item */ |
| 793 | 0, /* sq_ass_slice */ |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 794 | (objobjproc)mappingproxy_contains, /* sq_contains */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 795 | 0, /* sq_inplace_concat */ |
| 796 | 0, /* sq_inplace_repeat */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 797 | }; |
| 798 | |
| 799 | static PyObject * |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 800 | mappingproxy_get(mappingproxyobject *pp, PyObject *args) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 801 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 802 | PyObject *key, *def = Py_None; |
Martin v. Löwis | bd928fe | 2011-10-14 10:20:37 +0200 | [diff] [blame] | 803 | _Py_IDENTIFIER(get); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 804 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 805 | if (!PyArg_UnpackTuple(args, "get", 1, 2, &key, &def)) |
| 806 | return NULL; |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 807 | return _PyObject_CallMethodId(pp->mapping, &PyId_get, "(OO)", key, def); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 808 | } |
| 809 | |
| 810 | static PyObject * |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 811 | mappingproxy_keys(mappingproxyobject *pp) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 812 | { |
Martin v. Löwis | bd928fe | 2011-10-14 10:20:37 +0200 | [diff] [blame] | 813 | _Py_IDENTIFIER(keys); |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 814 | return _PyObject_CallMethodId(pp->mapping, &PyId_keys, NULL); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 815 | } |
| 816 | |
| 817 | static PyObject * |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 818 | mappingproxy_values(mappingproxyobject *pp) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 819 | { |
Martin v. Löwis | bd928fe | 2011-10-14 10:20:37 +0200 | [diff] [blame] | 820 | _Py_IDENTIFIER(values); |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 821 | return _PyObject_CallMethodId(pp->mapping, &PyId_values, NULL); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 822 | } |
| 823 | |
| 824 | static PyObject * |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 825 | mappingproxy_items(mappingproxyobject *pp) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 826 | { |
Martin v. Löwis | bd928fe | 2011-10-14 10:20:37 +0200 | [diff] [blame] | 827 | _Py_IDENTIFIER(items); |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 828 | return _PyObject_CallMethodId(pp->mapping, &PyId_items, NULL); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 829 | } |
| 830 | |
| 831 | static PyObject * |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 832 | mappingproxy_copy(mappingproxyobject *pp) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 833 | { |
Martin v. Löwis | bd928fe | 2011-10-14 10:20:37 +0200 | [diff] [blame] | 834 | _Py_IDENTIFIER(copy); |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 835 | return _PyObject_CallMethodId(pp->mapping, &PyId_copy, NULL); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 836 | } |
| 837 | |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 838 | /* WARNING: mappingproxy methods must not give access |
| 839 | to the underlying mapping */ |
| 840 | |
| 841 | static PyMethodDef mappingproxy_methods[] = { |
| 842 | {"get", (PyCFunction)mappingproxy_get, METH_VARARGS, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 843 | 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] | 844 | " d defaults to None.")}, |
| 845 | {"keys", (PyCFunction)mappingproxy_keys, METH_NOARGS, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 846 | PyDoc_STR("D.keys() -> list of D's keys")}, |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 847 | {"values", (PyCFunction)mappingproxy_values, METH_NOARGS, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 848 | PyDoc_STR("D.values() -> list of D's values")}, |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 849 | {"items", (PyCFunction)mappingproxy_items, METH_NOARGS, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 850 | 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] | 851 | {"copy", (PyCFunction)mappingproxy_copy, METH_NOARGS, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 852 | PyDoc_STR("D.copy() -> a shallow copy of D")}, |
| 853 | {0} |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 854 | }; |
| 855 | |
| 856 | static void |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 857 | mappingproxy_dealloc(mappingproxyobject *pp) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 858 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 859 | _PyObject_GC_UNTRACK(pp); |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 860 | Py_DECREF(pp->mapping); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 861 | PyObject_GC_Del(pp); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 862 | } |
| 863 | |
| 864 | static PyObject * |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 865 | mappingproxy_getiter(mappingproxyobject *pp) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 866 | { |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 867 | return PyObject_GetIter(pp->mapping); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 868 | } |
| 869 | |
Neil Schemenauer | 2677512 | 2001-10-21 22:26:43 +0000 | [diff] [blame] | 870 | static PyObject * |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 871 | mappingproxy_str(mappingproxyobject *pp) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 872 | { |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 873 | return PyObject_Str(pp->mapping); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 874 | } |
| 875 | |
Ezio Melotti | ac53ab6 | 2010-12-18 14:59:43 +0000 | [diff] [blame] | 876 | static PyObject * |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 877 | mappingproxy_repr(mappingproxyobject *pp) |
Ezio Melotti | ac53ab6 | 2010-12-18 14:59:43 +0000 | [diff] [blame] | 878 | { |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 879 | return PyUnicode_FromFormat("mappingproxy(%R)", pp->mapping); |
Ezio Melotti | ac53ab6 | 2010-12-18 14:59:43 +0000 | [diff] [blame] | 880 | } |
| 881 | |
Guido van Rossum | 048eb75 | 2001-10-02 21:24:57 +0000 | [diff] [blame] | 882 | static int |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 883 | mappingproxy_traverse(PyObject *self, visitproc visit, void *arg) |
Guido van Rossum | 048eb75 | 2001-10-02 21:24:57 +0000 | [diff] [blame] | 884 | { |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 885 | mappingproxyobject *pp = (mappingproxyobject *)self; |
| 886 | Py_VISIT(pp->mapping); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 887 | return 0; |
Guido van Rossum | 048eb75 | 2001-10-02 21:24:57 +0000 | [diff] [blame] | 888 | } |
| 889 | |
Raymond Hettinger | 29a6d44 | 2002-08-31 15:51:04 +0000 | [diff] [blame] | 890 | static PyObject * |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 891 | mappingproxy_richcompare(mappingproxyobject *v, PyObject *w, int op) |
Raymond Hettinger | 29a6d44 | 2002-08-31 15:51:04 +0000 | [diff] [blame] | 892 | { |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 893 | return PyObject_RichCompare(v->mapping, w, op); |
| 894 | } |
| 895 | |
| 896 | static int |
| 897 | mappingproxy_check_mapping(PyObject *mapping) |
| 898 | { |
| 899 | if (!PyMapping_Check(mapping) |
| 900 | || PyList_Check(mapping) |
| 901 | || PyTuple_Check(mapping)) { |
| 902 | PyErr_Format(PyExc_TypeError, |
| 903 | "mappingproxy() argument must be a mapping, not %s", |
| 904 | Py_TYPE(mapping)->tp_name); |
| 905 | return -1; |
| 906 | } |
| 907 | return 0; |
| 908 | } |
| 909 | |
| 910 | static PyObject* |
| 911 | mappingproxy_new(PyTypeObject *type, PyObject *args, PyObject *kwds) |
| 912 | { |
| 913 | static char *kwlist[] = {"mapping", NULL}; |
| 914 | PyObject *mapping; |
| 915 | mappingproxyobject *mappingproxy; |
| 916 | |
| 917 | if (!PyArg_ParseTupleAndKeywords(args, kwds, "O:mappingproxy", |
| 918 | kwlist, &mapping)) |
| 919 | return NULL; |
| 920 | |
| 921 | if (mappingproxy_check_mapping(mapping) == -1) |
| 922 | return NULL; |
| 923 | |
| 924 | mappingproxy = PyObject_GC_New(mappingproxyobject, &PyDictProxy_Type); |
| 925 | if (mappingproxy == NULL) |
| 926 | return NULL; |
| 927 | Py_INCREF(mapping); |
| 928 | mappingproxy->mapping = mapping; |
| 929 | _PyObject_GC_TRACK(mappingproxy); |
| 930 | return (PyObject *)mappingproxy; |
Raymond Hettinger | 29a6d44 | 2002-08-31 15:51:04 +0000 | [diff] [blame] | 931 | } |
| 932 | |
Christian Heimes | a22e8bd | 2007-11-29 22:35:39 +0000 | [diff] [blame] | 933 | PyTypeObject PyDictProxy_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 934 | PyVarObject_HEAD_INIT(&PyType_Type, 0) |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 935 | "mappingproxy", /* tp_name */ |
| 936 | sizeof(mappingproxyobject), /* tp_basicsize */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 937 | 0, /* tp_itemsize */ |
| 938 | /* methods */ |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 939 | (destructor)mappingproxy_dealloc, /* tp_dealloc */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 940 | 0, /* tp_print */ |
| 941 | 0, /* tp_getattr */ |
| 942 | 0, /* tp_setattr */ |
| 943 | 0, /* tp_reserved */ |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 944 | (reprfunc)mappingproxy_repr, /* tp_repr */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 945 | 0, /* tp_as_number */ |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 946 | &mappingproxy_as_sequence, /* tp_as_sequence */ |
| 947 | &mappingproxy_as_mapping, /* tp_as_mapping */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 948 | 0, /* tp_hash */ |
| 949 | 0, /* tp_call */ |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 950 | (reprfunc)mappingproxy_str, /* tp_str */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 951 | PyObject_GenericGetAttr, /* tp_getattro */ |
| 952 | 0, /* tp_setattro */ |
| 953 | 0, /* tp_as_buffer */ |
| 954 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */ |
| 955 | 0, /* tp_doc */ |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 956 | mappingproxy_traverse, /* tp_traverse */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 957 | 0, /* tp_clear */ |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 958 | (richcmpfunc)mappingproxy_richcompare, /* tp_richcompare */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 959 | 0, /* tp_weaklistoffset */ |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 960 | (getiterfunc)mappingproxy_getiter, /* tp_iter */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 961 | 0, /* tp_iternext */ |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 962 | mappingproxy_methods, /* tp_methods */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 963 | 0, /* tp_members */ |
| 964 | 0, /* tp_getset */ |
| 965 | 0, /* tp_base */ |
| 966 | 0, /* tp_dict */ |
| 967 | 0, /* tp_descr_get */ |
| 968 | 0, /* tp_descr_set */ |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 969 | 0, /* tp_dictoffset */ |
| 970 | 0, /* tp_init */ |
| 971 | 0, /* tp_alloc */ |
| 972 | mappingproxy_new, /* tp_new */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 973 | }; |
| 974 | |
| 975 | PyObject * |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 976 | PyDictProxy_New(PyObject *mapping) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 977 | { |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 978 | mappingproxyobject *pp; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 979 | |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 980 | if (mappingproxy_check_mapping(mapping) == -1) |
| 981 | return NULL; |
| 982 | |
| 983 | pp = PyObject_GC_New(mappingproxyobject, &PyDictProxy_Type); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 984 | if (pp != NULL) { |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 985 | Py_INCREF(mapping); |
| 986 | pp->mapping = mapping; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 987 | _PyObject_GC_TRACK(pp); |
| 988 | } |
| 989 | return (PyObject *)pp; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 990 | } |
| 991 | |
| 992 | |
| 993 | /* --- Wrapper object for "slot" methods --- */ |
| 994 | |
| 995 | /* This has no reason to be in this file except that adding new files is a |
| 996 | bit of a pain */ |
| 997 | |
| 998 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 999 | PyObject_HEAD |
| 1000 | PyWrapperDescrObject *descr; |
| 1001 | PyObject *self; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1002 | } wrapperobject; |
| 1003 | |
Benjamin Peterson | eff61f6 | 2011-09-01 16:32:31 -0400 | [diff] [blame] | 1004 | #define Wrapper_Check(v) (Py_TYPE(v) == &_PyMethodWrapper_Type) |
Mark Dickinson | 211c625 | 2009-02-01 10:28:51 +0000 | [diff] [blame] | 1005 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1006 | static void |
| 1007 | wrapper_dealloc(wrapperobject *wp) |
| 1008 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1009 | PyObject_GC_UnTrack(wp); |
| 1010 | Py_TRASHCAN_SAFE_BEGIN(wp) |
| 1011 | Py_XDECREF(wp->descr); |
| 1012 | Py_XDECREF(wp->self); |
| 1013 | PyObject_GC_Del(wp); |
| 1014 | Py_TRASHCAN_SAFE_END(wp) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1015 | } |
| 1016 | |
Mark Dickinson | 211c625 | 2009-02-01 10:28:51 +0000 | [diff] [blame] | 1017 | #define TEST_COND(cond) ((cond) ? Py_True : Py_False) |
| 1018 | |
| 1019 | static PyObject * |
| 1020 | wrapper_richcompare(PyObject *a, PyObject *b, int op) |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 1021 | { |
Benjamin Peterson | ca47063 | 2016-09-06 13:47:26 -0700 | [diff] [blame] | 1022 | intptr_t result; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1023 | PyObject *v; |
| 1024 | PyWrapperDescrObject *a_descr, *b_descr; |
Mark Dickinson | 211c625 | 2009-02-01 10:28:51 +0000 | [diff] [blame] | 1025 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1026 | assert(a != NULL && b != NULL); |
Mark Dickinson | 211c625 | 2009-02-01 10:28:51 +0000 | [diff] [blame] | 1027 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1028 | /* both arguments should be wrapperobjects */ |
| 1029 | if (!Wrapper_Check(a) || !Wrapper_Check(b)) { |
| 1030 | v = Py_NotImplemented; |
| 1031 | Py_INCREF(v); |
| 1032 | return v; |
| 1033 | } |
Mark Dickinson | 211c625 | 2009-02-01 10:28:51 +0000 | [diff] [blame] | 1034 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1035 | /* compare by descriptor address; if the descriptors are the same, |
| 1036 | compare by the objects they're bound to */ |
| 1037 | a_descr = ((wrapperobject *)a)->descr; |
| 1038 | b_descr = ((wrapperobject *)b)->descr; |
| 1039 | if (a_descr == b_descr) { |
| 1040 | a = ((wrapperobject *)a)->self; |
| 1041 | b = ((wrapperobject *)b)->self; |
| 1042 | return PyObject_RichCompare(a, b, op); |
| 1043 | } |
Mark Dickinson | 211c625 | 2009-02-01 10:28:51 +0000 | [diff] [blame] | 1044 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1045 | result = a_descr - b_descr; |
| 1046 | switch (op) { |
| 1047 | case Py_EQ: |
| 1048 | v = TEST_COND(result == 0); |
| 1049 | break; |
| 1050 | case Py_NE: |
| 1051 | v = TEST_COND(result != 0); |
| 1052 | break; |
| 1053 | case Py_LE: |
| 1054 | v = TEST_COND(result <= 0); |
| 1055 | break; |
| 1056 | case Py_GE: |
| 1057 | v = TEST_COND(result >= 0); |
| 1058 | break; |
| 1059 | case Py_LT: |
| 1060 | v = TEST_COND(result < 0); |
| 1061 | break; |
| 1062 | case Py_GT: |
| 1063 | v = TEST_COND(result > 0); |
| 1064 | break; |
| 1065 | default: |
| 1066 | PyErr_BadArgument(); |
| 1067 | return NULL; |
| 1068 | } |
| 1069 | Py_INCREF(v); |
| 1070 | return v; |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 1071 | } |
| 1072 | |
Benjamin Peterson | 8f67d08 | 2010-10-17 20:54:53 +0000 | [diff] [blame] | 1073 | static Py_hash_t |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1074 | wrapper_hash(wrapperobject *wp) |
| 1075 | { |
Benjamin Peterson | 8f67d08 | 2010-10-17 20:54:53 +0000 | [diff] [blame] | 1076 | Py_hash_t x, y; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1077 | x = _Py_HashPointer(wp->descr); |
| 1078 | if (x == -1) |
| 1079 | return -1; |
| 1080 | y = PyObject_Hash(wp->self); |
| 1081 | if (y == -1) |
| 1082 | return -1; |
| 1083 | x = x ^ y; |
| 1084 | if (x == -1) |
| 1085 | x = -2; |
| 1086 | return x; |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 1087 | } |
| 1088 | |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 1089 | static PyObject * |
| 1090 | wrapper_repr(wrapperobject *wp) |
| 1091 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1092 | return PyUnicode_FromFormat("<method-wrapper '%s' of %s object at %p>", |
| 1093 | wp->descr->d_base->name, |
| 1094 | wp->self->ob_type->tp_name, |
| 1095 | wp->self); |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 1096 | } |
| 1097 | |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1098 | static PyObject * |
| 1099 | wrapper_reduce(wrapperobject *wp) |
| 1100 | { |
| 1101 | PyObject *builtins; |
| 1102 | PyObject *getattr; |
| 1103 | _Py_IDENTIFIER(getattr); |
| 1104 | |
| 1105 | builtins = PyEval_GetBuiltins(); |
| 1106 | getattr = _PyDict_GetItemId(builtins, &PyId_getattr); |
| 1107 | return Py_BuildValue("O(OO)", getattr, wp->self, PyDescr_NAME(wp->descr)); |
| 1108 | } |
| 1109 | |
| 1110 | static PyMethodDef wrapper_methods[] = { |
| 1111 | {"__reduce__", (PyCFunction)wrapper_reduce, METH_NOARGS, NULL}, |
| 1112 | {NULL, NULL} |
| 1113 | }; |
| 1114 | |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 1115 | static PyMemberDef wrapper_members[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1116 | {"__self__", T_OBJECT, offsetof(wrapperobject, self), READONLY}, |
| 1117 | {0} |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1118 | }; |
| 1119 | |
| 1120 | static PyObject * |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 1121 | wrapper_objclass(wrapperobject *wp) |
| 1122 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1123 | PyObject *c = (PyObject *)PyDescr_TYPE(wp->descr); |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 1124 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1125 | Py_INCREF(c); |
| 1126 | return c; |
Armin Rigo | c6686b7 | 2005-11-07 08:38:00 +0000 | [diff] [blame] | 1127 | } |
| 1128 | |
| 1129 | static PyObject * |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1130 | wrapper_name(wrapperobject *wp) |
| 1131 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1132 | const char *s = wp->descr->d_base->name; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1133 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1134 | return PyUnicode_FromString(s); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1135 | } |
| 1136 | |
| 1137 | static PyObject * |
Larry Hastings | 5c66189 | 2014-01-24 06:17:25 -0800 | [diff] [blame] | 1138 | wrapper_doc(wrapperobject *wp, void *closure) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1139 | { |
Larry Hastings | 2623c8c | 2014-02-08 22:15:29 -0800 | [diff] [blame] | 1140 | 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] | 1141 | } |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1142 | |
Larry Hastings | 5c66189 | 2014-01-24 06:17:25 -0800 | [diff] [blame] | 1143 | static PyObject * |
| 1144 | wrapper_text_signature(wrapperobject *wp, void *closure) |
| 1145 | { |
Larry Hastings | 2623c8c | 2014-02-08 22:15:29 -0800 | [diff] [blame] | 1146 | 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] | 1147 | } |
| 1148 | |
Antoine Pitrou | 9d57481 | 2011-12-12 13:47:25 +0100 | [diff] [blame] | 1149 | static PyObject * |
| 1150 | wrapper_qualname(wrapperobject *wp) |
| 1151 | { |
| 1152 | return descr_get_qualname((PyDescrObject *)wp->descr); |
| 1153 | } |
| 1154 | |
Guido van Rossum | 32d34c8 | 2001-09-20 21:45:26 +0000 | [diff] [blame] | 1155 | static PyGetSetDef wrapper_getsets[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1156 | {"__objclass__", (getter)wrapper_objclass}, |
| 1157 | {"__name__", (getter)wrapper_name}, |
Antoine Pitrou | 9d57481 | 2011-12-12 13:47:25 +0100 | [diff] [blame] | 1158 | {"__qualname__", (getter)wrapper_qualname}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1159 | {"__doc__", (getter)wrapper_doc}, |
Larry Hastings | 5c66189 | 2014-01-24 06:17:25 -0800 | [diff] [blame] | 1160 | {"__text_signature__", (getter)wrapper_text_signature}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1161 | {0} |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1162 | }; |
| 1163 | |
| 1164 | static PyObject * |
| 1165 | wrapper_call(wrapperobject *wp, PyObject *args, PyObject *kwds) |
| 1166 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1167 | wrapperfunc wrapper = wp->descr->d_base->wrapper; |
| 1168 | PyObject *self = wp->self; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1169 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1170 | if (wp->descr->d_base->flags & PyWrapperFlag_KEYWORDS) { |
| 1171 | wrapperfunc_kwds wk = (wrapperfunc_kwds)wrapper; |
| 1172 | return (*wk)(self, args, wp->descr->d_wrapped, kwds); |
| 1173 | } |
Guido van Rossum | c8e5645 | 2001-10-22 00:43:43 +0000 | [diff] [blame] | 1174 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1175 | if (kwds != NULL && (!PyDict_Check(kwds) || PyDict_Size(kwds) != 0)) { |
| 1176 | PyErr_Format(PyExc_TypeError, |
| 1177 | "wrapper %s doesn't take keyword arguments", |
| 1178 | wp->descr->d_base->name); |
| 1179 | return NULL; |
| 1180 | } |
| 1181 | return (*wrapper)(self, args, wp->descr->d_wrapped); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1182 | } |
| 1183 | |
Guido van Rossum | 048eb75 | 2001-10-02 21:24:57 +0000 | [diff] [blame] | 1184 | static int |
| 1185 | wrapper_traverse(PyObject *self, visitproc visit, void *arg) |
| 1186 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1187 | wrapperobject *wp = (wrapperobject *)self; |
| 1188 | Py_VISIT(wp->descr); |
| 1189 | Py_VISIT(wp->self); |
| 1190 | return 0; |
Guido van Rossum | 048eb75 | 2001-10-02 21:24:57 +0000 | [diff] [blame] | 1191 | } |
| 1192 | |
Benjamin Peterson | eff61f6 | 2011-09-01 16:32:31 -0400 | [diff] [blame] | 1193 | PyTypeObject _PyMethodWrapper_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1194 | PyVarObject_HEAD_INIT(&PyType_Type, 0) |
| 1195 | "method-wrapper", /* tp_name */ |
| 1196 | sizeof(wrapperobject), /* tp_basicsize */ |
| 1197 | 0, /* tp_itemsize */ |
| 1198 | /* methods */ |
| 1199 | (destructor)wrapper_dealloc, /* tp_dealloc */ |
| 1200 | 0, /* tp_print */ |
| 1201 | 0, /* tp_getattr */ |
| 1202 | 0, /* tp_setattr */ |
| 1203 | 0, /* tp_reserved */ |
| 1204 | (reprfunc)wrapper_repr, /* tp_repr */ |
| 1205 | 0, /* tp_as_number */ |
| 1206 | 0, /* tp_as_sequence */ |
| 1207 | 0, /* tp_as_mapping */ |
| 1208 | (hashfunc)wrapper_hash, /* tp_hash */ |
| 1209 | (ternaryfunc)wrapper_call, /* tp_call */ |
| 1210 | 0, /* tp_str */ |
| 1211 | PyObject_GenericGetAttr, /* tp_getattro */ |
| 1212 | 0, /* tp_setattro */ |
| 1213 | 0, /* tp_as_buffer */ |
| 1214 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */ |
| 1215 | 0, /* tp_doc */ |
| 1216 | wrapper_traverse, /* tp_traverse */ |
| 1217 | 0, /* tp_clear */ |
| 1218 | wrapper_richcompare, /* tp_richcompare */ |
| 1219 | 0, /* tp_weaklistoffset */ |
| 1220 | 0, /* tp_iter */ |
| 1221 | 0, /* tp_iternext */ |
Antoine Pitrou | c9dc4a2 | 2013-11-23 18:59:12 +0100 | [diff] [blame] | 1222 | wrapper_methods, /* tp_methods */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1223 | wrapper_members, /* tp_members */ |
| 1224 | wrapper_getsets, /* tp_getset */ |
| 1225 | 0, /* tp_base */ |
| 1226 | 0, /* tp_dict */ |
| 1227 | 0, /* tp_descr_get */ |
| 1228 | 0, /* tp_descr_set */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1229 | }; |
| 1230 | |
| 1231 | PyObject * |
| 1232 | PyWrapper_New(PyObject *d, PyObject *self) |
| 1233 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1234 | wrapperobject *wp; |
| 1235 | PyWrapperDescrObject *descr; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1236 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1237 | assert(PyObject_TypeCheck(d, &PyWrapperDescr_Type)); |
| 1238 | descr = (PyWrapperDescrObject *)d; |
Victor Stinner | 3249dec | 2011-05-01 23:19:15 +0200 | [diff] [blame] | 1239 | assert(_PyObject_RealIsSubclass((PyObject *)Py_TYPE(self), |
Victor Stinner | d956131 | 2011-05-01 23:31:36 +0200 | [diff] [blame] | 1240 | (PyObject *)PyDescr_TYPE(descr))); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1241 | |
Benjamin Peterson | eff61f6 | 2011-09-01 16:32:31 -0400 | [diff] [blame] | 1242 | wp = PyObject_GC_New(wrapperobject, &_PyMethodWrapper_Type); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1243 | if (wp != NULL) { |
| 1244 | Py_INCREF(descr); |
| 1245 | wp->descr = descr; |
| 1246 | Py_INCREF(self); |
| 1247 | wp->self = self; |
| 1248 | _PyObject_GC_TRACK(wp); |
| 1249 | } |
| 1250 | return (PyObject *)wp; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1251 | } |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1252 | |
| 1253 | |
Guido van Rossum | 8bce4ac | 2001-09-06 21:56:42 +0000 | [diff] [blame] | 1254 | /* A built-in 'property' type */ |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1255 | |
| 1256 | /* |
Serhiy Storchaka | d741a88 | 2015-06-11 00:06:39 +0300 | [diff] [blame] | 1257 | class property(object): |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1258 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1259 | def __init__(self, fget=None, fset=None, fdel=None, doc=None): |
| 1260 | 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] | 1261 | doc = fget.__doc__ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1262 | self.__get = fget |
| 1263 | self.__set = fset |
| 1264 | self.__del = fdel |
| 1265 | self.__doc__ = doc |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1266 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1267 | def __get__(self, inst, type=None): |
| 1268 | if inst is None: |
Serhiy Storchaka | d741a88 | 2015-06-11 00:06:39 +0300 | [diff] [blame] | 1269 | return self |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1270 | if self.__get is None: |
Serhiy Storchaka | d741a88 | 2015-06-11 00:06:39 +0300 | [diff] [blame] | 1271 | raise AttributeError, "unreadable attribute" |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1272 | return self.__get(inst) |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1273 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1274 | def __set__(self, inst, value): |
| 1275 | if self.__set is None: |
Serhiy Storchaka | d741a88 | 2015-06-11 00:06:39 +0300 | [diff] [blame] | 1276 | raise AttributeError, "can't set attribute" |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1277 | return self.__set(inst, value) |
Guido van Rossum | ba2485f | 2001-12-10 18:03:34 +0000 | [diff] [blame] | 1278 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1279 | def __delete__(self, inst): |
| 1280 | if self.__del is None: |
Serhiy Storchaka | d741a88 | 2015-06-11 00:06:39 +0300 | [diff] [blame] | 1281 | raise AttributeError, "can't delete attribute" |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1282 | return self.__del(inst) |
Guido van Rossum | ba2485f | 2001-12-10 18:03:34 +0000 | [diff] [blame] | 1283 | |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1284 | */ |
| 1285 | |
| 1286 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1287 | PyObject_HEAD |
| 1288 | PyObject *prop_get; |
| 1289 | PyObject *prop_set; |
| 1290 | PyObject *prop_del; |
| 1291 | PyObject *prop_doc; |
| 1292 | int getter_doc; |
Guido van Rossum | 8bce4ac | 2001-09-06 21:56:42 +0000 | [diff] [blame] | 1293 | } propertyobject; |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1294 | |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 1295 | static PyObject * property_copy(PyObject *, PyObject *, PyObject *, |
Benjamin Peterson | 9396483 | 2010-06-28 03:07:10 +0000 | [diff] [blame] | 1296 | PyObject *); |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 1297 | |
Tim Peters | 66c1a52 | 2001-09-24 21:17:50 +0000 | [diff] [blame] | 1298 | static PyMemberDef property_members[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1299 | {"fget", T_OBJECT, offsetof(propertyobject, prop_get), READONLY}, |
| 1300 | {"fset", T_OBJECT, offsetof(propertyobject, prop_set), READONLY}, |
| 1301 | {"fdel", T_OBJECT, offsetof(propertyobject, prop_del), READONLY}, |
Raymond Hettinger | eac503a | 2015-05-13 01:09:59 -0700 | [diff] [blame] | 1302 | {"__doc__", T_OBJECT, offsetof(propertyobject, prop_doc), 0}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1303 | {0} |
Tim Peters | 66c1a52 | 2001-09-24 21:17:50 +0000 | [diff] [blame] | 1304 | }; |
| 1305 | |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 1306 | |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1307 | PyDoc_STRVAR(getter_doc, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1308 | "Descriptor to change the getter on a property."); |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1309 | |
Neal Norwitz | 32dde22 | 2008-04-15 06:43:13 +0000 | [diff] [blame] | 1310 | static PyObject * |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1311 | property_getter(PyObject *self, PyObject *getter) |
| 1312 | { |
Benjamin Peterson | 9396483 | 2010-06-28 03:07:10 +0000 | [diff] [blame] | 1313 | return property_copy(self, getter, NULL, NULL); |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1314 | } |
| 1315 | |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 1316 | |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1317 | PyDoc_STRVAR(setter_doc, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1318 | "Descriptor to change the setter on a property."); |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1319 | |
Neal Norwitz | 32dde22 | 2008-04-15 06:43:13 +0000 | [diff] [blame] | 1320 | static PyObject * |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1321 | property_setter(PyObject *self, PyObject *setter) |
| 1322 | { |
Benjamin Peterson | 9396483 | 2010-06-28 03:07:10 +0000 | [diff] [blame] | 1323 | return property_copy(self, NULL, setter, NULL); |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1324 | } |
| 1325 | |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 1326 | |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1327 | PyDoc_STRVAR(deleter_doc, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1328 | "Descriptor to change the deleter on a property."); |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1329 | |
Neal Norwitz | 32dde22 | 2008-04-15 06:43:13 +0000 | [diff] [blame] | 1330 | static PyObject * |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1331 | property_deleter(PyObject *self, PyObject *deleter) |
| 1332 | { |
Benjamin Peterson | 9396483 | 2010-06-28 03:07:10 +0000 | [diff] [blame] | 1333 | return property_copy(self, NULL, NULL, deleter); |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1334 | } |
| 1335 | |
| 1336 | |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1337 | static PyMethodDef property_methods[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1338 | {"getter", property_getter, METH_O, getter_doc}, |
| 1339 | {"setter", property_setter, METH_O, setter_doc}, |
| 1340 | {"deleter", property_deleter, METH_O, deleter_doc}, |
| 1341 | {0} |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 1342 | }; |
| 1343 | |
Tim Peters | 66c1a52 | 2001-09-24 21:17:50 +0000 | [diff] [blame] | 1344 | |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1345 | static void |
Guido van Rossum | 8bce4ac | 2001-09-06 21:56:42 +0000 | [diff] [blame] | 1346 | property_dealloc(PyObject *self) |
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 | propertyobject *gs = (propertyobject *)self; |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1349 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1350 | _PyObject_GC_UNTRACK(self); |
| 1351 | Py_XDECREF(gs->prop_get); |
| 1352 | Py_XDECREF(gs->prop_set); |
| 1353 | Py_XDECREF(gs->prop_del); |
| 1354 | Py_XDECREF(gs->prop_doc); |
| 1355 | self->ob_type->tp_free(self); |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1356 | } |
| 1357 | |
| 1358 | static PyObject * |
Guido van Rossum | 8bce4ac | 2001-09-06 21:56:42 +0000 | [diff] [blame] | 1359 | property_descr_get(PyObject *self, PyObject *obj, PyObject *type) |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1360 | { |
Serhiy Storchaka | a7a0ad6 | 2015-05-24 21:38:06 +0300 | [diff] [blame] | 1361 | static PyObject * volatile cached_args = NULL; |
| 1362 | PyObject *args; |
Raymond Hettinger | c4e335b | 2015-04-30 08:08:13 -0700 | [diff] [blame] | 1363 | PyObject *ret; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1364 | propertyobject *gs = (propertyobject *)self; |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1365 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1366 | if (obj == NULL || obj == Py_None) { |
| 1367 | Py_INCREF(self); |
| 1368 | return self; |
| 1369 | } |
| 1370 | if (gs->prop_get == NULL) { |
| 1371 | PyErr_SetString(PyExc_AttributeError, "unreadable attribute"); |
| 1372 | return NULL; |
| 1373 | } |
Serhiy Storchaka | a7a0ad6 | 2015-05-24 21:38:06 +0300 | [diff] [blame] | 1374 | args = cached_args; |
Serhiy Storchaka | 7822f15 | 2016-05-04 21:42:05 +0300 | [diff] [blame] | 1375 | cached_args = NULL; |
| 1376 | if (!args) { |
| 1377 | args = PyTuple_New(1); |
| 1378 | if (!args) |
Serhiy Storchaka | a7a0ad6 | 2015-05-24 21:38:06 +0300 | [diff] [blame] | 1379 | return NULL; |
Serhiy Storchaka | 7822f15 | 2016-05-04 21:42:05 +0300 | [diff] [blame] | 1380 | _PyObject_GC_UNTRACK(args); |
Raymond Hettinger | c4e335b | 2015-04-30 08:08:13 -0700 | [diff] [blame] | 1381 | } |
Serhiy Storchaka | a7a0ad6 | 2015-05-24 21:38:06 +0300 | [diff] [blame] | 1382 | Py_INCREF(obj); |
Raymond Hettinger | c4e335b | 2015-04-30 08:08:13 -0700 | [diff] [blame] | 1383 | PyTuple_SET_ITEM(args, 0, obj); |
| 1384 | ret = PyObject_Call(gs->prop_get, args, NULL); |
Serhiy Storchaka | 7822f15 | 2016-05-04 21:42:05 +0300 | [diff] [blame] | 1385 | if (cached_args == NULL && Py_REFCNT(args) == 1) { |
| 1386 | assert(Py_SIZE(args) == 1); |
| 1387 | assert(PyTuple_GET_ITEM(args, 0) == obj); |
| 1388 | cached_args = args; |
| 1389 | Py_DECREF(obj); |
Serhiy Storchaka | a7a0ad6 | 2015-05-24 21:38:06 +0300 | [diff] [blame] | 1390 | } |
Serhiy Storchaka | 7822f15 | 2016-05-04 21:42:05 +0300 | [diff] [blame] | 1391 | else { |
| 1392 | assert(Py_REFCNT(args) >= 1); |
| 1393 | _PyObject_GC_TRACK(args); |
| 1394 | Py_DECREF(args); |
| 1395 | } |
Raymond Hettinger | c4e335b | 2015-04-30 08:08:13 -0700 | [diff] [blame] | 1396 | return ret; |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1397 | } |
| 1398 | |
| 1399 | static int |
Guido van Rossum | 8bce4ac | 2001-09-06 21:56:42 +0000 | [diff] [blame] | 1400 | property_descr_set(PyObject *self, PyObject *obj, PyObject *value) |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1401 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1402 | propertyobject *gs = (propertyobject *)self; |
| 1403 | PyObject *func, *res; |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1404 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1405 | if (value == NULL) |
| 1406 | func = gs->prop_del; |
| 1407 | else |
| 1408 | func = gs->prop_set; |
| 1409 | if (func == NULL) { |
| 1410 | PyErr_SetString(PyExc_AttributeError, |
| 1411 | value == NULL ? |
| 1412 | "can't delete attribute" : |
| 1413 | "can't set attribute"); |
| 1414 | return -1; |
| 1415 | } |
| 1416 | if (value == NULL) |
Benjamin Peterson | 9b955de | 2010-12-07 04:04:02 +0000 | [diff] [blame] | 1417 | res = PyObject_CallFunctionObjArgs(func, obj, NULL); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1418 | else |
Benjamin Peterson | 9b955de | 2010-12-07 04:04:02 +0000 | [diff] [blame] | 1419 | res = PyObject_CallFunctionObjArgs(func, obj, value, NULL); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1420 | if (res == NULL) |
| 1421 | return -1; |
| 1422 | Py_DECREF(res); |
| 1423 | return 0; |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1424 | } |
| 1425 | |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 1426 | static PyObject * |
Benjamin Peterson | 9396483 | 2010-06-28 03:07:10 +0000 | [diff] [blame] | 1427 | property_copy(PyObject *old, PyObject *get, PyObject *set, PyObject *del) |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 1428 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1429 | propertyobject *pold = (propertyobject *)old; |
Benjamin Peterson | 9396483 | 2010-06-28 03:07:10 +0000 | [diff] [blame] | 1430 | PyObject *new, *type, *doc; |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 1431 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1432 | type = PyObject_Type(old); |
| 1433 | if (type == NULL) |
| 1434 | return NULL; |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 1435 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1436 | if (get == NULL || get == Py_None) { |
| 1437 | Py_XDECREF(get); |
| 1438 | get = pold->prop_get ? pold->prop_get : Py_None; |
| 1439 | } |
| 1440 | if (set == NULL || set == Py_None) { |
| 1441 | Py_XDECREF(set); |
| 1442 | set = pold->prop_set ? pold->prop_set : Py_None; |
| 1443 | } |
| 1444 | if (del == NULL || del == Py_None) { |
| 1445 | Py_XDECREF(del); |
| 1446 | del = pold->prop_del ? pold->prop_del : Py_None; |
| 1447 | } |
Benjamin Peterson | 9396483 | 2010-06-28 03:07:10 +0000 | [diff] [blame] | 1448 | if (pold->getter_doc && get != Py_None) { |
| 1449 | /* make _init use __doc__ from getter */ |
| 1450 | doc = Py_None; |
| 1451 | } |
| 1452 | else { |
| 1453 | doc = pold->prop_doc ? pold->prop_doc : Py_None; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1454 | } |
R. David Murray | b18500d | 2009-05-04 22:59:07 +0000 | [diff] [blame] | 1455 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1456 | new = PyObject_CallFunction(type, "OOOO", get, set, del, doc); |
| 1457 | Py_DECREF(type); |
| 1458 | if (new == NULL) |
| 1459 | return NULL; |
| 1460 | return new; |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 1461 | } |
| 1462 | |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1463 | static int |
Guido van Rossum | 8bce4ac | 2001-09-06 21:56:42 +0000 | [diff] [blame] | 1464 | property_init(PyObject *self, PyObject *args, PyObject *kwds) |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1465 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1466 | PyObject *get = NULL, *set = NULL, *del = NULL, *doc = NULL; |
| 1467 | static char *kwlist[] = {"fget", "fset", "fdel", "doc", 0}; |
| 1468 | propertyobject *prop = (propertyobject *)self; |
Tim Peters | 66c1a52 | 2001-09-24 21:17:50 +0000 | [diff] [blame] | 1469 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1470 | if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OOOO:property", |
| 1471 | kwlist, &get, &set, &del, &doc)) |
| 1472 | return -1; |
Tim Peters | 66c1a52 | 2001-09-24 21:17:50 +0000 | [diff] [blame] | 1473 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1474 | if (get == Py_None) |
| 1475 | get = NULL; |
| 1476 | if (set == Py_None) |
| 1477 | set = NULL; |
| 1478 | if (del == Py_None) |
| 1479 | del = NULL; |
Tim Peters | 66c1a52 | 2001-09-24 21:17:50 +0000 | [diff] [blame] | 1480 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1481 | Py_XINCREF(get); |
| 1482 | Py_XINCREF(set); |
| 1483 | Py_XINCREF(del); |
| 1484 | Py_XINCREF(doc); |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 1485 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1486 | prop->prop_get = get; |
| 1487 | prop->prop_set = set; |
| 1488 | prop->prop_del = del; |
| 1489 | prop->prop_doc = doc; |
| 1490 | prop->getter_doc = 0; |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1491 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1492 | /* if no docstring given and the getter has one, use that one */ |
| 1493 | if ((doc == NULL || doc == Py_None) && get != NULL) { |
Martin v. Löwis | bd928fe | 2011-10-14 10:20:37 +0200 | [diff] [blame] | 1494 | _Py_IDENTIFIER(__doc__); |
Martin v. Löwis | 1ee1b6f | 2011-10-10 18:11:30 +0200 | [diff] [blame] | 1495 | PyObject *get_doc = _PyObject_GetAttrId(get, &PyId___doc__); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1496 | if (get_doc) { |
| 1497 | if (Py_TYPE(self) == &PyProperty_Type) { |
Serhiy Storchaka | 4884271 | 2016-04-06 09:45:48 +0300 | [diff] [blame] | 1498 | Py_XSETREF(prop->prop_doc, get_doc); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1499 | } |
| 1500 | else { |
| 1501 | /* If this is a property subclass, put __doc__ |
| 1502 | in dict of the subclass instance instead, |
| 1503 | otherwise it gets shadowed by __doc__ in the |
| 1504 | class's dict. */ |
Martin v. Löwis | 1c67dd9 | 2011-10-14 15:16:45 +0200 | [diff] [blame] | 1505 | int err = _PyObject_SetAttrId(self, &PyId___doc__, get_doc); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1506 | Py_DECREF(get_doc); |
| 1507 | if (err < 0) |
| 1508 | return -1; |
| 1509 | } |
| 1510 | prop->getter_doc = 1; |
| 1511 | } |
| 1512 | else if (PyErr_ExceptionMatches(PyExc_Exception)) { |
| 1513 | PyErr_Clear(); |
| 1514 | } |
| 1515 | else { |
| 1516 | return -1; |
| 1517 | } |
| 1518 | } |
| 1519 | |
| 1520 | return 0; |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1521 | } |
| 1522 | |
Benjamin Peterson | bfebb7b | 2011-12-15 15:34:02 -0500 | [diff] [blame] | 1523 | static PyObject * |
| 1524 | property_get___isabstractmethod__(propertyobject *prop, void *closure) |
| 1525 | { |
| 1526 | int res = _PyObject_IsAbstract(prop->prop_get); |
| 1527 | if (res == -1) { |
| 1528 | return NULL; |
| 1529 | } |
| 1530 | else if (res) { |
| 1531 | Py_RETURN_TRUE; |
| 1532 | } |
| 1533 | |
| 1534 | res = _PyObject_IsAbstract(prop->prop_set); |
| 1535 | if (res == -1) { |
| 1536 | return NULL; |
| 1537 | } |
| 1538 | else if (res) { |
| 1539 | Py_RETURN_TRUE; |
| 1540 | } |
| 1541 | |
| 1542 | res = _PyObject_IsAbstract(prop->prop_del); |
| 1543 | if (res == -1) { |
| 1544 | return NULL; |
| 1545 | } |
| 1546 | else if (res) { |
| 1547 | Py_RETURN_TRUE; |
| 1548 | } |
| 1549 | Py_RETURN_FALSE; |
| 1550 | } |
| 1551 | |
| 1552 | static PyGetSetDef property_getsetlist[] = { |
| 1553 | {"__isabstractmethod__", |
| 1554 | (getter)property_get___isabstractmethod__, NULL, |
| 1555 | NULL, |
| 1556 | NULL}, |
| 1557 | {NULL} /* Sentinel */ |
| 1558 | }; |
| 1559 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1560 | PyDoc_STRVAR(property_doc, |
Tim Peters | 66c1a52 | 2001-09-24 21:17:50 +0000 | [diff] [blame] | 1561 | "property(fget=None, fset=None, fdel=None, doc=None) -> property attribute\n" |
| 1562 | "\n" |
| 1563 | "fget is a function to be used for getting an attribute value, and likewise\n" |
| 1564 | "fset is a function for setting, and fdel a function for del'ing, an\n" |
Raymond Hettinger | 97fc2ba | 2013-11-24 14:53:29 -0800 | [diff] [blame] | 1565 | "attribute. Typical use is to define a managed attribute x:\n\n" |
Guido van Rossum | 91c0d8a | 2001-08-24 09:55:51 +0000 | [diff] [blame] | 1566 | "class C(object):\n" |
Christian Heimes | 96f3163 | 2007-11-12 01:32:03 +0000 | [diff] [blame] | 1567 | " def getx(self): return self._x\n" |
| 1568 | " def setx(self, value): self._x = value\n" |
| 1569 | " def delx(self): del self._x\n" |
| 1570 | " x = property(getx, setx, delx, \"I'm the 'x' property.\")\n" |
| 1571 | "\n" |
Raymond Hettinger | 97fc2ba | 2013-11-24 14:53:29 -0800 | [diff] [blame] | 1572 | "Decorators make defining new properties or modifying existing ones easy:\n\n" |
Christian Heimes | 96f3163 | 2007-11-12 01:32:03 +0000 | [diff] [blame] | 1573 | "class C(object):\n" |
| 1574 | " @property\n" |
Raymond Hettinger | 97fc2ba | 2013-11-24 14:53:29 -0800 | [diff] [blame] | 1575 | " def x(self):\n" |
Gregory P. Smith | 0e52404 | 2013-11-25 00:30:56 -0800 | [diff] [blame] | 1576 | " \"I am the 'x' property.\"\n" |
Raymond Hettinger | 97fc2ba | 2013-11-24 14:53:29 -0800 | [diff] [blame] | 1577 | " return self._x\n" |
Christian Heimes | 96f3163 | 2007-11-12 01:32:03 +0000 | [diff] [blame] | 1578 | " @x.setter\n" |
Raymond Hettinger | 97fc2ba | 2013-11-24 14:53:29 -0800 | [diff] [blame] | 1579 | " def x(self, value):\n" |
| 1580 | " self._x = value\n" |
Christian Heimes | 96f3163 | 2007-11-12 01:32:03 +0000 | [diff] [blame] | 1581 | " @x.deleter\n" |
Raymond Hettinger | 97fc2ba | 2013-11-24 14:53:29 -0800 | [diff] [blame] | 1582 | " def x(self):\n" |
| 1583 | " del self._x\n" |
Christian Heimes | 96f3163 | 2007-11-12 01:32:03 +0000 | [diff] [blame] | 1584 | ); |
Guido van Rossum | 91c0d8a | 2001-08-24 09:55:51 +0000 | [diff] [blame] | 1585 | |
Guido van Rossum | 048eb75 | 2001-10-02 21:24:57 +0000 | [diff] [blame] | 1586 | static int |
| 1587 | property_traverse(PyObject *self, visitproc visit, void *arg) |
| 1588 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1589 | propertyobject *pp = (propertyobject *)self; |
| 1590 | Py_VISIT(pp->prop_get); |
| 1591 | Py_VISIT(pp->prop_set); |
| 1592 | Py_VISIT(pp->prop_del); |
| 1593 | Py_VISIT(pp->prop_doc); |
| 1594 | return 0; |
Guido van Rossum | 048eb75 | 2001-10-02 21:24:57 +0000 | [diff] [blame] | 1595 | } |
| 1596 | |
Raymond Hettinger | d4be691 | 2015-05-13 11:12:33 -0700 | [diff] [blame] | 1597 | static int |
| 1598 | property_clear(PyObject *self) |
| 1599 | { |
| 1600 | propertyobject *pp = (propertyobject *)self; |
| 1601 | Py_CLEAR(pp->prop_doc); |
| 1602 | return 0; |
| 1603 | } |
| 1604 | |
Guido van Rossum | 8bce4ac | 2001-09-06 21:56:42 +0000 | [diff] [blame] | 1605 | PyTypeObject PyProperty_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1606 | PyVarObject_HEAD_INIT(&PyType_Type, 0) |
| 1607 | "property", /* tp_name */ |
| 1608 | sizeof(propertyobject), /* tp_basicsize */ |
| 1609 | 0, /* tp_itemsize */ |
| 1610 | /* methods */ |
| 1611 | property_dealloc, /* tp_dealloc */ |
| 1612 | 0, /* tp_print */ |
| 1613 | 0, /* tp_getattr */ |
| 1614 | 0, /* tp_setattr */ |
| 1615 | 0, /* tp_reserved */ |
| 1616 | 0, /* tp_repr */ |
| 1617 | 0, /* tp_as_number */ |
| 1618 | 0, /* tp_as_sequence */ |
| 1619 | 0, /* tp_as_mapping */ |
| 1620 | 0, /* tp_hash */ |
| 1621 | 0, /* tp_call */ |
| 1622 | 0, /* tp_str */ |
| 1623 | PyObject_GenericGetAttr, /* tp_getattro */ |
| 1624 | 0, /* tp_setattro */ |
| 1625 | 0, /* tp_as_buffer */ |
| 1626 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC | |
| 1627 | Py_TPFLAGS_BASETYPE, /* tp_flags */ |
| 1628 | property_doc, /* tp_doc */ |
| 1629 | property_traverse, /* tp_traverse */ |
Raymond Hettinger | d4be691 | 2015-05-13 11:12:33 -0700 | [diff] [blame] | 1630 | (inquiry)property_clear, /* tp_clear */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1631 | 0, /* tp_richcompare */ |
| 1632 | 0, /* tp_weaklistoffset */ |
| 1633 | 0, /* tp_iter */ |
| 1634 | 0, /* tp_iternext */ |
| 1635 | property_methods, /* tp_methods */ |
| 1636 | property_members, /* tp_members */ |
Benjamin Peterson | bfebb7b | 2011-12-15 15:34:02 -0500 | [diff] [blame] | 1637 | property_getsetlist, /* tp_getset */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1638 | 0, /* tp_base */ |
| 1639 | 0, /* tp_dict */ |
| 1640 | property_descr_get, /* tp_descr_get */ |
| 1641 | property_descr_set, /* tp_descr_set */ |
| 1642 | 0, /* tp_dictoffset */ |
| 1643 | property_init, /* tp_init */ |
| 1644 | PyType_GenericAlloc, /* tp_alloc */ |
| 1645 | PyType_GenericNew, /* tp_new */ |
| 1646 | PyObject_GC_Del, /* tp_free */ |
Guido van Rossum | 29a62dd | 2001-08-23 21:40:38 +0000 | [diff] [blame] | 1647 | }; |