subspace mode -> config

Author: davidhassell

cf/docstring/docstring.py

@@ -620,13 +620,13 @@
     "{{to_size: `int`, optional}}": """to_size: `int`, optional
                 Pad the axis after so that the new axis has the given
                 size.""",
-    # subspace mode options
-    "{{mode: optional}}": """mode: optional
-                Specify the mode of operation (``mode``) and a halo to
-                be added to the subspaced axes (``halo``) with
-                positional arguments in format ``mode``, or ``halo``,
-                or ``mode, halo``, or with no positional arguments at
-                all.
+    # subspace config options
+    "{{config: optional}}": """config: optional
+                Configure the subspace by specifying the mode of
+                operation (``mode``) and any halo to be added to the
+                subspaced axes (``halo``), with positional arguments
+                in the format ``mode``, or ``halo``, or ``mode,
+                halo``, or with no positional arguments at all.
 
                 A mode of operation is given as a `str`, and a halo as
                 a non-negative `int` (or any object that can be

cf/domain.py

@@ -739,7 +739,7 @@ def identities(self):
 
         return out
 
-    def indices(self, *mode, **kwargs):
+    def indices(self, *config, **kwargs):
         """Create indices that define a subspace of the domain
         construct.
 
@@ -789,7 +789,7 @@ def indices(self, *mode, **kwargs):
 
         :Parameters:
 
-            {{mode: optional}}
+            {{config: optional}}
 
                 {{subspace valid modes Domain}}
 
@@ -847,7 +847,7 @@ def indices(self, *mode, **kwargs):
         """
         # Get the indices for every domain axis in the domain, without
         # any auxiliary masks.
-        domain_indices = self._indices(mode, None, False, kwargs)
+        domain_indices = self._indices(config, None, False, kwargs)
 
         return domain_indices["indices"]
 
@@ -1094,7 +1094,7 @@ def roll(self, axis, shift, inplace=False):
 
         return d
 
-    def subspace(self, *mode, **kwargs):
+    def subspace(self, *config, **kwargs):
         """Create a subspace of the field construct.
 
         Creation of a new domain construct which spans a subspace of
@@ -1141,7 +1141,7 @@ def subspace(self, *mode, **kwargs):
 
         :Parameters:
 
-            {{mode: optional}}
+            {{config: optional}}
 
                 {{subspace valid modes Domain}}
 
@@ -1186,19 +1186,19 @@ def subspace(self, *mode, **kwargs):
 
         """
         test = False
-        if "test" in mode:
-            mode = list(mode)
-            mode.remove("test")
+        if "test" in config:
+            config = list(config)
+            config.remove("test")
             test = True
 
-        if not mode and not kwargs:
+        if not config and not kwargs:
             if test:
                 return True
 
             return self.copy()
 
         try:
-            indices = self.indices(*mode, **kwargs)
+            indices = self.indices(*config, **kwargs)
         except ValueError as error:
             if test:
                 return False

cf/field.py

@@ -8809,7 +8809,7 @@ def insert_dimension(
             inplace=inplace,
         )
 
-    def indices(self, *mode, **kwargs):
+    def indices(self, *config, **kwargs):
         """Create indices that define a subspace of the field construct.
 
         The subspace is defined by identifying indices based on the
@@ -8879,7 +8879,7 @@ def indices(self, *mode, **kwargs):
 
         :Parameters:
 
-            {{mode: optional}}
+            {{config: optional}}
 
                 {{subspace valid modes Field}}
 
@@ -9006,7 +9006,7 @@ def indices(self, *mode, **kwargs):
          [-- -- -- -- -- -- 270.6 273.0 270.6]]]
 
         """
-        if "exact" in mode:
+        if "exact" in config:
             _DEPRECATION_ERROR_ARG(
                 self,
                 "indices",
@@ -9020,7 +9020,7 @@ def indices(self, *mode, **kwargs):
 
         # Get the indices for every domain axis in the domain,
         # including any ancillary masks
-        domain_indices = self._indices(mode, data_axes, True, kwargs)
+        domain_indices = self._indices(config, data_axes, True, kwargs)
 
         # Initialise the output indices with any ancillary masks.
         # Ensure that each ancillary mask is broadcastable to the
@@ -13286,7 +13286,7 @@ def subspace(self):
 
         :Parameters:
 
-            {{mode: optional}}
+            {{config: optional}}
 
                 {{subspace valid modes Field}}
 

cf/mixin/fielddomain.py

@@ -203,7 +203,7 @@ def _equivalent_coordinate_references(
 
         return True
 
-    def _indices(self, mode, data_axes, ancillary_mask, kwargs):
+    def _indices(self, config, data_axes, ancillary_mask, kwargs):
         """Create indices that define a subspace of the field or domain
         construct.
 
@@ -217,9 +217,9 @@ def _indices(self, mode, data_axes, ancillary_mask, kwargs):
 
         :Parameters:
 
-            mode: `tuple`
+            config: `tuple`
                 The mode of operation and the halo size. See the
-                *mode* parameter of `indices` for details.
+                *config* parameter of `indices` for details.
 
             data_axes: sequence of `str`, or `None`
                 The domain axis identifiers of the data axes, or
@@ -255,24 +255,24 @@ def _indices(self, mode, data_axes, ancillary_mask, kwargs):
         debug = is_log_level_debug(logger)
 
         # Parse mode and halo
-        n_mode = len(mode)
-        if not n_mode:
+        n_config = len(config)
+        if not n_config:
             mode = None
             halo = None
-        elif n_mode == 1:
+        elif n_config == 1:
             try:
-                halo = int(mode[0])
+                halo = int(config[0])
             except ValueError:
-                mode = mode[0]
+                mode = config[0]
                 halo = None
             else:
                 mode = None
-        elif n_mode == 2:
-            mode, halo = mode
+        elif n_config == 2:
+            mode, halo = config
         else:
             raise ValueError(
                 "Can't provide more than two positional arguments. "
-                f"Got: {', '.join(repr(x) for x in mode)}"
+                f"Got: {', '.join(repr(x) for x in config)}"
             )
 
         compress = mode is None or mode == "compress"

cf/subspacefield.py

@@ -89,11 +89,12 @@ class SubspaceField(mixin.Subspace):
 
     :Parameters:
 
-        mode: optional
-            Specify the mode of operation (``mode``) and a halo to be
-            added to the subspaced axes (``halo``) with positional
-            arguments in format ``mode``, or ``halo``, or ``mode,
-            halo``, or with no positional arguments at all.
+        config: optional
+            Configure the subspace by specifying the mode of operation
+            (``mode``) and any halo to be added to the subspaced axes
+            (``halo``), with positional arguments in the format
+            ``mode``, or ``halo``, or ``mode, halo``, or with no
+            positional arguments at all.
 
             A mode of operation is given as a `str`, and a halo as a
             non-negative `int` (or any object that can be converted to
@@ -201,7 +202,7 @@ class SubspaceField(mixin.Subspace):
 
     __slots__ = []
 
-    def __call__(self, *args, **kwargs):
+    def __call__(self, *config, **kwargs):
         """Create a subspace of a field construct.
 
         Creation of a new field construct which spans a subspace of the
@@ -324,19 +325,19 @@ def __call__(self, *args, **kwargs):
         field = self.variable
 
         test = False
-        if "test" in args:
-            args = list(args)
-            args.remove("test")
+        if "test" in config:
+            config = list(config)
+            config.remove("test")
             test = True
 
-        if not args and not kwargs:
+        if not config and not kwargs:
             if test:
                 return True
 
             return field.copy()
 
         try:
-            indices = field.indices(*args, **kwargs)
+            indices = field.indices(*config, **kwargs)
             out = field[indices]
         except (ValueError, IndexError) as error:
             if test: