Skip to content

Fix SimpleReader traversal adapters - #339

Open
Zhuyuyangyy wants to merge 1 commit into
python:mainfrom
Zhuyuyangyy:fix/simple-reader-traversal
Open

Zhuyuyangyy wants to merge 1 commit into
python:mainfrom
Zhuyuyangyy:fix/simple-reader-traversal

Conversation

@Zhuyuyangyy

Copy link
Copy Markdown

Problem

A provider implementing the documented SimpleReader interface through TraversableReader cannot use files(): ResourceContainer is still abstract because it does not implement Traversable.name.

from io import BytesIO
from importlib_resources.simple import TraversableReader

class Reader(TraversableReader):
    package = "example.package"

    def children(self):
        return []

    def resources(self):
        return ["data.txt"]

    def open_binary(self, resource):
        return BytesIO(b"hello")

Reader().files()  # TypeError: abstract method 'name'

The same adapter path has further blockers once the container can be instantiated: ResourceHandle lacks concrete name and iterdir implementations, resource enumeration iterates over the resources method rather than its result, and the leaf's joinpath cannot accept the empty tail supplied by Traversable.joinpath.

Changes

  • Implement the concrete container and resource names; use the reader's existing package-derived name for containers.
  • Call resources() when enumerating entries.
  • Give resource handles an empty directory iterator, matching the neighboring compatibility adapter.
  • Let a resource's empty joinpath() return itself while preserving the existing error for attempts to traverse further.
  • Add end-to-end tests for empty and populated readers, nested resources, binary/text reads, and the inherited resource-reader methods.
  • Include the now-tested simple.py in coverage and add a news fragment.

The change is confined to the SimpleReader adapters; it does not alter the public Traversable base implementation.

Validation

  • The six new end-to-end tests fail on the original implementation and pass after the fix.
  • tox -e py312: 312 passed, 1 skipped, 81 subtests passed, including Ruff and mypy checks (no issues in 30 source files).
  • simple.py: 59/59 statements covered (100%); overall suite coverage 97%.
  • ruff format --check importlib_resources/simple.py importlib_resources/tests/test_simple.py: passed.
  • git diff --check: passed.

Checked the existing open PRs and related history (#183, #249, #250, #267); I did not find an existing fix for this adapter failure.

AI assistance disclosure

This PR was prepared by an AI coding agent acting on behalf of @Zhuyuyangyy, including the code, regression tests, and automated validation. It has not received independent human code review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant