To improve the usefulness of the mvLogger for use with the logging module

dearpygui_ext/logger.py

@@ -1,10 +1,14 @@
+import logging
+import queue
+from logging.handlers import QueueHandler
+
 import dearpygui.dearpygui as dpg
 
 class mvLogger:
+    """Class to show log mesages raised by the logging module."""
 
     def __init__(self, parent=None):
-
-        self.log_level = 0
+
         self._auto_scroll = True
         self.filter_id = None
         if parent:
@@ -18,7 +22,7 @@ def __init__(self, parent=None):
             dpg.add_checkbox(label="Auto-scroll", default_value=True, callback=lambda sender:self.auto_scroll(dpg.get_value(sender)))
             dpg.add_button(label="Clear", callback=lambda: dpg.delete_item(self.filter_id, children_only=True))
 
-        dpg.add_input_text(label="Filter", callback=lambda sender: dpg.set_value(self.filter_id, dpg.get_value(sender)), 
+        dpg.add_input_text(label="Filter", callback=lambda sender: dpg.set_value(self.filter_id, dpg.get_value(sender)),
                     parent=self.window_id)
         self.child_id = dpg.add_child_window(parent=self.window_id, autosize_x=True, autosize_y=True)
         self.filter_id = dpg.add_filter_set(parent=self.child_id)
@@ -41,7 +45,7 @@ def __init__(self, parent=None):
 
         with dpg.theme() as self.error_theme:
             with dpg.theme_component(0):
-                dpg.add_theme_color(dpg.mvThemeCol_Text, (255, 0, 0, 255))
+                dpg.add_theme_color(dpg.mvThemeCol_Text, (220, 128, 64, 255))
 
         with dpg.theme() as self.critical_theme:
             with dpg.theme_component(0):
@@ -51,59 +55,70 @@ def auto_scroll(self, value):
         self._auto_scroll = value
 
     def _log(self, message, level):
-
-        if level < self.log_level:
-            return
+        """Take in a log message to show in DPG."""
 
         self.count+=1
 
         if self.count > self.flush_count:
             self.clear_log()
 
-        theme = self.info_theme
-
-        if level == 0:
-            message = "[TRACE]\t\t" + message
-            theme = self.trace_theme
-        elif level == 1:
-            message = "[DEBUG]\t\t" + message
-            theme = self.debug_theme
-        elif level == 2:
-            message = "[INFO]\t\t" + message
-        elif level == 3:
-            message = "[WARNING]\t\t" + message
-            theme = self.warning_theme
-        elif level == 4:
-            message = "[ERROR]\t\t" + message
-            theme = self.error_theme
-        elif level == 5:
-            message = "[CRITICAL]\t\t" + message
-            theme = self.critical_theme
+        levelname = logging._levelToName[level].lower()
+        logtheme = getattr(self, f'{levelname}_theme')
 
         new_log = dpg.add_text(message, parent=self.filter_id, filter_key=message)
-        dpg.bind_item_theme(new_log, theme)
+        dpg.bind_item_theme(new_log, logtheme)
         if self._auto_scroll:
             scroll_max = dpg.get_y_scroll_max(self.child_id)
             dpg.set_y_scroll(self.child_id, -1.0)
 
-    def log(self, message):
-        self._log(message, 0)
+    def clear_log(self):
+        dpg.delete_item(self.filter_id, children_only=True)
+        self.count = 0
 
-    def log_debug(self, message):
-        self._log(message, 1)
 
-    def log_info(self, message):
-        self._log(message, 2)
+if __name__ == "__main__":
 
-    def log_warning(self, message):
-        self._log(message, 3)
+    logger = logging.getLogger(__name__)
+    logger.setLevel(logging.DEBUG)
 
-    def log_error(self, message):
-        self._log(message, 4)
+    log_queue = queue.Queue(1000)
+    queue_handler = QueueHandler(log_queue)
+    queue_formatter = logging.Formatter('%(levelname)8s: %(message)s')
+    queue_handler.setFormatter(queue_formatter)
+    queue_handler.setLevel(logging.NOTSET)
 
-    def log_critical(self, message):
-        self._log(message, 5)
+    console_handler = logging.StreamHandler()
+    console_formatter = logging.Formatter('%(levelname)8s: %(message)s')
+    console_handler.setFormatter(console_formatter)
+    console_handler.setLevel(logging.WARNING)
 
-    def clear_log(self):
-        dpg.delete_item(self.filter_id, children_only=True)
-        self.count = 0
+    logger.addHandler(queue_handler)
+    logger.addHandler(console_handler)
+
+    dpg.create_context()
+
+    dpg.create_viewport()
+
+
+    logger.debug("We can log to a debug level.")
+    logger.info("We can log to an info level.")
+    logger.warning("We can log to a warning level.")
+    logger.error("We can log to a error level.")
+    logger.critical("We can log to a critical level.")
+
+    dpglogger = mvLogger()
+
+    dpg.setup_dearpygui()
+
+    dpg.show_viewport()
+    def callback_log():
+        """Pass messages from logging queue to dpg logger."""
+        if not log_queue.empty():
+            log_copy = log_queue.get()
+            dpglogger._log(log_copy.message, log_copy.levelno)
+
+    while dpg.is_dearpygui_running():
+        callback_log()
+        dpg.render_dearpygui_frame()
+
+    dpg.destroy_context()