gh-93963: Document importlib.abc deprecations (#94546)

This commit is contained in:
Hugo van Kemenade 2022-07-25 19:24:42 +03:00 committed by GitHub
parent ccd7c7a0bd
commit 10b12dd92a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 27 additions and 0 deletions

View File

@ -45,6 +45,9 @@
.. versionadded:: 3.7
.. deprecated-removed:: 3.12 3.14
Use :class:`importlib.resources.abc.TraversableResources` instead.
.. abstractmethod:: open_resource(resource)
Returns an opened, :term:`file-like object` for binary reading
@ -91,6 +94,9 @@
.. versionadded:: 3.9
.. deprecated-removed:: 3.12 3.14
Use :class:`importlib.resources.abc.Traversable` instead.
.. attribute:: name
Abstract. The base name of this object without any parent references.
@ -146,6 +152,9 @@
.. versionadded:: 3.9
.. deprecated-removed:: 3.12 3.14
Use :class:`importlib.resources.abc.TraversableResources` instead.
.. abstractmethod:: files()
Returns a :class:`importlib.resources.abc.Traversable` object for the loaded

View File

@ -180,6 +180,24 @@ APIs:
* :func:`unittest.getTestCaseNames` (:gh:`50096`)
* :class:`webbrowser.MacOSX` (:gh:`86421`)
Pending Removal in Python 3.14
==============================
* Deprecated the following :mod:`importlib.abc` classes, scheduled for removal in
Python 3.14:
* :class:`importlib.abc.ResourceReader`
* :class:`importlib.abc.Traversable`
* :class:`importlib.abc.TraversableResources`
Use :mod:`importlib.resources.abc` classes instead:
* :class:`importlib.resources.abc.TraversableResources`
* :class:`importlib.resources.abc.Traversable`
* :class:`importlib.resources.abc.TraversableResources`
(Contributed by Jason R. Coombs and Hugo van Kemenade in :gh:`93963`.)
Pending Removal in Future Versions
----------------------------------