bpo-41304: Ensure python3x._pth is loaded on Windows (GH-21495)

miss-islington · zooba · web-flow · commit 28e93dd2b26c · 2020-07-15T15:14:48.000-07:00
(cherry picked from commit 936a660) Co-authored-by: Steve Dower <steve.dower@python.org>
diff --git a/Lib/test/test_site.py b/Lib/test/test_site.py
@@ -589,12 +589,19 @@ def test_startup_interactivehook_isolated_explicit(self):
 @unittest.skipUnless(sys.platform == 'win32', "only supported on Windows")
 class _pthFileTests(unittest.TestCase):
 
-    def _create_underpth_exe(self, lines):
+    def _create_underpth_exe(self, lines, exe_pth=True):
+        import _winapi
         temp_dir = tempfile.mkdtemp()
         self.addCleanup(test.support.rmtree, temp_dir)
         exe_file = os.path.join(temp_dir, os.path.split(sys.executable)[1])
+        dll_src_file = _winapi.GetModuleFileName(sys.dllhandle)
+        dll_file = os.path.join(temp_dir, os.path.split(dll_src_file)[1])
         shutil.copy(sys.executable, exe_file)
-        _pth_file = os.path.splitext(exe_file)[0] + '._pth'
+        shutil.copy(dll_src_file, dll_file)
+        if exe_pth:
+            _pth_file = os.path.splitext(exe_file)[0] + '._pth'
+        else:
+            _pth_file = os.path.splitext(dll_file)[0] + '._pth'
         with open(_pth_file, 'w') as f:
             for line in lines:
                 print(line, file=f)
@@ -662,5 +669,30 @@ def test_underpth_file(self):
         self.assertTrue(rc, "sys.path is incorrect")
 
 
+    def test_underpth_dll_file(self):
+        libpath = os.path.dirname(os.path.dirname(encodings.__file__))
+        exe_prefix = os.path.dirname(sys.executable)
+        exe_file = self._create_underpth_exe([
+            'fake-path-name',
+            *[libpath for _ in range(200)],
+            '',
+            '# comment',
+            'import site'
+        ], exe_pth=False)
+        sys_prefix = os.path.dirname(exe_file)
+        env = os.environ.copy()
+        env['PYTHONPATH'] = 'from-env'
+        env['PATH'] = '{};{}'.format(exe_prefix, os.getenv('PATH'))
+        rc = subprocess.call([exe_file, '-c',
+            'import sys; sys.exit(not sys.flags.no_site and '
+            '%r in sys.path and %r in sys.path and %r not in sys.path and '
+            'all("\\r" not in p and "\\n" not in p for p in sys.path))' % (
+                os.path.join(sys_prefix, 'fake-path-name'),
+                libpath,
+                os.path.join(sys_prefix, 'from-env'),
+            )], env=env)
+        self.assertTrue(rc, "sys.path is incorrect")
+
+
 if __name__ == "__main__":
     unittest.main()
diff --git a/Misc/NEWS.d/next/Security/2020-07-15-20-15-08.bpo-41304.vNEeYA.rst b/Misc/NEWS.d/next/Security/2020-07-15-20-15-08.bpo-41304.vNEeYA.rst
@@ -0,0 +1 @@
+Fixes `python3x._pth` being ignored on Windows
diff --git a/PC/getpathp.c b/PC/getpathp.c
@@ -669,7 +669,7 @@ static int
 get_pth_filename(PyCalculatePath *calculate, wchar_t *filename,
                  const _PyPathConfig *pathconfig)
 {
-    if (get_dllpath(filename) &&
+    if (!get_dllpath(filename) &&
         !change_ext(filename, filename, L"._pth") &&
         exists(filename))
     {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Fixes `python3x._pth` being ignored on Windows
Original file line number	Diff line number	Diff line change
`@@ -669,7 +669,7 @@ static int`
`669`	`669`	`get_pth_filename(PyCalculatePath calculate, wchar_t filename,`
`670`	`670`	`const _PyPathConfig *pathconfig)`
`671`	`671`	`{`
`672`		`- if (get_dllpath(filename) &&`
	`672`	`+ if (!get_dllpath(filename) &&`
`673`	`673`	`!change_ext(filename, filename, L"._pth") &&`
`674`	`674`	`exists(filename))`
`675`	`675`	`{`