remove last usage of pkg_resources

Author: mr-c

mypy-requirements.txt

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

pyproject.toml

@@ -4,10 +4,9 @@ requires = [
     "setuptools_scm[toml]>=8.0.4,<9",
     'mypy[mypyc]==1.7.0',  # update mypy-requirements as well
     "black>=19.10b0,<23.12",
-    "types-pkg_resources",
     "types-requests",
     "types-dataclasses",
-    "importlib_resources>=1.4",  # equivalent to Python 3.9
+    "importlib_resources>=1.4;python_version<'3.9'",
     "ruamel.yaml>=0.17.6, < 0.19",
     "types-setuptools"
 ]

requirements.txt

@@ -5,5 +5,4 @@ mistune>=2.0.3,<2.1
 CacheControl[filecache]>= 0.11.7, < 0.14
 black>=19.10b0,<23.12
 mypy_extensions
-importlib_resources>=1.4
-# ^^ equivalent to Python 3.9
+importlib_resources>=1.4;python_version<'3.9'

schema_salad/dotnet_codegen.py

@@ -16,13 +16,12 @@
 )
 from xml.sax.saxutils import escape  # nosec
 
-from importlib_resources import files
-
 from . import _logger, schema
 from .codegen_base import CodeGenBase, LazyInitDef, TypeDef
 from .exceptions import SchemaException
 from .java_codegen import _ensure_directory_and_write, _safe_makedirs
 from .schema import shortname
+from .utils import Traversable, files
 
 
 def doc_to_doc_string(doc: Optional[str], indent_level: int = 0) -> str:
@@ -907,7 +906,7 @@ def epilogue(self, root_loader: TypeDef) -> None:
             license_name="Apache License, Version 2.0",
         )
 
-        def template_from_resource(resource: Path) -> string.Template:
+        def template_from_resource(resource: Traversable) -> string.Template:
             template_str = resource.read_text("utf-8")
             template = string.Template(template_str)
             return template

schema_salad/java_codegen.py

@@ -16,12 +16,11 @@
     Union,
 )
 
-from importlib_resources import files
-
 from . import _logger, schema
 from .codegen_base import CodeGenBase, LazyInitDef, TypeDef
 from .exceptions import SchemaException
 from .schema import shortname
+from .utils import Traversable, files
 
 # experiment at providing more typed objects building a optional type that allows
 # referencing one or a list of objects. It is useful for improving the RootLoader
@@ -885,7 +884,7 @@ def epilogue(self, root_loader: TypeDef) -> None:
             license_url="https://www.apache.org/licenses/LICENSE-2.0.txt",
         )
 
-        def template_from_resource(resource: Path) -> string.Template:
+        def template_from_resource(resource: Traversable) -> string.Template:
             template_str = resource.read_text("utf-8")
             template = string.Template(template_str)
             return template

schema_salad/python_codegen.py

@@ -1,19 +1,28 @@
 """Python code generator for a given schema salad definition."""
 import textwrap
 from io import StringIO
-from typing import Any, Dict, IO, List, MutableMapping, MutableSequence, Optional, Set, Union
+from typing import (
+    IO,
+    Any,
+    Dict,
+    List,
+    MutableMapping,
+    MutableSequence,
+    Optional,
+    Set,
+    Union,
+)
 
 try:
     import black
 except ModuleNotFoundError:
     black = None  # type: ignore[assignment]
 
-from importlib_resources import files
-
 from . import schema
 from .codegen_base import CodeGenBase, LazyInitDef, TypeDef
 from .exceptions import SchemaException
 from .schema import shortname
+from .utils import files
 
 _string_type_def = TypeDef("strtype", "_PrimitiveLoader(str)")
 _int_type_def = TypeDef("inttype", "_PrimitiveLoader(int)")

schema_salad/schema.py

@@ -19,7 +19,6 @@
 )
 from urllib.parse import urlparse
 
-from importlib_resources import files
 from ruamel.yaml.comments import CommentedMap, CommentedSeq
 
 from schema_salad.utils import (
@@ -28,6 +27,7 @@
     add_dictlist,
     aslist,
     convert_to_dict,
+    files,
     flatten,
     json_dumps,
     yaml_no_ts,

schema_salad/tests/util.py

@@ -1,9 +1,12 @@
+"""Shared test functions and attributes."""
+import atexit
 import os
+from contextlib import ExitStack
+from pathlib import Path
 from typing import Optional
 
-from pkg_resources import Requirement, ResolutionError, resource_filename
-
 from schema_salad import ref_resolver
+from schema_salad.utils import as_file, files
 
 
 def get_data(filename: str) -> Optional[str]:
@@ -16,18 +19,21 @@ def get_data(filename: str) -> Optional[str]:
     # or else it will cause problem when joining path
     filepath = None
     try:
-        filepath = resource_filename(Requirement.parse("schema-salad"), filename)
-    except ResolutionError:
+        file_manager = ExitStack()
+        atexit.register(file_manager.close)
+        traversable = files("schema-salad") / filename
+        filepath = file_manager.enter_context(as_file(traversable))
+    except ModuleNotFoundError:
         pass
     if not filepath or not os.path.isfile(filepath):
         # First try to load it from the local directory, probably ``./tests/``.
-        filepath = os.path.join(os.path.dirname(__file__), filename)
-        if not os.path.isfile(filepath):
+        filepath = Path(os.path.dirname(__file__)) / filename
+        if not filepath.is_file():
             # If that didn't work, then default to tests/../${filename},
             # note that we return the parent as it is expected that __file__
             # is a test file.
-            filepath = os.path.join(os.path.dirname(__file__), os.pardir, filename)
-    return filepath
+            filepath = Path(os.path.dirname(__file__)) / ".." / filename
+    return str(filepath.resolve())
 
 
 def get_data_uri(resource_path: str) -> str:

schema_salad/typescript_codegen.py

@@ -15,13 +15,12 @@
     Union,
 )
 
-from importlib_resources import files
-
 from . import _logger, schema
 from .codegen_base import CodeGenBase, LazyInitDef, TypeDef
 from .exceptions import SchemaException
 from .java_codegen import _ensure_directory_and_write, _safe_makedirs
 from .schema import shortname
+from .utils import Traversable, files
 
 
 def doc_to_doc_string(doc: Optional[str], indent_level: int = 0) -> str:
@@ -781,7 +780,7 @@ def epilogue(self, root_loader: TypeDef) -> None:
             generated_class_imports=generated_class_imports,
         )
 
-        def template_from_resource(resource: Path) -> string.Template:
+        def template_from_resource(resource: Traversable) -> string.Template:
             template_str = resource.read_text("utf-8")
             template = string.Template(template_str)
             return template

schema_salad/utils.py

@@ -26,6 +26,18 @@
 if TYPE_CHECKING:
     from .fetcher import Fetcher
 
+if sys.version_info >= (3, 11):
+    from importlib.resources import as_file, files
+    from importlib.resources.abc import Traversable
+elif sys.version_info >= (3, 9):
+    from importlib.abc import Traversable
+    from importlib.resources import as_file, files
+else:
+    from importlib_resources import as_file, files
+    from importlib_resources.abc import Traversable
+
+__all__ = ["files", "as_file", "Traversable"]
+
 ContextType = Dict[str, Union[Dict[str, Any], str, Iterable[str]]]
 DocumentType = TypeVar("DocumentType", CommentedSeq, CommentedMap)
 DocumentOrStrType = TypeVar("DocumentOrStrType", CommentedSeq, CommentedMap, str)