Add plain mode for logging

Author: whoisarpit

patchwork/app.py

@@ -144,20 +144,22 @@ def sigint_handler(signum, frame):
 @click.option("patched_api_key", "--patched_api_key", help="API key to use with the patched.codes service.")
 @click.option("disable_telemetry", "--disable_telemetry", is_flag=True, help="Disable telemetry.", default=False)
 @click.option("debug", "--debug", is_flag=True, help="Enable debug mode.", default=False)
+@click.option("plain", "--plain", is_flag=True, help="Enable plain mode (no panel).", default=False)
 def cli(
     log: str,
     patchflow: str,
     opts: list[str],
     config: str | None,
     output: str | None,
+    plain: bool,
     data_format: str,
     patched_api_key: str | None,
     disable_telemetry: bool,
     debug: bool,
 ):
     setup_cli()
 
-    init_cli_logger(log)
+    init_cli_logger(log, plain)
 
     if "::" in patchflow:
         module_path, _, patchflow_name = patchflow.partition("::")
@@ -167,7 +169,7 @@ def cli(
 
     possbile_module_paths = deque((module_path,))
 
-    panel = logger.panel("Initializing Patchwork CLI") if debug else nullcontext()
+    panel = nullcontext() if plain or not debug else logger.panel("Initializing Patchwork CLI")
 
     with panel:
         inputs = {}
@@ -227,7 +229,7 @@ def cli(
             # treat --key=value as a key-value pair
             inputs[key] = value
 
-    patchflow_panel = nullcontext() if debug else logger.panel(f"Patchflow {patchflow} inputs")
+    patchflow_panel = nullcontext() if plain or not debug else logger.panel(f"Patchflow {patchflow} inputs")
 
     with patchflow_panel as _:
         if debug is True:

patchwork/logger.py

@@ -18,7 +18,7 @@
 from patchwork.managed_files import HOME_FOLDER, LOG_FILE
 
 # Create a global console object
-console = Console()
+console = Console(force_terminal=True, no_color=False)
 
 # Add TRACE level to logging
 logging.TRACE = logging.DEBUG - 1
@@ -39,10 +39,11 @@ def evict_null_handler():
 
 
 class TerminalHandler(RichHandler):
-    def __init__(self, log_level: str):
+    def __init__(self, log_level: str, plain: bool):
+        self.plain = plain
         super().__init__(
             console=console,
-            rich_tracebacks=True,
+            rich_tracebacks=not plain,
             tracebacks_suppress=[click],
             show_time=False,
             show_path=False,
@@ -95,22 +96,25 @@ def deregister_progress_bar(self):
     @contextlib.contextmanager
     def panel(self, title: str):
         global console
-        self.__panel_lines = []
-        self.__panel_title = title
-        self.__panel = Panel("", title=title)
-        renderables = [self.__panel]
-        if self.__progress_bar is not None:
-            renderables.append(self.__progress_bar)
-
-        self.__live = Live(Group(*renderables), console=console, vertical_overflow="visible")
-        try:
-            self.__live.start()
+        if self.plain:
             yield
-        except Exception as e:
-            raise e
-        finally:
-            self.__reset_live()
-            self.console.print("\n")
+        else:
+            self.__panel_lines = []
+            self.__panel_title = title
+            self.__panel = Panel("", title=title)
+            renderables = [self.__panel]
+            if self.__progress_bar is not None:
+                renderables.append(self.__progress_bar)
+
+            self.__live = Live(Group(*renderables), console=console, vertical_overflow="visible")
+            try:
+                self.__live.start()
+                yield
+            except Exception as e:
+                raise e
+            finally:
+                self.__reset_live()
+                self.console.print("\n")
 
     def emit(self, record: logging.LogRecord) -> None:
         markup = getattr(record, "markup", None)
@@ -126,7 +130,8 @@ def emit(self, record: logging.LogRecord) -> None:
         if self.__panel is not None:
             self.__emit_panel(record)
         else:
-            setattr(record, "markup", True)
+            if not self.plain:
+                setattr(record, "markup", True)
             super().emit(record)
 
     def __emit_panel(self, record: logging.LogRecord) -> None:
@@ -143,7 +148,7 @@ def inner(record: logging.LogRecord) -> bool:
         return inner
 
 
-def init_cli_logger(log_level: str) -> logging.Logger:
+def init_cli_logger(log_level: str, plain: bool) -> logging.Logger:
     global logger
 
     evict_null_handler()
@@ -158,7 +163,7 @@ def init_cli_logger(log_level: str) -> logging.Logger:
     except FileNotFoundError:
         logger.error(f"Unable to create log file: {LOG_FILE}")
 
-    th = TerminalHandler(log_level.upper())
+    th = TerminalHandler(log_level.upper(), plain)
     logger.addHandler(th)
     setattr(logger, "panel", th.panel)
     setattr(logger, "register_progress_bar", th.register_progress_bar)