fsspec / fsspec/filesystem_spec
Publicly expose/document API for retrieving cache file details
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.4k
- Forks
- 490
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 38
Description
In an application that uses CachingFileSystem, we are interested in implementing partial cache cleanup based on cached file size & age. While fsspec already has the necessary pieces to accomplish this, such code would depend on currently-undocumented implementation details regarding the structure of cache metadata, which would not be a wise thing to do. We thus request the addition of some public method to CachingFileSystem for listing cached paths and the files that cache them.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the CachingFileSystem implementation and its existing cache metadata handling. Trace how cached paths and the files that store them are represented, then determine the public information needed for size- and age-based cleanup. Done means a documented public API exposes cached paths and their cache files without requiring callers to depend on undocumented metadata.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100