Fix HfFileSystem.exists() for deleted repos and update documentation
#2643
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
Wauplin
reviewed
Oct 31, 2024
There was a problem hiding this comment.
Thanks @hanouticelina!
Left a few nits. Could you also add a test to check the initial snippet now works as expected?
from huggingface_hub import HfApi, HfFileSystem
import time
api = HfApi()
hfs = HfFileSystem()
hub_model_id = "MoritzLaurer/test-repo"
api.create_repo(hub_model_id, repo_type='model')
time.sleep(5)
api.delete_repo(repo_id=hub_model_id, repo_type="model")
time.sleep(5)
assert not hfs.exists(hub_model_id, refresh=True)
Comment on lines
-887
to
-889
| # Add docstrings to the methods of HfFileSystem from fsspec.AbstractFileSystem | ||
| for name, function in inspect.getmembers(HfFileSystem, predicate=inspect.isfunction): | ||
| parent = getattr(fsspec.AbstractFileSystem, name, None) |
There was a problem hiding this comment.
I still think a similar logic makes sense for all "hidden" methods not defined in huggingface_hub but in fsspec instead: read_text, read-bytes, write_text, write_bytes, tail, touch, etc. The initial goal was to make them appear in the documentation (see #2100) even though the implementation did not do that.
This can be done in a later PR (not urgent)
Wauplin
approved these changes
Nov 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #2552.
This PR fixes a bug where
HfFileSystem.exists()returnsTrueeven after the repository has been deleted. The issue arises because the cache is not properly invalidated when the repository is deleted, causingHfFileSystemto rely on stale cache data. The fix updates theHfFileSystem.invalidate_cache()method to clear the repository 'existence' cache when the provided path matches the repository root.This PR also includes an update to
HfFileSystemdocumentation.Main changes
HfFileSystem.invalidate_cache()to clear repository cache.HfFileSystemdocumentation to suggest usingHFApimethods when possible.HfFileSystem's methods.HfApiclass docstring visible in package reference by moving it from__init__to class level.