Skip to content
Open
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
14 changes: 14 additions & 0 deletions Doc/library/profiling.sampling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1491,6 +1491,20 @@ Output options
named ``<format>_<PID>.<ext>`` (for example, ``flamegraph_12345.html``).
:option:`--heatmap` creates a directory named ``heatmap_<PID>``.

For HTML outputs (:option:`--flamegraph` and :option:`--heatmap`), the
generated file or directory is automatically opened in your default web
browser after profiling completes. Use :option:`--no-browser` to disable
this behavior. When using :option:`--subprocesses`, only the main process
output is opened automatically to avoid opening multiple browser tabs.

.. option:: --no-browser

Disable automatic browser opening for HTML output (:option:`--flamegraph`
and :option:`--heatmap`). By default, HTML visualizations are opened in
your default web browser after generation. When profiling with
:option:`--subprocesses`, only the main process opens the browser by
default; subprocess outputs are never auto-opened.


pstats display options
----------------------
Expand Down
44 changes: 44 additions & 0 deletions Lib/profiling/sampling/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import subprocess
import sys
import time
import webbrowser
from contextlib import nullcontext

from .errors import SamplingUnknownProcessError, SamplingModuleNotFoundError, SamplingScriptNotFoundError
Expand Down Expand Up @@ -147,6 +148,9 @@ def _build_child_profiler_args(args):
if args.format != "pstats":
child_args.append(f"--{args.format}")

# Always add --no-browser for child profilers to avoid opening multiple browser tabs
child_args.append("--no-browser")

return child_args


Expand Down Expand Up @@ -492,6 +496,12 @@ def _add_format_options(parser, include_compression=True, include_binary=True):
help="Output path (default: stdout for pstats, auto-generated for others). "
"For heatmap: directory name (default: heatmap_PID)",
)
output_group.add_argument(
"--no-browser",
action="store_true",
help="Disable automatic browser opening for HTML output (flamegraph, heatmap). "
"When using --subprocesses, only the main process opens the browser by default",
)


def _add_pstats_options(parser):
Expand Down Expand Up @@ -591,6 +601,32 @@ def _generate_output_filename(format_type, pid):
return f"{format_type}_{pid}.{extension}"


def _open_in_browser(path):
"""Open a file or directory in the default web browser.

Args:
path: File path or directory path to open

For directories (heatmap), opens the index.html file inside.
"""
abs_path = os.path.abspath(path)

# For heatmap directories, open the index.html file
if os.path.isdir(abs_path):
index_path = os.path.join(abs_path, 'index.html')
if os.path.exists(index_path):
abs_path = index_path
else:
print(f"Warning: Could not find index.html in {path}", file=sys.stderr)
return

file_url = f"file://{abs_path}"
try:
webbrowser.open(file_url)
except Exception as e:
print(f"Warning: Could not open browser: {e}", file=sys.stderr)


def _handle_output(collector, args, pid, mode):
"""Handle output for the collector based on format and arguments.

Expand Down Expand Up @@ -630,6 +666,10 @@ def _handle_output(collector, args, pid, mode):
filename = args.outfile or _generate_output_filename(args.format, pid)
collector.export(filename)

# Auto-open browser for HTML output unless --no-browser flag is set
if args.format in ('flamegraph', 'heatmap') and not getattr(args, 'no_browser', False):
_open_in_browser(filename)


def _validate_args(args, parser):
"""Validate format-specific options and live mode requirements.
Expand Down Expand Up @@ -1153,6 +1193,10 @@ def progress_callback(current, total):
filename = args.outfile or _generate_output_filename(args.format, os.getpid())
collector.export(filename)

# Auto-open browser for HTML output unless --no-browser flag is set
if args.format in ('flamegraph', 'heatmap') and not getattr(args, 'no_browser', False):
_open_in_browser(filename)

print(f"Replayed {count} samples")


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -438,6 +438,11 @@ def assert_flag_value_pair(flag, value):
child_args,
f"Flag '--flamegraph' not found in args: {child_args}",
)
self.assertIn(
"--no-browser",
child_args,
f"Flag '--no-browser' not found in args: {child_args}",
)

def test_build_child_profiler_args_no_gc(self):
"""Test building CLI args with --no-gc."""
Expand Down Expand Up @@ -992,6 +997,7 @@ def test_subprocesses_flag_with_flamegraph_output(self):
"-r",
"100",
"--flamegraph",
"--no-browser",
"-o",
output_file,
script_file,
Expand Down
Loading