From: Jason R. Coombs Date: Tue, 4 Oct 2022 16:58:34 +0000 (-0400) Subject: [3.9] gh-96845: Fix docs around importlib.abc.Traversable (GH-97515) (GH-97761) X-Git-Tag: v3.9.15~11 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=71edddea86c53a91a56ebebdb18e9d616f4675c2;p=thirdparty%2FPython%2Fcpython.git [3.9] gh-96845: Fix docs around importlib.abc.Traversable (GH-97515) (GH-97761) Co-authored-by: Jason R. Coombs --- diff --git a/Doc/library/importlib.rst b/Doc/library/importlib.rst index c7fbcb21274a..975648153101 100644 --- a/Doc/library/importlib.rst +++ b/Doc/library/importlib.rst @@ -845,6 +845,8 @@ ABC hierarchy:: Read contents of self as text. + Note: In Python 3.11 and later, this class is found in ``importlib.resources.abc``. + .. class:: TraversableResources @@ -856,6 +858,8 @@ ABC hierarchy:: .. versionadded:: 3.9 + Note: In Python 3.11 and later, this class is found in ``importlib.resources.abc``. + :mod:`importlib.resources` -- Resources --------------------------------------- @@ -918,7 +922,7 @@ The following functions are available. .. function:: files(package) - Returns an :class:`importlib.resources.abc.Traversable` object + Returns an :class:`importlib.abc.Traversable` object representing the resource container for the package (think directory) and its resources (think files). A Traversable may contain other containers (think subdirectories). @@ -930,7 +934,7 @@ The following functions are available. .. function:: as_file(traversable) - Given a :class:`importlib.resources.abc.Traversable` object representing + Given a :class:`importlib.abc.Traversable` object representing a file, typically from :func:`importlib.resources.files`, return a context manager for use in a :keyword:`with` statement. The context manager provides a :class:`pathlib.Path` object.