[Python-checkins] [3.10] gh-96845: Fix docs around importlib.abc.Traversable (GH-97515)
jaraco
webhook-mailer at python.org
Mon Oct 3 09:11:15 EDT 2022
https://github.com/python/cpython/commit/bead571e6a2752d111f4995bcd4a0c2c3b19c6b6
commit: bead571e6a2752d111f4995bcd4a0c2c3b19c6b6
branch: 3.10
author: Jason R. Coombs <jaraco at jaraco.com>
committer: jaraco <jaraco at jaraco.com>
date: 2022-10-03T09:11:06-04:00
summary:
[3.10] gh-96845: Fix docs around importlib.abc.Traversable (GH-97515)
* [3.10] gh-96845: Correct reference to Traversable* classes.
* [3.10] gh-96845: Add a note about the pending move of resources.abcs.
files:
M Doc/library/importlib.rst
diff --git a/Doc/library/importlib.rst b/Doc/library/importlib.rst
index 3981cc6f2d96..1addba3fb47f 100644
--- a/Doc/library/importlib.rst
+++ b/Doc/library/importlib.rst
@@ -854,6 +854,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
@@ -868,6 +870,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
---------------------------------------
@@ -930,7 +934,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).
@@ -942,7 +946,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.
More information about the Python-checkins
mailing list