bpo-46015: Fixes calculation of sys.path in a venv on Windows (GH-29992)

zooba · web-flow · commit 7778116c2f57 · 2021-12-08T19:25:58.000Z
Also ensures that pybuilddir.txt is written early enough in the build to be picked up by later steps.
diff --git a/Lib/test/test_embed.py b/Lib/test/test_embed.py
@@ -1362,6 +1362,8 @@ def test_init_pyvenv_cfg(self):
             if not MS_WINDOWS:
                 paths[-1] = lib_dynload
             else:
+                # Include DLLs directory as well
+                paths.insert(1, '.\\DLLs')
                 for index, path in enumerate(paths):
                     if index == 0:
                         # Because we copy the DLLs into tmpdir as well, the zip file
diff --git a/Lib/test/test_getpath.py b/Lib/test/test_getpath.py
@@ -100,6 +100,7 @@ def test_venv_win32(self):
             module_search_paths_set=1,
             module_search_paths=[
                 r"C:\Python\python98.zip",
+                r"C:\Python\DLLs",
                 r"C:\Python\Lib",
                 r"C:\Python",
             ],
diff --git a/Misc/NEWS.d/next/Windows/2021-12-08-16-36-20.bpo-46105.t1mJ6Q.rst b/Misc/NEWS.d/next/Windows/2021-12-08-16-36-20.bpo-46105.t1mJ6Q.rst
@@ -0,0 +1 @@
+Fixed calculation of :data:`sys.path` in a venv on Windows.
diff --git a/Modules/getpath.c b/Modules/getpath.c
@@ -390,7 +390,7 @@ getpath_readlines(PyObject *Py_UNUSED(self), PyObject *args)
         while (cb && (p1[cb] == L'\n' || p1[cb] == L'\r')) {
             --cb;
         }
-        PyObject *u = PyUnicode_FromWideChar(p1, cb + 1);
+        PyObject *u = PyUnicode_FromWideChar(p1, cb ? cb + 1 : 0);
         if (!u || PyList_Append(r, u) < 0) {
             Py_XDECREF(u);
             Py_CLEAR(r);
diff --git a/Modules/getpath.py b/Modules/getpath.py
@@ -668,14 +668,17 @@ def search_up(prefix, *landmarks, test=isfile):
             pythonpath.append(joinpath(prefix, p))
 
     # Then add stdlib_dir and platstdlib_dir
-    if stdlib_dir:
-        pythonpath.append(stdlib_dir)
-    if platstdlib_dir:
-        if os_name == 'nt' and venv_prefix:
-            # QUIRK: Windows appends executable_dir instead of platstdlib_dir
-            # when in a venv
-            pythonpath.append(executable_dir)
-        else:
+    if os_name == 'nt' and venv_prefix:
+        # QUIRK: Windows generates paths differently in a venv
+        if platstdlib_dir:
+            pythonpath.append(platstdlib_dir)
+        if stdlib_dir:
+            pythonpath.append(stdlib_dir)
+        pythonpath.append(executable_dir)
+    else:
+        if stdlib_dir:
+            pythonpath.append(stdlib_dir)
+        if platstdlib_dir:
             pythonpath.append(platstdlib_dir)
 
     config['module_search_paths'] = pythonpath
diff --git a/PCbuild/python.vcxproj b/PCbuild/python.vcxproj
@@ -117,6 +117,10 @@
     <Import Project="regen.targets" />
   </ImportGroup>
   <Target Name="_TriggerPostRegen" AfterTargets="Build" DependsOnTargets="PostBuildRegen" />
+  <Target Name="GeneratePyBuildDirTxt" AfterTargets="Link">
+    <Message Text="Generating $(OutDir)pybuilddir.txt" />
+    <WriteLinesToFile File="$(OutDir)pybuilddir.txt" Lines="%0D%0A" Overwrite="true" />
+  </Target>
   <Target Name="ValidateUcrtbase" AfterTargets="AfterBuild" Condition="$(Configuration) != 'PGInstrument' and $(Platform) != 'ARM' and $(Platform) != 'ARM64'">
     <PropertyGroup>
       <UcrtName>ucrtbase</UcrtName>
@@ -147,7 +151,4 @@ $(_PGOPath)
     </PropertyGroup>
     <WriteLinesToFile File="$(PySourcePath)python.bat" Lines="$(_Content)" Overwrite="true" Condition="'$(_Content)' != '$(_ExistingContent)'" />
   </Target>
-  <Target Name="GeneratePyBuildDirTxt" BeforeTargets="AfterBuild">
-    <WriteLinesToFile File="$(OutDir)pybuilddir.txt" Lines="" Overwrite="true" />
-  </Target>
 </Project>

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Fixed calculation of :data:`sys.path` in a venv on Windows.
Original file line number	Diff line number	Diff line change
`@@ -390,7 +390,7 @@ getpath_readlines(PyObject Py_UNUSED(self), PyObject args)`
`390`	`390`	`while (cb && (p1[cb] == L'\n' \|\| p1[cb] == L'\r')) {`
`391`	`391`	`--cb;`
`392`	`392`	`}`
`393`		`- PyObject *u = PyUnicode_FromWideChar(p1, cb + 1);`
	`393`	`+ PyObject *u = PyUnicode_FromWideChar(p1, cb ? cb + 1 : 0);`
`394`	`394`	`if (!u \|\| PyList_Append(r, u) < 0) {`
`395`	`395`	`Py_XDECREF(u);`
`396`	`396`	`Py_CLEAR(r);`