GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — gh-135953: Profile a module or script with sampling profiler by lkollar · Pull Request #136777 · python/cpython

gh-135953: Profile a module or script with sampling profiler #136777

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

pablogsal merged 14 commits into python:main from lkollar:sample-module

Aug 11, 2025

Uh oh!

There was an error while loading. Please reload this page.

Merged

gh-135953: Profile a module or script with sampling profiler #136777

Show file tree

Hide file tree

Changes from all commits

Commits

Show all changes

14 commits

Select commit Hold shift + click to select a range

eada5f0

Profile a module or script with sampling profiler

lkollar Jul 15, 2025

d8d035e

Wait for interpreter to initialize in subprocess

lkollar Aug 3, 2025

d99a39e

Remove unnecessary argument check

lkollar Aug 3, 2025

f97cc55

Handle the process runs shorter than expected

lkollar Aug 3, 2025

18c4002

Improve ReadRemoteMemory error handling on macOS

lkollar Aug 5, 2025

980c0f2

fixup! Handle the process runs shorter than expected

lkollar Aug 5, 2025

5043171

fixup! Wait for interpreter to initialize in subprocess

lkollar Aug 5, 2025

7832a7d

fixup! fixup! Wait for interpreter to initialize in subprocess

lkollar Aug 5, 2025

c13a74d

fixup! Improve ReadRemoteMemory error handling on macOS

lkollar Aug 5, 2025

2ce8a96

fixup! fixup! Wait for interpreter to initialize in subprocess

lkollar Aug 5, 2025

1622ee3

fixup! fixup! Improve ReadRemoteMemory error handling on macOS

lkollar Aug 6, 2025

0338ee1

Do not return error without an exception set

pablogsal Aug 8, 2025

2576f8b

Protect against more errors with no exceptions

pablogsal Aug 9, 2025

3847fff

Attempt to sync processes

pablogsal Aug 9, 2025

File filter

Filter by extension .c (1) .h (1) .py (3) All 3 file types selected

Viewed files

Clear filters

Conversations

Failed to load comments.

Uh oh!

There was an error while loading. Please reload this page.

Jump to

Jump to file

Failed to load files.

Uh oh!

There was an error while loading. Please reload this page.

Diff view

Unified

Split

Hide whitespace

Diff view

Unified

Split

Hide whitespace

There are no files selected for viewing

243 changes: 243 additions & 0 deletions 243 Lib/profile/_sync_coordinator.py

Show comments

View file

Open in desktop

Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,243 @@
		"""
		Internal synchronization coordinator for the sample profiler.

		This module is used internally by the sample profiler to coordinate
		the startup of target processes. It should not be called directly by users.
		"""

		import os
		import sys
		import socket
		import runpy
		import time
		from typing import List, NoReturn


		class CoordinatorError(Exception):
		"""Base exception for coordinator errors."""
		pass


		class ArgumentError(CoordinatorError):
		"""Raised when invalid arguments are provided."""
		pass


		class SyncError(CoordinatorError):
		"""Raised when synchronization with profiler fails."""
		pass


		class TargetError(CoordinatorError):
		"""Raised when target execution fails."""
		pass


		def _validate_arguments(args: List[str]) -> tuple[int, str, List[str]]:
		"""
		Validate and parse command line arguments.

		Args:
		args: Command line arguments including script name

		Returns:
		Tuple of (sync_port, working_directory, target_args)

		Raises:
		ArgumentError: If arguments are invalid
		"""
		if len(args) < 4:
		raise ArgumentError(
		"Insufficient arguments. Expected: <sync_port> <cwd> <target> [args...]"
		)

		try:
		sync_port = int(args[1])
		if not (1 <= sync_port <= 65535):
		raise ValueError("Port out of range")
		except ValueError as e:
		raise ArgumentError(f"Invalid sync port '{args[1]}': {e}") from e

		cwd = args[2]
		if not os.path.isdir(cwd):
		raise ArgumentError(f"Working directory does not exist: {cwd}")

		target_args = args[3:]
		if not target_args:
		raise ArgumentError("No target specified")

		return sync_port, cwd, target_args


		# Constants for socket communication
		_MAX_RETRIES = 3
		_INITIAL_RETRY_DELAY = 0.1
		_SOCKET_TIMEOUT = 2.0
		_READY_MESSAGE = b"ready"


		def _signal_readiness(sync_port: int) -> None:
		"""
		Signal readiness to the profiler via TCP socket.

		Args:
		sync_port: Port number where profiler is listening

		Raises:
		SyncError: If unable to signal readiness
		"""
		last_error = None

		for attempt in range(_MAX_RETRIES):
		try:
		# Use context manager for automatic cleanup
		with socket.create_connection(("127.0.0.1", sync_port), timeout=_SOCKET_TIMEOUT) as sock:
		sock.send(_READY_MESSAGE)
		return
		except (socket.error, OSError) as e:
		last_error = e
		if attempt < _MAX_RETRIES - 1:
		# Exponential backoff before retry
		time.sleep(_INITIAL_RETRY_DELAY * (2 ** attempt))

		# If we get here, all retries failed
		raise SyncError(f"Failed to signal readiness after {_MAX_RETRIES} attempts: {last_error}") from last_error


		def _setup_environment(cwd: str) -> None:
		"""
		Set up the execution environment.

		Args:
		cwd: Working directory to change to

		Raises:
		TargetError: If unable to set up environment
		"""
		try:
		os.chdir(cwd)
		except OSError as e:
		raise TargetError(f"Failed to change to directory {cwd}: {e}") from e

		# Add current directory to sys.path if not present (for module imports)
		if cwd not in sys.path:
		sys.path.insert(0, cwd)


		def _execute_module(module_name: str, module_args: List[str]) -> None:
		"""
		Execute a Python module.

		Args:
		module_name: Name of the module to execute
		module_args: Arguments to pass to the module

		Raises:
		TargetError: If module execution fails
		"""
		# Replace sys.argv to match how Python normally runs modules
		# When running 'python -m module args', sys.argv is ["__main__.py", "args"]
		sys.argv = [f"__main__.py"] + module_args

		try:
		runpy.run_module(module_name, run_name="__main__", alter_sys=True)
		except ImportError as e:
		raise TargetError(f"Module '{module_name}' not found: {e}") from e
		except SystemExit:
		# SystemExit is normal for modules
		pass
		except Exception as e:
		raise TargetError(f"Error executing module '{module_name}': {e}") from e


		def _execute_script(script_path: str, script_args: List[str], cwd: str) -> None:
		"""
		Execute a Python script.

		Args:
		script_path: Path to the script to execute
		script_args: Arguments to pass to the script
		cwd: Current working directory for path resolution

		Raises:
		TargetError: If script execution fails
		"""
		# Make script path absolute if it isn't already
		if not os.path.isabs(script_path):
		script_path = os.path.join(cwd, script_path)

		if not os.path.isfile(script_path):
		raise TargetError(f"Script not found: {script_path}")

		# Replace sys.argv to match original script call
		sys.argv = [script_path] + script_args

		try:
		with open(script_path, 'rb') as f:
		source_code = f.read()

		# Compile and execute the script
		code = compile(source_code, script_path, 'exec')
		exec(code, {'__name__': '__main__', '__file__': script_path})
		except FileNotFoundError as e:
		raise TargetError(f"Script file not found: {script_path}") from e
		except PermissionError as e:
		raise TargetError(f"Permission denied reading script: {script_path}") from e
		except SyntaxError as e:
		raise TargetError(f"Syntax error in script {script_path}: {e}") from e
		except SystemExit:
		# SystemExit is normal for scripts
		pass
		except Exception as e:
		raise TargetError(f"Error executing script '{script_path}': {e}") from e


		def main() -> NoReturn:
		"""
		Main coordinator function.

		This function coordinates the startup of a target Python process
		with the sample profiler by signaling when the process is ready
		to be profiled.
		"""
		try:
		# Parse and validate arguments
		sync_port, cwd, target_args = _validate_arguments(sys.argv)

		# Set up execution environment
		_setup_environment(cwd)

		# Signal readiness to profiler
		_signal_readiness(sync_port)

		# Execute the target
		if target_args[0] == "-m":
		# Module execution
		if len(target_args) < 2:
		raise ArgumentError("Module name required after -m")

		module_name = target_args[1]
		module_args = target_args[2:]
		_execute_module(module_name, module_args)
		else:
		# Script execution
		script_path = target_args[0]
		script_args = target_args[1:]
		_execute_script(script_path, script_args, cwd)

		except CoordinatorError as e:
		print(f"Profiler coordinator error: {e}", file=sys.stderr)
		sys.exit(1)
		except KeyboardInterrupt:
		print("Interrupted", file=sys.stderr)
		sys.exit(1)
		except Exception as e:
		print(f"Unexpected error in profiler coordinator: {e}", file=sys.stderr)
		sys.exit(1)

		# Normal exit
		sys.exit(0)


		if __name__ == "__main__":
		main()

Oops, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

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.

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.