Skip to content

gh-160976: Preserve source file path in Gecko sampling collector #160982

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

Open
makwana-akshat wants to merge 3 commits into
base: main
Choose a base branch
from
+47 −1
Open

gh-160976: Preserve source file path in Gecko sampling collector #160982

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c3d1138
gh-160976: Preserve source file path in Gecko sampling collector
makwana-akshat Oct 30, 2026
90c2f07
gh-160976: Relax global string table check in Gecko collector test
makwana-akshat Oct 30, 2026
806d351
gh-160976: Simplify Gecko source path regression test
makwana-akshat Nov 1, 2026
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 Lib/profiling/sampling/gecko_collector.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -617,7 +617,7 @@ def _get_or_create_func(self, thread_data, filename, funcname, lineno):
func_resources.append(resource_idx)

if is_python:
filename_idx = self._intern_string(os.path.basename(filename))
filename_idx = self._intern_string(filename)
func_filenames.append(filename_idx)
func_line_numbers.append(lineno)
else:
Expand Down
45 changes: 45 additions & 0 deletions Lib/test/test_profiling/test_sampling_profiler/test_collectors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -741,6 +741,51 @@ def test_gecko_collector_basic(self):
self.assertGreater(stack_table["length"], 0)
self.assertGreater(len(stack_table["frame"]), 0)

def test_gecko_collector_preserves_source_file_paths(self):

@ivonastojanovic ivonastojanovic Nov 1, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we could simplify this test quite a bit. Some of the assertions seem redundant, like checking the index types/ranges and that both the indices and strings are different. I think we could keep just the assertions that verify the behavior we actually care about here.

"""Test that GeckoCollector preserves source file paths and distinguishes
files with the same basename in different directories."""
collector = GeckoCollector(1000)
file_a = os.path.join("pkg_a", "__init__.py")
file_b = os.path.join("pkg_b", "__init__.py")

test_frames = [
MockInterpreterInfo(
0,
[
MockThreadInfo(
1,
[
MockFrameInfo(file_a, 10, "func_a"),
MockFrameInfo(file_b, 20, "func_b"),
],
status=THREAD_STATUS_MAIN_THREAD,
)
],
)
]
collector.collect(test_frames)
profile_data = collector._build_profile()

string_array = profile_data["shared"]["stringArray"]
func_table = profile_data["threads"][0]["funcTable"]

self.assertEqual(func_table["length"], 2)

funcs_by_name = {
string_array[func_table["name"][i]]: (
func_table["fileName"][i],
string_array[func_table["fileName"][i]],
)
for i in range(func_table["length"])
}

file_idx_a, resolved_file_a = funcs_by_name["func_a"]
file_idx_b, resolved_file_b = funcs_by_name["func_b"]

self.assertEqual(resolved_file_a, file_a)
self.assertEqual(resolved_file_b, file_b)
self.assertNotEqual(file_idx_a, file_idx_b)

def test_gecko_collector_async_aware(self):
collector = GeckoCollector(1000)

Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Library/2026-10-30-23-05-00.gh-issue-160976.GeCk0P.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The Gecko reporter (``--gecko``) in ``profiling.sampling`` now records full source file paths instead of only basenames.
Loading