gh-124872: Change PyContext_WatchCallback to take PyObject (#124737)

rhansen · web-flow · commit 330c527299a5 · 2024-10-12T13:57:27.000-07:00
The PyContext struct is not intended to be public, and users of the API don't need anything more specific than PyObject. Also see gh-78943.
diff --git a/Doc/c-api/contextvars.rst b/Doc/c-api/contextvars.rst
@@ -136,7 +136,7 @@ Context object management functions:
 
    .. versionadded:: 3.14
 
-.. c:type:: int (*PyContext_WatchCallback)(PyContextEvent event, PyContext* ctx)
+.. c:type:: int (*PyContext_WatchCallback)(PyContextEvent event, PyObject *obj)
 
    Context object watcher callback function.  The object passed to the callback
    is event-specific; see :c:type:`PyContextEvent` for details.
diff --git a/Include/cpython/context.h b/Include/cpython/context.h
@@ -52,7 +52,7 @@ typedef enum {
  * if the callback returns with an exception set, it must return -1. Otherwise
  * it should return 0
  */
-typedef int (*PyContext_WatchCallback)(PyContextEvent, PyContext *);
+typedef int (*PyContext_WatchCallback)(PyContextEvent, PyObject *);
 
 /*
  * Register a per-interpreter callback that will be invoked for context object
diff --git a/Modules/_testcapi/watchers.c b/Modules/_testcapi/watchers.c
@@ -630,7 +630,7 @@ static int num_context_object_enter_events[NUM_CONTEXT_WATCHERS] = {0, 0};
 static int num_context_object_exit_events[NUM_CONTEXT_WATCHERS] = {0, 0};
 
 static int
-handle_context_watcher_event(int which_watcher, PyContextEvent event, PyContext *ctx) {
+handle_context_watcher_event(int which_watcher, PyContextEvent event, PyObject *ctx) {
     if (event == Py_CONTEXT_EVENT_ENTER) {
         num_context_object_enter_events[which_watcher]++;
     }
@@ -644,22 +644,22 @@ handle_context_watcher_event(int which_watcher, PyContextEvent event, PyContext
 }
 
 static int
-first_context_watcher_callback(PyContextEvent event, PyContext *ctx) {
+first_context_watcher_callback(PyContextEvent event, PyObject *ctx) {
     return handle_context_watcher_event(0, event, ctx);
 }
 
 static int
-second_context_watcher_callback(PyContextEvent event, PyContext *ctx) {
+second_context_watcher_callback(PyContextEvent event, PyObject *ctx) {
     return handle_context_watcher_event(1, event, ctx);
 }
 
 static int
-noop_context_event_handler(PyContextEvent event, PyContext *ctx) {
+noop_context_event_handler(PyContextEvent event, PyObject *ctx) {
     return 0;
 }
 
 static int
-error_context_event_handler(PyContextEvent event, PyContext *ctx) {
+error_context_event_handler(PyContextEvent event, PyObject *ctx) {
     PyErr_SetString(PyExc_RuntimeError, "boom!");
     return -1;
 }
diff --git a/Python/context.c b/Python/context.c
@@ -113,7 +113,7 @@ context_event_name(PyContextEvent event) {
 }
 
 static void
-notify_context_watchers(PyThreadState *ts, PyContextEvent event, PyContext *ctx)
+notify_context_watchers(PyThreadState *ts, PyContextEvent event, PyObject *ctx)
 {
     assert(Py_REFCNT(ctx) > 0);
     PyInterpreterState *interp = ts->interp;
@@ -193,7 +193,7 @@ _PyContext_Enter(PyThreadState *ts, PyObject *octx)
     ts->context = Py_NewRef(ctx);
     ts->context_ver++;
 
-    notify_context_watchers(ts, Py_CONTEXT_EVENT_ENTER, ctx);
+    notify_context_watchers(ts, Py_CONTEXT_EVENT_ENTER, octx);
     return 0;
 }
 
@@ -227,7 +227,7 @@ _PyContext_Exit(PyThreadState *ts, PyObject *octx)
         return -1;
     }
 
-    notify_context_watchers(ts, Py_CONTEXT_EVENT_EXIT, ctx);
+    notify_context_watchers(ts, Py_CONTEXT_EVENT_EXIT, octx);
     Py_SETREF(ts->context, (PyObject *)ctx->ctx_prev);
     ts->context_ver++;
 

Original file line number	Diff line number	Diff line change
`@@ -630,7 +630,7 @@ static int num_context_object_enter_events[NUM_CONTEXT_WATCHERS] = {0, 0};`
`630`	`630`	`static int num_context_object_exit_events[NUM_CONTEXT_WATCHERS] = {0, 0};`
`631`	`631`
`632`	`632`	`static int`
`633`		`-handle_context_watcher_event(int which_watcher, PyContextEvent event, PyContext *ctx) {`
	`633`	`+handle_context_watcher_event(int which_watcher, PyContextEvent event, PyObject *ctx) {`
`634`	`634`	`if (event == Py_CONTEXT_EVENT_ENTER) {`
`635`	`635`	`num_context_object_enter_events[which_watcher]++;`
`636`	`636`	`}`
`@@ -644,22 +644,22 @@ handle_context_watcher_event(int which_watcher, PyContextEvent event, PyContext`
`644`	`644`	`}`
`645`	`645`
`646`	`646`	`static int`
`647`		`-first_context_watcher_callback(PyContextEvent event, PyContext *ctx) {`
	`647`	`+first_context_watcher_callback(PyContextEvent event, PyObject *ctx) {`
`648`	`648`	`return handle_context_watcher_event(0, event, ctx);`
`649`	`649`	`}`
`650`	`650`
`651`	`651`	`static int`
`652`		`-second_context_watcher_callback(PyContextEvent event, PyContext *ctx) {`
	`652`	`+second_context_watcher_callback(PyContextEvent event, PyObject *ctx) {`
`653`	`653`	`return handle_context_watcher_event(1, event, ctx);`
`654`	`654`	`}`
`655`	`655`
`656`	`656`	`static int`
`657`		`-noop_context_event_handler(PyContextEvent event, PyContext *ctx) {`
	`657`	`+noop_context_event_handler(PyContextEvent event, PyObject *ctx) {`
`658`	`658`	`return 0;`
`659`	`659`	`}`
`660`	`660`
`661`	`661`	`static int`
`662`		`-error_context_event_handler(PyContextEvent event, PyContext *ctx) {`
	`662`	`+error_context_event_handler(PyContextEvent event, PyObject *ctx) {`
`663`	`663`	`PyErr_SetString(PyExc_RuntimeError, "boom!");`
`664`	`664`	`return -1;`
`665`	`665`	`}`
Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ context_event_name(PyContextEvent event) {`
`113`	`113`	`}`
`114`	`114`
`115`	`115`	`static void`
`116`		`-notify_context_watchers(PyThreadState ts, PyContextEvent event, PyContext ctx)`
	`116`	`+notify_context_watchers(PyThreadState ts, PyContextEvent event, PyObject ctx)`
`117`	`117`	`{`
`118`	`118`	`assert(Py_REFCNT(ctx) > 0);`
`119`	`119`	`PyInterpreterState *interp = ts->interp;`
`@@ -193,7 +193,7 @@ _PyContext_Enter(PyThreadState ts, PyObject octx)`
`193`	`193`	`ts->context = Py_NewRef(ctx);`
`194`	`194`	`ts->context_ver++;`
`195`	`195`
`196`		`- notify_context_watchers(ts, Py_CONTEXT_EVENT_ENTER, ctx);`
	`196`	`+ notify_context_watchers(ts, Py_CONTEXT_EVENT_ENTER, octx);`
`197`	`197`	`return 0;`
`198`	`198`	`}`
`199`	`199`
`@@ -227,7 +227,7 @@ _PyContext_Exit(PyThreadState ts, PyObject octx)`
`227`	`227`	`return -1;`
`228`	`228`	`}`
`229`	`229`
`230`		`- notify_context_watchers(ts, Py_CONTEXT_EVENT_EXIT, ctx);`
	`230`	`+ notify_context_watchers(ts, Py_CONTEXT_EVENT_EXIT, octx);`
`231`	`231`	`Py_SETREF(ts->context, (PyObject *)ctx->ctx_prev);`
`232`	`232`	`ts->context_ver++;`
`233`	`233`