opendate 0.1.3__tar.gz → 0.1.5__tar.gz

{opendate-0.1.3 → opendate-0.1.5}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: opendate
-Version: 0.1.3
-Summary: 
+Version: 0.1.5
+Summary: Python business datetimes
 Home-page: https://github.com/bissli/opendate
 License: MIT
 Author: bissli

{opendate-0.1.3 → opendate-0.1.5}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "opendate"
-version = "0.1.3"
-description = ""
+version = "0.1.5"
+description = "Python business datetimes"
 authors = ["bissli <bissli.xyz@protonmail.com>"]
 readme = "README.md"
 license = "MIT"

{opendate-0.1.3 → opendate-0.1.5}/src/date/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '0.1.3'
+__version__ = '0.1.5'
 
 import datetime as _datetime
 
@@ -51,11 +51,10 @@ def time(*args, **kwargs):
     return Time(*args, **kwargs)
 
 
-def parse():
-    """Generic parser that guesses type"""
-    raise NotImplementedError(
-        'Generic parser not implemented, use Date or DateTime parsers'
-    )
+def parse(s: str | None, fmt: str = None, entity: Entity = NYSE, raise_err: bool = False) -> DateTime | None:
+    """Parse using DateTime.parse
+    """
+    return DateTime.parse(s, entity=entity, raise_err=True)
 
 
 def instance(obj: _datetime.date | _datetime.datetime | _datetime.time) -> DateTime | Date | Time:
@@ -72,13 +71,13 @@ def instance(obj: _datetime.date | _datetime.datetime | _datetime.time) -> DateT
 
 
 def now(tz: str | _zoneinfo.ZoneInfo | None = None) -> DateTime:
-    """Get current datetime
+    """Returns Datetime.now
     """
     return DateTime.now(tz)
 
 
 def today(tz: str | _zoneinfo.ZoneInfo = None) -> DateTime:
-    """Get current date
+    """Returns DateTime.today
     """
     return DateTime.today(tz)
 

{opendate-0.1.3 → opendate-0.1.5}/src/date/date.py

@@ -47,6 +47,27 @@ __all__ = [
 
 def Timezone(name:str = 'US/Eastern') -> _zoneinfo.ZoneInfo:
     """Simple wrapper around Pendulum `Timezone`
+
+    Ex: sanity check US/Eastern == America/New_York
+
+    >>> winter1 = DateTime(2000, 1, 1, 12, tzinfo=Timezone('US/Eastern'))
+    >>> winter2 = DateTime(2000, 1, 1, 12, tzinfo=Timezone('America/New_York'))
+
+    >>> summer1 = DateTime(2000, 7, 1, 12, tzinfo=Timezone('US/Eastern'))
+    >>> summer2 = DateTime(2000, 7, 1, 12, tzinfo=Timezone('America/New_York'))
+
+    >>> winter = [winter1, winter2,
+    ... winter1.astimezone(Timezone('America/New_York')),
+    ... winter2.astimezone(Timezone('US/Eastern')),
+    ... ]
+    >>> assert all(x==winter[0] for x in winter)
+
+    >>> summer = [summer1, summer2,
+    ... summer1.astimezone(Timezone('America/New_York')),
+    ... summer2.astimezone(Timezone('US/Eastern')),
+    ... ]
+    >>> assert all(x==summer[0] for x in summer)
+
     """
     return _pendulum.tz.Timezone(name)
 
@@ -1115,7 +1136,11 @@ class DateTime(DateBusinessMixin, _pendulum.DateTime):
         return Time.instance(self)
 
     @classmethod
-    def parse(cls, s: str | int | None, raise_err: bool = False) -> Self | None:
+    def parse(
+        cls, s: str | int | None,
+        entity: Entity = NYSE,
+        raise_err: bool = False
+        ) -> Self | None:
         """Thin layer on Date parser and our custom `Date.parse``
 
         >>> DateTime.parse('2022/1/1')
@@ -1173,7 +1198,7 @@ class DateTime(DateBusinessMixin, _pendulum.DateTime):
                 if d is not None and t is not None:
                     return DateTime.combine(d, t, LCL)
 
-        d = Date.parse(s)
+        d = Date.parse(s, entity=entity)
         if d is not None:
             return cls(d.year, d.month, d.day, 0, 0, 0)
 
@@ -1413,18 +1438,35 @@ class Interval:
                 yield thedate
             thedate = thedate.add(days=1)
 
+    def start_of_series(self, unit='month') -> list[Date]:
+        """Return a series between and inclusive of begdate and enddate.
+
+        >>> Interval(Date(2018, 1, 5), Date(2018, 4, 5)).start_of_series('month')
+        [Date(2018, 1, 1), Date(2018, 2, 1), Date(2018, 3, 1), Date(2018, 4, 1)]
+        >>> Interval(Date(2018, 4, 30), Date(2018, 7, 30)).start_of_series('month')
+        [Date(2018, 4, 1), Date(2018, 5, 1), Date(2018, 6, 1), Date(2018, 7, 1)]
+        >>> Interval(Date(2018, 1, 5), Date(2018, 4, 5)).start_of_series('week')
+        [Date(2018, 1, 1), Date(2018, 1, 8), ..., Date(2018, 4, 2)]
+        """
+        begdate = self.begdate.start_of(unit)
+        enddate = self.enddate.start_of(unit)
+        interval = _pendulum.interval(begdate, enddate)
+        return [Date.instance(d).start_of(unit) for d in interval.range(f'{unit}s')]
+
     def end_of_series(self, unit='month') -> list[Date]:
         """Return a series between and inclusive of begdate and enddate.
 
         >>> Interval(Date(2018, 1, 5), Date(2018, 4, 5)).end_of_series('month')
         [Date(2018, 1, 31), Date(2018, 2, 28), Date(2018, 3, 31), Date(2018, 4, 30)]
+        >>> Interval(Date(2018, 4, 30), Date(2018, 7, 30)).end_of_series('month')
+        [Date(2018, 4, 30), Date(2018, 5, 31), Date(2018, 6, 30), Date(2018, 7, 31)]
         >>> Interval(Date(2018, 1, 5), Date(2018, 4, 5)).end_of_series('week')
         [Date(2018, 1, 7), Date(2018, 1, 14), ..., Date(2018, 4, 8)]
         """
         begdate = self.begdate.end_of(unit)
         enddate = self.enddate.end_of(unit)
         interval = _pendulum.interval(begdate, enddate)
-        return [Date.instance(d) for d in interval.range(f'{unit}s')]
+        return [Date.instance(d).end_of(unit) for d in interval.range(f'{unit}s')]
 
     def days(self) -> int:
         """Return days between (begdate, enddate] or negative (enddate, begdate].