Descriptor Objects (original) (raw)

“Descriptors” are objects that describe some attribute of an object. They are found in the dictionary of type objects.

PyTypeObject PyProperty_Type¶

Part of the Stable ABI.

The type object for the built-in descriptor types.

PyObject *PyDescr_NewGetSet(PyTypeObject *type, struct PyGetSetDef *getset)¶

Return value: New reference. Part of the Stable ABI.

PyObject *PyDescr_NewMember(PyTypeObject *type, struct PyMemberDef *meth)¶

Return value: New reference. Part of the Stable ABI.

PyTypeObject PyMemberDescr_Type¶

Part of the Stable ABI.

The type object for member descriptor objects created fromPyMemberDef structures. These descriptors expose fields of a C struct as attributes on a type, and correspond to types.MemberDescriptorType objects in Python.

PyTypeObject PyGetSetDescr_Type¶

Part of the Stable ABI.

The type object for get/set descriptor objects created fromPyGetSetDef structures. These descriptors implement attributes whose value is computed by C getter and setter functions, and are used for many built-in type attributes.

PyObject *PyDescr_NewMethod(PyTypeObject *type, struct PyMethodDef *meth)¶

Return value: New reference. Part of the Stable ABI.

PyTypeObject PyMethodDescr_Type¶

Part of the Stable ABI.

The type object for method descriptor objects created fromPyMethodDef structures. These descriptors expose C functions as methods on a type, and correspond to types.MemberDescriptorTypeobjects in Python.

PyObject *PyDescr_NewWrapper(PyTypeObject *type, struct wrapperbase *wrapper, void *wrapped)¶

Return value: New reference.

PyTypeObject PyWrapperDescr_Type¶

Part of the Stable ABI.

The type object for wrapper descriptor objects created byPyDescr_NewWrapper() and PyWrapper_New(). Wrapper descriptors are used internally to expose special methods implemented via wrapper structures, and appear in Python astypes.WrapperDescriptorType objects.

PyObject *PyDescr_NewClassMethod(PyTypeObject *type, PyMethodDef *method)¶

Return value: New reference. Part of the Stable ABI.

int PyDescr_IsData(PyObject *descr)¶

Return non-zero if the descriptor object descr describes a data attribute, or0 if it describes a method. descr must be a descriptor object; there is no error checking.

PyObject *PyWrapper_New(PyObject*, PyObject*)¶

Return value: New reference. Part of the Stable ABI.

Built-in descriptors¶

PyTypeObject PySuper_Type¶

Part of the Stable ABI.

The type object for super objects. This is the same object assuper in the Python layer.

PyTypeObject PyClassMethod_Type¶

The type of class method objects. This is the same object asclassmethod in the Python layer.

PyTypeObject PyClassMethodDescr_Type¶

Part of the Stable ABI.

The type object for C-level class method descriptor objects. This is the type of the descriptors created for classmethod() defined in C extension types, and is the same object as classmethodin Python.

PyObject *PyClassMethod_New(PyObject *callable)¶

Create a new classmethod object wrapping callable.callable must be a callable object and must not be NULL.

On success, this function returns a strong reference to a new class method descriptor. On failure, this function returns NULL with an exception set.

PyTypeObject PyStaticMethod_Type¶

The type of static method objects. This is the same object asstaticmethod in the Python layer.

PyObject *PyStaticMethod_New(PyObject *callable)¶

Create a new staticmethod object wrapping callable.callable must be a callable object and must not be NULL.

On success, this function returns a strong reference to a new static method descriptor. On failure, this function returns NULL with an exception set.