gh-127012: Traversable.read_text now allows/solicits an errors parameter. (#148401)

Applies changes from importlib_resources 6.5.2.

Author: jaraco

Lib/importlib/resources/__init__.py

@@ -8,12 +8,11 @@
 """
 
 from ._common import (
+    Anchor,
+    Package,
     as_file,
     files,
-    Package,
-    Anchor,
 )
-
 from ._functional import (
     contents,
     is_resource,
@@ -23,10 +22,8 @@
     read_binary,
     read_text,
 )
-
 from .abc import ResourceReader
 
-
 __all__ = [
     'Package',
     'Anchor',

Lib/importlib/resources/_common.py

@@ -1,14 +1,14 @@
-import os
-import pathlib
-import tempfile
-import functools
 import contextlib
-import types
+import functools
 import importlib
 import inspect
 import itertools
+import os
+import pathlib
+import tempfile
+import types
+from typing import cast, Optional, Union
 
-from typing import Union, Optional, cast
 from .abc import ResourceReader, Traversable
 
 Package = Union[types.ModuleType, str]
@@ -32,7 +32,7 @@ def get_resource_reader(package: types.ModuleType) -> Optional[ResourceReader]:
     # zipimport.zipimporter does not support weak references, resulting in a
     # TypeError.  That seems terrible.
     spec = package.__spec__
-    reader = getattr(spec.loader, 'get_resource_reader', None)  # type: ignore[union-attr]
+    reader = getattr(spec.loader, "get_resource_reader", None)  # type: ignore[union-attr]
     if reader is None:
         return None
     return reader(spec.name)  # type: ignore[union-attr]
@@ -50,7 +50,7 @@ def _(cand: str) -> types.ModuleType:
 
 @resolve.register
 def _(cand: None) -> types.ModuleType:
-    return resolve(_infer_caller().f_globals['__name__'])
+    return resolve(_infer_caller().f_globals["__name__"])
 
 
 def _infer_caller():
@@ -62,7 +62,7 @@ def is_this_file(frame_info):
         return frame_info.filename == stack[0].filename
 
     def is_wrapper(frame_info):
-        return frame_info.function == 'wrapper'
+        return frame_info.function == "wrapper"
 
     stack = inspect.stack()
     not_this_file = itertools.filterfalse(is_this_file, stack)
@@ -87,7 +87,7 @@ def from_package(package: types.ModuleType):
 @contextlib.contextmanager
 def _tempfile(
     reader,
-    suffix='',
+    suffix="",
     # gh-93353: Keep a reference to call os.remove() in late Python
     # finalization.
     *,

Lib/importlib/resources/_functional.py

@@ -2,8 +2,8 @@
 
 import warnings
 
-from ._common import files, as_file
-
+from ._common import as_file, files
+from .abc import TraversalError
 
 _MISSING = object()
 
@@ -42,7 +42,10 @@ def is_resource(anchor, *path_names):
 
     Otherwise returns ``False``.
     """
-    return _get_resource(anchor, path_names).is_file()
+    try:
+        return _get_resource(anchor, path_names).is_file()
+    except TraversalError:
+        return False
 
 
 def contents(anchor, *path_names):

Lib/importlib/resources/abc.py

@@ -1,12 +1,22 @@
 import abc
-import io
 import itertools
 import os
 import pathlib
-from typing import Any, BinaryIO, Iterable, Iterator, NoReturn, Text, Optional
-from typing import runtime_checkable, Protocol
-from typing import Union
-
+from typing import (
+    Any,
+    BinaryIO,
+    Iterable,
+    Iterator,
+    Literal,
+    NoReturn,
+    Optional,
+    Protocol,
+    Text,
+    TextIO,
+    Union,
+    overload,
+    runtime_checkable,
+)
 
 StrPath = Union[str, os.PathLike[str]]
 
@@ -82,11 +92,13 @@ def read_bytes(self) -> bytes:
         with self.open('rb') as strm:
             return strm.read()
 
-    def read_text(self, encoding: Optional[str] = None) -> str:
+    def read_text(
+        self, encoding: Optional[str] = None, errors: Optional[str] = None
+    ) -> str:
         """
         Read contents of self as text
         """
-        with self.open(encoding=encoding) as strm:
+        with self.open(encoding=encoding, errors=errors) as strm:
             return strm.read()
 
     @abc.abstractmethod
@@ -132,8 +144,16 @@ def __truediv__(self, child: StrPath) -> "Traversable":
         """
         return self.joinpath(child)
 
+    @overload
+    def open(self, mode: Literal['r'] = 'r', *args: Any, **kwargs: Any) -> TextIO: ...
+
+    @overload
+    def open(self, mode: Literal['rb'], *args: Any, **kwargs: Any) -> BinaryIO: ...
+
     @abc.abstractmethod
-    def open(self, mode='r', *args, **kwargs):
+    def open(
+        self, mode: str = 'r', *args: Any, **kwargs: Any
+    ) -> Union[TextIO, BinaryIO]:
         """
         mode may be 'r' or 'rb' to open as text or binary. Return a handle
         suitable for reading (same as pathlib.Path.open).
@@ -160,7 +180,7 @@ class TraversableResources(ResourceReader):
     def files(self) -> "Traversable":
         """Return a Traversable object for the loaded package."""
 
-    def open_resource(self, resource: StrPath) -> io.BufferedReader:
+    def open_resource(self, resource: StrPath) -> BinaryIO:
         return self.files().joinpath(resource).open('rb')
 
     def resource_path(self, resource: Any) -> NoReturn:

Lib/importlib/resources/readers.py

@@ -3,15 +3,14 @@
 import collections
 import contextlib
 import itertools
-import pathlib
 import operator
+import pathlib
 import re
 import warnings
 import zipfile
 from collections.abc import Iterator
 
 from . import abc
-
 from ._itertools import only
 
 

Lib/test/test_importlib/resources/_path.py

@@ -1,10 +1,6 @@
-import pathlib
 import functools
-
-from typing import Dict, Union
-from typing import runtime_checkable
-from typing import Protocol
-
+import pathlib
+from typing import Dict, Protocol, Union, runtime_checkable
 
 ####
 # from jaraco.path 3.7.1

Lib/test/test_importlib/resources/test_compatibilty_files.py

@@ -1,8 +1,6 @@
+import importlib.resources as resources
 import io
 import unittest
-
-from importlib import resources
-
 from importlib.resources._adapters import (
     CompatibilityFiles,
     wrap_spec,

Lib/test/test_importlib/resources/test_contents.py

@@ -1,5 +1,5 @@
+import importlib.resources as resources
 import unittest
-from importlib import resources
 
 from . import util
 

Lib/test/test_importlib/resources/test_custom.py

@@ -1,12 +1,12 @@
-import unittest
 import contextlib
+import importlib.resources as resources
 import pathlib
+import unittest
+from importlib.resources import abc
+from importlib.resources.abc import ResourceReader, TraversableResources
 
 from test.support import os_helper
 
-from importlib import resources
-from importlib.resources import abc
-from importlib.resources.abc import TraversableResources, ResourceReader
 from . import util
 
 

Lib/test/test_importlib/resources/test_files.py

@@ -1,15 +1,16 @@
+import contextlib
+import importlib
+import importlib.resources as resources
 import pathlib
 import py_compile
 import textwrap
 import unittest
 import warnings
-import importlib
-import contextlib
-
-from importlib import resources
 from importlib.resources.abc import Traversable
+
+from test.support import import_helper, os_helper
+
 from . import util
-from test.support import os_helper, import_helper
 
 
 @contextlib.contextmanager
@@ -62,7 +63,7 @@ def test_non_paths_in_dunder_path(self):
         to cause the ``PathEntryFinder`` to be called when searching
         for packages. In that case, resources should still be loadable.
         """
-        import namespacedata01
+        import namespacedata01  # type: ignore[import-not-found]
 
         namespacedata01.__path__.append(
             '__editable__.sample_namespace-1.0.finder.__path_hook__'
@@ -153,7 +154,9 @@ def _compile_importlib(self):
         sources = pathlib.Path(resources.__file__).parent
 
         for source_path in sources.glob('**/*.py'):
-            c_path = c_resources.joinpath(source_path.relative_to(sources)).with_suffix('.pyc')
+            c_path = c_resources.joinpath(source_path.relative_to(sources)).with_suffix(
+                '.pyc'
+            )
             py_compile.compile(source_path, c_path)
         self.fixtures.enter_context(import_helper.DirsOnSysPath(bin_site))