Issue 13673: PyTraceBack_Print() fails if signal received but PyErr_CheckSignals() not called (original) (raw)
Created on 2011-12-28 21:34 by sbt, last changed 2022-04-11 14:57 by admin.
Messages (7)
Author: Richard Oudkerk (sbt) * 
Date: 2011-12-28 21:34
If SIGINT arrives while a function implemented in C is executing, then it prevents the function from raising an exception unless the function first calls PyErr_CheckSignals(). (If the function returns an object (instead of NULL) then KeyboardInterrupt is raised as expected.)
For example, the following function just spins for 5 seconds before raising RuntimeError:
static PyObject * testsigint_wait(PyObject *self, PyObject arg) { clock_t start = clock(); while (clock() - start < 5 * CLOCKS_PER_SEC) { / pass */ } //PyErr_CheckSignals(); PyErr_SetNone(PyExc_RuntimeError); return NULL; }
If I call this function and press Ctrl-C before it completes, then I get the following:
import testsigint a = testsigint.wait() ^C>>> print(a) Traceback (most recent call last): File "", line 1, in NameError: name 'a' is not defined
So the call failed, but no exception was raised, and the variable "a" was not set!
I would have expected RuntimeError (or KeyboardInterrupt) to be raised. If I uncomment the PyErr_CheckSignals() line then I get RuntimeError as expected:
import testsigint a = testsigint.wait() ^CTraceback (most recent call last): File "", line 1, in RuntimeError
Also, if I wrap the call in try...finally or try...except, I get a sensible "chained" traceback:
try: ... testsigint.wait() ... finally: ... print("done") ... ^CTraceback (most recent call last): File "", line 2, in RuntimeError
During handling of the above exception, another exception occurred:
Traceback (most recent call last): File "", line 2, in KeyboardInterrupt
(Tested under Linux and Windows with the default branch.)
Author: Richard Oudkerk (sbt) *
Date: 2011-12-29 12:25
I have tried the same with Python 2.7.1 on Linux. The problem is the same, but one gets a partial traceback with no exception:
import sys, testsigint testsigint.wait() ^CTraceback (most recent call last): File "", line 1, in
sys.last_value RuntimeError()
Both on 2.7 and 3.3 sys.last_value gives RuntimeError().
Author: Richard Oudkerk (sbt) *
Date: 2011-12-29 14:58
I think I have found the problem. PyTraceBack_Print() calls PyFile_WriteString(), which calls PyFile_WriteObject(), which calls PyObject_Str() which begins with
PyObject_Str(PyObject *v) { PyObject *res; if (PyErr_CheckSignals()) return NULL; ...
Since PyErr_CheckSignals() returns -1, PyTraceBack_Print() fails.
(Changed title.)
Author: Richard Oudkerk (sbt) *
Date: 2011-12-29 18:19
Attached is a patch for the default branch.
Before calling PyFile_WriteString() the patch saves the current exception. Then it calls PyErr_CheckSignals() and clears the current exception if any. After calling PyFile_WriteString() the exception is restored.
I am not sure this is an appropriate fix.
Author: Antoine Pitrou (pitrou) *
Date: 2011-12-29 18:40
I think calling PyErr_WriteUnraisable would be more appropriate than PyErr_Clear. I also wonder whether it's ok to ignore the exception. Pressing e.g. Ctrl-C generally shouldn't fail to stop the program, even if another exception is being processed at that moment. (of course, you could argue this is already the case when e.g. the signal is received while in a del)
Author: Richard Oudkerk (sbt) *
Date: 2011-12-29 22:08
I think calling PyErr_WriteUnraisable would be more appropriate than PyErr_Clear.
You mean just adding
PyErr_CheckSignals();
if (PyErr_Occurred())
PyErr_WriteUnraisable(NULL);before the call to PyFile_WriteString()? That seems to work:
from testsigint import *; wait() ^CException KeyboardInterrupt ignored Traceback (most recent call last): File "", line 1, in RuntimeError
I also wonder whether it's ok to ignore the exception. Pressing e.g. Ctrl-C generally shouldn't fail to stop the program, even if another exception is being processed at that moment.
The ignoring and clearing of exceptions also happens higher (lower?) in the call stack in print_exception() and print_exception_recursive(). For example, print_exception() ends with
/* If an error happened here, don't show it.
XXX This is wrong, but too many callers rely on this behavior. */
if (err != 0)
PyErr_Clear();}
Author: Richard Oudkerk (sbt) *
Date: 2012-01-08 16:07
Trivial 3 lines patch.
I guess there is still a race: if Ctrl-C is pressed after PyErr_CheckSignals() is called but before PyObject_Str() then the printing of any exception can still be suppressed.
History
Date
User
Action
Args
2022-04-11 14:57:25
admin
set
github: 57882
2015-10-13 04:38:39
martin.panter
set
messages: -
2015-10-13 04:38:37
martin.panter
set
messages: -
2013-04-03 10:41:05
sbt
set
messages: +
2013-04-03 10:39:44
sbt
set
files: - input-ctrlc.patch
2013-04-03 10:39:03
sbt
set
files: + input-ctrlc.patch
messages: +
2012-01-08 16:07:57
sbt
set
files: + traceback_checksignals_2.patch
messages: +
2011-12-29 22:08:55
sbt
set
messages: +
2011-12-29 18:40:09
pitrou
set
nosy: + amaury.forgeotdarc, pitrou
messages: +
stage: patch review
2011-12-29 18:19:38
sbt
set
files: + traceback_checksignals.patch
keywords: + patch
messages: +
components: + Interpreter Core
2011-12-29 14:58:57
sbt
set
type: behavior
title: SIGINT prevents raising of exceptions unless PyErr_CheckSignals() called -> PyTraceBack_Print() fails if signal received but PyErr_CheckSignals() not called
messages: +
versions: + Python 2.7, Python 3.2
2011-12-29 12:25:24
sbt
set
messages: +
2011-12-28 21:34:59
sbt
create