[validate] Add OutputVisualizer as special type of Validator

Author: mpsijm

bin/problem.py

@@ -910,6 +910,13 @@ def _validators(
                 paths = [problem.path / validate.OutputValidator.source_dir]
             else:
                 paths = [config.TOOLS_ROOT / "support" / "default_output_validator.cpp"]
+        elif cls == validate.OutputVisualizer:
+            # TODO: if not config.args.no_output_visualizer:
+            paths = (
+                [problem.path / validate.OutputVisualizer.source_dir]
+                if (problem.path / validate.OutputVisualizer.source_dir).is_dir()
+                else []
+            )
         else:
             paths = list(glob(problem.path / cls.source_dir, "*"))
 
@@ -944,7 +951,7 @@ def has_constraints_checking(f):
             )
             for path in paths
         ]
-        bar = ProgressBar(f"Building {cls.validator_type} validator", items=validators)
+        bar = ProgressBar(f"Building {cls.validator_type}", items=validators)
 
         def build_program(p):
             localbar = bar.start(p)
@@ -963,9 +970,10 @@ def prepare_run(problem):
         if not testcases:
             return False
 
-        # Pre build the output validator to prevent nested ProgressBars.
+        # Pre build the output validator and visualizer to prevent nested ProgressBars.
         if not problem.validators(validate.OutputValidator):
             return False
+        problem.validators(validate.OutputVisualizer)
 
         submissions = problem.submissions()
         if not submissions:

bin/run.py

@@ -5,7 +5,7 @@
 
 from colorama import Fore, Style
 from pathlib import Path
-from typing import cast
+from typing import Optional, cast
 
 import config
 import interactive
@@ -174,7 +174,9 @@ def run(self, bar, *, interaction=None, submission_args=None):
 
             result.duration = max_duration
 
-            # Delete .out files larger than 1MB.
+            self._visualize_output(bar)
+
+            # Delete .out files larger than 1GB.
             if (
                 not config.args.error
                 and self.out_path.is_file()
@@ -215,7 +217,7 @@ def _prepare_nextpass(self, nextpass):
         shutil.move(nextpass, self.in_path)
         return True
 
-    def _validate_output(self, bar):
+    def _validate_output(self, bar: ProgressBar) -> Optional[ExecResult]:
         output_validators = self.problem.validators(validate.OutputValidator)
         if not output_validators:
             return None
@@ -227,6 +229,16 @@ def _validate_output(self, bar):
             args=self.testcase.testdata_yaml_validator_args(output_validator, bar),
         )
 
+    def _visualize_output(self, bar: ProgressBar) -> Optional[ExecResult]:
+        output_validators = self.problem.validators(validate.OutputVisualizer)
+        if not output_validators:
+            return None
+        return output_validators[0].run(
+            self.testcase,
+            self,
+            args=self.testcase.testdata_yaml_validator_args(output_validators[0], bar),
+        )
+
 
 class Submission(program.Program):
     def __init__(self, problem, path, skip_double_build_warning=False):

bin/validate.py

@@ -227,7 +227,7 @@ class InputValidator(Validator):
     def __init__(self, problem, path, **kwargs):
         super().__init__(problem, path, "input_validators", **kwargs)
 
-    validator_type: Final[str] = "input"
+    validator_type: Final[str] = "input validator"
 
     source_dir: Final[str] = "input_validators"
 
@@ -287,7 +287,7 @@ class AnswerValidator(Validator):
     def __init__(self, problem, path, **kwargs):
         super().__init__(problem, path, "answer_validators", **kwargs)
 
-    validator_type: Final[str] = "answer"
+    validator_type: Final[str] = "answer validator"
 
     source_dir: Final[str] = "answer_validators"
 
@@ -338,7 +338,7 @@ class OutputValidator(Validator):
     def __init__(self, problem, path, **kwargs):
         super().__init__(problem, path, "output_validator", **kwargs)
 
-    validator_type: Final[str] = "output"
+    validator_type: Final[str] = "output validator"
 
     source_dir: Final[str] = "output_validator"
 
@@ -356,7 +356,7 @@ def run(
         ---------
 
         mode: either a run.Run (namely, when validating submission output) or a Mode
-            (namely, when validation a testcase)
+            (namely, when validating a testcase)
 
         Returns
         -------
@@ -366,7 +366,7 @@ def run(
         assert self.run_command is not None, "Validator should be built before running it"
 
         if mode == Mode.INPUT:
-            raise ValueError("OutputValidator do not support Mode.INPUT")
+            raise ValueError("OutputValidator does not support Mode.INPUT")
 
         in_path = testcase.in_path.resolve()
         ans_path = testcase.ans_path.resolve()
@@ -410,7 +410,68 @@ def run(
         return ret
 
 
-AnyValidator = InputValidator | AnswerValidator | OutputValidator
+class OutputVisualizer(Validator):
+    """
+    Visualize the output of a submission
+
+       ./visualizer input answer feedbackdir [arguments from problem.yaml] < output
+    """
+
+    def __init__(self, problem, path, **kwargs):
+        super().__init__(problem, path, "output_visualizer", **kwargs)
+
+    validator_type: Final[str] = "output visualizer"
+
+    source_dir: Final[str] = "output_visualizer"
+
+    def run(
+        self,
+        testcase,  # TODO #102: fix type errors after setting type to Testcase
+        mode,
+        constraints: Optional[ConstraintsDict] = None,
+        args=None,
+    ) -> ExecResult:
+        """
+        Run this validator on the given testcase.
+
+        Arguments
+        ---------
+
+        run: run.Run (namely, when visualizing submission output)
+
+        Returns
+        -------
+        The ExecResult
+        """
+
+        assert self.run_command is not None, "Validator should be built before running it"
+
+        in_path = testcase.in_path.resolve()
+        ans_path = testcase.ans_path.resolve()
+        run = mode  # mode is actually a run
+        path = run.out_path
+        in_path = run.in_path
+
+        if self.language in Validator.FORMAT_VALIDATOR_LANGUAGES:
+            raise ValueError("Invalid output validator language")
+
+        # Only get the output_validator_args
+        _, _, arglist = self._run_helper(testcase, constraints, args)
+        cwd = run.feedbackdir
+        invocation = self.run_command + [in_path, ans_path, cwd]
+
+        with path.open() as file:
+            ret = self._exec_helper(
+                invocation + arglist,
+                exec_code_map=validator_exec_code_map,
+                stdin=file,
+                cwd=cwd,
+            )
+
+        return ret
+
+
+AnyValidator = InputValidator | AnswerValidator | OutputValidator | OutputVisualizer
 
 
 # Checks if byte is printable or whitespace