Skip to content

GH-137426: Remove code deprecation of importlib.abc.ResourceLoader #137567

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −38
Open

GH-137426: Remove code deprecation of importlib.abc.ResourceLoader #137567

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Doc/library/importlib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,8 @@ ABC hierarchy::
.. deprecated:: 3.7
This ABC is deprecated in favour of supporting resource loading
through :class:`importlib.resources.abc.TraversableResources`.
This class exists for backwards compatibility only with other ABCs in
this module.

.. method:: get_data(path)
:abstractmethod:
Expand Down
14 changes: 4 additions & 10 deletions Lib/importlib/abc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,20 +64,14 @@ def invalidate_caches(self):
class ResourceLoader(Loader):

"""Abstract base class for loaders which can return data from their
back-end storage.
back-end storage to facilitate reading data to perform an import.

This ABC represents one of the optional protocols specified by PEP 302.

"""

def __init__(self):
import warnings
warnings.warn('importlib.abc.ResourceLoader is deprecated in '
'favour of supporting resource loading through '
'importlib.resources.abc.TraversableResources.',
DeprecationWarning, stacklevel=2)
super().__init__()
For directly loading resources, use TraversableResources instead. This class
primarily exists for backwards compatibility with other ABCs in this module.

"""

@abc.abstractmethod
def get_data(self, path):
Expand Down
31 changes: 3 additions & 28 deletions Lib/test/test_importlib/test_abc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,15 +224,7 @@ class ResourceLoaderDefaultsTests(ABCTestHarness):
SPLIT = make_abc_subclasses(ResourceLoader)

def test_get_data(self):
with (
self.assertRaises(IOError),
self.assertWarnsRegex(
DeprecationWarning,
r"importlib\.abc\.ResourceLoader is deprecated in favour of "
r"supporting resource loading through importlib\.resources"
r"\.abc\.TraversableResources.",
),
):
with self.assertRaises(IOError):
self.ins.get_data('/some/path')


Expand Down Expand Up @@ -936,13 +928,8 @@ def get_filename(self, fullname):

def path_stats(self, path):
return {'mtime': 1}
with self.assertWarnsRegex(
DeprecationWarning,
r"importlib\.abc\.ResourceLoader is deprecated in favour of "
r"supporting resource loading through importlib\.resources"
r"\.abc\.TraversableResources.",
):
loader = DummySourceLoader()

loader = DummySourceLoader()

with self.assertWarnsRegex(
DeprecationWarning,
Expand All @@ -952,17 +939,5 @@ def path_stats(self, path):
loader.path_mtime('foo.py')


class ResourceLoaderDeprecationWarningsTests(unittest.TestCase):
"""Tests ResourceLoader deprecation warnings."""

def test_deprecated_resource_loader(self):
from importlib.abc import ResourceLoader
class DummyLoader(ResourceLoader):
def get_data(self, path):
return b''

with self.assertWarns(DeprecationWarning):
DummyLoader()

if __name__ == '__main__':
unittest.main()
3 changes: 3 additions & 0 deletions Misc/NEWS.d/next/Library/2025-08-08-15-00-38.gh-issue-137426.lW-Rk2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Remove the code deprecation of importlib.abc.ResourceLoader . It is
documented as deprecated, but left for backwards compatibility with other
classes in importlib.abc.
Comment on lines +1 to +3
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Remove the code deprecation of importlib.abc.ResourceLoader . It is
documented as deprecated, but left for backwards compatibility with other
classes in importlib.abc.
Remove the code deprecation of ``importlib.abc.ResourceLoader``. It is
documented as deprecated, but left for backwards compatibility with other
classes in ``importlib.abc``.

Loading