Merge pull request #1346 from ngnpope/fix-shadowing-regression

BUG: Remove prepended entry from sys.path

asv/benchmark.py

@@ -22,6 +22,7 @@
       Run a Unix socket forkserver.
 """
 
+import os
 import sys
 
 from asv_runner.discovery import _discover
@@ -49,6 +50,17 @@ def _help(args):
 
 
 def main():
+    # Remove asv package directory from `sys.path`. This script file resides
+    # there although it's not part of the package, so Python prepends it to
+    # `sys.path` on start which can shadow other modules. On Python 3.11+ it is
+    # possible to use `PYTHONSAFEPATH` to prevent this, but the script needs to
+    # work for older versions of Python.
+    if (
+        not getattr(sys.flags, 'safe_path', False)  # Python 3.11+ only.
+        and sys.path[0] == os.path.dirname(os.path.abspath(__file__))
+    ):
+        sys.path.pop(0)
+
     if len(sys.argv) < 2:
         _help([])
         sys.exit(1)

test/test_runner.py

@@ -450,3 +450,33 @@ def test_timeraw_benchmark(benchmarks_fixture):
     assert times['timeraw_examples.TimerawSuite.timeraw_setup'].result is not None
     assert 'timed out' in times['timeraw_examples.TimerawSuite.timeraw_timeout'].stderr
     assert '0' * 7 * 3 in times['timeraw_examples.TimerawSuite.timeraw_count'].stderr
+
+
+def test_asv_package_not_on_sys_path(capsys, benchmarks_fixture):
+    # Check benchmark script directory is not prepended to sys.path
+
+    conf, repo, envs, commit_hash = benchmarks_fixture
+
+    with open(os.path.join('benchmark', 'sys_path.py'), 'w') as f:
+        f.write('import sys; print(repr(sys.path[0]), flush=True)')
+
+    try:
+        benchmarks.Benchmarks.discover(conf, repo, envs, [commit_hash], check=True)
+    except util.UserError:
+        pass
+
+    out, err = capsys.readouterr()
+
+    assert repr(os.path.dirname(runner.BENCHMARK_RUN_SCRIPT)) not in out
+
+
+def test_builtin_statistics_module_not_shadowed(benchmarks_fixture):
+    # Crashes with the following exception on stderr if builtin statistics module is shadowed:
+    #   ImportError: cannot import name 'pstdev' from 'statistics' (.../asv/statistics.py)
+
+    conf, repo, envs, commit_hash = benchmarks_fixture
+
+    with open(os.path.join('benchmark', 'no_shadow.py'), 'w') as f:
+        f.write('from statistics import pstdev')
+
+    benchmarks.Benchmarks.discover(conf, repo, envs, [commit_hash])