Typing – Traversable vs MultiplexedPath return value of files() #286

Activity

1. jaraco commented on Aug 7, 2023

   

   jaraco

   on Aug 7, 2023

   Member

   More actions

   It's possible the current implementation of importlib resources will only return a MultiplexedPath, but the interface is extensible, with alternate resource providers directed to return objects conforming to the more general Traversable protocol.

   But when I look at the code, the only reader that returns a MultiplexedPath is a NamespaceReader. That makes me think that other readers probably don't return MultiplexedPath.

   Indeed, a standard module will return a pathlib.Path:

    draft @ mkdir foo
    draft @ touch foo/__init__.py
    draft @ pip-run importlib_resources
   Python 3.11.4 (main, Jun 20 2023, 17:23:00) [Clang 14.0.3 (clang-1403.0.22.14.1)] on darwin
   Type "help", "copyright", "credits" or "license" for more information.
   >>> import importlib_resources as res
   >>> res.files('foo')
   PosixPath('/Users/jaraco/draft/foo')
   

   And ZipReader returns a ZipPath:

   importlib_resources/importlib_resources/readers.py

   Line 53 in a203c1b

   return ZipPath(self.archive, self.prefix)

   mypy did not complain

   Probably the reason it did not complain is that the type annotations are incomplete. Still, mypy should have been smart enough to detect that a FileReader by dint of being a TraversableResources will return a Traversable for files(), which may not be a MultiplexedPath.
2. jaraco

   closed this as completedon Aug 7, 2023