Split compat up into multiple files to improve import times

Author: domdfcoding

domdf_python_tools/compat.py renamed to domdf_python_tools/compat/__init__.py

@@ -76,20 +76,6 @@
 
 __all__ = ["importlib_resources", "importlib_metadata", "nullcontext", "PYPY", "PYPY36", "PYPY37"]
 
-if sys.version_info[:2] < (3, 7):  # pragma: no cover (py37+)
-	# 3rd party
-	import importlib_resources
-else:  # pragma: no cover (<py37)
-	# stdlib
-	import importlib.resources as importlib_resources
-
-if sys.version_info[:2] < (3, 9):  # pragma: no cover (py39+)
-	# 3rd party
-	import importlib_metadata
-else:  # pragma: no cover (<py39)
-	# stdlib
-	import importlib.metadata as importlib_metadata
-
 if sys.version_info[:2] < (3, 7) or domdf_python_tools.__docs or TYPE_CHECKING:  # pragma: no cover (py37+)
 
 	_T = TypeVar("_T")

domdf_python_tools/compat/importlib_metadata.py

@@ -0,0 +1,9 @@
+# stdlib
+import sys
+
+if sys.version_info[:2] < (3, 9):  # pragma: no cover (py39+)
+	# 3rd party
+	from importlib_metadata import *
+else:  # pragma: no cover (<py39)
+	# stdlib
+	from importlib.metadata import *

domdf_python_tools/compat/importlib_metadata.pyi

@@ -0,0 +1,131 @@
+# From https://github.com/python/typeshed
+# Apache-2.0 Licensed
+
+# stdlib
+import abc
+import pathlib
+import sys
+from collections.abc import Mapping
+from email.message import Message
+from importlib.abc import MetaPathFinder
+from os import PathLike
+from pathlib import Path
+from typing import Any, Dict, Iterable, List, NamedTuple, Optional, Tuple, Union, overload
+
+StrPath = Union[str, PathLike[str]]
+
+if sys.version_info >= (3, 10):
+
+	def packages_distributions() -> Mapping[str, List[str]]: ...
+
+class PackageNotFoundError(ModuleNotFoundError): ...
+
+class _EntryPointBase(NamedTuple):
+	name: str
+	value: str
+	group: str
+
+class EntryPoint(_EntryPointBase):
+	def load(self) -> Any: ...  # Callable[[], Any] or an importable module
+
+	@property
+	def extras(self) -> List[str]: ...
+
+class PackagePath(pathlib.PurePosixPath):
+	def read_text(self, encoding: str = ...) -> str: ...
+	def read_binary(self) -> bytes: ...
+	def locate(self) -> PathLike[str]: ...
+
+	# The following attributes are not defined on PackagePath, but are dynamically added by Distribution.files:
+	hash: Optional[FileHash]
+	size: Optional[int]
+	dist: Distribution
+
+class FileHash:
+	mode: str
+	value: str
+
+	def __init__(self, spec: str) -> None: ...
+
+class Distribution:
+
+	@abc.abstractmethod
+	def read_text(self, filename: str) -> Optional[str]: ...
+
+	@abc.abstractmethod
+	def locate_file(self, path: StrPath) -> PathLike[str]: ...
+
+	@classmethod
+	def from_name(cls, name: str) -> Distribution: ...
+
+	@overload
+	@classmethod
+	def discover(cls, *, context: DistributionFinder.Context) -> Iterable[Distribution]: ...
+
+	@overload
+	@classmethod
+	def discover(cls,
+					*,
+					context: None = ...,
+					name: Optional[str] = ...,
+					path: List[str] = ...,
+					**kwargs: Any) -> Iterable[Distribution]: ...
+
+	@staticmethod
+	def at(path: StrPath) -> PathDistribution: ...
+
+	@property
+	def metadata(self) -> Message: ...
+
+	@property
+	def version(self) -> str: ...
+
+	@property
+	def entry_points(self) -> List[EntryPoint]: ...
+
+	@property
+	def files(self) -> Optional[List[PackagePath]]: ...
+
+	@property
+	def requires(self) -> Optional[List[str]]: ...
+
+class DistributionFinder(MetaPathFinder):
+
+	class Context:
+		name: Optional[str]
+
+		def __init__(self, *, name: Optional[str] = ..., path: List[str] = ..., **kwargs: Any) -> None: ...
+
+		@property
+		def path(self) -> List[str]: ...
+
+	@abc.abstractmethod
+	def find_distributions(self, context: DistributionFinder.Context = ...) -> Iterable[Distribution]: ...
+
+class MetadataPathFinder(DistributionFinder):
+
+	@classmethod
+	def find_distributions(cls, context: DistributionFinder.Context = ...) -> Iterable[PathDistribution]: ...
+
+class PathDistribution(Distribution):
+	def __init__(self, path: Path) -> None: ...
+	def read_text(self, filename: StrPath) -> str: ...
+	def locate_file(self, path: StrPath) -> PathLike[str]: ...
+
+def distribution(distribution_name: str) -> Distribution: ...
+
+@overload
+def distributions(*, context: DistributionFinder.Context) -> Iterable[Distribution]: ...
+
+@overload
+def distributions(*,
+					context: None = ...,
+					name: Optional[str] = ...,
+					path: List[str] = ...,
+					**kwargs: Any) -> Iterable[Distribution]: ...
+
+def metadata(distribution_name: str) -> Message: ...
+def version(distribution_name: str) -> str: ...
+def entry_points() -> Dict[str, Tuple[EntryPoint, ...]]: ...
+def files(distribution_name: str) -> Optional[List[PackagePath]]: ...
+def requires(distribution_name: str) -> Optional[List[str]]: ...

domdf_python_tools/compat/importlib_resources.py

@@ -0,0 +1,9 @@
+# stdlib
+import sys
+
+if sys.version_info[:2] < (3, 7):  # pragma: no cover (py37+)
+	# 3rd party
+	from importlib_resources import *
+else:  # pragma: no cover (<py39)
+	# stdlib
+	from importlib.resources import *

domdf_python_tools/compat/importlib_resources.pyi

@@ -0,0 +1,26 @@
+# From https://github.com/python/typeshed
+# Apache-2.0 Licensed
+
+import sys
+from typing import Any
+
+import os
+from pathlib import Path
+from types import ModuleType
+from typing import BinaryIO, ContextManager, Iterator, TextIO, Union
+
+Package = Union[str, ModuleType]
+Resource = Union[str, os.PathLike[Any]]
+def open_binary(package: Package, resource: Resource) -> BinaryIO: ...
+def open_text(package: Package, resource: Resource, encoding: str = ..., errors: str = ...) -> TextIO: ...
+def read_binary(package: Package, resource: Resource) -> bytes: ...
+def read_text(package: Package, resource: Resource, encoding: str = ..., errors: str = ...) -> str: ...
+def path(package: Package, resource: Resource) -> ContextManager[Path]: ...
+def is_resource(package: Package, name: str) -> bool: ...
+def contents(package: Package) -> Iterator[str]: ...
+
+if sys.version_info >= (3, 9):
+    from contextlib import AbstractContextManager
+    from importlib.abc import Traversable
+    def files(package: Package) -> Traversable: ...
+    def as_file(path: Traversable) -> AbstractContextManager[Path]: ...

tests/test_import_tools_/test_iter_submodules_domdf_python_tools_3_10_.yml

@@ -2,6 +2,8 @@
 - domdf_python_tools._is_match
 - domdf_python_tools.bases
 - domdf_python_tools.compat
+- domdf_python_tools.compat.importlib_metadata
+- domdf_python_tools.compat.importlib_resources
 - domdf_python_tools.dates
 - domdf_python_tools.delegators
 - domdf_python_tools.doctools

tests/test_import_tools_/test_iter_submodules_domdf_python_tools_3_6_.yml

@@ -2,6 +2,8 @@
 - domdf_python_tools._is_match
 - domdf_python_tools.bases
 - domdf_python_tools.compat
+- domdf_python_tools.compat.importlib_metadata
+- domdf_python_tools.compat.importlib_resources
 - domdf_python_tools.dates
 - domdf_python_tools.delegators
 - domdf_python_tools.doctools

tests/test_import_tools_/test_iter_submodules_domdf_python_tools_3_7_.yml

@@ -2,6 +2,8 @@
 - domdf_python_tools._is_match
 - domdf_python_tools.bases
 - domdf_python_tools.compat
+- domdf_python_tools.compat.importlib_metadata
+- domdf_python_tools.compat.importlib_resources
 - domdf_python_tools.dates
 - domdf_python_tools.delegators
 - domdf_python_tools.doctools

tests/test_import_tools_/test_iter_submodules_domdf_python_tools_3_7_pypy_.yml

@@ -2,6 +2,8 @@
 - domdf_python_tools._is_match
 - domdf_python_tools.bases
 - domdf_python_tools.compat
+- domdf_python_tools.compat.importlib_metadata
+- domdf_python_tools.compat.importlib_resources
 - domdf_python_tools.dates
 - domdf_python_tools.delegators
 - domdf_python_tools.doctools

tests/test_import_tools_/test_iter_submodules_domdf_python_tools_3_8_.yml

@@ -2,6 +2,8 @@
 - domdf_python_tools._is_match
 - domdf_python_tools.bases
 - domdf_python_tools.compat
+- domdf_python_tools.compat.importlib_metadata
+- domdf_python_tools.compat.importlib_resources
 - domdf_python_tools.dates
 - domdf_python_tools.delegators
 - domdf_python_tools.doctools