fsspec / fsspec/filesystem_spec

Feature request: classmethod returning possible keys of the details=True dictionary for each filesystem.

Open
#1,301 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.4k
Forks
490
Avg merge
2d 3h
Merged PRs (30d)
38

Description

I have written a Qt ItemModel for fsspec, what is tricky though is that there is no way to know which keys the "details" dictionary can contain for each filesystem (I would like to show a dedicated column for each details key, depending on filesystem)
It would be nice to have some classmethod for each FileSystem class which returns all possible keys for the details dictionary.

Example: This is what i have right now for github filesystem:
image
I have to hardcode in my code though that github filesystem offers "Size", "Type", "Permissions" etc.

Link to code

Thank you for all the work!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked PrettyQt fsspec model and how the GitHub filesystem currently exposes its details=True dictionaries. Identify the filesystem implementations and tests that would need to define the proposed classmethod; done means the API and its possible-key behavior are specified and covered across the relevant filesystems.

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
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.