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