fsspec / fsspec/s3fs

`_ls` overrides base class in incompatible manner

Open
#945 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1k
Forks
305
Avg merge
22h 37m
Merged PRs (30d)
4

Description

Here you default to detail=False in _ls

https://github.com/fsspec/s3fs/blob/b4d3fa89f1accbfc2186f1d42d07be15bc9df101/s3fs/core.py#L1021

but in the base class of AsyncFileSystem you default to detail=True.

Is it intentional to override the base class in this way? Is every implementor intended to disregard the default value of detail in the base class?

Contributor guide

Open the contributing guide

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

Read s3fs/core.py around line 1021 and fsspec/asyn.py around line 704 to compare the _ls defaults. Check existing _ls callers and tests to determine the intended detail behavior, then document or implement the agreed compatibility and verify the related filesystem tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend, cloud
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.