Cache paths in Pooch #261
Merged
Cache paths in Pooch #261
Conversation
This file contains hidden or 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
Comment on lines
+42
to
+43
| @cache # noqa: B019 | ||
| def get_path(self, name: str, unzip: bool = False) -> Path: |
Member
There was a problem hiding this comment.
Are there cases where caching is bad, either because the file was corrupted or deleted? I am more thinking of the use case of users running tutorials, not the unit tests.
Member
Author
There was a problem hiding this comment.
Depends. There are a couple of scenarios:
- If the file is bad when calling
get_path, it redownloads the file. - If the download fails, it raises an exception and the result is not cached. So calling
get_pathagain, attempts the download again. - Likewise, if the download succeeds but file access fails, we can an exception and the result is not cached.
- If the first call to
get_pathsucceeds and the file gets corrupted or removed afterwards, a second call toget_pathwill simply return the same path without any checks.
Did I miss a scenario?
Only the last case is a problem. But is it really a relevant problem? The files are fairly well hidden and it is unlikely for people to touch them accidentally.
SimonHeybrock
approved these changes
Aug 11, 2025
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.
The main change here is the addition of
@cacheinget_path. See scipp/esssans#206.I decided to put this into ESSreduce to allow the instrument packages to take advantage of it. It would be nice to place it further upstream but I don't see a good package for it. And the performance impact is most relevant for the instrument packages because they rely more on data files for their tests.