use files() API in contents()

Signed-off-by: Filipe Laíns <[email protected]>

Author: FFY00

importlib_resources/__init__.py

@@ -3,12 +3,12 @@
 from ._common import (
     as_file,
     files,
+    contents,
 )
 
 from importlib_resources._py3 import (
     Package,
     Resource,
-    contents,
     is_resource,
     open_binary,
     open_text,

importlib_resources/_common.py

@@ -6,7 +6,7 @@
 import types
 import importlib
 
-from typing import Union, Any, Optional
+from typing import Union, Any, Optional, Iterable
 from .abc import ResourceReader
 
 from ._compat import wrap_spec
@@ -112,3 +112,16 @@ def _(path):
     Degenerate behavior for pathlib.Path objects.
     """
     yield path
+
+
+# legacy API
+
+
+def contents(package: Package) -> Iterable[str]:
+    """Return an iterable of entries in `package`.
+
+    Note that not all entries are resources.  Specifically, directories are
+    not considered resources.  Use `is_resource()` on each entry returned here
+    to check if it is a resource or not.
+    """
+    return [path.name for path in files(package).iterdir()]

importlib_resources/_py3.py

@@ -8,7 +8,7 @@
 from io import BytesIO, TextIOWrapper
 from pathlib import Path
 from types import ModuleType
-from typing import ContextManager, Iterable, Union
+from typing import ContextManager, Union
 from typing import cast
 from typing.io import BinaryIO, TextIO
 from collections.abc import Sequence
@@ -135,29 +135,12 @@ def is_resource(package: Package, name: str) -> bool:
     reader = _common.get_resource_reader(package)
     if reader is not None:
         return reader.is_resource(name)
-    package_contents = set(contents(package))
+    package_contents = set(_common.contents(package))
     if name not in package_contents:
         return False
     return (_common.from_package(package) / name).is_file()
 
 
-def contents(package: Package) -> Iterable[str]:
-    """Return an iterable of entries in `package`.
-
-    Note that not all entries are resources.  Specifically, directories are
-    not considered resources.  Use `is_resource()` on each entry returned here
-    to check if it is a resource or not.
-    """
-    package = _common.get_package(package)
-    reader = _common.get_resource_reader(package)
-    if reader is not None:
-        return _ensure_sequence(reader.contents())
-    transversable = _common.from_package(package)
-    if transversable.is_dir():
-        return list(item.name for item in transversable.iterdir())
-    return []
-
-
 @singledispatch
 def _ensure_sequence(iterable):
     return list(iterable)

importlib_resources/tests/test_resource.py

@@ -33,14 +33,14 @@ def test_contents(self):
         # are not germane to this test, so just filter them out.
         contents.discard('__pycache__')
         self.assertEqual(
-            contents,
-            {
+            sorted(contents),
+            [
                 '__init__.py',
-                'subdirectory',
-                'utf-8.file',
                 'binary.file',
+                'subdirectory',
                 'utf-16.file',
-            },
+                'utf-8.file',
+            ],
         )