Cubesummary tidy

lib/iris/_representation.py

@@ -6,7 +6,7 @@
 """
 Provides objects describing cube summaries.
 """
-
+import numpy as np
 import iris.util
 
 
@@ -66,7 +66,11 @@ def _summary_coord_extra(self, cube, coord):
                         vary.add(key)
                         break
                     value = similar_coord.attributes[key]
-                    if attributes.setdefault(key, value) != value:
+                    # Like "if attributes.setdefault(key, value) != value:"
+                    # ..except setdefault fails if values are numpy arrays.
+                    if key not in attributes:
+                        attributes[key] = value
+                    elif not np.all(attributes[key] == value):
                         vary.add(key)
                         break
             keys = sorted(vary & set(coord.attributes.keys()))
@@ -132,9 +136,6 @@ def __init__(self, cube, coord):
 
 
 class Section:
-    def _init_(self):
-        self.contents = []
-
     def is_empty(self):
         return self.contents == []
 
@@ -180,11 +181,13 @@ def __init__(self, title, cell_methods):
 
 
 class CubeSummary:
+    """
+    This class provides a structure for output representations of an Iris cube.
+    TODO: use to produce the printout of :meth:`iris.cube.Cube.__str__`.
+
+    """
+
     def __init__(self, cube, shorten=False, name_padding=35):
-        self.section_indent = 5
-        self.item_indent = 10
-        self.extra_indent = 13
-        self.shorten = shorten
         self.header = FullHeader(cube, name_padding)
 
         # Cache the derived coords so we can rely on consistent
@@ -249,9 +252,9 @@ def add_vector_section(title, contents, iscoord=True):
         add_vector_section("Dimension coordinates:", vector_dim_coords)
         add_vector_section("Auxiliary coordinates:", vector_aux_coords)
         add_vector_section("Derived coordinates:", vector_derived_coords)
-        add_vector_section("Cell Measures:", vector_cell_measures, False)
+        add_vector_section("Cell measures:", vector_cell_measures, False)
         add_vector_section(
-            "Ancillary Variables:", vector_ancillary_variables, False
+            "Ancillary variables:", vector_ancillary_variables, False
         )
 
         self.scalar_sections = {}
@@ -260,7 +263,7 @@ def add_scalar_section(section_class, title, *args):
             self.scalar_sections[title] = section_class(title, *args)
 
         add_scalar_section(
-            ScalarSection, "Scalar Coordinates:", cube, scalar_coords
+            ScalarSection, "Scalar coordinates:", cube, scalar_coords
         )
         add_scalar_section(
             ScalarCellMeasureSection,

lib/iris/tests/unit/representation/test_representation.py

@@ -54,8 +54,8 @@ def test_blank_cube(self):
             "Dimension coordinates:",
             "Auxiliary coordinates:",
             "Derived coordinates:",
-            "Cell Measures:",
-            "Ancillary Variables:",
+            "Cell measures:",
+            "Ancillary variables:",
         ]
         self.assertEqual(
             list(rep.vector_sections.keys()), expected_vector_sections
@@ -66,7 +66,7 @@ def test_blank_cube(self):
             self.assertTrue(vector_section.is_empty())
 
         expected_scalar_sections = [
-            "Scalar Coordinates:",
+            "Scalar coordinates:",
             "Scalar cell measures:",
             "Attributes:",
             "Cell methods:",
@@ -111,7 +111,7 @@ def test_scalar_coord(self):
         cube.add_aux_coord(scalar_coord_text)
         rep = iris._representation.CubeSummary(cube)
 
-        scalar_section = rep.scalar_sections["Scalar Coordinates:"]
+        scalar_section = rep.scalar_sections["Scalar coordinates:"]
 
         self.assertEqual(len(scalar_section.contents), 3)
 
@@ -137,7 +137,7 @@ def test_cell_measure(self):
         cube.add_cell_measure(cell_measure, 0)
         rep = iris._representation.CubeSummary(cube)
 
-        cm_section = rep.vector_sections["Cell Measures:"]
+        cm_section = rep.vector_sections["Cell measures:"]
         self.assertEqual(len(cm_section.contents), 1)
 
         cm_summary = cm_section.contents[0]
@@ -150,7 +150,7 @@ def test_ancillary_variable(self):
         cube.add_ancillary_variable(cell_measure, 0)
         rep = iris._representation.CubeSummary(cube)
 
-        av_section = rep.vector_sections["Ancillary Variables:"]
+        av_section = rep.vector_sections["Ancillary variables:"]
         self.assertEqual(len(av_section.contents), 1)
 
         av_summary = av_section.contents[0]
@@ -182,6 +182,56 @@ def test_cell_methods(self):
         expected_contents = ["mean: x, y", "mean: x"]
         self.assertEqual(cell_method_section.contents, expected_contents)
 
+    def test_scalar_cube(self):
+        cube = self.cube
+        while cube.ndim > 0:
+            cube = cube[0]
+        rep = iris._representation.CubeSummary(cube)
+        self.assertEqual(rep.header.nameunit, "air_temperature / (K)")
+        self.assertTrue(rep.header.dimension_header.scalar)
+        self.assertEqual(rep.header.dimension_header.dim_names, [])
+        self.assertEqual(rep.header.dimension_header.shape, [])
+        self.assertEqual(rep.header.dimension_header.contents, ["scalar cube"])
+        self.assertEqual(len(rep.vector_sections), 5)
+        self.assertTrue(
+            all(sect.is_empty() for sect in rep.vector_sections.values())
+        )
+        self.assertEqual(len(rep.scalar_sections), 4)
+        self.assertEqual(
+            len(rep.scalar_sections["Scalar coordinates:"].contents), 1
+        )
+        self.assertTrue(
+            rep.scalar_sections["Scalar cell measures:"].is_empty()
+        )
+        self.assertTrue(rep.scalar_sections["Attributes:"].is_empty())
+        self.assertTrue(rep.scalar_sections["Cell methods:"].is_empty())
+
+    def test_coord_attributes(self):
+        cube = self.cube
+        co1 = cube.coord("latitude")
+        co1.attributes.update(dict(a=1, b=2))
+        co2 = co1.copy()
+        co2.attributes.update(dict(a=7, z=77))
+        cube.add_aux_coord(co2, cube.coord_dims(co1))
+        rep = iris._representation.CubeSummary(cube)
+        co1_summ = rep.vector_sections["Dimension coordinates:"].contents[0]
+        co2_summ = rep.vector_sections["Auxiliary coordinates:"].contents[0]
+        self.assertEqual(co1_summ.extra, "a=1")
+        self.assertEqual(co2_summ.extra, "a=7, z=77")
+
+    def test_array_attributes(self):
+        cube = self.cube
+        co1 = cube.coord("latitude")
+        co1.attributes.update(dict(a=1, array=np.array([1.2, 3])))
+        co2 = co1.copy()
+        co2.attributes.update(dict(b=2, array=np.array([3.2, 1])))
+        cube.add_aux_coord(co2, cube.coord_dims(co1))
+        rep = iris._representation.CubeSummary(cube)
+        co1_summ = rep.vector_sections["Dimension coordinates:"].contents[0]
+        co2_summ = rep.vector_sections["Auxiliary coordinates:"].contents[0]
+        self.assertEqual(co1_summ.extra, "array=array([1.2, 3. ])")
+        self.assertEqual(co2_summ.extra, "array=array([3.2, 1. ]), b=2")
+
 
 if __name__ == "__main__":
     tests.main()