From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Sun, 9 Nov 2025 17:20:24 +0000 (+0100)
Subject: [3.14] gh-141004: Document `PyExceptionInstance*` APIs (GH-141301) (GH-141302)
X-Git-Tag: v3.14.1~176
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=42878e862a012398178cf3d5eaee0d3b30822b12;p=thirdparty%2FPython%2Fcpython.git

[3.14] gh-141004: Document `PyExceptionInstance*` APIs (GH-141301) (GH-141302)

gh-141004: Document `PyExceptionInstance*` APIs (GH-141301)
(cherry picked from commit b5a0c72492800c7e999b87adfcfeabaacb4ecb97)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
---

diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst
index c58aa659e1b1..5241533e1128 100644
--- a/Doc/c-api/exceptions.rst
+++ b/Doc/c-api/exceptions.rst
@@ -788,6 +788,17 @@ Exception Classes
 Exception Objects
 =================
 
+.. c:function:: int PyExceptionInstance_Check(PyObject *op)
+
+   Return true if *op* is an instance of :class:`BaseException`, false
+   otherwise. This function always succeeds.
+
+
+.. c:macro:: PyExceptionInstance_Class(op)
+
+   Equivalent to :c:func:`Py_TYPE(op) <Py_TYPE>`.
+
+
 .. c:function:: PyObject* PyException_GetTraceback(PyObject *ex)
 
    Return the traceback associated with the exception as a new reference, as