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
Prev Previous commit
Next Next commit
Update Doc/c-api/exceptions.rst 
Co-authored-by: Petr Viktorin <[email protected]>
  • Loading branch information
@ZeroIntensity @encukou
ZeroIntensity and encukou authored Feb 19, 2026
commit b63b5d71e6df6d458b1e0cda55f491944fcb8fc1
38 changes: 38 additions & 0 deletions Doc/c-api/exceptions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -703,6 +703,44 @@
.. versionchanged:: 3.14
This function may now execute a remote debugger script, if remote
debugging is enabled.
Handle external interruptions, such as signals (including :kbd:`Ctrl-C`),

Check warning on line 706 in Doc/c-api/exceptions.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

Explicit markup ends without a blank line; unexpected unindent. [docutils]
or activating a debugger, whose processing has been delayed until it is safe
to run Python code and/or raise exceptions.
The function should be called by long-running C code frequently
enough so that the response appears immediate to humans.

Handlers invoked by this function currently include:

- Signal handlers, including Python functions registered using
the :mod:`signal` module.

Signal handlers are only run in the main thread of the main interpreter.

(This is where the function got the name: originally, signals
were the only way to interrupt the interpreter.)

- Running the garbage collector, if necessary.

- Execuing a pending :ref:`remote debugger <remote-debugging>` script.

If any handler raises an exception, immediately return ``-1`` with that
exception set.
Any remaining interruptions are left to be processed on the next
:c:func:`PyErr_CheckSignals()` invocation, if appropriate.

If all handlers finish successfully, or there are no handlers to run,
return ``0``.

.. note::
The default Python signal handler for :py:data:`signal.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.


.. c:function:: void PyErr_SetInterrupt()
Expand Down
Loading