game logging

src/data_collection.py

@@ -4,8 +4,8 @@ from typing import NewType
 
 import pydantic
 
-import message
 import player
+import message
 
 from pydantic import BaseModel
 
@@ -26,10 +26,14 @@ def save(log_object: Model):
 
 
 def get_log_file(log_object: Model) -> str:
+    from game import Game
+
     if isinstance(log_object, message.AgentMessage):
         log_file = "messages.jsonl"
     elif isinstance(log_object, player.Player):
         log_file = "players.jsonl"
+    elif isinstance(log_object, Game):
+        log_file = "games.jsonl"
     else:
         raise ValueError(f"Unknown log object type: {type(log_object)}")
 

src/game.py

@@ -1,36 +1,41 @@
-from typing import Optional, Type, List
+from typing import Optional, Type, List, ClassVar
+
+from pydantic import BaseModel, Field
 
 from game_utils import *
-from player import Player
 from message import Message, MessageType
 from agent_interfaces import HumanAgentCLI, OpenAIAgentInterface, HumanAgentInterface
+from player import Player
 from data_collection import save
 
 # Abstracting the Game Class is a WIP so that future games can be added
-class Game:
+class Game(BaseModel):
     """Base class for all games."""
 
-    number_of_players: int
-    """The number of players in the game."""
+    # Required
 
-    def __init__(
-            self,
-            game_id: str,
-            players: List[Player],
-            observer: Optional[Player] = None
-    ):
-        self.players: List[Player] = players
-        """The players in the game."""
-        self.observer: Optional[Player] = observer
-        """An observer who can see all public messages, but doesn't actually play."""
-        self.game_id = game_id
-        """The unique id of the game."""
-
-        self.winner_id: str | None = None
-        """The id of the player who has won the game."""
-        self.game_state: str = "game_start"
-        """Keeps track of the current state of the game."""
-        self.awaiting_input: bool = False
+    players: List[Player] = Field(exclude=True)
+    """The players in the game."""
+    observer: Optional[Player]
+    """An observer who can see all public messages, but doesn't actually play."""
+    game_id: str
+    """The unique id of the game."""
+
+    # Default
+
+    winner_id: str | None = None
+    """The id of the player who has won the game."""
+    game_state: str = Field("game_start", exclude=True)
+    """Keeps track of the current state of the game."""
+    awaiting_input: bool = Field(False, exclude=True)
+    """Whether the game is currently awaiting input from a player."""
+
+    # Class Variables
+
+    number_of_players: ClassVar[int]
+    """The number of players in the game."""
+    player_class: ClassVar[Type[Player]] = Player
+    """The class of the player used in the game."""
 
     def player_from_id(self, player_id: str) -> Player:
         """Returns a player from their ID."""
@@ -89,6 +94,10 @@ class Game:
         for player in self.players:
             save(player)
 
+        save(self)
+
+
+
     @classmethod
     def from_human_name(
             cls, human_name: str = None,
@@ -126,7 +135,7 @@ class Game:
                 player_dict["interface"] = OpenAIAgentInterface(agent_id=player_id)
                 player_dict["message_level"] = "info"
 
-            players.append(Player(**player_dict))
+            players.append(cls.player_class(**player_dict))
 
         # Add Observer - an Agent who can see all the messages, but doesn't actually play
         if human_index is None:
@@ -134,7 +143,7 @@ class Game:
         else:
             observer = None
 
-        return cls(game_id, players, observer)
+        return cls(game_id=game_id, players=players, observer=observer)
 
 
 

src/game_chameleon.py

@@ -1,4 +1,5 @@
 from collections import Counter
+from typing import ClassVar
 
 from game_utils import random_index
 from output_formats import *
@@ -9,37 +10,39 @@ from game import Game
 
 # Default Values
 NUMBER_OF_PLAYERS = 6
-WINNING_SCORE = 6
+WINNING_SCORE = 7
+AVAILABLE_ANIMALS = ["Dog", "Cat", "Mouse", "Hamster", "Monkey", "Rabbit", "Fox", "Bear", "Panda", "Koala", "Tiger",
+                     "Lion", "Cow", "Pig", "Frog", "Owl", "Duck", "Chicken", "Butterfly", "Turtle", "Snake", "Octopus",
+                     "Squid", "Hedgehog", "Elephant", "Rhinoceros", "Zebra", "Crocodile", "Whale", "Dolphin", "Camel",
+                     "Giraffe", "Deer", "Gorilla", "Goat", "Llama", "Horse", "Unicorn", "Flamingo", "Skunk", "Shark"]
 
 
 class ChameleonGame(Game):
     """The main game class, handles the game logic and player interactions."""
 
-    number_of_players = NUMBER_OF_PLAYERS
+    # Defaults
 
-    winning_score = WINNING_SCORE
+    winning_score: int = WINNING_SCORE
     """The Number of points required to win the game."""
-    available_animals = ["Dog", "Cat", "Mouse", "Hamster", "Monkey", "Rabbit", "Fox", "Bear", "Panda", "Koala", "Tiger", "Lion", "Cow", "Pig", "Frog", "Owl", "Duck", "Chicken", "Butterfly", "Turtle", "Snake", "Octopus", "Squid", "Hedgehog", "Elephant", "Rhinoceros", "Zebra", "Crocodile", "Whale", "Dolphin", "Camel", "Giraffe", "Deer", "Gorilla", "Goat", "Llama", "Horse", "Unicorn", "Flamingo", "Skunk", "Shark"]
+    available_animals: List[str] = Field(AVAILABLE_ANIMALS, exclude=True)
     """The list of animals that can be chosen as the secret animal."""
-
-    def __init__(self, *args, **kwargs):
-
-        super().__init__(*args, **kwargs)
-
-        # Convert the Players to ChameleonPlayers
-        self.players: List[ChameleonPlayer] = [ChameleonPlayer.from_player(player) for player in self.players]
-
-        # Instance Variables
-        self.chameleon_ids: List[str] = []
-        """Record of which player was the chameleon for each round."""
-        self.herd_animals: List[str] = []
-        """Record of what animal was the herd animal for each round."""
-        self.all_animal_descriptions: List[List[dict]] = []
-        """Record of the animal descriptions each player has given for each round."""
-        self.chameleon_guesses: List[str] = []
-        """Record of what animal the chameleon guessed for each round."""
-        self.herd_vote_tallies: List[List[dict]] = []
-        """Record of the votes of each herd member for the chameleon for each round."""
+    chameleon_ids: List[str] = []
+    """Record of which player was the chameleon for each round."""
+    herd_animals: List[str] = []
+    """Record of what animal was the herd animal for each round."""
+    all_animal_descriptions: List[List[dict]] = []
+    """Record of the animal descriptions each player has given for each round."""
+    chameleon_guesses: List[str] = []
+    """Record of what animal the chameleon guessed for each round."""
+    herd_vote_tallies: List[List[dict]] = []
+    """Record of the votes of each herd member for the chameleon for each round."""
+
+    # Class Variables
+
+    number_of_players: ClassVar[int] = NUMBER_OF_PLAYERS
+    """The number of players in the game."""
+    player_class: ClassVar[Type[Player]] = ChameleonPlayer
+    """The class of the player used in the game."""
 
     @property
     def chameleon(self) -> ChameleonPlayer: