Fix cube repr for scalar anc_var and cell measures

docs/src/whatsnew/latest.rst

@@ -50,6 +50,12 @@ This document explains the changes made to Iris for this release
 #. `@bjlittle`_ and `@lbdreyer`_ (reviewer) fixed the building of the CF
    Standard Names module ``iris.std_names`` for the ``setup.py`` commands
    ``develop`` and ``std_names``. (:issue:`4951`, :pull:`4952`)
+
+#. `@lbdreyer`_ and `@pp-mo`_ (reviewer) fixed the cube print out such that
+   scalar ancillary variables are displayed in a dedicated section rather than
+   being added to the vector ancillary variables section. Further, ancillary
+   variables and cell measures that map to a cube dimension of length 1 are now
+   included in the respective vector sections. (:pull:`4945`)
 
 
 💣 Incompatible Changes

lib/iris/_representation/cube_printout.py

@@ -260,7 +260,10 @@ def add_scalar_row(name, value=""):
                 elif title in ("attributes:", "cell methods:", "mesh:"):
                     for title, value in zip(sect.names, sect.values):
                         add_scalar_row(title, value)
-                elif title == "scalar cell measures:":
+                elif title in (
+                    "scalar ancillary variables:",
+                    "scalar cell measures:",
+                ):
                     # These are just strings: nothing in the 'value' column.
                     for name in sect.contents:
                         add_scalar_row(name)

lib/iris/_representation/cube_summary.py

@@ -219,6 +219,12 @@ def __init__(self, title, cell_measures):
         self.contents = [cm.name() for cm in cell_measures]
 
 
+class ScalarAncillaryVariableSection(Section):
+    def __init__(self, title, ancillary_variables):
+        self.title = title
+        self.contents = [av.name() for av in ancillary_variables]
+
+
 class AttributeSection(Section):
     def __init__(self, title, attributes):
         self.title = title
@@ -274,7 +280,7 @@ class CubeSummary:
 
     """
 
-    def __init__(self, cube, shorten=False, name_padding=35):
+    def __init__(self, cube, name_padding=35):
         self.header = FullHeader(cube, name_padding)
 
         # Cache the derived coords so we can rely on consistent
@@ -314,13 +320,23 @@ def __init__(self, cube, shorten=False, name_padding=35):
             if id(coord) not in scalar_coord_ids
         ]
 
-        # cell measures
-        vector_cell_measures = [
-            cm for cm in cube.cell_measures() if cm.shape != (1,)
-        ]
-
         # Ancillary Variables
-        vector_ancillary_variables = [av for av in cube.ancillary_variables()]
+        vector_ancillary_variables = []
+        scalar_ancillary_variables = []
+        for av, av_dims in cube._ancillary_variables_and_dims:
+            if av_dims:
+                vector_ancillary_variables.append(av)
+            else:
+                scalar_ancillary_variables.append(av)
+
+        # Cell Measures
+        vector_cell_measures = []
+        scalar_cell_measures = []
+        for cm, cm_dims in cube._cell_measures_and_dims:
+            if cm_dims:
+                vector_cell_measures.append(cm)
+            else:
+                scalar_cell_measures.append(cm)
 
         # Sort scalar coordinates by name.
         scalar_coords.sort(key=lambda coord: coord.name())
@@ -334,9 +350,6 @@ def __init__(self, cube, shorten=False, name_padding=35):
         vector_derived_coords.sort(
             key=lambda coord: (cube.coord_dims(coord), coord.name())
         )
-        scalar_cell_measures = [
-            cm for cm in cube.cell_measures() if cm.shape == (1,)
-        ]
 
         self.vector_sections = {}
 
@@ -369,6 +382,11 @@ def add_scalar_section(section_class, title, *args):
             "Scalar cell measures:",
             scalar_cell_measures,
         )
+        add_scalar_section(
+            ScalarAncillaryVariableSection,
+            "Scalar ancillary variables:",
+            scalar_ancillary_variables,
+        )
         add_scalar_section(
             CellMethodSection, "Cell methods:", cube.cell_methods
         )

lib/iris/tests/unit/representation/cube_printout/test_CubePrintout.py

@@ -349,6 +349,20 @@ def test_section_vector_ancils(self):
         ]
         self.assertEqual(rep, expected)
 
+    def test_section_vector_ancils_length_1(self):
+        # Check ancillary variables that map to a cube dimension of length 1
+        # are not interpreted as scalar ancillary variables.
+        cube = Cube(np.zeros((1, 3)), long_name="name", units=1)
+        cube.add_ancillary_variable(AncillaryVariable([0], long_name="av1"), 0)
+
+        rep = cube_replines(cube)
+        expected = [
+            "name / (1)                          (-- : 1; -- : 3)",
+            "    Ancillary variables:",
+            "        av1                             x       -",
+        ]
+        self.assertEqual(rep, expected)
+
     def test_section_vector_cell_measures(self):
         cube = Cube(np.zeros((2, 3)), long_name="name", units=1)
         cube.add_cell_measure(CellMeasure([0, 1, 2], long_name="cm"), 1)
@@ -361,6 +375,20 @@ def test_section_vector_cell_measures(self):
         ]
         self.assertEqual(rep, expected)
 
+    def test_section_vector_cell_measures_length_1(self):
+        # Check cell measures that map to a cube dimension of length 1 are not
+        # interpreted as scalar cell measures.
+        cube = Cube(np.zeros((2, 1)), long_name="name", units=1)
+        cube.add_cell_measure(CellMeasure([0], long_name="cm"), 1)
+
+        rep = cube_replines(cube)
+        expected = [
+            "name / (1)                          (-- : 2; -- : 1)",
+            "    Cell measures:",
+            "        cm                              -       x",
+        ]
+        self.assertEqual(rep, expected)
+
     def test_section_scalar_coords(self):
         # incl points + bounds
         # TODO: ought to incorporate coord-based summary
@@ -424,8 +452,8 @@ def test_section_scalar_ancillaries(self):
         rep = cube_replines(cube)
         expected = [
             "name / (1)                          (-- : 2; -- : 3)",
-            "    Ancillary variables:",
-            "        av                              -       -",
+            "    Scalar ancillary variables:",
+            "        av",
         ]
         self.assertEqual(rep, expected)
 

lib/iris/tests/unit/representation/cube_summary/test_CubeSummary.py

@@ -75,6 +75,7 @@ def test_blank_cube(self):
             "Mesh:",
             "Scalar coordinates:",
             "Scalar cell measures:",
+            "Scalar ancillary variables:",
             "Cell methods:",
             "Attributes:",
         ]
@@ -222,7 +223,7 @@ def test_scalar_cube(self):
         self.assertTrue(
             all(sect.is_empty() for sect in rep.vector_sections.values())
         )
-        self.assertEqual(len(rep.scalar_sections), 5)
+        self.assertEqual(len(rep.scalar_sections), 6)
         self.assertEqual(
             len(rep.scalar_sections["Scalar coordinates:"].contents), 1
         )