refactor(config): replace deprecated pkg_resources (#503)

Replace `pkg_resources`` with the modern `importlib.resources` API to
resolve deprecation warnings. Uses `importlib.resources`` for Python
3.9+ and the `importlib_resources` backport for Python 3.8
compatibility.

Closes #502

Author: tiborsimko

reana_commons/api_client.py

@@ -10,11 +10,17 @@
 import json
 import logging
 import os
+import sys
 import traceback
 from typing import Optional
 
-import pkg_resources
 from bravado.client import RequestsClient, SwaggerClient
+
+# Use importlib.resources for Python 3.9+ or importlib_resources backport for 3.8
+if sys.version_info >= (3, 9):
+    from importlib.resources import files
+else:
+    from importlib_resources import files
 from bravado.exception import (
     HTTPBadRequest,
     HTTPError,
@@ -74,13 +80,17 @@ def _load_config_from_env(self):
 
     def _get_spec(self, spec_file):
         """Get json specification from package data."""
-        spec_file_path = os.path.join(
-            pkg_resources.resource_filename("reana_commons", "openapi_specifications"),
-            spec_file,
-        )
-
-        with open(spec_file_path) as f:
-            json_spec = json.load(f)
+        # Get the OpenAPI specification file using importlib.resources
+        package_files = files("reana_commons")
+        spec_resource = package_files / "openapi_specifications" / spec_file
+
+        # For Python 3.9+, we need to handle this as a Traversable
+        if sys.version_info >= (3, 9):
+            json_spec = json.loads(spec_resource.read_text())
+        else:
+            # For Python 3.8 with backport, convert to string path
+            with open(str(spec_resource)) as f:
+                json_spec = json.load(f)
         return json_spec
 
 

reana_commons/config.py

@@ -11,12 +11,18 @@
 import json
 import logging
 import os
+import sys
 
-import pkg_resources
 import yaml
 
 from reana_commons.errors import REANAConfigDoesNotExist
 
+# Use importlib.resources for Python 3.9+ or importlib_resources backport for 3.8
+if sys.version_info >= (3, 9):
+    from importlib.resources import files
+else:
+    from importlib_resources import files
+
 
 class REANAConfig:
     """REANA global configuration class."""
@@ -40,9 +46,30 @@ def load(cls, kind):
         return cls._read_file(cls.config_mapping[kind])
 
 
-reana_yaml_schema_file_path = pkg_resources.resource_filename(
-    __name__, "validation/schemas/reana_analysis_schema.json"
-)
+def _get_reana_yaml_schema_file_path():
+    """Get the path to the REANA YAML schema file.
+
+    This function handles the differences between Python versions and ensures
+    the schema file is accessible as a real filesystem path.
+    """
+    package_files = files("reana_commons")
+    schema_resource = (
+        package_files / "validation" / "schemas" / "reana_analysis_schema.json"
+    )
+
+    # For Python 3.8 with backport, we can directly convert to string
+    # For Python 3.9+, the resource might be in a zip, so we need to check
+    if hasattr(schema_resource, "is_file") and schema_resource.is_file():
+        # It's a real file on the filesystem
+        return str(schema_resource)
+    else:
+        # For older importlib_resources or when in a zip, try direct string conversion
+        # This should work for the backport
+        return str(schema_resource)
+
+
+# Get the path to the validation schema file
+reana_yaml_schema_file_path = _get_reana_yaml_schema_file_path()
 """REANA specification schema location."""
 
 REANA_COMPONENT_PREFIX = os.getenv("REANA_COMPONENT_PREFIX", "reana")

setup.py

@@ -61,6 +61,7 @@
     "checksumdir>=1.1.4,<1.2",
     "click>=7.0",
     "fs>=2.0",
+    "importlib_resources>=5.0; python_version<'3.9'",
     "jsonschema[format]>=3.0.1",
     "kombu>=4.6",
     "mock>=3.0,<4",

tests/test_utils.py

@@ -10,13 +10,14 @@
 
 import os
 import shutil
+import sys
 import time
 from hashlib import md5
 
-import pkg_resources
 import pytest
 from pytest_reana.fixtures import sample_workflow_workspace
 
+
 from reana_commons.utils import (
     calculate_file_access_time,
     calculate_hash_of_dir,
@@ -70,9 +71,14 @@ def test_calculate_hash_of_dir(sample_workflow_workspace):  # noqa: F811
     non_existing_dir_hash = calculate_hash_of_dir("a/b/c")
     assert non_existing_dir_hash == -1
 
-    test_workspace_path = pkg_resources.resource_filename(
-        "pytest_reana", "test_workspace"
-    )
+    # Get the path to the test workspace by finding the pytest_reana package location
+    import pytest_reana
+    import pathlib
+
+    # Get the package path and construct test_workspace path
+    package_path = pathlib.Path(pytest_reana.__file__).parent
+    test_workspace_path = package_path / "test_workspace"
+
     sample_workflow_workspace_path = next(sample_workflow_workspace("sample"))
     shutil.rmtree(sample_workflow_workspace_path)
     shutil.copytree(test_workspace_path, sample_workflow_workspace_path)