Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Avoid copying files with same name prefix when copying folder #576

Merged
merged 4 commits into from
Aug 31, 2023
Merged

Avoid copying files with same name prefix when copying folder #576

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0be233f
fix: avoid copying files with same name prefix
john-jam Aug 24, 2023
6d46a60
Merge branch 'main' into fix-new-derived-test
john-jam Aug 24, 2023
13a6ac6
Merge branch 'main' into fix-new-derived-test
john-jam Aug 30, 2023
d1ff25f
feat: avoid calling isdir before fetching objects
john-jam Aug 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 3 additions & 12 deletions gcsfs/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -989,18 +989,6 @@ async def _info(self, path, generation=None, **kwargs):
else:
raise FileNotFoundError(path)

async def _glob(self, path, prefix="", **kwargs):
if not prefix:
# Identify pattern prefixes. Ripped from fsspec.spec.AbstractFileSystem.glob and matches
# the glob.has_magic patterns.
indstar = path.find("*") if path.find("*") >= 0 else len(path)
indques = path.find("?") if path.find("?") >= 0 else len(path)
indbrace = path.find("[") if path.find("[") >= 0 else len(path)

ind = min(indstar, indques, indbrace)
prefix = path[:ind].split("/")[-1]
return await super()._glob(path, prefix=prefix, **kwargs)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we apply the fix in the _find method below then this glob prefix construction no longer work for the edge case highlighted here.

This is because the the glob subdir* will create a subdir prefix and will be handled like a folder in the _find method (and add a trailing slash and miss the subdir.txt file).

Also, not sure to understand the initial benefit of this _glob method override. Was this just for caching?
Anyway, if another fix exists maybe this could be left as-is.


async def _ls(
self, path, detail=False, prefix="", versions=False, refresh=False, **kwargs
):
Expand Down Expand Up @@ -1410,6 +1398,9 @@ async def _find(
else:
_prefix = key

if _prefix != "" and await self._isdir(f"{bucket}/{_prefix}"):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there no way to avoid isdir here? This doubles the number of calls for a simple list - and isdir surely is doing a list op anyway!

Copy link
Contributor Author

@john-jam john-jam Aug 30, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, it's not useful to double the calls there. That's why I initially indicated that a better solution should probably exist ;)

I updated the code with this commit to try out another solution inspired by the _find method in s3fs which first fetches the path as if it is a directory then calls the _info method on the path to check if it's a file and returns it accordingly. In gcsfs, we can't call _info because some tests are expecting versioned files (_info does not support versioned files) or a prefixed search. So I simply moved the initial implementation into a block executed if the first search (when we treat path as a directory) does not return anything. It still doubles the calls when we are searching a single file though.

Let me know if that works for you. This commit is tested against this PR to fix this test.

_prefix = _prefix.rstrip("/") + "/"

objects, _ = await self._do_list_objects(
bucket, delimiter="", prefix=_prefix, versions=versions
)
Expand Down
7 changes: 4 additions & 3 deletions gcsfs/tests/test_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,10 +292,11 @@ def test_gcs_glob(gcs):
for f in gcs.glob(TEST_BUCKET + "/nested/*")
if gcs.isfile(f)
)
# the following is no longer true since the glob method list the root path
# Ensure the glob only fetches prefixed folders
gcs.dircache.clear()
gcs.glob(TEST_BUCKET + "/nested**1")
assert all(d.startswith(TEST_BUCKET + "/nested") for d in gcs.dircache)
# gcs.dircache.clear()
# gcs.glob(TEST_BUCKET + "/nested**1")
# assert all(d.startswith(TEST_BUCKET + "/nested") for d in gcs.dircache)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Without the _glob method override, _find is now called for the parent folder (TEST_BUCKET) so other folder like test are now in the dircache.

# the following is no longer true as of #437
# gcs.glob(TEST_BUCKET + "/test*")
# assert TEST_BUCKET + "/test" in gcs.dircache
Expand Down
Loading