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_RealIsSubclass((PyObject
*)Py_TYPE(self
),
228 (PyObject
*)(descr
->d_type
))) {
229 PyErr_Format(PyExc_TypeError
,
230 "descriptor '%.200s' "
231 "requires a '%.100s' object "
232 "but received a '%.100s'",
233 descr_name((PyDescrObject
*)descr
),
234 descr
->d_type
->tp_name
,
235 self
->ob_type
->tp_name
);
239 func
= PyCFunction_New(descr
->d_method
, self
);
242 args
= PyTuple_GetSlice(args
, 1, argc
);
247 result
= PyEval_CallObjectWithKeywords(func
, args
, kwds
);
254 classmethoddescr_call(PyMethodDescrObject
*descr
, PyObject
*args
,
257 PyObject
*func
, *result
;
259 func
= PyCFunction_New(descr
->d_method
, (PyObject
*)descr
->d_type
);
263 result
= PyEval_CallObjectWithKeywords(func
, args
, kwds
);
269 wrapperdescr_call(PyWrapperDescrObject
*descr
, PyObject
*args
, PyObject
*kwds
)
272 PyObject
*self
, *func
, *result
;
274 /* Make sure that the first argument is acceptable as 'self' */
275 assert(PyTuple_Check(args
));
276 argc
= PyTuple_GET_SIZE(args
);
278 PyErr_Format(PyExc_TypeError
,
279 "descriptor '%.300s' of '%.100s' "
280 "object needs an argument",
281 descr_name((PyDescrObject
*)descr
),
282 descr
->d_type
->tp_name
);
285 self
= PyTuple_GET_ITEM(args
, 0);
286 if (!_PyObject_RealIsSubclass((PyObject
*)Py_TYPE(self
),
287 (PyObject
*)(descr
->d_type
))) {
288 PyErr_Format(PyExc_TypeError
,
289 "descriptor '%.200s' "
290 "requires a '%.100s' object "
291 "but received a '%.100s'",
292 descr_name((PyDescrObject
*)descr
),
293 descr
->d_type
->tp_name
,
294 self
->ob_type
->tp_name
);
298 func
= PyWrapper_New((PyObject
*)descr
, self
);
301 args
= PyTuple_GetSlice(args
, 1, argc
);
306 result
= PyEval_CallObjectWithKeywords(func
, args
, kwds
);
313 method_get_doc(PyMethodDescrObject
*descr
, void *closure
)
315 if (descr
->d_method
->ml_doc
== NULL
) {
319 return PyString_FromString(descr
->d_method
->ml_doc
);
322 static PyMemberDef descr_members
[] = {
323 {"__objclass__", T_OBJECT
, offsetof(PyDescrObject
, d_type
), READONLY
},
324 {"__name__", T_OBJECT
, offsetof(PyDescrObject
, d_name
), READONLY
},
328 static PyGetSetDef method_getset
[] = {
329 {"__doc__", (getter
)method_get_doc
},
334 member_get_doc(PyMemberDescrObject
*descr
, void *closure
)
336 if (descr
->d_member
->doc
== NULL
) {
340 return PyString_FromString(descr
->d_member
->doc
);
343 static PyGetSetDef member_getset
[] = {
344 {"__doc__", (getter
)member_get_doc
},
349 getset_get_doc(PyGetSetDescrObject
*descr
, void *closure
)
351 if (descr
->d_getset
->doc
== NULL
) {
355 return PyString_FromString(descr
->d_getset
->doc
);
358 static PyGetSetDef getset_getset
[] = {
359 {"__doc__", (getter
)getset_get_doc
},
364 wrapperdescr_get_doc(PyWrapperDescrObject
*descr
, void *closure
)
366 if (descr
->d_base
->doc
== NULL
) {
370 return PyString_FromString(descr
->d_base
->doc
);
373 static PyGetSetDef wrapperdescr_getset
[] = {
374 {"__doc__", (getter
)wrapperdescr_get_doc
},
379 descr_traverse(PyObject
*self
, visitproc visit
, void *arg
)
381 PyDescrObject
*descr
= (PyDescrObject
*)self
;
382 Py_VISIT(descr
->d_type
);
386 static PyTypeObject PyMethodDescr_Type
= {
387 PyVarObject_HEAD_INIT(&PyType_Type
, 0)
389 sizeof(PyMethodDescrObject
),
391 (destructor
)descr_dealloc
, /* tp_dealloc */
396 (reprfunc
)method_repr
, /* tp_repr */
397 0, /* tp_as_number */
398 0, /* tp_as_sequence */
399 0, /* tp_as_mapping */
401 (ternaryfunc
)methoddescr_call
, /* tp_call */
403 PyObject_GenericGetAttr
, /* tp_getattro */
405 0, /* tp_as_buffer */
406 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_GC
, /* tp_flags */
408 descr_traverse
, /* tp_traverse */
410 0, /* tp_richcompare */
411 0, /* tp_weaklistoffset */
415 descr_members
, /* tp_members */
416 method_getset
, /* tp_getset */
419 (descrgetfunc
)method_get
, /* tp_descr_get */
420 0, /* tp_descr_set */
423 /* This is for METH_CLASS in C, not for "f = classmethod(f)" in Python! */
424 static PyTypeObject PyClassMethodDescr_Type
= {
425 PyVarObject_HEAD_INIT(&PyType_Type
, 0)
426 "classmethod_descriptor",
427 sizeof(PyMethodDescrObject
),
429 (destructor
)descr_dealloc
, /* tp_dealloc */
434 (reprfunc
)method_repr
, /* tp_repr */
435 0, /* tp_as_number */
436 0, /* tp_as_sequence */
437 0, /* tp_as_mapping */
439 (ternaryfunc
)classmethoddescr_call
, /* tp_call */
441 PyObject_GenericGetAttr
, /* tp_getattro */
443 0, /* tp_as_buffer */
444 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_GC
, /* tp_flags */
446 descr_traverse
, /* tp_traverse */
448 0, /* tp_richcompare */
449 0, /* tp_weaklistoffset */
453 descr_members
, /* tp_members */
454 method_getset
, /* tp_getset */
457 (descrgetfunc
)classmethod_get
, /* tp_descr_get */
458 0, /* tp_descr_set */
461 PyTypeObject PyMemberDescr_Type
= {
462 PyVarObject_HEAD_INIT(&PyType_Type
, 0)
464 sizeof(PyMemberDescrObject
),
466 (destructor
)descr_dealloc
, /* tp_dealloc */
471 (reprfunc
)member_repr
, /* tp_repr */
472 0, /* tp_as_number */
473 0, /* tp_as_sequence */
474 0, /* tp_as_mapping */
478 PyObject_GenericGetAttr
, /* tp_getattro */
480 0, /* tp_as_buffer */
481 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_GC
, /* tp_flags */
483 descr_traverse
, /* tp_traverse */
485 0, /* tp_richcompare */
486 0, /* tp_weaklistoffset */
490 descr_members
, /* tp_members */
491 member_getset
, /* tp_getset */
494 (descrgetfunc
)member_get
, /* tp_descr_get */
495 (descrsetfunc
)member_set
, /* tp_descr_set */
498 PyTypeObject PyGetSetDescr_Type
= {
499 PyVarObject_HEAD_INIT(&PyType_Type
, 0)
501 sizeof(PyGetSetDescrObject
),
503 (destructor
)descr_dealloc
, /* tp_dealloc */
508 (reprfunc
)getset_repr
, /* tp_repr */
509 0, /* tp_as_number */
510 0, /* tp_as_sequence */
511 0, /* tp_as_mapping */
515 PyObject_GenericGetAttr
, /* tp_getattro */
517 0, /* tp_as_buffer */
518 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_GC
, /* tp_flags */
520 descr_traverse
, /* tp_traverse */
522 0, /* tp_richcompare */
523 0, /* tp_weaklistoffset */
527 descr_members
, /* tp_members */
528 getset_getset
, /* tp_getset */
531 (descrgetfunc
)getset_get
, /* tp_descr_get */
532 (descrsetfunc
)getset_set
, /* tp_descr_set */
535 PyTypeObject PyWrapperDescr_Type
= {
536 PyVarObject_HEAD_INIT(&PyType_Type
, 0)
537 "wrapper_descriptor",
538 sizeof(PyWrapperDescrObject
),
540 (destructor
)descr_dealloc
, /* tp_dealloc */
545 (reprfunc
)wrapperdescr_repr
, /* tp_repr */
546 0, /* tp_as_number */
547 0, /* tp_as_sequence */
548 0, /* tp_as_mapping */
550 (ternaryfunc
)wrapperdescr_call
, /* tp_call */
552 PyObject_GenericGetAttr
, /* tp_getattro */
554 0, /* tp_as_buffer */
555 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_GC
, /* tp_flags */
557 descr_traverse
, /* tp_traverse */
559 0, /* tp_richcompare */
560 0, /* tp_weaklistoffset */
564 descr_members
, /* tp_members */
565 wrapperdescr_getset
, /* tp_getset */
568 (descrgetfunc
)wrapperdescr_get
, /* tp_descr_get */
569 0, /* tp_descr_set */
572 static PyDescrObject
*
573 descr_new(PyTypeObject
*descrtype
, PyTypeObject
*type
, const char *name
)
575 PyDescrObject
*descr
;
577 descr
= (PyDescrObject
*)PyType_GenericAlloc(descrtype
, 0);
580 descr
->d_type
= type
;
581 descr
->d_name
= PyString_InternFromString(name
);
582 if (descr
->d_name
== NULL
) {
591 PyDescr_NewMethod(PyTypeObject
*type
, PyMethodDef
*method
)
593 PyMethodDescrObject
*descr
;
595 descr
= (PyMethodDescrObject
*)descr_new(&PyMethodDescr_Type
,
596 type
, method
->ml_name
);
598 descr
->d_method
= method
;
599 return (PyObject
*)descr
;
603 PyDescr_NewClassMethod(PyTypeObject
*type
, PyMethodDef
*method
)
605 PyMethodDescrObject
*descr
;
607 descr
= (PyMethodDescrObject
*)descr_new(&PyClassMethodDescr_Type
,
608 type
, method
->ml_name
);
610 descr
->d_method
= method
;
611 return (PyObject
*)descr
;
615 PyDescr_NewMember(PyTypeObject
*type
, PyMemberDef
*member
)
617 PyMemberDescrObject
*descr
;
619 descr
= (PyMemberDescrObject
*)descr_new(&PyMemberDescr_Type
,
622 descr
->d_member
= member
;
623 return (PyObject
*)descr
;
627 PyDescr_NewGetSet(PyTypeObject
*type
, PyGetSetDef
*getset
)
629 PyGetSetDescrObject
*descr
;
631 descr
= (PyGetSetDescrObject
*)descr_new(&PyGetSetDescr_Type
,
634 descr
->d_getset
= getset
;
635 return (PyObject
*)descr
;
639 PyDescr_NewWrapper(PyTypeObject
*type
, struct wrapperbase
*base
, void *wrapped
)
641 PyWrapperDescrObject
*descr
;
643 descr
= (PyWrapperDescrObject
*)descr_new(&PyWrapperDescr_Type
,
646 descr
->d_base
= base
;
647 descr
->d_wrapped
= wrapped
;
649 return (PyObject
*)descr
;
653 /* --- Readonly proxy for dictionaries (actually any mapping) --- */
655 /* This has no reason to be in this file except that adding new files is a
664 proxy_len(proxyobject
*pp
)
666 return PyObject_Size(pp
->dict
);
670 proxy_getitem(proxyobject
*pp
, PyObject
*key
)
672 return PyObject_GetItem(pp
->dict
, key
);
675 static PyMappingMethods proxy_as_mapping
= {
676 (lenfunc
)proxy_len
, /* mp_length */
677 (binaryfunc
)proxy_getitem
, /* mp_subscript */
678 0, /* mp_ass_subscript */
682 proxy_contains(proxyobject
*pp
, PyObject
*key
)
684 return PyDict_Contains(pp
->dict
, key
);
687 static PySequenceMethods proxy_as_sequence
= {
694 0, /* sq_ass_slice */
695 (objobjproc
)proxy_contains
, /* sq_contains */
696 0, /* sq_inplace_concat */
697 0, /* sq_inplace_repeat */
701 proxy_has_key(proxyobject
*pp
, PyObject
*key
)
703 int res
= PyDict_Contains(pp
->dict
, key
);
706 return PyBool_FromLong(res
);
710 proxy_get(proxyobject
*pp
, PyObject
*args
)
712 PyObject
*key
, *def
= Py_None
;
714 if (!PyArg_UnpackTuple(args
, "get", 1, 2, &key
, &def
))
716 return PyObject_CallMethod(pp
->dict
, "get", "(OO)", key
, def
);
720 proxy_keys(proxyobject
*pp
)
722 return PyMapping_Keys(pp
->dict
);
726 proxy_values(proxyobject
*pp
)
728 return PyMapping_Values(pp
->dict
);
732 proxy_items(proxyobject
*pp
)
734 return PyMapping_Items(pp
->dict
);
738 proxy_iterkeys(proxyobject
*pp
)
740 return PyObject_CallMethod(pp
->dict
, "iterkeys", NULL
);
744 proxy_itervalues(proxyobject
*pp
)
746 return PyObject_CallMethod(pp
->dict
, "itervalues", NULL
);
750 proxy_iteritems(proxyobject
*pp
)
752 return PyObject_CallMethod(pp
->dict
, "iteritems", NULL
);
755 proxy_copy(proxyobject
*pp
)
757 return PyObject_CallMethod(pp
->dict
, "copy", NULL
);
760 static PyMethodDef proxy_methods
[] = {
761 {"has_key", (PyCFunction
)proxy_has_key
, METH_O
,
762 PyDoc_STR("D.has_key(k) -> True if D has a key k, else False")},
763 {"get", (PyCFunction
)proxy_get
, METH_VARARGS
,
764 PyDoc_STR("D.get(k[,d]) -> D[k] if D.has_key(k), else d."
765 " d defaults to None.")},
766 {"keys", (PyCFunction
)proxy_keys
, METH_NOARGS
,
767 PyDoc_STR("D.keys() -> list of D's keys")},
768 {"values", (PyCFunction
)proxy_values
, METH_NOARGS
,
769 PyDoc_STR("D.values() -> list of D's values")},
770 {"items", (PyCFunction
)proxy_items
, METH_NOARGS
,
771 PyDoc_STR("D.items() -> list of D's (key, value) pairs, as 2-tuples")},
772 {"iterkeys", (PyCFunction
)proxy_iterkeys
, METH_NOARGS
,
773 PyDoc_STR("D.iterkeys() -> an iterator over the keys of D")},
774 {"itervalues",(PyCFunction
)proxy_itervalues
, METH_NOARGS
,
775 PyDoc_STR("D.itervalues() -> an iterator over the values of D")},
776 {"iteritems", (PyCFunction
)proxy_iteritems
, METH_NOARGS
,
777 PyDoc_STR("D.iteritems() ->"
778 " an iterator over the (key, value) items of D")},
779 {"copy", (PyCFunction
)proxy_copy
, METH_NOARGS
,
780 PyDoc_STR("D.copy() -> a shallow copy of D")},
785 proxy_dealloc(proxyobject
*pp
)
787 _PyObject_GC_UNTRACK(pp
);
793 proxy_getiter(proxyobject
*pp
)
795 return PyObject_GetIter(pp
->dict
);
799 proxy_str(proxyobject
*pp
)
801 return PyObject_Str(pp
->dict
);
805 proxy_traverse(PyObject
*self
, visitproc visit
, void *arg
)
807 proxyobject
*pp
= (proxyobject
*)self
;
813 proxy_compare(proxyobject
*v
, PyObject
*w
)
815 return PyObject_Compare(v
->dict
, w
);
819 proxy_richcompare(proxyobject
*v
, PyObject
*w
, int op
)
821 return PyObject_RichCompare(v
->dict
, w
, op
);
824 PyTypeObject PyDictProxy_Type
= {
825 PyVarObject_HEAD_INIT(&PyType_Type
, 0)
826 "dictproxy", /* tp_name */
827 sizeof(proxyobject
), /* tp_basicsize */
830 (destructor
)proxy_dealloc
, /* tp_dealloc */
834 (cmpfunc
)proxy_compare
, /* tp_compare */
836 0, /* tp_as_number */
837 &proxy_as_sequence
, /* tp_as_sequence */
838 &proxy_as_mapping
, /* tp_as_mapping */
841 (reprfunc
)proxy_str
, /* tp_str */
842 PyObject_GenericGetAttr
, /* tp_getattro */
844 0, /* tp_as_buffer */
845 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_GC
, /* tp_flags */
847 proxy_traverse
, /* tp_traverse */
849 (richcmpfunc
)proxy_richcompare
, /* tp_richcompare */
850 0, /* tp_weaklistoffset */
851 (getiterfunc
)proxy_getiter
, /* tp_iter */
853 proxy_methods
, /* tp_methods */
858 0, /* tp_descr_get */
859 0, /* tp_descr_set */
863 PyDictProxy_New(PyObject
*dict
)
867 pp
= PyObject_GC_New(proxyobject
, &PyDictProxy_Type
);
871 _PyObject_GC_TRACK(pp
);
873 return (PyObject
*)pp
;
877 /* --- Wrapper object for "slot" methods --- */
879 /* This has no reason to be in this file except that adding new files is a
884 PyWrapperDescrObject
*descr
;
889 wrapper_dealloc(wrapperobject
*wp
)
891 PyObject_GC_UnTrack(wp
);
892 Py_TRASHCAN_SAFE_BEGIN(wp
)
893 Py_XDECREF(wp
->descr
);
894 Py_XDECREF(wp
->self
);
896 Py_TRASHCAN_SAFE_END(wp
)
900 wrapper_compare(wrapperobject
*a
, wrapperobject
*b
)
902 if (a
->descr
== b
->descr
)
903 return PyObject_Compare(a
->self
, b
->self
);
905 return (a
->descr
< b
->descr
) ? -1 : 1;
909 wrapper_hash(wrapperobject
*wp
)
912 x
= _Py_HashPointer(wp
->descr
);
915 y
= PyObject_Hash(wp
->self
);
925 wrapper_repr(wrapperobject
*wp
)
927 return PyString_FromFormat("<method-wrapper '%s' of %s object at %p>",
928 wp
->descr
->d_base
->name
,
929 wp
->self
->ob_type
->tp_name
,
933 static PyMemberDef wrapper_members
[] = {
934 {"__self__", T_OBJECT
, offsetof(wrapperobject
, self
), READONLY
},
939 wrapper_objclass(wrapperobject
*wp
)
941 PyObject
*c
= (PyObject
*)wp
->descr
->d_type
;
948 wrapper_name(wrapperobject
*wp
)
950 char *s
= wp
->descr
->d_base
->name
;
952 return PyString_FromString(s
);
956 wrapper_doc(wrapperobject
*wp
)
958 char *s
= wp
->descr
->d_base
->doc
;
965 return PyString_FromString(s
);
969 static PyGetSetDef wrapper_getsets
[] = {
970 {"__objclass__", (getter
)wrapper_objclass
},
971 {"__name__", (getter
)wrapper_name
},
972 {"__doc__", (getter
)wrapper_doc
},
977 wrapper_call(wrapperobject
*wp
, PyObject
*args
, PyObject
*kwds
)
979 wrapperfunc wrapper
= wp
->descr
->d_base
->wrapper
;
980 PyObject
*self
= wp
->self
;
982 if (wp
->descr
->d_base
->flags
& PyWrapperFlag_KEYWORDS
) {
983 wrapperfunc_kwds wk
= (wrapperfunc_kwds
)wrapper
;
984 return (*wk
)(self
, args
, wp
->descr
->d_wrapped
, kwds
);
987 if (kwds
!= NULL
&& (!PyDict_Check(kwds
) || PyDict_Size(kwds
) != 0)) {
988 PyErr_Format(PyExc_TypeError
,
989 "wrapper %s doesn't take keyword arguments",
990 wp
->descr
->d_base
->name
);
993 return (*wrapper
)(self
, args
, wp
->descr
->d_wrapped
);
997 wrapper_traverse(PyObject
*self
, visitproc visit
, void *arg
)
999 wrapperobject
*wp
= (wrapperobject
*)self
;
1000 Py_VISIT(wp
->descr
);
1005 static PyTypeObject wrappertype
= {
1006 PyVarObject_HEAD_INIT(&PyType_Type
, 0)
1007 "method-wrapper", /* tp_name */
1008 sizeof(wrapperobject
), /* tp_basicsize */
1009 0, /* tp_itemsize */
1011 (destructor
)wrapper_dealloc
, /* tp_dealloc */
1015 (cmpfunc
)wrapper_compare
, /* tp_compare */
1016 (reprfunc
)wrapper_repr
, /* tp_repr */
1017 0, /* tp_as_number */
1018 0, /* tp_as_sequence */
1019 0, /* tp_as_mapping */
1020 (hashfunc
)wrapper_hash
, /* tp_hash */
1021 (ternaryfunc
)wrapper_call
, /* tp_call */
1023 PyObject_GenericGetAttr
, /* tp_getattro */
1024 0, /* tp_setattro */
1025 0, /* tp_as_buffer */
1026 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_GC
, /* tp_flags */
1028 wrapper_traverse
, /* tp_traverse */
1030 0, /* tp_richcompare */
1031 0, /* tp_weaklistoffset */
1033 0, /* tp_iternext */
1035 wrapper_members
, /* tp_members */
1036 wrapper_getsets
, /* tp_getset */
1039 0, /* tp_descr_get */
1040 0, /* tp_descr_set */
1044 PyWrapper_New(PyObject
*d
, PyObject
*self
)
1047 PyWrapperDescrObject
*descr
;
1049 assert(PyObject_TypeCheck(d
, &PyWrapperDescr_Type
));
1050 descr
= (PyWrapperDescrObject
*)d
;
1051 assert(_PyObject_RealIsSubclass((PyObject
*)Py_TYPE(self
),
1052 (PyObject
*)(descr
->d_type
)));
1054 wp
= PyObject_GC_New(wrapperobject
, &wrappertype
);
1060 _PyObject_GC_TRACK(wp
);
1062 return (PyObject
*)wp
;
1066 /* A built-in 'property' type */
1069 class property(object):
1071 def __init__(self, fget=None, fset=None, fdel=None, doc=None):
1072 if doc is None and fget is not None and hasattr(fget, "__doc__"):
1079 def __get__(self, inst, type=None):
1082 if self.__get is None:
1083 raise AttributeError, "unreadable attribute"
1084 return self.__get(inst)
1086 def __set__(self, inst, value):
1087 if self.__set is None:
1088 raise AttributeError, "can't set attribute"
1089 return self.__set(inst, value)
1091 def __delete__(self, inst):
1092 if self.__del is None:
1093 raise AttributeError, "can't delete attribute"
1094 return self.__del(inst)
1107 static PyObject
* property_copy(PyObject
*, PyObject
*, PyObject
*,
1110 static PyMemberDef property_members
[] = {
1111 {"fget", T_OBJECT
, offsetof(propertyobject
, prop_get
), READONLY
},
1112 {"fset", T_OBJECT
, offsetof(propertyobject
, prop_set
), READONLY
},
1113 {"fdel", T_OBJECT
, offsetof(propertyobject
, prop_del
), READONLY
},
1114 {"__doc__", T_OBJECT
, offsetof(propertyobject
, prop_doc
), READONLY
},
1119 PyDoc_STRVAR(getter_doc
,
1120 "Descriptor to change the getter on a property.");
1123 property_getter(PyObject
*self
, PyObject
*getter
)
1125 return property_copy(self
, getter
, NULL
, NULL
);
1129 PyDoc_STRVAR(setter_doc
,
1130 "Descriptor to change the setter on a property.");
1133 property_setter(PyObject
*self
, PyObject
*setter
)
1135 return property_copy(self
, NULL
, setter
, NULL
);
1139 PyDoc_STRVAR(deleter_doc
,
1140 "Descriptor to change the deleter on a property.");
1143 property_deleter(PyObject
*self
, PyObject
*deleter
)
1145 return property_copy(self
, NULL
, NULL
, deleter
);
1149 static PyMethodDef property_methods
[] = {
1150 {"getter", property_getter
, METH_O
, getter_doc
},
1151 {"setter", property_setter
, METH_O
, setter_doc
},
1152 {"deleter", property_deleter
, METH_O
, deleter_doc
},
1158 property_dealloc(PyObject
*self
)
1160 propertyobject
*gs
= (propertyobject
*)self
;
1162 _PyObject_GC_UNTRACK(self
);
1163 Py_XDECREF(gs
->prop_get
);
1164 Py_XDECREF(gs
->prop_set
);
1165 Py_XDECREF(gs
->prop_del
);
1166 Py_XDECREF(gs
->prop_doc
);
1167 self
->ob_type
->tp_free(self
);
1171 property_descr_get(PyObject
*self
, PyObject
*obj
, PyObject
*type
)
1173 propertyobject
*gs
= (propertyobject
*)self
;
1175 if (obj
== NULL
|| obj
== Py_None
) {
1179 if (gs
->prop_get
== NULL
) {
1180 PyErr_SetString(PyExc_AttributeError
, "unreadable attribute");
1183 return PyObject_CallFunction(gs
->prop_get
, "(O)", obj
);
1187 property_descr_set(PyObject
*self
, PyObject
*obj
, PyObject
*value
)
1189 propertyobject
*gs
= (propertyobject
*)self
;
1190 PyObject
*func
, *res
;
1193 func
= gs
->prop_del
;
1195 func
= gs
->prop_set
;
1197 PyErr_SetString(PyExc_AttributeError
,
1199 "can't delete attribute" :
1200 "can't set attribute");
1204 res
= PyObject_CallFunction(func
, "(O)", obj
);
1206 res
= PyObject_CallFunction(func
, "(OO)", obj
, value
);
1214 property_copy(PyObject
*old
, PyObject
*get
, PyObject
*set
, PyObject
*del
)
1216 propertyobject
*pold
= (propertyobject
*)old
;
1217 PyObject
*new, *type
, *doc
;
1219 type
= PyObject_Type(old
);
1223 if (get
== NULL
|| get
== Py_None
) {
1225 get
= pold
->prop_get
? pold
->prop_get
: Py_None
;
1227 if (set
== NULL
|| set
== Py_None
) {
1229 set
= pold
->prop_set
? pold
->prop_set
: Py_None
;
1231 if (del
== NULL
|| del
== Py_None
) {
1233 del
= pold
->prop_del
? pold
->prop_del
: Py_None
;
1235 if (pold
->getter_doc
&& get
!= Py_None
) {
1236 /* make _init use __doc__ from getter */
1240 doc
= pold
->prop_doc
? pold
->prop_doc
: Py_None
;
1243 new = PyObject_CallFunction(type
, "OOOO", get
, set
, del
, doc
);
1251 property_init(PyObject
*self
, PyObject
*args
, PyObject
*kwds
)
1253 PyObject
*get
= NULL
, *set
= NULL
, *del
= NULL
, *doc
= NULL
;
1254 static char *kwlist
[] = {"fget", "fset", "fdel", "doc", 0};
1255 propertyobject
*prop
= (propertyobject
*)self
;
1257 if (!PyArg_ParseTupleAndKeywords(args
, kwds
, "|OOOO:property",
1258 kwlist
, &get
, &set
, &del
, &doc
))
1273 prop
->prop_get
= get
;
1274 prop
->prop_set
= set
;
1275 prop
->prop_del
= del
;
1276 prop
->prop_doc
= doc
;
1277 prop
->getter_doc
= 0;
1279 /* if no docstring given and the getter has one, use that one */
1280 if ((doc
== NULL
|| doc
== Py_None
) && get
!= NULL
) {
1281 PyObject
*get_doc
= PyObject_GetAttrString(get
, "__doc__");
1283 if (Py_TYPE(self
) == &PyProperty_Type
) {
1284 Py_XDECREF(prop
->prop_doc
);
1285 prop
->prop_doc
= get_doc
;
1288 /* If this is a property subclass, put __doc__
1289 in dict of the subclass instance instead,
1290 otherwise it gets shadowed by __doc__ in the
1292 int err
= PyObject_SetAttrString(self
, "__doc__", get_doc
);
1297 prop
->getter_doc
= 1;
1299 else if (PyErr_ExceptionMatches(PyExc_Exception
)) {
1310 PyDoc_STRVAR(property_doc
,
1311 "property(fget=None, fset=None, fdel=None, doc=None) -> property attribute\n"
1313 "fget is a function to be used for getting an attribute value, and likewise\n"
1314 "fset is a function for setting, and fdel a function for del'ing, an\n"
1315 "attribute. Typical use is to define a managed attribute x:\n"
1316 "class C(object):\n"
1317 " def getx(self): return self._x\n"
1318 " def setx(self, value): self._x = value\n"
1319 " def delx(self): del self._x\n"
1320 " x = property(getx, setx, delx, \"I'm the 'x' property.\")\n"
1322 "Decorators make defining new properties or modifying existing ones easy:\n"
1323 "class C(object):\n"
1325 " def x(self): return self._x\n"
1327 " def x(self, value): self._x = value\n"
1329 " def x(self): del self._x\n"
1333 property_traverse(PyObject
*self
, visitproc visit
, void *arg
)
1335 propertyobject
*pp
= (propertyobject
*)self
;
1336 Py_VISIT(pp
->prop_get
);
1337 Py_VISIT(pp
->prop_set
);
1338 Py_VISIT(pp
->prop_del
);
1339 Py_VISIT(pp
->prop_doc
);
1343 PyTypeObject PyProperty_Type
= {
1344 PyVarObject_HEAD_INIT(&PyType_Type
, 0)
1345 "property", /* tp_name */
1346 sizeof(propertyobject
), /* tp_basicsize */
1347 0, /* tp_itemsize */
1349 property_dealloc
, /* tp_dealloc */
1355 0, /* tp_as_number */
1356 0, /* tp_as_sequence */
1357 0, /* tp_as_mapping */
1361 PyObject_GenericGetAttr
, /* tp_getattro */
1362 0, /* tp_setattro */
1363 0, /* tp_as_buffer */
1364 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_GC
|
1365 Py_TPFLAGS_BASETYPE
, /* tp_flags */
1366 property_doc
, /* tp_doc */
1367 property_traverse
, /* tp_traverse */
1369 0, /* tp_richcompare */
1370 0, /* tp_weaklistoffset */
1372 0, /* tp_iternext */
1373 property_methods
, /* tp_methods */
1374 property_members
, /* tp_members */
1378 property_descr_get
, /* tp_descr_get */
1379 property_descr_set
, /* tp_descr_set */
1380 0, /* tp_dictoffset */
1381 property_init
, /* tp_init */
1382 PyType_GenericAlloc
, /* tp_alloc */
1383 PyType_GenericNew
, /* tp_new */
1384 PyObject_GC_Del
, /* tp_free */