Skip to content

gh-144748: Document 3.12 and 3.14 changes to PyErr_CheckSignals #144982

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
ZeroIntensity merged 5 commits into from
Feb 21, 2026
Merged

gh-144748: Document 3.12 and 3.14 changes to PyErr_CheckSignals #144982

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c34616c
Add note about the GC and remote debugging to PyErr_CheckSignals().
ZeroIntensity Feb 19, 2026
b63b5d7
Update Doc/c-api/exceptions.rst
ZeroIntensity Feb 19, 2026
80a26ef
Remove old content from bad suggestion
encukou Feb 20, 2026
3f295d7
Convert note to a more friendly example
encukou Feb 20, 2026
f1c162e
Update Doc/c-api/exceptions.rst
ZeroIntensity Feb 20, 2026
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
12 changes: 10 additions & 2 deletions Doc/c-api/exceptions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -686,8 +686,9 @@ Signal Handling
other pending signals may not have been handled yet: they will be on the
next :c:func:`PyErr_CheckSignals()` invocation).

If the function is called from a non-main thread, or under a non-main
Python interpreter, it does nothing and returns ``0``.
This function may invoke the garbage collector or execute a :ref:`remote
debugger <remote-debugging>` script, regardless of the calling thread
or Python interpreter.

This function can be called by long-running C code that wants to
be interruptible by user requests (such as by pressing Ctrl-C).
Expand All @@ -696,6 +697,13 @@ Signal Handling
The default Python signal handler for :c:macro:`!SIGINT` raises the
:exc:`KeyboardInterrupt` exception.

.. versionchanged:: 3.12
This function may now invoke the garbage collector.

.. versionchanged:: 3.14
This function may now execute a remote debugger script, if remote
debugging is enabled.

Comment thread
ZeroIntensity marked this conversation as resolved.
Outdated

.. c:function:: void PyErr_SetInterrupt()

Expand Down
Loading