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