summaryrefslogtreecommitdiffstats
path: root/Doc/c-api/descriptor.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2008-01-20 09:30:57 (GMT)
committerGeorg Brandl <georg@python.org>2008-01-20 09:30:57 (GMT)
commit54a3faae0806ab1dd8290e16acc8ab7acdd4762b (patch)
tree3f58890aaea549244ca64e911f8deee3ca5bd08d /Doc/c-api/descriptor.rst
parent135bf209ac9a44244a97fd3bf5ff638a320e1a43 (diff)
downloadcpython-54a3faae0806ab1dd8290e16acc8ab7acdd4762b.zip
cpython-54a3faae0806ab1dd8290e16acc8ab7acdd4762b.tar.gz
cpython-54a3faae0806ab1dd8290e16acc8ab7acdd4762b.tar.bz2
Split C API docs in Py3k branch.
Diffstat (limited to 'Doc/c-api/descriptor.rst')
-rw-r--r--Doc/c-api/descriptor.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/Doc/c-api/descriptor.rst b/Doc/c-api/descriptor.rst
new file mode 100644
index 0000000..5db2570
--- /dev/null
+++ b/Doc/c-api/descriptor.rst
@@ -0,0 +1,40 @@
+.. highlightlang:: c
+
+.. _descriptor-objects:
+
+Descriptor Objects
+------------------
+
+"Descriptors" are objects that describe some attribute of an object. They are
+found in the dictionary of type objects.
+
+.. XXX document these!
+
+.. cvar:: PyTypeObject PyProperty_Type
+
+ The type object for the built-in descriptor types.
+
+
+.. cfunction:: PyObject* PyDescr_NewGetSet(PyTypeObject *type, struct PyGetSetDef *getset)
+
+
+.. cfunction:: PyObject* PyDescr_NewMember(PyTypeObject *type, struct PyMemberDef *meth)
+
+
+.. cfunction:: PyObject* PyDescr_NewMethod(PyTypeObject *type, struct PyMethodDef *meth)
+
+
+.. cfunction:: PyObject* PyDescr_NewWrapper(PyTypeObject *type, struct wrapperbase *wrapper, void *wrapped)
+
+
+.. cfunction:: PyObject* PyDescr_NewClassMethod(PyTypeObject *type, PyMethodDef *method)
+
+
+.. cfunction:: int PyDescr_IsData(PyObject *descr)
+
+ Return true if the descriptor objects *descr* describes a data attribute, or
+ false if it describes a method. *descr* must be a descriptor object; there is
+ no error checking.
+
+
+.. cfunction:: PyObject* PyWrapper_New(PyObject *, PyObject *)