Skip to content

[3.13] gh-122029: Log call events in sys.setprofile when it's a method with c function (GH-122072) #122205

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
merged 1 commit into from
Jul 23, 2024
Merged

[3.13] gh-122029: Log call events in sys.setprofile when it's a method with c function (GH-122072) #122205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions Lib/test/test_sys_setprofile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -479,6 +479,20 @@ def f():
sys.setprofile(lambda *args: None)
f()

def test_method_with_c_function(self):
# gh-122029
# When we have a PyMethodObject whose im_func is a C function, we
# should record both the call and the return. f = classmethod(repr)
# is just a way to create a PyMethodObject with a C function.
class A:
f = classmethod(repr)
events = []
sys.setprofile(lambda frame, event, args: events.append(event))
A().f()
sys.setprofile(None)
# The last c_call is the call to sys.setprofile
self.assertEqual(events, ['c_call', 'c_return', 'c_call'])


if __name__ == "__main__":
unittest.main()
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Core and Builtins/2024-07-21-01-23-54.gh-issue-122029.gKv-e2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Emit ``c_call`` events in :func:`sys.setprofile` when a ``PyMethodObject`` pointing to a ``PyCFunction`` is called.
13 changes: 13 additions & 0 deletions Python/legacy_tracing.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,19 @@ sys_profile_call_or_return(
Py_DECREF(meth);
return res;
}
else if (Py_TYPE(callable) == &PyMethod_Type) {
// CALL instruction will grab the function from the method,
// so if the function is a C function, the return event will
// be emitted. However, CALL event happens before CALL
// instruction, so we need to handle this case here.
PyObject* func = PyMethod_GET_FUNCTION(callable);
if (func == NULL) {
return NULL;
}
if (PyCFunction_Check(func)) {
return call_profile_func(self, func);
}
}
Py_RETURN_NONE;
}

Expand Down
Loading