clockwork 0.1.3__tar.gz → 0.2.0__tar.gz

{clockwork-0.1.3 → clockwork-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: clockwork
-Version: 0.1.3
+Version: 0.2.0
 Summary: Toolkit for time-related operations including scheduling, logging, date manipulation, and more.
 Home-page: https://github.com/zteinck/clockwork
 License: MIT

clockwork-0.2.0/clockwork/__init__.py

@@ -0,0 +1,4 @@
+from .core import *
+
+__version__ = '0.2.0'
+__author__ = 'Zachary Einck <zacharyeinck@gmail.com>'

{clockwork-0.1.3 → clockwork-0.2.0}/clockwork/_base.py

@@ -1,9 +1,8 @@
 import datetime
 import calendar
 import time
-from functools import cached_property
 from dateutil.relativedelta import relativedelta
-import holidays
+import holidays as hd
 import pandas as pd
 import numpy as np
 
@@ -19,6 +18,11 @@ class DateBase(object):
     --------------------
     factory : func
         initializes new instances as the correct subclass
+    weekdays : dict
+        dictionary where keys are the days of the week and values
+        are the corresponding index values
+    holidays : holidays.countries.united_states.UnitedStates
+        comprehensive list of U.S. holidays
 
     Instance Attributes
     --------------------
@@ -26,6 +30,15 @@ class DateBase(object):
         date and time (if applicable)
     '''
 
+    #╭-------------------------------------------------------------------------╮
+    #| Class Attributes                                                        |
+    #╰-------------------------------------------------------------------------╯
+
+    holidays = hd.UnitedStates()
+    weekdays = {k: i for i, k in enumerate(calendar.day_name)}
+    weekdays.update({k[:3]: v for k, v in weekdays.items()})
+
+
     #╭-------------------------------------------------------------------------╮
     #| Initialize Instance                                                     |
     #╰-------------------------------------------------------------------------╯
@@ -119,7 +132,7 @@ class DateBase(object):
             ''' spawn new date instance '''
 
             def wrapper(self, *args, **kwargs):
-                return cls.spawn(func(self, *args, **kwargs))
+                return self.spawn(func(self, *args, **kwargs))
 
             return wrapper
 
@@ -145,9 +158,9 @@ class DateBase(object):
             def wrapper(self, other):
                 try:
                     other = datetime.timedelta(float(other))
-                    return cls.spawn(func(self, other))
+                    return self.spawn(func(self, other))
                 except:
-                    other = cls.spawn(other).dt
+                    other = self.spawn(other).dt
                     return func(self, other)
 
             return wrapper
@@ -300,20 +313,6 @@ class DateBase(object):
         ''' returns the current holiday, if applicable '''
         return self.holidays.get(self.ymd)
 
-    @cached_property
-    def weekdays(self):
-        ''' dictionary where keys are the days of the week and values are the corresponding index values '''
-        out = {k: i for i, k in enumerate((
-            'Monday','Tuesday','Wednesday','Thursday',
-            'Friday','Saturday','Sunday'))}
-        out.update({k[:3]: v for k, v in out.items()})
-        return out
-
-    @cached_property
-    def holidays(self):
-        ''' comprehensive list of U.S. holidays '''
-        return holidays.UnitedStates()
-
 
     #╭-------------------------------------------------------------------------╮
     #| Magic Methods                                                           |
@@ -326,7 +325,7 @@ class DateBase(object):
         components = ['%Y-%m-%d']
         if self.dt.hour + self.dt.second + self.dt.microsecond > 0:
             components.append('%I:%M:%S.%f %p')
-        return self.str(' '.join(components))
+        return self.__class__.__name__ + '(%s)' % self.str(' '.join(components))
 
     def __int__(self):
         return self.timestamp

{clockwork-0.1.3 → clockwork-0.2.0}/clockwork/core.py

@@ -12,7 +12,7 @@ from ._month_end import MonthEnd
 #| Functions                                                               |
 #╰-------------------------------------------------------------------------╯
 
-def Date(arg=None, normalize=False, week_offset=0):
+def Date(arg=None, normalize=False, format=None, week_offset=0):
     '''
     Description
     ------------
@@ -30,11 +30,13 @@ def Date(arg=None, normalize=False, week_offset=0):
             • string
                 ► day of the week fully spelled out or first 3 letters (not case sensitive)
                   (e.g. 'Monday', 'monday', 'mon')
-                ► quarter in #QYY or YYYYQ# format
+                ► quarter in #QYY, YYYYQ#, or Q# format
                 ► any string format supported by pd.to_datetime
             • DateBase object or DateBase polymorphism
     normalize : bool
         if True, only the year, month, and day are retained (hours, minutes, seconds, microseconds are set to zero)
+    format : str
+        if 'arg' is a string, this format is used to parse it (e.g. '%Y%m%d %H%S').
     week_offset : int
         by default, if a day of the week is supplied (e.g. 'Monday') then the date returned will be that day of the week
         for the current week. This argument is used to override this behavior by shifting the week backwards or forwards
@@ -51,20 +53,31 @@ def Date(arg=None, normalize=False, week_offset=0):
     def qtr_label_to_dt(x):
         ''' attempts to convert quarter expressed as string to datetime.
             Suported formats include #QYY and YYYYQ# '''
+        x = x.upper()
         try:
-            qtr, year = re.findall(r'(\d{1})Q(\d{2})', x)[0]
+            qtr, year = re.findall(r'^(\d{1})Q(\d{2})$', x)[0]
         except:
             try:
-                year, qtr = re.findall(r'(\d{4})Q(\d{1})', x)[0]
+                year, qtr = re.findall(r'^(\d{4})Q(\d{1})$', x)[0]
             except:
-                return
+                try:
+                    qtr = re.findall(r'^Q(\d{1})$', x)[0]
+                    year = datetime.datetime.now().year
+                except:
+                    return
 
-        inverse = {v: k for k,v in qtr_map.items()}
+        inverse = {v: k for k, v in qtr_map.items()}
         month, day = inverse[int(qtr)]
         out = DateBase.to_datetime(f'{month}-{day}-{year}')
         return out
 
 
+    if format is not None:
+        if not isinstance(arg, str):
+            raise TypeError(f"When 'format' argument is not None, 'arg' must be a string, not {type(arg)}.")
+        arg = DateBase.to_datetime(arg, format=format)
+        return Date(arg, normalize=normalize)
+
     if arg is None:
         dt = datetime.datetime.now()
     elif hasattr(arg, 'to_pydatetime'): # pandas

{clockwork-0.1.3 → clockwork-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "clockwork"
-version = "0.1.3"
+version = "0.2.0"
 description = "Toolkit for time-related operations including scheduling, logging, date manipulation, and more."
 authors = ["Zachary Einck <zacharyeinck@gmail.com>"]
 license = "MIT"

clockwork-0.1.3/clockwork/__init__.py

@@ -1,4 +0,0 @@
-from .core import *
-
-__version__ = '0.1.3'
-__author__ = 'Zachary Einck <zacharyeinck@gmail.com>'