Merge pull request #94 from bbc/philipn-fix-contains-and-float

Fix TimeRange `__contains__` and add Timestamp `__float__`

Author: philipnbbc

mediatimestamp/immutable/timerange.py

@@ -371,16 +371,13 @@ def finite(self) -> bool:
         return (self.start is not None and self.end is not None)
 
     def __contains__(self, ts: object) -> bool:
-        """Returns true if the timestamp is within this range."""
-        return ((isinstance(ts, SupportsMediaTimestamp)) and
-                (self.start is None or mediatimestamp(ts) >= self.start) and
-                (self.end is None or mediatimestamp(ts) <= self.end) and
-                (not ((self.start is not None) and
-                      (mediatimestamp(ts) == self.start) and
-                      (self.inclusivity & TimeRange.INCLUDE_START == 0))) and
-                (not ((self.end is not None) and
-                      (mediatimestamp(ts) == self.end) and
-                      (self.inclusivity & TimeRange.INCLUDE_END == 0))))
+        """Returns true if the timestamp or timerange is wholly within this range."""
+        return ((
+                    isinstance(ts, (Timestamp, SupportsMediaTimestamp, int, float)) and
+                    self.contains_subrange(mediatimestamp(ts))
+                ) or (
+                    isinstance(ts, (TimeRange, SupportsMediaTimeRange)) and
+                    self.contains_subrange(ts)))
 
     def __eq__(self, other: object) -> bool:
         if not isinstance(other, SupportsMediaTimeRange):

mediatimestamp/immutable/timestamp.py

@@ -429,7 +429,7 @@ def to_tai_sec_frac(self, fixed_size: bool = False) -> str:
     def to_float(self) -> float:
         """ Convert to a floating point number of seconds
         """
-        return self._value / Timestamp.MAX_NANOSEC
+        return self.__float__()
 
     def to_datetime(self) -> datetime:
         sec, nsec, sign, leap = self.to_unix()
@@ -665,6 +665,9 @@ def __floordiv__(self, anint: int) -> "Timestamp":
         ns = self._value // anint
         return Timestamp(ns=ns)
 
+    def __float__(self):
+        return self._value / Timestamp.MAX_NANOSEC
+
     def _get_fractional_seconds(self, fixed_size: bool = False) -> str:
         div = self.MAX_NANOSEC // 10
         rem = self.ns

tests/test_timerange.py

@@ -353,6 +353,35 @@ def test_subrange__negative(self):
 
         self._check_subrange(a, b, c, d)
 
+    def test_subrange__eternity_never(self):
+        self.assertTrue(TimeRange.eternity().contains_subrange(TimeRange.eternity()))
+        self.assertTrue(TimeRange.eternity().contains_subrange(TimeRange.from_str("[0:0]")))
+        self.assertTrue(TimeRange.eternity().contains_subrange(TimeRange.from_str("[0:0_1:0)")))
+
+        self.assertTrue(TimeRange.eternity().contains_subrange(TimeRange.never()))
+
+        self.assertFalse(TimeRange.never().contains_subrange(TimeRange.eternity()))
+        self.assertFalse(TimeRange.never().contains_subrange(TimeRange.never()))
+        self.assertFalse(TimeRange.never().contains_subrange(TimeRange.from_str("[0:0]")))
+        self.assertFalse(TimeRange.never().contains_subrange(TimeRange.from_str("[0:0_1:0)")))
+
+    def test_contains(self):
+        self.assertNotIn(None, TimeRange.from_str("[0:0]"))
+        self.assertNotIn(None, TimeRange.never())
+        self.assertNotIn(None, TimeRange.eternity())
+
+        self.assertNotIn(1.0, TimeRange.from_str("[0:0]"))
+        self.assertIn(1.0, TimeRange.from_str("[1:0]"))
+        self.assertIn(1.0, TimeRange.from_str("[0:0_10:0)"))
+
+        self.assertNotIn(Timestamp.from_str("0:0"), TimeRange.from_str("[1:0_10:0)"))
+        self.assertIn(Timestamp.from_str("1:0"), TimeRange.from_str("[1:0_10:0)"))
+
+        self.assertNotIn(TimeRange.from_str("[0:0_10:0)"), TimeRange.from_str("[0:0_5:0)"))
+        self.assertIn(TimeRange.from_str("0:0_5:0"), TimeRange.from_str("[0:0_10:0)"))
+
+        # The subrange tests will cover the rest
+
     def _check_intersection(self, a, b, c, d):
         self.assertEqual(TimeRange(a, c, TimeRange.INCLUDE_START).intersect_with(b), mediatimerange(b))
 
@@ -460,6 +489,11 @@ def test_length_negative(self):
 
         self._check_length(a, b, c)
 
+    def test_length_float(self):
+        self.assertEqual(TimeRange.eternity().length, float("inf"))
+        self.assertEqual(float(TimeRange.eternity().length), float("inf"))
+        self.assertEqual(float(TimeRange.from_str("[0:0_1:0)").length), 1.0)
+
     def test_repr(self):
         """This tests that the repr function turns time ranges into `eval`-able strings."""
         test_trs = [