ConsoleBase now defines a default logging formatter

This is used unless logging_handlers defines a formatter.
Enable not specifying a level via logging_handlers.

Author: MHendricks

examples/output_console.py

@@ -54,6 +54,10 @@ def __init__(self, parent=None):
         # See this method for how to configure uiAllLog to show all logging
         # messages of all levels
         self.all_logging_level_warning()
+        # Configure the default logging formatter for this widget.
+        self.uiAllLog.logging_formatter_str = (
+            "<<%(levelname)s| %(name)s: Line: %(lineno)d>> %(message)s"
+        )
 
         # Configure uiSelectLog to show logging messages from specific handlers
         self.uiSelectLog.logging_handlers = [
@@ -80,6 +84,7 @@ def all_logging_level_debug(self):
             "root,level=DEBUG",
             "PyQt5,level=CRITICAL",
             "PyQt6,level=CRITICAL",
+            "logger_b,fmt=[%(levelname)s:%(name)s] %(message)s",
         ]
 
     def all_logging_level_warning(self):
@@ -92,6 +97,8 @@ def all_logging_level_warning(self):
             # logging messages created when first showing the PrEditor instance.
             "PyQt5,level=CRITICAL",
             "PyQt6,level=CRITICAL",
+            # Replace the default logging_formatter_str formatter only for logger_b
+            "logger_b,fmt=[%(levelname)s:%(name)s] %(message)s",
         ]
 
     def clear_all(self):

examples/output_console.ui

@@ -77,7 +77,11 @@
        </property>
        <layout class="QVBoxLayout" name="verticalLayout_4">
         <item>
-         <widget class="OutputConsole" name="uiSelectLog"/>
+         <widget class="OutputConsole" name="uiSelectLog">
+          <property name="logging_formatter_str" stdset="0">
+           <string>&lt;&lt;%(levelname)s| %(name)s: Line: %(lineno)d&gt;&gt; %(message)s</string>
+          </property>
+         </widget>
         </item>
        </layout>
       </widget>

preditor/gui/console_base.py

@@ -8,7 +8,7 @@
 from typing import Optional
 
 from Qt import QtCompat
-from Qt.QtCore import Qt
+from Qt.QtCore import Property, Qt
 from Qt.QtGui import (
     QColor,
     QFontMetrics,
@@ -21,7 +21,7 @@
 
 from .. import instance, resourcePath, stream
 from ..constants import StreamType
-from ..stream.console_handler import HandlerInfo
+from ..stream.console_handler import FormatterDescriptor, HandlerInfo
 from ..utils.cute import QtPropertyInit
 from .codehighlighter import CodeHighlighter
 from .loggerwindow import LoggerWindow
@@ -31,6 +31,12 @@
 class ConsoleBase(QTextEdit):
     """Base class for a text widget used to show stdout/stderr writes."""
 
+    _default_format = (
+        '%(levelname)s %(module)s.%(funcName)s line:%(lineno)d - %(message)s'
+    )
+    logging_formatter = FormatterDescriptor(default=_default_format)
+    """Used to format logging messages if logging_handlers doesn't define it."""
+
     def __init__(self, parent: QWidget, controller: Optional[LoggerWindow] = None):
         super().__init__(parent)
         self.controller = controller
@@ -597,6 +603,8 @@ def write_log(self, log_data, stream_type=StreamType.CONSOLE):
         formatter = handler
         if logging_info.formatter:
             formatter = logging_info.formatter
+        elif self.logging_formatter:
+            formatter = self.logging_formatter
         msg = formatter.format(record)
         self.write(f'{msg}\n', stream_type=stream_type)
 
@@ -789,6 +797,18 @@ def _write(self, msg, stream_type=StreamType.STDOUT):
     stdoutColor = QtPropertyInit('_stdoutColor', QColor(17, 154, 255))
     stringColor = QtPropertyInit('_stringColor', QColor(255, 128, 0))
 
+    @Property(str)
+    def logging_formatter_str(self):
+        """QtProperty exposing logging_formatter as a string for QtDesigner."""
+        try:
+            return self.logging_formatter._fmt
+        except AttributeError:
+            return ""
+
+    @logging_formatter_str.setter  # type: ignore[no-redef]
+    def logging_formatter_str(self, value):
+        self.logging_formatter = value
+
     logging_handlers = QtPropertyInit(
         '_logging_handlers', list, callback=init_logging_handlers, typ="QStringList"
     )

preditor/stream/console_handler.py

@@ -37,7 +37,9 @@ class LoggingLevelDescriptor(DefaultDescriptor):
     _level_conversion = logging.Handler()
 
     def __set__(self, obj, value):
-        if value is not None:
+        if value is None:
+            value = logging.NOTSET
+        else:
             try:
                 value = int(value)
             except ValueError:
@@ -57,6 +59,11 @@ class FormatterDescriptor(DefaultDescriptor):
     If a string is passed it will be cast into a Formatter instance.
     """
 
+    def __init__(self, *, ident=None, default=None):
+        if isinstance(default, str):
+            default = logging.Formatter(default)
+        super().__init__(ident=ident, default=default)
+
     def __set__(self, obj, value):
         if isinstance(value, str):
             value = logging.Formatter(value)
@@ -65,28 +72,23 @@ def __set__(self, obj, value):
 
 @dataclass
 class HandlerInfo:
-    _default_format = (
-        '%(levelname)s %(module)s.%(funcName)s line:%(lineno)d - %(message)s'
-    )
     name: str
     level: LoggingLevelDescriptor = LoggingLevelDescriptor()
     plugin: Optional[str] = "Console"
-    formatter: FormatterDescriptor = FormatterDescriptor(default=_default_format)
+    formatter: FormatterDescriptor = FormatterDescriptor()
 
     _attr_names = {"plug": "plugin", "fmt": "formatter", "lvl": "level"}
 
     def __post_init__(self):
-        # Process self.name as a string if level is not defined
-        if self.level is None:
-            # Clear self.name so you can define omit name to define a root logger
-            # For example passing "level=INFO" would set the root logger to info.
-            name = self.name
-            self.name = ""
-
-            parts = self.__to_parts__(name)
-            for i, value in enumerate(parts):
-                key, _value = self.__parse_setting__(value, i)
-                setattr(self, key, _value)
+        # Clear self.name so you can define omit name to define a root logger
+        # For example passing "level=INFO" would set the root logger to info.
+        name = self.name
+        self.name = ""
+
+        parts = self.__to_parts__(name)
+        for i, value in enumerate(parts):
+            key, _value = self.__parse_setting__(value, i)
+            setattr(self, key, _value)
 
     @classmethod
     def __to_parts__(cls, value):

tests/test_stream.py

@@ -4,6 +4,7 @@
 import logging
 import sys
 import traceback
+from logging import NOTSET
 
 import pytest
 
@@ -236,19 +237,22 @@ def test_install_to_std():
 @pytest.mark.parametrize(
     "input,check",
     (
-        (["preditor.cli"], ["preditor.cli", None, "Console", None]),
+        (["preditor.cli"], ["preditor.cli", NOTSET, "Console", None]),
         (["preditor.cli,INFO"], ["preditor.cli", 20, "Console", None]),
         (["preditor.prefs,30"], ["preditor.prefs", 30, "Console", None]),
         (["preditor.cli,lvl=30"], ["preditor.cli", 30, "Console", None]),
         (["preditor.cli,level=WARNING"], ["preditor.cli", 30, "Console", None]),
         # Test escaping and complex formatter strings
-        (["preditor,formatter=%(msg)s"], ["preditor", None, "Console", "%(msg)s"]),
-        (["preditor,fmt=%(msg)s,POST"], ["preditor", None, "Console", "%(msg)s,POST"]),
-        ([r"preditor,fmt=M\=%(msg)s"], ["preditor", None, "Console", "M=%(msg)s"]),
-        ([r"preditor,fmt=M\\=%(msg)s"], ["preditor", None, "Console", r"M\=%(msg)s"]),
+        (["preditor,formatter=%(msg)s"], ["preditor", NOTSET, "Console", "%(msg)s"]),
+        (
+            ["preditor,fmt=%(msg)s,POST"],
+            ["preditor", NOTSET, "Console", "%(msg)s,POST"],
+        ),
+        ([r"preditor,fmt=M\=%(msg)s"], ["preditor", NOTSET, "Console", "M=%(msg)s"]),
+        ([r"preditor,fmt=M\\=%(msg)s"], ["preditor", NOTSET, "Console", r"M\=%(msg)s"]),
         (
             [r"preditor,fmt=M\=%(msg)s,POST"],
-            ["preditor", None, "Console", "M=%(msg)s,POST"],
+            ["preditor", NOTSET, "Console", "M=%(msg)s,POST"],
         ),
         (
             [r"plug=PrEditor,fmt=A\=%(msg)sG\=G,level=WARNING,name=six"],
@@ -272,11 +276,11 @@ def test_handler_info(input, check):
     assert hi.name == check[0]
     assert hi.level == check[1]
     assert hi.plugin == check[2]
-    assert isinstance(hi.formatter, logging.Formatter)
     if check[3] is None:
-        # Treat None as the default formatter
-        check[3] = HandlerInfo._default_format
-    assert hi.formatter._fmt == check[3]
+        assert hi.formatter is None
+    else:
+        assert isinstance(hi.formatter, logging.Formatter)
+        assert hi.formatter._fmt == check[3]
 
 
 class TestShellPrint: