opendate 0.1.13__py3-none-any.whl → 0.1.20__py3-none-any.whl

date/extras.py

@@ -1,6 +1,15 @@
-from collections import namedtuple
+"""Legacy compatibility functions for OpenDate.
 
-from date import NYSE, DateTime, Entity
+This module contains functions that exist primarily for backward compatibility
+with older codebases. These functions provide alternative interfaces to
+functionality that may be available through other means in the core Date,
+DateTime, and Interval classes.
+
+New code should prefer using the built-in methods on Date, DateTime, and
+Interval objects where applicable.
+"""
+
+from date import NYSE, Date, DateTime, Entity, Interval
 
 __all__ = [
     'is_within_business_hours',
@@ -10,27 +19,7 @@ __all__ = [
 
 
 def is_within_business_hours(entity: Entity = NYSE) -> bool:
-    """Return whether the current native datetime is between
-    open and close of business hours.
-
-    >>> from unittest.mock import patch
-    >>> tz = NYSE.tz
-
-    >>> with patch('date.DateTime.now') as mock:
-    ...     mock.return_value = DateTime(2000, 5, 1, 12, 30, 0, 0, tzinfo=tz)
-    ...     is_within_business_hours()
-    True
-
-    >>> with patch('date.DateTime.now') as mock:
-    ...     mock.return_value = DateTime(2000, 7, 2, 12, 15, 0, 0, tzinfo=tz) # Sunday
-    ...     is_within_business_hours()
-    False
-
-    >>> with patch('date.DateTime.now') as mock:
-    ...     mock.return_value = DateTime(2000, 11, 1, 1, 15, 0, 0, tzinfo=tz)
-    ...     is_within_business_hours()
-    False
-
+    """Return whether the current native datetime is between open and close of business hours.
     """
     this = DateTime.now()
     this_entity = DateTime.now(tz=entity.tz).entity(entity)
@@ -44,47 +33,26 @@ def is_business_day(entity: Entity = NYSE) -> bool:
     return DateTime.now(tz=entity.tz).entity(entity).is_business_day()
 
 
-Range = namedtuple('Range', ['start', 'end'])
-
+def overlap_days(
+    interval_one: Interval | tuple[Date | DateTime, Date | DateTime],
+    interval_two: Interval | tuple[Date | DateTime, Date | DateTime],
+    days: bool = False,
+) -> bool | int:
+    """Calculate how much two date intervals overlap.
 
-def overlap_days(range_one, range_two, days=False):
-    """Test by how much two date ranges overlap
-    if `days=True`, we return an actual day count,
-    otherwise we just return if it overlaps True/False
-    poached from Raymond Hettinger http://stackoverflow.com/a/9044111
+    When days=False, returns True/False indicating whether intervals overlap.
+    When days=True, returns the actual day count (negative if non-overlapping).
 
-    >>> from date import Date
-    >>> date1 = Date(2016, 3, 1)
-    >>> date2 = Date(2016, 3, 2)
-    >>> date3 = Date(2016, 3, 29)
-    >>> date4 = Date(2016, 3, 30)
-
-    >>> assert overlap_days((date1, date3), (date2, date4))
-    >>> assert overlap_days((date2, date4), (date1, date3))
-    >>> assert not overlap_days((date1, date2), (date3, date4))
-
-    >>> assert overlap_days((date1, date4), (date1, date4))
-    >>> assert overlap_days((date1, date4), (date2, date3))
-    >>> overlap_days((date1, date4), (date1, date4), True)
-    30
-
-    >>> assert overlap_days((date2, date3), (date1, date4))
-    >>> overlap_days((date2, date3), (date1, date4), True)
-    28
-
-    >>> assert not overlap_days((date3, date4), (date1, date2))
-    >>> overlap_days((date3, date4), (date1, date2), True)
-    -26
+    Algorithm adapted from Raymond Hettinger: http://stackoverflow.com/a/9044111
     """
-    r1 = Range(*range_one)
-    r2 = Range(*range_two)
-    latest_start = max(r1.start, r2.start)
-    earliest_end = min(r1.end, r2.end)
+    if not isinstance(interval_one, Interval):
+        interval_one = Interval(*interval_one)
+    if not isinstance(interval_two, Interval):
+        interval_two = Interval(*interval_two)
+
+    latest_start = max(interval_one._start, interval_two._start)
+    earliest_end = min(interval_one._end, interval_two._end)
     overlap = (earliest_end - latest_start).days + 1
     if days:
         return overlap
     return overlap >= 0
-
-
-if __name__ == '__main__':
-    __import__('doctest').testmod(optionflags=4 | 8 | 32)