-
Notifications
You must be signed in to change notification settings - Fork 4
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.
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
Testing data fetching via pooch #62
Merged
Merged
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
…dist-compatible implementation of pooch-based testdata fetching
for more information, see https://pre-commit.ci
1 task
RondeauG
approved these changes
Jan 8, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hard to really test or review without data in xhydro-testdata
, but overall this seems good!
Co-authored-by: RondeauG <38501935+RondeauG@users.noreply.github.com>
RondeauG
approved these changes
Jan 9, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
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.
Pull Request Checklist:
number
) and pull request (:pull:number
) has been added.What kind of change does this PR introduce?
pooch
as a hard dependency (this can be revisited)xhydro.testing.helpers.py
andxhydro.testing.registry.txt
generate_registry
: Parses data found in package (xhydro.testing.data
), and adds it to theregistry.txt
load_registry
: Loads installed (or custom) registry and returns dictionarypopulate_testing_data
: Fetches the registry and optionally caches files at a different location (helpful forpytest-xdist
)Does this PR introduce a breaking change?
Yes. Testing data management is largely handled at the environment variable level:
XHYDRO_DATA_DIR
can be used to override the default cache location set forpooch
(on *nix:$XDG_CACHE_HOME
; Must be an absolute path)XHYDRO_TESTDATA_BRANCH
can be used to override the branch that the testing datashould be fetched from (default:
main
).Other information:
https://www.fatiando.org/pooch/latest/sample-data.html
Based on a similar approach taken for: https://github.com/Ouranosinc/xclim-testdata
Typically, the loaded
pooch
registries are given dog names, so I landed onDEVEREAUX
as an appropriate name for this project.