Ouranosinc / xclim / 10604210263

92%

Build Type

push

github

Committed by web-flow

Commit Message

Use pooch (#1889)

<!--Please ensure the PR fulfills the following requirements! -->
<!-- If this is your first PR, make sure to add your details to the
AUTHORS.rst! -->
### Pull Request Checklist:
- [x] This PR addresses an already opened issue (for bug fixes /
features)
- This PR relies on changes to be merged in
https://github.com/Ouranosinc/xclim-testdata/pull/29
- [x] Tests for the changes have been added (for bug fixes / features)
- [x] (If applicable) Documentation has been added / updated (for bug
fixes / features)
- [x] CHANGELOG.rst has been updated (with summary of main changes)
- [x] Link to issue (:issue:`number`) and pull request (:pull:`number`)
has been added

### What kind of change does this PR introduce?

* Replaces the logic for file gathering and caching from the in-house
developed version to instead use `pooch`.
  * In order to fetch testing data, one can now use the following:
  ```python
  from xclim.testing.utils import nimbus

  n = nimbus()
# from a fork of xclim-testdata:
nimbus(repo="https://github.com/Me/My_Repo", branch="my_test_branch")
  file = n.fetch("some_folder/some_data.nc")
  ```
* Removes the remote GitHub calls for every file request (which was
performed by `_get()`).
* Exports most of the file request and cache handling to `pooch`, while
maintaining a relatively unchanged API for users.
* (To be confirmed) Speeds up the delivery of test data to tests by
reducing the amount of redundant calls to fixtures and relying on a
single pooch instance of pooch to prevent multiple setup stages.

### Does this PR introduce a breaking change?

Absolutely. `get_file` and `open_dataset` no longer fetch remote files
from GitHub. Instead, a locally-stored `registry.txt` file contains all
the checksums of all files needed to run the tests and returns the
appropriate file from a locally-held cache. If the file checksum does
not match the expected value, it will attempt to replace it from... (continued)

Run Details

105 of 182 new or added lines in 4 files covered. (57.69%)

9 existing lines in 3 files now uncovered.

9100 of 10207 relevant lines covered (89.15%)

7.5 hits per line