[gh-135953] Profile a module or script with sampling profiler #136777
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -2,6 +2,7 @@ | |||||
| import _remote_debugging | ||||||
| import os | ||||||
| import pstats | ||||||
| import subprocess | ||||||
| import statistics | ||||||
| import sys | ||||||
| import sysconfig | ||||||
|
|
@@ -542,46 +543,66 @@ def main(): | |||||
| parser = argparse.ArgumentParser( | ||||||
| description=( | ||||||
| "Sample a process's stack frames and generate profiling data.\n" | ||||||
| "Supports the following target modes:\n" | ||||||
| " - -p PID: Profile an existing process by PID\n" | ||||||
| " - -m MODULE [ARGS...]: Profile a module as python -m module ... \n" | ||||||
| " - filename [ARGS...]: Profile the specified script by running it in a subprocess\n" | ||||||
| "\n" | ||||||
| "Examples:\n" | ||||||
| " # Profile process 1234 for 10 seconds with default settings\n" | ||||||
| " python -m profile.sample -p 1234\n" | ||||||
| "\n" | ||||||
| " # Profile a script by running it in a subprocess\n" | ||||||
| " python -m profile.sample myscript.py arg1 arg2\n" | ||||||
| "\n" | ||||||
| " # Profile a module by running it as python -m module in a subprocess\n" | ||||||
| " python -m profile.sample -m mymodule arg1 arg2\n" | ||||||
| "\n" | ||||||
| " # Profile with custom interval and duration, save to file\n" | ||||||
| " python -m profile.sample -i 50 -d 30 -o profile.stats -p 1234\n" | ||||||
| "\n" | ||||||
| " # Generate collapsed stacks for flamegraph\n" | ||||||
| " python -m profile.sample --collapsed -p 1234\n" | ||||||
| "\n" | ||||||
| " # Profile all threads, sort by total time\n" | ||||||
| " python -m profile.sample -a --sort-tottime -p 1234\n" | ||||||
| "\n" | ||||||
| " # Profile for 1 minute with 1ms sampling interval\n" | ||||||
| " python -m profile.sample -i 1000 -d 60 -p 1234\n" | ||||||
| "\n" | ||||||
| " # Show only top 20 functions sorted by direct samples\n" | ||||||
| " python -m profile.sample --sort-nsamples -l 20 -p 1234\n" | ||||||
| "\n" | ||||||
| " # Profile all threads and save collapsed stacks\n" | ||||||
| " python -m profile.sample -a --collapsed -o stacks.txt -p 1234\n" | ||||||
| "\n" | ||||||
| " # Profile with real-time sampling statistics\n" | ||||||
| " python -m profile.sample --realtime-stats -p 1234\n" | ||||||
| "\n" | ||||||
| " # Sort by sample percentage to find most sampled functions\n" | ||||||
| " python -m profile.sample --sort-sample-pct -p 1234\n" | ||||||
| "\n" | ||||||
| " # Sort by cumulative samples to find functions most on call stack\n" | ||||||
| " python -m profile.sample --sort-nsamples-cumul -p 1234\n" | ||||||
| ), | ||||||
| formatter_class=argparse.RawDescriptionHelpFormatter, | ||||||
| ) | ||||||
|
|
||||||
| # Target selection | ||||||
| target_group = parser.add_mutually_exclusive_group(required=True) | ||||||
| target_group.add_argument( | ||||||
| "-p", "--pid", type=int, help="Process ID to sample" | ||||||
| ) | ||||||
| target_group.add_argument( | ||||||
| "-m", "--module", | ||||||
| nargs=argparse.REMAINDER, | ||||||
| help="Run and profile a module as python -m module [ARGS...]" | ||||||
| ) | ||||||
| target_group.add_argument( | ||||||
| "script", | ||||||
| nargs=argparse.REMAINDER, | ||||||
| help="Script to run and profile, with optional arguments" | ||||||
| ) | ||||||
|
|
||||||
| # Sampling options | ||||||
| sampling_group = parser.add_argument_group("Sampling configuration") | ||||||
|
|
@@ -712,19 +733,59 @@ def main(): | |||||
|
|
||||||
| sort_value = args.sort if args.sort is not None else 2 | ||||||
|
|
||||||
| if not(args.pid or args.module or args.script): | ||||||
| parser.error( | ||||||
| "You must specify either a process ID (-p), a module (-m), or a script to run." | ||||||
| ) | ||||||
|
|
||||||
| if args.pid: | ||||||
| sample( | ||||||
| args.pid, | ||||||
| sample_interval_usec=args.interval, | ||||||
| duration_sec=args.duration, | ||||||
| filename=args.outfile, | ||||||
| all_threads=args.all_threads, | ||||||
| limit=args.limit, | ||||||
| sort=sort_value, | ||||||
| show_summary=not args.no_summary, | ||||||
| output_format=args.format, | ||||||
| realtime_stats=args.realtime_stats, | ||||||
| ) | ||||||
| elif args.module or args.script: | ||||||
| if args.module: | ||||||
| cmd = [sys.executable, "-m", *args.module] | ||||||
| else: | ||||||
| cmd = [sys.executable, *args.script] | ||||||
|
|
||||||
| process = subprocess.Popen(cmd) | ||||||
|
|
||||||
| try: | ||||||
| exit_code = process.wait(timeout=0.1) | ||||||
|
There was a problem hiding this comment. The hardcoded timeout of 0.1 seconds is a magic number. Consider defining this as a named constant or making it configurable, as some programs may have longer startup times.
Suggested change
Copilot uses AI. Check for mistakes. There was a problem hiding this comment. Hummm, why is this? Just in case the process fails immediately? |
||||||
| sys.exit(exit_code) | ||||||
| except subprocess.TimeoutExpired: | ||||||
| pass | ||||||
|
|
||||||
| try: | ||||||
| sample( | ||||||
| process.pid, | ||||||
| sort=sort_value, | ||||||
| sample_interval_usec=args.interval, | ||||||
| duration_sec=args.duration, | ||||||
| filename=args.outfile, | ||||||
| all_threads=args.all_threads, | ||||||
| limit=args.limit, | ||||||
| show_summary=not args.no_summary, | ||||||
| output_format=args.format, | ||||||
| realtime_stats=args.realtime_stats, | ||||||
| ) | ||||||
| finally: | ||||||
| if process.poll() is None: | ||||||
| process.terminate() | ||||||
| try: | ||||||
| process.wait(timeout=2) | ||||||
|
There was a problem hiding this comment. The hardcoded timeout of 2 seconds for graceful termination is a magic number. Consider defining this as a named constant for better maintainability.
Suggested change
Copilot uses AI. Check for mistakes. |
||||||
| except subprocess.TimeoutExpired: | ||||||
| process.kill() | ||||||
| process.wait() | ||||||
|
|
||||||
| if __name__ == "__main__": | ||||||
| main() | ||||||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The condition
not(args.pid or args.module or args.script)is redundant since the mutually exclusive group is already marked asrequired=True. The argparse library will automatically enforce that one of these options is provided.Copilot uses AI. Check for mistakes.