blob: 1d525daf98f6c9eff533c215cbeeb9642d02e2c3 [file] [log] [blame]
Tim Peters6d6c1a32001-08-02 04:15:00 +00001/* 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 Peters6d6c1a32001-08-02 04:15:00 +00006static void
7descr_dealloc(PyDescrObject *descr)
8{
Guido van Rossum048eb752001-10-02 21:24:57 +00009 _PyObject_GC_UNTRACK(descr);
Tim Peters6d6c1a32001-08-02 04:15:00 +000010 Py_XDECREF(descr->d_type);
11 Py_XDECREF(descr->d_name);
Guido van Rossum048eb752001-10-02 21:24:57 +000012 PyObject_GC_Del(descr);
Tim Peters6d6c1a32001-08-02 04:15:00 +000013}
14
15static char *
16descr_name(PyDescrObject *descr)
17{
18 if (descr->d_name != NULL && PyString_Check(descr->d_name))
19 return PyString_AS_STRING(descr->d_name);
20 else
21 return "?";
22}
23
24static PyObject *
25descr_repr(PyDescrObject *descr, char *format)
26{
Barry Warsaw7ce36942001-08-24 18:34:26 +000027 return PyString_FromFormat(format, descr_name(descr),
28 descr->d_type->tp_name);
Tim Peters6d6c1a32001-08-02 04:15:00 +000029}
30
31static PyObject *
32method_repr(PyMethodDescrObject *descr)
33{
34 return descr_repr((PyDescrObject *)descr,
Barry Warsaw7ce36942001-08-24 18:34:26 +000035 "<method '%s' of '%s' objects>");
Tim Peters6d6c1a32001-08-02 04:15:00 +000036}
37
38static PyObject *
39member_repr(PyMemberDescrObject *descr)
40{
41 return descr_repr((PyDescrObject *)descr,
Barry Warsaw7ce36942001-08-24 18:34:26 +000042 "<member '%s' of '%s' objects>");
Tim Peters6d6c1a32001-08-02 04:15:00 +000043}
44
45static PyObject *
46getset_repr(PyGetSetDescrObject *descr)
47{
48 return descr_repr((PyDescrObject *)descr,
Barry Warsaw7ce36942001-08-24 18:34:26 +000049 "<attribute '%s' of '%s' objects>");
Tim Peters6d6c1a32001-08-02 04:15:00 +000050}
51
52static PyObject *
53wrapper_repr(PyWrapperDescrObject *descr)
54{
55 return descr_repr((PyDescrObject *)descr,
Barry Warsaw7ce36942001-08-24 18:34:26 +000056 "<slot wrapper '%s' of '%s' objects>");
Tim Peters6d6c1a32001-08-02 04:15:00 +000057}
58
59static int
60descr_check(PyDescrObject *descr, PyObject *obj, PyTypeObject *type,
Guido van Rossum8098ddb2001-08-16 08:27:33 +000061 PyObject **pres)
Tim Peters6d6c1a32001-08-02 04:15:00 +000062{
Guido van Rossum8098ddb2001-08-16 08:27:33 +000063 if (obj == NULL || (obj == Py_None && type != Py_None->ob_type)) {
Tim Peters6d6c1a32001-08-02 04:15:00 +000064 Py_INCREF(descr);
65 *pres = (PyObject *)descr;
66 return 1;
67 }
68 if (!PyObject_IsInstance(obj, (PyObject *)(descr->d_type))) {
69 PyErr_Format(PyExc_TypeError,
Barry Warsaw7ce36942001-08-24 18:34:26 +000070 "descriptor '%s' for '%s' objects "
71 "doesn't apply to '%s' object",
Tim Peters6d6c1a32001-08-02 04:15:00 +000072 descr_name((PyDescrObject *)descr),
73 descr->d_type->tp_name,
74 obj->ob_type->tp_name);
75 *pres = NULL;
76 return 1;
77 }
78 return 0;
79}
80
81static PyObject *
82method_get(PyMethodDescrObject *descr, PyObject *obj, PyTypeObject *type)
83{
84 PyObject *res;
85
86 if (descr_check((PyDescrObject *)descr, obj, type, &res))
87 return res;
88 return PyCFunction_New(descr->d_method, obj);
89}
90
91static PyObject *
92member_get(PyMemberDescrObject *descr, PyObject *obj, PyTypeObject *type)
93{
94 PyObject *res;
95
96 if (descr_check((PyDescrObject *)descr, obj, type, &res))
97 return res;
Guido van Rossum6f799372001-09-20 20:46:19 +000098 return PyMember_GetOne((char *)obj, descr->d_member);
Tim Peters6d6c1a32001-08-02 04:15:00 +000099}
100
101static PyObject *
102getset_get(PyGetSetDescrObject *descr, PyObject *obj, PyTypeObject *type)
103{
104 PyObject *res;
105
106 if (descr_check((PyDescrObject *)descr, obj, type, &res))
107 return res;
108 if (descr->d_getset->get != NULL)
109 return descr->d_getset->get(obj, descr->d_getset->closure);
110 PyErr_Format(PyExc_TypeError,
111 "attribute '%300s' of '%.100s' objects is not readable",
112 descr_name((PyDescrObject *)descr),
113 descr->d_type->tp_name);
114 return NULL;
115}
116
117static PyObject *
118wrapper_get(PyWrapperDescrObject *descr, PyObject *obj, PyTypeObject *type)
119{
120 PyObject *res;
121
122 if (descr_check((PyDescrObject *)descr, obj, type, &res))
123 return res;
124 return PyWrapper_New((PyObject *)descr, obj);
125}
126
127static int
128descr_setcheck(PyDescrObject *descr, PyObject *obj, PyObject *value,
129 int *pres)
130{
131 assert(obj != NULL);
132 if (!PyObject_IsInstance(obj, (PyObject *)(descr->d_type))) {
133 PyErr_Format(PyExc_TypeError,
134 "descriptor '%.200s' for '%.100s' objects "
135 "doesn't apply to '%.100s' object",
136 descr_name(descr),
137 descr->d_type->tp_name,
138 obj->ob_type->tp_name);
139 *pres = -1;
140 return 1;
141 }
142 return 0;
143}
144
145static int
146member_set(PyMemberDescrObject *descr, PyObject *obj, PyObject *value)
147{
148 int res;
149
150 if (descr_setcheck((PyDescrObject *)descr, obj, value, &res))
151 return res;
Guido van Rossum6f799372001-09-20 20:46:19 +0000152 return PyMember_SetOne((char *)obj, descr->d_member, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000153}
154
155static int
156getset_set(PyGetSetDescrObject *descr, PyObject *obj, PyObject *value)
157{
158 int res;
159
160 if (descr_setcheck((PyDescrObject *)descr, obj, value, &res))
161 return res;
162 if (descr->d_getset->set != NULL)
163 return descr->d_getset->set(obj, value,
164 descr->d_getset->closure);
165 PyErr_Format(PyExc_TypeError,
166 "attribute '%300s' of '%.100s' objects is not writable",
167 descr_name((PyDescrObject *)descr),
168 descr->d_type->tp_name);
169 return -1;
170}
171
172static PyObject *
173methoddescr_call(PyMethodDescrObject *descr, PyObject *args, PyObject *kwds)
174{
175 int argc;
176 PyObject *self, *func, *result;
177
178 /* Make sure that the first argument is acceptable as 'self' */
179 assert(PyTuple_Check(args));
180 argc = PyTuple_GET_SIZE(args);
181 if (argc < 1) {
182 PyErr_Format(PyExc_TypeError,
183 "descriptor '%.300s' of '%.100s' "
184 "object needs an argument",
185 descr_name((PyDescrObject *)descr),
186 descr->d_type->tp_name);
187 return NULL;
188 }
189 self = PyTuple_GET_ITEM(args, 0);
190 if (!PyObject_IsInstance(self, (PyObject *)(descr->d_type))) {
191 PyErr_Format(PyExc_TypeError,
192 "descriptor '%.200s' "
193 "requires a '%.100s' object "
194 "but received a '%.100s'",
195 descr_name((PyDescrObject *)descr),
196 descr->d_type->tp_name,
197 self->ob_type->tp_name);
198 return NULL;
199 }
200
201 func = PyCFunction_New(descr->d_method, self);
202 if (func == NULL)
203 return NULL;
204 args = PyTuple_GetSlice(args, 1, argc);
205 if (args == NULL) {
206 Py_DECREF(func);
207 return NULL;
208 }
209 result = PyEval_CallObjectWithKeywords(func, args, kwds);
210 Py_DECREF(args);
211 Py_DECREF(func);
212 return result;
213}
214
215static PyObject *
216wrapperdescr_call(PyWrapperDescrObject *descr, PyObject *args, PyObject *kwds)
217{
218 int argc;
219 PyObject *self, *func, *result;
220
221 /* Make sure that the first argument is acceptable as 'self' */
222 assert(PyTuple_Check(args));
223 argc = PyTuple_GET_SIZE(args);
224 if (argc < 1) {
225 PyErr_Format(PyExc_TypeError,
226 "descriptor '%.300s' of '%.100s' "
227 "object needs an argument",
228 descr_name((PyDescrObject *)descr),
229 descr->d_type->tp_name);
230 return NULL;
231 }
232 self = PyTuple_GET_ITEM(args, 0);
233 if (!PyObject_IsInstance(self, (PyObject *)(descr->d_type))) {
234 PyErr_Format(PyExc_TypeError,
235 "descriptor '%.200s' "
236 "requires a '%.100s' object "
237 "but received a '%.100s'",
238 descr_name((PyDescrObject *)descr),
239 descr->d_type->tp_name,
240 self->ob_type->tp_name);
241 return NULL;
242 }
243
244 func = PyWrapper_New((PyObject *)descr, self);
245 if (func == NULL)
246 return NULL;
247 args = PyTuple_GetSlice(args, 1, argc);
248 if (args == NULL) {
249 Py_DECREF(func);
250 return NULL;
251 }
252 result = PyEval_CallObjectWithKeywords(func, args, kwds);
253 Py_DECREF(args);
254 Py_DECREF(func);
255 return result;
256}
257
258static PyObject *
Guido van Rossum6f799372001-09-20 20:46:19 +0000259method_get_doc(PyMethodDescrObject *descr, void *closure)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000260{
261 if (descr->d_method->ml_doc == NULL) {
262 Py_INCREF(Py_None);
263 return Py_None;
264 }
265 return PyString_FromString(descr->d_method->ml_doc);
266}
267
Guido van Rossum6f799372001-09-20 20:46:19 +0000268static PyMemberDef descr_members[] = {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000269 {"__objclass__", T_OBJECT, offsetof(PyDescrObject, d_type), READONLY},
270 {"__name__", T_OBJECT, offsetof(PyDescrObject, d_name), READONLY},
271 {0}
272};
273
Guido van Rossum32d34c82001-09-20 21:45:26 +0000274static PyGetSetDef method_getset[] = {
Guido van Rossum6f799372001-09-20 20:46:19 +0000275 {"__doc__", (getter)method_get_doc},
276 {0}
277};
278
279static PyObject *
280member_get_doc(PyMemberDescrObject *descr, void *closure)
281{
282 if (descr->d_member->doc == NULL) {
283 Py_INCREF(Py_None);
284 return Py_None;
285 }
286 return PyString_FromString(descr->d_member->doc);
287}
288
Guido van Rossum32d34c82001-09-20 21:45:26 +0000289static PyGetSetDef member_getset[] = {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000290 {"__doc__", (getter)member_get_doc},
291 {0}
292};
293
294static PyObject *
Guido van Rossum32d34c82001-09-20 21:45:26 +0000295getset_get_doc(PyGetSetDescrObject *descr, void *closure)
296{
297 if (descr->d_getset->doc == NULL) {
298 Py_INCREF(Py_None);
299 return Py_None;
300 }
301 return PyString_FromString(descr->d_getset->doc);
302}
303
304static PyGetSetDef getset_getset[] = {
305 {"__doc__", (getter)getset_get_doc},
306 {0}
307};
308
309static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000310wrapper_get_doc(PyWrapperDescrObject *descr, void *closure)
311{
312 if (descr->d_base->doc == NULL) {
313 Py_INCREF(Py_None);
314 return Py_None;
315 }
316 return PyString_FromString(descr->d_base->doc);
317}
318
Guido van Rossum32d34c82001-09-20 21:45:26 +0000319static PyGetSetDef wrapper_getset[] = {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000320 {"__doc__", (getter)wrapper_get_doc},
321 {0}
322};
323
Guido van Rossum048eb752001-10-02 21:24:57 +0000324static int
325descr_traverse(PyObject *self, visitproc visit, void *arg)
326{
327 PyDescrObject *descr = (PyDescrObject *)self;
328 int err;
329
330 if (descr->d_type) {
331 err = visit((PyObject *)(descr->d_type), arg);
332 if (err)
333 return err;
334 }
335 return 0;
336}
337
Tim Peters6d6c1a32001-08-02 04:15:00 +0000338static PyTypeObject PyMethodDescr_Type = {
339 PyObject_HEAD_INIT(&PyType_Type)
340 0,
341 "method_descriptor",
342 sizeof(PyMethodDescrObject),
343 0,
344 (destructor)descr_dealloc, /* tp_dealloc */
345 0, /* tp_print */
346 0, /* tp_getattr */
347 0, /* tp_setattr */
348 0, /* tp_compare */
349 (reprfunc)method_repr, /* tp_repr */
350 0, /* tp_as_number */
351 0, /* tp_as_sequence */
352 0, /* tp_as_mapping */
353 0, /* tp_hash */
354 (ternaryfunc)methoddescr_call, /* tp_call */
355 0, /* tp_str */
356 PyObject_GenericGetAttr, /* tp_getattro */
357 0, /* tp_setattro */
358 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +0000359 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000360 0, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +0000361 descr_traverse, /* tp_traverse */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000362 0, /* tp_clear */
363 0, /* tp_richcompare */
364 0, /* tp_weaklistoffset */
365 0, /* tp_iter */
366 0, /* tp_iternext */
367 0, /* tp_methods */
368 descr_members, /* tp_members */
Guido van Rossum6f799372001-09-20 20:46:19 +0000369 method_getset, /* tp_getset */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000370 0, /* tp_base */
371 0, /* tp_dict */
372 (descrgetfunc)method_get, /* tp_descr_get */
373 0, /* tp_descr_set */
374};
375
376static PyTypeObject PyMemberDescr_Type = {
377 PyObject_HEAD_INIT(&PyType_Type)
378 0,
379 "member_descriptor",
380 sizeof(PyMemberDescrObject),
381 0,
382 (destructor)descr_dealloc, /* tp_dealloc */
383 0, /* tp_print */
384 0, /* tp_getattr */
385 0, /* tp_setattr */
386 0, /* tp_compare */
387 (reprfunc)member_repr, /* tp_repr */
388 0, /* tp_as_number */
389 0, /* tp_as_sequence */
390 0, /* tp_as_mapping */
391 0, /* tp_hash */
392 (ternaryfunc)0, /* tp_call */
393 0, /* tp_str */
394 PyObject_GenericGetAttr, /* tp_getattro */
395 0, /* tp_setattro */
396 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +0000397 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000398 0, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +0000399 descr_traverse, /* tp_traverse */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000400 0, /* tp_clear */
401 0, /* tp_richcompare */
402 0, /* tp_weaklistoffset */
403 0, /* tp_iter */
404 0, /* tp_iternext */
405 0, /* tp_methods */
406 descr_members, /* tp_members */
Guido van Rossum6f799372001-09-20 20:46:19 +0000407 member_getset, /* tp_getset */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000408 0, /* tp_base */
409 0, /* tp_dict */
410 (descrgetfunc)member_get, /* tp_descr_get */
411 (descrsetfunc)member_set, /* tp_descr_set */
412};
413
414static PyTypeObject PyGetSetDescr_Type = {
415 PyObject_HEAD_INIT(&PyType_Type)
416 0,
417 "getset_descriptor",
418 sizeof(PyGetSetDescrObject),
419 0,
420 (destructor)descr_dealloc, /* tp_dealloc */
421 0, /* tp_print */
422 0, /* tp_getattr */
423 0, /* tp_setattr */
424 0, /* tp_compare */
425 (reprfunc)getset_repr, /* tp_repr */
426 0, /* tp_as_number */
427 0, /* tp_as_sequence */
428 0, /* tp_as_mapping */
429 0, /* tp_hash */
430 (ternaryfunc)0, /* tp_call */
431 0, /* tp_str */
432 PyObject_GenericGetAttr, /* tp_getattro */
433 0, /* tp_setattro */
434 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +0000435 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000436 0, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +0000437 descr_traverse, /* tp_traverse */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000438 0, /* tp_clear */
439 0, /* tp_richcompare */
440 0, /* tp_weaklistoffset */
441 0, /* tp_iter */
442 0, /* tp_iternext */
443 0, /* tp_methods */
444 descr_members, /* tp_members */
Guido van Rossum32d34c82001-09-20 21:45:26 +0000445 getset_getset, /* tp_getset */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000446 0, /* tp_base */
447 0, /* tp_dict */
448 (descrgetfunc)getset_get, /* tp_descr_get */
449 (descrsetfunc)getset_set, /* tp_descr_set */
450};
451
Guido van Rossumf4593e02001-10-03 12:09:30 +0000452PyTypeObject PyWrapperDescr_Type = {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000453 PyObject_HEAD_INIT(&PyType_Type)
454 0,
455 "wrapper_descriptor",
456 sizeof(PyWrapperDescrObject),
457 0,
458 (destructor)descr_dealloc, /* tp_dealloc */
459 0, /* tp_print */
460 0, /* tp_getattr */
461 0, /* tp_setattr */
462 0, /* tp_compare */
463 (reprfunc)wrapper_repr, /* tp_repr */
464 0, /* tp_as_number */
465 0, /* tp_as_sequence */
466 0, /* tp_as_mapping */
467 0, /* tp_hash */
468 (ternaryfunc)wrapperdescr_call, /* tp_call */
469 0, /* tp_str */
470 PyObject_GenericGetAttr, /* tp_getattro */
471 0, /* tp_setattro */
472 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +0000473 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000474 0, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +0000475 descr_traverse, /* tp_traverse */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000476 0, /* tp_clear */
477 0, /* tp_richcompare */
478 0, /* tp_weaklistoffset */
479 0, /* tp_iter */
480 0, /* tp_iternext */
481 0, /* tp_methods */
482 descr_members, /* tp_members */
483 wrapper_getset, /* tp_getset */
484 0, /* tp_base */
485 0, /* tp_dict */
486 (descrgetfunc)wrapper_get, /* tp_descr_get */
487 0, /* tp_descr_set */
488};
489
490static PyDescrObject *
491descr_new(PyTypeObject *descrtype, PyTypeObject *type, char *name)
492{
493 PyDescrObject *descr;
494
495 descr = (PyDescrObject *)PyType_GenericAlloc(descrtype, 0);
496 if (descr != NULL) {
497 Py_XINCREF(type);
498 descr->d_type = type;
499 descr->d_name = PyString_InternFromString(name);
500 if (descr->d_name == NULL) {
501 Py_DECREF(descr);
502 descr = NULL;
503 }
504 }
505 return descr;
506}
507
508PyObject *
509PyDescr_NewMethod(PyTypeObject *type, PyMethodDef *method)
510{
511 PyMethodDescrObject *descr;
512
513 descr = (PyMethodDescrObject *)descr_new(&PyMethodDescr_Type,
514 type, method->ml_name);
515 if (descr != NULL)
516 descr->d_method = method;
517 return (PyObject *)descr;
518}
519
520PyObject *
Guido van Rossum6f799372001-09-20 20:46:19 +0000521PyDescr_NewMember(PyTypeObject *type, PyMemberDef *member)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000522{
523 PyMemberDescrObject *descr;
524
525 descr = (PyMemberDescrObject *)descr_new(&PyMemberDescr_Type,
526 type, member->name);
527 if (descr != NULL)
528 descr->d_member = member;
529 return (PyObject *)descr;
530}
531
532PyObject *
Guido van Rossum32d34c82001-09-20 21:45:26 +0000533PyDescr_NewGetSet(PyTypeObject *type, PyGetSetDef *getset)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000534{
535 PyGetSetDescrObject *descr;
536
537 descr = (PyGetSetDescrObject *)descr_new(&PyGetSetDescr_Type,
538 type, getset->name);
539 if (descr != NULL)
540 descr->d_getset = getset;
541 return (PyObject *)descr;
542}
543
544PyObject *
545PyDescr_NewWrapper(PyTypeObject *type, struct wrapperbase *base, void *wrapped)
546{
547 PyWrapperDescrObject *descr;
548
549 descr = (PyWrapperDescrObject *)descr_new(&PyWrapperDescr_Type,
550 type, base->name);
551 if (descr != NULL) {
552 descr->d_base = base;
553 descr->d_wrapped = wrapped;
554 }
555 return (PyObject *)descr;
556}
557
558int
559PyDescr_IsData(PyObject *d)
560{
561 return d->ob_type->tp_descr_set != NULL;
562}
563
564
565/* --- Readonly proxy for dictionaries (actually any mapping) --- */
566
567/* This has no reason to be in this file except that adding new files is a
568 bit of a pain */
569
570typedef struct {
571 PyObject_HEAD
572 PyObject *dict;
573} proxyobject;
574
575static int
576proxy_len(proxyobject *pp)
577{
578 return PyObject_Size(pp->dict);
579}
580
581static PyObject *
582proxy_getitem(proxyobject *pp, PyObject *key)
583{
584 return PyObject_GetItem(pp->dict, key);
585}
586
587static PyMappingMethods proxy_as_mapping = {
588 (inquiry)proxy_len, /* mp_length */
589 (binaryfunc)proxy_getitem, /* mp_subscript */
590 0, /* mp_ass_subscript */
591};
592
593static int
594proxy_contains(proxyobject *pp, PyObject *key)
595{
596 return PySequence_Contains(pp->dict, key);
597}
598
599static PySequenceMethods proxy_as_sequence = {
600 0, /* sq_length */
601 0, /* sq_concat */
602 0, /* sq_repeat */
603 0, /* sq_item */
604 0, /* sq_slice */
605 0, /* sq_ass_item */
606 0, /* sq_ass_slice */
607 (objobjproc)proxy_contains, /* sq_contains */
608 0, /* sq_inplace_concat */
609 0, /* sq_inplace_repeat */
610};
611
612static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000613proxy_has_key(proxyobject *pp, PyObject *key)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000614{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000615 return PyInt_FromLong(PySequence_Contains(pp->dict, key));
616}
617
618static PyObject *
619proxy_get(proxyobject *pp, PyObject *args)
620{
621 PyObject *key, *def = Py_None;
622
623 if (!PyArg_ParseTuple(args, "O|O:get", &key, &def))
624 return NULL;
625 return PyObject_CallMethod(pp->dict, "get", "(OO)", key, def);
626}
627
628static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000629proxy_keys(proxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000630{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000631 return PyMapping_Keys(pp->dict);
632}
633
634static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000635proxy_values(proxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000636{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000637 return PyMapping_Values(pp->dict);
638}
639
640static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000641proxy_items(proxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000642{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000643 return PyMapping_Items(pp->dict);
644}
645
646static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000647proxy_copy(proxyobject *pp)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000648{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000649 return PyObject_CallMethod(pp->dict, "copy", NULL);
650}
651
652static PyMethodDef proxy_methods[] = {
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000653 {"has_key", (PyCFunction)proxy_has_key, METH_O, "XXX"},
Tim Peters6d6c1a32001-08-02 04:15:00 +0000654 {"get", (PyCFunction)proxy_get, METH_VARARGS, "XXX"},
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000655 {"keys", (PyCFunction)proxy_keys, METH_NOARGS, "XXX"},
656 {"values", (PyCFunction)proxy_values, METH_NOARGS, "XXX"},
657 {"items", (PyCFunction)proxy_items, METH_NOARGS, "XXX"},
658 {"copy", (PyCFunction)proxy_copy, METH_NOARGS, "XXX"},
Tim Peters6d6c1a32001-08-02 04:15:00 +0000659 {0}
660};
661
662static void
663proxy_dealloc(proxyobject *pp)
664{
Guido van Rossum048eb752001-10-02 21:24:57 +0000665 _PyObject_GC_UNTRACK(pp);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000666 Py_DECREF(pp->dict);
Guido van Rossum048eb752001-10-02 21:24:57 +0000667 PyObject_GC_Del(pp);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000668}
669
670static PyObject *
671proxy_getiter(proxyobject *pp)
672{
673 return PyObject_GetIter(pp->dict);
674}
675
676PyObject *
677proxy_str(proxyobject *pp)
678{
679 return PyObject_Str(pp->dict);
680}
681
Guido van Rossum048eb752001-10-02 21:24:57 +0000682static int
683proxy_traverse(PyObject *self, visitproc visit, void *arg)
684{
685 proxyobject *pp = (proxyobject *)self;
686 int err;
687
688 if (pp->dict) {
689 err = visit(pp->dict, arg);
690 if (err)
691 return err;
692 }
693 return 0;
694}
695
Tim Peters6d6c1a32001-08-02 04:15:00 +0000696PyTypeObject proxytype = {
697 PyObject_HEAD_INIT(&PyType_Type)
698 0, /* ob_size */
699 "dict-proxy", /* tp_name */
700 sizeof(proxyobject), /* tp_basicsize */
701 0, /* tp_itemsize */
702 /* methods */
703 (destructor)proxy_dealloc, /* tp_dealloc */
704 0, /* tp_print */
705 0, /* tp_getattr */
706 0, /* tp_setattr */
707 0, /* tp_compare */
708 0, /* tp_repr */
709 0, /* tp_as_number */
710 &proxy_as_sequence, /* tp_as_sequence */
711 &proxy_as_mapping, /* tp_as_mapping */
712 0, /* tp_hash */
713 0, /* tp_call */
714 (reprfunc)proxy_str, /* tp_str */
715 PyObject_GenericGetAttr, /* tp_getattro */
716 0, /* tp_setattro */
717 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +0000718 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000719 0, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +0000720 proxy_traverse, /* tp_traverse */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000721 0, /* tp_clear */
722 0, /* tp_richcompare */
723 0, /* tp_weaklistoffset */
724 (getiterfunc)proxy_getiter, /* tp_iter */
725 0, /* tp_iternext */
726 proxy_methods, /* tp_methods */
727 0, /* tp_members */
728 0, /* tp_getset */
729 0, /* tp_base */
730 0, /* tp_dict */
731 0, /* tp_descr_get */
732 0, /* tp_descr_set */
733};
734
735PyObject *
736PyDictProxy_New(PyObject *dict)
737{
738 proxyobject *pp;
739
Guido van Rossum048eb752001-10-02 21:24:57 +0000740 pp = PyObject_GC_New(proxyobject, &proxytype);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000741 if (pp != NULL) {
742 Py_INCREF(dict);
743 pp->dict = dict;
Guido van Rossum048eb752001-10-02 21:24:57 +0000744 _PyObject_GC_TRACK(pp);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000745 }
746 return (PyObject *)pp;
747}
748
749
750/* --- Wrapper object for "slot" methods --- */
751
752/* This has no reason to be in this file except that adding new files is a
753 bit of a pain */
754
755typedef struct {
756 PyObject_HEAD
757 PyWrapperDescrObject *descr;
758 PyObject *self;
759} wrapperobject;
760
761static void
762wrapper_dealloc(wrapperobject *wp)
763{
Guido van Rossum048eb752001-10-02 21:24:57 +0000764 _PyObject_GC_UNTRACK(wp);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000765 Py_XDECREF(wp->descr);
766 Py_XDECREF(wp->self);
Guido van Rossum048eb752001-10-02 21:24:57 +0000767 PyObject_GC_Del(wp);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000768}
769
770static PyMethodDef wrapper_methods[] = {
771 {0}
772};
773
774static PyObject *
775wrapper_name(wrapperobject *wp)
776{
777 char *s = wp->descr->d_base->name;
778
779 return PyString_FromString(s);
780}
781
782static PyObject *
783wrapper_doc(wrapperobject *wp)
784{
785 char *s = wp->descr->d_base->doc;
786
787 if (s == NULL) {
788 Py_INCREF(Py_None);
789 return Py_None;
790 }
791 else {
792 return PyString_FromString(s);
793 }
794}
795
Guido van Rossum32d34c82001-09-20 21:45:26 +0000796static PyGetSetDef wrapper_getsets[] = {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000797 {"__name__", (getter)wrapper_name},
798 {"__doc__", (getter)wrapper_doc},
799 {0}
800};
801
802static PyObject *
803wrapper_call(wrapperobject *wp, PyObject *args, PyObject *kwds)
804{
805 wrapperfunc wrapper = wp->descr->d_base->wrapper;
806 PyObject *self = wp->self;
807
808 return (*wrapper)(self, args, wp->descr->d_wrapped);
809}
810
Guido van Rossum048eb752001-10-02 21:24:57 +0000811static int
812wrapper_traverse(PyObject *self, visitproc visit, void *arg)
813{
814 wrapperobject *wp = (wrapperobject *)self;
815 int err;
816
817 if (wp->descr) {
818 err = visit((PyObject *)(wp->descr), arg);
819 if (err)
820 return err;
821 }
822 if (wp->self) {
823 err = visit(wp->self, arg);
824 if (err)
825 return err;
826 }
827 return 0;
828}
829
Tim Peters6d6c1a32001-08-02 04:15:00 +0000830PyTypeObject wrappertype = {
831 PyObject_HEAD_INIT(&PyType_Type)
832 0, /* ob_size */
833 "method-wrapper", /* tp_name */
834 sizeof(wrapperobject), /* tp_basicsize */
835 0, /* tp_itemsize */
836 /* methods */
837 (destructor)wrapper_dealloc, /* tp_dealloc */
838 0, /* tp_print */
839 0, /* tp_getattr */
840 0, /* tp_setattr */
841 0, /* tp_compare */
842 0, /* tp_repr */
843 0, /* tp_as_number */
844 0, /* tp_as_sequence */
845 0, /* tp_as_mapping */
846 0, /* tp_hash */
847 (ternaryfunc)wrapper_call, /* tp_call */
848 0, /* tp_str */
849 PyObject_GenericGetAttr, /* tp_getattro */
850 0, /* tp_setattro */
851 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +0000852 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000853 0, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +0000854 wrapper_traverse, /* tp_traverse */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000855 0, /* tp_clear */
856 0, /* tp_richcompare */
857 0, /* tp_weaklistoffset */
858 0, /* tp_iter */
859 0, /* tp_iternext */
860 wrapper_methods, /* tp_methods */
861 0, /* tp_members */
862 wrapper_getsets, /* tp_getset */
863 0, /* tp_base */
864 0, /* tp_dict */
865 0, /* tp_descr_get */
866 0, /* tp_descr_set */
867};
868
869PyObject *
870PyWrapper_New(PyObject *d, PyObject *self)
871{
872 wrapperobject *wp;
873 PyWrapperDescrObject *descr;
874
875 assert(PyObject_TypeCheck(d, &PyWrapperDescr_Type));
876 descr = (PyWrapperDescrObject *)d;
877 assert(PyObject_IsInstance(self, (PyObject *)(descr->d_type)));
878
Guido van Rossum048eb752001-10-02 21:24:57 +0000879 wp = PyObject_GC_New(wrapperobject, &wrappertype);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000880 if (wp != NULL) {
881 Py_INCREF(descr);
882 wp->descr = descr;
883 Py_INCREF(self);
884 wp->self = self;
Guido van Rossum048eb752001-10-02 21:24:57 +0000885 _PyObject_GC_TRACK(wp);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000886 }
887 return (PyObject *)wp;
888}
Guido van Rossum29a62dd2001-08-23 21:40:38 +0000889
890
Guido van Rossum8bce4ac2001-09-06 21:56:42 +0000891/* A built-in 'property' type */
Guido van Rossum29a62dd2001-08-23 21:40:38 +0000892
893/*
Guido van Rossum8bce4ac2001-09-06 21:56:42 +0000894 class property(object):
Guido van Rossum29a62dd2001-08-23 21:40:38 +0000895
Tim Peters66c1a522001-09-24 21:17:50 +0000896 def __init__(self, fget=None, fset=None, fdel=None, doc=None):
897 self.__get = fget
898 self.__set = fset
899 self.__del = fdel
900 self.__doc__ = doc
Guido van Rossum29a62dd2001-08-23 21:40:38 +0000901
902 def __get__(self, inst, type=None):
903 if self.__get is None:
904 raise AttributeError, "unreadable attribute"
905 if inst is None:
906 return self
907 return self.__get(inst)
908
909 def __set__(self, inst, value):
Tim Peters66c1a522001-09-24 21:17:50 +0000910 if value is None:
911 if self.__del is None:
912 raise AttributeError, "can't delete attribute"
913 return self.__del(inst)
914 else:
915 if self.__set is None:
916 raise AttributeError, "can't set attribute"
917 return self.__set(inst, value)
Guido van Rossum29a62dd2001-08-23 21:40:38 +0000918*/
919
920typedef struct {
921 PyObject_HEAD
Tim Peters66c1a522001-09-24 21:17:50 +0000922 PyObject *prop_get;
923 PyObject *prop_set;
924 PyObject *prop_del;
925 PyObject *prop_doc;
Guido van Rossum8bce4ac2001-09-06 21:56:42 +0000926} propertyobject;
Guido van Rossum29a62dd2001-08-23 21:40:38 +0000927
Tim Peters66c1a522001-09-24 21:17:50 +0000928static PyMemberDef property_members[] = {
929 {"fget", T_OBJECT, offsetof(propertyobject, prop_get), READONLY},
930 {"fset", T_OBJECT, offsetof(propertyobject, prop_set), READONLY},
931 {"fdel", T_OBJECT, offsetof(propertyobject, prop_del), READONLY},
932 {"__doc__", T_OBJECT, offsetof(propertyobject, prop_doc), READONLY},
933 {0}
934};
935
936
Guido van Rossum29a62dd2001-08-23 21:40:38 +0000937static void
Guido van Rossum8bce4ac2001-09-06 21:56:42 +0000938property_dealloc(PyObject *self)
Guido van Rossum29a62dd2001-08-23 21:40:38 +0000939{
Guido van Rossum8bce4ac2001-09-06 21:56:42 +0000940 propertyobject *gs = (propertyobject *)self;
Guido van Rossum29a62dd2001-08-23 21:40:38 +0000941
Guido van Rossum048eb752001-10-02 21:24:57 +0000942 _PyObject_GC_UNTRACK(self);
Tim Peters66c1a522001-09-24 21:17:50 +0000943 Py_XDECREF(gs->prop_get);
944 Py_XDECREF(gs->prop_set);
945 Py_XDECREF(gs->prop_del);
946 Py_XDECREF(gs->prop_doc);
Guido van Rossum29a62dd2001-08-23 21:40:38 +0000947 self->ob_type->tp_free(self);
948}
949
950static PyObject *
Guido van Rossum8bce4ac2001-09-06 21:56:42 +0000951property_descr_get(PyObject *self, PyObject *obj, PyObject *type)
Guido van Rossum29a62dd2001-08-23 21:40:38 +0000952{
Guido van Rossum8bce4ac2001-09-06 21:56:42 +0000953 propertyobject *gs = (propertyobject *)self;
Guido van Rossum29a62dd2001-08-23 21:40:38 +0000954
Tim Peters66c1a522001-09-24 21:17:50 +0000955 if (gs->prop_get == NULL) {
Guido van Rossum29a62dd2001-08-23 21:40:38 +0000956 PyErr_SetString(PyExc_AttributeError, "unreadable attribute");
957 return NULL;
958 }
959 if (obj == NULL || obj == Py_None) {
960 Py_INCREF(self);
961 return self;
962 }
Tim Peters66c1a522001-09-24 21:17:50 +0000963 return PyObject_CallFunction(gs->prop_get, "(O)", obj);
Guido van Rossum29a62dd2001-08-23 21:40:38 +0000964}
965
966static int
Guido van Rossum8bce4ac2001-09-06 21:56:42 +0000967property_descr_set(PyObject *self, PyObject *obj, PyObject *value)
Guido van Rossum29a62dd2001-08-23 21:40:38 +0000968{
Guido van Rossum8bce4ac2001-09-06 21:56:42 +0000969 propertyobject *gs = (propertyobject *)self;
Guido van Rossum271410a2001-08-24 15:23:20 +0000970 PyObject *func, *res;
Guido van Rossum29a62dd2001-08-23 21:40:38 +0000971
Guido van Rossum271410a2001-08-24 15:23:20 +0000972 if (value == NULL)
Tim Peters66c1a522001-09-24 21:17:50 +0000973 func = gs->prop_del;
Guido van Rossum271410a2001-08-24 15:23:20 +0000974 else
Tim Peters66c1a522001-09-24 21:17:50 +0000975 func = gs->prop_set;
Guido van Rossum271410a2001-08-24 15:23:20 +0000976 if (func == NULL) {
977 PyErr_SetString(PyExc_AttributeError,
978 value == NULL ?
979 "can't delete attribute" :
980 "can't set attribute");
Guido van Rossum29a62dd2001-08-23 21:40:38 +0000981 return -1;
982 }
Guido van Rossum845fc482001-08-24 10:17:36 +0000983 if (value == NULL)
Guido van Rossum271410a2001-08-24 15:23:20 +0000984 res = PyObject_CallFunction(func, "(O)", obj);
Guido van Rossum845fc482001-08-24 10:17:36 +0000985 else
Guido van Rossum271410a2001-08-24 15:23:20 +0000986 res = PyObject_CallFunction(func, "(OO)", obj, value);
Guido van Rossum29a62dd2001-08-23 21:40:38 +0000987 if (res == NULL)
988 return -1;
989 Py_DECREF(res);
990 return 0;
991}
992
993static int
Guido van Rossum8bce4ac2001-09-06 21:56:42 +0000994property_init(PyObject *self, PyObject *args, PyObject *kwds)
Guido van Rossum29a62dd2001-08-23 21:40:38 +0000995{
Tim Peters66c1a522001-09-24 21:17:50 +0000996 PyObject *get = NULL, *set = NULL, *del = NULL, *doc = NULL;
997 static char *kwlist[] = {"fget", "fset", "fdel", "doc", 0};
Guido van Rossum8bce4ac2001-09-06 21:56:42 +0000998 propertyobject *gs = (propertyobject *)self;
Guido van Rossum29a62dd2001-08-23 21:40:38 +0000999
Tim Peters66c1a522001-09-24 21:17:50 +00001000 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OOOO:property",
1001 kwlist, &get, &set, &del, &doc))
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001002 return -1;
Tim Peters66c1a522001-09-24 21:17:50 +00001003
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001004 if (get == Py_None)
1005 get = NULL;
1006 if (set == Py_None)
1007 set = NULL;
Tim Peters66c1a522001-09-24 21:17:50 +00001008 if (del == Py_None)
1009 del = NULL;
1010
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001011 Py_XINCREF(get);
1012 Py_XINCREF(set);
Guido van Rossum271410a2001-08-24 15:23:20 +00001013 Py_XINCREF(del);
Tim Peters66c1a522001-09-24 21:17:50 +00001014 Py_XINCREF(doc);
1015
1016 gs->prop_get = get;
1017 gs->prop_set = set;
1018 gs->prop_del = del;
1019 gs->prop_doc = doc;
1020
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001021 return 0;
1022}
1023
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001024static char property_doc[] =
Tim Peters66c1a522001-09-24 21:17:50 +00001025"property(fget=None, fset=None, fdel=None, doc=None) -> property attribute\n"
1026"\n"
1027"fget is a function to be used for getting an attribute value, and likewise\n"
1028"fset is a function for setting, and fdel a function for del'ing, an\n"
1029"attribute. Typical use is to define a managed attribute x:\n"
Guido van Rossum91c0d8a2001-08-24 09:55:51 +00001030"class C(object):\n"
1031" def getx(self): return self.__x\n"
1032" def setx(self, value): self.__x = value\n"
Guido van Rossum271410a2001-08-24 15:23:20 +00001033" def delx(self): del self.__x\n"
Tim Peters66c1a522001-09-24 21:17:50 +00001034" x = property(getx, setx, delx, \"I'm the 'x' property.\")";
Guido van Rossum91c0d8a2001-08-24 09:55:51 +00001035
Guido van Rossum048eb752001-10-02 21:24:57 +00001036static int
1037property_traverse(PyObject *self, visitproc visit, void *arg)
1038{
1039 propertyobject *pp = (propertyobject *)self;
1040 int err;
1041
1042#define VISIT(SLOT) \
1043 if (pp->SLOT) { \
1044 err = visit((PyObject *)(pp->SLOT), arg); \
1045 if (err) \
1046 return err; \
1047 }
1048
1049 VISIT(prop_get);
1050 VISIT(prop_set);
1051 VISIT(prop_del);
1052
1053 return 0;
1054}
1055
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001056PyTypeObject PyProperty_Type = {
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001057 PyObject_HEAD_INIT(&PyType_Type)
1058 0, /* ob_size */
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001059 "property", /* tp_name */
1060 sizeof(propertyobject), /* tp_basicsize */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001061 0, /* tp_itemsize */
1062 /* methods */
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001063 property_dealloc, /* tp_dealloc */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001064 0, /* tp_print */
1065 0, /* tp_getattr */
1066 0, /* tp_setattr */
1067 0, /* tp_compare */
1068 0, /* tp_repr */
1069 0, /* tp_as_number */
1070 0, /* tp_as_sequence */
1071 0, /* tp_as_mapping */
1072 0, /* tp_hash */
1073 0, /* tp_call */
1074 0, /* tp_str */
1075 PyObject_GenericGetAttr, /* tp_getattro */
1076 0, /* tp_setattro */
1077 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00001078 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
1079 Py_TPFLAGS_BASETYPE, /* tp_flags */
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001080 property_doc, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +00001081 property_traverse, /* tp_traverse */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001082 0, /* tp_clear */
1083 0, /* tp_richcompare */
1084 0, /* tp_weaklistoffset */
1085 0, /* tp_iter */
1086 0, /* tp_iternext */
1087 0, /* tp_methods */
Tim Peters66c1a522001-09-24 21:17:50 +00001088 property_members, /* tp_members */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001089 0, /* tp_getset */
1090 0, /* tp_base */
1091 0, /* tp_dict */
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001092 property_descr_get, /* tp_descr_get */
1093 property_descr_set, /* tp_descr_set */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001094 0, /* tp_dictoffset */
Guido van Rossum8bce4ac2001-09-06 21:56:42 +00001095 property_init, /* tp_init */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001096 PyType_GenericAlloc, /* tp_alloc */
1097 PyType_GenericNew, /* tp_new */
Guido van Rossum048eb752001-10-02 21:24:57 +00001098 _PyObject_GC_Del, /* tp_free */
Guido van Rossum29a62dd2001-08-23 21:40:38 +00001099};