1 /* Descriptors -- a new, flexible way to describe attributes */
4 #include "structmember.h" /* Why is this not included in Python.h? */
7 descr_dealloc(PyDescrObject
*descr
)
9 _PyObject_GC_UNTRACK(descr
);
10 Py_XDECREF(descr
->d_type
);
11 Py_XDECREF(descr
->d_name
);
12 PyObject_GC_Del(descr
);
16 descr_name(PyDescrObject
*descr
)
18 if (descr
->d_name
!= NULL
&& PyString_Check(descr
->d_name
))
19 return PyString_AS_STRING(descr
->d_name
);
25 descr_repr(PyDescrObject
*descr
, char *format
)
27 return PyString_FromFormat(format
, descr_name(descr
),
28 descr
->d_type
->tp_name
);
32 method_repr(PyMethodDescrObject
*descr
)
34 return descr_repr((PyDescrObject
*)descr
,
35 "<method '%s' of '%s' objects>");
39 member_repr(PyMemberDescrObject
*descr
)
41 return descr_repr((PyDescrObject
*)descr
,
42 "<member '%s' of '%s' objects>");
46 getset_repr(PyGetSetDescrObject
*descr
)
48 return descr_repr((PyDescrObject
*)descr
,
49 "<attribute '%s' of '%s' objects>");
53 wrapperdescr_repr(PyWrapperDescrObject
*descr
)
55 return descr_repr((PyDescrObject
*)descr
,
56 "<slot wrapper '%s' of '%s' objects>");
60 descr_check(PyDescrObject
*descr
, PyObject
*obj
, PyObject
**pres
)
64 *pres
= (PyObject
*)descr
;
67 if (!PyObject_TypeCheck(obj
, descr
->d_type
)) {
68 PyErr_Format(PyExc_TypeError
,
69 "descriptor '%s' for '%s' objects "
70 "doesn't apply to '%s' object",
71 descr_name((PyDescrObject
*)descr
),
72 descr
->d_type
->tp_name
,
73 obj
->ob_type
->tp_name
);
81 classmethod_get(PyMethodDescrObject
*descr
, PyObject
*obj
, PyObject
*type
)
83 /* Ensure a valid type. Class methods ignore obj. */
86 type
= (PyObject
*)obj
->ob_type
;
89 PyErr_Format(PyExc_TypeError
,
90 "descriptor '%s' for type '%s' "
91 "needs either an object or a type",
92 descr_name((PyDescrObject
*)descr
),
93 descr
->d_type
->tp_name
);
97 if (!PyType_Check(type
)) {
98 PyErr_Format(PyExc_TypeError
,
99 "descriptor '%s' for type '%s' "
100 "needs a type, not a '%s' as arg 2",
101 descr_name((PyDescrObject
*)descr
),
102 descr
->d_type
->tp_name
,
103 type
->ob_type
->tp_name
);
106 if (!PyType_IsSubtype((PyTypeObject
*)type
, descr
->d_type
)) {
107 PyErr_Format(PyExc_TypeError
,
108 "descriptor '%s' for type '%s' "
109 "doesn't apply to type '%s'",
110 descr_name((PyDescrObject
*)descr
),
111 descr
->d_type
->tp_name
,
112 ((PyTypeObject
*)type
)->tp_name
);
115 return PyCFunction_New(descr
->d_method
, type
);
119 method_get(PyMethodDescrObject
*descr
, PyObject
*obj
, PyObject
*type
)
123 if (descr_check((PyDescrObject
*)descr
, obj
, &res
))
125 return PyCFunction_New(descr
->d_method
, obj
);
129 member_get(PyMemberDescrObject
*descr
, PyObject
*obj
, PyObject
*type
)
133 if (descr_check((PyDescrObject
*)descr
, obj
, &res
))
135 return PyMember_GetOne((char *)obj
, descr
->d_member
);
139 getset_get(PyGetSetDescrObject
*descr
, PyObject
*obj
, PyObject
*type
)
143 if (descr_check((PyDescrObject
*)descr
, obj
, &res
))
145 if (descr
->d_getset
->get
!= NULL
)
146 return descr
->d_getset
->get(obj
, descr
->d_getset
->closure
);
147 PyErr_Format(PyExc_AttributeError
,
148 "attribute '%.300s' of '%.100s' objects is not readable",
149 descr_name((PyDescrObject
*)descr
),
150 descr
->d_type
->tp_name
);
155 wrapperdescr_get(PyWrapperDescrObject
*descr
, PyObject
*obj
, PyObject
*type
)
159 if (descr_check((PyDescrObject
*)descr
, obj
, &res
))
161 return PyWrapper_New((PyObject
*)descr
, obj
);
165 descr_setcheck(PyDescrObject
*descr
, PyObject
*obj
, PyObject
*value
,
169 if (!PyObject_TypeCheck(obj
, descr
->d_type
)) {
170 PyErr_Format(PyExc_TypeError
,
171 "descriptor '%.200s' for '%.100s' objects "
172 "doesn't apply to '%.100s' object",
174 descr
->d_type
->tp_name
,
175 obj
->ob_type
->tp_name
);
183 member_set(PyMemberDescrObject
*descr
, PyObject
*obj
, PyObject
*value
)
187 if (descr_setcheck((PyDescrObject
*)descr
, obj
, value
, &res
))
189 return PyMember_SetOne((char *)obj
, descr
->d_member
, value
);
193 getset_set(PyGetSetDescrObject
*descr
, PyObject
*obj
, PyObject
*value
)
197 if (descr_setcheck((PyDescrObject
*)descr
, obj
, value
, &res
))
199 if (descr
->d_getset
->set
!= NULL
)
200 return descr
->d_getset
->set(obj
, value
,
201 descr
->d_getset
->closure
);
202 PyErr_Format(PyExc_AttributeError
,
203 "attribute '%.300s' of '%.100s' objects is not writable",
204 descr_name((PyDescrObject
*)descr
),
205 descr
->d_type
->tp_name
);
210 methoddescr_call(PyMethodDescrObject
*descr
, PyObject
*args
, PyObject
*kwds
)
213 PyObject
*self
, *func
, *result
;
215 /* Make sure that the first argument is acceptable as 'self' */
216 assert(PyTuple_Check(args
));
217 argc
= PyTuple_GET_SIZE(args
);
219 PyErr_Format(PyExc_TypeError
,
220 "descriptor '%.300s' of '%.100s' "
221 "object needs an argument",
222 descr_name((PyDescrObject
*)descr
),
223 descr
->d_type
->tp_name
);
226 self
= PyTuple_GET_ITEM(args
, 0);
227 if (!PyObject_IsInstance(self
, (PyObject
*)(descr
->d_type
))) {
228 PyErr_Format(PyExc_TypeError
,
229 "descriptor '%.200s' "
230 "requires a '%.100s' object "
231 "but received a '%.100s'",
232 descr_name((PyDescrObject
*)descr
),
233 descr
->d_type
->tp_name
,
234 self
->ob_type
->tp_name
);
238 func
= PyCFunction_New(descr
->d_method
, self
);
241 args
= PyTuple_GetSlice(args
, 1, argc
);
246 result
= PyEval_CallObjectWithKeywords(func
, args
, kwds
);
253 classmethoddescr_call(PyMethodDescrObject
*descr
, PyObject
*args
,
256 PyObject
*func
, *result
;
258 func
= PyCFunction_New(descr
->d_method
, (PyObject
*)descr
->d_type
);
262 result
= PyEval_CallObjectWithKeywords(func
, args
, kwds
);
268 wrapperdescr_call(PyWrapperDescrObject
*descr
, PyObject
*args
, PyObject
*kwds
)
271 PyObject
*self
, *func
, *result
;
273 /* Make sure that the first argument is acceptable as 'self' */
274 assert(PyTuple_Check(args
));
275 argc
= PyTuple_GET_SIZE(args
);
277 PyErr_Format(PyExc_TypeError
,
278 "descriptor '%.300s' of '%.100s' "
279 "object needs an argument",
280 descr_name((PyDescrObject
*)descr
),
281 descr
->d_type
->tp_name
);
284 self
= PyTuple_GET_ITEM(args
, 0);
285 if (!PyObject_IsInstance(self
, (PyObject
*)(descr
->d_type
))) {
286 PyErr_Format(PyExc_TypeError
,
287 "descriptor '%.200s' "
288 "requires a '%.100s' object "
289 "but received a '%.100s'",
290 descr_name((PyDescrObject
*)descr
),
291 descr
->d_type
->tp_name
,
292 self
->ob_type
->tp_name
);
296 func
= PyWrapper_New((PyObject
*)descr
, self
);
299 args
= PyTuple_GetSlice(args
, 1, argc
);
304 result
= PyEval_CallObjectWithKeywords(func
, args
, kwds
);
311 method_get_doc(PyMethodDescrObject
*descr
, void *closure
)
313 if (descr
->d_method
->ml_doc
== NULL
) {
317 return PyString_FromString(descr
->d_method
->ml_doc
);
320 static PyMemberDef descr_members
[] = {
321 {"__objclass__", T_OBJECT
, offsetof(PyDescrObject
, d_type
), READONLY
},
322 {"__name__", T_OBJECT
, offsetof(PyDescrObject
, d_name
), READONLY
},
326 static PyGetSetDef method_getset
[] = {
327 {"__doc__", (getter
)method_get_doc
},
332 member_get_doc(PyMemberDescrObject
*descr
, void *closure
)
334 if (descr
->d_member
->doc
== NULL
) {
338 return PyString_FromString(descr
->d_member
->doc
);
341 static PyGetSetDef member_getset
[] = {
342 {"__doc__", (getter
)member_get_doc
},
347 getset_get_doc(PyGetSetDescrObject
*descr
, void *closure
)
349 if (descr
->d_getset
->doc
== NULL
) {
353 return PyString_FromString(descr
->d_getset
->doc
);
356 static PyGetSetDef getset_getset
[] = {
357 {"__doc__", (getter
)getset_get_doc
},
362 wrapperdescr_get_doc(PyWrapperDescrObject
*descr
, void *closure
)
364 if (descr
->d_base
->doc
== NULL
) {
368 return PyString_FromString(descr
->d_base
->doc
);
371 static PyGetSetDef wrapperdescr_getset
[] = {
372 {"__doc__", (getter
)wrapperdescr_get_doc
},
377 descr_traverse(PyObject
*self
, visitproc visit
, void *arg
)
379 PyDescrObject
*descr
= (PyDescrObject
*)self
;
380 Py_VISIT(descr
->d_type
);
384 static PyTypeObject PyMethodDescr_Type
= {
385 PyVarObject_HEAD_INIT(&PyType_Type
, 0)
387 sizeof(PyMethodDescrObject
),
389 (destructor
)descr_dealloc
, /* tp_dealloc */
394 (reprfunc
)method_repr
, /* tp_repr */
395 0, /* tp_as_number */
396 0, /* tp_as_sequence */
397 0, /* tp_as_mapping */
399 (ternaryfunc
)methoddescr_call
, /* tp_call */
401 PyObject_GenericGetAttr
, /* tp_getattro */
403 0, /* tp_as_buffer */
404 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_GC
, /* tp_flags */
406 descr_traverse
, /* tp_traverse */
408 0, /* tp_richcompare */
409 0, /* tp_weaklistoffset */
413 descr_members
, /* tp_members */
414 method_getset
, /* tp_getset */
417 (descrgetfunc
)method_get
, /* tp_descr_get */
418 0, /* tp_descr_set */
421 /* This is for METH_CLASS in C, not for "f = classmethod(f)" in Python! */
422 static PyTypeObject PyClassMethodDescr_Type
= {
423 PyVarObject_HEAD_INIT(&PyType_Type
, 0)
424 "classmethod_descriptor",
425 sizeof(PyMethodDescrObject
),
427 (destructor
)descr_dealloc
, /* tp_dealloc */
432 (reprfunc
)method_repr
, /* tp_repr */
433 0, /* tp_as_number */
434 0, /* tp_as_sequence */
435 0, /* tp_as_mapping */
437 (ternaryfunc
)classmethoddescr_call
, /* tp_call */
439 PyObject_GenericGetAttr
, /* tp_getattro */
441 0, /* tp_as_buffer */
442 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_GC
, /* tp_flags */
444 descr_traverse
, /* tp_traverse */
446 0, /* tp_richcompare */
447 0, /* tp_weaklistoffset */
451 descr_members
, /* tp_members */
452 method_getset
, /* tp_getset */
455 (descrgetfunc
)classmethod_get
, /* tp_descr_get */
456 0, /* tp_descr_set */
459 PyTypeObject PyMemberDescr_Type
= {
460 PyVarObject_HEAD_INIT(&PyType_Type
, 0)
462 sizeof(PyMemberDescrObject
),
464 (destructor
)descr_dealloc
, /* tp_dealloc */
469 (reprfunc
)member_repr
, /* tp_repr */
470 0, /* tp_as_number */
471 0, /* tp_as_sequence */
472 0, /* tp_as_mapping */
476 PyObject_GenericGetAttr
, /* tp_getattro */
478 0, /* tp_as_buffer */
479 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_GC
, /* tp_flags */
481 descr_traverse
, /* tp_traverse */
483 0, /* tp_richcompare */
484 0, /* tp_weaklistoffset */
488 descr_members
, /* tp_members */
489 member_getset
, /* tp_getset */
492 (descrgetfunc
)member_get
, /* tp_descr_get */
493 (descrsetfunc
)member_set
, /* tp_descr_set */
496 PyTypeObject PyGetSetDescr_Type
= {
497 PyVarObject_HEAD_INIT(&PyType_Type
, 0)
499 sizeof(PyGetSetDescrObject
),
501 (destructor
)descr_dealloc
, /* tp_dealloc */
506 (reprfunc
)getset_repr
, /* tp_repr */
507 0, /* tp_as_number */
508 0, /* tp_as_sequence */
509 0, /* tp_as_mapping */
513 PyObject_GenericGetAttr
, /* tp_getattro */
515 0, /* tp_as_buffer */
516 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_GC
, /* tp_flags */
518 descr_traverse
, /* tp_traverse */
520 0, /* tp_richcompare */
521 0, /* tp_weaklistoffset */
525 descr_members
, /* tp_members */
526 getset_getset
, /* tp_getset */
529 (descrgetfunc
)getset_get
, /* tp_descr_get */
530 (descrsetfunc
)getset_set
, /* tp_descr_set */
533 PyTypeObject PyWrapperDescr_Type
= {
534 PyVarObject_HEAD_INIT(&PyType_Type
, 0)
535 "wrapper_descriptor",
536 sizeof(PyWrapperDescrObject
),
538 (destructor
)descr_dealloc
, /* tp_dealloc */
543 (reprfunc
)wrapperdescr_repr
, /* tp_repr */
544 0, /* tp_as_number */
545 0, /* tp_as_sequence */
546 0, /* tp_as_mapping */
548 (ternaryfunc
)wrapperdescr_call
, /* tp_call */
550 PyObject_GenericGetAttr
, /* tp_getattro */
552 0, /* tp_as_buffer */
553 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_GC
, /* tp_flags */
555 descr_traverse
, /* tp_traverse */
557 0, /* tp_richcompare */
558 0, /* tp_weaklistoffset */
562 descr_members
, /* tp_members */
563 wrapperdescr_getset
, /* tp_getset */
566 (descrgetfunc
)wrapperdescr_get
, /* tp_descr_get */
567 0, /* tp_descr_set */
570 static PyDescrObject
*
571 descr_new(PyTypeObject
*descrtype
, PyTypeObject
*type
, const char *name
)
573 PyDescrObject
*descr
;
575 descr
= (PyDescrObject
*)PyType_GenericAlloc(descrtype
, 0);
578 descr
->d_type
= type
;
579 descr
->d_name
= PyString_InternFromString(name
);
580 if (descr
->d_name
== NULL
) {
589 PyDescr_NewMethod(PyTypeObject
*type
, PyMethodDef
*method
)
591 PyMethodDescrObject
*descr
;
593 descr
= (PyMethodDescrObject
*)descr_new(&PyMethodDescr_Type
,
594 type
, method
->ml_name
);
596 descr
->d_method
= method
;
597 return (PyObject
*)descr
;
601 PyDescr_NewClassMethod(PyTypeObject
*type
, PyMethodDef
*method
)
603 PyMethodDescrObject
*descr
;
605 descr
= (PyMethodDescrObject
*)descr_new(&PyClassMethodDescr_Type
,
606 type
, method
->ml_name
);
608 descr
->d_method
= method
;
609 return (PyObject
*)descr
;
613 PyDescr_NewMember(PyTypeObject
*type
, PyMemberDef
*member
)
615 PyMemberDescrObject
*descr
;
617 descr
= (PyMemberDescrObject
*)descr_new(&PyMemberDescr_Type
,
620 descr
->d_member
= member
;
621 return (PyObject
*)descr
;
625 PyDescr_NewGetSet(PyTypeObject
*type
, PyGetSetDef
*getset
)
627 PyGetSetDescrObject
*descr
;
629 descr
= (PyGetSetDescrObject
*)descr_new(&PyGetSetDescr_Type
,
632 descr
->d_getset
= getset
;
633 return (PyObject
*)descr
;
637 PyDescr_NewWrapper(PyTypeObject
*type
, struct wrapperbase
*base
, void *wrapped
)
639 PyWrapperDescrObject
*descr
;
641 descr
= (PyWrapperDescrObject
*)descr_new(&PyWrapperDescr_Type
,
644 descr
->d_base
= base
;
645 descr
->d_wrapped
= wrapped
;
647 return (PyObject
*)descr
;
651 /* --- Readonly proxy for dictionaries (actually any mapping) --- */
653 /* This has no reason to be in this file except that adding new files is a
662 proxy_len(proxyobject
*pp
)
664 return PyObject_Size(pp
->dict
);
668 proxy_getitem(proxyobject
*pp
, PyObject
*key
)
670 return PyObject_GetItem(pp
->dict
, key
);
673 static PyMappingMethods proxy_as_mapping
= {
674 (lenfunc
)proxy_len
, /* mp_length */
675 (binaryfunc
)proxy_getitem
, /* mp_subscript */
676 0, /* mp_ass_subscript */
680 proxy_contains(proxyobject
*pp
, PyObject
*key
)
682 return PyDict_Contains(pp
->dict
, key
);
685 static PySequenceMethods proxy_as_sequence
= {
692 0, /* sq_ass_slice */
693 (objobjproc
)proxy_contains
, /* sq_contains */
694 0, /* sq_inplace_concat */
695 0, /* sq_inplace_repeat */
699 proxy_has_key(proxyobject
*pp
, PyObject
*key
)
701 int res
= PyDict_Contains(pp
->dict
, key
);
704 return PyBool_FromLong(res
);
708 proxy_get(proxyobject
*pp
, PyObject
*args
)
710 PyObject
*key
, *def
= Py_None
;
712 if (!PyArg_UnpackTuple(args
, "get", 1, 2, &key
, &def
))
714 return PyObject_CallMethod(pp
->dict
, "get", "(OO)", key
, def
);
718 proxy_keys(proxyobject
*pp
)
720 return PyMapping_Keys(pp
->dict
);
724 proxy_values(proxyobject
*pp
)
726 return PyMapping_Values(pp
->dict
);
730 proxy_items(proxyobject
*pp
)
732 return PyMapping_Items(pp
->dict
);
736 proxy_iterkeys(proxyobject
*pp
)
738 return PyObject_CallMethod(pp
->dict
, "iterkeys", NULL
);
742 proxy_itervalues(proxyobject
*pp
)
744 return PyObject_CallMethod(pp
->dict
, "itervalues", NULL
);
748 proxy_iteritems(proxyobject
*pp
)
750 return PyObject_CallMethod(pp
->dict
, "iteritems", NULL
);
753 proxy_copy(proxyobject
*pp
)
755 return PyObject_CallMethod(pp
->dict
, "copy", NULL
);
758 static PyMethodDef proxy_methods
[] = {
759 {"has_key", (PyCFunction
)proxy_has_key
, METH_O
,
760 PyDoc_STR("D.has_key(k) -> True if D has a key k, else False")},
761 {"get", (PyCFunction
)proxy_get
, METH_VARARGS
,
762 PyDoc_STR("D.get(k[,d]) -> D[k] if D.has_key(k), else d."
763 " d defaults to None.")},
764 {"keys", (PyCFunction
)proxy_keys
, METH_NOARGS
,
765 PyDoc_STR("D.keys() -> list of D's keys")},
766 {"values", (PyCFunction
)proxy_values
, METH_NOARGS
,
767 PyDoc_STR("D.values() -> list of D's values")},
768 {"items", (PyCFunction
)proxy_items
, METH_NOARGS
,
769 PyDoc_STR("D.items() -> list of D's (key, value) pairs, as 2-tuples")},
770 {"iterkeys", (PyCFunction
)proxy_iterkeys
, METH_NOARGS
,
771 PyDoc_STR("D.iterkeys() -> an iterator over the keys of D")},
772 {"itervalues",(PyCFunction
)proxy_itervalues
, METH_NOARGS
,
773 PyDoc_STR("D.itervalues() -> an iterator over the values of D")},
774 {"iteritems", (PyCFunction
)proxy_iteritems
, METH_NOARGS
,
775 PyDoc_STR("D.iteritems() ->"
776 " an iterator over the (key, value) items of D")},
777 {"copy", (PyCFunction
)proxy_copy
, METH_NOARGS
,
778 PyDoc_STR("D.copy() -> a shallow copy of D")},
783 proxy_dealloc(proxyobject
*pp
)
785 _PyObject_GC_UNTRACK(pp
);
791 proxy_getiter(proxyobject
*pp
)
793 return PyObject_GetIter(pp
->dict
);
797 proxy_str(proxyobject
*pp
)
799 return PyObject_Str(pp
->dict
);
803 proxy_traverse(PyObject
*self
, visitproc visit
, void *arg
)
805 proxyobject
*pp
= (proxyobject
*)self
;
811 proxy_compare(proxyobject
*v
, PyObject
*w
)
813 return PyObject_Compare(v
->dict
, w
);
817 proxy_richcompare(proxyobject
*v
, PyObject
*w
, int op
)
819 return PyObject_RichCompare(v
->dict
, w
, op
);
822 PyTypeObject PyDictProxy_Type
= {
823 PyVarObject_HEAD_INIT(&PyType_Type
, 0)
824 "dictproxy", /* tp_name */
825 sizeof(proxyobject
), /* tp_basicsize */
828 (destructor
)proxy_dealloc
, /* tp_dealloc */
832 (cmpfunc
)proxy_compare
, /* tp_compare */
834 0, /* tp_as_number */
835 &proxy_as_sequence
, /* tp_as_sequence */
836 &proxy_as_mapping
, /* tp_as_mapping */
839 (reprfunc
)proxy_str
, /* tp_str */
840 PyObject_GenericGetAttr
, /* tp_getattro */
842 0, /* tp_as_buffer */
843 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_GC
, /* tp_flags */
845 proxy_traverse
, /* tp_traverse */
847 (richcmpfunc
)proxy_richcompare
, /* tp_richcompare */
848 0, /* tp_weaklistoffset */
849 (getiterfunc
)proxy_getiter
, /* tp_iter */
851 proxy_methods
, /* tp_methods */
856 0, /* tp_descr_get */
857 0, /* tp_descr_set */
861 PyDictProxy_New(PyObject
*dict
)
865 pp
= PyObject_GC_New(proxyobject
, &PyDictProxy_Type
);
869 _PyObject_GC_TRACK(pp
);
871 return (PyObject
*)pp
;
875 /* --- Wrapper object for "slot" methods --- */
877 /* This has no reason to be in this file except that adding new files is a
882 PyWrapperDescrObject
*descr
;
887 wrapper_dealloc(wrapperobject
*wp
)
889 PyObject_GC_UnTrack(wp
);
890 Py_TRASHCAN_SAFE_BEGIN(wp
)
891 Py_XDECREF(wp
->descr
);
892 Py_XDECREF(wp
->self
);
894 Py_TRASHCAN_SAFE_END(wp
)
898 wrapper_compare(wrapperobject
*a
, wrapperobject
*b
)
900 if (a
->descr
== b
->descr
)
901 return PyObject_Compare(a
->self
, b
->self
);
903 return (a
->descr
< b
->descr
) ? -1 : 1;
907 wrapper_hash(wrapperobject
*wp
)
910 x
= _Py_HashPointer(wp
->descr
);
913 y
= PyObject_Hash(wp
->self
);
923 wrapper_repr(wrapperobject
*wp
)
925 return PyString_FromFormat("<method-wrapper '%s' of %s object at %p>",
926 wp
->descr
->d_base
->name
,
927 wp
->self
->ob_type
->tp_name
,
931 static PyMemberDef wrapper_members
[] = {
932 {"__self__", T_OBJECT
, offsetof(wrapperobject
, self
), READONLY
},
937 wrapper_objclass(wrapperobject
*wp
)
939 PyObject
*c
= (PyObject
*)wp
->descr
->d_type
;
946 wrapper_name(wrapperobject
*wp
)
948 char *s
= wp
->descr
->d_base
->name
;
950 return PyString_FromString(s
);
954 wrapper_doc(wrapperobject
*wp
)
956 char *s
= wp
->descr
->d_base
->doc
;
963 return PyString_FromString(s
);
967 static PyGetSetDef wrapper_getsets
[] = {
968 {"__objclass__", (getter
)wrapper_objclass
},
969 {"__name__", (getter
)wrapper_name
},
970 {"__doc__", (getter
)wrapper_doc
},
975 wrapper_call(wrapperobject
*wp
, PyObject
*args
, PyObject
*kwds
)
977 wrapperfunc wrapper
= wp
->descr
->d_base
->wrapper
;
978 PyObject
*self
= wp
->self
;
980 if (wp
->descr
->d_base
->flags
& PyWrapperFlag_KEYWORDS
) {
981 wrapperfunc_kwds wk
= (wrapperfunc_kwds
)wrapper
;
982 return (*wk
)(self
, args
, wp
->descr
->d_wrapped
, kwds
);
985 if (kwds
!= NULL
&& (!PyDict_Check(kwds
) || PyDict_Size(kwds
) != 0)) {
986 PyErr_Format(PyExc_TypeError
,
987 "wrapper %s doesn't take keyword arguments",
988 wp
->descr
->d_base
->name
);
991 return (*wrapper
)(self
, args
, wp
->descr
->d_wrapped
);
995 wrapper_traverse(PyObject
*self
, visitproc visit
, void *arg
)
997 wrapperobject
*wp
= (wrapperobject
*)self
;
1003 static PyTypeObject wrappertype
= {
1004 PyVarObject_HEAD_INIT(&PyType_Type
, 0)
1005 "method-wrapper", /* tp_name */
1006 sizeof(wrapperobject
), /* tp_basicsize */
1007 0, /* tp_itemsize */
1009 (destructor
)wrapper_dealloc
, /* tp_dealloc */
1013 (cmpfunc
)wrapper_compare
, /* tp_compare */
1014 (reprfunc
)wrapper_repr
, /* tp_repr */
1015 0, /* tp_as_number */
1016 0, /* tp_as_sequence */
1017 0, /* tp_as_mapping */
1018 (hashfunc
)wrapper_hash
, /* tp_hash */
1019 (ternaryfunc
)wrapper_call
, /* tp_call */
1021 PyObject_GenericGetAttr
, /* tp_getattro */
1022 0, /* tp_setattro */
1023 0, /* tp_as_buffer */
1024 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_GC
, /* tp_flags */
1026 wrapper_traverse
, /* tp_traverse */
1028 0, /* tp_richcompare */
1029 0, /* tp_weaklistoffset */
1031 0, /* tp_iternext */
1033 wrapper_members
, /* tp_members */
1034 wrapper_getsets
, /* tp_getset */
1037 0, /* tp_descr_get */
1038 0, /* tp_descr_set */
1042 PyWrapper_New(PyObject
*d
, PyObject
*self
)
1045 PyWrapperDescrObject
*descr
;
1047 assert(PyObject_TypeCheck(d
, &PyWrapperDescr_Type
));
1048 descr
= (PyWrapperDescrObject
*)d
;
1049 assert(PyObject_IsInstance(self
, (PyObject
*)(descr
->d_type
)));
1051 wp
= PyObject_GC_New(wrapperobject
, &wrappertype
);
1057 _PyObject_GC_TRACK(wp
);
1059 return (PyObject
*)wp
;
1063 /* A built-in 'property' type */
1066 class property(object):
1068 def __init__(self, fget=None, fset=None, fdel=None, doc=None):
1069 if doc is None and fget is not None and hasattr(fget, "__doc__"):
1076 def __get__(self, inst, type=None):
1079 if self.__get is None:
1080 raise AttributeError, "unreadable attribute"
1081 return self.__get(inst)
1083 def __set__(self, inst, value):
1084 if self.__set is None:
1085 raise AttributeError, "can't set attribute"
1086 return self.__set(inst, value)
1088 def __delete__(self, inst):
1089 if self.__del is None:
1090 raise AttributeError, "can't delete attribute"
1091 return self.__del(inst)
1104 static PyObject
* property_copy(PyObject
*, PyObject
*, PyObject
*,
1105 PyObject
*, PyObject
*);
1107 static PyMemberDef property_members
[] = {
1108 {"fget", T_OBJECT
, offsetof(propertyobject
, prop_get
), READONLY
},
1109 {"fset", T_OBJECT
, offsetof(propertyobject
, prop_set
), READONLY
},
1110 {"fdel", T_OBJECT
, offsetof(propertyobject
, prop_del
), READONLY
},
1111 {"__doc__", T_OBJECT
, offsetof(propertyobject
, prop_doc
), READONLY
},
1116 PyDoc_STRVAR(getter_doc
,
1117 "Descriptor to change the getter on a property.");
1120 property_getter(PyObject
*self
, PyObject
*getter
)
1122 return property_copy(self
, getter
, NULL
, NULL
, NULL
);
1126 PyDoc_STRVAR(setter_doc
,
1127 "Descriptor to change the setter on a property.");
1130 property_setter(PyObject
*self
, PyObject
*setter
)
1132 return property_copy(self
, NULL
, setter
, NULL
, NULL
);
1136 PyDoc_STRVAR(deleter_doc
,
1137 "Descriptor to change the deleter on a property.");
1140 property_deleter(PyObject
*self
, PyObject
*deleter
)
1142 return property_copy(self
, NULL
, NULL
, deleter
, NULL
);
1146 static PyMethodDef property_methods
[] = {
1147 {"getter", property_getter
, METH_O
, getter_doc
},
1148 {"setter", property_setter
, METH_O
, setter_doc
},
1149 {"deleter", property_deleter
, METH_O
, deleter_doc
},
1155 property_dealloc(PyObject
*self
)
1157 propertyobject
*gs
= (propertyobject
*)self
;
1159 _PyObject_GC_UNTRACK(self
);
1160 Py_XDECREF(gs
->prop_get
);
1161 Py_XDECREF(gs
->prop_set
);
1162 Py_XDECREF(gs
->prop_del
);
1163 Py_XDECREF(gs
->prop_doc
);
1164 self
->ob_type
->tp_free(self
);
1168 property_descr_get(PyObject
*self
, PyObject
*obj
, PyObject
*type
)
1170 propertyobject
*gs
= (propertyobject
*)self
;
1172 if (obj
== NULL
|| obj
== Py_None
) {
1176 if (gs
->prop_get
== NULL
) {
1177 PyErr_SetString(PyExc_AttributeError
, "unreadable attribute");
1180 return PyObject_CallFunction(gs
->prop_get
, "(O)", obj
);
1184 property_descr_set(PyObject
*self
, PyObject
*obj
, PyObject
*value
)
1186 propertyobject
*gs
= (propertyobject
*)self
;
1187 PyObject
*func
, *res
;
1190 func
= gs
->prop_del
;
1192 func
= gs
->prop_set
;
1194 PyErr_SetString(PyExc_AttributeError
,
1196 "can't delete attribute" :
1197 "can't set attribute");
1201 res
= PyObject_CallFunction(func
, "(O)", obj
);
1203 res
= PyObject_CallFunction(func
, "(OO)", obj
, value
);
1211 property_copy(PyObject
*old
, PyObject
*get
, PyObject
*set
, PyObject
*del
,
1214 propertyobject
*pold
= (propertyobject
*)old
;
1215 propertyobject
*pnew
= NULL
;
1216 PyObject
*new, *type
;
1218 type
= PyObject_Type(old
);
1222 if (get
== NULL
|| get
== Py_None
) {
1224 get
= pold
->prop_get
? pold
->prop_get
: Py_None
;
1226 if (set
== NULL
|| set
== Py_None
) {
1228 set
= pold
->prop_set
? pold
->prop_set
: Py_None
;
1230 if (del
== NULL
|| del
== Py_None
) {
1232 del
= pold
->prop_del
? pold
->prop_del
: Py_None
;
1234 if (doc
== NULL
|| doc
== Py_None
) {
1236 doc
= pold
->prop_doc
? pold
->prop_doc
: Py_None
;
1239 new = PyObject_CallFunction(type
, "OOOO", get
, set
, del
, doc
);
1243 pnew
= (propertyobject
*)new;
1245 if (pold
->getter_doc
&& get
!= Py_None
) {
1246 PyObject
*get_doc
= PyObject_GetAttrString(get
, "__doc__");
1247 if (get_doc
!= NULL
) {
1248 Py_XDECREF(pnew
->prop_doc
);
1249 pnew
->prop_doc
= get_doc
; /* get_doc already INCREF'd by GetAttr */
1250 pnew
->getter_doc
= 1;
1259 property_init(PyObject
*self
, PyObject
*args
, PyObject
*kwds
)
1261 PyObject
*get
= NULL
, *set
= NULL
, *del
= NULL
, *doc
= NULL
;
1262 static char *kwlist
[] = {"fget", "fset", "fdel", "doc", 0};
1263 propertyobject
*prop
= (propertyobject
*)self
;
1265 if (!PyArg_ParseTupleAndKeywords(args
, kwds
, "|OOOO:property",
1266 kwlist
, &get
, &set
, &del
, &doc
))
1281 prop
->prop_get
= get
;
1282 prop
->prop_set
= set
;
1283 prop
->prop_del
= del
;
1284 prop
->prop_doc
= doc
;
1285 prop
->getter_doc
= 0;
1287 /* if no docstring given and the getter has one, use that one */
1288 if ((doc
== NULL
|| doc
== Py_None
) && get
!= NULL
) {
1289 PyObject
*get_doc
= PyObject_GetAttrString(get
, "__doc__");
1290 if (get_doc
!= NULL
) {
1291 Py_XDECREF(prop
->prop_doc
);
1292 prop
->prop_doc
= get_doc
; /* get_doc already INCREF'd by GetAttr */
1293 prop
->getter_doc
= 1;
1302 PyDoc_STRVAR(property_doc
,
1303 "property(fget=None, fset=None, fdel=None, doc=None) -> property attribute\n"
1305 "fget is a function to be used for getting an attribute value, and likewise\n"
1306 "fset is a function for setting, and fdel a function for del'ing, an\n"
1307 "attribute. Typical use is to define a managed attribute x:\n"
1308 "class C(object):\n"
1309 " def getx(self): return self._x\n"
1310 " def setx(self, value): self._x = value\n"
1311 " def delx(self): del self._x\n"
1312 " x = property(getx, setx, delx, \"I'm the 'x' property.\")\n"
1314 "Decorators make defining new properties or modifying existing ones easy:\n"
1315 "class C(object):\n"
1317 " def x(self): return self._x\n"
1319 " def x(self, value): self._x = value\n"
1321 " def x(self): del self._x\n"
1325 property_traverse(PyObject
*self
, visitproc visit
, void *arg
)
1327 propertyobject
*pp
= (propertyobject
*)self
;
1328 Py_VISIT(pp
->prop_get
);
1329 Py_VISIT(pp
->prop_set
);
1330 Py_VISIT(pp
->prop_del
);
1331 Py_VISIT(pp
->prop_doc
);
1335 PyTypeObject PyProperty_Type
= {
1336 PyVarObject_HEAD_INIT(&PyType_Type
, 0)
1337 "property", /* tp_name */
1338 sizeof(propertyobject
), /* tp_basicsize */
1339 0, /* tp_itemsize */
1341 property_dealloc
, /* tp_dealloc */
1347 0, /* tp_as_number */
1348 0, /* tp_as_sequence */
1349 0, /* tp_as_mapping */
1353 PyObject_GenericGetAttr
, /* tp_getattro */
1354 0, /* tp_setattro */
1355 0, /* tp_as_buffer */
1356 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_GC
|
1357 Py_TPFLAGS_BASETYPE
, /* tp_flags */
1358 property_doc
, /* tp_doc */
1359 property_traverse
, /* tp_traverse */
1361 0, /* tp_richcompare */
1362 0, /* tp_weaklistoffset */
1364 0, /* tp_iternext */
1365 property_methods
, /* tp_methods */
1366 property_members
, /* tp_members */
1370 property_descr_get
, /* tp_descr_get */
1371 property_descr_set
, /* tp_descr_set */
1372 0, /* tp_dictoffset */
1373 property_init
, /* tp_init */
1374 PyType_GenericAlloc
, /* tp_alloc */
1375 PyType_GenericNew
, /* tp_new */
1376 PyObject_GC_Del
, /* tp_free */