Skip to content

gh-142410: Soft-deprecate PyException_HEAD in C API docs #145391

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

Open
Krishna-web-hub wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −4
Open

gh-142410: Soft-deprecate PyException_HEAD in C API docs #145391

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 8 additions & 4 deletions Doc/c-api/exceptions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -795,11 +795,15 @@ Exception Classes

.. c:macro:: PyException_HEAD

This is a :term:`soft deprecated` macro including the base fields for an
exception object.
Include the base fields for an exception object.

This was included in Python's C API by mistake and is not designed for use
in extensions. For creating custom exception objects, use
.. deprecated:: 3.14
``PyException_HEAD`` is an internal implementation detail that was not
intended to be exposed as part of the python C API and is not designed
for use by third-party extensions.

The macro may be changed or removed in a future Python version.
Extensions authors should instead create exception class using
:c:func:`PyErr_NewException` or otherwise create a class inheriting from
:c:data:`PyExc_BaseException`.

Expand Down
3 changes: 3 additions & 0 deletions Misc/NEWS.d/next/Documentation/2026-03-01-19-54-44.gh-issue-142410.8f-dkN.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Soft-deprecate the ``PyException_HEAD`` macro in the C API documentation.
The macro is an internal implementation detail and should not be used by
third-party extensions.
Loading