Thanks to visit codestin.com
Credit goes to github.com

Skip to content

gh-141004: Document PyException_HEAD and PyDescr_COMMON #143896

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ZeroIntensity merged 4 commits into from
Jan 17, 2026
Merged

gh-141004: Document PyException_HEAD and PyDescr_COMMON #143896

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
65d6ced
Document PyException_HEAD
ZeroIntensity Jan 16, 2026
6898b42
Document PyDescr_COMMON
ZeroIntensity Jan 16, 2026
83011f7
Fix my stupid script.
ZeroIntensity Jan 17, 2026
8b54721
Merge branch 'main' into document-head-macros
ZeroIntensity Jan 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Document PyDescr_COMMON
  • Loading branch information
@ZeroIntensity
ZeroIntensity committed Jan 16, 2026
commit 6898b426a676290efbd7e65a4c00eb627f2df563
22 changes: 17 additions & 5 deletions Doc/c-api/descriptor.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,6 @@ 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)


Expand Down Expand Up @@ -74,9 +69,26 @@ found in the dictionary of type objects.
.. c:function:: PyObject* PyWrapper_New(PyObject *, PyObject *)


.. c:macro:: PyDescr_COMMON

This is a :term:`soft deprecated` macro including the common fields for a
descriptor object.

This was included in Python's C API by mistake; do not use it in extensions.
For creating custom descriptor objects, create a class implementing the
descriptor protocol (:c:member:`~PyTypeObject.tp_descr_get` and
:c:member:`~PyTypeObject.tp_descr_set`).


Built-in descriptors
^^^^^^^^^^^^^^^^^^^^

.. c:var:: PyTypeObject PyProperty_Type

The type object for property objects. This is the same object as
:class:`property` in the Python layer.


.. c:var:: PyTypeObject PySuper_Type

The type object for super objects. This is the same object as
Expand Down
Loading