Merge pull request #376 from davidhassell/cached-elements

Control setting and display of cached data elements

Author: davidhassell

Changelog.rst

@@ -8,8 +8,19 @@ Version NEXTVERSION
   (https://github.com/NCAS-CMS/cfdm/issues/354)
 * Read Zarr v2 and v3 datasets that contain a group hierarchy with
   `cfdm.read` (https://github.com/NCAS-CMS/cfdm/issues/355)
-* New function `cfdm.dataset_flatten` that replaces the deprecated
+* New function `cfdm.dataset_flatten` that replaces the deprecated*
   `cfdm.netcdf_flatten` (https://github.com/NCAS-CMS/cfdm/issues/355)
+* New function to control the creation of cached elements during data
+  display: `cfdm.display_data`
+  (https://github.com/NCAS-CMS/cfdm/issues/363)
+* New methods: `cfdm.Data.get_cached_elements`,
+  `cfdm.Data.cache_elements`
+  (https://github.com/NCAS-CMS/cfdm/issues/363)
+* Set cached elements during `cfdm.Data.__init__`
+  (https://github.com/NCAS-CMS/cfdm/issues/363)
+* Removed the `cfdm.constants.CONSTANTS` dictionary, replacing it
+  with `cfdm.ConstantAccess.constants`
+  (https://github.com/NCAS-CMS/cfdm/issues/361)
 * Reduce the time taken to import `cfdm`
   (https://github.com/NCAS-CMS/cfdm/issues/361)
 * New optional dependency: ``zarr>=3.1.3``

cfdm/__init__.py

@@ -60,6 +60,7 @@
     chunksize,
     configuration,
     dirname,
+    display_data,
     environment,
     integer_dtype,
     log_level,

cfdm/auxiliarycoordinate.py

@@ -49,6 +49,7 @@ class AuxiliaryCoordinate(
     def dump(
         self,
         display=True,
+        data=None,
         _omit_properties=None,
         _key=None,
         _level=0,
@@ -65,6 +66,10 @@ def dump(
 
         :Parameters:
 
+            {{data: `bool` or `None`, optional}}
+
+                .. versionadded:: (cfdm) NEXTVERSION
+
             display: `bool`, optional
                 If False then return the description as a string. By
                 default the description is printed.
@@ -78,6 +83,7 @@ def dump(
             _title = "Auxiliary coordinate: " + self.identity(default="")
 
         return super().dump(
+            data=data,
             display=display,
             _key=_key,
             _level=_level,

cfdm/bounds.py

@@ -47,6 +47,7 @@ class Bounds(
 
     def dump(
         self,
+        data=None,
         display=True,
         _key=None,
         _title=None,
@@ -66,6 +67,10 @@ def dump(
 
         :Parameters:
 
+            {{data: `bool` or `None`, optional}}
+
+                .. versionadded:: (cfdm) NEXTVERSION
+
             display: `bool`, optional
                 If False then return the description as a string. By
                 default the description is printed.
@@ -79,6 +84,7 @@ def dump(
             _title = "Bounds: " + self.identity(default="")
 
         return super().dump(
+            data=data,
             display=display,
             _key=_key,
             _omit_properties=_omit_properties,

cfdm/cellconnectivity.py

@@ -127,6 +127,7 @@ def creation_commands(
 
     def dump(
         self,
+        data=None,
         display=True,
         _omit_properties=None,
         _key=None,
@@ -144,6 +145,10 @@ def dump(
 
         :Parameters:
 
+            {{data: `bool` or `None`, optional}}
+
+                .. versionadded:: (cfdm) NEXTVERSION
+
             display: `bool`, optional
                 If False then return the description as a string. By
                 default the description is printed.
@@ -157,6 +162,7 @@ def dump(
             _title = "Cell Connectivity: " + self.identity(default="")
 
         return super().dump(
+            data=data,
             display=display,
             _key=_key,
             _omit_properties=_omit_properties,

cfdm/cellmeasure.py

@@ -120,6 +120,7 @@ def creation_commands(
 
     def dump(
         self,
+        data=None,
         display=True,
         _omit_properties=None,
         _key=None,
@@ -137,6 +138,10 @@ def dump(
 
         :Parameters:
 
+            {{data: `bool` or `None`, optional}}
+
+                .. versionadded:: (cfdm) NEXTVERSION
+
             display: `bool`, optional
                 If False then return the description as a string. By
                 default the description is printed.
@@ -161,6 +166,7 @@ def dump(
                 _title += f" (external variable: {ncvar})"
 
         return super().dump(
+            data=data,
             display=display,
             _key=_key,
             _omit_properties=_omit_properties,

cfdm/count.py

@@ -43,6 +43,7 @@ class Count(
 
     def dump(
         self,
+        data=None,
         display=True,
         _key=None,
         _title=None,
@@ -62,6 +63,10 @@ def dump(
 
         :Parameters:
 
+            {{data: `bool` or `None`, optional}}
+
+                .. versionadded:: (cfdm) NEXTVERSION
+
             display: `bool`, optional
                 If False then return the description as a string. By
                 default the description is printed.
@@ -75,6 +80,7 @@ def dump(
             _title = "Count: " + self.identity(default="")
 
         return super().dump(
+            data=data,
             display=display,
             _key=_key,
             _omit_properties=_omit_properties,