Inherit PYTHONPATH when spawning workers. (psf#148)

Prepare release 2.6.0.

Author: tjni

doc/changelog.rst

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+Version 2.6.0 (2022-11-21)
+-------------
+
+* Inherit ``PYTHONPATH`` environment variable by default.
+  Patch by Theodore Ni.
+
 Version 2.5.0 (2022-11-04)
 -------------
 

doc/conf.py

@@ -55,7 +55,7 @@
 # built documents.
 #
 # The short X.Y version.
-version = release = '2.5.0'
+version = release = '2.6.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

doc/runner.rst

@@ -118,9 +118,10 @@ Option::
   isolated CPUs are found. See :ref:`CPU pinning and CPU isolation <pin-cpu>`.
 * ``--inherit-environ=VARS``: ``VARS`` is a comma-separated list of environment
   variable names which are inherited by worker child processes. By default,
-  only the following variables are inherited: ``PATH``, ``HOME``, ``TEMP``,
-  ``COMSPEC``, ``SystemRoot`` and locale environment variables. See the
-  ``--no-locale`` below for locale environment variables.
+  only the following variables are inherited: ``PATH``, ``PYTHONPATH``,
+  ``HOME``, ``TEMP``, ``COMSPEC``, ``SystemRoot``, ``SystemDrive``, and locale
+  environment variables. See the ``--no-locale`` below for locale environment
+  variables.
 * ``--copy-env``: Inherit all environment variables.
 * ``--no-locale``: Don't inherit locale environment variables:
 

pyperf/__init__.py

@@ -1,6 +1,6 @@
 from time import perf_counter
 
-VERSION = (2, 5, 0)
+VERSION = (2, 6, 0)
 __version__ = '.'.join(map(str, VERSION))
 
 # Export pyperf.perf_counter for backward compatibility with pyperf 1.7

pyperf/_utils.py

@@ -279,7 +279,7 @@ def create_environ(inherit_environ, locale, copy_all):
         return os.environ
     env = {}
 
-    copy_env = ["PATH", "HOME", "TEMP", "COMSPEC", "SystemRoot", "SystemDrive"]
+    copy_env = ["PATH", "PYTHONPATH", "HOME", "TEMP", "COMSPEC", "SystemRoot", "SystemDrive"]
     if locale:
         copy_env.extend(('LANG', 'LC_ADDRESS', 'LC_ALL', 'LC_COLLATE',
                          'LC_CTYPE', 'LC_IDENTIFICATION', 'LC_MEASUREMENT',

pyperf/tests/test_examples.py

@@ -27,7 +27,7 @@ def check_command(self, script, args, nproc=3):
         self.TESTED.add(script)
         script = os.path.join(EXAMPLES_DIR, script)
 
-        cmd = [sys.executable] + [script] + args + ["--inherit-env=PYTHONPATH"]
+        cmd = [sys.executable] + [script] + args
         proc = tests.get_output(cmd)
 
         self.assertRegex(proc.stdout,

pyperf/tests/test_timeit.py

@@ -237,8 +237,7 @@ def test_python_option(self):
 
             # Run benchmark to check if --python works
             args = ('--metadata',
-                    '--python', tmp_exe,
-                    '--inherit-env', 'PYTHONPATH')
+                    '--python', tmp_exe)
             args = PERF_TIMEIT + args + FAST_BENCH_ARGS
             cmd = tests.get_output(args, env=env)
         finally:

setup.py

@@ -24,7 +24,7 @@
 #  - git commit -a -m "post-release"
 #  - git push or send the PR to the repository
 
-VERSION = '2.5.0'
+VERSION = '2.6.0'
 
 DESCRIPTION = 'Python module to run and analyze benchmarks'
 CLASSIFIERS = [