Skip to content

importlib.resources.contents is deprecated #14835

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 4 commits into
base: main
Choose a base branch
from
Open

importlib.resources.contents is deprecated #14835

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
50ac822
`importlib.resources.contents` is deprecated
sobolevn Oct 5, 2025
b16b50e
Fix tests
sobolevn Oct 5, 2025
b421475
Fix tests
sobolevn Oct 5, 2025
0b4410a
Apply suggestions from code review
sobolevn Oct 6, 2025
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: 1 addition & 1 deletion stdlib/@tests/test_cases/check_importlib_resources.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ def f(pth: pathlib.Path | str | _CustomPathLike) -> None:
importlib.resources.read_binary("pkg", pth)
importlib.resources.path("pkg", pth)
importlib.resources.is_resource("pkg", pth)
importlib.resources.contents("pkg", pth)
importlib.resources.contents("pkg", pth) # pyright: ignore[reportDeprecated]
8 changes: 6 additions & 2 deletions stdlib/importlib/resources/__init__.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ from contextlib import AbstractContextManager
from pathlib import Path
from types import ModuleType
from typing import Any, BinaryIO, Literal, TextIO
from typing_extensions import TypeAlias
from typing_extensions import TypeAlias, deprecated

if sys.version_info >= (3, 11):
from importlib.resources.abc import Traversable
Expand Down Expand Up @@ -64,7 +64,11 @@ else:
def read_text(package: Package, resource: Resource, encoding: str = "utf-8", errors: str = "strict") -> str: ...
def path(package: Package, resource: Resource) -> AbstractContextManager[Path, Literal[False]]: ...
def is_resource(package: Package, name: str) -> bool: ...
def contents(package: Package) -> Iterator[str]: ...
if sys.version_info >= (3, 11):
@deprecated("Deprecated since Python 3.11, use `files(anchor).iterdir()`")
def contents(package: Package) -> Iterator[str]: ...
else:
def contents(package: Package) -> Iterator[str]: ...

if sys.version_info >= (3, 11):
from importlib.resources._common import as_file as as_file
Expand Down
3 changes: 2 additions & 1 deletion stdlib/importlib/resources/_functional.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ if sys.version_info >= (3, 13):
from io import TextIOWrapper
from pathlib import Path
from typing import BinaryIO, Literal, overload
from typing_extensions import Unpack
from typing_extensions import Unpack, deprecated

def open_binary(anchor: Anchor, *path_names: StrPath) -> BinaryIO: ...
@overload
Expand All @@ -27,4 +27,5 @@ if sys.version_info >= (3, 13):
def read_text(anchor: Anchor, *path_names: StrPath, encoding: str | None, errors: str | None = "strict") -> str: ...
def path(anchor: Anchor, *path_names: StrPath) -> AbstractContextManager[Path, Literal[False]]: ...
def is_resource(anchor: Anchor, *path_names: StrPath) -> bool: ...
@deprecated("Deprecated since Python 3.11, use `files(anchor).iterdir()`")
def contents(anchor: Anchor, *path_names: StrPath) -> Iterator[str]: ...