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

Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
This commit is contained in:
Thomas Grainger 2025-04-08 09:36:29 +01:00 committed by GitHub
parent 4c5e84dbbe
commit 3fc57f86b1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 18 additions and 56 deletions

View file

@ -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.
@ -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,
@ -64,7 +46,6 @@ def open_text(
)
@deprecated
def read_text(
package: Package,
resource: Resource,
@ -80,7 +61,6 @@ def read_text(
return fp.read()
@deprecated
def contents(package: Package) -> Iterable[str]:
"""Return an iterable of entries in `package`.
@ -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`.
@ -104,7 +83,6 @@ def is_resource(package: Package, name: str) -> bool:
)
@deprecated
def path(
package: Package,
resource: Resource,