use IGNORE_FORMATTER as a flag

Author: rkoschmitzky

README.md

@@ -76,15 +76,15 @@ As soon as your handler was attached, the log records will be catched within a b
 | `LEVEL_COLORS`          | `dict`    | A dictionary with corresponding colors to the defined `LOG_LEVELS`. Expects RGB values from 0-255 and an optional alpha value from 0-100. default: `        "debug": (255, 255, 255, 100), "info": (204, 236, 242, 100), "warning": (152, 210, 217, 100), "error": (223, 57, 57, 100), "critical": (182, 60, 66, 100)}`
 | `INITIAL_FILTER_REGEX`  | `str`     | A regular expression that will be used when launching the logbook.
 | `INITIAL_COLORING`      | `bool`    | If `True` coloring mode will be enabled by default when launching the logbook.
-| `IGNORE_FORMATTER`      | `bool`    | If a formatter was set to the handler, it can be explicitly ignored by setting this to `True`. This means, the formatter will not be considered as the recorditem's text. Instead it will only use the `LogRecord.msg` directly.
 | `EXCEPTION_FORMATTER`   | `logging.Formatter` |  A formatter instance that will be used to format the `exc_info` tuple that will be dispayed inside the ToolTips of recorditems.
 
 | Flag                      | Description
 |:--------------------------|:-----------
 | `COLORING_TEXT`           | When given the item's foreground color will be set instead of the background color.
+| `IGNORE_FORMATTER`        | If a formatter was set to the handler, it can be explicitly ignored by setting using this. It means, the formatter will not be considered as the recorditem's text. Instead it will only use the `LogRecord.getMessage()` directly.
 | `INITIAL_COLORING`        | When given the `Coloring` option will be checked by default when launching the logbook. 
 | `READABLE_TEXT_COLOR`     | When given and `COLORING_TEXT` is NOT set it sets an automatic item foreground color based on the background color for better readability.
-| `RE_IGNORE_CASE`          | When given the `Ignore Case` option will be checked by default when launching the logbook. 
+| `RE_IGNORE_CASE`          | When given the `Ignore Case` option will be checked by default when launching the logbook.
 
 This examples activates coloring of item's foreground color instead of background color.
 ```python
@@ -94,7 +94,7 @@ LogbookWidget.FLAGS = LogbookWidget.Flags.INITIAL_COLORING | LogbookWidget.Flags
 <img src="https://github.com/rkoschmitzky/logbook/blob/master/.graphics/text_coloring.gif" width="400">
 
 #### Recorditems Formatting
-By default the logbook handlers doesn't use a formatting. It will use the `LogRecord.msg` attribute as the recorditem's text.
+By default, the logbook handlers doesn't use a formatter. It will use the `LogRecord.getMessage()` attribute as the recorditem's text.
 A formatter can be set easily by using the `handler` property on the logbook instance.
 
 ```python

widget.py

@@ -94,10 +94,18 @@ class LogbookWidget(QtWidgets.QWidget):
     """ A simple widget that makes log reading more pleasant. """
 
     class Flags:
+        # sets the `Coloring` checkbox on launch
         INITIAL_COLORING = 2**1
+        # defines whether background color or foreground color (text) of an item will be set
         COLORING_TEXT = 2**2
+        # if background color will be set this automatically sets a foreground color for better readability
         READABLE_TEXT_COLOR = 2**3
+        # sets the `Ignore Case` checkbox on launch
         RE_IGNORE_CASE = 2**4
+        # If a formatter was set to the handler, it can be explicitly ignored.
+        # This means, the formatter will not be considered as the recorditem's text.
+        # Instead it will only use the LogRecord.getMessage() directly.
+        IGNORE_FORMATTER = 2**5
 
     FLAGS = 0
     LABEL_WIDTH = 70
@@ -125,7 +133,6 @@ class Flags:
         LOG_LEVELS[4]: (182, 60, 66, 100)
     }
     INITIAL_FILTER_REGEX = r""
-    IGNORE_FORMATTER = False
     EXCEPTION_FORMATTER = logging.Formatter()
 
     _handler = LogbookHandler()
@@ -170,6 +177,10 @@ def _use_readable_text_coloring(self):
     def _use_re_ignore_case(self):
         return (self.FLAGS & self.Flags.RE_IGNORE_CASE) > 0
 
+    @property
+    def _ignore_formatter(self):
+        return (self.FLAGS & self.Flags.IGNORE_FORMATTER) > 0
+
     @classmethod
     def _validate_levels(cls):
         """ ensure we allow flexible level addition but give proper guidance """
@@ -432,7 +443,7 @@ def add_record(self, log_record):
 
         def _add_item():
 
-            if self.IGNORE_FORMATTER:
+            if self._ignore_formatter:
                 formatter = None
             else:
                 formatter = self.handler.formatter