Merge pull request #4904 from boegel/det_pypkg_version

prefer using `importlib.metadata` over the deprecated `pkg_resources` in `det_pypkg_version`

Author: branfosj

.github/workflows/container_tests.yml

@@ -97,7 +97,7 @@ jobs:
           # see https://docs.easybuild.io/en/latest/Containers.html
           curl -OL https://raw.githubusercontent.com/easybuilders/easybuild-easyconfigs/develop/easybuild/easyconfigs/b/bzip2/bzip2-1.0.8.eb
           export EASYBUILD_CONTAINERPATH=$PWD
-          export EASYBUILD_CONTAINER_CONFIG='bootstrap=docker,from=ghcr.io/easybuilders/centos-7.9-python3-amd64'
+          export EASYBUILD_CONTAINER_CONFIG='bootstrap=docker,from=ghcr.io/easybuilders/rockylinux-8.10-amd64'
           eb bzip2-1.0.8.eb --containerize --experimental --container-build-image
           singularity exec bzip2-1.0.8.sif command -v bzip2 | grep '/app/software/bzip2/1.0.8/bin/bzip2' || (echo "Path to bzip2 '$which_bzip2' is not correct" && exit 1)
           singularity exec bzip2-1.0.8.sif bzip2 --help

.github/workflows/container_tests_apptainer.yml

@@ -91,7 +91,7 @@ jobs:
           # see https://docs.easybuild.io/en/latest/Containers.html
           curl -OL https://raw.githubusercontent.com/easybuilders/easybuild-easyconfigs/develop/easybuild/easyconfigs/b/bzip2/bzip2-1.0.8.eb
           export EASYBUILD_CONTAINERPATH=$PWD
-          export EASYBUILD_CONTAINER_CONFIG='bootstrap=docker,from=ghcr.io/easybuilders/centos-7.9-python3-amd64'
+          export EASYBUILD_CONTAINER_CONFIG='bootstrap=docker,from=ghcr.io/easybuilders/rockylinux-8.10-amd64'
           export EASYBUILD_CONTAINER_TYPE='apptainer'
           eb bzip2-1.0.8.eb --containerize --experimental --container-build-image
           apptainer exec bzip2-1.0.8.sif command -v bzip2 | grep '/app/software/bzip2/1.0.8/bin/bzip2' || (echo "Path to bzip2 '$which_bzip2' is not correct" && exit 1)

easybuild/tools/systemtools.py

@@ -56,11 +56,20 @@
 # pkg_resources is provided by the setuptools Python package,
 # which we really want to keep as an *optional* dependency
 try:
-    import pkg_resources
+    # catch & ignore deprecation warning when importing pkg_resources produced by setuptools
+    with warnings.catch_warnings():
+        warnings.simplefilter("ignore", UserWarning)
+        import pkg_resources
     HAVE_PKG_RESOURCES = True
 except ImportError:
     HAVE_PKG_RESOURCES = False
 
+# importlib.metadata only available in Python 3.10+ (which we take into account when using it)
+try:
+    import importlib.metadata
+except ImportError:
+    pass
+
 try:
     # only needed on macOS, may not be available on Linux
     import ctypes.macholib.dyld
@@ -1467,17 +1476,38 @@ def det_pypkg_version(pkg_name, imported_pkg, import_name=None):
 
     version = None
 
-    if HAVE_PKG_RESOURCES:
+    # prefer using importlib.metadata, since pkg_resources is deprecated since setuptools v68.0.0
+    # and is scheduled to be removed in November 2025; see also https://github.com/pypa/setuptools/pull/5007
+
+    raised_error = None
+
+    # figure out which function to use to determine module/package version,
+    # and which error may be raised if the name is unknown
+    if check_python_version() >= (3, 10):
+
+        def _get_version(name):
+            return importlib.metadata.version(name)
+
+        raised_error = importlib.metadata.PackageNotFoundError
+
+    elif HAVE_PKG_RESOURCES:
+
+        def _get_version(name):
+            return pkg_resources.get_distribution(name).version
+
+        raised_error = pkg_resources.DistributionNotFound
+
+    if raised_error is not None:
         if import_name:
             try:
-                version = pkg_resources.get_distribution(import_name).version
-            except pkg_resources.DistributionNotFound as err:
+                version = _get_version(import_name)
+            except raised_error as err:
                 _log.debug("%s Python package not found: %s", import_name, err)
 
         if version is None:
             try:
-                version = pkg_resources.get_distribution(pkg_name).version
-            except pkg_resources.DistributionNotFound as err:
+                version = _get_version(pkg_name)
+            except raised_error as err:
                 _log.debug("%s Python package not found: %s", pkg_name, err)
 
     if version is None:

test/framework/systemtools.py

@@ -49,11 +49,12 @@
 from easybuild.tools.systemtools import CPU_VENDORS, AMD, APM, ARM, CAVIUM, IBM, INTEL
 from easybuild.tools.systemtools import MAX_FREQ_FP, PROC_CPUINFO_FP, PROC_MEMINFO_FP
 from easybuild.tools.systemtools import check_linked_shared_libs, check_os_dependency, check_python_version
-from easybuild.tools.systemtools import det_parallelism, get_avail_core_count, get_cuda_object_dump_raw
-from easybuild.tools.systemtools import get_cuda_architectures, get_cpu_arch_name, get_cpu_architecture
-from easybuild.tools.systemtools import get_cpu_family, get_cpu_features, get_cpu_model, get_cpu_speed, get_cpu_vendor
-from easybuild.tools.systemtools import get_gcc_version, get_glibc_version, get_os_type, get_os_name, get_os_version
-from easybuild.tools.systemtools import get_platform_name, get_shared_lib_ext, get_system_info, get_total_memory
+from easybuild.tools.systemtools import det_parallelism, det_pypkg_version, get_avail_core_count
+from easybuild.tools.systemtools import get_cuda_object_dump_raw, get_cuda_architectures, get_cpu_arch_name
+from easybuild.tools.systemtools import get_cpu_architecture, get_cpu_family, get_cpu_features, get_cpu_model
+from easybuild.tools.systemtools import get_cpu_speed, get_cpu_vendor, get_gcc_version, get_glibc_version, get_os_type
+from easybuild.tools.systemtools import get_os_name, get_os_version, get_platform_name, get_shared_lib_ext
+from easybuild.tools.systemtools import get_system_info, get_total_memory
 from easybuild.tools.systemtools import find_library_path, locate_solib, pick_dep_version, pick_system_specific_value
 
 
@@ -1117,6 +1118,14 @@ def test_pick_dep_version(self):
         error_pattern = r"Unknown value type for version: .* \(1.23\), should be string value"
         self.assertErrorRegex(EasyBuildError, error_pattern, pick_dep_version, 1.23)
 
+    def test_det_pypkg_version(self):
+        """Test det_pypkg_version function."""
+        self.assertIsNone(det_pypkg_version('doesnotexist', 'doesnotexist.foo'))
+
+        rich_ver = det_pypkg_version('rich', 'rich')
+        regex = re.compile(r'^[0-9]+\.[0-9].*')
+        self.assertTrue(regex.match(rich_ver), f"Pattern {regex.pattern} should match for: {rich_ver}")
+
     def test_pick_system_specific_value(self):
         """Test pick_system_specific_value function."""