Skip to content

gh-91048: Reorder result tuple of parse_code_object #134898

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
pablogsal merged 1 commit into from
May 31, 2025
Merged

gh-91048: Reorder result tuple of parse_code_object #134898

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
Reorder result tuple of parse_code_object 
The standard followed by APIs like pstat.Stats is to take a file, line,
function triplet. The parse_code_object function (and callers exposing
this in Python like RemoteUnwinder.get_stack_trace) return function,
file, line triplets which requires the caller to reorder these when
using it in classes like pstat.Stats.
  • Loading branch information
@lkollar
lkollar committed May 30, 2025
commit 58e9e03adf68ecb20b4440fdba72f01b909184fa
76 changes: 38 additions & 38 deletions Lib/test/test_external_inspection.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,17 +114,17 @@ def foo():
p.wait(timeout=SHORT_TIMEOUT)

thread_expected_stack_trace = [
("foo", script_name, 15),
("baz", script_name, 12),
("bar", script_name, 9),
('Thread.run', threading.__file__, ANY)
(script_name, 15, "foo"),
(script_name, 12, "baz"),
(script_name, 9, "bar"),
(threading.__file__, ANY, 'Thread.run')
]
# Is possible that there are more threads, so we check that the
# expected stack traces are in the result (looking at you Windows!)
self.assertIn((ANY, thread_expected_stack_trace), stack_trace)

# Check that the main thread stack trace is in the result
frame = ("<module>", script_name, 19)
frame = (script_name, 19, "<module>")
for _, stack in stack_trace:
if frame in stack:
break
Expand Down Expand Up @@ -222,70 +222,70 @@ def new_eager_loop():
root_task = "Task-1"
expected_stack_trace = [
[
("c5", script_name, 10),
("c4", script_name, 14),
("c3", script_name, 17),
("c2", script_name, 20),
(script_name, 10, "c5"),
(script_name, 14, "c4"),
(script_name, 17, "c3"),
(script_name, 20, "c2"),
],
"c2_root",
[
[
[
(
"TaskGroup._aexit",
taskgroups.__file__,
ANY,
"TaskGroup._aexit"
),
(
"TaskGroup.__aexit__",
taskgroups.__file__,
ANY,
"TaskGroup.__aexit__"
),
("main", script_name, 26),
(script_name, 26, "main"),
],
"Task-1",
[],
],
[
[("c1", script_name, 23)],
[(script_name, 23, "c1")],
"sub_main_1",
[
[
[
(
"TaskGroup._aexit",
taskgroups.__file__,
ANY,
"TaskGroup._aexit"
),
(
"TaskGroup.__aexit__",
taskgroups.__file__,
ANY,
"TaskGroup.__aexit__"
),
("main", script_name, 26),
(script_name, 26, "main"),
],
"Task-1",
[],
]
],
],
[
[("c1", script_name, 23)],
[(script_name, 23, "c1")],
"sub_main_2",
[
[
[
(
"TaskGroup._aexit",
taskgroups.__file__,
ANY,
"TaskGroup._aexit"
),
(
"TaskGroup.__aexit__",
taskgroups.__file__,
ANY,
"TaskGroup.__aexit__"
),
("main", script_name, 26),
(script_name, 26, "main"),
],
"Task-1",
[],
Expand Down Expand Up @@ -363,9 +363,9 @@ async def main():

expected_stack_trace = [
[
("gen_nested_call", script_name, 10),
("gen", script_name, 16),
("main", script_name, 19),
(script_name, 10, "gen_nested_call"),
(script_name, 16, "gen"),
(script_name, 19, "main"),
],
"Task-1",
[],
Expand Down Expand Up @@ -439,9 +439,9 @@ async def main():
stack_trace[2].sort(key=lambda x: x[1])

expected_stack_trace = [
[("deep", script_name, 11), ("c1", script_name, 15)],
[(script_name, 11, "deep"), (script_name, 15, "c1")],
"Task-2",
[[[("main", script_name, 21)], "Task-1", []]],
[[[(script_name, 21, "main")], "Task-1", []]],
]
self.assertEqual(stack_trace, expected_stack_trace)

Expand Down Expand Up @@ -515,16 +515,16 @@ async def main():
stack_trace[2].sort(key=lambda x: x[1])
expected_stack_trace = [
[
("deep", script_name, 11),
("c1", script_name, 15),
("staggered_race.<locals>.run_one_coro", staggered.__file__, ANY),
(script_name, 11, "deep"),
(script_name, 15, "c1"),
(staggered.__file__, ANY, "staggered_race.<locals>.run_one_coro"),
],
"Task-2",
[
[
[
("staggered_race", staggered.__file__, ANY),
("main", script_name, 21),
(staggered.__file__, ANY, "staggered_race"),
(script_name, 21, "main"),
],
"Task-1",
[],
Expand Down Expand Up @@ -662,16 +662,16 @@ async def main():
self.assertIn((ANY, "Task-1", []), entries)
main_stack = [
(
"TaskGroup._aexit",
taskgroups.__file__,
ANY,
"TaskGroup._aexit",
),
(
"TaskGroup.__aexit__",
taskgroups.__file__,
ANY,
"TaskGroup.__aexit__",
),
("main", script_name, 60),
(script_name, 60, "main"),
]
self.assertIn(
(ANY, "server task", [[main_stack, ANY]]),
Expand All @@ -686,16 +686,16 @@ async def main():
[
[
(
"TaskGroup._aexit",
taskgroups.__file__,
ANY,
"TaskGroup._aexit",
),
(
"TaskGroup.__aexit__",
taskgroups.__file__,
ANY,
"TaskGroup.__aexit__",
),
("echo_client_spam", script_name, 41),
(script_name, 41, "echo_client_spam"),
],
ANY,
]
Expand Down Expand Up @@ -741,14 +741,14 @@ def test_self_trace(self):
stack[:2],
[
(
"get_stack_trace",
__file__,
get_stack_trace.__code__.co_firstlineno + 2,
"get_stack_trace",
),
(
"TestGetStackTrace.test_self_trace",
__file__,
self.test_self_trace.__code__.co_firstlineno + 6,
"TestGetStackTrace.test_self_trace",
),
]
)
Expand Down
8 changes: 4 additions & 4 deletions Modules/_remote_debugging_module.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1562,9 +1562,9 @@ parse_code_object(RemoteUnwinderObject *unwinder,

Py_INCREF(meta->func_name);
Py_INCREF(meta->file_name);
PyTuple_SET_ITEM(tuple, 0, meta->func_name);
PyTuple_SET_ITEM(tuple, 1, meta->file_name);
PyTuple_SET_ITEM(tuple, 2, lineno);
PyTuple_SET_ITEM(tuple, 0, meta->file_name);
PyTuple_SET_ITEM(tuple, 1, lineno);
PyTuple_SET_ITEM(tuple, 2, meta->func_name);

*result = tuple;
return 0;
Expand Down Expand Up @@ -2921,4 +2921,4 @@ PyMODINIT_FUNC
PyInit__remote_debugging(void)
{
return PyModuleDef_Init(&remote_debugging_module);
}
}
Loading