Remove pkg_resources (fixes #650) (#690)

Author: DavidMStraub

gramps_webapi/api/image.py

@@ -23,14 +23,14 @@
 import os
 import shutil
 import tempfile
+from importlib.resources import as_file, files
 from pathlib import Path
 from typing import BinaryIO, Callable
 
 import ffmpeg
 from pdf2image import convert_from_path
 from PIL import Image, ImageOps
 from PIL.Image import Image as ImageType
-from pkg_resources import resource_filename  # type: ignore[import-untyped]
 
 from gramps_webapi.const import MIME_PDF
 from gramps_webapi.types import FilenameOrPath
@@ -230,12 +230,11 @@ def detect_faces(stream: BinaryIO) -> list[tuple[float, float, float, float]]:
     assert cv_image is not None, "cv_image is None"  # for type checker
 
     # Load the YuNet model
-    model_path = resource_filename(
-        "gramps_webapi", "data/face_detection_yunet_2023mar.onnx"
-    )
-    face_detector = cv2.FaceDetectorYN.create(
-        model_path, "", (320, 320), score_threshold=0.5
-    )
+    ref = files("gramps_webapi") / "data/face_detection_yunet_2023mar.onnx"
+    with as_file(ref) as model_path:
+        face_detector = cv2.FaceDetectorYN.create(
+            str(model_path), "", (320, 320), score_threshold=0.5
+        )
 
     # Set input image size for YuNet
     height, width, _ = cv_image.shape

gramps_webapi/const.py

@@ -19,27 +19,40 @@
 
 """Constants for the web API."""
 
+import atexit
 import shutil
+from contextlib import ExitStack
+from importlib.resources import as_file, files
 
 import gramps.gen.lib as lib
 from gramps.gen.plug import CATEGORY_DRAW, CATEGORY_GRAPHVIZ, CATEGORY_TEXT
-from pkg_resources import resource_filename  # type: ignore[import-untyped]
 
 from ._version import __version__ as VERSION
 
 # the value of the TREE config option that enables multi-tree support
 TREE_MULTI = "*"
 
-# files
-TEST_CONFIG = resource_filename("gramps_webapi", "data/test.cfg")
-TEST_AUTH_CONFIG = resource_filename("gramps_webapi", "data/test_auth.cfg")
-TEST_EXAMPLE_GRAMPS_CONFIG = resource_filename(
+# Helper function to get resource file paths with managed cleanup
+_file_manager = ExitStack()
+atexit.register(_file_manager.close)
+
+
+def _get_resource_path(package: str, resource_path: str) -> str:
+    """Get the file system path for a package resource with managed cleanup."""
+    ref = files(package) / resource_path
+    return str(_file_manager.enter_context(as_file(ref)))
+
+
+# Configuration files
+TEST_CONFIG = _get_resource_path("gramps_webapi", "data/test.cfg")
+TEST_AUTH_CONFIG = _get_resource_path("gramps_webapi", "data/test_auth.cfg")
+TEST_EXAMPLE_GRAMPS_CONFIG = _get_resource_path(
     "gramps_webapi", "data/example_gramps.cfg"
 )
-TEST_EXAMPLE_GRAMPS_AUTH_CONFIG = resource_filename(
+TEST_EXAMPLE_GRAMPS_AUTH_CONFIG = _get_resource_path(
     "gramps_webapi", "data/example_gramps_auth.cfg"
 )
-TEST_EMPTY_GRAMPS_AUTH_CONFIG = resource_filename(
+TEST_EMPTY_GRAMPS_AUTH_CONFIG = _get_resource_path(
     "gramps_webapi", "data/empty_gramps_auth.cfg"
 )
 

tests/test_cli.py

@@ -215,11 +215,15 @@ def test_search_reindex_full_notree(self):
     def test_search_reindex_with_broken_progress_callback(self):
         """Test that would catch the original bug where progress_callback_count was undefined."""
         tree = WebDbManager(name=self.name).dirname
-        
+
         # Temporarily break the progress callback by patching it to raise an error
-        with patch('gramps_webapi.__main__.progress_callback_count_factory') as mock_factory:
-            mock_factory.side_effect = NameError("name 'progress_callback_count' is not defined")
-            
+        with patch(
+            "gramps_webapi.__main__.progress_callback_count_factory"
+        ) as mock_factory:
+            mock_factory.side_effect = NameError(
+                "name 'progress_callback_count' is not defined"
+            )
+
             result = self.runner.invoke(
                 cli,
                 [

tests/test_endpoints/__init__.py

@@ -20,12 +20,11 @@
 """Tests for the `gramps_webapi.api` module."""
 
 import os
-import shutil
+from importlib.resources import as_file, files
 from unittest.mock import patch
 
 import yaml
 from jsonschema import RefResolver
-from pkg_resources import resource_filename
 
 from gramps_webapi.api.search import get_search_indexer
 from gramps_webapi.app import create_app
@@ -41,8 +40,10 @@
 from gramps_webapi.dbmanager import WebDbManager
 from tests import TEST_GRAMPSHOME, ExampleDbSQLite
 
-with open(resource_filename("gramps_webapi", "data/apispec.yaml")) as file_handle:
-    API_SCHEMA = yaml.safe_load(file_handle)
+ref = files("gramps_webapi") / "data/apispec.yaml"
+with as_file(ref) as file_path:
+    with open(file_path, encoding="utf-8") as file_handle:
+        API_SCHEMA = yaml.safe_load(file_handle)
 
 API_RESOLVER = RefResolver(base_uri="", referrer=API_SCHEMA, store={"": API_SCHEMA})
 

tests/test_schema.py

@@ -20,10 +20,10 @@
 """Tests for the `gramps_webapi.api` module."""
 
 import unittest
+from importlib.resources import as_file, files
 
 import yaml
-from jsonschema import Draft4Validator, validate
-from pkg_resources import resource_filename
+from jsonschema import Draft4Validator
 
 
 class TestSchema(unittest.TestCase):
@@ -32,9 +32,9 @@ class TestSchema(unittest.TestCase):
     def test_schema(self):
         """Check schema for validity."""
         # check it loads okay
-        with open(
-            resource_filename("gramps_webapi", "data/apispec.yaml")
-        ) as file_handle:
-            api_schema = yaml.safe_load(file_handle)
+        ref = files("gramps_webapi") / "data/apispec.yaml"
+        with as_file(ref) as file_path:
+            with open(file_path, encoding="utf-8") as file_handle:
+                api_schema = yaml.safe_load(file_handle)
         # check structure
         Draft4Validator.check_schema(api_schema)

tests/test_version.py

@@ -20,9 +20,9 @@
 """Test consistent version numbers."""
 
 import unittest
+from importlib.resources import as_file, files
 
 import yaml
-from pkg_resources import resource_filename
 
 from gramps_webapi import __version__
 
@@ -32,8 +32,8 @@ class TestVersion(unittest.TestCase):
 
     def test_version(self):
         """Test version in setup and apispec are equal."""
-        with open(
-            resource_filename("gramps_webapi", "data/apispec.yaml")
-        ) as file_handle:
-            schema = yaml.safe_load(file_handle)
+        ref = files("gramps_webapi") / "data/apispec.yaml"
+        with as_file(ref) as file_path:
+            with open(file_path, encoding="utf-8") as file_handle:
+                schema = yaml.safe_load(file_handle)
         self.assertEqual(__version__, schema["info"]["version"])