Ouranosinc / xclim / 33214604034

91%

Build Type

push

github

Committed by web-flow

Commit Message

Refactor the Indicator class, move modules to IndicatorCollection (#2399)

<!--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 #2397
- [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?
Finally, changing indicator derivation from subclassing to copying made
things more complicated, I abandoned the idea. I did pursue the idea of
refactoring `indicator.py` so that it was less of a monolith.

* The `Indicator` class is now the child of a hierarchy of smaller
classes.
- `IndexWrapper` : Wraps a compute function, extracting its metadata.
Docstring parsing and generation has been removed from `formatting`, put
here.
- `IndicatorBase` : Handles the fancy subclassing, with modification of
parameters, outputs (etc) from user input. It also defines the structure
of `__call__` and the related methods subclasses are supposed to use as
entry points in the computation.
- Then a stack of classes incrementing the features of the indicator:
        + `_DatasetIO` : Support for dataset as input and output.
        + `_DataTreeIterator` : Support for DataTree as input and output
+ `_MetadataFormatter` : Format output attributes with our template
system, add them to the output(s).
        + `_LocaleMetadataFormatter` : Adds translation support.
+ `_DeprecationWarner ` : Adds possibility to deprecate an indicator.
        + `_InputChecker` : Defines the checks performed on the inputs.
+ `_Compatibility` : Some support for input arguments I broke and ... (continued)

Coverage Stats

865 of 902 new or added lines in 24 files covered. (95.9%)

10 existing lines in 5 files now uncovered.

7973 of 8796 relevant lines covered (90.64%)

7.64 hits per line