Skip to content

Document case-sensitive lookups in the directory cache - #610

Open
Hugohong258 wants to merge 1 commit into
PyFilesystem:masterfrom
Hugohong258:codex/document-cached-dir-case-20261029
Open

Hugohong258 wants to merge 1 commit into
PyFilesystem:masterfrom
Hugohong258:codex/document-cached-dir-case-20261029

Conversation

@Hugohong258

Copy link
Copy Markdown

Type of changes

  • Documentation / docstrings

Checklist

  • I've run the repository-pinned Black 22.3.0 on the changed Python file.
  • I've updated CHANGELOG.md and CONTRIBUTORS.md where appropriate.
  • I've added tests for new code (documentation-only change).
  • I accept that @PyFilesystem/maintainers may be pedantic in the code review.

Description

Related to #560: WrapCachedDir matches cached directory entry names case-sensitively even if the wrapped filesystem is case-insensitive. Document the limitation for getinfo, isdir, and isfile, and describe using the spelling from scandir or querying the wrapped filesystem directly. This documents the existing behavior; it does not change the cache implementation.

On Windows with CPython 3.9.25, an OSFS containing MixedCase and Document.txt recognizes both exact-case and lowercase queries, while WrapCachedDir reports the lowercase variants missing. Verified the rendered API documentation and its links with Sphinx 3.5.4 and the project docs requirements, plus compatible Jinja2 and sphinxcontrib version pins. The HTML build completed with 90 warnings, including missing _static, autodoc signature warnings, and repeated contributing-page toctree warnings. Black 22.3.0 check and git diff --check passed. No runtime behavior changed; the full test suite was not run.

This branch has not been deployed

No deployments
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