clear/erase console line before logging by default

By default, clear the current terminal line, before printing the log message.
DLR-KI · Jul 29, 2024 · fa240ee · fa240ee
1 parent 80e566b
commit fa240ee
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 3 deletions.
diff --git a/dlr/ki/logging/config.py b/dlr/ki/logging/config.py
@@ -27,7 +27,7 @@ def get_default_logging_dict(log_filepath: Optional[str] = None, ensure_log_dir:
         "formatters": {
             "console_formatter": {
                 "class": "dlr.ki.logging.formatter.colored_console.ColoredConsoleFormatter",
-                "format": "[%(levelcolor)s%(levelname)-8s%(colorreset)s] %(ansi.fg.grey)s[%(name)s][%(filename)s:%(lineno)d]%(ansi.fx.reset)s  %(message)s"  # noqa: E501
+                "format": "%(clearline)s[%(levelcolor)s%(levelname)-8s%(colorreset)s] %(ansi.fg.grey)s[%(name)s][%(filename)s:%(lineno)d]%(ansi.fx.reset)s  %(message)s"  # noqa: E501
             },
             "file_formatter": {
                 "class": "dlr.ki.logging.formatter.term_escape_code.TermEscapeCodeFormatter",

diff --git a/dlr/ki/logging/formatter/colored_console.py b/dlr/ki/logging/formatter/colored_console.py
@@ -5,6 +5,7 @@
 
 from ansi.colour.base import Graphic as AnsiGraphic
 import ansi.color as ansi
+from ansi.cursor import erase_line
 from copy import copy
 from logging import Formatter  # type: ignore [attr-defined]
 from typing import Dict
@@ -50,5 +51,6 @@ def format(self, record):
             ColoredConsoleFormatter.MAPPING["DEBUG"]
         )
         colored_record.colorreset = ansi.fx.reset
+        colored_record.clearline = erase_line() + "\r"
         colored_record.__dict__.update(self.ansi_dict)
         return super().format(colored_record)
diff --git a/examples/logging.conf b/examples/logging.conf
@@ -43,7 +43,7 @@ keys=consoleFormatter,fileFormatter
 
 [formatter_consoleFormatter]
 class=dlr.ki.logging.formatter.colored_console.ColoredConsoleFormatter
-format=[%(levelcolor)s%(levelname)-8s%(colorreset)s] %(ansi.fg.grey)s[%(name)s][%(filename)s:%(lineno)d]%(ansi.fx.reset)s  %(message)s
+format=%(clearline)s[%(levelcolor)s%(levelname)-8s%(colorreset)s] %(ansi.fg.grey)s[%(name)s][%(filename)s:%(lineno)d]%(ansi.fx.reset)s  %(message)s
 
 [formatter_fileFormatter]
 class=dlr.ki.logging.formatter.term_escape_code.TermEscapeCodeFormatter

diff --git a/examples/logging.yml b/examples/logging.yml
@@ -36,7 +36,7 @@ handlers:
 formatters:
   console_formatter:
     class: dlr.ki.logging.formatter.colored_console.ColoredConsoleFormatter
-    format: '[%(levelcolor)s%(levelname)-8s%(colorreset)s] %(ansi.fg.grey)s[%(name)s][%(filename)s:%(lineno)d]%(ansi.fx.reset)s  %(message)s'
+    format: '%(clearline)s[%(levelcolor)s%(levelname)-8s%(colorreset)s] %(ansi.fg.grey)s[%(name)s][%(filename)s:%(lineno)d]%(ansi.fx.reset)s  %(message)s'
   file_formatter:
     class: dlr.ki.logging.formatter.term_escape_code.TermEscapeCodeFormatter
     format: '%(asctime)s [%(levelname)-8s] [%(name)s][%(filename)s:%(lineno)d]  %(message)s'