dev

Author: davidhassell

Changelog.rst

@@ -1,3 +1,14 @@
+Version NEXTVERSION
+----------------
+
+**2025-??-??**
+
+* Read Zarr datasets with `cf.read`
+  (https://github.com/NCAS-CMS/cf-python/issues/863)
+* Changed dependency: ``cfdm>=1.12.2.0, <1.12.3.0``
+
+----
+
 version 3.17.0
 --------------
 

cf/data/array/zarrarray.py

@@ -2,11 +2,13 @@
 
 from ...mixin_container import Container
 
+# Uncomment when we can use active storage on Zarr datasets:
 # from .mixin import ActiveStorageMixin
 
 
 class ZarrArray(
-    #    ActiveStorageMixin,
+    # Uncomment when we can use active storage on Zarr datasets:
+    # ActiveStorageMixin,
     Container,
     cfdm.ZarrArray,
 ):

cf/data/mixin/deprecations.py

@@ -437,14 +437,14 @@ def dumps(self):
     def HDF_chunks(self, *chunks):
         """Get or set HDF chunk sizes.
 
-        The HDF chunk sizes may be used by external code that allows
-        `Data` objects to be written to netCDF files.
-
         Deprecated at version 3.14.0 and is no longer available. Use
         the methods `nc_clear_dataset_chunksizes`,
         `nc_dataset_chunksizes`, and `nc_set_dataset_chunksizes`
         instead.
 
+        The HDF chunk sizes may be used by external code that allows
+        `Data` objects to be written to netCDF files.
+
         .. seealso:: `nc_clear_dataset_chunksizes`,
                      `nc_dataset_chunksizes`,
                      `nc_set_dataset_chunksizes`

cf/field.py

@@ -13991,11 +13991,12 @@ def field(
         )  # pragma: no cover
 
     def HDF_chunks(self, *chunksizes):
-        """Deprecated at version 3.0.0.
+        """Get or set HDF chunk sizes.
 
-        Use methods 'Data.nc_dataset_chunksizes',
-        'Data.nc_set_dataset_chunksizes',
-        'Data.nc_clear_dataset_chunksizes' instead.
+        Deprecated at version 3.0.0 and is no longer available.  Use
+        methods `Data.nc_dataset_chunksizes`,
+        `Data.nc_set_dataset_chunksizes`,
+        `Data.nc_clear_dataset_chunksizes` instead.
 
         """
         _DEPRECATION_ERROR_METHOD(

cf/read_write/read.py

@@ -146,6 +146,10 @@ class read(cfdm.read):
 
         {{read datasets: (arbitrarily nested sequence of) `str`}}
 
+        {{read recursive: `bool`, optional}}
+
+        {{read followlinks: `bool`, optional}}
+
         {{read cdl_string: `bool`, optional}}
 
         {{read external: (sequence of) `str`, optional}}
@@ -165,7 +169,7 @@ class read(cfdm.read):
             ============  ============================================
             ``'netCDF'``  A netCDF-3 or netCDF-4 dataset
             ``'CDL'``     A text CDL file of a netCDF dataset
-            ``'Zarr'``    A Zarr v2 (xarray) or Zarr v3 dataset
+            ``'Zarr'``    A Zarr v2 (xarray-style) or Zarr v3 dataset
             ``'UM'``      A UM fields file or PP dataset
             ============  ============================================
 
@@ -276,24 +280,6 @@ class read(cfdm.read):
             select='air_temperature')`` is equivalent to ``fl =
             cf.read(file).select_by_identity('air_temperature')``.
 
-        recursive: `bool`, optional
-            If True then recursively read sub-directories of any
-            directories specified with the *files* parameter.
-
-        followlinks: `bool`, optional
-            If True, and *recursive* is True, then also search for
-            files in sub-directories which resolve to symbolic
-            links. By default directories which resolve to symbolic
-            links are ignored. Ignored of *recursive* is False. Files
-            which are symbolic links are always followed.
-
-            Note that setting ``recursive=True, followlinks=True`` can
-            lead to infinite recursion if a symbolic link points to a
-            parent directory of itself.
-
-            This parameter replaces the deprecated *follow_symlinks*
-            parameter.
-
         {{read warn_valid: `bool`, optional}}
 
             .. versionadded:: 3.4.0

cf/test/test_read_write.py

@@ -798,7 +798,6 @@ def test_read_write_domain(self):
 
         e = cf.read(tmpfile, domain=True, verbose=1)
         self.assertEqual(len(e), 1)
-        print(type(e))
         self.assertIsInstance(e, cf.DomainList)
         e = e[0]
         self.assertIsInstance(e, cf.Domain)

docs/source/tutorial.rst

@@ -131,7 +131,11 @@ The following file types can be read:
 
 ..
   
-* Datasets in `Zarr v2 (xarray) <https://docs.xarray.dev/en/latest/internals/zarr-encoding-spec.html>`_ and `Zarr v3 <https://zarr-specs.readthedocs.io/en/latest/v3/core/index.html>`_ formats.
+* Datasets in `Zarr v2 (xarray-style)
+  <https://docs.xarray.dev/en/latest/internals/zarr-encoding-spec.html>`_
+  and `Zarr v3
+  <https://zarr-specs.readthedocs.io/en/latest/v3/core/index.html>`_
+  formats.
 
 ..