Skip to content

gh-101578: Amend PyErr_{Set,Get}RaisedException docs #101962

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

Merged
erlend-aasland merged 6 commits into from
Feb 19, 2023
Merged

gh-101578: Amend PyErr_{Set,Get}RaisedException docs #101962

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fd0dde1
gh-101578: Amend PyErr_{Set,Get}RaisedException docs
erlend-aasland Feb 16, 2023
415a70d
Address CAM's first round of review
erlend-aasland Feb 17, 2023
45ecfe5
Address CAM's second round of review
erlend-aasland Feb 17, 2023
02334f4
Move seealso to get API
erlend-aasland Feb 17, 2023
3cf91f8
Fixup seealo, hopefully for real this time
erlend-aasland Feb 17, 2023
fd94dd8
Update Doc/c-api/exceptions.rst
erlend-aasland Feb 19, 2023
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
Prev Previous commit
Next Next commit
Address CAM's first round of review
  • Loading branch information
@erlend-aasland
erlend-aasland committed Feb 17, 2023
commit 415a70d044e997e88abe3727cc4f030c87e49564
16 changes: 10 additions & 6 deletions Doc/c-api/exceptions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -408,7 +408,7 @@ Querying the error indicator
This function is used by code that needs to catch exceptions,
or code that needs to save and restore the error indicator temporarily.

Example::
For example::

{
PyObject *exc = PyErr_GetRaisedException();
Expand All @@ -418,10 +418,13 @@ Querying the error indicator
PyErr_SetRaisedException(exc);
}

Use :c:func:`PyErr_GetHandledException` to fetch the exception
currently being handled.
.. seealso::

.. seealso:: :c:func:`PyErr_SetRaisedException`
* :c:func:`PyErr_SetRaisedException`,
to set the current raised exception.

* :c:func:`PyErr_GetHandledException`,
to fetch the exception currently being handled.

Comment thread
erlend-aasland marked this conversation as resolved.
Outdated
.. versionadded:: 3.12

Expand All @@ -431,11 +434,12 @@ Querying the error indicator
Set *exc* as the exception currently being raised.
If another exception is already raised, it is cleared first.
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated

.. note::
.. caution::
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated

This call steals a reference to *exc*, which must be a valid exception.

.. seealso:: :c:func:`PyErr_GetRaisedException`
.. seealso:: :c:func:`PyErr_GetRaisedException`,
to save the current raised exception.

.. versionadded:: 3.12

Expand Down