Ouranosinc / xscen

87%

push

github

Tests for the IO module (#492)

<!-- 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 fixes #xyz
- [x] (If applicable) Documentation has been added / updated (for bug
fixes / features).
- [x] (If applicable) Tests have been added.
- [x] This PR does not seem to break the templates.
- [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?

* Mainly adds tests to the IO module, along with bugfixes:
  * Adds a missing library (`openpyxl`) to the requirements.
  * Improves the code in `estimate_chunks` to support n dimensions.
* Fixes a bug in `subset_maxsize` where the last year would be dropped.
* Fixes a bug in `clean_incomplete` where the `zmetadata` file would not
be removed.
  * Added more flexibility to `clean_incomplete`.
  * Fixed a bug in `_coerce_attrs` where encoding would get dropped.
* Fixed bugs in `save_to_zarr` with `mode=='a'`: encoding of existing
variables is now always dropped & the code now crashes if trying to both
append dimensions with new data and add a new variable to an existing
zarr.
* Fixed bugs in `save_to_zarr` where the code would crash when skipping
a variable if `bitround` was not None.
* Fixed a bug in `make_toc` where the French name for the sheet would
get dropped if given a Dataset instead of a DataArray.
* Better default argument for `column` in `save_to_table`. It stays
unchanged if given a Dataset with multiple variables, but is now `None`
otherwise.
* Fixed a bug in `save_to_table` where `engine_kwargs` would not be used
if saving an Excel with a single sheet.

- An option was added to `publish_release_notes` to only ... (continued)

117 of 126 new or added lines in 3 files covered. (92.86%)

3860 of 4450 relevant lines covered (86.74%)

5.1 hits per line