switch to importlib_{metadata,resources} from deprecated pkg_resources

Author: mr-c

mypy-requirements.txt

@@ -1,6 +1,5 @@
 mypy==1.4.1  # update pyproject.toml as well
 black>=19.10b0
-types-pkg_resources
 types-requests
 types-dataclasses
 objgraph

pyproject.toml

@@ -5,9 +5,9 @@ requires = [
     'mypy==0.971; python_version == "3.6"',  # last version for Python 3.6
     'mypy==1.4.1; python_version >= "3.7"',  # update mypy-requirements as well
     "black>=19.10b0",
-    "types-pkg_resources",
     "types-requests",
     "types-dataclasses",
+    "importlib_resources>=1.4",  # equivalent to Python 3.9
     "ruamel.yaml>= 0.12.4, != 0.16.6, < 0.18",
     "types-setuptools"
 ]

requirements.txt

@@ -10,3 +10,6 @@ CacheControl[filecache]< 0.13;python_version<='3.6'
 urllib3<2;python_version<='3.6'
 black<23.8
 mypy_extensions
+importlib_metadata;python_version<'3.8'
+importlib_resources>=1.4
+# ^^ equivalent to Python 3.9

schema_salad/dotnet_codegen.py

@@ -16,7 +16,7 @@
 )
 from xml.sax.saxutils import escape  # nosec
 
-import pkg_resources
+from importlib_resources import files
 
 from . import _logger, schema
 from .codegen_base import CodeGenBase, TypeDef
@@ -855,15 +855,13 @@ def epilogue(self, root_loader: TypeDef) -> None:
             license_name="Apache License, Version 2.0",
         )
 
-        def template_from_resource(resource: str) -> string.Template:
-            template_str = pkg_resources.resource_string(__name__, f"dotnet/{resource}").decode(
-                "utf-8"
-            )
+        def template_from_resource(resource: Path) -> string.Template:
+            template_str = resource.read_text("utf-8")
             template = string.Template(template_str)
             return template
 
         def expand_resource_template_to(resource: str, path: Path) -> None:
-            template = template_from_resource(resource)
+            template = template_from_resource(files("schema_salad").joinpath(f"dotnet/{resource}"))
             src = template.safe_substitute(template_vars)
             _ensure_directory_and_write(path, src)
 
@@ -944,13 +942,12 @@ def expand_resource_template_to(resource: str, path: Path) -> None:
         }
 
         def copy_utils_recursive(util_src: str, util_target: Path) -> None:
-            for util in pkg_resources.resource_listdir(__name__, f"dotnet/{util_src}"):
-                template_path = os.path.join(util_src, util)
-                if pkg_resources.resource_isdir(__name__, f"dotnet/{template_path}"):
-                    copy_utils_recursive(os.path.join(util_src, util), util_target / util)
+            for util in files("schema_salad").joinpath(f"dotnet/{util_src}").iterdir():
+                if util.is_dir():
+                    copy_utils_recursive(os.path.join(util_src, util.name), util_target / util.name)
                     continue
-                src_path = util_target / util
-                src_template = template_from_resource(template_path)
+                src_path = util_target / util.name
+                src_template = template_from_resource(util)
                 src = src_template.safe_substitute(template_args)
                 _ensure_directory_and_write(src_path, src)
 

schema_salad/java_codegen.py

@@ -16,7 +16,7 @@
     Union,
 )
 
-import pkg_resources
+from importlib_resources import files
 
 from . import _logger, schema
 from .codegen_base import CodeGenBase, TypeDef
@@ -788,15 +788,13 @@ def epilogue(self, root_loader: TypeDef) -> None:
             license_url="https://www.apache.org/licenses/LICENSE-2.0.txt",
         )
 
-        def template_from_resource(resource: str) -> string.Template:
-            template_str = pkg_resources.resource_string(__name__, f"java/{resource}").decode(
-                "utf-8"
-            )
+        def template_from_resource(resource: Path) -> string.Template:
+            template_str = resource.read_text("utf-8")
             template = string.Template(template_str)
             return template
 
         def expand_resource_template_to(resource: str, path: Path) -> None:
-            template = template_from_resource(resource)
+            template = template_from_resource(files("schema_salad").joinpath(f"java/{resource}"))
             src = template.safe_substitute(template_vars)
             _ensure_directory_and_write(path, src)
 
@@ -880,9 +878,9 @@ def expand_resource_template_to(resource: str, path: Path) -> None:
             "test_utils": self.test_src_dir,
         }
         for util_src, util_target in util_src_dirs.items():
-            for util in pkg_resources.resource_listdir(__name__, f"java/{util_src}"):
-                src_path = util_target / "utils" / util
-                src_template = template_from_resource(os.path.join(util_src, util))
+            for util in files("schema_salad").joinpath(f"java/{util_src}").iterdir():
+                src_path = util_target / "utils" / util.name
+                src_template = template_from_resource(util)
                 src = src_template.safe_substitute(template_args)
                 _ensure_directory_and_write(src_path, src)
 

schema_salad/main.py

@@ -7,7 +7,6 @@
 from typing import Any, Dict, List, Mapping, MutableSequence, Optional, Union, cast
 from urllib.parse import urlparse
 
-import pkg_resources  # part of setuptools
 from rdflib import __version__ as rdflib_version
 from rdflib.parser import Parser
 from rdflib.plugin import register
@@ -22,6 +21,11 @@
 
 if int(rdflib_version.split(".", maxsplit=1)[0]) < 6:
     register("json-ld", Parser, "rdflib_jsonld.parser", "JsonLDParser")
+
+if sys.version_info >= (3, 8):
+    import importlib.metadata as importlib_metadata
+else:
+    import importlib_metadata
 _logger = logging.getLogger("salad")
 
 
@@ -221,12 +225,12 @@ def main(argsl: Optional[List[str]] = None) -> int:
     if args.debug:
         _logger.setLevel(logging.DEBUG)
 
-    pkg = pkg_resources.require("schema_salad")
+    pkg = importlib_metadata.version("schema_salad")
     if pkg:
         if args.version:
-            print(f"{sys.argv[0]} Current version: {pkg[0].version}")
+            print(f"{sys.argv[0]} Current version: {pkg}")
             return 0
-        _logger.info("%s Current version: %s", sys.argv[0], pkg[0].version)
+        _logger.info("%s Current version: %s", sys.argv[0], pkg)
 
     # Get the metaschema to validate the schema
     metaschema_names, metaschema_doc, metaschema_loader = schema.get_metaschema()

schema_salad/python_codegen.py

@@ -18,7 +18,7 @@
 except ModuleNotFoundError:
     black = None  # type: ignore[assignment]
 
-from pkg_resources import resource_stream
+from importlib_resources import files
 
 from . import schema
 from .codegen_base import CodeGenBase, TypeDef
@@ -125,10 +125,10 @@ def prologue(self) -> None:
                 )
             )
 
-        stream = resource_stream(__name__, "python_codegen_support.py")
-        python_codegen_support = stream.read().decode("UTF-8")
+        python_codegen_support = (
+            files("schema_salad").joinpath("python_codegen_support.py").read_text("UTF-8")
+        )
         self.out.write(python_codegen_support[python_codegen_support.find("\n") + 1 :])
-        stream.close()
         self.out.write("\n\n")
 
         self.out.write(

schema_salad/schema.py

@@ -19,7 +19,7 @@
 )
 from urllib.parse import urlparse
 
-from pkg_resources import resource_stream
+from importlib_resources import files
 from ruamel.yaml.comments import CommentedMap, CommentedSeq
 
 from schema_salad.utils import (
@@ -182,11 +182,13 @@ def get_metaschema() -> Tuple[Names, List[Dict[str, str]], Loader]:
     )
 
     for salad in SALAD_FILES:
-        with resource_stream("schema_salad", "metaschema/" + salad) as stream:
-            loader.cache["https://w3id.org/cwl/" + salad] = stream.read().decode("UTF-8")
+        loader.cache["https://w3id.org/cwl/" + salad] = (
+            files("schema_salad").joinpath("metaschema/" + salad).read_text("UTF-8")
+        )
 
-    with resource_stream("schema_salad", "metaschema/metaschema.yml") as stream:
-        loader.cache["https://w3id.org/cwl/salad"] = stream.read().decode("UTF-8")
+    loader.cache["https://w3id.org/cwl/salad"] = (
+        files("schema_salad").joinpath("metaschema/metaschema.yml").read_text("UTF-8")
+    )
 
     yaml = yaml_no_ts()
     j = yaml.load(loader.cache["https://w3id.org/cwl/salad"])

schema_salad/typescript_codegen.py

@@ -15,7 +15,7 @@
     Union,
 )
 
-import pkg_resources
+from importlib_resources import files
 
 from . import _logger, schema
 from .codegen_base import CodeGenBase, TypeDef
@@ -731,15 +731,15 @@ def epilogue(self, root_loader: TypeDef) -> None:
             generated_class_imports=generated_class_imports,
         )
 
-        def template_from_resource(resource: str) -> string.Template:
-            template_str = pkg_resources.resource_string(__name__, f"typescript/{resource}").decode(
-                "utf-8"
-            )
+        def template_from_resource(resource: Path) -> string.Template:
+            template_str = resource.read_text("utf-8")
             template = string.Template(template_str)
             return template
 
         def expand_resource_template_to(resource: str, path: Path) -> None:
-            template = template_from_resource(resource)
+            template = template_from_resource(
+                files("schema_salad").joinpath(f"typescript/{resource}")
+            )
             src = template.safe_substitute(template_vars)
             _ensure_directory_and_write(path, src)
 
@@ -806,13 +806,12 @@ def expand_resource_template_to(resource: str, path: Path) -> None:
         }
 
         def copy_utils_recursive(util_src: str, util_target: Path) -> None:
-            for util in pkg_resources.resource_listdir(__name__, f"typescript/{util_src}"):
-                template_path = os.path.join(util_src, util)
-                if pkg_resources.resource_isdir(__name__, f"typescript/{template_path}"):
-                    copy_utils_recursive(os.path.join(util_src, util), util_target / util)
+            for util in files("schema_salad").joinpath(f"typescript/{util_src}").iterdir():
+                if util.is_dir():
+                    copy_utils_recursive(os.path.join(util_src, util.name), util_target / util.name)
                     continue
-                src_path = util_target / util
-                src_template = template_from_resource(template_path)
+                src_path = util_target / util.name
+                src_template = template_from_resource(util)
                 src = src_template.safe_substitute(template_args)
                 _ensure_directory_and_write(src_path, src)
 

setup.py

@@ -91,6 +91,8 @@
     "CacheControl[filecache] < 0.13;python_version<='3.6'",
     "urllib3<2;python_version<='3.6'",
     "mypy_extensions",
+    "importlib_resources>=1.4",  # equivalent to Python 3.9,
+    "importlib_metadata;python_version<'3.8'",
 ]
 
 extras_require = {