GH-106898: Add the exception as an argument to the PY_UNWIND event callback function. (GH-107347)

markshannon · web-flow · commit ac7a0f858a8d · 2023-07-27T15:47:33.000+01:00
diff --git a/Lib/test/test_monitoring.py b/Lib/test/test_monitoring.py
@@ -715,7 +715,7 @@ def check_balanced(self, func, recorders):
             self.assertIn(r0, ("raise", "reraise"))
             h0 = h[0]
             self.assertIn(h0, ("handled", "unwind"))
-
+            self.assertEqual(r[1], h[1])
 
 
 class StopiterationRecorder(ExceptionRecorder):
@@ -733,8 +733,8 @@ class UnwindRecorder(ExceptionRecorder):
 
     event_type = E.PY_UNWIND
 
-    def __call__(self, *args):
-        self.events.append(("unwind", None))
+    def __call__(self, code, offset, exc):
+        self.events.append(("unwind", type(exc)))
 
 class ExceptionHandledRecorder(ExceptionRecorder):
 
diff --git a/Misc/NEWS.d/next/Core and Builtins/2023-07-26-21-28-06.gh-issue-106898.8Wjuiv.rst b/Misc/NEWS.d/next/Core and Builtins/2023-07-26-21-28-06.gh-issue-106898.8Wjuiv.rst
@@ -0,0 +1,3 @@
+Add the exception as the third argument to ``PY_UNIND`` callbacks in
+``sys.monitoring``. This makes the ``PY_UNWIND`` callback consistent with
+the other exception hanlding callbacks.
diff --git a/Python/ceval.c b/Python/ceval.c
@@ -1987,7 +1987,7 @@ monitor_unwind(PyThreadState *tstate,
     if (no_tools_for_event(tstate, frame, PY_MONITORING_EVENT_PY_UNWIND)) {
         return;
     }
-    _Py_call_instrumentation_exc0(tstate, PY_MONITORING_EVENT_PY_UNWIND, frame, instr);
+    do_monitor_exc(tstate, frame, instr, PY_MONITORING_EVENT_PY_UNWIND);
 }
 
 
diff --git a/Python/legacy_tracing.c b/Python/legacy_tracing.c
@@ -64,6 +64,16 @@ sys_profile_func3(
     return call_profile_func(self, args[2]);
 }
 
+static PyObject *
+sys_profile_unwind(
+    _PyLegacyEventHandler *self, PyObject *const *args,
+    size_t nargsf, PyObject *kwnames
+) {
+    assert(kwnames == NULL);
+    assert(PyVectorcall_NARGS(nargsf) == 3);
+    return call_profile_func(self, Py_None);
+}
+
 static PyObject *
 sys_profile_call_or_return(
     _PyLegacyEventHandler *self, PyObject *const *args,
@@ -152,6 +162,16 @@ sys_trace_func2(
     return call_trace_func(self, Py_None);
 }
 
+static PyObject *
+sys_trace_unwind(
+    _PyLegacyEventHandler *self, PyObject *const *args,
+    size_t nargsf, PyObject *kwnames
+) {
+    assert(kwnames == NULL);
+    assert(PyVectorcall_NARGS(nargsf) == 3);
+    return call_trace_func(self, Py_None);
+}
+
 static PyObject *
 sys_trace_return(
     _PyLegacyEventHandler *self, PyObject *const *args,
@@ -362,7 +382,7 @@ _PyEval_SetProfile(PyThreadState *tstate, Py_tracefunc func, PyObject *arg)
             return -1;
         }
         if (set_callbacks(PY_MONITORING_SYS_PROFILE_ID,
-            (vectorcallfunc)sys_profile_func2, PyTrace_RETURN,
+            (vectorcallfunc)sys_profile_unwind, PyTrace_RETURN,
                         PY_MONITORING_EVENT_PY_UNWIND, -1)) {
             return -1;
         }
@@ -450,7 +470,7 @@ _PyEval_SetTrace(PyThreadState *tstate, Py_tracefunc func, PyObject *arg)
             return -1;
         }
         if (set_callbacks(PY_MONITORING_SYS_TRACE_ID,
-            (vectorcallfunc)sys_trace_func2, PyTrace_RETURN,
+            (vectorcallfunc)sys_trace_unwind, PyTrace_RETURN,
                         PY_MONITORING_EVENT_PY_UNWIND, -1)) {
             return -1;
         }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+Add the exception as the third argument to ``PY_UNIND`` callbacks in
	`2`	+``sys.monitoring``. This makes the ``PY_UNWIND`` callback consistent with
	`3`	`+the other exception hanlding callbacks.`
Original file line number	Diff line number	Diff line change
`@@ -1987,7 +1987,7 @@ monitor_unwind(PyThreadState *tstate,`
`1987`	`1987`	`if (no_tools_for_event(tstate, frame, PY_MONITORING_EVENT_PY_UNWIND)) {`
`1988`	`1988`	`return;`
`1989`	`1989`	`}`
`1990`		`- _Py_call_instrumentation_exc0(tstate, PY_MONITORING_EVENT_PY_UNWIND, frame, instr);`
	`1990`	`+ do_monitor_exc(tstate, frame, instr, PY_MONITORING_EVENT_PY_UNWIND);`
`1991`	`1991`	`}`
`1992`	`1992`
`1993`	`1993`