Merge pull request #1003 from TheDeanLab/logging-updates

Remove repr, cleanup dependency, combine logs

Author: AdvancedImagingUTSW

src/navigate/controller/sub_controllers/stages.py

@@ -39,12 +39,13 @@
 
 # Local Imports
 from navigate.controller.sub_controllers.gui import GUIController
-from navigate.model.devices import log_initialization
+from navigate.tools.decorators import log_initialization
 
 # Logger Setup
 p = __name__.split(".")[1]
 logger = logging.getLogger(p)
 
+
 @log_initialization
 class StageController(GUIController):
     """StageController

src/navigate/log_files/filters.py

@@ -97,10 +97,3 @@ def filter(self, record):
         if record.getMessage().startswith("Spec"):
             return False
         return True
-
-class DebugFilter(logging.Filter):
-    """
-    A custom logging filter to include only DEBUG level messages.
-    """
-    def filter(self, record):
-        return record.levelno == logging.DEBUG

src/navigate/log_files/logging.yml

@@ -9,8 +9,6 @@ filters:
     (): ext://navigate.log_files.filters.PerformanceFilter
   not_performance:
     (): ext://navigate.log_files.filters.NonPerfFilter
-  only_debug:
-    (): ext://navigate.log_files.filters.DebugFilter
 handlers:
   console:
     class: logging.StreamHandler
@@ -30,29 +28,19 @@ handlers:
     level: DEBUG
     formatter: base
     filename: view_controller_debug.log
-    filters: [not_performance, only_debug]
+    filters: [not_performance]
     mode: a
-#  performance:
-#    class: logging.handlers.RotatingFileHandler
-#    level: DEBUG
-#    formatter: base
-#    filename: view_controller_performance.log
-#    filters: [performance_specs]
-#    mode: a
 loggers:
   view:
     level: DEBUG
-#    handlers: [console, vc_info, vc_debug, performance]
     handlers: [console, vc_info, vc_debug]
     propagate: no
   controller:
     level: DEBUG
-#    handlers: [console, vc_info, vc_debug, performance]
     handlers: [console, vc_info, vc_debug]
     propagate: no
   config:
     level: DEBUG
-#    handlers: [console, vc_info, vc_debug, performance]
     handlers: [console, vc_info, vc_debug]
     propagate: no
 

src/navigate/log_files/model_logging.yml

@@ -9,8 +9,6 @@ filters:
     (): ext://navigate.log_files.filters.PerformanceFilter
   not_performance:
     (): ext://navigate.log_files.filters.NonPerfFilter
-  only_debug:
-    (): ext://navigate.log_files.filters.DebugFilter
 handlers:
   console:
     class: logging.StreamHandler
@@ -30,7 +28,7 @@ handlers:
     level: DEBUG
     formatter: base
     filename: model_debug.log
-    filters: [not_performance, only_debug]
+    filters: [not_performance]
     mode: a
   model_error:
     class: logging.handlers.RotatingFileHandler
@@ -39,13 +37,6 @@ handlers:
     filename: model_error.log
     filters: [not_performance]
     mode: a
-#  model_performance:
-#    class: logging.handlers.RotatingFileHandler
-#    level: DEBUG
-#    formatter: base
-#    filename: model_performance.log
-#    filters: [performance_specs]
-#    mode: a
 loggers:
   model:
     level: DEBUG

src/navigate/model/devices/__init__.py

@@ -1,62 +1,17 @@
 """ Hardware devices. """
 
 # Standard library imports
-from functools import wraps
-import logging
-import reprlib
 
 # Third party imports
 
 # Local imports
-# from .daq.synthetic import SyntheticDAQ  # noqa
-# from .camera.synthetic import SyntheticCamera  # noqa
-# from .filter_wheel.synthetic import SyntheticFilterWheel  # noqa
-# from .galvo.synthetic import SyntheticGalvo  # noqa
-# from .remote_focus.synthetic import SyntheticRemoteFocus  # noqa
-# from .shutter.synthetic import SyntheticShutter  # noqa
-# from .stages.synthetic import SyntheticStage  # noqa
-# from .zoom.synthetic import SyntheticZoom  # noqa
-# from .lasers.synthetic import SyntheticLaser  # noqa
-# from .mirrors.synthetic import SyntheticMirror  # noqa
-
-def log_initialization(cls):
-    """Decorator for logging the initialization of a device class.
-
-    Parameters
-    ----------
-    cls : class
-        The class to be logged.
-
-    Returns
-    -------
-    cls : class
-        The class with the logging decorator.
-    """
-    # Set up the reprlib object
-    mod_repr = reprlib.Repr()
-    mod_repr.indent = 4
-    mod_repr.maxstring = 50
-    mod_repr.maxother = 50
-
-    # Get the original __init__ method
-    original_init = cls.__init__
-
-    @wraps(original_init)
-    def new_init(self, *args, **kwargs):
-        module_location = cls.__module__
-        logger = logging.getLogger(module_location.split(".")[1])
-        try:
-            original_init(self, *args, **kwargs)
-            logger.info(f"{mod_repr.repr(cls.__name__)}, "
-                        f"{mod_repr.repr(args)}, "
-                        f"{mod_repr.repr(kwargs)}"
-                        )
-        except Exception as e:
-            logger.error(f"{mod_repr.repr(cls.__name__)} Initialization Failed")
-            logger.error(f"Input args & kwargs: {args}, {kwargs}")
-            logger.error(f"Error: {e}")
-            raise e
-
-    # Replace the original __init__ method with the new one
-    cls.__init__ = new_init
-    return cls
+from .daq.synthetic import SyntheticDAQ  # noqa
+from .camera.synthetic import SyntheticCamera  # noqa
+from .filter_wheel.synthetic import SyntheticFilterWheel  # noqa
+from .galvo.synthetic import SyntheticGalvo  # noqa
+from .remote_focus.synthetic import SyntheticRemoteFocus  # noqa
+from .shutter.synthetic import SyntheticShutter  # noqa
+from .stages.synthetic import SyntheticStage  # noqa
+from .zoom.synthetic import SyntheticZoom  # noqa
+from .lasers.synthetic import SyntheticLaser  # noqa
+from .mirrors.synthetic import SyntheticMirror  # noqa

src/navigate/model/devices/camera/base.py

@@ -39,12 +39,13 @@
 
 # Local Imports
 from navigate.config import get_navigate_path
-from navigate.model.devices import log_initialization
+from navigate.tools.decorators import log_initialization
 
 # Logger Setup
 p = __name__.split(".")[1]
 logger = logging.getLogger(p)
 
+
 @log_initialization
 class CameraBase:
     """CameraBase - Parent camera class."""
@@ -163,8 +164,9 @@ def get_offset_variance_maps(self):
                 os.path.join(map_path, f"{serial_number}_var.tiff")
             )
         except FileNotFoundError:
-            logger.info(f"{str(self)}, Offset or variance map not found in"
-                        f" {map_path}")
+            logger.info(
+                f"{str(self)}, Offset or variance map not found in {map_path}"
+            )
             self._offset, self._variance = None, None
         return self._offset, self._variance
 

src/navigate/model/devices/camera/hamamatsu.py

@@ -37,7 +37,8 @@
 
 # Local Imports
 from navigate.model.devices.camera.base import CameraBase
-from navigate.model.devices import log_initialization
+from navigate.tools.decorators import log_initialization
+
 # Logger Setup
 p = __name__.split(".")[1]
 logger = logging.getLogger(p)

src/navigate/model/devices/camera/photometrics.py

@@ -41,7 +41,7 @@
 
 # Local Imports
 from navigate.model.devices.camera.base import CameraBase
-from navigate.model.devices import log_initialization
+from navigate.tools.decorators import log_initialization
 
 # Logger Setup
 p = __name__.split(".")[1]

src/navigate/model/devices/camera/synthetic.py

@@ -42,7 +42,7 @@
 # Local Imports
 from navigate.model.analysis import camera
 from navigate.model.devices.camera.base import CameraBase
-from navigate.model.devices import log_initialization
+from navigate.tools.decorators import log_initialization
 
 # Logger Setup
 p = __name__.split(".")[1]

src/navigate/model/devices/daq/base.py

@@ -37,12 +37,13 @@
 
 # Local Imports
 from navigate.model.waveforms import camera_exposure
-from navigate.model.devices import log_initialization
+from navigate.tools.decorators import log_initialization
 
 # Logger Setup
 p = __name__.split(".")[1]
 logger = logging.getLogger(p)
 
+
 @log_initialization
 class DAQBase:
     """DAQBase - Parent class for Data Acquisition (DAQ) classes."""