refactor: do refactoring

Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>

Author: ktro2828

t4_devkit/sanity/checker.py

@@ -49,8 +49,15 @@ def __call__(self, context: SanityContext, fix: bool = False) -> Report:
         fixed = self.fix(context) if fix and reasons else False
         return make_report(self.id, self.name, self.severity, self.description, reasons, fixed)
 
-    def can_skip(self, _: SanityContext) -> Maybe[Reason]:
-        """Return a skip reason if the checker should be skipped."""
+    def can_skip(self, context: SanityContext) -> Maybe[Reason]:
+        """Return a skip reason if the checker should be skipped.
+
+        Args:
+            context (SanityContext): The sanity context.
+
+        Returns:
+            A skip reason if the checker should be skipped, or Nothing if it should not be skipped.
+        """
         return Nothing
 
     @abstractmethod

t4_devkit/sanity/result.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from enum import Enum
-from typing import TYPE_CHECKING, NewType
+from typing import TYPE_CHECKING, ClassVar, NewType
 
 from attrs import define, field
 from tabulate import tabulate
@@ -47,6 +47,13 @@ class Report:
     reasons: list[Reason] | None = field(default=None)
     fixed: bool = False
 
+    PALETTE: ClassVar[dict[str, str]] = {
+        "RED": "\033[31m",
+        "GREEN": "\033[32m",
+        "YELLOW": "\033[33m",
+        "CYAN": "\033[36m",
+    }
+
     def __attrs_post_init__(self) -> None:
         if self.status == Status.PASSED:
             assert self.reasons is None, "Passed report cannot have reasons"
@@ -82,21 +89,35 @@ def to_str(self, *, strict: bool = False) -> str:
             A string representation of the report.
         """
         parts = []
-        is_fixed = " --> FIXED" if self.fixed else ""
         if not self.is_passed(strict=strict):
-            parts.append(f"\033[31m  {self.id}:\033[0m{is_fixed}\n")
+            # print failure reasons
+            color = self.PALETTE["RED"]
+            parts.append(f"{color}  {self.id}:\033[0m\n")
             for reason in self.reasons or []:
-                parts.append(f"\033[31m     - {reason}\033[0m\n")
+                parts.append(f"{color}     - {reason}\033[0m\n")
         elif self.is_skipped():
-            parts.append(f"\033[36m  {self.id}: [SKIPPED]\033[0m\n")
+            # print skipped reasons
+            color = self.PALETTE["CYAN"]
+            parts.append(f"{color}  {self.id}: [SKIPPED]\033[0m\n")
             for reason in self.reasons or []:
-                parts.append(f"\033[36m     - {reason}\033[0m\n")
+                parts.append(f"{color}     - {reason}\033[0m\n")
         elif self.severity.is_warning() and self.reasons:
-            parts.append(f"\033[33m  {self.id}:\033[0m{is_fixed}\n")
+            # print warning reasons
+            color = self.PALETTE["YELLOW"]
+            parts.append(f"{color}  {self.id}:\033[0m\n")
+            for reason in self.reasons or []:
+                parts.append(f"{color}     - {reason}\033[0m\n")
+        elif self.is_passed() and self.fixed:
+            # print failure or warning but fixed reasons
+            color1 = self.PALETTE["YELLOW"] if self.severity.is_warning() else self.PALETTE["RED"]
+            color2 = self.PALETTE["GREEN"]
+            parts.append(f"{color1}  {self.id}:\033[0m {color2}--> FIXED🎉\033[0m\n")
             for reason in self.reasons or []:
-                parts.append(f"\033[33m     - {reason}\033[0m\n")
+                parts.append(f"{color1}     - {reason}\033[0m\n")
         else:
-            parts.append(f"\033[32m  {self.id}: ✅\033[0m\n")
+            # print passed
+            color = self.PALETTE["GREEN"]
+            parts.append(f"{color}  {self.id}: ✅\033[0m\n")
         return "".join(parts)