Skip to content

[3.12] gh-116608: undeprecate functional importlib.resources API #132206

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.

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

Merged
merged 3 commits into from
Apr 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
51 changes: 17 additions & 34 deletions Doc/library/importlib.resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,10 @@ for example, a package and its resources can be imported from a zip file using
Added support for *traversable* representing a directory.


Deprecated functions
^^^^^^^^^^^^^^^^^^^^
Functional API
^^^^^^^^^^^^^^

An older, deprecated set of functions is still available, but is
scheduled for removal in a future version of Python.
An older, previously deprecated set of functions is still available.
The main drawback of these functions is that they do not support
directories: they assume all resources are located directly within a *package*.

Expand All @@ -116,8 +115,6 @@ directories: they assume all resources are located directly within a *package*.

The ``Package`` type is defined as ``Union[str, ModuleType]``.

.. deprecated:: 3.12


.. data:: Resource

Expand All @@ -138,11 +135,9 @@ directories: they assume all resources are located directly within a *package*.
sub-resources (i.e. it cannot be a directory). This function returns a
``typing.BinaryIO`` instance, a binary I/O stream open for reading.

.. deprecated:: 3.11

Calls to this function can be replaced by::
This function is roughly equivalent to::

files(package).joinpath(resource).open('rb')
files(package).joinpath(resource).open('rb')


.. function:: open_text(package, resource, encoding='utf-8', errors='strict')
Expand All @@ -159,11 +154,9 @@ directories: they assume all resources are located directly within a *package*.
This function returns a ``typing.TextIO`` instance, a text I/O stream open
for reading.

.. deprecated:: 3.11
This function is roughly equivalent to::

Calls to this function can be replaced by::

files(package).joinpath(resource).open('r', encoding=encoding)
files(package).joinpath(resource).open('r', encoding=encoding)


.. function:: read_binary(package, resource)
Expand All @@ -177,11 +170,9 @@ directories: they assume all resources are located directly within a *package*.
sub-resources (i.e. it cannot be a directory). This function returns the
contents of the resource as :class:`bytes`.

.. deprecated:: 3.11

Calls to this function can be replaced by::
This function is roughly equivalent to::

files(package).joinpath(resource).read_bytes()
files(package).joinpath(resource).read_bytes()


.. function:: read_text(package, resource, encoding='utf-8', errors='strict')
Expand All @@ -196,11 +187,9 @@ directories: they assume all resources are located directly within a *package*.
have the same meaning as with built-in :func:`open`. This function
returns the contents of the resource as :class:`str`.

.. deprecated:: 3.11
This function is roughly equivalent to::

Calls to this function can be replaced by::

files(package).joinpath(resource).read_text(encoding=encoding)
files(package).joinpath(resource).read_text(encoding=encoding)


.. function:: path(package, resource)
Expand All @@ -217,11 +206,9 @@ directories: they assume all resources are located directly within a *package*.
within *package*; it may not contain path separators and it may not have
sub-resources (i.e. it cannot be a directory).

.. deprecated:: 3.11

Calls to this function can be replaced using :func:`as_file`::
This function is roughly equivalent to ::

as_file(files(package).joinpath(resource))
as_file(files(package).joinpath(resource))


.. function:: is_resource(package, name)
Expand All @@ -232,11 +219,9 @@ directories: they assume all resources are located directly within a *package*.
*package* is either a name or a module object which conforms to the
``Package`` requirements.

.. deprecated:: 3.11
This function is roughly equivalent to::

Calls to this function can be replaced by::

files(package).joinpath(resource).is_file()
files(package).joinpath(resource).is_file()


.. function:: contents(package)
Expand All @@ -248,8 +233,6 @@ directories: they assume all resources are located directly within a *package*.
*package* is either a name or a module object which conforms to the
``Package`` requirements.

.. deprecated:: 3.11

Calls to this function can be replaced by::
This function is roughly equivalent to::

(resource.name for resource in files(package).iterdir() if resource.is_file())
(resource.name for resource in files(package).iterdir() if resource.is_file())
22 changes: 0 additions & 22 deletions Lib/importlib/resources/_legacy.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,6 @@
Resource = str


def deprecated(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
warnings.warn(
f"{func.__name__} is deprecated. Use files() instead. "
"Refer to https://importlib-resources.readthedocs.io"
"/en/latest/using.html#migrating-from-legacy for migration advice.",
DeprecationWarning,
stacklevel=2,
)
return func(*args, **kwargs)

return wrapper


def normalize_path(path: Any) -> str:
"""Normalize a path by ensuring it is a string.

Expand All @@ -39,19 +24,16 @@ def normalize_path(path: Any) -> str:
return file_name


@deprecated
def open_binary(package: Package, resource: Resource) -> BinaryIO:
"""Return a file-like object opened for binary reading of the resource."""
return (_common.files(package) / normalize_path(resource)).open('rb')


@deprecated
def read_binary(package: Package, resource: Resource) -> bytes:
"""Return the binary contents of the resource."""
return (_common.files(package) / normalize_path(resource)).read_bytes()


@deprecated
def open_text(
package: Package,
resource: Resource,
Expand All @@ -64,7 +46,6 @@ def open_text(
)


@deprecated
def read_text(
package: Package,
resource: Resource,
Expand All @@ -80,7 +61,6 @@ def read_text(
return fp.read()


@deprecated
def contents(package: Package) -> Iterable[str]:
"""Return an iterable of entries in `package`.

Expand All @@ -91,7 +71,6 @@ def contents(package: Package) -> Iterable[str]:
return [path.name for path in _common.files(package).iterdir()]


@deprecated
def is_resource(package: Package, name: str) -> bool:
"""True if `name` is a resource inside `package`.

Expand All @@ -104,7 +83,6 @@ def is_resource(package: Package, name: str) -> bool:
)


@deprecated
def path(
package: Package,
resource: Resource,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
undeprecate functional API for ``importlib.resources``
Loading