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
5 changes: 5 additions & 0 deletions Lib/profiling/sampling/_sync_coordinator.py
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,11 @@ def _execute_script(script_path: str, script_args: List[str], cwd: str) -> None:
if not os.path.isfile(script_path):
raise TargetError(f"Script not found: {script_path}")

script_dir = os.path.dirname(os.path.realpath(script_path))
if script_dir in sys.path:
sys.path.remove(script_dir)
sys.path.insert(0, script_dir)

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

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
"""Tests for the sampling profiler's synchronization coordinator."""

import os
import socket
import subprocess
import sys
import tempfile
import unittest

from test.support import SHORT_TIMEOUT, os_helper, requires_subprocess


@requires_subprocess()
class TestSyncCoordinatorScriptExecution(unittest.TestCase):
"""Tests for how the coordinator executes a target script."""

def run_coordinator(self, cwd, target, *target_args):
"""Execute *target* from *cwd* with the sync coordinator.

Returns the ``(stdout, stderr)`` captured from the coordinator.
"""
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as server:
server.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
server.bind(("127.0.0.1", 0))
server.listen(1)
server.settimeout(SHORT_TIMEOUT)
port = server.getsockname()[1]

cmd = (
sys.executable,
"-m",
"profiling.sampling._sync_coordinator",
str(port),
cwd,
target,
) + tuple(target_args)
process = subprocess.Popen(
cmd,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
text=True,
)
try:
conn, _ = server.accept()
with conn:
# _signal_readiness() sends b"ready" before running target.
self.assertEqual(conn.recv(64), b"ready")
stdout, stderr = process.communicate(timeout=SHORT_TIMEOUT)
finally:
if process.poll() is None:
process.kill()
process.wait()
return stdout, stderr

def test_script_directory_on_sys_path(self):
# gh-158540: The coordinator must put the directory containing the
# script (not the working directory) on sys.path, matching
# ``python script.py``, so that modules next to the script can be
# imported even when the coordinator runs from another directory.
with tempfile.TemporaryDirectory() as tmpdir:
script_dir = os.path.join(tmpdir, "sub")
os.mkdir(script_dir)
with open(os.path.join(script_dir, "helper.py"), "w") as f:
f.write("message = 'helper imported'\n")
with open(os.path.join(script_dir, "where.py"), "w") as f:
f.write(
"import os\n"
"import sys\n"
"print('PATH0:', os.path.realpath(sys.path[0]))\n"
"import helper\n"
"print('HELPER:', helper.message)\n"
)

stdout, stderr = self.run_coordinator(
tmpdir, os.path.join("sub", "where.py")
)

self.assertNotIn("ModuleNotFoundError", stderr)
self.assertIn("HELPER: helper imported", stdout)
self.assertIn(f"PATH0: {os.path.realpath(script_dir)}", stdout)

@os_helper.skip_unless_symlink
def test_symlinked_script_uses_real_directory(self):
# gh-158540: ``python script.py`` resolves symlinks when computing
# sys.path[0], so a symlinked script must import modules next to the
# real script, not next to the link.
with tempfile.TemporaryDirectory() as tmpdir:
script_dir = os.path.join(tmpdir, "sub")
os.mkdir(script_dir)
with open(os.path.join(script_dir, "helper.py"), "w") as f:
f.write("message = 'helper imported'\n")
with open(os.path.join(script_dir, "where.py"), "w") as f:
f.write(
"import os\n"
"import sys\n"
"print('PATH0:', os.path.realpath(sys.path[0]))\n"
"import helper\n"
"print('HELPER:', helper.message)\n"
)
os.symlink(
os.path.join("sub", "where.py"),
os.path.join(tmpdir, "link.py"),
)

stdout, stderr = self.run_coordinator(tmpdir, "link.py")

self.assertNotIn("ModuleNotFoundError", stderr)
self.assertIn("HELPER: helper imported", stdout)
self.assertIn(f"PATH0: {os.path.realpath(script_dir)}", stdout)


if __name__ == "__main__":
unittest.main()
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Fix :mod:`profiling.sampling` not adding the directory containing the
profiled script to :data:`sys.path`, which prevented the script from
importing modules placed next to it. The script's directory is now added,
matching the behavior of ``python script.py``.
Loading