feat: store reports as list instead of dict

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

Author: ktro2828

docs/tutorials/cli/t4sanity.md

@@ -108,15 +108,15 @@ Then a JSON file named `results.json` will be generated as follows:
   {
     "dataset_id": "<DatasetID: str>",
     "version": <Version: int>,
-    "reports": {
-      "<RuleID: str>": {
+    "reports": [
+      {
           "id": "<RuleID: str>",
           "name": "<RuleName: str>",
           "description": "<Description: str>",
           "status": "<SUCCESS/FAILURE/SKIPPED: str>",
           "reasons": "<[<Reason1>, <Reason2>, ...]: [str; N] | null>" // Failure or skipped reasons, null if success
       },
-    }
+    ]
   }
 ]
 ```
@@ -126,5 +126,6 @@ Then a JSON file named `results.json` will be generated as follows:
 With `-e; --excludes` option enables us to exclude specific checks by specifying the **rule IDs or groups**:
 
 ```shell
+# Exclude STR001 and all FMT-relevant rules
 t4sanity <DB_PARENT> -e STR001 -e FMT
 ```

t4_devkit/cli/sanity.py

@@ -36,9 +36,9 @@ def _run_sanity_check(
 def _print_table(results: list[SanityResult], *, detail: bool = False) -> str:
     summary_rows = []
     for result in results:
-        success = sum(1 for rp in result.reports.values() if rp.is_success())
-        failures = sum(1 for rp in result.reports.values() if rp.is_failure())
-        skips = sum(1 for rp in result.reports.values() if rp.is_skipped())
+        success = sum(1 for rp in result.reports if rp.is_success())
+        failures = sum(1 for rp in result.reports if rp.is_failure())
+        skips = sum(1 for rp in result.reports if rp.is_skipped())
         summary_rows.append(
             [
                 result.dataset_id,

t4_devkit/sanity/result.py

@@ -39,6 +39,12 @@ class Report:
     status: Status
     reasons: list[Reason] | None = field(default=None)
 
+    def __attrs_post_init__(self) -> None:
+        if self.is_success():
+            assert self.reasons is None, "Success report cannot have reasons"
+        else:
+            assert self.reasons is not None, "Failure report must have reasons"
+
     def is_success(self) -> bool:
         return self.status == Status.SUCCESS
 
@@ -68,10 +74,10 @@ def make_failure(id: RuleID, name: RuleName, description: str, reasons: list[Rea
 class SanityResult:
     dataset_id: str
     version: str | None
-    reports: dict[str, Report]
+    reports: list[Report]
 
     @classmethod
-    def from_context(cls, context: SanityContext, reports: dict[RuleID, Report]) -> Self:
+    def from_context(cls, context: SanityContext, reports: list[Report]) -> Self:
         return cls(
             dataset_id=context.dataset_id.value_or("UNKNOWN"),
             version=context.version.value_or(None),
@@ -80,15 +86,15 @@ def from_context(cls, context: SanityContext, reports: dict[RuleID, Report]) ->
 
     def __repr__(self) -> str:
         string = f"=== DatasetID: {self.dataset_id} ===\n"
-        for id, report in self.reports.items():
+        for report in self.reports:
             if report.is_failure():
-                string += f"\033[31m  {id}:\033[0m\n"
+                string += f"\033[31m  {report.id}:\033[0m\n"
                 for reason in report.reasons or []:
                     string += f"\033[31m     - {reason}\033[0m\n"
             elif report.is_skipped():
-                string += f"\033[33m  {id}:\033[0m\n"
+                string += f"\033[33m  {report.id}:\033[0m\n"
                 for reason in report.reasons or []:
                     string += f"\033[33m     - {reason}\033[0m\n"
             else:
-                string += f"\033[32m  {id}: ✅\033[0m\n"
+                string += f"\033[32m  {report.id}: ✅\033[0m\n"
         return string

t4_devkit/sanity/run.py

@@ -26,6 +26,6 @@ def sanity_check(
         context = SanityContext.from_path(data_root, revision=revision)
 
         checkers = CHECKERS.build(excludes=excludes)
-        reports = {checker.id: checker(context) for checker in checkers}
+        reports = [checker(context) for checker in checkers]
 
         return SanityResult.from_context(context, reports)