Merge pull request #244 from henryiii/henryiii/types/fix1

fix(types): Adding some typing from typeshed

CHANGES.rst

@@ -1,3 +1,8 @@
+v5.6.0
+======
+
+* #244: Add type declarations in ABCs.
+
 v5.5.0
 ======
 

importlib_resources/_compat.py

@@ -1,9 +1,12 @@
 # flake8: noqa
 
 import abc
+import os
 import sys
 import pathlib
 from contextlib import suppress
+from typing import Union
+
 
 if sys.version_info >= (3, 10):
     from zipfile import Path as ZipPath  # type: ignore
@@ -96,3 +99,10 @@ def wrap_spec(package):
     from . import _adapters
 
     return _adapters.SpecLoaderAdapter(package.__spec__, TraversableResourcesLoader)
+
+
+if sys.version_info >= (3, 9):
+    StrPath = Union[str, os.PathLike[str]]
+else:
+    # PathLike is only subscriptable at runtime in 3.9+
+    StrPath = Union[str, "os.PathLike[str]"]

importlib_resources/abc.py

@@ -1,7 +1,11 @@
 import abc
-from typing import BinaryIO, Iterable, Text
+import io
+from typing import Any, BinaryIO, Iterable, Iterator, NoReturn, Text, Optional
 
-from ._compat import runtime_checkable, Protocol
+from ._compat import runtime_checkable, Protocol, StrPath
+
+
+__all__ = ["ResourceReader", "Traversable", "TraversableResources"]
 
 
 class ResourceReader(metaclass=abc.ABCMeta):
@@ -54,19 +58,19 @@ class Traversable(Protocol):
     """
 
     @abc.abstractmethod
-    def iterdir(self):
+    def iterdir(self) -> Iterator["Traversable"]:
         """
         Yield Traversable objects in self
         """
 
-    def read_bytes(self):
+    def read_bytes(self) -> bytes:
         """
         Read contents of self as bytes
         """
         with self.open('rb') as strm:
             return strm.read()
 
-    def read_text(self, encoding=None):
+    def read_text(self, encoding: Optional[str] = None) -> str:
         """
         Read contents of self as text
         """
@@ -86,12 +90,12 @@ def is_file(self) -> bool:
         """
 
     @abc.abstractmethod
-    def joinpath(self, child):
+    def joinpath(self, child: StrPath) -> "Traversable":
         """
         Return Traversable child in self
         """
 
-    def __truediv__(self, child):
+    def __truediv__(self, child: StrPath) -> "Traversable":
         """
         Return Traversable child in self
         """
@@ -121,17 +125,17 @@ class TraversableResources(ResourceReader):
     """
 
     @abc.abstractmethod
-    def files(self):
+    def files(self) -> "Traversable":
         """Return a Traversable object for the loaded package."""
 
-    def open_resource(self, resource):
+    def open_resource(self, resource: StrPath) -> io.BufferedReader:
         return self.files().joinpath(resource).open('rb')
 
-    def resource_path(self, resource):
+    def resource_path(self, resource: Any) -> NoReturn:
         raise FileNotFoundError(resource)
 
-    def is_resource(self, path):
+    def is_resource(self, path: StrPath) -> bool:
         return self.files().joinpath(path).is_file()
 
-    def contents(self):
+    def contents(self) -> Iterator[str]:
         return (item.name for item in self.files().iterdir())