opendate 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

date/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '0.1.1'
+__version__ = '0.1.3'
 
 import datetime as _datetime
 
@@ -31,7 +31,9 @@ from date.date import expect_utc_timezone
 from date.date import prefer_native_timezone
 from date.date import prefer_utc_timezone
 from date.date import Timezone
-from date.business import *
+from date.extras import overlap_days
+from date.extras import is_business_day
+from date.extras import is_within_business_hours
 
 
 timezone = Timezone
@@ -57,8 +59,7 @@ def parse():
 
 
 def instance(obj: _datetime.date | _datetime.datetime | _datetime.time) -> DateTime | Date | Time:
-    """
-    Create a DateTime/Date/Time instance from a datetime/date/time native one.
+    """Create a DateTime/Date/Time instance from a datetime/date/time native one.
     """
     if isinstance(obj, DateTime | Date | Time):
         return obj
@@ -104,6 +105,8 @@ __all__ = [
     'NYSE',
     'date',
     'datetime',
-    'time'
-    'within_business_hours'
+    'time',
+    'overlap_days',
+    'is_within_business_hours',
+    'is_business_day',
     ]

date/date.py

@@ -8,9 +8,7 @@ import time
 import warnings
 import zoneinfo as _zoneinfo
 from abc import ABC, abstractmethod
-from collections import namedtuple
 from collections.abc import Callable, Sequence
-from enum import IntEnum
 from functools import lru_cache, partial, wraps
 from typing import Self
 
@@ -31,8 +29,6 @@ __all__ = [
     'IntervalError',
     'Time',
     'Timezone',
-    'WeekDay',
-    'WEEKDAY_SHORTNAME',
     'EST',
     'UTC',
     'GMT',
@@ -45,6 +41,7 @@ __all__ = [
     'expect_datetime',
     'Entity',
     'NYSE'
+    'WEEKDAY_SHORTNAME',
     ]
 
 
@@ -59,16 +56,7 @@ GMT = Timezone('GMT')
 EST = Timezone('US/Eastern')
 LCL = _pendulum.tz.Timezone(_pendulum.tz.get_local_timezone().name)
 
-
-class WeekDay(IntEnum):
-    MONDAY = 0
-    TUESDAY = 1
-    WEDNESDAY = 2
-    THURSDAY = 3
-    FRIDAY = 4
-    SATURDAY = 5
-    SUNDAY = 6
-
+WeekDay = _pendulum.day.WeekDay
 
 WEEKDAY_SHORTNAME = {
     'MO': WeekDay.MONDAY,
@@ -281,7 +269,7 @@ class NYSE(Entity):
                 if begdate <= d <= enddate}
 
 
-class PendulumBusinessDateMixin:
+class DateBusinessMixin:
 
     _entity: type[NYSE] = NYSE
     _business: bool = False
@@ -509,7 +497,141 @@ class PendulumBusinessDateMixin:
         return self
 
 
-class Date(PendulumBusinessDateMixin, _pendulum.Date):
+class DateExtrasMixin:
+    """Legacy support functionality well outside the
+    scope of Pendulum. Ideally these should be removed.
+
+    See how pendulum does end_of and next_ with getattr
+
+    Create a nearest [start_of, end_of] [week, day, month, quarter, year]
+
+    combo that accounts for whatever prefix and unit is passed in
+    """
+
+    def nearest_start_of_month(self):
+        """Get `nearest` start of month
+
+        1/1/2015 -> Thursday (New Year's Day)
+        2/1/2015 -> Sunday
+
+        >>> from date import Date
+        >>> Date(2015, 1, 1).nearest_start_of_month()
+        Date(2015, 1, 1)
+        >>> Date(2015, 1, 15).nearest_start_of_month()
+        Date(2015, 1, 1)
+        >>> Date(2015, 1, 15).b.nearest_start_of_month()
+        Date(2015, 1, 2)
+        >>> Date(2015, 1, 16).nearest_start_of_month()
+        Date(2015, 2, 1)
+        >>> Date(2015, 1, 31).nearest_start_of_month()
+        Date(2015, 2, 1)
+        >>> Date(2015, 1, 31).b.nearest_start_of_month()
+        Date(2015, 2, 2)
+        """
+        _business = self._business
+        self._business = False
+        if self.day > 15:
+            d = self.end_of('month')
+            if _business:
+                return d.business().add(days=1)
+            return d.add(days=1)
+        d = self.start_of('month')
+        if _business:
+            return d.business().add(days=1)
+        return d
+
+    def nearest_end_of_month(self):
+        """Get `nearest` end of month
+
+        12/31/2014 -> Wednesday
+        1/31/2015 -> Saturday
+
+        >>> from date import Date
+        >>> Date(2015, 1, 1).nearest_end_of_month()
+        Date(2014, 12, 31)
+        >>> Date(2015, 1, 15).nearest_end_of_month()
+        Date(2014, 12, 31)
+        >>> Date(2015, 1, 15).b.nearest_end_of_month()
+        Date(2014, 12, 31)
+        >>> Date(2015, 1, 16).nearest_end_of_month()
+        Date(2015, 1, 31)
+        >>> Date(2015, 1, 31).nearest_end_of_month()
+        Date(2015, 1, 31)
+        >>> Date(2015, 1, 31).b.nearest_end_of_month()
+        Date(2015, 1, 30)
+        """
+        _business = self._business
+        self._business = False
+        if self.day <= 15:
+            d = self.start_of('month')
+            if _business:
+                return d.business().subtract(days=1)
+            return d.subtract(days=1)
+        d = self.end_of('month')
+        if _business:
+            return d.business().subtract(days=1)
+        return d
+
+    def next_relative_date_of_week_by_day(self, day='MO'):
+        """Get next relative day of week by relativedelta code
+
+        >>> from date import Date
+        >>> Date(2020, 5, 18).next_relative_date_of_week_by_day('SU')
+        Date(2020, 5, 24)
+        >>> Date(2020, 5, 24).next_relative_date_of_week_by_day('SU')
+        Date(2020, 5, 24)
+        """
+        if self.weekday() == WEEKDAY_SHORTNAME.get(day):
+            return self
+        return self.next(WEEKDAY_SHORTNAME.get(day))
+
+    def weekday_or_previous_friday(self):
+        """Return the date if it is a weekday, else previous Friday
+
+        >>> from date import Date
+        >>> Date(2019, 10, 6).weekday_or_previous_friday() # Sunday
+        Date(2019, 10, 4)
+        >>> Date(2019, 10, 5).weekday_or_previous_friday() # Saturday
+        Date(2019, 10, 4)
+        >>> Date(2019, 10, 4).weekday_or_previous_friday() # Friday
+        Date(2019, 10, 4)
+        >>> Date(2019, 10, 3).weekday_or_previous_friday() # Thursday
+        Date(2019, 10, 3)
+        """
+        dnum = self.weekday()
+        if dnum in {WeekDay.SATURDAY, WeekDay.SUNDAY}:
+            return self.subtract(days=dnum - 4)
+        return self
+
+    """
+    create a simple nth weekday function that accounts for
+    [1,2,3,4] and weekday as options
+    or weekday, [1,2,3,4]
+
+    """
+
+    @classmethod
+    def third_wednesday(cls, year, month):
+        """Third Wednesday date of a given month/year
+
+        >>> from date import Date
+        >>> Date.third_wednesday(2022, 6)
+        Date(2022, 6, 15)
+        >>> Date.third_wednesday(2023, 3)
+        Date(2023, 3, 15)
+        >>> Date.third_wednesday(2022, 12)
+        Date(2022, 12, 21)
+        >>> Date.third_wednesday(2023, 6)
+        Date(2023, 6, 21)
+        """
+        third = cls(year, month, 15)  # lowest 3rd day
+        w = third.weekday()
+        if w != WeekDay.WEDNESDAY:
+            third = third.replace(day=(15 + (WeekDay.WEDNESDAY - w) % 7))
+        return third
+
+
+class Date(DateExtrasMixin, DateBusinessMixin, _pendulum.Date):
     """Inherits and wraps pendulum.Date
     """
 
@@ -768,105 +890,6 @@ class Date(PendulumBusinessDateMixin, _pendulum.Date):
         with contextlib.suppress(Exception):
             return self.isocalendar()[1]
 
-    """
-    See how pendulum does end_of and next_ with getattr
-
-    Create a nearest [start_of, end_of] [week, day, month, quarter, year]
-
-    combo that accounts for whatever prefix and unit is passed in
-    """
-
-    def nearest_start_of_month(self):
-        """Get `nearest` start of month
-
-        1/1/2015 -> Thursday (New Year's Day)
-        2/1/2015 -> Sunday
-
-        >>> Date(2015, 1, 1).nearest_start_of_month()
-        Date(2015, 1, 1)
-        >>> Date(2015, 1, 15).nearest_start_of_month()
-        Date(2015, 1, 1)
-        >>> Date(2015, 1, 15).b.nearest_start_of_month()
-        Date(2015, 1, 2)
-        >>> Date(2015, 1, 16).nearest_start_of_month()
-        Date(2015, 2, 1)
-        >>> Date(2015, 1, 31).nearest_start_of_month()
-        Date(2015, 2, 1)
-        >>> Date(2015, 1, 31).b.nearest_start_of_month()
-        Date(2015, 2, 2)
-        """
-        _business = self._business
-        self._business = False
-        if self.day > 15:
-            d = self.end_of('month')
-            if _business:
-                return d.business().add(days=1)
-            return d.add(days=1)
-        d = self.start_of('month')
-        if _business:
-            return d.business().add(days=1)
-        return d
-
-    def nearest_end_of_month(self):
-        """Get `nearest` end of month
-
-        12/31/2014 -> Wednesday
-        1/31/2015 -> Saturday
-
-        >>> Date(2015, 1, 1).nearest_end_of_month()
-        Date(2014, 12, 31)
-        >>> Date(2015, 1, 15).nearest_end_of_month()
-        Date(2014, 12, 31)
-        >>> Date(2015, 1, 15).b.nearest_end_of_month()
-        Date(2014, 12, 31)
-        >>> Date(2015, 1, 16).nearest_end_of_month()
-        Date(2015, 1, 31)
-        >>> Date(2015, 1, 31).nearest_end_of_month()
-        Date(2015, 1, 31)
-        >>> Date(2015, 1, 31).b.nearest_end_of_month()
-        Date(2015, 1, 30)
-        """
-        _business = self._business
-        self._business = False
-        if self.day <= 15:
-            d = self.start_of('month')
-            if _business:
-                return d.business().subtract(days=1)
-            return d.subtract(days=1)
-        d = self.end_of('month')
-        if _business:
-            return d.business().subtract(days=1)
-        return d
-
-    def next_relative_date_of_week_by_day(self, day='MO'):
-        """Get next relative day of week by relativedelta code
-
-        >>> Date(2020, 5, 18).next_relative_date_of_week_by_day('SU')
-        Date(2020, 5, 24)
-        >>> Date(2020, 5, 24).next_relative_date_of_week_by_day('SU')
-        Date(2020, 5, 24)
-        """
-        if self.weekday() == WEEKDAY_SHORTNAME.get(day):
-            return self
-        return self.next(WEEKDAY_SHORTNAME.get(day))
-
-    def weekday_or_previous_friday(self):
-        """Return the date if it is a weekday, else previous Friday
-
-        >>> Date(2019, 10, 6).weekday_or_previous_friday() # Sunday
-        Date(2019, 10, 4)
-        >>> Date(2019, 10, 5).weekday_or_previous_friday() # Saturday
-        Date(2019, 10, 4)
-        >>> Date(2019, 10, 4).weekday_or_previous_friday() # Friday
-        Date(2019, 10, 4)
-        >>> Date(2019, 10, 3).weekday_or_previous_friday() # Thursday
-        Date(2019, 10, 3)
-        """
-        dnum = self.weekday()
-        if dnum in {WeekDay.SATURDAY, WeekDay.SUNDAY}:
-            return self.subtract(days=dnum - 4)
-        return self
-
     def lookback(self, unit='last') -> Self:
         """Date back based on lookback string, ie last, week, month.
 
@@ -897,32 +920,6 @@ class Date(PendulumBusinessDateMixin, _pendulum.Date):
             'year': _lookback(years=1),
             }.get(unit)
 
-    """
-    create a simple nth weekday function that accounts for
-    [1,2,3,4] and weekday as options
-    or weekday, [1,2,3,4]
-
-    """
-
-    @staticmethod
-    def third_wednesday(year, month):
-        """Third Wednesday date of a given month/year
-
-        >>> Date.third_wednesday(2022, 6)
-        Date(2022, 6, 15)
-        >>> Date.third_wednesday(2023, 3)
-        Date(2023, 3, 15)
-        >>> Date.third_wednesday(2022, 12)
-        Date(2022, 12, 21)
-        >>> Date.third_wednesday(2023, 6)
-        Date(2023, 6, 21)
-        """
-        third = Date(year, month, 15)  # lowest 3rd day
-        w = third.weekday()
-        if w != WeekDay.WEDNESDAY:
-            third = third.replace(day=(15 + (WeekDay.WEDNESDAY - w) % 7))
-        return third
-
 
 class Time(_pendulum.Time):
 
@@ -1050,7 +1047,7 @@ class Time(_pendulum.Time):
                    tzinfo=obj.tzinfo or tz)
 
 
-class DateTime(PendulumBusinessDateMixin, _pendulum.DateTime):
+class DateTime(DateBusinessMixin, _pendulum.DateTime):
     """Inherits and wraps pendulum.DateTime
     """
 
@@ -1613,47 +1610,6 @@ class Interval:
         raise ValueError('Basis range [0, 4]. Unknown basis {basis}.')
 
 
-Range = namedtuple('Range', ['start', 'end'])
-
-
-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
-
-    >>> 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
-    """
-    r1 = Range(*range_one)
-    r2 = Range(*range_two)
-    latest_start = max(r1.start, r2.start)
-    earliest_end = min(r1.end, r2.end)
-    overlap = (earliest_end - latest_start).days + 1
-    if days:
-        return overlap
-    return overlap >= 0
-
-
 def create_ics(begdate, enddate, summary, location):
     """Create a simple .ics file per RFC 5545 guidelines."""
 

date/extras.py

@@ -0,0 +1,90 @@
+from collections import namedtuple
+
+from date import NYSE, DateTime, Entity
+
+__all__ = [
+    'is_within_business_hours',
+    'is_business_day',
+    'overlap_days',
+]
+
+
+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
+
+    """
+    this = DateTime.now()
+    this_entity = DateTime.now(tz=entity.tz).entity(entity)
+    bounds = this_entity.business_hours()
+    return this_entity.business_open() and (bounds[0] <= this.astimezone(entity.tz) <= bounds[1])
+
+
+def is_business_day(entity: Entity = NYSE) -> bool:
+    """Return whether the current native datetime is a business day.
+    """
+    return DateTime.now(tz=entity.tz).entity(entity).is_business_day()
+
+
+Range = namedtuple('Range', ['start', 'end'])
+
+
+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
+
+    >>> 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
+    """
+    r1 = Range(*range_one)
+    r2 = Range(*range_two)
+    latest_start = max(r1.start, r2.start)
+    earliest_end = min(r1.end, r2.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)

{opendate-0.1.1.dist-info → opendate-0.1.3.dist-info}/METADATA

@@ -1,10 +1,13 @@
 Metadata-Version: 2.1
 Name: opendate
-Version: 0.1.1
+Version: 0.1.3
 Summary: 
+Home-page: https://github.com/bissli/opendate
+License: MIT
 Author: bissli
 Author-email: bissli.xyz@protonmail.com
 Requires-Python: >=3.9,<4.0
+Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
@@ -20,6 +23,7 @@ Requires-Dist: pytest ; extra == "test"
 Requires-Dist: regex
 Requires-Dist: typing-extensions
 Requires-Dist: wrapt
+Project-URL: Repository, https://github.com/bissli/opendate
 Description-Content-Type: text/markdown
 
 opendate
@@ -45,7 +49,7 @@ thedate.business().add(days=5) # add 5 business day
 
 # subtract days
 thedate.subtract(days=5)
-thedate.business().subtrat(days=5) # subtract 5 business day
+thedate.business().subtract(days=5) # subtract 5 business day
 
 # start of month
 thedate.start_of('month')

opendate-0.1.3.dist-info/RECORD

@@ -0,0 +1,7 @@
+date/__init__.py,sha256=OUG51eAQp1unyaQT2pxSXrsU_VUorfofQ6xcGLmJ9OM,2693
+date/date.py,sha256=W6TcGhkRfaDNtY6gWeLfJy-pi80M10CTqWTpQKXhDEU,53971
+date/extras.py,sha256=7xsOsdhKrmGoyLl5W4Xhg9TfuytaaIH7uKWW9PvR5sE,2832
+opendate-0.1.3.dist-info/LICENSE,sha256=V4Rx8WWy7v8Fim6PHcEBszpZkDLbCHeorz1e_gr0Cbk,1111
+opendate-0.1.3.dist-info/METADATA,sha256=cySMy5_i5RWt0XTzOO3UUmz6qSrBONhSiEtES2HXwMI,1816
+opendate-0.1.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+opendate-0.1.3.dist-info/RECORD,,

date/business.py

@@ -1,42 +0,0 @@
-from date import NYSE, DateTime, Entity
-
-__all__ = ['is_within_business_hours', 'is_business_day']
-
-
-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
-
-    """
-    this = DateTime.now()
-    this_entity = DateTime.now(tz=entity.tz).entity(entity)
-    bounds = this_entity.business_hours()
-    return this_entity.business_open() and (bounds[0] <= this.astimezone(entity.tz) <= bounds[1])
-
-
-def is_business_day(entity: Entity = NYSE) -> bool:
-    """Return whether the current native datetime is a business day.
-    """
-    return DateTime.now(tz=entity.tz).entity(entity).is_business_day()
-
-
-if __name__ == '__main__':
-    __import__('doctest').testmod(optionflags=4 | 8 | 32)

opendate-0.1.1.dist-info/RECORD

@@ -1,7 +0,0 @@
-date/__init__.py,sha256=rKMipKmHXrZv3rFgLy6hfa4IT4yPEaiOZNm-3lUPFi0,2552
-date/business.py,sha256=g4dHpmEaUuADgMxIcTG96AEviaRo9NvGDJ8IPKXD7xQ,1386
-date/date.py,sha256=DrjvL_c3hYSHXaVVkccOpEyr7nDZvc02XUfSP8n_tNI,55210
-opendate-0.1.1.dist-info/LICENSE,sha256=V4Rx8WWy7v8Fim6PHcEBszpZkDLbCHeorz1e_gr0Cbk,1111
-opendate-0.1.1.dist-info/METADATA,sha256=yhEiuR4bKrpG87JPWLt9ilya31PkmKcTKs8AQxRcgiA,1645
-opendate-0.1.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-opendate-0.1.1.dist-info/RECORD,,