Merge branch 'main' of github.com:NCAS-CMS/cf-python into field-combination

Author: davidhassell

Changelog.rst

@@ -1,3 +1,19 @@
+version NEXTVERSION
+-------------------
+
+**2024-??-??**
+
+* Include the UM version as a field property when reading UM files
+  (https://github.com/NCAS-CMS/cf-python/issues/777)
+* Fix bug where `cf.example_fields` returned a `list`
+  of Fields rather than a `Fieldlist`
+  (https://github.com/NCAS-CMS/cf-python/issues/725)
+* Fix bug where `cf.normalize_slice` doesn't correctly
+  handle certain cyclic slices
+  (https://github.com/NCAS-CMS/cf-python/issues/774)
+
+----
+
 version 3.16.2
 --------------
 

cf/examplefield.py

@@ -1,6 +1,7 @@
 import cfdm
 
 from .cfimplementation import implementation
+from .fieldlist import FieldList
 
 _implementation = implementation()
 
@@ -13,7 +14,7 @@ def example_field(n, _implementation=_implementation):
 
 
 def example_fields(*n, _func=example_field):
-    return cfdm.example_fields(*n, _func=_func)
+    return FieldList(cfdm.example_fields(*n, _func=_func))
 
 
 example_fields.__doc__ = cfdm.example_fields.__doc__.replace("cfdm.", "cf.")

cf/field.py

@@ -10513,9 +10513,9 @@ def convolution_filter(
                     new_bounds[0 : length - lower_offset, 1:] = old_bounds[
                         lower_offset:length, 1:
                     ]
-                    new_bounds[length - lower_offset : length, 1:] = (
-                        old_bounds[length - 1, 1:]
-                    )
+                    new_bounds[
+                        length - lower_offset : length, 1:
+                    ] = old_bounds[length - 1, 1:]
 
                 coord.set_bounds(self._Bounds(data=new_bounds))
 

cf/functions.py

@@ -2132,8 +2132,8 @@ def normalize_slice(index, size, cyclic=False):
         return slice(start, stop, step)
 
     if not (
-        (step > 0 and start < 0 and stop > 0)
-        or (step < 0 and start > 0 and stop < 0)
+        (step > 0 and start < 0 and stop >= 0)
+        or (step < 0 and start >= 0 and stop < 0)
     ):
         raise IndexError(
             f"{index!r} is not a {'cyclic ' if cyclic else ''}slice"

cf/read_write/um/umread.py

@@ -1040,6 +1040,22 @@ def __init__(
             cf_properties["stash_code"] = str(stash)
             cf_properties["submodel"] = str(submodel)
 
+            # Convert the UM version to a string and provide it as a
+            # CF property. E.g. 405 -> '4.5', 606.3 -> '6.6.3', 1002
+            # -> '10.2'
+            #
+            # Note: We don't just do `divmod(self.um_version, 100)`
+            #       because if self.um_version has a fractional part
+            #       then it would likely get altered in the divmod
+            #       calculation.
+            a, b = divmod(int(self.um_version), 100)
+            fraction = str(self.um_version).split(".")[-1]
+            um = f"{a}.{b}"
+            if fraction != "0" and fraction != str(self.um_version):
+                um += f".{fraction}"
+
+            cf_properties["um_version"] = um
+
             # --------------------------------------------------------
             # Set the data and extra data
             # --------------------------------------------------------

cf/test/test_Data.py

@@ -2389,7 +2389,9 @@ def test_Data_BINARY_AND_UNARY_OPERATORS(self):
                 except Exception:
                     pass
                 else:
-                    self.assertTrue((x**d).all(), "{}**{}".format(x, repr(d)))
+                    self.assertTrue(
+                        (x**d).all(), "{}**{}".format(x, repr(d))
+                    )
 
                 self.assertTrue(
                     d.__truediv__(x).equals(

cf/test/test_functions.py

@@ -17,8 +17,12 @@ class functionTest(unittest.TestCase):
     def setUp(self):
         self.test_only = ()
 
-    def test_example_field(self):
-        for f in cf.example_fields():
+    def test_example_field_example_fields(self):
+        e = cf.example_fields()
+        self.assertIsInstance(e, cf.FieldList)
+
+        for f in e:
+            self.assertIsInstance(f, cf.Field)
             f.dump(display=False)
 
         with self.assertRaises(ValueError):
@@ -385,7 +389,24 @@ def test_normalize_slice(self):
             cf.normalize_slice(slice(2, 5, -2), 8, cyclic=True),
             slice(2, -3, -2),
         )
-
+        
+        self.assertEqual(
+            cf.normalize_slice(slice(-8, 0, 1), 8, cyclic=True),
+            slice(-8, 0, 1)
+            )
+        self.assertEqual(
+            cf.normalize_slice(slice(0, 7, -1), 8, cyclic=True),
+            slice(0, -1, -1)
+            )        
+        self.assertEqual(
+            cf.normalize_slice(slice(-1, -8, 1), 8, cyclic=True),
+            slice(-1, 0, 1)
+            )
+        self.assertEqual(
+            cf.normalize_slice(slice(-8, -1, -1), 8, cyclic=True),
+            slice(0, -1, -1)
+            )        
+        
         with self.assertRaises(IndexError):
             cf.normalize_slice([1, 2], 8)
 

cf/test/test_pp.py

@@ -57,7 +57,7 @@ def test_PP_read_um(self):
         g = cf.read(self.ppextradata, um={"fmt": "pp"})[0]
         self.assertTrue(f.equals(g))
 
-        for vn in (4.5, 405, "4.5", None):
+        for vn in (4.5, 405, "4.5"):
             g = cf.read(self.ppextradata, um={"fmt": "pp", "version": vn})[0]
             self.assertTrue(f.equals(g))
 
@@ -138,6 +138,13 @@ def test_PP_extra_data(self):
         self.assertTrue(f.dimension_coordinate("time", default=False))
         self.assertTrue(f.auxiliary_coordinate("longitude", default=False))
 
+    def test_PP_um_version(self):
+        f = cf.read(self.ppfile)[0]
+        self.assertEqual(f.get_property("um_version"), "11.0")
+
+        f = cf.read(self.ppfile, um={"version": "6.6.3"})[0]
+        self.assertEqual(f.get_property("um_version"), "6.6.3")
+
 
 if __name__ == "__main__":
     print("Run date:", datetime.datetime.now())

cf/weights.py

@@ -1461,9 +1461,9 @@ def linear(
         else:
             # Bounds exist
             if methods:
-                weights[(da_key,)] = (
-                    f"linear {f.constructs.domain_axis_identity(da_key)}"
-                )
+                weights[
+                    (da_key,)
+                ] = f"linear {f.constructs.domain_axis_identity(da_key)}"
             else:
                 weights[(da_key,)] = dim.cellsize
 

docs/source/contributing.rst

@@ -126,3 +126,4 @@ ideas, code, and documentation to the cf library:
 * Sadie Bartholomew
 * Thibault Hallouin
 * Tim Bradshaw
+* Matt Brown