umfive 0.2.2__tar.gz → 0.3.0__tar.gz

{umfive-0.2.2/umfive.egg-info → umfive-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: umfive
-Version: 0.2.2
+Version: 0.3.0
 Summary: PP/Fields reader with pyfive-style high-level API
 Author: David Hassell, Alan Iwi, Bryan Lawrence, Valeriu Predoi - package
 License: MIT

{umfive-0.2.2 → umfive-0.3.0}/pyproject.toml

@@ -8,7 +8,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "umfive"
-version = "0.2.2"
+version = "0.3.0"
 description = "PP/Fields reader with pyfive-style high-level API"
 license = {text = "MIT"}
 readme = "README.md"

{umfive-0.2.2 → umfive-0.3.0}/tests/data/cl_umfile_dump.txt

@@ -1,6 +1,6 @@
 <umfive.File: tests/data/cl_umfile, 49 data variables, 37 metadata variables>
     Attributes:
-        Conventions: 'CF-1.14'
+        Conventions: 'CF-1.13'
     Data variables:
         <umfive.DataVariable: UM_m01s00i001_vn405, shape=(12, 37, 48), dimensions=(time, latitude, longitude)>
             Attributes:

{umfive-0.2.2 → umfive-0.3.0}/tests/data/extra_data_dump.txt

@@ -1,6 +1,6 @@
 <umfive.File: tests/data/extra_data.pp, 1 data variable, 10 metadata variables>
     Attributes:
-        Conventions: 'CF-1.14'
+        Conventions: 'CF-1.13'
     Data variables:
         <umfive.DataVariable: UM_m01s03i236_vn405, shape=(1, 1, 100, 3), dimensions=(dimension1, height, time, site)>
             Attributes:
@@ -228,6 +228,7 @@
         <umfive.Variable: region, shape=(3,), dimensions=(site)>
             Attributes:
                 DIMENSION_LIST: (('site',),)
+                standard_name: 'region'
             Data str608:
                 ['Northern Hemisphere', 'Southern Hemisphere',
                  'Global']

{umfive-0.2.2 → umfive-0.3.0}/tests/data/test2_dump.txt

@@ -1,6 +1,6 @@
 <umfive.File: tests/data/test2.pp, 1 data variable, 9 metadata variables>
     Attributes:
-        Conventions: 'CF-1.14'
+        Conventions: 'CF-1.13'
     Data variables:
         <umfive.DataVariable: UM_m01s15i201_vn405, shape=(3, 5, 110, 106), dimensions=(time, air_pressure, grid_latitude, grid_longitude)>
             Attributes:

{umfive-0.2.2 → umfive-0.3.0}/tests/data/umfile_dump.txt

@@ -1,6 +1,6 @@
 <umfive.File: tests/data/umfile.pp, 1 data variable, 7 metadata variables>
     Attributes:
-        Conventions: 'CF-1.14'
+        Conventions: 'CF-1.13'
     Data variables:
         <umfive.DataVariable: UM_m01s00i001_vn405, shape=(3, 73, 96), dimensions=(time, latitude, longitude)>
             Attributes:

{umfive-0.2.2 → umfive-0.3.0}/tests/data/wgdos_packed_dump.txt

@@ -1,6 +1,6 @@
 <umfive.File: tests/data/wgdos_packed.pp, 1 data variable, 7 metadata variables>
     Attributes:
-        Conventions: 'CF-1.14'
+        Conventions: 'CF-1.13'
     Data variables:
         <umfive.DataVariable: UM_m01s30i201_vn1100, shape=(1, 1, 145, 192), dimensions=(time, air_pressure, latitude, longitude)>
             Attributes:

{umfive-0.2.2 → umfive-0.3.0}/tests/tests_core/test_pyfive_interoperability.py

@@ -10,7 +10,7 @@ def test_pyfive_resistration():
         assert isinstance(f, pyfive.File)
 
         for var in f.values():
-            assert isinstance(var, pyfive.Dataset)
+            isinstance(var, pyfive.Dataset)
 
 
 def test_umfive_file_exposes_pyfive_root_members():

{umfive-0.2.2 → umfive-0.3.0}/tests/tests_io/test_file.py

@@ -17,6 +17,7 @@ import umfive
     ],
 )
 def test_file(dataset, suffix):
+    """Test umfive.File with various input files."""
     # Build the file paths dynamically based on parameters
     input_file = f"tests/data/{dataset}{suffix}"
     dump_file = f"tests/data/{dataset}_dump.txt"
@@ -31,6 +32,7 @@ def test_file(dataset, suffix):
 
 
 def test_File_with_builtin_open_as_input():
+    """Test umfive.File with open file handle 'filename' argument."""
     with open("tests/data/test2.pp", "rb") as fh:
         f = umfive.File(fh)
         assert (
@@ -40,6 +42,7 @@ def test_File_with_builtin_open_as_input():
 
 
 def test_File_with_bytesio_as_input():
+    """Test umfive.File with BytesIO 'filename' argument."""
     path = Path("tests/data/test2.pp")
     raw = BytesIO(path.read_bytes())
     f = umfive.File(raw)
@@ -54,10 +57,12 @@ def test_File_with_bytesio_as_input():
     [[], {}, (), None, 0, 3.14, True],
 )
 def test_File_with_invalid_input(filename):
+    """Test umfive.File with bad 'filename' type."""
     with pytest.raises(ValueError):
         umfive.File(filename)
 
 
 def test_File_with_directory_input():
+    """Test umfive.File with 'filename' pointing to a directory."""
     with pytest.raises(IsADirectoryError):
         umfive.File("tests/data")

{umfive-0.2.2 → umfive-0.3.0}/umfive/__init__.py

@@ -2,3 +2,5 @@ from .high_level import File
 from .variable import DataVariable, DimensionScale, Variable
 from .stash import load_stash_table, stash_records, stash_table
 from .io import ByteReader, FileObjReader, LocalPosixReader
+
+__version__ = "0.3.0"

{umfive-0.2.2 → umfive-0.3.0}/umfive/constants.py

@@ -1,7 +1,7 @@
 from sys import float_info
 
 # The value of the CF "Conventions" attribute.
-CF_CONVENTIONS = "CF-1.14"
+CF_CONVENTIONS = "CF-1.13"
 
 # Sizes (in words) of the lookup header
 N_INT_HDR = 45

{umfive-0.2.2 → umfive-0.3.0}/umfive/core/variables.py

@@ -47,7 +47,6 @@ from .data import (
     read_record_array,
 )
 from .interpret import get_type
-from .models import RecordInfo
 
 
 def _float_key(val):

{umfive-0.2.2 → umfive-0.3.0}/umfive/high_level.py

@@ -2465,6 +2465,7 @@ class DataVariableMetadata:
                 ac = Variable(
                     name="region",
                     data=array,
+                    attrs={"standard_name": "region"},
                     DIMENSION_LIST=((self._axis[axis],),),
                 )
                 aux_ncvar = self.add_to_variables(ac)
@@ -2923,7 +2924,7 @@ class DataVariableMetadata:
 # Let external callers treat File as pyfive-like File
 try:
     import pyfive
+
+    pyfive.File.register(File)
 except Exception:  # pragma: no cover
     pass
-else:
-    pyfive.File.register(File)

{umfive-0.2.2 → umfive-0.3.0}/umfive/stash.py

@@ -99,7 +99,7 @@ def _parse_cf_extra(value):
     return out
 
 
-def load_stash_table(table=None, delimiter="!", merge=True):
+def load_stash_table(table=None, delimiter="!", merge=True, reset=False):
     """Load a STASH to standard name conversion table from a file.
 
     This used when reading PP and UM fields files.
@@ -132,12 +132,10 @@ def load_stash_table(table=None, delimiter="!", merge=True):
 
     :Parameters:
 
-        table: `str`, optional
-            Use the conversion table at this file location. By default
-            the table in ``data/STASH_to_CF.txt`` will be used.
-
-            Setting *table* to `None` will reset the table, removing
-            any modifications that have previously been made.
+        table: `str` or `None`, optional
+            Use the conversion table at this file location. If `None`
+            (the default) the table in ``data/STASH_to_CF.txt`` will be
+            used.
 
         delimiter: `str`, optional
             The delimiter of the table columns. By default, ``!`` is
@@ -150,8 +148,9 @@ def load_stash_table(table=None, delimiter="!", merge=True):
             into the existing table, overwriting any entries which
             already exist.
 
-            If *table* is `None` then *merge* is taken as False,
-            regardless of its given value.
+        reset: `bool`, optional
+            If True then clear all entries and re-load the default
+            table.
 
     :Returns:
 
@@ -166,60 +165,71 @@ def load_stash_table(table=None, delimiter="!", merge=True):
     >>> load_stash_table('my_table4.txt', merge=False)
 
     """
+    if reset:
+        table = None
+        merge = False
+        _stash_table.clear()
+
     if table is None:
         # Use the default STASH table
         if _default_stash_table:
-            # The default STASH table has already been loaded
-            return
+            # Use the existing default tables
+            read_table = False
+            store_default = False
+        else:
+            read_table = True
+            store_default = True
 
-        default = True
-        merge = False
         table_path = files(__package__).joinpath("data/STASH_to_CF.txt")
     else:
         # User supplied table
-        default = False
+        read_table = True
+        store_default = False
         table_path = PosixPath(table)
 
     stash2sn = {}
-
-    with table_path.open("r", encoding="utf-8") as handle:
-        rows = list(
-            csv.reader(handle, delimiter=delimiter, skipinitialspace=True)
-        )
-
-    for row in rows:
-        if not row or row[0].startswith("#"):
-            continue
-
-        # Normalize to expected width.
-        if len(row) < 9:
-            row = row + [""] * (9 - len(row))
-
-        key = (int(row[_MODEL]), int(row[_STASH]))
-        name = row[_NAME]
-        units = row[_UNITS] or None
-        valid_from = _parse_version(row[_VALID_FROM])
-        valid_to = _parse_version(row[_VALID_TO])
-        standard_name = row[_STANDARD_NAME] or None
-        cf_info = _parse_cf_extra(row[_CF_EXTRA])
-        pp_extra = row[_PP_EXTRA].rstrip()
-
-        entry = (
-            name,
-            units,
-            valid_from,
-            valid_to,
-            standard_name,
-            cf_info,
-            pp_extra,
-        )
-
-        if key in stash2sn:
-            stash2sn[key] += (entry,)
-        else:
-            stash2sn[key] = (entry,)
-
-    if default:
+    if read_table:
+        with table_path.open("r", encoding="utf-8") as handle:
+            rows = list(
+                csv.reader(handle, delimiter=delimiter, skipinitialspace=True)
+            )
+
+        for row in rows:
+            if not row or row[0].startswith("#"):
+                continue
+
+            # Normalize to expected width.
+            if len(row) < 9:
+                row = row + [""] * (9 - len(row))
+
+            key = (int(row[_MODEL]), int(row[_STASH]))
+            name = row[_NAME]
+            units = row[_UNITS] or None
+            valid_from = _parse_version(row[_VALID_FROM])
+            valid_to = _parse_version(row[_VALID_TO])
+            standard_name = row[_STANDARD_NAME] or None
+            cf_info = _parse_cf_extra(row[_CF_EXTRA])
+            pp_extra = row[_PP_EXTRA].rstrip()
+
+            entry = (
+                name,
+                units,
+                valid_from,
+                valid_to,
+                standard_name,
+                cf_info,
+                pp_extra,
+            )
+
+            if key in stash2sn:
+                stash2sn[key] += (entry,)
+            else:
+                stash2sn[key] = (entry,)
+
+    if reset:
+        stash2sn = _default_stash_table
+
+    if store_default:
         # Store the default STASH table
         _default_stash_table.update(stash2sn)
 
@@ -229,19 +239,26 @@ def load_stash_table(table=None, delimiter="!", merge=True):
     _stash_table.update(stash2sn)
 
 
-def stash_table():
+def stash_table(reset=False):
     """Return a copy of the current STASH table.
 
     .. seealso:: `load_stash_table`, `stash_record`
 
+    :Parameters:
+
+        reset: `bool`, optional
+            If True then clear all entries, re-load the default
+            table, and return it.
+
     :Returns:
 
         `dict`
             The currently loaded STASH table.
 
     """
-    if not _stash_table:
-        load_stash_table()
+
+    if reset or not _default_stash_table:
+        load_stash_table(reset=reset)
 
     return _stash_table.copy()
 

{umfive-0.2.2 → umfive-0.3.0}/umfive/variable.py

@@ -1211,9 +1211,9 @@ class DataVariable(_Mixin):
 # Let external callers treat variable classes as pyfive-like Datasets
 try:
     import pyfive
-except Exception:  # pragma: no cover
-    pass
-else:
+
     pyfive.Dataset.register(DataVariable)
     pyfive.Dataset.register(DimensionScale)
     pyfive.Dataset.register(Variable)
+except Exception:  # pragma: no cover
+    pass

{umfive-0.2.2 → umfive-0.3.0/umfive.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: umfive
-Version: 0.2.2
+Version: 0.3.0
 Summary: PP/Fields reader with pyfive-style high-level API
 Author: David Hassell, Alan Iwi, Bryan Lawrence, Valeriu Predoi - package
 License: MIT