clockwork 0.1.0__tar.gz

clockwork-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Zachary Einck
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

clockwork-0.1.0/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.1
+Name: clockwork
+Version: 0.1.0
+Summary: Toolkit for time-related operations including scheduling, logging, date manipulation, and more.
+Home-page: https://github.com/zteinck/clockwork
+License: MIT
+Author: Zachary Einck
+Author-email: zacharyeinck@gmail.com
+Requires-Python: >=3.8,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: holidays
+Requires-Dist: iterlab
+Requires-Dist: pathpilot
+Requires-Dist: schedule
+Requires-Dist: textwrap3
+Project-URL: Repository, https://github.com/zteinck/clockwork
+Description-Content-Type: text/markdown
+
+# clockwork
+`clockwork` is a library that provides a multitude of time-related functionalities, facilitating tasks such as scheduling, logging, date manipulation, and more.

clockwork-0.1.0/README.md

@@ -0,0 +1,2 @@
+# clockwork
+`clockwork` is a library that provides a multitude of time-related functionalities, facilitating tasks such as scheduling, logging, date manipulation, and more.

clockwork-0.1.0/clockwork/__init__.py

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

clockwork-0.1.0/clockwork/chronicle.py

@@ -0,0 +1,97 @@
+import logging
+import datetime
+from pathpilot import Folder
+
+
+class CustomLogFormatter(logging.Formatter):
+    ''' the default implementation of logging.Formatter does not allow timestamps to be formatted how I want '''
+
+    converter = datetime.datetime.fromtimestamp
+
+    def formatTime(self, record, datefmt=None):
+        if datefmt is not None: raise TypeError('datefmt argument must be None')
+        return self.converter(record.created).strftime('%Y-%m-%d %I:%M:%S.{} %p').format('%03d' % record.msecs)
+
+
+
+class Logger(object):
+
+    instances = {}
+
+    @classmethod
+    def load(cls, name, *args, **kwargs):
+        if name not in cls.instances:
+            cls.instances[name] = cls(name, *args, **kwargs)
+        return cls.instances[name]
+
+
+    def __init__(self, name, clear=False, stream_handler=False):
+        self.name = name
+
+        # create logger
+        logger = logging.getLogger(name)
+        logger.setLevel(logging.DEBUG)
+
+        # 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')
+
+        # create file handler which logs even debug messages
+        self.file = Folder().parent.join('Data', 'Logger', read_only=False).join(f'{name}.log').path
+        if clear: self.clear()
+        fh = logging.FileHandler(self.file)
+        fh.setLevel(logging.DEBUG)
+        fh.setFormatter(formatter)
+        logger.addHandler(fh) # add handler to the logger
+
+        # create console handler with a higher log level
+        if stream_handler:
+            ch = logging.StreamHandler()
+            ch.setLevel(logging.ERROR)
+            ch.setFormatter(formatter)
+            logger.addHandler(ch) # add handler to the logger
+
+        # disable logging to console
+        logger.propagate = False
+
+        self.logger = logger
+
+
+    def __getitem__(self, name):
+        return self.__dict__[name].logger
+
+    def __repr__(self):
+        return self.file
+
+    def __str__(self):
+        return self.file
+
+    def clear(self):
+        open(self.file, 'w').close()
+
+
+
+def log(logger=None):
+    ''' Logs decorated function using the passed logging.Logger object.
+    If None, a logger object is created (or loaded if already exists)
+    using the decorated function's name. '''
+    def decorator(func):
+        def wrapper(*args, **kwargs):
+            nonlocal logger
+            logger = logger or Logger.load(func.__name__).logger
+            logger.info('start')
+            try:
+                out = func(*args, **kwargs)
+                logger.info('complete')
+                return out
+            except Exception as e:
+                logger.exception('exception')
+                return e
+        return wrapper
+    return decorator
+
+
+
+if __name__ == '__main__':
+    pass