review actions

Author: bjlittle

lib/iris/aux_factory.py

@@ -14,7 +14,7 @@
 import dask.array as da
 import numpy as np
 
-from iris.common import CFVariableMixin, CoordMetadata, MetadataFactory
+from iris.common import CFVariableMixin, CoordMetadata, MetadataManagerFactory
 import iris.coords
 
 
@@ -34,8 +34,8 @@ class AuxCoordFactory(CFVariableMixin, metaclass=ABCMeta):
 
     def __init__(self):
         # Configure the metadata manager.
-        if not hasattr(self, "_metadata"):
-            self._metadata = MetadataFactory(CoordMetadata)
+        if not hasattr(self, "_metadata_manager"):
+            self._metadata_manager = MetadataManagerFactory(CoordMetadata)
 
         #: Descriptive name of the coordinate made by the factory
         self.long_name = None
@@ -45,19 +45,19 @@ def __init__(self):
 
         self.coord_system = None
         # See the climatological property getter.
-        self._metadata.climatological = False
+        self._metadata_manager.climatological = False
 
     @property
     def coord_system(self):
         """
         The coordinate-system (if any) of the coordinate made by the factory.
 
         """
-        return self._metadata.coord_system
+        return self._metadata_manager.coord_system
 
     @coord_system.setter
     def coord_system(self, value):
-        self._metadata.coord_system = value
+        self._metadata_manager.coord_system = value
 
     @property
     def climatological(self):
@@ -66,7 +66,7 @@ def climatological(self):
         and therefore can never be climatological by definition.
 
         """
-        return self._metadata.climatological
+        return self._metadata_manager.climatological
 
     @property
     @abstractmethod
@@ -385,7 +385,7 @@ def __init__(self, delta=None, sigma=None, orography=None):
 
         """
         # Configure the metadata manager.
-        self._metadata = MetadataFactory(CoordMetadata)
+        self._metadata_manager = MetadataManagerFactory(CoordMetadata)
         super().__init__()
 
         if delta and delta.nbounds not in (0, 2):
@@ -574,7 +574,7 @@ def __init__(self, delta=None, sigma=None, surface_air_pressure=None):
 
         """
         # Configure the metadata manager.
-        self._metadata = MetadataFactory(CoordMetadata)
+        self._metadata_manager = MetadataManagerFactory(CoordMetadata)
         super().__init__()
 
         # Check that provided coords meet necessary conditions.
@@ -779,7 +779,7 @@ def __init__(
 
         """
         # Configure the metadata manager.
-        self._metadata = MetadataFactory(CoordMetadata)
+        self._metadata_manager = MetadataManagerFactory(CoordMetadata)
         super().__init__()
 
         # Check that provided coordinates meet necessary conditions.
@@ -1080,7 +1080,7 @@ def __init__(self, sigma=None, eta=None, depth=None):
 
         """
         # Configure the metadata manager.
-        self._metadata = MetadataFactory(CoordMetadata)
+        self._metadata_manager = MetadataManagerFactory(CoordMetadata)
         super().__init__()
 
         # Check that provided coordinates meet necessary conditions.
@@ -1263,7 +1263,7 @@ def __init__(self, s=None, c=None, eta=None, depth=None, depth_c=None):
 
         """
         # Configure the metadata manager.
-        self._metadata = MetadataFactory(CoordMetadata)
+        self._metadata_manager = MetadataManagerFactory(CoordMetadata)
         super().__init__()
 
         # Check that provided coordinates meet necessary conditions.
@@ -1486,7 +1486,7 @@ def __init__(
 
         """
         # Configure the metadata manager.
-        self._metadata = MetadataFactory(CoordMetadata)
+        self._metadata_manager = MetadataManagerFactory(CoordMetadata)
         super().__init__()
 
         # Check that provided coordinates meet necessary conditions.
@@ -1704,7 +1704,7 @@ def __init__(self, s=None, c=None, eta=None, depth=None, depth_c=None):
 
         """
         # Configure the metadata manager.
-        self._metadata = MetadataFactory(CoordMetadata)
+        self._metadata_manager = MetadataManagerFactory(CoordMetadata)
         super().__init__()
 
         # Check that provided coordinates meet necessary conditions.

lib/iris/common/metadata.py

@@ -17,15 +17,15 @@
     "CellMeasureMetadata",
     "CoordMetadata",
     "CubeMetadata",
-    "MetadataFactory",
+    "MetadataManagerFactory",
 ]
 
 
 # https://www.unidata.ucar.edu/software/netcdf/docs/netcdf_data_set_components.html#object_name
 _TOKEN_PARSE = re.compile(r"""^[a-zA-Z0-9][\w\.\+\-@]*$""")
 
 
-class _BaseMeta(ABCMeta):
+class _NamedTupleMeta(ABCMeta):
     """
     Meta-class to support the convenience of creating a namedtuple from
     names/members of the metadata class hierarchy.
@@ -71,7 +71,7 @@ def __new__(mcs, name, bases, namespace):
         return super().__new__(mcs, name, bases, namespace)
 
 
-class BaseMetadata(metaclass=_BaseMeta):
+class BaseMetadata(metaclass=_NamedTupleMeta):
     """
     Container for common metadata.
 
@@ -154,7 +154,8 @@ def _check(item):
     def __lt__(self, other):
         #
         # Support Python2 behaviour for a "<" operation involving a
-        # "NoneType" operand.
+        # "NoneType" operand. Require to at least implement this comparison
+        # operator to support sorting of instances.
         #
         if not isinstance(other, self.__class__):
             return NotImplemented
@@ -242,7 +243,7 @@ def _check(item):
     @property
     def _names(self):
         """
-        A tuple containing the value of each name participating in the identify
+        A tuple containing the value of each name participating in the identity
         of a :class:`iris.cube.Cube`. This includes the standard name,
         long name, NetCDF variable name, and the STASH from the attributes
         dictionary.
@@ -267,7 +268,7 @@ def _names(self):
         return (standard_name, long_name, var_name, stash_name)
 
 
-def MetadataFactory(cls, **kwargs):
+def MetadataManagerFactory(cls, **kwargs):
     """
     A class instance factory function responsible for manufacturing
     metadata instances dynamically at runtime.
@@ -333,7 +334,7 @@ def __reduce__(self):
         instance, and dump and load instance state successfully.
 
         """
-        return (MetadataFactory, (self.cls,), self.__getstate__())
+        return (MetadataManagerFactory, (self.cls,), self.__getstate__())
 
     def __repr__(self):
         args = ", ".join(
@@ -373,7 +374,7 @@ def values(self):
             raise ValueError(emsg.format(cls.__name__, bad))
 
     # Define the name, (inheritance) bases and namespace of the dynamic class.
-    name = "Metadata"
+    name = "MetadataManager"
     bases = ()
     namespace = {
         "DEFAULT_NAME": cls.DEFAULT_NAME,

lib/iris/common/mixin.py

@@ -121,7 +121,7 @@ def update(self, other, **kwargs):
 class CFVariableMixin:
     @wraps(BaseMetadata.name)
     def name(self, default=None, token=None):
-        return self._metadata.name(default=default, token=token)
+        return self._metadata_manager.name(default=default, token=token)
 
     def rename(self, name):
         """
@@ -145,60 +145,62 @@ def rename(self, name):
     @property
     def standard_name(self):
         """The CF Metadata standard name for the object."""
-        return self._metadata.standard_name
+        return self._metadata_manager.standard_name
 
     @standard_name.setter
     def standard_name(self, name):
-        self._metadata.standard_name = _get_valid_standard_name(name)
+        self._metadata_manager.standard_name = _get_valid_standard_name(name)
 
     @property
     def long_name(self):
         """The CF Metadata long name for the object."""
-        return self._metadata.long_name
+        return self._metadata_manager.long_name
 
     @long_name.setter
     def long_name(self, name):
-        self._metadata.long_name = name
+        self._metadata_manager.long_name = name
 
     @property
     def var_name(self):
         """The NetCDF variable name for the object."""
-        return self._metadata.var_name
+        return self._metadata_manager.var_name
 
     @var_name.setter
     def var_name(self, name):
         if name is not None:
-            result = self._metadata.token(name)
+            result = self._metadata_manager.token(name)
             if result is None or not name:
                 emsg = "{!r} is not a valid NetCDF variable name."
                 raise ValueError(emsg.format(name))
-        self._metadata.var_name = name
+        self._metadata_manager.var_name = name
 
     @property
     def units(self):
         """The S.I. unit of the object."""
-        return self._metadata.units
+        return self._metadata_manager.units
 
     @units.setter
     def units(self, unit):
-        self._metadata.units = cf_units.as_unit(unit)
+        self._metadata_manager.units = cf_units.as_unit(unit)
 
     @property
     def attributes(self):
-        return self._metadata.attributes
+        return self._metadata_manager.attributes
 
     @attributes.setter
     def attributes(self, attributes):
-        self._metadata.attributes = LimitedAttributeDict(attributes or {})
+        self._metadata_manager.attributes = LimitedAttributeDict(
+            attributes or {}
+        )
 
     @property
     def metadata(self):
-        return self._metadata.values
+        return self._metadata_manager.values
 
     @metadata.setter
     def metadata(self, metadata):
-        cls = self._metadata.cls
-        fields = self._metadata.fields
+        cls = self._metadata_manager.cls
+        fields = self._metadata_manager.fields
         arg = metadata
 
         try:

lib/iris/coords.py

@@ -31,7 +31,7 @@
     CFVariableMixin,
     CellMeasureMetadata,
     CoordMetadata,
-    MetadataFactory,
+    MetadataManagerFactory,
 )
 import iris.exceptions
 import iris.time
@@ -98,8 +98,8 @@ def __init__(
         # it provides is a 'has_bounds()' method, which always returns False.
 
         # Configure the metadata manager.
-        if not hasattr(self, "_metadata"):
-            self._metadata = MetadataFactory(BaseMetadata)
+        if not hasattr(self, "_metadata_manager"):
+            self._metadata_manager = MetadataManagerFactory(BaseMetadata)
 
         #: CF standard name of the quantity that the metadata represents.
         self.standard_name = standard_name
@@ -709,8 +709,10 @@ def __init__(
 
         """
         # Configure the metadata manager.
-        if not hasattr(self, "_metadata"):
-            self._metadata = MetadataFactory(AncillaryVariableMetadata)
+        if not hasattr(self, "_metadata_manager"):
+            self._metadata_manager = MetadataManagerFactory(
+                AncillaryVariableMetadata
+            )
 
         super().__init__(
             values=data,
@@ -820,7 +822,7 @@ def __init__(
 
         """
         # Configure the metadata manager.
-        self._metadata = MetadataFactory(CellMeasureMetadata)
+        self._metadata_manager = MetadataManagerFactory(CellMeasureMetadata)
 
         super().__init__(
             data=data,
@@ -839,14 +841,14 @@ def __init__(
 
     @property
     def measure(self):
-        return self._metadata.measure
+        return self._metadata_manager.measure
 
     @measure.setter
     def measure(self, measure):
         if measure not in ["area", "volume"]:
             emsg = f"measure must be 'area' or 'volume', got {measure!r}"
             raise ValueError(emsg)
-        self._metadata.measure = measure
+        self._metadata_manager.measure = measure
 
     def __str__(self):
         result = repr(self)
@@ -1319,7 +1321,7 @@ def __init__(
 
         """
         # Configure the metadata manager.
-        self._metadata = MetadataFactory(CoordMetadata)
+        self._metadata_manager = MetadataManagerFactory(CoordMetadata)
 
         super().__init__(
             values=points,
@@ -1438,11 +1440,11 @@ def bounds(self, bounds):
     @property
     def coord_system(self):
         """The coordinate-system of the coordinate."""
-        return self._metadata.coord_system
+        return self._metadata_manager.coord_system
 
     @coord_system.setter
     def coord_system(self, value):
-        self._metadata.coord_system = value
+        self._metadata_manager.coord_system = value
 
     @property
     def climatological(self):
@@ -1457,10 +1459,10 @@ def climatological(self):
 
         """
         if not self.has_bounds():
-            self._metadata.climatological = False
+            self._metadata_manager.climatological = False
         if not self.units.is_time_reference():
-            self._metadata.climatological = False
-        return self._metadata.climatological
+            self._metadata_manager.climatological = False
+        return self._metadata_manager.climatological
 
     @climatological.setter
     def climatological(self, value):
@@ -1478,7 +1480,7 @@ def climatological(self, value):
                 emsg = "Cannot set climatological coordinate, no bounds exist."
                 raise ValueError(emsg)
 
-        self._metadata.climatological = value
+        self._metadata_manager.climatological = value
 
     def lazy_points(self):
         """