23 xarray utility

[mark141]

The following checks are now implemented:

• existence of certain dimensions
• allowed coordinate dtypes
• specific coordinate values

Input should be a nested dict with an array for the values:

ref = {
     "time" : {
        "optional" : True,
        "dtype" : ["datetime64[ns]","timedelta64[ns]"] },
    "c" : {"values" : ["x","y","z"]}
}

usage:
utility.xr_check_coords(dax: xr.DataArray, ref: dict)
utility.xr_check_dtype(dax: xr.DataArray, ref: dict)

missing:

• Do we want to raise Errors when the check fails or return a Value? Or maybe just a Warning?
• @reviewers do you confirm the change of the values to an array?
• Docstrings (depending on the missing solutions)

[codecov]

Codecov Report

Merging #125 into master will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master     #125   +/-   ##
=======================================
  Coverage   99.53%   99.54%           
=======================================
  Files         126      126           
  Lines        6952     7016   +64     
=======================================
+ Hits         6920     6984   +64     
  Misses         32       32           

Impacted Files	Coverage Δ
weldx/transformations.py	98.01% <100.00%> (+<0.01%)	⬆️
weldx/utility.py	98.11% <100.00%> (+0.31%)	⬆️
D:/a/weldx/weldx/weldx/transformations.py	98.01% <0.00%> (+<0.01%)	⬆️
D:/a/weldx/weldx/weldx/utility.py	98.11% <0.00%> (+0.31%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a545f07...781b4fe. Read the comment docs.

[CagtayFabry]

looks good 👍

• maybe add more test cases
• add docstrings (ideally with examples)
• implement missing functions
• code and repo cleanup

[vhirtham]

Added some reminders via review so that those issues won't be forgotten

[pep8speaks]

Hello @mark141! Thanks for updating this PR.

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2020-10-09 08:13:03 UTC

[mark141]

Added functionalities are now all in one function xr_check_coords(dax: xr.DataArray, ref: dict).
Functionalities:

• "optional" keyword: if the DataArray does not have this dimension
• "values" keyword: comparing the values of the the DataArray with the ones in the reference dictionary
• "dtype" keyword: comparing the numpy dtypes. Additional all numpy strings are now comparable with str
• Output is True or the corresponding Exception.

Other achievements:

• Pytests now test every line of the code.
• All Tests and functions got docstrings! And only one language is used in the whole code!
• There is even a small example in the docstring of xr_check_coords.

[CagtayFabry]

• add support for general "timedelta64" and "datetime64" dtype description as discussed
• add changelog entry

[CagtayFabry]

see my comment for final code changes :)

[vhirtham]

Looks good so far. My comments are just nitpicking, but the stuff should be added relatively easy