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