[3.13] Docs: Document PyExceptionClass functions in the C API (GH-135697) (GH-135758)
Some checks are pending
Tests / Windows MSI (push) Blocked by required conditions
Tests / (push) Blocked by required conditions
Tests / Change detection (push) Waiting to run
Tests / Docs (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 / 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

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 59963e866a)

Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
This commit is contained in:
Miss Islington (bot) 2025-06-20 16:03:10 +02:00 committed by GitHub
parent a8c3af080a
commit c6e26ef881
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -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
=================