Fixed an issue where capture replays with random boards could not be loaded.

Author: eriq-augustine

.pylintrc

@@ -104,10 +104,6 @@ recursive=no
 # source root.
 source-roots=
 
-# When enabled, pylint would attempt to guess common misconfiguration and emit
-# user-friendly hints instead of false-positive error messages.
-suggestion-mode=yes
-
 # Allow loading of arbitrary C extensions. Extensions are imported into the
 # active Python interpreter and may run arbitrary code.
 unsafe-load-any-extension=no
@@ -431,22 +427,27 @@ confidence=HIGH,
 # --disable=W".
 disable=bad-inline-option,
         broad-exception-caught,
+        consider-iterating-dictionary,
         deprecated-pragma,
         duplicate-code,
         file-ignored,
         locally-disabled,
         missing-module-docstring,
         protected-access,
         raw-checker-failed,
+        redefined-builtin,
         superfluous-parens,
         suppressed-message,
         too-few-public-methods,
         too-many-arguments,
         too-many-branches,
         too-many-instance-attributes,
+        too-many-lines,
         too-many-locals,
         too-many-positional-arguments,
         too-many-public-methods,
+        too-many-return-statements,
+        too-many-statements,
         unused-argument,
         use-symbolic-message-instead,
         use-implicit-booleaness-not-comparison-to-string,
@@ -585,7 +586,7 @@ contextmanager-decorators=contextlib.contextmanager
 # List of members which are set dynamically and missed by pylint inference
 # system, and so shouldn't trigger E1101 when accessed. Python regular
 # expressions are accepted.
-generated-members=
+generated-members=logging.trace
 
 # Tells whether to warn about missing members when the owner of the attribute
 # is inferred to be None.

pacai/capture/bin.py

@@ -15,8 +15,6 @@
 DEFAULT_BOARD: str = 'capture-medium'
 DEFAULT_SPRITE_SHEET: str = 'capture'
 
-RANDOM_BOARD_PREFIX: str = 'random'
-
 def set_cli_args(parser: argparse.ArgumentParser, **kwargs: typing.Any) -> argparse.ArgumentParser:
     """
     Set Capture-specific CLI arguments.
@@ -69,13 +67,7 @@ def init_from_args(args: argparse.Namespace) -> tuple[dict[int, pacai.core.agent
         base_agent_infos[i] = agent_info
 
     # Check for random boards.
-    if (args.board.startswith(RANDOM_BOARD_PREFIX)):
-        board_seed = None
-        if (args.board != RANDOM_BOARD_PREFIX):
-            # Strip 'random-' and 'random'.
-            board_seed = int(args.board.removeprefix(RANDOM_BOARD_PREFIX + '-').removeprefix(RANDOM_BOARD_PREFIX))
-
-        args.board = pacai.capture.board.generate(seed = board_seed)
+    args.board = pacai.capture.game.Game.check_for_random_board(args.board)
 
     return base_agent_infos, [], {}
 

pacai/capture/game.py

@@ -1,3 +1,4 @@
+import argparse
 import random
 
 import pacai.capture.gamestate
@@ -6,6 +7,8 @@
 import pacai.core.game
 import pacai.core.gamestate
 
+RANDOM_BOARD_PREFIX: str = 'random'
+
 class Game(pacai.core.game.Game):
     """
     A game following the standard rules of Capture.
@@ -16,3 +19,29 @@ def get_initial_state(self,
             board: pacai.core.board.Board,
             agent_infos: dict[int, pacai.core.agentinfo.AgentInfo]) -> pacai.core.gamestate.GameState:
         return pacai.capture.gamestate.GameState(board = board, agent_infos = agent_infos)
+
+    @classmethod
+    def override_args_with_replay(cls,
+            args: argparse.Namespace, base_agent_infos: dict[int, pacai.core.agentinfo.AgentInfo]) -> None:
+        super().override_args_with_replay(args, base_agent_infos)
+
+        # Check for random boards.
+        args.board = Game.check_for_random_board(args.board)
+
+    @staticmethod
+    def check_for_random_board(board: str) -> str | pacai.core.board.Board:
+        """
+        Check if the board string is a random board.
+        If it is a board string represents a random board, generate and return it.
+        If the board string is not random, return the original string.
+        """
+
+        if (not board.startswith(RANDOM_BOARD_PREFIX)):
+            return board
+
+        board_seed = None
+        if (board != RANDOM_BOARD_PREFIX):
+            # Strip 'random-' and 'random'.
+            board_seed = int(board.removeprefix(RANDOM_BOARD_PREFIX + '-').removeprefix(RANDOM_BOARD_PREFIX))
+
+        return pacai.capture.board.generate(seed = board_seed)

pacai/capture/game_test.py

@@ -0,0 +1,44 @@
+import os
+
+import edq.testing.unittest
+import edq.util.dirent
+
+import pacai.capture.bin
+
+class GameTest(edq.testing.unittest.BaseTest):
+    """ Test specifics for capture games. """
+
+    def test_load_randomboard_replay(self):
+        """ Test loading a replay that has a random board. """
+
+        temp_dir = edq.util.dirent.get_temp_dir(prefix = 'pacai-test-')
+        replay_path = os.path.join(temp_dir, 'test.replay')
+
+        expected_score = -10
+
+        # Run a short capture game and save the replay.
+        argv = [
+            '--seed', '4',
+            '--quiet',
+            '--board', 'random-6',
+            '--red', 'capture-team-baseline',
+            '--blue', 'capture-team-dummy',
+            '--ui', 'null',
+            '--max-turns', '80',
+            '--save-path', replay_path,
+
+        ]
+        _, results = pacai.capture.bin.main(argv = argv)
+
+        self.assertEqual(expected_score, results[0].score)
+
+        # Replay the game and get the same result.
+        argv = [
+            '--quiet',
+            '--ui', 'null',
+            '--replay-path', replay_path,
+
+        ]
+        _, results = pacai.capture.bin.main(argv = argv)
+
+        self.assertEqual(expected_score, results[0].score)

pacai/core/game.py

@@ -452,6 +452,43 @@ def _receive_user_inputs(self,
         for user_inputs in agent_user_inputs.values():
             user_inputs += new_user_inputs
 
+    @classmethod
+    def override_args_with_replay(cls,
+            args: argparse.Namespace, base_agent_infos: dict[int, pacai.core.agentinfo.AgentInfo]) -> None:
+        """
+        Override the args with the settings from the replay in the args.
+        Children may extend this for additional functionality.
+        """
+
+        logging.info("Loading replay from '%s'.", args.replay_path)
+        replay_info = typing.cast(GameResult, edq.util.json.load_object_path(args.replay_path, GameResult))
+
+        # Overrides from the replay info.
+        args.board = replay_info.game_info.board_source
+        args.seed = replay_info.game_info.seed
+
+        # Special settings for replays.
+        args.num_games = 1
+        args.num_training = 0
+        args.max_turns = len(replay_info.history)
+
+        # Script the moves for each agent based on the replay's history.
+        scripted_actions: dict[int, list[pacai.core.action.Action]] = {}
+        for item in replay_info.history:
+            if (item.agent_index not in scripted_actions):
+                scripted_actions[item.agent_index] = []
+
+            scripted_actions[item.agent_index].append(item.get_action())
+
+        base_agent_infos.clear()
+
+        for (agent_index, actions) in scripted_actions.items():
+            base_agent_infos[agent_index] = pacai.core.agentinfo.AgentInfo(
+                name = pacai.util.alias.AGENT_SCRIPTED.short,
+                move_delay = replay_info.game_info.agent_infos[agent_index].move_delay,
+                actions = actions,
+            )
+
 def set_cli_args(parser: argparse.ArgumentParser, default_board: str | None = None) -> argparse.ArgumentParser:
     """
     Set common CLI arguments.
@@ -553,7 +590,7 @@ def init_from_args(
     # then all the core arguments are loaded differently (directly from the file).
     # Use the replay file to override all the current options.
     if (args.replay_path is not None):
-        _override_args_with_replay(args, base_agent_infos)
+        game_class.override_args_with_replay(args, base_agent_infos)
         remove_agent_indexes = []
 
     if (args.board is None):
@@ -635,40 +672,6 @@ def init_from_args(
 
     return args
 
-def _override_args_with_replay(args: argparse.Namespace, base_agent_infos: dict[int, pacai.core.agentinfo.AgentInfo]) -> None:
-    """
-    Override the args with the settings from the replay in the args.
-    """
-
-    logging.info("Loading replay from '%s'.", args.replay_path)
-    replay_info = typing.cast(GameResult, edq.util.json.load_object_path(args.replay_path, GameResult))
-
-    # Overrides from the replay info.
-    args.board = replay_info.game_info.board_source
-    args.seed = replay_info.game_info.seed
-
-    # Special settings for replays.
-    args.num_games = 1
-    args.num_training = 0
-    args.max_turns = len(replay_info.history)
-
-    # Script the moves for each agent based on the replay's history.
-    scripted_actions: dict[int, list[pacai.core.action.Action]] = {}
-    for item in replay_info.history:
-        if (item.agent_index not in scripted_actions):
-            scripted_actions[item.agent_index] = []
-
-        scripted_actions[item.agent_index].append(item.get_action())
-
-    base_agent_infos.clear()
-
-    for (agent_index, actions) in scripted_actions.items():
-        base_agent_infos[agent_index] = pacai.core.agentinfo.AgentInfo(
-            name = pacai.util.alias.AGENT_SCRIPTED.short,
-            move_delay = replay_info.game_info.agent_infos[agent_index].move_delay,
-            actions = actions,
-        )
-
 def _parse_agent_infos(
         agent_indexes: list[int],
         raw_args: list[str],

pacai/ui/web.py

@@ -192,7 +192,7 @@ def _handle_request(self, data_handler: typing.Callable) -> None:
         self.end_headers()
 
         if (payload is not None):
-            self.wfile.write(payload)  # type: ignore[arg-type]
+            self.wfile.write(payload)
 
     def _route(self, path: str, params: dict[str, typing.Any]) -> RequestHandlerResult:
         path = path.strip()