GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Fix SimpleReader traversal adapters by Zhuyuyangyy · Pull Request #339 · python/importlib_resources

Conversation

@Zhuyuyangyy

@Zhuyuyangyy Zhuyuyangyy commented Oct 30, 2026

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@Zhuyuyangyy
Fix SimpleReader traversal adapters
e8c776d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

1 participant

@Zhuyuyangyy
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.