fsspec / fsspec/filesystem_spec
Support argument discovery
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.4k
- Forks
- 490
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 38
Description
This is a somewhat speculative feature request.
My exploration of fsspec suggests that there's currently no standard, machine-actionable mechanism through which a backend implementation can describe the arguments (args, kwargs) that it understands.
The use-case I'm considering is for implementation-agnostic UI systems; for example the Jupyter fsspec extension. Currently, the user is expected to configure the jupyter extension by editing a configuration file, providing the necessary configuration (if any) for that fsspec backend implementation.
Seemingly, the user must discover information about how to configure the backend implementation by somehow finding and reading the backend implementation's documentation.
Fsspec already supports discovering the list of available backend implementations. If it were possible, for a specific fsspec backend implementation, to discover a list of possible configuration options, along with some metadata (input type, a brief description, whether it is required, etc) then the fsspec client (jupyter fsspec extension, in the above example) could build a UI that would allow the user to add fsspec implementations, ideally without forcing the user to discover documentation for the backend implementation.
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 reviewing fsspec's existing mechanism for discovering available backend implementations; the issue does not name a file or test to begin with. Define the scope of a machine-actionable argument description and its metadata, then determine how the Jupyter fsspec extension would consume it. Done should include an agreed interface and validation for backend configuration discovery.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100