cf-xarray 0.9.2__tar.gz → 0.9.3__tar.gz

{cf_xarray-0.9.2 → cf_xarray-0.9.3}/.github/workflows/ci.yaml

@@ -50,7 +50,7 @@ jobs:
         run: |
           pytest -n auto --cov=./ --cov-report=xml
       - name: Upload code coverage to Codecov
-        uses: codecov/codecov-action@v4.4.1
+        uses: codecov/codecov-action@v4.5.0
         with:
           file: ./coverage.xml
           flags: unittests
@@ -114,7 +114,7 @@ jobs:
         run: |
           python -m mypy --install-types --non-interactive --cobertura-xml-report mypy_report cf_xarray/
       - name: Upload mypy coverage to Codecov
-        uses: codecov/codecov-action@v4.4.1
+        uses: codecov/codecov-action@v4.5.0
         with:
           file: mypy_report/cobertura.xml
           flags: mypy

{cf_xarray-0.9.2 → cf_xarray-0.9.3}/.github/workflows/pypi.yaml

@@ -72,7 +72,7 @@ jobs:
 
       - name: Publish package to TestPyPI
         if: github.event_name == 'push'
-        uses: pypa/gh-action-pypi-publish@v1.8.14
+        uses: pypa/gh-action-pypi-publish@v1.9.0
         with:
           password: ${{ secrets.TESTPYPI_TOKEN }}
           repository_url: https://test.pypi.org/legacy/
@@ -96,6 +96,6 @@ jobs:
           name: releases
           path: dist
       - name: Publish package to PyPI
-        uses: pypa/gh-action-pypi-publish@v1.8.14
+        uses: pypa/gh-action-pypi-publish@v1.9.0
         with:
           verbose: true

{cf_xarray-0.9.2 → cf_xarray-0.9.3}/.pre-commit-config.yaml

@@ -3,20 +3,20 @@ ci:
 
 repos:
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.15.2
+    rev: v3.16.0
     hooks:
       - id: pyupgrade
         args: ["--py39-plus"]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: 'v0.3.5'
+    rev: 'v0.5.0'
     hooks:
       - id: ruff
         args: ["--show-fixes", "--fix"]
 
   - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 24.3.0
+    rev: 24.4.2
     hooks:
       - id: black
 
@@ -47,7 +47,7 @@ repos:
           additional_dependencies: [mdformat==0.7.17]
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
@@ -67,7 +67,7 @@ repos:
     - id: validate-cff
 
   - repo: https://github.com/abravalheri/validate-pyproject
-    rev: v0.16
+    rev: v0.18
     hooks:
       - id: validate-pyproject
 

{cf_xarray-0.9.2 → cf_xarray-0.9.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cf_xarray
-Version: 0.9.2
+Version: 0.9.3
 Summary: A convenience wrapper for using CF attributes on xarray objects
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -224,7 +224,7 @@ License-File: LICENSE
 Requires-Dist: xarray
 Provides-Extra: all
 Requires-Dist: matplotlib; extra == "all"
-Requires-Dist: pint; extra == "all"
+Requires-Dist: pint!=0.24.0,>=0.18; extra == "all"
 Requires-Dist: shapely; extra == "all"
 Requires-Dist: regex; extra == "all"
 Requires-Dist: rich; extra == "all"

cf_xarray-0.9.3/cf_xarray/_version.py

@@ -0,0 +1 @@
+__version__ = "0.9.3"

{cf_xarray-0.9.2 → cf_xarray-0.9.3}/cf_xarray/geometry.py

@@ -17,6 +17,19 @@ __all__ = [
 ]
 
 
+# Useful convention language:
+# 1. Whether linked to normal CF space-time coordinates with a nodes attribute or not, inclusion of such coordinates is
+#    recommended to maintain backward compatibility with software that has not implemented geometry capabilities.
+# 2. The geometry node coordinate variables must each have an axis attribute whose allowable values are X, Y, and Z.
+# 3. If a coordinates attribute is carried by the geometry container variable or its parent data variable, then those coordinate variables
+#    that have a meaningful correspondence with node coordinates are indicated as such by a nodes attribute that names the corresponding node
+#    coordinates, but only if the grid_mapping associated the geometry node variables is the same as that of the coordinate variables.
+#    If a different grid mapping is used, then the provided coordinates must not have the nodes attribute.
+#
+# Interpretation:
+# 1. node coordinates are exact; the 'normal' coordinates are a reasonable value to use, if you do not know how to interpret the nodes.
+
+
 def decode_geometries(encoded: xr.Dataset) -> xr.Dataset:
     """
     Decode CF encoded geometries to a numpy object array containing shapely geometries.
@@ -282,6 +295,14 @@ def shapely_to_cf(geometries: xr.DataArray | Sequence, grid_mapping: str | None
     ----------
     Please refer to the CF conventions document: http://cfconventions.org/Data/cf-conventions/cf-conventions-1.8/cf-conventions.html#geometries
     """
+
+    if isinstance(geometries, xr.DataArray) and grid_mapping is not None:
+        raise DeprecationWarning(
+            "Explicitly passing `grid_mapping` with DataArray of geometries is deprecated. "
+            "Please set a `grid_mapping` attribute on `geometries`, ",
+            "and set the grid mapping variable as a coordinate",
+        )
+
     # Get all types to call the appropriate translation function.
     types = {
         geom.item().geom_type if isinstance(geom, xr.DataArray) else geom.geom_type
@@ -300,19 +321,38 @@ def shapely_to_cf(geometries: xr.DataArray | Sequence, grid_mapping: str | None
 
     ds[GEOMETRY_CONTAINER_NAME].attrs.update(coordinates="crd_x crd_y")
 
+    if (
+        grid_mapping is None
+        and isinstance(geometries, xr.DataArray)
+        and (grid_mapping_varname := geometries.attrs.get("grid_mapping"))
+    ):
+        if grid_mapping_varname in geometries.coords:
+            grid_mapping = geometries.coords[grid_mapping_varname].attrs[
+                "grid_mapping_name"
+            ]
+            for name_ in ["x", "y", "crd_x", "crd_y"]:
+                ds[name_].attrs["grid_mapping"] = grid_mapping_varname
+
     # Special treatment of selected grid mappings
-    if grid_mapping == "longitude_latitude":
-        # Special case for longitude_latitude grid mapping
+    if grid_mapping in ["latitude_longitude", "rotated_latitude_longitude"]:
+        # Special case for longitude_latitude type grid mappings
         ds = ds.rename(crd_x="lon", crd_y="lat")
-        ds.lon.attrs.update(units="degrees_east", standard_name="longitude")
-        ds.lat.attrs.update(units="degrees_north", standard_name="latitude")
+        if grid_mapping == "latitude_longitude":
+            ds.lon.attrs.update(units="degrees_east", standard_name="longitude")
+            ds.x.attrs.update(units="degrees_east", standard_name="longitude")
+            ds.lat.attrs.update(units="degrees_north", standard_name="latitude")
+            ds.y.attrs.update(units="degrees_north", standard_name="latitude")
+        elif grid_mapping == "rotated_latitude_longitude":
+            ds.lon.attrs.update(units="degrees", standard_name="grid_longitude")
+            ds.x.attrs.update(units="degrees", standard_name="grid_longitude")
+            ds.lat.attrs.update(units="degrees", standard_name="grid_latitude")
+            ds.y.attrs.update(units="degrees", standard_name="grid_latitude")
         ds[GEOMETRY_CONTAINER_NAME].attrs.update(coordinates="lon lat")
-        ds.x.attrs.update(units="degrees_east", standard_name="longitude")
-        ds.y.attrs.update(units="degrees_north", standard_name="latitude")
     elif grid_mapping is not None:
-        raise NotImplementedError(
-            f"Only grid mapping longitude_latitude is implemented. Got {grid_mapping}."
-        )
+        ds.crd_x.attrs.update(standard_name="projection_x_coordinate")
+        ds.x.attrs.update(standard_name="projection_x_coordinate")
+        ds.crd_y.attrs.update(standard_name="projection_y_coordinate")
+        ds.y.attrs.update(standard_name="projection_y_coordinate")
 
     return ds
 

{cf_xarray-0.9.2 → cf_xarray-0.9.3}/cf_xarray/tests/test_geometry.py

@@ -265,8 +265,8 @@ def test_shapely_to_cf(geometry_ds):
         [
             in_ds.drop_vars("geometry").isel(index=slice(1, None)),
             cfxr.shapely_to_cf(
-                in_ds.geometry.isel(index=slice(1, None)),
-                grid_mapping="longitude_latitude",
+                in_ds.geometry.isel(index=slice(1, None)).data,
+                grid_mapping="latitude_longitude",
             ),
         ]
     )
@@ -355,10 +355,11 @@ def test_shapely_to_cf_errors():
     with pytest.raises(ValueError, match="Mixed geometry types are not supported"):
         cfxr.shapely_to_cf(geoms)
 
-    with pytest.raises(
-        NotImplementedError, match="Only grid mapping longitude_latitude"
-    ):
-        cfxr.shapely_to_cf([Point(4, 5)], grid_mapping="albers_conical_equal_area")
+    encoded = cfxr.shapely_to_cf(
+        [Point(4, 5)], grid_mapping="albers_conical_equal_area"
+    )
+    assert encoded["x"].attrs["standard_name"] == "projection_x_coordinate"
+    assert encoded["y"].attrs["standard_name"] == "projection_y_coordinate"
 
 
 @requires_shapely
@@ -491,7 +492,6 @@ def test_reshape_unique_geometries(geometry_ds):
 
 @requires_shapely
 def test_encode_decode(geometry_ds, polygon_geometry):
-
     geom_dim_ds = xr.Dataset()
     geom_dim_ds = geom_dim_ds.assign_coords(
         xr.Coordinates(

{cf_xarray-0.9.2 → cf_xarray-0.9.3}/cf_xarray/tests/test_units.py

@@ -75,11 +75,16 @@ def test_udunits_power_syntax_parse_units():
         ("m ** -1", "m-1"),
         ("m ** 2 / s ** 2", "m2 s-2"),
         ("m ** 3 / (kg * s ** 2)", "m3 kg-1 s-2"),
+        ("", "1"),
     ),
 )
 def test_udunits_format(units, expected):
     u = ureg.parse_units(units)
+    if units == "":
+        # The non-shortened dimensionless can only work with recent pint
+        pytest.importorskip("pint", minversion="0.24.1")
 
+    assert f"{u:~cf}" == expected
     assert f"{u:cf}" == expected
 
 

{cf_xarray-0.9.2 → cf_xarray-0.9.3}/cf_xarray/units.py

@@ -4,62 +4,57 @@ import functools
 import re
 
 import pint
-from pint import (  # noqa: F401
-    DimensionalityError,
-    UndefinedUnitError,
-    UnitStrippedWarning,
-)
+from packaging.version import Version
 
 from .utils import emit_user_level_warning
 
-# from `xclim`'s unit support module with permission of the maintainers
-try:
 
-    @pint.register_unit_format("cf")
-    def short_formatter(unit, registry, **options):
-        """Return a CF-compliant unit string from a `pint` unit.
-
-        Parameters
-        ----------
-        unit : pint.UnitContainer
-            Input unit.
-        registry : pint.UnitRegistry
-            the associated registry
-        **options
-            Additional options (may be ignored)
-
-        Returns
-        -------
-        out : str
-            Units following CF-Convention, using symbols.
-        """
-        import re
-
-        # convert UnitContainer back to Unit
-        unit = registry.Unit(unit)
-        # Print units using abbreviations (millimeter -> mm)
-        s = f"{unit:~D}"
-
-        # Search and replace patterns
-        pat = r"(?P<inverse>(?:1 )?/ )?(?P<unit>\w+)(?: \*\* (?P<pow>\d))?"
-
-        def repl(m):
-            i, u, p = m.groups()
-            p = p or (1 if i else "")
-            neg = "-" if i else ""
-
-            return f"{u}{neg}{p}"
-
-        out, n = re.subn(pat, repl, s)
-
-        # Remove multiplications
-        out = out.replace(" * ", " ")
-        # Delta degrees:
-        out = out.replace("Δ°", "delta_deg")
-        return out.replace("percent", "%")
+@pint.register_unit_format("cf")
+def short_formatter(unit, registry, **options):
+    """Return a CF-compliant unit string from a `pint` unit.
+
+    Parameters
+    ----------
+    unit : pint.UnitContainer
+        Input unit.
+    registry : pint.UnitRegistry
+        The associated registry
+    **options
+        Additional options (may be ignored)
+
+    Returns
+    -------
+    out : str
+        Units following CF-Convention, using symbols.
+    """
+    # pint 0.24.1 gives {"dimensionless": 1} for non-shortened dimensionless units
+    # CF uses "1" to denote fractions and dimensionless quantities
+    if unit == {"dimensionless": 1} or not unit:
+        return "1"
+
+    # If u is a name, get its symbol (same as pint's "~" pre-formatter)
+    # otherwise, assume a symbol (pint should have already raised on invalid units before this)
+    unit = pint.util.UnitsContainer(
+        {
+            registry._get_symbol(u) if u in registry._units else u: exp
+            for u, exp in unit.items()
+        }
+    )
+
+    # Change in formatter signature in pint 0.24
+    if Version(pint.__version__) < Version("0.24"):
+        args = (unit.items(),)
+    else:
+        # Numerators splitted from denominators
+        args = (
+            ((u, e) for u, e in unit.items() if e >= 0),
+            ((u, e) for u, e in unit.items() if e < 0),
+        )
+
+    out = pint.formatter(*args, as_ratio=False, product_fmt=" ", power_fmt="{}{}")
+    # To avoid potentiel unicode problems in netCDF. In both cases, this unit is not recognized by udunits
+    return out.replace("Δ°", "delta_deg")
 
-except ImportError:
-    pass
 
 # ------
 # Reused with modification from MetPy under the terms of the BSD 3-Clause License.

{cf_xarray-0.9.2 → cf_xarray-0.9.3}/cf_xarray.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cf_xarray
-Version: 0.9.2
+Version: 0.9.3
 Summary: A convenience wrapper for using CF attributes on xarray objects
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -224,7 +224,7 @@ License-File: LICENSE
 Requires-Dist: xarray
 Provides-Extra: all
 Requires-Dist: matplotlib; extra == "all"
-Requires-Dist: pint; extra == "all"
+Requires-Dist: pint!=0.24.0,>=0.18; extra == "all"
 Requires-Dist: shapely; extra == "all"
 Requires-Dist: regex; extra == "all"
 Requires-Dist: rich; extra == "all"

{cf_xarray-0.9.2 → cf_xarray-0.9.3}/cf_xarray.egg-info/requires.txt

@@ -2,7 +2,7 @@ xarray
 
 [all]
 matplotlib
-pint
+pint!=0.24.0,>=0.18
 shapely
 regex
 rich

{cf_xarray-0.9.2 → cf_xarray-0.9.3}/doc/units.md

@@ -16,7 +16,7 @@ hide-toc: true
 
 The xarray ecosystem supports unit-aware arrays using  [pint](https://pint.readthedocs.io) and [pint-xarray](https://pint-xarray.readthedocs.io). Some changes are required to make these packages work well with [UDUNITS format recommended by the CF conventions](http://cfconventions.org/Data/cf-conventions/cf-conventions-1.8/cf-conventions.html#units).
 
-`cf_xarray` makes those recommended changes when you `import cf_xarray.units`. These changes allow pint to parse and format UDUNIT units strings, and add several custom units like `degrees_north` for latitude, `psu` for ocean salinity, etc.
+`cf_xarray` makes those recommended changes when you `import cf_xarray.units`. These changes allow pint to parse and format UDUNIT units strings, and add several custom units like `degrees_north` for latitude, `psu` for ocean salinity, etc.  Be aware that pint supports some units that UDUNITS does not recognize but `cf-xarray` will not try to detect them and raise an error. For example, a temperature subtraction returns "delta_degC" units in pint, which does not exist in UDUNITS.
 
 ## Formatting units
 
@@ -27,5 +27,5 @@ from pint import application_registry as ureg
 import cf_xarray.units
 
 u = ureg.Unit("m ** 3 / s ** 2")
-f"{u:~cf}"
+f"{u:cf}" # or {u:~cf}, both return the same short format
 ```

{cf_xarray-0.9.2 → cf_xarray-0.9.3}/pyproject.toml

@@ -22,7 +22,7 @@ dependencies = [
 dynamic = ["version"]
 
 [project.optional-dependencies]
-all = ["matplotlib", "pint", "shapely", "regex", "rich", "pooch"]
+all = ["matplotlib", "pint >=0.18, !=0.24.0", "shapely", "regex", "rich", "pooch"]
 
 [project.urls]
 homepage = "https://cf-xarray.readthedocs.io"

cf_xarray-0.9.2/cf_xarray/_version.py

@@ -1 +0,0 @@
-__version__ = "0.9.2"