mirror of
https://github.com/python/cpython.git
synced 2025-11-24 20:30:18 +00:00
6e659bf645
Some checks failed
Tests / Change detection (push) Waiting to run
Tests / Docs (push) Blocked by required conditions
Tests / (push) Blocked by required conditions
Tests / Sanitizers (push) Blocked by required conditions
Tests / Cross build Linux (push) Blocked by required conditions
Tests / Windows MSI (push) Blocked by required conditions
Tests / Check if the ABI has changed (push) Blocked by required conditions
Tests / Check if Autoconf files are up to date (push) Blocked by required conditions
Tests / Check if generated files are up to date (push) Blocked by required conditions
Tests / Ubuntu SSL tests with OpenSSL (push) Blocked by required conditions
Tests / Android (aarch64) (push) Blocked by required conditions
Tests / Android (x86_64) (push) Blocked by required conditions
Tests / iOS (push) Blocked by required conditions
Tests / WASI (push) Blocked by required conditions
Tests / Hypothesis tests on Ubuntu (push) Blocked by required conditions
Tests / Address sanitizer (push) Blocked by required conditions
Tests / CIFuzz (push) Blocked by required conditions
Tests / All required checks pass (push) Blocked by required conditions
Lint / lint (push) Waiting to run
Tail calling interpreter / aarch64-apple-darwin/clang (push) Has been cancelled
Tail calling interpreter / aarch64-unknown-linux-gnu/gcc (push) Has been cancelled
Tail calling interpreter / x86_64-pc-windows-msvc/msvc (push) Has been cancelled
Tail calling interpreter / x86_64-apple-darwin/clang (push) Has been cancelled
Tail calling interpreter / free-threading (push) Has been cancelled
Tail calling interpreter / x86_64-unknown-linux-gnu/gcc (push) Has been cancelled
gh-141004: Document `PySuper_Type` (GH-141315)
(cherry picked from commit 14c62227f9)
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
82 lines
2.3 KiB
ReStructuredText
82 lines
2.3 KiB
ReStructuredText
.. highlight:: 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!
|
|
|
|
.. c:var:: PyTypeObject PyProperty_Type
|
|
|
|
The type object for the built-in descriptor types.
|
|
|
|
|
|
.. c:function:: PyObject* PyDescr_NewGetSet(PyTypeObject *type, struct PyGetSetDef *getset)
|
|
|
|
|
|
.. c:function:: PyObject* PyDescr_NewMember(PyTypeObject *type, struct PyMemberDef *meth)
|
|
|
|
|
|
.. c:function:: PyObject* PyDescr_NewMethod(PyTypeObject *type, struct PyMethodDef *meth)
|
|
|
|
|
|
.. c:function:: PyObject* PyDescr_NewWrapper(PyTypeObject *type, struct wrapperbase *wrapper, void *wrapped)
|
|
|
|
|
|
.. c:function:: PyObject* PyDescr_NewClassMethod(PyTypeObject *type, PyMethodDef *method)
|
|
|
|
|
|
.. c:function:: int PyDescr_IsData(PyObject *descr)
|
|
|
|
Return non-zero if the descriptor object *descr* describes a data attribute, or
|
|
``0`` if it describes a method. *descr* must be a descriptor object; there is
|
|
no error checking.
|
|
|
|
|
|
.. c:function:: PyObject* PyWrapper_New(PyObject *, PyObject *)
|
|
|
|
|
|
Built-in descriptors
|
|
^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. c:var:: PyTypeObject PySuper_Type
|
|
|
|
The type object for super objects. This is the same object as
|
|
:class:`super` in the Python layer.
|
|
|
|
|
|
.. c:var:: PyTypeObject PyClassMethod_Type
|
|
|
|
The type of class method objects. This is the same object as
|
|
:class:`classmethod` in the Python layer.
|
|
|
|
|
|
.. c:function:: PyObject *PyClassMethod_New(PyObject *callable)
|
|
|
|
Create a new :class:`classmethod` object wrapping *callable*.
|
|
*callable* must be a callable object and must not be ``NULL``.
|
|
|
|
On success, this function returns a :term:`strong reference` to a new class
|
|
method descriptor. On failure, this function returns ``NULL`` with an
|
|
exception set.
|
|
|
|
|
|
.. c:var:: PyTypeObject PyStaticMethod_Type
|
|
|
|
The type of static method objects. This is the same object as
|
|
:class:`staticmethod` in the Python layer.
|
|
|
|
|
|
.. c:function:: PyObject *PyStaticMethod_New(PyObject *callable)
|
|
|
|
Create a new :class:`staticmethod` object wrapping *callable*.
|
|
*callable* must be a callable object and must not be ``NULL``.
|
|
|
|
On success, this function returns a :term:`strong reference` to a new static
|
|
method descriptor. On failure, this function returns ``NULL`` with an
|
|
exception set.
|
|
|