Add color param to console log methods so file logs stay plain text

Author: pedjaradenkovic

codeplain_REST_api.py

@@ -5,6 +5,7 @@
 from requests.exceptions import ConnectionError, RequestException, Timeout
 
 import plain2code_exceptions
+from plain2code_console import RETRY_COLOR
 from plain2code_state import RunState
 
 MAX_RETRIES = 4
@@ -68,8 +69,9 @@ def _handle_retry_logic(
         if attempt < num_retries:
             if not silent:
                 self.console.debug(
-                    f"[#FFB454]↻ {connection_error_type} on attempt {attempt + 1}/{num_retries + 1}: {error}. "
-                    f"Retrying in {retry_delay} seconds...[/#FFB454]"
+                    f"↻ {connection_error_type} on attempt {attempt + 1}/{num_retries + 1}: {error}. "
+                    f"Retrying in {retry_delay} seconds...",
+                    color=RETRY_COLOR,
                 )
             time.sleep(retry_delay)
             # Exponential backoff

plain2code_console.py

@@ -11,6 +11,12 @@
 
 logger = logging.getLogger(plain2code_logger.LOGGER_NAME)
 
+# Colors for log messages, applied by the terminal and the TUI via the "color"
+# parameter of the console methods. The file log always receives plain text.
+RETRY_COLOR = "#FFB454"  # Amber
+SUCCESS_COLOR = "#79FC96"  # Green
+MUTED_COLOR = "#888888"  # Grey
+
 
 class Plain2CodeConsole(Console):
     INFO_STYLE = Style()
@@ -33,30 +39,37 @@ def __init__(self):
             logger.debug(f"Exception: {e}")
             self.llm_encoding = None
 
-    def info(self, *args, **kwargs):
-        logger.info(" ".join(map(str, args)))
-        super().print(*args, **kwargs, style=self.INFO_STYLE)
+    def info(self, *args, color=None, **kwargs):
+        self._log_and_print(logging.INFO, self.INFO_STYLE, args, color, kwargs)
 
-    def warning(self, *args, **kwargs):
-        logger.warning(" ".join(map(str, args)))
-        super().print(*args, **kwargs, style=self.WARNING_STYLE)
+    def warning(self, *args, color=None, **kwargs):
+        self._log_and_print(logging.WARNING, self.WARNING_STYLE, args, color, kwargs)
 
-    def error(self, *args, **kwargs):
-        logger.error(" ".join(map(str, args)))
-        super().print(*args, **kwargs, style=self.ERROR_STYLE)
+    def error(self, *args, color=None, **kwargs):
+        self._log_and_print(logging.ERROR, self.ERROR_STYLE, args, color, kwargs)
 
-    def input(self, *args, **kwargs):
+    def input(self, *args, color=None, **kwargs):
         # We also log input as info so it shows in the toggled view
-        logger.info(" ".join(map(str, args)))
-        super().print(*args, **kwargs, style=self.INPUT_STYLE)
+        self._log_and_print(logging.INFO, self.INPUT_STYLE, args, color, kwargs)
+
+    def output(self, *args, color=None, **kwargs):
+        self._log_and_print(logging.INFO, self.OUTPUT_STYLE, args, color, kwargs)
 
-    def output(self, *args, **kwargs):
-        logger.info(" ".join(map(str, args)))
-        super().print(*args, **kwargs, style=self.OUTPUT_STYLE)
+    def debug(self, *args, color=None, **kwargs):
+        self._log_and_print(logging.DEBUG, self.DEBUG_STYLE, args, color, kwargs)
 
-    def debug(self, *args, **kwargs):
-        logger.debug(" ".join(map(str, args)))
-        super().print(*args, **kwargs, style=self.DEBUG_STYLE)
+    def _log_and_print(self, level, base_style, args, color, kwargs):
+        """Log the plain message text, then print it styled to the terminal.
+
+        The optional color is applied by the terminal (via style) and forwarded to
+        the TUI as the "log_color" record attribute; the file log stays plain text.
+        """
+        logger.log(level, " ".join(map(str, args)), extra={"log_color": color})
+        style = base_style + Style(color=color) if color else base_style
+        # Log messages must render exactly as logged: don't interpret square brackets
+        # in interpolated content (error texts, file names) as Rich markup.
+        kwargs.setdefault("markup", False)
+        super().print(*args, **kwargs, style=style)
 
     def print_list(self, items, style=None):
         for item in items:
@@ -130,9 +143,7 @@ def print_resources(self, resources_list, linked_resources):
         for resource_name in resources_list:
             if resource_name["target"] in linked_resources:
                 file_tokens = self._count_tokens(linked_resources[resource_name["target"]])
-                self.debug(
-                    f"- {resource_name['text']} [#4169E1]({resource_name['target']}, {file_tokens} tokens)[/#4169E1]"
-                )
+                self.debug(f"- {resource_name['text']} ({resource_name['target']}, {file_tokens} tokens)")
 
         self.input()
 

plain2code_events.py

@@ -44,6 +44,7 @@ class LogMessageEmitted(BaseEvent):
     level: str  # e.g., "INFO", "DEBUG", "ERROR"
     message: str  # The actual log message
     timestamp: str  # Formatted timestamp
+    log_color: Optional[str] = None  # Color for the message (e.g. "#FFB454"); the file log stays plain text
 
 
 @dataclass

plain2code_logger.py

@@ -88,6 +88,7 @@ def emit(self, record):
                 level=record.levelname,
                 message=record.getMessage(),
                 timestamp=timestamp,
+                log_color=getattr(record, "log_color", None),
             )
             self.event_bus.publish(event)
         except RuntimeError:

render_machine/actions/create_dist.py

@@ -1,7 +1,7 @@
 from typing import Any
 
 import file_utils
-from plain2code_console import console
+from plain2code_console import SUCCESS_COLOR, console
 from render_machine.actions.base_action import BaseAction
 from render_machine.render_context import RenderContext
 
@@ -21,6 +21,6 @@ def execute(self, render_context: RenderContext, _previous_action_payload: Any |
                 render_context.conformance_tests.get_module_conformance_tests_folder(render_context.module_name),
                 render_context.conformance_tests_dest,
             )
-        console.info(f"[#79FC96]Render of module {render_context.module_name} completed successfully.[/#79FC96]")
+        console.info(f"✓ Render of module {render_context.module_name} completed successfully.", color=SUCCESS_COLOR)
 
         return self.SUCCESSFUL_OUTCOME, None

render_machine/actions/exit_with_error.py

@@ -20,7 +20,8 @@ def execute(self, render_context: RenderContext, previous_action_payload: Any |
 
         if render_context.frid_context is not None:
             console.info(
-                f"To continue rendering from the last successfully rendered functionality, provide the [red]--render-from {render_context.frid_context.frid}[/red] flag."
+                f"To continue rendering from the last successfully rendered functionality, "
+                f"provide the --render-from {render_context.frid_context.frid} flag."
             )
 
         if render_context.run_state.render_id is not None:

render_machine/actions/fix_conformance_test.py

@@ -4,7 +4,7 @@
 import file_utils
 import plain_spec
 from memory_management import MemoryManager
-from plain2code_console import console
+from plain2code_console import RETRY_COLOR, console
 from plain2code_exceptions import InternalClientError
 from render_machine.actions.base_action import BaseAction
 from render_machine.implementation_code_helpers import ImplementationCodeHelpers
@@ -144,7 +144,9 @@ def execute(self, render_context: RenderContext, previous_action_payload: Any |
             render_context.conformance_tests_running_context.conflicting_module_name = current_testing_module_name
             render_context.conformance_tests_running_context.conflicting_frid = current_testing_frid
             console.info(
-                f"[#FFB454]Potential conflicting functionalities detected while fixing conformance tests for functionality {current_testing_frid} in module {current_testing_module_name}.[/#FFB454]"
+                f"↻ Potential conflicting functionalities detected while fixing conformance tests "
+                f"for functionality {current_testing_frid} in module {current_testing_module_name}.",
+                color=RETRY_COLOR,
             )
 
         if issue_reason_code == self.ISSUE_REASON_CODE_CONFORMANCE_TESTS:

render_machine/actions/render_functional_requirement.py

@@ -3,7 +3,7 @@
 import file_utils
 import render_machine.render_utils as render_utils
 from memory_management import MemoryManager
-from plain2code_console import console
+from plain2code_console import RETRY_COLOR, console
 from plain2code_exceptions import FunctionalRequirementTooComplex
 from render_machine.actions.base_action import BaseAction
 from render_machine.implementation_code_helpers import ImplementationCodeHelpers
@@ -28,8 +28,9 @@ def execute(self, render_context: RenderContext, _previous_action_payload: Any |
 
         if render_context.frid_context.functional_requirement_render_attempts > 1:
             console.info(
-                f"[#FFB454]↻ Unittests could not be fixed after rendering the functionality. "
-                f"Restarting rendering functionality {render_context.frid_context.frid} from scratch.[/#FFB454]"
+                f"↻ Unittests could not be fixed after rendering the functionality. "
+                f"Restarting rendering functionality {render_context.frid_context.frid} from scratch.",
+                color=RETRY_COLOR,
             )
 
         render_utils.revert_changes_for_frid(render_context)

render_machine/render_context.py

@@ -7,7 +7,7 @@
 import plain_spec
 from codeplain_REST_api import CodeplainAPI
 from event_bus import EventBus
-from plain2code_console import console
+from plain2code_console import RETRY_COLOR, console
 from plain2code_events import RenderContextSnapshot
 from plain2code_state import RunState
 from plain_modules import PlainModule
@@ -283,9 +283,10 @@ def _on_unit_test_limit_exceeded_in_conformance_tests(self):
             self.dispatch_error(error_msg)
         else:
             console.info(
-                f"[#FFB454]↻ Failed to adjust the unit tests after implementation code was updated while fixing the "
+                f"↻ Failed to adjust the unit tests after implementation code was updated while fixing the "
                 f"conformance tests for functionality {self.frid_context.frid}. "
-                f"Restarting rendering the functionality {self.frid_context.frid} from scratch.[/#FFB454]"
+                f"Restarting rendering the functionality {self.frid_context.frid} from scratch.",
+                color=RETRY_COLOR,
             )
             self.machine.dispatch(triggers.RESTART_FRID_PROCESSING)
 

render_machine/render_utils.py

@@ -14,7 +14,7 @@
 import file_utils
 import git_utils
 import plain_spec
-from plain2code_console import console
+from plain2code_console import MUTED_COLOR, RETRY_COLOR, SUCCESS_COLOR, console
 from plain2code_exceptions import RenderCancelledError
 
 SCRIPT_EXECUTION_TIMEOUT = 120
@@ -178,24 +178,30 @@ def _drain_stdout() -> None:
                 temp_file.write(f"{script_type} script {script} successfully passed.\n")
             temp_file.write(f"{script_type} script execution time: {elapsed_time:.2f} seconds.\n")
 
-        console.debug(f"[#888888]{script_type} script output stored in: {temp_file_path.strip()}[/#888888]")
+        console.debug(f"{script_type} script output stored in: {temp_file_path.strip()}", color=MUTED_COLOR)
 
         if proc.returncode != 0:
             if frid is not None:
                 console.info(
-                    f"[#FFB454]↻ The {script_type} script for functionality ID {frid} of module {module} has failed. Initiating the patching mode to automatically correct the discrepancies.[/#FFB454]"
+                    f"↻ The {script_type} script for functionality ID {frid} of module {module} has failed. "
+                    f"Initiating the patching mode to automatically correct the discrepancies.",
+                    color=RETRY_COLOR,
                 )
             else:
                 console.info(
-                    f"[#FFB454]↻ The {script_type} script has failed. Initiating the patching mode to automatically correct the discrepancies.[/#FFB454]"
+                    f"↻ The {script_type} script has failed. "
+                    f"Initiating the patching mode to automatically correct the discrepancies.",
+                    color=RETRY_COLOR,
                 )
         else:
             if frid is not None:
                 console.info(
-                    f"[#79FC96]The {script_type} script for functionality ID {frid} of module {module} has passed successfully.[/#79FC96]"
+                    f"✓ The {script_type} script for functionality ID {frid} of module {module} "
+                    f"has passed successfully.",
+                    color=SUCCESS_COLOR,
                 )
             else:
-                console.info(f"[#79FC96]All {script_type} scripts have passed successfully.[/#79FC96]")
+                console.info(f"✓ All {script_type} scripts have passed successfully.", color=SUCCESS_COLOR)
 
         return proc.returncode, sanitized_script_output, temp_file_path