pybind/pybind11
1
0
Fork 0
mirror of https://github.com/pybind/pybind11.git synced 2026-03-14 20:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add documentation entry for warnings (#5356)

Browse Source 
* [docs] Add entry for warnings

* Fix code formatting

* Update docs

* Fix issue with docs

* [skip ci] Minor edits.

---------

Co-authored-by: Ralf W. Grosse-Kunstleve <rgrossekunst@nvidia.com>
This commit is contained in:
Jan Iwaszkiewicz
2025-06-17 20:03:58 +02:00
committed by GitHub
parent f3bb00732d
commit e2f86af216
1 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/advanced/exceptions.rst
View File

@@ -328,6 +328,28 @@ Alternately, to ignore the error, call `PyErr_Clear
Any Python error must be thrown or cleared, or Python/pybind11 will be left in
an invalid state.
Handling warnings from the Python C API
=======================================
Wrappers for handling Python warnings are provided in ``pybind11/warnings.h``.
This header must be included explicitly; it is not transitively included via
``pybind11/pybind11.h``.
Warnings can be raised with the ``warn`` function:
.. code-block:: cpp
py::warnings::warn("This is a warning!", PyExc_Warning);
// Optionally, a `stack_level` can be specified.
py::warnings::warn("Another one!", PyExc_DeprecationWarning, 3);
New warning types can be registered at the module level using ``new_warning_type``:
.. code-block:: cpp
py::warnings::new_warning_type(m, "CustomWarning", PyExc_RuntimeWarning);
Chaining exceptions ('raise from')
==================================