clockwork 0.3.5__tar.gz → 0.4.0__tar.gz

{clockwork-0.3.5 → clockwork-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: clockwork
-Version: 0.3.5
+Version: 0.4.0
 Summary: Toolkit for time-related operations including scheduling, logging, date manipulation, and more.
 Home-page: https://github.com/zteinck/clockwork
 License: MIT
@@ -16,7 +16,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: holidays
 Requires-Dist: numpy
-Requires-Dist: oddments (>=0.3.1)
+Requires-Dist: oddments (>=0.4.0)
 Requires-Dist: pandas
 Requires-Dist: schedule
 Project-URL: Repository, https://github.com/zteinck/clockwork

{clockwork-0.3.5 → clockwork-0.4.0}/clockwork/__init__.py

@@ -8,5 +8,5 @@ from .utils import (
     temporal_format_to_regex,
     )
 
-__version__ = '0.3.5'
+__version__ = '0.4.0'
 __author__ = 'Zachary Einck <zacharyeinck@gmail.com>'

{clockwork-0.3.5 → clockwork-0.4.0}/clockwork/decorators.py

@@ -1,5 +1,5 @@
 from functools import wraps
-from oddments import add_border
+import oddments as odd
 import time
 
 from .utils import format_elapsed_seconds
@@ -11,11 +11,11 @@ def action_timer(func):
     def wrapper(*args, **kwargs):
         start_time = time.time()
         action = func.__name__
-        header = add_border(action, width=75, fixed_width=True)
+        header = odd.add_border(action, width=75, fixed_width=True)
         print(header + '\n')
         out = func(*args, **kwargs)
         duration = format_elapsed_seconds(time.time() - start_time)
-        trailer = add_border(f'{action} complete in {duration}.')
+        trailer = odd.add_border(f'{action} complete in {duration}.')
         print(trailer + '\n')
         return out
 

{clockwork-0.3.5 → clockwork-0.4.0}/clockwork/month_end.py

@@ -96,17 +96,17 @@ class MonthEnd(Timestamp):
 
     @property
     def long_label(self):
-        return self.str('%Y-%m-%d')
+        return self.to_string('%Y-%m-%d')
 
 
     @property
     def compact_label(self):
-        return self.str('%Y-%m')
+        return self.to_string('%Y-%m')
 
 
     @property
     def short_label(self):
-        return self.str('%b')
+        return self.to_string('%b')
 
 
     @property
@@ -145,7 +145,7 @@ class MonthEnd(Timestamp):
         ''' offsets instance by desired number of periods '''
         odd.validate_value(
             value=periods,
-            attr='periods',
+            name='periods',
             types=int
             )
 

{clockwork-0.3.5 → clockwork-0.4.0}/clockwork/quarter_end.py

@@ -96,7 +96,7 @@ class QuarterEnd(MonthEnd):
 
     @property
     def compact_label(self):
-        return f'{self.qtr}Q' + self.str('%y')
+        return f'{self.qtr}Q' + self.to_string('%y')
 
 
     @property
@@ -150,7 +150,7 @@ class QuarterEnd(MonthEnd):
 
         odd.validate_value(
             value=value,
-            attr='scheme',
+            name='scheme',
             types=tuple
             )
 

{clockwork-0.3.5 → clockwork-0.4.0}/clockwork/taskmaster/taskmaster.py

@@ -140,8 +140,8 @@ class TaskMaster(object):
             will be set to 'second' and 1, respectively, so that the job will
             run ASAP once the 'start' criteria has been met (if applicable).
         at : str | iter
-            time_string argument passed to schedule.Job.at(time_string). Times may be
-            passed in '%I:%M%p' format (e.g ['06:15 AM', '12:15 PM']).
+            time_string argument passed to schedule.Job.at(time_string). Times
+            may be passed in '%I:%M%p' format (e.g ['06:15 AM', '12:15 PM']).
             If argument is an iterable then the job will be scheduled at each
             constituent time.
         interval : int
@@ -182,7 +182,7 @@ class TaskMaster(object):
             else:
                 raise Exception("'every' argument cannot be None")
 
-        for at in odd.to_iter(at):
+        for at in odd.ensure_list(at):
             job = getattr(cls.scheduler.every(interval), every)
             if at is not None:
                 try:

{clockwork-0.3.5 → clockwork-0.4.0}/clockwork/timestamp.py

@@ -173,7 +173,7 @@ class Timestamp(object):
                 shifted : Timestamp
                     Timestamp instance
                 '''
-                odd.validate_value(value=arg, attr='arg', types=str)
+                odd.validate_value(value=arg, name='arg', types=str)
                 kind = func.__name__
 
                 # try weekday
@@ -262,8 +262,8 @@ class Timestamp(object):
             self._dt = value
         else:
             raise TypeError(
-                f"Value must be of type <datetime.datetime> when set directly, "
-                f"got: {value!r} of type <{type(value).__name__}>."
+                f'Value must be of type <datetime.datetime> when set '
+                f'directly, got: {value!r} of type <{type(value).__name__}>.'
                 )
 
 
@@ -286,9 +286,9 @@ class Timestamp(object):
 
 
     @property
-    def pandas(self):
-        ''' to_pandas() alias '''
-        return self.to_pandas()
+    def pd(self):
+        ''' to_pandas_timestamp() alias '''
+        return self.to_pandas_timestamp()
 
 
     @property
@@ -564,19 +564,24 @@ class Timestamp(object):
         return self.__class__(dt)
 
 
+    def to_base(self):
+        ''' return a base-class version of this instance '''
+        return self._make_base(self)
+
+
     def to_datetime(self):
         ''' returns a copy of the underlying datetime.datetime object '''
         return deepcopy(self.dt)
 
 
-    def to_pandas(self):
+    def to_pandas_timestamp(self):
         ''' return as a pd.Timestamp object '''
         return pd.to_datetime(self.dt)
 
 
     def to_timestamp(self):
         ''' returns timestamp expressed in seconds '''
-        return self.to_pandas().timestamp()
+        return self.pd.timestamp()
 
 
     def to_date(self):

{clockwork-0.3.5 → clockwork-0.4.0}/clockwork/utils.py

@@ -1,4 +1,4 @@
-from oddments import validate_value
+import oddments as odd
 import re
 
 
@@ -74,8 +74,8 @@ def temporal_format_to_regex(format, encase=False):
     pattern : str
         regex pattern
     '''
-    validate_value(value=format, attr='format', types=str)
-    validate_value(value=encase, attr='encase', types=bool)
+    odd.validate_value(value=format, name='format', types=str)
+    odd.validate_value(value=encase, name='encase', types=bool)
 
     digit_pattern = lambda x: r'\d{%d}' % x
     mapping = {}

{clockwork-0.3.5 → clockwork-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "clockwork"
-version = "0.3.5"
+version = "0.4.0"
 description = "Toolkit for time-related operations including scheduling, logging, date manipulation, and more."
 authors = ["Zachary Einck <zacharyeinck@gmail.com>"]
 license = "MIT"
@@ -14,7 +14,7 @@ pandas = "*"
 numpy = "*"
 schedule = "*"
 holidays = "*"
-oddments = ">=0.3.1"
+oddments = ">=0.4.0"
 
 [build-system]
 requires = ["poetry-core"]