Skip to content

Commit 10b12dd

Browse files
authored
gh-93963: Document importlib.abc deprecations (#94546)
1 parent ccd7c7a commit 10b12dd

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

Doc/library/importlib.resources.abc.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@
4545

4646
.. versionadded:: 3.7
4747

48+
.. deprecated-removed:: 3.12 3.14
49+
Use :class:`importlib.resources.abc.TraversableResources` instead.
50+
4851
.. abstractmethod:: open_resource(resource)
4952

5053
Returns an opened, :term:`file-like object` for binary reading
@@ -91,6 +94,9 @@
9194

9295
.. versionadded:: 3.9
9396

97+
.. deprecated-removed:: 3.12 3.14
98+
Use :class:`importlib.resources.abc.Traversable` instead.
99+
94100
.. attribute:: name
95101

96102
Abstract. The base name of this object without any parent references.
@@ -146,6 +152,9 @@
146152

147153
.. versionadded:: 3.9
148154

155+
.. deprecated-removed:: 3.12 3.14
156+
Use :class:`importlib.resources.abc.TraversableResources` instead.
157+
149158
.. abstractmethod:: files()
150159

151160
Returns a :class:`importlib.resources.abc.Traversable` object for the loaded

Doc/whatsnew/3.12.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,24 @@ APIs:
180180
* :func:`unittest.getTestCaseNames` (:gh:`50096`)
181181
* :class:`webbrowser.MacOSX` (:gh:`86421`)
182182

183+
Pending Removal in Python 3.14
184+
==============================
185+
186+
* Deprecated the following :mod:`importlib.abc` classes, scheduled for removal in
187+
Python 3.14:
188+
189+
* :class:`importlib.abc.ResourceReader`
190+
* :class:`importlib.abc.Traversable`
191+
* :class:`importlib.abc.TraversableResources`
192+
193+
Use :mod:`importlib.resources.abc` classes instead:
194+
195+
* :class:`importlib.resources.abc.TraversableResources`
196+
* :class:`importlib.resources.abc.Traversable`
197+
* :class:`importlib.resources.abc.TraversableResources`
198+
199+
(Contributed by Jason R. Coombs and Hugo van Kemenade in :gh:`93963`.)
200+
183201
Pending Removal in Future Versions
184202
----------------------------------
185203

0 commit comments

Comments
 (0)