clockwork 0.3.3__tar.gz → 0.3.5__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: clockwork
-Version: 0.3.3
+Version: 0.3.5
 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.0)
+Requires-Dist: oddments (>=0.3.1)
 Requires-Dist: pandas
 Requires-Dist: schedule
 Project-URL: Repository, https://github.com/zteinck/clockwork

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

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

{clockwork-0.3.3 → clockwork-0.3.5}/clockwork/taskmaster/_task.py

@@ -4,7 +4,7 @@ from contextlib import redirect_stdout
 from schedule import CancelJob
 
 from ..timestamp import Timestamp
-from ..utils import elapsed_time
+from ..utils import format_elapsed_seconds
 from .utils import PrerequisiteError, ContinueFailedJob
 
 
@@ -22,8 +22,8 @@ class Task(object):
     verbose : bool
         If True, class content is printed to console.
     disable_print : bool
-        If True, printing is suppressed while func runs. Must be True if verbose
-        is True.
+        If True, printing is suppressed while func runs. Must be True if
+        verbose is True.
     cascade_status : str
         cascade status
 
@@ -52,8 +52,8 @@ class Task(object):
         traceback. cancel_on_failure and cascade are automatically set to True
         if this argument is True (prevents endless spam).
     restrict_to_business_hours : bool
-        If True, the job will only execute during business hours. This is a more
-        restrictive version of restrict_to_business_days.
+        If True, the job will only execute during business hours. This is a
+        more restrictive version of restrict_to_business_days.
     restrict_to_business_days : bool
         If True, the job will only execute during weekdays (i.e. not weekends).
     cascade : bool
@@ -61,14 +61,15 @@ class Task(object):
         multiple times in the jobs table due to having multiple 'at' values,
         changes in activiation in one will cascade to all others. For example,
         consider the job named 'my job' which is scheduled at 8:00 AM and 5:00
-        PM that is cancelled on completion. If the 8:00 AM completes successfully
-        then the job with that 'at' time will be set to inactive and have its status
-        updated in the table accordingly. Under default behavior, the 5:00 PM run
-        will be unaffected by the completion of the 8:00 AM run, however, if cascade
-        is set to True then the 5:00 PM run will also receive the same updates.
+        PM that is cancelled on completion. If the 8:00 AM completes
+        successfully then the job with that 'at' time will be set to inactive
+        and have its status updated in the table accordingly. Under default
+        behavior, the 5:00 PM run will be unaffected by the completion of the
+        8:00 AM run, however, if cascade is set to True then the 5:00 PM run
+        will also receive the same updates.
     attempts : int
-        If greater than 1, the job will be attempted this number of times before
-        being cancelled.
+        If greater than 1, the job will be attempted this number of times
+        before being cancelled.
     status : str | None
         current status of the job
     '''
@@ -161,7 +162,10 @@ class Task(object):
 
         def update_status(status, set_inactive=False):
             self.status = status
-            if logger: logger.info(f"{self.name} status update: '{self.status}'")
+
+            if logger:
+                logger.info(f"{self.name} status update: '{self.status}'")
+
             self.update_table(active=0 if set_inactive else 1)
 
         if self.expiry and self.expiry < Timestamp():
@@ -188,11 +192,17 @@ class Task(object):
                     print(self.name, end='')
                     print(f' @ {Timestamp()} ->', end=' ')
 
-                if self.restrict_to_business_hours and not Timestamp().is_business_hours:
-                    raise PrerequisiteError('cannot execute outside of business hours')
+                if self.restrict_to_business_hours \
+                    and not Timestamp().is_business_hours:
+                    raise PrerequisiteError(
+                        'cannot execute outside of business hours'
+                        )
 
-                if self.restrict_to_business_days and not Timestamp().is_business_day:
-                    raise PrerequisiteError('cannot execute during the weekend')
+                if self.restrict_to_business_days \
+                    and not Timestamp().is_business_day:
+                    raise PrerequisiteError(
+                        'cannot execute during the weekend'
+                        )
 
                 if self.disable_print:
                     with redirect_stdout(open(os.devnull, 'w')):
@@ -201,10 +211,16 @@ class Task(object):
                     out = self.func(*self.args, **self.kwargs)
 
                 if self.verbose:
-                    print(f'Complete {elapsed_time(time.time() - start)}', end='')
-                    print(' (Job Cancelled)') if self.cancel_on_completion else print('')
+                    elapsed = format_elapsed_seconds(time.time() - start)
+                    print(f'Complete {elapsed}' , end='')
+                    print(
+                        ' (Job Cancelled)'
+                        if self.cancel_on_completion
+                        else ''
+                        )
 
-                if logger: logger.info(f'{self.name} complete')
+                if logger:
+                    logger.info(f'{self.name} complete')
 
                 if self.cancel_on_completion:
                     update_status('cancelled on completion', set_inactive=True)
@@ -240,4 +256,8 @@ class Task(object):
                     if self.notify_on_failure:
                         self.send_email_notification()
 
-                return CancelJob if self.cancel_on_failure else ContinueFailedJob
+                return (
+                    CancelJob
+                    if self.cancel_on_failure
+                    else ContinueFailedJob
+                    )

{clockwork-0.3.3 → clockwork-0.3.5}/clockwork/taskmaster/logger.py

@@ -53,8 +53,9 @@ class Logger(object):
 
         # create custom formatter
         # https://docs.python.org/3/library/logging.html#logrecord-attributes
-        formatter = CustomLogFormatter(fmt='%(asctime)s %(levelname)s %(message)s')
-        # formatter = CustomLogFormatter(fmt='%(asctime)s %(name)s %(levelname)s %(message)s')
+        formatter = CustomLogFormatter(
+            fmt='%(asctime)s %(levelname)s %(message)s'
+            )
 
         # create file handler which logs even debug messages
         self.file = self.folder.join(f'{name}.log', read_only=False).path

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

@@ -78,7 +78,8 @@ class TaskMaster(object):
                 1) job completed succesfully and was cancelled
                 2) job obained this status via cascade from a job that satisfied
                    criteria in 1)
-                3) job was manually set inactive via TaskMaster.set_inactive method
+                3) job was manually set inactive via TaskMaster.set_inactive
+                   method
         expiry : str
             Task.expiry
         status : str
@@ -139,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_str argument passed to schedule.Job.at(time_str). Times may be
-            passed in '%I:%M%p' format (e.g ['06:15 AM', '12:15 PM', '06: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
@@ -185,12 +186,13 @@ class TaskMaster(object):
             job = getattr(cls.scheduler.every(interval), every)
             if at is not None:
                 try:
-                    time_str = datetime.datetime.strptime(
-                        at.upper().replace(' ',''), '%I:%M%p'
+                    time_string = datetime.datetime.strptime(
+                        at.upper().replace(' ', ''),
+                        '%I:%M%p'
                         ).strftime('%H:%M')
                 except:
-                    time_str = at
-                job = job.at(time_str)
+                    time_string = at
+                job = job.at(time_string)
             else:
                 at = 'N/A'
 

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

@@ -5,9 +5,9 @@ import holidays as hd
 import pandas as pd
 import numpy as np
 import oddments as odd
-from copy import deepcopy as deep_copy
-from dateutil.relativedelta import \
-    relativedelta as relative_delta
+from copy import deepcopy
+from dateutil.relativedelta import relativedelta
+from dateutil.parser import parse
 
 from .constants import MONTHS_IN_YEAR
 
@@ -111,7 +111,8 @@ class Timestamp(object):
 
             @wraps(func)
             def wrapper(self, other):
-                # Subtracting a date-like 'other' returns a datetime.timedelta object.
+                # Subtracting a date-like 'other' returns a datetime.timedelta
+                # object.
                 if func.__name__.replace('_', '') == 'sub' and \
                     not isinstance(other, (dict, float, int)):
                     return func(self, self._to_datetime(other))
@@ -163,9 +164,9 @@ class Timestamp(object):
                     characters (e.g. 'Friday' or 'Fri') not case-sensitive. Also
                     supports period ends (e.g. 'QE', 'ME').
                 offset : int
-                    Offset value +/- indicating how many additional weeks to shift.
-                    For example, self.next('Mon', offset=+1) would return the Monday
-                    two weeks from self.
+                    Offset value +/- indicating how many additional weeks to
+                    shift. For example, self.next('Mon', offset=+1) would
+                    return the Monday two weeks from self.
 
                 Returns
                 ------------
@@ -565,7 +566,7 @@ class Timestamp(object):
 
     def to_datetime(self):
         ''' returns a copy of the underlying datetime.datetime object '''
-        return deep_copy(self.dt)
+        return deepcopy(self.dt)
 
 
     def to_pandas(self):
@@ -588,14 +589,9 @@ class Timestamp(object):
         return self.dt.time()
 
 
-    def to_string(self, fmt):
+    def to_string(self, format):
         ''' strftime alias '''
-        return self.strftime(fmt)
-
-
-    def str(self, *args, **kwargs):
-        ''' to_string() alias '''
-        return self.to_string(*args, **kwargs)
+        return self.strftime(format)
 
 
     @Decorators.skip_shift
@@ -639,7 +635,7 @@ class Timestamp(object):
         if not kwargs:
             raise ValueError("'kwargs' is empty?")
 
-        return (relative_delta if relative else
+        return (relativedelta if relative else
                 datetime.timedelta)(**kwargs)
 
 
@@ -836,7 +832,7 @@ class Timestamp(object):
 
 
     @classmethod
-    def _to_datetime(cls, arg, **kwargs):
+    def _to_datetime(cls, arg, format=None, offset=0):
         '''
         Description
         ------------
@@ -888,8 +884,8 @@ class Timestamp(object):
             qe_cls = cls._get_quarter_end_cls()
             parsed = qe_cls.parse_label(arg)
             if parsed is None: return
-            year, qtr = parsed
-            qe = qe_cls(year=year, qtr=qtr, offset=offset)
+            year, quarter = parsed
+            qe = qe_cls(year=year, quarter=quarter, offset=offset)
             return qe.dt
 
 
@@ -900,14 +896,16 @@ class Timestamp(object):
             raise NotImplementedError
 
         if isinstance(arg, str):
-            if not kwargs.get('format'):
-                offset = cls._try_int(kwargs.pop('offset', 0))
-                for parser in (try_weekday, try_quarter_end):
-                    result = parser(arg, offset)
-                    if result is not None:
-                        return result
-
-            return pd.to_datetime(arg, **kwargs).to_pydatetime()
+            if format is not None:
+                return datetime.datetime.strptime(arg, format)
+
+            offset = cls._try_int(offset)
+            for func in (try_weekday, try_quarter_end):
+                result = func(arg, offset)
+                if result is not None:
+                    return result
+
+            return parse(arg)
 
         # Timestamp instance (or subclass)
         if isinstance(arg, Timestamp):

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

@@ -1,3 +1,4 @@
+from oddments import validate_value
 import re
 
 
@@ -48,7 +49,7 @@ def format_elapsed_seconds(seconds, n_digits=2):
     return ', '.join(parts)
 
 
-def date_format_to_regex(date_format, encase=False):
+def temporal_format_to_regex(format, encase=False):
     '''
     Description
     ------------
@@ -63,7 +64,7 @@ def date_format_to_regex(date_format, encase=False):
 
     Parameters
     ------------
-    date_format : str
+    format : str
         String of datetime format codes (e.g. '%Y-%m-%d').
     encase : bool
         If True, the output will be encased in parenthesis.
@@ -73,9 +74,11 @@ def date_format_to_regex(date_format, encase=False):
     pattern : str
         regex pattern
     '''
-    mapping = {}
+    validate_value(value=format, attr='format', types=str)
+    validate_value(value=encase, attr='encase', types=bool)
 
     digit_pattern = lambda x: r'\d{%d}' % x
+    mapping = {}
 
     for k, v in [('w', 1), ('j', 3), ('Y', 4), ('f', 6)]:
         mapping['%' + k] = digit_pattern(v)
@@ -96,10 +99,10 @@ def date_format_to_regex(date_format, encase=False):
         mapping['%' + k] = r'(?:%s)' % '|'.join(v)
 
     for k in ['z','Z','c','x','X']:
-        if '%' + k in date_format:
+        if '%' + k in format:
             raise NotImplementedError
 
-    pattern = re.escape(date_format)
+    pattern = re.escape(format)
 
     for k, v in mapping.items():
         pattern = pattern.replace(re.escape(k), v)

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "clockwork"
-version = "0.3.3"
+version = "0.3.5"
 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.0"
+oddments = ">=0.3.1"
 
 [build-system]
 requires = ["poetry-core"]