Merge pull request #34 from DocOtak/rcaneill-issue33

Add test on units

Author: rcaneill

.github/workflows/ci.yml

@@ -45,13 +45,16 @@ jobs:
       uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
+    - name: Install udunits
+      run: sudo apt-get install -y libudunits2-dev
     - name: Run image
       uses: abatilo/[email protected]
       with:
         poetry-version: ${{ matrix.poetry-version }}
     - name: Install dependencies
       run: |
         poetry install
+        poetry run pip install cf_units==3.0.1
     - name: Test with pytest
       run: |
         poetry run pytest gsw_xarray/tests

gsw_xarray/_attributes.py

@@ -308,7 +308,7 @@
     },
     "enthalpy_second_derivatives": (
         {
-            "units": "(J/kg)(g/kg)^-2)",
+            "units": "(J/kg)(g/kg)^-2",
         },
         {
             "units": "J/(kg K(g/kg))",
@@ -319,7 +319,7 @@
     ),
     "enthalpy_second_derivatives_CT_exact": (
         {
-            "units": "(J/kg)(g/kg)^-2)",
+            "units": "(J/kg)(g/kg)^-2",
         },
         {
             "units": "J/(kg K(g/kg))",
@@ -690,7 +690,7 @@
             "units": "(kg/m^3)(g/kg)^-2",  # matlab doc is uncorrect
         },
         {
-            "units": "(kg/m^3)(g/kg)^-1 (J/kg)^-1",
+            "units": "(kg/m^3)(g/kg)^-1 J^-1/kg^-1",
         },
         {
             "units": "(kg/m^3)(J/kg)^-2",
@@ -800,7 +800,7 @@
             "units": "(m^3/kg)(g/kg)^-2",  # error in doc?
         },
         {
-            "units": "(m^3/kg)(g/kg)^-1 (J/kg)^-1",
+            "units": "(m^3/kg)(g/kg)^-1 J^-1/kg^-1",
         },
         {
             "units": "(m^3/kg)(J/kg)^-2",

gsw_xarray/tests/test_units.py

@@ -0,0 +1,45 @@
+"""
+Testing units with pint and cf_units
+"""
+import pytest
+
+from .test_imports import gsw_base
+from gsw_xarray._attributes import _func_attrs
+
+from pint import UnitRegistry
+
+ureg = UnitRegistry()
+
+
+@pytest.mark.parametrize("func_name", gsw_base)
+def test_unit_pint(func_name):
+    if func_name in ["indexer", "match_args_return", "pchip_interp"]:
+        # Internal gsw cookery or non wrapped functions
+        return
+    if func_name == "geostrophic_velocity":
+        pytest.xfail(
+            'geostrophic_velocity outputs "degree_north" and "degree_east" that are not compatible with pint'
+        )
+    attrs = _func_attrs[func_name]
+    if isinstance(attrs, dict):
+        attrs = [
+            attrs,
+        ]
+    for a in attrs:
+        print(a["units"])
+        ureg.Unit(a["units"])
+
+@pytest.mark.parametrize("func_name", gsw_base)
+def test_unit_cf_units(func_name):
+    cf_units = pytest.importorskip("cf_units")
+    if func_name in ["indexer", "match_args_return", "pchip_interp"]:
+        # Internal gsw cookery or non wrapped functions
+        return
+    attrs = _func_attrs[func_name]
+    if isinstance(attrs, dict):
+        attrs = [
+            attrs,
+        ]
+    for a in attrs:
+        print(a["units"])
+        cf_units.Unit(a["units"])

poetry.lock

@@ -14,6 +14,7 @@ furo = {version = ">=2022.1.2", optional = true}
 
 [tool.poetry.dev-dependencies]
 pytest = ">=6.2.5"
+Pint = ">=0.18"
 
 [tool.poetry.extras]
 docs = ["Sphinx", "furo"]