Skip to content

gh-142186: all-local PEP-669 events #146182

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
markshannon merged 10 commits into from
Apr 22, 2026
Merged

gh-142186: all-local PEP-669 events #146182

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
07a26bd
Make PY_UNWIND available as a local event
P403n1x87 Dec 2, 2025
1a3e828
break local == instrumented assumption
P403n1x87 Dec 2, 2025
6d743f9
add DISABLE support for PY_UNWIND
P403n1x87 Mar 19, 2026
b5758b3
Make all PEP-669 events local
P403n1x87 Mar 19, 2026
3b8e1d5
rename PY_MONITORING_IS_LOCAL_EVENT -> PY_MONITORING_IS_UNGROUPED_EVENT
P403n1x87 Mar 19, 2026
8fb54fa
fix get_tools_for_instruction
P403n1x87 Mar 20, 2026
958595a
add blurb note
P403n1x87 Mar 23, 2026
7761135
keep local vs other separation
P403n1x87 Apr 18, 2026
5545d46
Merge branch 'main' into gh-142186-pep-669-all-local-events
P403n1x87 Apr 18, 2026
c6d23e9
add whatsnew entry
P403n1x87 Apr 21, 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
Next Next commit
Make PY_UNWIND available as a local event 
We make the PY_UNWIND monitoring event available as a code-local
event to allow trapping on function exit events when an exception
bubbles up. This complements the PY_RETURN event by allowing to
catch any function exit event.
  • Loading branch information
@P403n1x87
P403n1x87 committed Mar 19, 2026
commit 07a26bde9fb2832722c52f965741cb1ed9d54f78
11 changes: 7 additions & 4 deletions Include/cpython/monitoring.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ extern "C" {


/* Local events.
* These require bytecode instrumentation */
* Some of these require bytecode instrumentation */

#define PY_MONITORING_EVENT_PY_START 0
#define PY_MONITORING_EVENT_PY_RESUME 1
Expand All @@ -22,15 +22,18 @@ extern "C" {
#define PY_MONITORING_EVENT_BRANCH_LEFT 8
#define PY_MONITORING_EVENT_BRANCH_RIGHT 9
#define PY_MONITORING_EVENT_STOP_ITERATION 10
#define PY_MONITORING_EVENT_PY_UNWIND 11

// TODO: PY_UNWIND requires no instrumentation so this definition is not
// entirely correct.
#define PY_MONITORING_IS_INSTRUMENTED_EVENT(ev) \
((ev) < _PY_MONITORING_LOCAL_EVENTS)
((ev) <= _PY_MONITORING_LOCAL_EVENTS)


/* Other events, mainly exceptions */

#define PY_MONITORING_EVENT_RAISE 11
#define PY_MONITORING_EVENT_EXCEPTION_HANDLED 12
#define PY_MONITORING_EVENT_PY_UNWIND 13
#define PY_MONITORING_EVENT_RAISE 13
#define PY_MONITORING_EVENT_PY_THROW 14
#define PY_MONITORING_EVENT_RERAISE 15

Expand Down
2 changes: 1 addition & 1 deletion Include/internal/pycore_instruments.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ PyAPI_DATA(PyObject) _PyInstrumentation_DISABLE;
/* Total tool ids available */
#define PY_MONITORING_TOOL_IDS 8
/* Count of all local monitoring events */
#define _PY_MONITORING_LOCAL_EVENTS 11
#define _PY_MONITORING_LOCAL_EVENTS 12
/* Count of all "real" monitoring events (not derived from other events) */
#define _PY_MONITORING_UNGROUPED_EVENTS 16
/* Count of all monitoring events */
Expand Down
2 changes: 1 addition & 1 deletion Python/ceval.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ monitor_unwind(PyThreadState *tstate,
_PyInterpreterFrame *frame,
_Py_CODEUNIT *instr)
{
if (no_tools_for_global_event(tstate, PY_MONITORING_EVENT_PY_UNWIND)) {
if (no_tools_for_local_event(tstate, frame, PY_MONITORING_EVENT_PY_UNWIND)) {
return;
}
do_monitor_exc(tstate, frame, instr, PY_MONITORING_EVENT_PY_UNWIND);
Expand Down