Rename Test Case Visualizer back to Input Visualizer

See Kattis/problem-package-format#439 (comment)

Author: mpsijm

bin/export.py

@@ -13,7 +13,7 @@
 from latex import PdfType
 from problem import Problem
 from validate import InputValidator, AnswerValidator, OutputValidator
-from visualize import TestCaseVisualizer, OutputVisualizer
+from visualize import InputVisualizer, OutputVisualizer
 
 
 def select_languages(problems: list[Problem]) -> list[str]:
@@ -128,7 +128,7 @@ def build_problem_zip(problem: Problem, output: Path) -> bool:
         ("submissions/accepted/**/*", True),
         ("submissions/*/**/*", False),
         ("attachments/**/*", problem.interactive or problem.multi_pass),
-        (f"{TestCaseVisualizer.source_dir}/**/*", False),
+        (f"{InputVisualizer.source_dir}/**/*", False),
         (f"{OutputVisualizer.source_dir}/**/*", False),
     ]
 
@@ -219,7 +219,7 @@ def add_testcase(in_file: Path) -> None:
             f"{OutputValidator.source_dir}/**/*",
             # "statement/*", "solution/*", "problem_slide/*", use \constant{} commands
             # "submissions/*/**/*", removed support?
-            f"{TestCaseVisualizer.source_dir}/**/*",
+            f"{InputVisualizer.source_dir}/**/*",
             f"{OutputVisualizer.source_dir}/**/*",
         ]
         for pattern in constants_supported:

bin/generate.py

@@ -1045,7 +1045,7 @@ def use_feedback_image(feedbackdir: Path, source: str) -> None:
                         return
 
             visualizer: Optional[visualize.AnyVisualizer] = problem.visualizer(
-                visualize.TestCaseVisualizer
+                visualize.InputVisualizer
             )
             output_visualizer = problem.visualizer(visualize.OutputVisualizer)
             if output_visualizer is not None:
@@ -1074,7 +1074,7 @@ def use_feedback_image(feedbackdir: Path, source: str) -> None:
             for ext in config.KNOWN_VISUALIZER_EXTENSIONS:
                 in_path.with_suffix(ext).unlink(True)
 
-            if isinstance(visualizer, visualize.TestCaseVisualizer):
+            if isinstance(visualizer, visualize.InputVisualizer):
                 result = visualizer.run(in_path, ans_path, cwd, visualizer_args)
             else:
                 feedbackcopy = in_path.with_suffix(".feedbackcopy")
@@ -1944,7 +1944,7 @@ def build_program(p):
         build_programs(program.Generator, generators_used)
         build_programs(run.Submission, solutions_used)
         if build_visualizers:
-            self.problem.visualizer(visualize.TestCaseVisualizer)
+            self.problem.visualizer(visualize.InputVisualizer)
             self.problem.visualizer(visualize.OutputVisualizer)
 
         self.problem.validators(validate.InputValidator)

bin/problem.py

@@ -495,7 +495,7 @@ def _parse_test_case_and_groups_yaml(p, path: Path, bar: BAR_TYPE):
                         case (
                             validate.OutputValidator.args_key
                             | validate.AnswerValidator.args_key
-                            | visualize.TestCaseVisualizer.args_key
+                            | visualize.InputVisualizer.args_key
                             | visualize.OutputVisualizer.args_key
                         ):
                             if not isinstance(flags[k], list):
@@ -561,7 +561,7 @@ def get_test_case_yaml(
             validate.InputValidator.args_key,
             validate.OutputValidator.args_key,
             validate.AnswerValidator.args_key,
-            visualize.TestCaseVisualizer.args_key,
+            visualize.InputVisualizer.args_key,
             visualize.OutputVisualizer.args_key,
         ]
         if key not in known_args_keys:
@@ -925,8 +925,8 @@ def build_program(p):
 
     @overload
     def visualizer(
-        problem, cls: type[visualize.TestCaseVisualizer]
-    ) -> Optional[visualize.TestCaseVisualizer]: ...
+        problem, cls: type[visualize.InputVisualizer]
+    ) -> Optional[visualize.InputVisualizer]: ...
     @overload
     def visualizer(
         problem, cls: type[visualize.OutputVisualizer]

bin/upgrade.py

@@ -200,7 +200,7 @@ def upgrade_generators_yaml(problem_path: Path, bar: ProgressBar) -> None:
 
     if "visualizer" in yaml_data:
         warn(
-            "Cannot automatically upgrade 'visualizer'.\n - move visualizer to 'test_case_visualizer/'\n - first argument is the in_file\n - second argument is the ans_file"
+            "Cannot automatically upgrade 'visualizer'.\n - move visualizer to 'input_visualizer/'\n - first argument is the in_file\n - second argument is the ans_file"
         )
 
     if "data" in yaml_data and isinstance(yaml_data["data"], dict):

bin/visualize.py

@@ -9,25 +9,25 @@
     from problem import Problem
 
 
-class TestCaseVisualizer(program.Program):
+class InputVisualizer(program.Program):
     """
     Visualizes a test case, called as:
 
         ./visualizer input answer [args]
 
     """
 
-    visualizer_type: Final[str] = "test case"
+    visualizer_type: Final[str] = "input"
 
-    source_dir: Final[str] = "test_case_visualizer"
+    source_dir: Final[str] = "input_visualizer"
 
-    args_key: Final[str] = "test_case_visualizer_args"
+    args_key: Final[str] = "input_visualizer_args"
 
     def __init__(self, problem: "Problem", path: Path, **kwargs: Any):
         super().__init__(
             problem,
             path,
-            TestCaseVisualizer.source_dir,
+            InputVisualizer.source_dir,
             limits={"timeout": problem.limits.visualizer_time},
             substitute_constants=True,
             **kwargs,
@@ -37,9 +37,7 @@ def __init__(self, problem: "Problem", path: Path, **kwargs: Any):
     def run(
         self, in_path: Path, ans_path: Path, cwd: Path, args: Optional[list[str]] = None
     ) -> ExecResult:
-        assert self.run_command is not None, (
-            "Test Case Visualizer should be built before running it"
-        )
+        assert self.run_command is not None, "Input Visualizer should be built before running it"
 
         return self._exec_command(
             self.run_command + [in_path, ans_path] + (args or []),
@@ -94,4 +92,4 @@ def run(
             return self._exec_command(command, cwd=cwd)
 
 
-AnyVisualizer = TestCaseVisualizer | OutputVisualizer
+AnyVisualizer = InputVisualizer | OutputVisualizer

skel/problem/test_case_visualizer/example_test_case_visualizer.py renamed to skel/problem/input_visualizer/example_input_visualizer.py

@@ -0,0 +1,2 @@
+This input visualizer is intended for use with BAPCtools' `bt generate`.
+The visualizer should be invoked as `./visualizer <input_file_path> <answer_file_path> <...input_visualizer_args>` and should write a `testcase.<ext>` file.

skel/problem/input_visualizer/readme.md

@@ -85,12 +85,12 @@
           },
           "description": "Defines arguments passed to the output validator for the test case/group."
         },
-        "test_case_visualizer_args": {
+        "input_visualizer_args": {
           "type": "array",
           "items": {
             "type": "string"
           },
-          "description": "Defines arguments passed to the test case visualizer for the test case/group."
+          "description": "Defines arguments passed to the input visualizer for the test case/group."
         },
         "output_visualizer_args": {
           "type": "array",

skel/problem/test_case_visualizer/readme.md

@@ -25,7 +25,7 @@ let filename = "[A-Za-z0-9][A-Za-z0-9_.-]{0,253}[A-Za-z0-9]"
 	args?: *[] | [string]
 	input_validator_args?: *[] | [string] | {[string]: [string]}
 	output_validator_args?: *[] | [string]
-	test_case_visualizer_args?: *[] | [string]
+	input_visualizer_args?: *[] | [string]
 	output_visualizer_args?: *[] | [string]
 	full_feedback?: bool
 }