Merge pull request #315 from clamsproject/312-missing-isoformat-convert

fixed some missing conversion in tuh.convert implementation

Author: keighrim

mmif/utils/timeunit_helper.py

@@ -67,18 +67,29 @@ def convert(t: Union[int, float, str], in_unit: str, out_unit: str, fps: float)
         return t
     elif out_unit == 'frame':
         # ms>f
-        if 'millisecond' == in_unit:
+        if in_unit == 'millisecond':
             return round(t / 1000 * fps)
         # s>f
         elif 'second' == in_unit:
             return round(t * fps)
+        # i>f
+        else:
+            return round(_isoformat_to_millisecond(t) / 1000 * fps)
     # s>(ms or i)
     elif in_unit == 'second':
         return round(t * 1000) if out_unit == 'millisecond' else _second_to_isoformat(t)
     # ms>(s or i)
     elif in_unit == 'millisecond':
         return t / 1000 if out_unit == 'second' else _millisecond_to_isoformat(t)
-    # f>ms, f>s
+    # f>
     else:
-        return (t / fps) if out_unit == 'second' else round(round(t / fps, 3) * 1000)  # pytype: disable=bad-return-type
+        # f>s
+        if out_unit == 'second':
+            return t / fps
+        # f>ms
+        elif out_unit == 'millisecond': 
+            return round(round(t / fps, 3) * 1000)
+        # f>i
+        else:
+            return _second_to_isoformat(t / fps)
 

requirements.txt

@@ -1,2 +1,3 @@
 deepdiff>5
+orderly-set==5.3.*  # 5.4 drops py38 support
 jsonschema

tests/test_serialize.py

@@ -20,7 +20,9 @@
 
 # Flags for skipping tests
 DEBUG = False
-SKIP_SCHEMA = False, "Not skipping TestSchema by default"
+SKIP_SCHEMA = True, "Not skipping TestSchema by default"
+# skipping jsonschema testing until vocab-type level validation is fully implemented 
+# (https://github.com/clamsproject/mmif-python/issues/309)
 not_existing_attype = 'http://not.existing/type'
 tester_appname = 'http://not.existing/app'
 

tests/test_utils.py

@@ -9,17 +9,29 @@
 from mmif.utils import timeunit_helper as tuh
 from mmif.utils import video_document_helper as vdh
 from tests.mmif_examples import *
+from hypothesis import given, strategies as st
 
 
 class TestTimeunitHelper(unittest.TestCase):
-    FPS = 30
-
-    def test_convert(self):
-        self.assertEqual(1000, tuh.convert(1, 's', 'ms', self.FPS))
-        self.assertEqual(1.1, tuh.convert(1100, 'ms', 's', self.FPS))
-        self.assertEqual('00:01:30.000', tuh.convert(90, 's', 'i', self.FPS))
-        self.assertEqual(3300, tuh.convert('00:00:03.300', 'i', 'ms', self.FPS))
-        self.assertEqual(7.77, tuh.convert('00:00:07.770', 'i', 's', self.FPS))
+    FPS = 100  # 1 frame == 10 ms
+
+    @given(st.integers(min_value=300, max_value=10000))
+    def test_convert(self, value):
+        # using hypothesis library, test time unit conversions 
+        # four-way between second, millisecond, framenum, and isoformat 
+        for tu1 in ['s', 'm', 'f', 'i']:
+            for tu2 in ['s', 'm', 'f', 'i']:
+                if tu1 == tu2:
+                    continue
+                # since the input (generated by hypothesis) is always integer/millisecond
+                # I'm going to dual round-trip conversion
+                # ms > tu1 > tu2 > tu1 > ms 
+                # then see the ends are equal (enough)
+                in_t = tuh.convert(value, 'm', tu1, self.FPS)
+                converted = tuh.convert(in_t, tu1, tu2, self.FPS)
+                converted_back = tuh.convert(converted, tu2, tu1, self.FPS)
+                out_t = tuh.convert(converted_back, tu1, 'm', self.FPS)
+                self.assertAlmostEqual(value, out_t, delta=1000/self.FPS)  # up to 1 frame error
 
 
 class TestVideoDocumentHelper(unittest.TestCase):