Merge pull request #3 from desultory/dev

3.0, remove threading, add "types" modue

Author: desultory

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "zenlib"
-version = "2.4.1"
+version = "3.0.0"
 authors = [
   { name="Desultory", email="[email protected]" },
 ]

readme.md

@@ -142,33 +142,3 @@ If `key` is a dict, the structure will be used to walk the `validate_dict`.
 * `message` Set the vailidation failure message.
 
 Additional arguments exist to set a value to compare found keys against
-
-## Threading
-
-> This is not being maintained, please don't use it, it's just here because I used to use it.
-
-### ZenThread
-
-An extension of the builtin thread that sets results to self.return_value and exceptions to self.exception.
-
-Supports re-starting and looping with the self.loop event.
-
-### @threaded
-
-Runs the wrapped function in a thread when called.
-
-Adds the thread to `_threads` within the object.
-
-If an exception is raised, it will be added to `self._threads` in the form `(thread, exception_queue)`.
-
-### @thread_wrapped('threadname')
-
-Meant to be used with `@add_thread`, the argument is the threadname that function is associated with.
-
-### @add_thread('threadname', 'target_function', 'description')
-
-`@add_thread` decorates a class, and adds `create_{threadname}_thread`, `start_` and `stop_` functions which are used to handle thread management of a `thread_wrapped` function.
-
-Once added, a thread will be added to `self.threads[threadname]`.
-
-

src/zenlib/__init__.py

@@ -1,11 +1,13 @@
 from .logging import ColorLognameFormatter, loggify
-from .util import NoDupFlatList, check_dict, handle_plural, pretty_print, replace_file_line, update_init, walk_dict
+from .types import NoDupFlatList, validatedDataclass
+from .util import check_dict, handle_plural, pretty_print, replace_file_line, update_init, walk_dict
 
 __all__ = [
     "ColorLognameFormatter",
     "loggify",
     "handle_plural",
     "NoDupFlatList",
+    "validatedDataclass",
     "pretty_print",
     "replace_file_line",
     "update_init",

src/zenlib/logging/classlogger.py

@@ -1,7 +1,7 @@
 __author__ = "desultory"
-__version__ = "2.1.0"
+__version__ = "2.2.0"
 
-from .utils import add_handler_if_not_exists, log_init, log_setattr
+from .utils import add_handler_if_not_exists, log_init, handle_additional_logging
 
 from logging import Logger, getLogger
 
@@ -21,14 +21,8 @@ def __init__(self, *args, **kwargs):
         # Log class init if _log_init is passed
         log_init(self, args, kwargs)
 
-        # add setattr logging
-        setattr(self, "__setattr__", log_setattr)
+        # Add logging to _log_setattr if set
+        handle_additional_logging(self, kwargs)
 
         if super().__class__.__class__ is not type:
             super().__init__(*args, **kwargs)
-
-    def __setitem__(self, name, value):
-        """ Add logging to dict setitem. """
-        if hasattr(super(), '__setitem__'):
-            super().__setitem__(name, value)
-            self.logger.log(5, "Setitem '%s' to: %s" % (name, value))

src/zenlib/logging/loggify.py

@@ -1,34 +1,33 @@
 __author__ = "desultory"
-__version__ = "2.4.0"
-
-from .utils import add_handler_if_not_exists, log_init, log_setattr
+__version__ = "2.4.2"
 
 from logging import Logger, getLogger
 
+from zenlib.util import merge_class
+
+from .utils import add_handler_if_not_exists, log_init, handle_additional_logging
+
 
 def loggify(cls):
     class ClassLogger(cls):
         def __init__(self, *args, **kwargs):
             # Get the parent logger from the root if one was not passed
-            parent_logger = kwargs.pop('logger') if isinstance(kwargs.get('logger'), Logger) else getLogger()
+            parent_logger = kwargs.pop("logger") if isinstance(kwargs.get("logger"), Logger) else getLogger()
             # Get a child logger from the parent logger, set self.logger
             self.logger = parent_logger.getChild(cls.__name__)
             # Bump the log level if _log_bump is passed
-            self.logger.setLevel(self.logger.parent.level + kwargs.pop('_log_bump', 0))
+            self.logger.setLevel(self.logger.parent.level + kwargs.pop("_log_bump", 0))
 
             # Add a colored stream handler if one does not exist
             add_handler_if_not_exists(self.logger)
 
             # Log class init if _log_init is passed
             log_init(self, args, kwargs)
 
-            # Add setattr logging
-            setattr(self, "__setattr__", log_setattr)
+            # Add logging to _log_setattr if set
+            handle_additional_logging(self, kwargs)
 
             super().__init__(*args, **kwargs)
 
-    ClassLogger.__name__ = cls.__name__
-    ClassLogger.__module__ = cls.__module__
-    ClassLogger.__doc__ = cls.__doc__
-    ClassLogger.__qualname__ = cls.__qualname__
+    merge_class(cls, ClassLogger, ignored_attributes=["__setattr__"])
     return ClassLogger

src/zenlib/logging/utils.py

@@ -25,7 +25,7 @@ def log_init(self, args, kwargs):
     class_name = self.__class__.__name__
     logger = self.logger
     if not kwargs.pop("_log_init", False):
-        return logger.debug("Init logging disabled for class: %s", class_name)
+        return logger.log(5, "Init logging disabled for class: %s", class_name)
 
     logger.info("Initializing class: %s", class_name)
 
@@ -49,6 +49,11 @@ def log_init(self, args, kwargs):
     if class_version := getattr(self, '__version__', None):
         logger.info("[%s] Class version: %s" % (class_name, class_version))
 
+def handle_additional_logging(self, kwargs):
+    """ Sets __setattr__ to log_setattr if _log_setattr is in the kwargs and set to True """
+    if kwargs.pop("_log_setattr", False):
+        setattr(self, "__setattr__", log_setattr)
+
 def log_setattr(self, name, value):
     """ Logs when an attribute is set """
     super().__setattr__(name, value)