update code to use Sofa.convention_status

Author: f-brinkmann

sofar/sofa.py

@@ -807,26 +807,17 @@ def upgrade_convention(self, target=None, verify='auto'):
 
         # check input ---------------------------------------------------------
         self._reset_convention()
+        status = self.convention_status
 
         # get deprecations and information about Sofa object
-        _, _, deprecations, upgrade = self._verification_rules()
+        _, _, _, upgrade = self._verification_rules()
         convention_current = self.GLOBAL_SOFAConventions
         version_current = self.GLOBAL_SOFAConventionsVersion
         sofa_version_current = self.GLOBAL_Version
 
-        # check if convention is deprecated -----------------------------------
-        is_deprecated = False
-
-        if convention_current in deprecations["GLOBAL:SOFAConventions"]:
-            is_deprecated = True
-        elif convention_current in upgrade:
-            for from_to in upgrade[convention_current]["from_to"]:
-                if version_current in from_to[0]:
-                    is_deprecated = True
-                    break
-
         # check for upgrades --------------------------------------------------
-        if is_deprecated:
+        if status == 'deprecated':
+
             # check if upgrade is available for this convention
             if convention_current not in upgrade:
                 print((f"Convention {convention_current} v{version_current} is"
@@ -1027,6 +1018,7 @@ def verify(self, issue_handling="raise", mode="write"):
         # ---------------------------------------------------------------------
         # 0. update the convention
         self._reset_convention()
+        status = self.convention_status
 
         # ---------------------------------------------------------------------
         # 1. check if the mandatory attributes are contained
@@ -1437,21 +1429,18 @@ def verify(self, issue_handling="raise", mode="write"):
         # ---------------------------------------------------------------------
         # 8. check deprecations
         # (so far there are only deprecations for the convention)
-        if self.GLOBAL_SOFAConventions in \
-                deprecations["GLOBAL:SOFAConventions"]:
-            convention = self.GLOBAL_SOFAConventions
+        if status == 'deprecated':
             msg = ("Detected deprecations:\n"
                    f"- GLOBAL_SOFAConventions is "
-                   f"{self.GLOBAL_SOFAConventions}, which is deprecated. Use "
-                   "Sofa.upgrade_convention() to upgrade to "
-                   f"{deprecations['GLOBAL:SOFAConventions'][convention]}")
+                   f"{self.GLOBAL_SOFAConventions}, which is deprecated. See "
+                   "Sofa.upgrade_convention() for upgrade possibilities.")
             if mode == "write":
                 error_msg += msg
             else:
                 warning_msg += msg
 
         # warn if preliminary conventions versions are used
-        if float(self.GLOBAL_SOFAConventionsVersion) < 1.0:
+        if status == 'preliminary':
             warning_msg += (
                 "\n\nDetected preliminary conventions version "
                 f"{self.GLOBAL_SOFAConventionsVersion}:\n - Upgrade data to "

tests/test_io.py

@@ -12,7 +12,6 @@
 import numpy as np
 import numpy.testing as npt
 from netCDF4 import Dataset
-from packaging.version import parse
 
 
 def test_read_write_sofa():
@@ -166,18 +165,21 @@ def test_roundtrip(mandatory):
     for name, version in names_versions:
         print(f"Testing: {name} {version}")
 
-        # writing deprecated and proposed conventions is not tested
-        if name in deprecations["GLOBAL:SOFAConventions"] or \
-                parse(version) < parse('1.0'):
-            sofa = sf.Sofa(name, mandatory, version, verify=False)
-            # non stable conventions are not verified
-            if parse(version) >= parse('1.0'):
-                with pytest.warns(UserWarning, match="deprecations"):
-                    sofa.verify(mode="read")
-        else:
+        # create Sofa object without verification. Verification will be done
+        # when writing below.
+        sofa = sf.Sofa(name, mandatory, version, verify=False)
+        status = sofa.convention_status
+
+        if status == 'preliminary':
+            # don't test anything for preliminary conventions
+            return
+        elif status == 'deprecated':
+            # don't test writing deprecated conventions
+            with pytest.warns(UserWarning, match="deprecations"):
+                sofa.verify(mode="read")
+        elif status == 'current':
             # test full round-trip for other conventions
             file = os.path.join(temp_dir.name, name + ".sofa")
-            sofa = sf.Sofa(name, mandatory, version)
             sf.write_sofa(file, sofa)
             sofa_r = sf.read_sofa(file)
             identical = sf.equals(sofa, sofa_r, verbose=True, exclude="DATE")