Move API to public header and tests to _testcapi

Author: SubbaraoGarlapati

Include/cpython/monitoring.h

@@ -274,6 +274,20 @@ PyMonitoring_FireStopIterationEvent(PyMonitoringState *state, PyObject *codelike
 
 #undef _PYMONITORING_IF_ACTIVE
 
+
+/* Callback API for notifications when sys.settrace/sys.setprofile are called. */
+typedef enum {
+    PyUnstable_EVAL_TRACE_SET = 0,
+    PyUnstable_EVAL_TRACE_CLEAR = 1,
+    PyUnstable_EVAL_PROFILE_SET = 2,
+    PyUnstable_EVAL_PROFILE_CLEAR = 3,
+} PyUnstable_EvalEvent;
+
+typedef int (*PyUnstable_EvalCallback)(PyUnstable_EvalEvent event, void *data);
+
+PyAPI_FUNC(int) PyUnstable_SetEvalCallback(PyUnstable_EvalCallback callback, void *data);
+PyAPI_FUNC(PyUnstable_EvalCallback) PyUnstable_GetEvalCallback(void **data);
+
 #ifdef __cplusplus
 }
 #endif

Include/internal/pycore_instruments.h

@@ -123,19 +123,6 @@ typedef struct _PyCoMonitoringData {
 } _PyCoMonitoringData;
 
 
-/* Callback API for notifications when sys.settrace/sys.setprofile are called. */
-typedef enum {
-    PyUnstable_EVAL_TRACE_SET = 0,
-    PyUnstable_EVAL_TRACE_CLEAR = 1,
-    PyUnstable_EVAL_PROFILE_SET = 2,
-    PyUnstable_EVAL_PROFILE_CLEAR = 3,
-} PyUnstable_EvalEvent;
-
-typedef int (*PyUnstable_EvalCallback)(PyUnstable_EvalEvent event, void *data);
-
-PyAPI_FUNC(int) PyUnstable_SetEvalCallback(PyUnstable_EvalCallback callback, void *data);
-PyAPI_FUNC(PyUnstable_EvalCallback) PyUnstable_GetEvalCallback(void **data);
-
 #ifdef __cplusplus
 }
 #endif

Lib/test/test_capi/test_misc.py

@@ -2869,10 +2869,10 @@ class TestEvalCallback(unittest.TestCase):
 
     def setUp(self):
         self.events = []
-        _testinternalcapi.set_eval_callback_record(self.events)
+        _testcapi.set_eval_callback_record(self.events)
 
     def tearDown(self):
-        _testinternalcapi.clear_eval_callback()
+        _testcapi.clear_eval_callback()
         sys.settrace(None)
         sys.setprofile(None)
 
@@ -2923,10 +2923,10 @@ def dummy_profile(frame, event, arg):
         ])
 
     def test_clear_callback_stops_events(self):
-        _testinternalcapi.clear_eval_callback()
+        _testcapi.clear_eval_callback()
         events_after_clear = []
-        _testinternalcapi.set_eval_callback_record(events_after_clear)
-        _testinternalcapi.clear_eval_callback()
+        _testcapi.set_eval_callback_record(events_after_clear)
+        _testcapi.clear_eval_callback()
 
         def dummy_trace(frame, event, arg):
             return dummy_trace

Modules/_testcapi/monitoring.c

@@ -1,8 +1,7 @@
 #include "parts.h"
 #include "util.h"
 
-#define Py_BUILD_CORE
-#include "internal/pycore_instruments.h"
+#include "cpython/monitoring.h"
 
 typedef struct {
     PyObject_HEAD
@@ -488,6 +487,43 @@ exit_scope(PyObject *self, PyObject *args)
     Py_RETURN_NONE;
 }
 
+static int
+test_eval_callback(PyUnstable_EvalEvent event, void *data)
+{
+    if (data == NULL) {
+        return 0;
+    }
+    PyObject *event_int = PyLong_FromLong((long)event);
+    if (event_int == NULL) {
+        return -1;
+    }
+    int res = PyList_Append((PyObject *)data, event_int);
+    Py_DECREF(event_int);
+    return res;
+}
+
+static PyObject *
+set_eval_callback_record(PyObject *self, PyObject *list)
+{
+    if (!PyList_Check(list)) {
+        PyErr_SetString(PyExc_TypeError, "argument must be a list");
+        return NULL;
+    }
+    if (PyUnstable_SetEvalCallback(test_eval_callback, list) < 0) {
+        return NULL;
+    }
+    Py_RETURN_NONE;
+}
+
+static PyObject *
+clear_eval_callback(PyObject *self, PyObject *Py_UNUSED(args))
+{
+    if (PyUnstable_SetEvalCallback(NULL, NULL) < 0) {
+        return NULL;
+    }
+    Py_RETURN_NONE;
+}
+
 static PyMethodDef TestMethods[] = {
     {"fire_event_py_start", fire_event_py_start, METH_VARARGS},
     {"fire_event_py_resume", fire_event_py_resume, METH_VARARGS},
@@ -508,6 +544,8 @@ static PyMethodDef TestMethods[] = {
     {"fire_event_stop_iteration", fire_event_stop_iteration, METH_VARARGS},
     {"monitoring_enter_scope", enter_scope, METH_VARARGS},
     {"monitoring_exit_scope", exit_scope, METH_VARARGS},
+    {"set_eval_callback_record", set_eval_callback_record, METH_O},
+    {"clear_eval_callback", clear_eval_callback, METH_NOARGS},
     {NULL},
 };
 

Modules/_testinternalcapi.c

@@ -38,7 +38,6 @@
 #include "pycore_pystate.h"       // _PyThreadState_GET()
 #include "pycore_runtime_structs.h" // _PY_NSMALLPOSINTS
 #include "pycore_unicodeobject.h" // _PyUnicode_TransformDecimalAndSpaceToASCII()
-#include "pycore_instruments.h"   // PyUnstable_SetEvalCallback
 
 #include "clinic/_testinternalcapi.c.h"
 
@@ -2837,50 +2836,9 @@ test_threadstate_set_stack_protection(PyObject *self, PyObject *Py_UNUSED(args))
 }
 
 
-// Helper for testing PyUnstable_SetEvalCallback / PyUnstable_GetEvalCallback
-static int
-test_eval_callback(PyUnstable_EvalEvent event, void *data)
-{
-    if (data == NULL) {
-        return 0;
-    }
-    PyObject *event_int = PyLong_FromLong((long)event);
-    if (event_int == NULL) {
-        return -1;
-    }
-    int res = PyList_Append((PyObject *)data, event_int);
-    Py_DECREF(event_int);
-    return res;
-}
-
-static PyObject *
-set_eval_callback_record(PyObject *self, PyObject *list)
-{
-    if (!PyList_Check(list)) {
-        PyErr_SetString(PyExc_TypeError, "argument must be a list");
-        return NULL;
-    }
-    if (PyUnstable_SetEvalCallback(test_eval_callback, list) < 0) {
-        return NULL;
-    }
-    Py_RETURN_NONE;
-}
-
-static PyObject *
-clear_eval_callback(PyObject *self, PyObject *Py_UNUSED(args))
-{
-    if (PyUnstable_SetEvalCallback(NULL, NULL) < 0) {
-        return NULL;
-    }
-    Py_RETURN_NONE;
-}
-
-
 static PyMethodDef module_functions[] = {
     {"get_configs", get_configs, METH_NOARGS},
     {"get_eval_frame_stats", get_eval_frame_stats, METH_NOARGS, NULL},
-    {"set_eval_callback_record", set_eval_callback_record, METH_O, NULL},
-    {"clear_eval_callback", clear_eval_callback, METH_NOARGS, NULL},
     {"get_recursion_depth", get_recursion_depth, METH_NOARGS},
     {"get_c_recursion_remaining", get_c_recursion_remaining, METH_NOARGS},
     {"get_stack_pointer", get_stack_pointer, METH_NOARGS},