fsspec / fsspec/filesystem_spec
split spec class
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.4k
- Forks
- 490
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 38
Description
The AbstractFileSystem class has a lot of methods. When adapting for async (#310 ), there may be many more, to allow for both sync and async calls. While the class I think should stay the same, it may be good to split into superclasses that it can derive from:
- the public API, user methods
- default implementation details, like glob
- the set of methods that a new implementation should/might have to be functional
- (optional) a set of methods that should be async in the implementation or in the public API.
Note that there is a cost too, or some indirection when finding out the definition of a given method.
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 by reading the AbstractFileSystem class and the async adaptation referenced in issue #310. Clarify the proposed superclass boundaries and agree on the design before changing the class; done means the refactor preserves the public API while cleanly separating the identified responsibilities.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend-api-design
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100