Skip to content

[3.11] gh-91348: Restore frame argument to sys._getframe audit event (GH-94928) #94932

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.

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 17, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion Doc/library/sys.rst
Original file line number Diff line number Diff line change
Expand Up @@ -774,7 +774,7 @@ always available.
that is deeper than the call stack, :exc:`ValueError` is raised. The default
for *depth* is zero, returning the frame at the top of the call stack.

.. audit-event:: sys._getframe "" sys._getframe
.. audit-event:: sys._getframe frame sys._getframe

.. impl-detail::

Expand Down
11 changes: 11 additions & 0 deletions Lib/test/audit-tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -408,6 +408,17 @@ def hook(event, *args):
raise RuntimeError("Expected sqlite3.load_extension to fail")


def test_sys_getframe():
import sys

def hook(event, args):
if event.startswith("sys."):
print(event, args[0].f_code.co_name)

sys.addaudithook(hook)
sys._getframe()


if __name__ == "__main__":
from test.support import suppress_msvcrt_asserts

Expand Down
12 changes: 12 additions & 0 deletions Lib/test/test_audit.py
Original file line number Diff line number Diff line change
Expand Up @@ -176,5 +176,17 @@ def test_sqlite3(self):
self.assertEqual(actual, expected)


def test_sys_getframe(self):
returncode, events, stderr = self.run_python("test_sys_getframe")
if returncode:
self.fail(stderr)

if support.verbose:
print(*events, sep='\n')
actual = [(ev[0], ev[2]) for ev in events]
expected = [("sys._getframe", "test_sys_getframe")]

self.assertEqual(actual, expected)

if __name__ == "__main__":
unittest.main()
12 changes: 7 additions & 5 deletions Python/sysmodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -1780,10 +1780,6 @@ sys__getframe_impl(PyObject *module, int depth)
PyThreadState *tstate = _PyThreadState_GET();
_PyInterpreterFrame *frame = tstate->cframe->current_frame;

if (_PySys_Audit(tstate, "sys._getframe", NULL) < 0) {
return NULL;
}

if (frame != NULL) {
while (depth > 0) {
frame = frame->previous;
Expand All @@ -1801,7 +1797,13 @@ sys__getframe_impl(PyObject *module, int depth)
"call stack is not deep enough");
return NULL;
}
return _Py_XNewRef((PyObject *)_PyFrame_GetFrameObject(frame));

PyObject *pyFrame = Py_XNewRef((PyObject *)_PyFrame_GetFrameObject(frame));
if (pyFrame && _PySys_Audit(tstate, "sys._getframe", "(O)", pyFrame) < 0) {
Py_DECREF(pyFrame);
return NULL;
}
return pyFrame;
}

/*[clinic input]
Expand Down