enable same EBPYTHONPREFIXES changes in pythonbundle

Author: Thyre

easybuild/easyblocks/generic/pythonbundle.py

@@ -35,6 +35,7 @@
 from easybuild.tools.build_log import EasyBuildError
 from easybuild.tools.config import build_option, PYTHONPATH, EBPYTHONPREFIXES
 from easybuild.tools.modules import get_software_root
+from easybuild.tools.filetools import search_file
 
 
 class PythonBundle(Bundle):
@@ -123,6 +124,19 @@ def make_module_extra(self, *args, **kwargs):
                 self.log.info("Preferred Python search path is $EBPYTHONPREFIXES, so using that")
                 use_ebpythonprefixes = True
 
+        # Check if the installdir or sources contain any .pth files. For them to work correctly,
+        # Python needs these files to be in the sitedir path. While this typically works system-wide
+        # or in a venv, having Python modules in separate directories is unusual, and only having
+        # $PYTHONPATH will ignore these files.
+        # Our sitecustomize.py adds paths in $EBPYTHONPREFIXES to the sitedir path though, allowing
+        # these .pth files to work as expected. See: https://docs.python.org/3/library/site.html#module-site
+        # .pth files always should be in the site folder, so most of the path is fixed.
+        # Try the installation directory first
+        if self.installdir and search_file([self.installdir], r".*\.pth$", silent=True):
+            self.log.info("Found path configuration file in installation directory. "
+                          "Enabling $EBPYTHONPREFIXES...")
+            use_ebpythonprefixes = True
+
         if self.multi_python or use_ebpythonprefixes:
             path = ''  # EBPYTHONPREFIXES are relative to the install dir
             if path not in self.module_generator.added_paths_per_key[EBPYTHONPREFIXES]:

easybuild/easyblocks/generic/pythonpackage.py

@@ -643,15 +643,17 @@ def using_ebpythonprefixes(self) -> bool:
         # these .pth files to work as expected. See: https://docs.python.org/3/library/site.html#module-site
         # .pth files always should be in the site folder, so most of the path is fixed.
         # Try the installation directory first
-        if search_file([self.installdir], r".*\.pth$", silent=True):
-            self.log.info("Found path configuration file in installation directory."
-                          "Enabling $EBPYTHONPREFIXES...")
-            use_ebpythonprefixes = True
-        # If we did a test installation, check that one as well
-        if self.testinstall and search_file([self.pypkg_test_installdir], r".*\.pth$", silent=True):
-            self.log.info("Found path configuration file in test installation directory."
+        if self.installdir and search_file([self.installdir], r".*\.pth$", silent=True):
+            self.log.info("Found path configuration file in installation directory. "
                           "Enabling $EBPYTHONPREFIXES...")
             use_ebpythonprefixes = True
+        # If we did a test installation, check that one as well. Ensure that pypkg_test_installdir is set,
+        # since that might not be the case for sanity_check_only or module_only.
+        if self.testinstall and self.pypkg_test_installdir:
+            if search_file([self.pypkg_test_installdir], r".*\.pth$", silent=True):
+                self.log.info("Found path configuration file in test installation directory. "
+                              "Enabling $EBPYTHONPREFIXES...")
+                use_ebpythonprefixes = True
 
         return self.multi_python or use_ebpythonprefixes