From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Fri, 20 Jun 2025 14:03:46 +0000 (+0200)
Subject: [3.14] Docs: Document `PyExceptionClass` functions in the C API (GH-135697) (GH-135757)
X-Git-Tag: v3.14.0b4~127
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=bd24261728e6b3c0c383746b72ad3ef34ed07bf1;p=thirdparty%2FPython%2Fcpython.git

[3.14] Docs: Document `PyExceptionClass` functions in the C API (GH-135697) (GH-135757)

Docs: Document `PyExceptionClass` functions in the C API (GH-135697)

* Docs: Document `PyExceptionClass_Name`

`PyExceptionClass_Name` is an undocumented function in the limited API.

* Document `PyExceptionClass_Check`
(cherry picked from commit 59963e866a1bb8128a50cd53d1b13eeab03df06e)

Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
---

diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst
index 885dbeb75303..a750cda3e2d4 100644
--- a/Doc/c-api/exceptions.rst
+++ b/Doc/c-api/exceptions.rst
@@ -749,6 +749,16 @@ Exception Classes
    .. versionadded:: 3.2
 
 
+.. c:function:: int PyExceptionClass_Check(PyObject *ob)
+
+   Return non-zero if *ob* is an exception class, zero otherwise. This function always succeeds.
+
+
+.. c:function:: const char *PyExceptionClass_Name(PyObject *ob)
+
+   Return :c:member:`~PyTypeObject.tp_name` of the exception class *ob*.
+
+
 Exception Objects
 =================