Skip to content

gh-91053: Add an optional callback that is invoked whenever a function is modified #98175

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
erlend-aasland merged 16 commits into from
Nov 22, 2022
Merged

gh-91053: Add an optional callback that is invoked whenever a function is modified #98175

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
89ce99c
Add an optional callback that is invoked whenever a function is modified
mpage Sep 23, 2022
4d4823c
Use imperative mood for all enum values
mpage Nov 8, 2022
acde67e
Update docs
mpage Nov 8, 2022
896d708
Conform to PEP-7
mpage Nov 8, 2022
788ad34
Move tests into test_capi
mpage Nov 8, 2022
c189528
Add a test for allocating too many watchers
mpage Nov 8, 2022
9d3496f
Dispatch events when {kw}defaults are modified via the C-API
mpage Nov 8, 2022
0fdc7d7
Trigger events when {kw}defaults are changed via the C-API
mpage Nov 9, 2022
a79e618
More PEP-7
mpage Nov 9, 2022
e1dd4e4
Merge branch 'main' into func-watchers
mpage Nov 9, 2022
e0601c1
Merge branch 'main' into func-watchers
mpage Nov 10, 2022
9804bba
Merge branch 'main' into func-watchers
mpage Nov 22, 2022
dd41468
Document that the runtime is free to optimize away function creation
mpage Nov 22, 2022
812dd5f
Add a bit vector to optimize watcher dispatch
mpage Nov 22, 2022
f28acc1
Sync with main
erlend-aasland Nov 22, 2022
e7b3325
Revert added newlines to VS project files
erlend-aasland Nov 22, 2022
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
Prev Previous commit
Next Next commit
Conform to PEP-7
  • Loading branch information
@mpage
mpage committed Nov 8, 2022
commit 896d70879b2ade0f47026adc7293b40c1dcd30bc
6 changes: 3 additions & 3 deletions Lib/test/test_func_events.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,11 @@ def myfunc():
self.assertIsInstance(cm.unraisable.exc_value, MyError)

def test_clear_out_of_range_watcher_id(self):
with self.assertRaisesRegex(ValueError, r"Invalid func watcher ID -1"):
with self.assertRaisesRegex(ValueError, r"invalid func watcher ID -1"):
_clear_func_watcher(-1)
with self.assertRaisesRegex(ValueError, r"Invalid func watcher ID 8"):
with self.assertRaisesRegex(ValueError, r"invalid func watcher ID 8"):
_clear_func_watcher(8) # FUNC_MAX_WATCHERS = 8

def test_clear_unassigned_watcher_id(self):
with self.assertRaisesRegex(ValueError, r"No func watcher set for ID 1"):
with self.assertRaisesRegex(ValueError, r"no func watcher set for ID 1"):
_clear_func_watcher(1)
38 changes: 22 additions & 16 deletions Modules/_testcapi/func_events.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@
static PyObject *pyfunc_watchers[NUM_WATCHERS];
static int watcher_ids[NUM_WATCHERS] = {-1, -1};

static PyObject *get_id(PyObject *obj) {
PyObject *builtins = PyEval_GetBuiltins();
static
PyObject *get_id(PyObject *obj)
Comment thread
mpage marked this conversation as resolved.
Outdated
{
PyObject *builtins = PyEval_GetBuiltins(); // borrowed ref.
if (builtins == NULL) {
return NULL;
}
Expand All @@ -25,7 +27,8 @@ static PyObject *get_id(PyObject *obj) {
}

static int
call_pyfunc_watcher(PyObject *watcher, PyFunction_WatchEvent event, PyFunctionObject *func, PyObject *new_value)
call_pyfunc_watcher(PyObject *watcher, PyFunction_WatchEvent event,
PyFunctionObject *func, PyObject *new_value)
{
PyObject *event_obj = PyLong_FromLong(event);
if (event_obj == NULL) {
Expand All @@ -44,7 +47,8 @@ call_pyfunc_watcher(PyObject *watcher, PyFunction_WatchEvent event, PyFunctionOb
Py_DECREF(new_value);
return -1;
}
} else {
}
else {
Py_INCREF(func);
func_or_id = (PyObject *) func;
}
Expand All @@ -59,20 +63,22 @@ call_pyfunc_watcher(PyObject *watcher, PyFunction_WatchEvent event, PyFunctionOb
}

static int
first_watcher_callback(PyFunction_WatchEvent event, PyFunctionObject *func, PyObject *new_value)
first_watcher_callback(PyFunction_WatchEvent event, PyFunctionObject *func,
PyObject *new_value)
{
return call_pyfunc_watcher(pyfunc_watchers[0], event, func, new_value);
}

static int
second_watcher_callback(PyFunction_WatchEvent event, PyFunctionObject *func, PyObject *new_value)
second_watcher_callback(PyFunction_WatchEvent event, PyFunctionObject *func,
PyObject *new_value)
{
return call_pyfunc_watcher(pyfunc_watchers[1], event, func, new_value);
}

static PyFunction_WatchCallback watcher_callbacks[NUM_WATCHERS] = {
first_watcher_callback,
second_watcher_callback
first_watcher_callback,
second_watcher_callback
};

static int
Expand Down Expand Up @@ -114,8 +120,7 @@ add_watcher(PyObject *self, PyObject *func)
Py_DECREF(result);
return NULL;
}
pyfunc_watchers[idx] = func;
Py_INCREF(func);
pyfunc_watchers[idx] = Py_NewRef(func);
return result;
}

Expand All @@ -124,7 +129,7 @@ clear_watcher(PyObject *self, PyObject *watcher_id_obj)
{
long watcher_id = PyLong_AsLong(watcher_id_obj);
if ((watcher_id < INT_MIN) || (watcher_id > INT_MAX)) {
Comment thread
mpage marked this conversation as resolved.
Outdated
PyErr_SetString(PyExc_ValueError, "invalid watcher id");
PyErr_SetString(PyExc_ValueError, "invalid watcher ID");
return NULL;
}
int wid = (int) watcher_id;
Expand All @@ -133,10 +138,10 @@ clear_watcher(PyObject *self, PyObject *watcher_id_obj)
}
int idx = -1;
for (int i = 0; i < NUM_WATCHERS; i++) {
if (watcher_ids[i] == wid) {
idx = i;
break;
}
if (watcher_ids[i] == wid) {
idx = i;
break;
}
}
assert(idx != -1);
Py_CLEAR(pyfunc_watchers[idx]);
Expand All @@ -151,7 +156,8 @@ static PyMethodDef TestMethods[] = {
};

int
_PyTestCapi_Init_FuncEvents(PyObject *m) {
_PyTestCapi_Init_FuncEvents(PyObject *m)
{
if (PyModule_AddFunctions(m, TestMethods) < 0) {
return -1;
}
Expand Down
7 changes: 4 additions & 3 deletions Objects/funcobject.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,19 +35,20 @@ PyFunction_AddWatcher(PyFunction_WatchCallback callback)
}
PyErr_SetString(PyExc_RuntimeError, "no more func watcher IDs available");
return -1;
Comment thread
mpage marked this conversation as resolved.

}

int
PyFunction_ClearWatcher(int watcher_id)
{
PyInterpreterState *interp = _PyInterpreterState_GET();
if (watcher_id < 0 || watcher_id >= FUNC_MAX_WATCHERS) {
PyErr_Format(PyExc_ValueError, "Invalid func watcher ID %d", watcher_id);
PyErr_Format(PyExc_ValueError, "invalid func watcher ID %d",
watcher_id);
return -1;
}
if (!interp->func_watchers[watcher_id]) {
PyErr_Format(PyExc_ValueError, "No func watcher set for ID %d", watcher_id);
PyErr_Format(PyExc_ValueError, "no func watcher set for ID %d",
watcher_id);
return -1;
}
interp->func_watchers[watcher_id] = NULL;
Expand Down