Resolve "Fix warnings and code style resulting from #25"

Closes #33 (closed)

overcooked_simulator/pygame_gui/pygame_gui.py

@@ -11,7 +11,7 @@ from overcooked_simulator.counters import (
     PlateReturn,
     ServingWindow,
 )
-from overcooked_simulator.game_items import ProgressibleItem, Plate
+from overcooked_simulator.game_items import ProgressibleItem, Plate, HoldableItem
 from overcooked_simulator.game_items import Tomato
 from overcooked_simulator.overcooked_environment import Action
 from overcooked_simulator.simulation_runner import Simulator
@@ -19,7 +19,7 @@ from overcooked_simulator.simulation_runner import Simulator
 WHITE = (255, 255, 255)
 GREY = (190, 190, 190)
 BLACK = (0, 0, 0)
-COUNTERCOLOR = (240, 240, 240)
+COUNTER_COLOR = (240, 240, 240)
 LIGHTGREY = (220, 220, 220)
 GREEN = (0, 255, 0)
 RED = (255, 0, 0)
@@ -32,7 +32,7 @@ PLATE_RETURN_COLOR = (170, 170, 240)
 BOARD_COLOR = (239, 193, 151)
 
 
-class PlayerKeyset:
+class PlayerKeySet:
     """Set of keyboard keys for controlling a player.
     First four keys are for movement. Order: Down, Up, Left, Right.
     5th key is for interacting with counters.
@@ -41,7 +41,7 @@ class PlayerKeyset:
     """
 
     def __init__(self, player_name: str, keys: list[pygame.key]):
-        """Creates a player keyset which contains information about which keyboard keys control the player.
+        """Creates a player key set which contains information about which keyboard keys control the player.
         Movement keys in the following order: Down, Up, Left, Right
 
         Args:
@@ -59,7 +59,7 @@ class PlayerKeyset:
 
 
 class PyGameGUI:
-    """Visualisation of the overcooked environmnent and reading keyboard inputs using pygame."""
+    """Visualisation of the overcooked environment and reading keyboard inputs using pygame."""
 
     def __init__(
         self,
@@ -67,6 +67,7 @@ class PyGameGUI:
         player_names: list[str],
         player_keys: list[pygame.key],
     ):
+        self.screen = None
         self.FPS = 60
         self.simulator = simulator
         self.counter_size = self.simulator.env.counter_side_length
@@ -79,10 +80,10 @@ class PyGameGUI:
         self.player_keys = player_keys
         assert len(self.player_names) == len(
             self.player_keys
-        ), "Number of players and keysets should match."
+        ), "Number of players and key sets should match."
 
-        self.player_keysets: list[PlayerKeyset] = [
-            PlayerKeyset(player_name, keys)
+        self.player_key_sets: list[PlayerKeySet] = [
+            PlayerKeySet(player_name, keys)
             for player_name, keys in zip(self.player_names, self.player_keys)
         ]
 
@@ -101,13 +102,13 @@ class PyGameGUI:
         an action is sent in this function.
         """
         keys = pygame.key.get_pressed()
-        for player_idx, keyset in enumerate(self.player_keysets):
-            relevant_keys = [keys[k] for k in keyset.player_keys]
+        for player_idx, key_set in enumerate(self.player_key_sets):
+            relevant_keys = [keys[k] for k in key_set.player_keys]
             if any(relevant_keys[:-2]):
                 move_vec = np.zeros(2)
                 for idx, pressed in enumerate(relevant_keys[:-2]):
                     if pressed:
-                        move_vec += keyset.move_vectors[idx]
+                        move_vec += key_set.move_vectors[idx]
                 if np.linalg.norm(move_vec) != 0:
                     move_vec = move_vec / np.linalg.norm(move_vec)
 
@@ -122,17 +123,17 @@ class PyGameGUI:
         Args:
             event: Pygame event for extracting the key action.
         """
-        for keyset in self.player_keysets:
-            if event.key == keyset.pickup_key and event.type == pygame.KEYDOWN:
-                action = Action(keyset.name, "pickup", "pickup")
+        for key_set in self.player_key_sets:
+            if event.key == key_set.pickup_key and event.type == pygame.KEYDOWN:
+                action = Action(key_set.name, "pickup", "pickup")
                 self.send_action(action)
 
-            if event.key == keyset.interact_key:
+            if event.key == key_set.interact_key:
                 if event.type == pygame.KEYDOWN:
-                    action = Action(keyset.name, "interact", "keydown")
+                    action = Action(key_set.name, "interact", "keydown")
                     self.send_action(action)
                 elif event.type == pygame.KEYUP:
-                    action = Action(keyset.name, "interact", "keyup")
+                    action = Action(key_set.name, "interact", "keyup")
                     self.send_action(action)
 
     def draw_background(self):
@@ -144,7 +145,7 @@ class PyGameGUI:
                 pygame.draw.rect(self.screen, BACKGROUND_LINES_COLOR, rect, 1)
 
     def draw_players(self, state):
-        """Visualizes the players as circles with a triangle for the facing diretion.
+        """Visualizes the players as circles with a triangle for the facing direction.
         If the player holds something in their hands, it is displayed
 
         Args:
@@ -175,7 +176,7 @@ class PyGameGUI:
                 holding_item_pos = player.pos + (20 * player.facing_direction)
                 self.draw_item(holding_item_pos, player.holding)
 
-    def draw_item(self, pos, item):
+    def draw_item(self, pos, item: HoldableItem):
         """Visualisation of an item at the specified position. On a counter or in the hands of the player."""
         if isinstance(item, Tomato):
             if item.finished:
@@ -192,7 +193,7 @@ class PyGameGUI:
 
         if isinstance(item, Plate):
             image = pygame.image.load(
-                "overcooked_simulator/pygame_gui/images/plate.png"
+                self.images_path / "plate.png"
             ).convert_alpha()  # or .convert_alpha()
             rect = image.get_rect()
             rect.center = pos
@@ -229,7 +230,7 @@ class PyGameGUI:
             self.counter_size,
             self.counter_size,
         )
-        pygame.draw.rect(self.screen, COUNTERCOLOR, counter_rect_outline)
+        pygame.draw.rect(self.screen, COUNTER_COLOR, counter_rect_outline)
 
         if isinstance(counter, CuttingBoard):
             board_size = 30
@@ -309,7 +310,7 @@ class PyGameGUI:
         pygame.display.flip()
 
     def start_pygame(self):
-        """Starts pygame and the gui loop. Each frame the gamestate is visualized and keyboard inputs are read."""
+        """Starts pygame and the gui loop. Each frame the game state is visualized and keyboard inputs are read."""
         pygame.init()
         pygame.font.init()