chessai.core.isolation.isolator

 1import abc
 2import random
 3
 4import chessai.core.agentaction
 5import chessai.core.agentinfo
 6import chessai.core.gamestate
 7
 8class AgentIsolator(abc.ABC):
 9    """
10    An isolator isolates an agent instance from the game being played.
11    This "isolation" allows the game to hide or protect state from a agent.
12    For example, without isolation an agent can just directly modify the state
13    to get all the points and end the game.
14
15    All communication between the game engine and agent should be done via the isolator.
16    """
17
18    @abc.abstractmethod
19    def init_agents(self, agent_infos: dict[chessai.core.types.Color, chessai.core.agentinfo.AgentInfo]) -> None:
20        """
21        Initialize the agents this isolator will be responsible for.
22        """
23
24    @abc.abstractmethod
25    def game_start(self,
26            rng: random.Random,
27            initial_state: chessai.core.gamestate.GameState,
28            timeout: float,
29            ) -> dict[chessai.core.types.Color, chessai.core.agentaction.AgentActionRecord]:
30        """
31        Pass along the initial game state to each agent and all them the allotted time to start.
32        """
33
34    @abc.abstractmethod
35    def game_complete(self,
36            final_state: chessai.core.gamestate.GameState,
37            timeout: float,
38            ) -> dict[chessai.core.types.Color, chessai.core.agentaction.AgentActionRecord]:
39        """
40        Notify all agents that the game is over.
41        """
42
43    @abc.abstractmethod
44    def get_action(self,
45            state: chessai.core.gamestate.GameState,
46            timeout: float,
47            ) -> chessai.core.agentaction.AgentActionRecord:
48        """
49        Get the current agent's next action.
50        User inputs may be provided by the UI if available.
51        """
52
53    @abc.abstractmethod
54    def close(self) -> None:
55        """
56        Close the isolator and release all owned resources.
57        This call should not communicate with agents and forcibly release any agent resources.
58        """