cf-xarray 0.10.0__tar.gz → 0.10.1__tar.gz

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/.github/workflows/ci.yaml

@@ -36,7 +36,7 @@ jobs:
         run: |
           echo "PYTHON_VERSION=${{ matrix.python-version }}" >> $GITHUB_ENV
       - name: Set up conda environment
-        uses: mamba-org/setup-micromamba@v1
+        uses: mamba-org/setup-micromamba@v2
         with:
           environment-file: ci/environment.yml
           environment-name: cf_xarray_test
@@ -50,7 +50,7 @@ jobs:
         run: |
           pytest -n auto --cov=./ --cov-report=xml
       - name: Upload code coverage to Codecov
-        uses: codecov/codecov-action@v4.5.0
+        uses: codecov/codecov-action@v5.4.0
         with:
           file: ./coverage.xml
           flags: unittests
@@ -70,7 +70,7 @@ jobs:
           # need to fetch all tags to get a correct version
           fetch-depth: 0  # fetch all branches and tags
       - name: Set up conda environment
-        uses: mamba-org/setup-micromamba@v1
+        uses: mamba-org/setup-micromamba@v2
         with:
           environment-file: ci/environment-no-optional-deps.yml
           environment-name: cf_xarray_test
@@ -97,7 +97,7 @@ jobs:
         with:
           fetch-depth: 0 # Fetch all history for all branches and tags.
       - name: Set up conda environment
-        uses: mamba-org/setup-micromamba@v1
+        uses: mamba-org/setup-micromamba@v2
         with:
           environment-file: ci/environment.yml
           environment-name: cf_xarray_test
@@ -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.5.0
+        uses: codecov/codecov-action@v5.4.0
         with:
           file: mypy_report/cobertura.xml
           flags: mypy

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/.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.10.2
+        uses: pypa/gh-action-pypi-publish@v1.12.4
         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.10.2
+        uses: pypa/gh-action-pypi-publish@v1.12.4
         with:
           verbose: true

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/.github/workflows/upstream-dev-ci.yaml

@@ -38,7 +38,7 @@ jobs:
         run: |
           echo "PYTHON_VERSION=${{ matrix.python-version }}" >> $GITHUB_ENV
       - name: Set up conda environment
-        uses: mamba-org/setup-micromamba@v1
+        uses: mamba-org/setup-micromamba@v2
         with:
           environment-file: ci/upstream-dev-env.yml
           environment-name: cf_xarray_test

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/.pre-commit-config.yaml

@@ -3,22 +3,18 @@ ci:
 
 repos:
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.17.0
+    rev: v3.19.1
     hooks:
       - id: pyupgrade
         args: ["--py310-plus"]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: 'v0.6.9'
+    rev: 'v0.9.3'
     hooks:
       - id: ruff
-        args: ["--show-fixes", "--fix"]
-
-  - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 24.10.0
-    hooks:
-      - id: black
+        args: ["--fix", "--show-fixes"]
+      - id: ruff-format
 
   - repo: https://github.com/rstcheck/rstcheck
     rev: v6.2.4
@@ -28,7 +24,7 @@ repos:
           args: ['--config', 'pyproject.toml']
 
   - repo: https://github.com/executablebooks/mdformat
-    rev: 0.7.17
+    rev: 0.7.21
     hooks:
     - id: mdformat
       additional_dependencies:
@@ -36,10 +32,8 @@ repos:
         - mdformat-myst
 
   - repo: https://github.com/nbQA-dev/nbQA
-    rev: 1.8.7
+    rev: 1.9.1
     hooks:
-        - id: nbqa-black
-        - id: nbqa-ruff
         - id: nbqa
           entry: nbqa mdformat
           name: nbqa-mdformat
@@ -55,19 +49,13 @@ repos:
       - id: check-yaml
       - id: debug-statements
 
-  - repo: https://github.com/keewis/blackdoc
-    rev: v0.3.9
-    hooks:
-      - id: blackdoc
-        files: .+\.py$
-
   - repo: https://github.com/citation-file-format/cff-converter-python
     rev: "44e8fc9"
     hooks:
     - id: validate-cff
 
   - repo: https://github.com/abravalheri/validate-pyproject
-    rev: v0.20.2
+    rev: v0.23
     hooks:
       - id: validate-pyproject
 

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/.readthedocs.yml

@@ -1,5 +1,6 @@
 version: 2
-
+sphinx:
+  configuration: doc/conf.py
 build:
   os: ubuntu-lts-latest
   tools:

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: cf_xarray
-Version: 0.10.0
+Version: 0.10.1
 Summary: A convenience wrapper for using CF attributes on xarray objects
 License:                                  Apache License
                                    Version 2.0, January 2004

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/cf_xarray/__init__.py

@@ -9,6 +9,6 @@ from .helpers import bounds_to_vertices, vertices_to_bounds  # noqa
 from .options import set_options  # noqa
 from .utils import _get_version
 
-from . import geometry  # noqa
+from . import geometry, groupers  # noqa
 
 __version__ = _get_version()

cf_xarray-0.10.1/cf_xarray/_version.py

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

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/cf_xarray/accessor.py

@@ -680,7 +680,7 @@ def _getattr(
             None,
         ):
             raise AttributeError(
-                f"{obj.__class__.__name__+'.cf'!r} object has no attribute {attr!r}"
+                f"{obj.__class__.__name__ + '.cf'!r} object has no attribute {attr!r}"
             ) from None
         raise AttributeError(
             f"{attr!r} is not a valid attribute on the underlying xarray object."
@@ -1374,7 +1374,11 @@ class CFAccessor:
                 coords_iter = coords
             coords = [
                 apply_mapper(
-                    [_single(_get_coords)], self._obj, v, error=False, default=[v]  # type: ignore[arg-type]
+                    [_single(_get_coords)],  # type:ignore[arg-type]
+                    self._obj,
+                    v,
+                    error=False,
+                    default=[v],
                 )[0]
                 for v in coords_iter
             ]
@@ -1385,7 +1389,11 @@ class CFAccessor:
                 reduce_dims_iter = list(reduce_dims)
             reduce_dims = [
                 apply_mapper(
-                    [_single(_get_dims)], self._obj, v, error=False, default=[v]  # type: ignore[arg-type]
+                    [_single(_get_dims)],  # type:ignore[arg-type]
+                    self._obj,
+                    v,
+                    error=False,
+                    default=[v],
                 )[0]
                 for v in reduce_dims_iter
             ]
@@ -2758,9 +2766,9 @@ class CFDatasetAccessor(CFAccessor):
 
         for dim in allterms:
             if prefix is None:
-                assert (
-                    outnames is not None
-                ), "if prefix is None, outnames must be provided"
+                assert outnames is not None, (
+                    "if prefix is None, outnames must be provided"
+                )
                 # set outnames here
                 try:
                     zname = outnames[dim]

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/cf_xarray/datasets.py

@@ -21,15 +21,14 @@ ds_with_tuple = airds.rename({"air": (1, 2, 3)})
 
 # POM dataset
 pomds = xr.Dataset()
+# fmt: off
 pomds["sigma"] = (
-    # fmt: off
     "sigma",
     [-0.983333, -0.95    , -0.916667, -0.883333, -0.85    , -0.816667,
      -0.783333, -0.75    , -0.716667, -0.683333, -0.65    , -0.616667,
      -0.583333, -0.55    , -0.516667, -0.483333, -0.45    , -0.416667,
      -0.383333, -0.35    , -0.316667, -0.283333, -0.25    , -0.216667,
      -0.183333, -0.15    , -0.116667, -0.083333, -0.05    , -0.016667],
-    # fmt: on
     {
         "units": "sigma_level",
         "long_name": "Sigma Stretched Vertical Coordinate at Nodes",
@@ -38,6 +37,7 @@ pomds["sigma"] = (
         "formula_terms": "sigma: sigma eta: zeta depth: depth",
     }
 )
+# fmt: on
 pomds["depth"] = 175.0
 pomds["zeta"] = ("ocean_time", [-0.155356, -0.127435])
 
@@ -109,15 +109,14 @@ multiple["v2"] = (("x2", "y2"), np.ones((10, 5)) * 15)
 
 
 romsds = xr.Dataset()
+# fmt: off
 romsds["s_rho"] = (
-    # fmt: off
     "s_rho",
     [-0.983333, -0.95    , -0.916667, -0.883333, -0.85    , -0.816667,
      -0.783333, -0.75    , -0.716667, -0.683333, -0.65    , -0.616667,
      -0.583333, -0.55    , -0.516667, -0.483333, -0.45    , -0.416667,
      -0.383333, -0.35    , -0.316667, -0.283333, -0.25    , -0.216667,
      -0.183333, -0.15    , -0.116667, -0.083333, -0.05    , -0.016667],
-    # fmt: on
     {
         "long_name": "S-coordinate at RHO-points",
         "valid_min": -1.0,
@@ -125,13 +124,14 @@ romsds["s_rho"] = (
         "standard_name": "ocean_s_coordinate_g2",
         "formula_terms": "s: s_rho C: Cs_r eta: zeta depth: h depth_c: hc",
         "field": "s_rho, scalar",
-    }
+    },
 )
+# fmt: on
 romsds.coords["hc"] = 20.0
 romsds.coords["h"] = 603.9
 romsds.coords["Vtransform"] = 2.0
+# fmt: off
 romsds.coords["Cs_r"] = (
-    # fmt: off
     "s_rho",
     [-9.33010396e-01, -8.09234736e-01, -6.98779853e-01, -6.01008926e-01,
      -5.15058562e-01, -4.39938913e-01, -3.74609181e-01, -3.18031817e-01,
@@ -141,8 +141,8 @@ romsds.coords["Cs_r"] = (
      -2.53860004e-02, -1.95414261e-02, -1.46880431e-02, -1.06952600e-02,
      -7.45515186e-03, -4.87981407e-03, -2.89916971e-03, -1.45919898e-03,
      -5.20560097e-04, -5.75774004e-05],
-    # fmt: on
 )
+# fmt: on
 romsds["zeta"] = ("ocean_time", [-0.155356, -0.127435])
 romsds["temp"] = (
     ("ocean_time", "s_rho"),

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/cf_xarray/geometry.py

@@ -4,6 +4,7 @@ import copy
 from collections import ChainMap
 from collections.abc import Hashable, Sequence
 from dataclasses import dataclass
+from typing import TYPE_CHECKING
 
 import numpy as np
 import pandas as pd
@@ -21,6 +22,9 @@ __all__ = [
 ]
 
 
+if TYPE_CHECKING:
+    from shapely import MultiPoint, Point
+
 # 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.
@@ -547,7 +551,11 @@ def cf_to_shapely(ds: xr.Dataset, *, container: Hashable = GEOMETRY_CONTAINER_NA
     return geometries.rename("geometry")
 
 
-def points_to_cf(pts: xr.DataArray | Sequence, *, names: GeometryNames | None = None):
+def points_to_cf(
+    pts: xr.DataArray | Sequence[Point | MultiPoint],
+    *,
+    names: GeometryNames | None = None,
+):
     """Get a list of points (shapely.geometry.[Multi]Point) and return a CF-compliant geometry dataset.
 
     Parameters
@@ -563,6 +571,7 @@ def points_to_cf(pts: xr.DataArray | Sequence, *, names: GeometryNames | None =
     """
     from shapely.geometry import MultiPoint
 
+    pts_: Sequence[Point | MultiPoint]
     if isinstance(pts, xr.DataArray):
         # TODO: Fix this hardcoding
         if pts.ndim != 1:

cf_xarray-0.10.1/cf_xarray/groupers.py

@@ -0,0 +1,34 @@
+from dataclasses import dataclass
+
+import numpy as np
+import pandas as pd
+from xarray.groupers import EncodedGroups, UniqueGrouper
+
+
+@dataclass
+class FlagGrouper(UniqueGrouper):
+    def factorize(self, group) -> EncodedGroups:
+        if "flag_values" not in group.attrs or "flag_meanings" not in group.attrs:
+            raise ValueError(
+                "FlagGrouper can only be used with flag variables that have"
+                "`flag_values` and `flag_meanings` specified in attrs."
+            )
+
+        values = np.array(group.attrs["flag_values"])
+        full_index = pd.Index(group.attrs["flag_meanings"].split(" "))
+
+        self.labels = values
+
+        # TODO: we could optimize here, since `group` is already factorized,
+        # but there are subtleties. For example, the attrs must be up to date,
+        # any value that is not in flag_values will cause an error, etc.
+        ret = super().factorize(group)
+
+        ret.codes.attrs.pop("flag_values")
+        ret.codes.attrs.pop("flag_meanings")
+
+        return EncodedGroups(
+            codes=ret.codes,
+            full_index=full_index,
+            group_indices=ret.group_indices,
+        )

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/cf_xarray/options.py

@@ -38,7 +38,6 @@ class set_options:  # numpydoc ignore=PR01,PR02
     >>> ds = xr.Dataset({"elev": np.arange(1000)})
     >>> with cf_xarray.set_options(custom_criteria=my_custom_criteria):
     ...     xr.testing.assert_identical(ds["elev"], ds.cf["ssh"])
-    ...
 
     Or to set global options:
 

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/cf_xarray/tests/__init__.py

@@ -32,8 +32,7 @@ class CountingScheduler:
         self.total_computes += 1
         if self.total_computes > self.max_computes:
             raise RuntimeError(
-                "Too many computes. Total: %d > max: %d."
-                % (self.total_computes, self.max_computes)
+                f"Too many computes. Total:{self.total_computes} > max: {self.max_computes}."
             )
         return dask.get(dsk, keys, **kwargs)
 

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/cf_xarray/tests/test_accessor.py

@@ -453,7 +453,7 @@ def test_rename_like() -> None:
 @pytest.mark.parametrize(
     "attr, xrkwargs, cfkwargs",
     (
-        ("resample", {"time": "M"}, {"T": "M"}),
+        ("resample", {"time": "ME"}, {"T": "ME"}),
         ("rolling", {"lat": 5}, {"Y": 5}),
         ("groupby", {"group": "time"}, {"group": "T"}),
         ("groupby", {"group": "time.month"}, {"group": "T.month"}),
@@ -1748,7 +1748,7 @@ def test_add_canonical_attributes(override, skip, verbose, capsys):
 
     # Attributes have been added
     for var in sum(ds.cf.standard_names.values(), []):
-        assert set(ds[var].attrs) < set(cf_ds[var].attrs)
+        assert set(ds[var].attrs) <= set(cf_ds[var].attrs)
 
     # Time units did not change
     assert ds["time"].attrs.get("units") is cf_ds["time"].attrs.get("units") is None
@@ -2047,7 +2047,8 @@ def test_ancillary_variables_extra_dim():
             ),
         }
     )
-    assert_identical(ds.cf["X"], ds["x"])
+    with pytest.warns(UserWarning):
+        assert_identical(ds.cf["X"], ds["x"])
 
 
 def test_geometry_association(geometry_ds):

cf_xarray-0.10.1/cf_xarray/tests/test_groupers.py

@@ -0,0 +1,45 @@
+import numpy as np
+import pytest
+import xarray as xr
+from xarray.testing import assert_identical
+
+from cf_xarray.datasets import flag_excl
+from cf_xarray.groupers import FlagGrouper
+
+
+def test_flag_grouper():
+    ds = flag_excl.to_dataset().set_coords("flag_var").copy(deep=True)
+    ds["foo"] = ("time", np.arange(8))
+    actual = ds.groupby(flag_var=FlagGrouper()).mean()
+    expected = ds.groupby("flag_var").mean()
+    expected["flag_var"] = ["flag_1", "flag_2", "flag_3"]
+    expected["flag_var"].attrs["standard_name"] = "flag_mutual_exclusive"
+    assert_identical(actual, expected)
+
+    del ds.flag_var.attrs["flag_values"]
+    with pytest.raises(ValueError):
+        ds.groupby(flag_var=FlagGrouper())
+
+    ds.flag_var.attrs["flag_values"] = [0, 1, 2]
+    del ds.flag_var.attrs["flag_meanings"]
+    with pytest.raises(ValueError):
+        ds.groupby(flag_var=FlagGrouper())
+
+
+@pytest.mark.parametrize(
+    "values",
+    [
+        [1, 2],
+        [1, 2, 3],  # value out of range of flag_values
+    ],
+)
+def test_flag_grouper_optimized(values):
+    ds = xr.Dataset(
+        {"foo": ("x", values, {"flag_values": [0, 1, 2], "flag_meanings": "a b c"})}
+    )
+    ret = FlagGrouper().factorize(ds.foo)
+    expected = ds.foo
+    expected.data[ds.foo.data > 2] = -1
+    del ds.foo.attrs["flag_meanings"]
+    del ds.foo.attrs["flag_values"]
+    assert_identical(ret.codes, ds.foo)

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/cf_xarray/utils.py

@@ -108,10 +108,16 @@ def parse_cf_standard_name_table(source=None):
     if not source:
         import pooch
 
+        downloader = pooch.HTTPDownloader(
+            # https://github.com/readthedocs/readthedocs.org/issues/11763
+            headers={"User-Agent": "cf-xarray"}
+        )
+
         source = pooch.retrieve(
             "https://raw.githubusercontent.com/cf-convention/cf-convention.github.io/"
             "master/Data/cf-standard-names/current/src/cf-standard-name-table.xml",
             known_hash=None,
+            downloader=downloader,
         )
     root = ElementTree.parse(source).getroot()
 

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/cf_xarray.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: cf_xarray
-Version: 0.10.0
+Version: 0.10.1
 Summary: A convenience wrapper for using CF attributes on xarray objects
 License:                                  Apache License
                                    Version 2.0, January 2004

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/cf_xarray.egg-info/SOURCES.txt

@@ -24,6 +24,7 @@ cf_xarray/criteria.py
 cf_xarray/datasets.py
 cf_xarray/formatting.py
 cf_xarray/geometry.py
+cf_xarray/groupers.py
 cf_xarray/helpers.py
 cf_xarray/options.py
 cf_xarray/parametric.py
@@ -43,6 +44,7 @@ cf_xarray/tests/conftest.py
 cf_xarray/tests/test_accessor.py
 cf_xarray/tests/test_coding.py
 cf_xarray/tests/test_geometry.py
+cf_xarray/tests/test_groupers.py
 cf_xarray/tests/test_helpers.py
 cf_xarray/tests/test_options.py
 cf_xarray/tests/test_parametric.py

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/ci/doc.yml

@@ -8,7 +8,7 @@ dependencies:
   - netcdf4
   - pooch
   - xarray
-  - sphinx
+  - sphinx<8
   - sphinx-copybutton
   - numpydoc
   - sphinx-autosummary-accessors

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/doc/api.rst

@@ -21,13 +21,20 @@ Geometries
 ----------
 .. autosummary::
     :toctree: generated/
-
     geometry.decode_geometries
+
     geometry.encode_geometries
     geometry.shapely_to_cf
     geometry.cf_to_shapely
     geometry.GeometryNames
 
+
+Groupers
+--------
+.. autosummary::
+    :toctree: generated/
+    groupers.FlagGrouper
+
 .. currentmodule:: xarray
 
 DataArray

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/doc/bounds.md

@@ -14,7 +14,7 @@
 
 `cf_xarray` supports parsing [coordinate bounds](http://cfconventions.org/Data/cf-conventions/cf-conventions-1.10/cf-conventions.html#cell-boundaries) as encoded in the CF `bounds` attribute. A useful feature for incomplete dataset is also the automatic bounds estimation possible through `cf.add_bounds`. This method will estimate the missing bounds by finding the middle points between elements of the given coordinate, but also by extrapolating to find the outer bounds of the grid. This linear estimation works well with rectilinear grids, but it is only a coarse approximation for curvilinear and simple irregular grids.
 
-As an example, we present a "rotated pole" grid. It is defined on a rotated rectilinear grid which uses the `rlat` and  `rlon` 1D coordinates, over North America at a resolution of 0.44°. The datasets comes with 2D `lat` and `lon` coordinates. `cf_xarray` will estimate the bounds by linear interpolation (extrapolation at the edges) of the existing `lon` and `lat`, which yields good results on parts of the grid where the rotation is small. However the errors is larger in other places, as seen when visualizing the distance in degrees between the estimated bounds and the true bounds.
+As an example, we present a "rotated pole" grid. It is defined on a rotated rectilinear grid which uses the `rlat` and `rlon` 1D coordinates, over North America at a resolution of 0.44°. The datasets comes with 2D `lat` and `lon` coordinates. `cf_xarray` will estimate the bounds by linear interpolation (extrapolation at the edges) of the existing `lon` and `lat`, which yields good results on parts of the grid where the rotation is small. However the errors is larger in other places, as seen when visualizing the distance in degrees between the estimated bounds and the true bounds.
 
 ![2d bounds error](2D_bounds_error.png)
 

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/doc/coord_axes.md

@@ -55,7 +55,7 @@ This table lists these internal criteria
    :stub-columns: 1
 ```
 
-Any DataArray that has `standard_name: "latitude"` or `_CoordinateAxisType: "Lat"` or `"units": "degrees_north"` in its `attrs` will be identified as the `"latitude"` variable by cf-xarray.  Similarly for other coordinate names.
+Any DataArray that has `standard_name: "latitude"` or `_CoordinateAxisType: "Lat"` or `"units": "degrees_north"` in its `attrs` will be identified as the `"latitude"` variable by cf-xarray. Similarly for other coordinate names.
 
 ## Axis Names
 
@@ -68,7 +68,7 @@ Similar criteria exist for the concept of "axes".
    :stub-columns: 1
 ```
 
-## `.axes` and  `.coordinates` properties
+## `.axes` and `.coordinates` properties
 
 Alternatively use the special properties {py:attr}`DataArray.cf.axes` or {py:attr}`DataArray.cf.coordinates` to access the variable names. These properties return dictionaries that map "CF names" to a list of variable names. Note that a list is always returned even if only one variable name matches the name `"latitude"` (for example).
 

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/doc/custom-criteria.md

@@ -73,7 +73,7 @@ with cfxr.set_options(custom_criteria=salt_criteria):
 salty
 ```
 
-Note that `salty` contains both `salt1` and `salt2`. Without setting these criteria, we  would only get `salt1` by default
+Note that `salty` contains both `salt1` and `salt2`. Without setting these criteria, we would only get `salt1` by default
 
 ```{code-cell}
 ds.cf[["sea_water_salinity"]]

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/doc/flags.md

@@ -60,6 +60,38 @@ You can also check whether a DataArray has the appropriate attributes to be reco
 da.cf.is_flag_variable
 ```
 
+## GroupBy
+
+Flag variables, such as that above, are naturally used for GroupBy operations.
+cf-xarray provides a `FlagGrouper` that understands the `flag_meanings` and `flag_values` attributes.
+
+Let's load an example dataset where the `flag_var` array has the needed attributes.
+
+```{code-cell}
+import cf_xarray as cfxr
+import numpy as np
+
+from cf_xarray.datasets import flag_excl
+
+ds = flag_excl.to_dataset().set_coords('flag_var')
+ds["foo"] = ("time", np.arange(8))
+ds.flag_var
+```
+
+Now use the :py:class:`~cf_xarray.groupers.FlagGrouper` to group by this flag variable:
+
+```{code-cell}
+from cf_xarray.groupers import FlagGrouper
+
+ds.groupby(flag_var=FlagGrouper()).mean()
+```
+
+Note how the output coordinate has the values from `flag_meanings`!
+
+```{seealso}
+See the Xarray docs on using [Grouper objects](https://docs.xarray.dev/en/stable/user-guide/groupby.html#grouper-objects).
+```
+
 ## Flag Masks
 
 ```{warning}

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/doc/selecting.md

@@ -30,7 +30,7 @@ CF conventions on
 1. [ancillary data](http://cfconventions.org/Data/cf-conventions/cf-conventions-1.8/cf-conventions.html#ancillary-data)
 ```
 
-A powerful feature of `cf_xarray` is the ability select DataArrays using special "CF names" like the "latitude", or "longitude" coordinate names, "X"  or "Y" axes names, oreven using the `standard_name` attribute if present.
+A powerful feature of `cf_xarray` is the ability select DataArrays using special "CF names" like the "latitude", or "longitude" coordinate names, "X" or "Y" axes names, oreven using the `standard_name` attribute if present.
 
 To demonstrate this, let's load a few datasets
 
@@ -91,7 +91,7 @@ anc
 
 ## Selecting multiple variables
 
-Sometimes a Dataset may contain multiple `X` or multiple `longitude` variables. In that case a simple `.cf["X"]` will raise an error. Instead follow Xarray convention and pass a  list `.cf[["X"]]` to receive a Dataset with all available `"X"` variables
+Sometimes a Dataset may contain multiple `X` or multiple `longitude` variables. In that case a simple `.cf["X"]` will raise an error. Instead follow Xarray convention and pass a list `.cf[["X"]]` to receive a Dataset with all available `"X"` variables
 
 ```{code-cell}
 multiple.cf[["X"]]
@@ -103,7 +103,7 @@ pop.cf[["longitude"]]
 
 ## Mixing names
 
-cf_xarray aims to be as friendly as possible, so it is  possible to mix "CF names" and normal variable names. Here we select `UVEL` and `TEMP` by using the `standard_name` of `TEMP` (which is `sea_water_potential_temperature`)
+cf_xarray aims to be as friendly as possible, so it is possible to mix "CF names" and normal variable names. Here we select `UVEL` and `TEMP` by using the `standard_name` of `TEMP` (which is `sea_water_potential_temperature`)
 
 ```{code-cell}
 pop.cf[["sea_water_potential_temperature", "UVEL"]]

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/doc/sgrid_ugrid.md

@@ -65,7 +65,7 @@ variable `grid` list many more dimension names.
 
 ### Topology variable
 
-`cf_xarray` supports identifying  the `mesh_topology` variable using the `cf_role` attribute.
+`cf_xarray` supports identifying the `mesh_topology` variable using the `cf_role` attribute.
 
 ## More?
 

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/doc/units.md

@@ -14,9 +14,9 @@ hide-toc: true
 1. [CF conventions on units](http://cfconventions.org/Data/cf-conventions/cf-conventions-1.8/cf-conventions.html#units)
 ```
 
-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).
+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.  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.
+`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
 

{cf_xarray-0.10.0 → cf_xarray-0.10.1}/pyproject.toml

@@ -53,9 +53,6 @@ write_to = "cf_xarray/_version.py"
 write_to_template= '__version__ = "{version}"'
 tag_regex= "^(?P<prefix>v)?(?P<version>[^\\+]+)(?P<suffix>.*)?$"
 
-[tool.black]
-target-version = ["py310"]
-
 [tool.ruff]
 target-version = "py310"
 builtins = ["ellipsis"]
@@ -66,14 +63,18 @@ exclude = [
 
 [tool.ruff.lint]
 # E402: module level import not at top of file
-# E501: line too long - let ruff worry about that
+# E501: line too long - let black worry about that
+# E731: do not assign a lambda expression, use a def
 ignore = [
     "E402",
     "E501",
+    "E731",
     "B018",
     "B015",
 ]
 select = [
+    # Bugbear
+    "B",
     # Pyflakes
     "F",
     # Pycodestyle
@@ -84,9 +85,6 @@ select = [
     # Pyupgrade
     "UP",
 ]
-extend-select = [
-  "B",  # flake8-bugbear
-]
 
 [tool.ruff.lint.isort]
 known-first-party = ["cf_xarray"]
@@ -103,6 +101,10 @@ known-third-party = [
     "xarray"
 ]
 
+[tool.ruff.format]
+# Enable reformatting of code snippets in docstrings.
+docstring-code-format = true
+
 
 [tool.pytest]
 python_files = "test_*.py"

cf_xarray-0.10.0/cf_xarray/_version.py

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