Fix classic environments screen sizes, add type hints, fix pre-commit (…

…#998)

pettingzoo/atari/basketball_pong/basketball_pong.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Basketball Pong
 

pettingzoo/atari/boxing/boxing.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Boxing
 

pettingzoo/atari/combat_plane/combat_plane.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Combat: Plane
 

pettingzoo/atari/combat_tank/combat_tank.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Combat: Tank
 

pettingzoo/atari/double_dunk/double_dunk.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Double Dunk
 

pettingzoo/atari/entombed_competitive/entombed_competitive.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Emtombed: Competitive
 

pettingzoo/atari/entombed_cooperative/entombed_cooperative.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Emtombed: Cooperative
 

pettingzoo/atari/flag_capture/flag_capture.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Flag Capture
 

pettingzoo/atari/foozpong/foozpong.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Foozpong
 

pettingzoo/atari/ice_hockey/ice_hockey.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Ice Hockey
 

pettingzoo/atari/joust/joust.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Joust
 

pettingzoo/atari/mario_bros/mario_bros.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Mario Bros
 

pettingzoo/atari/maze_craze/maze_craze.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Maze Craze
 

pettingzoo/atari/othello/othello.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Othello
 

pettingzoo/atari/pong/pong.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Pong
 

pettingzoo/atari/quadrapong/quadrapong.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Quadrapong
 

pettingzoo/atari/space_invaders/space_invaders.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Space Invaders
 

pettingzoo/atari/space_war/space_war.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Space War
 

pettingzoo/atari/surround/surround.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Surround
 

pettingzoo/atari/tennis/tennis.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Tennis
 

pettingzoo/atari/video_checkers/video_checkers.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Video Checkers
 

pettingzoo/atari/volleyball_pong/volleyball_pong.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Volleyball Pong
 

pettingzoo/atari/warlords/warlords.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Warlords
 

pettingzoo/atari/wizard_of_wor/wizard_of_wor.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Wizard of Wor
 

pettingzoo/butterfly/cooperative_pong/cooperative_pong.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Cooperative Pong
 

pettingzoo/butterfly/knights_archers_zombies/knights_archers_zombies.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Knights Archers Zombies ('KAZ')
 

pettingzoo/butterfly/pistonball/pistonball.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Pistonball
 

pettingzoo/classic/chess/chess.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Chess
 
@@ -83,6 +83,8 @@
 * v0: Initial versions release (1.0.0)
 
 """
+from __future__ import annotations
+
 from os import path
 
 import chess
@@ -97,8 +99,8 @@
 from pettingzoo.utils.agent_selector import agent_selector
 
 
-def env(render_mode=None):
-    env = raw_env(render_mode=render_mode)
+def env(**kwargs):
+    env = raw_env(**kwargs)
     env = wrappers.TerminateIllegalWrapper(env, illegal_reward=-1)
     env = wrappers.AssertOutOfBoundsWrapper(env)
     env = wrappers.OrderEnforcingWrapper(env)
@@ -113,7 +115,7 @@ class raw_env(AECEnv):
         "render_fps": 2,
     }
 
-    def __init__(self, render_mode=None):
+    def __init__(self, render_mode: str | None = None, screen_height: int | None = 800):
         super().__init__()
 
         self.board = chess.Board()
@@ -149,6 +151,7 @@ def __init__(self, render_mode=None):
 
         assert render_mode is None or render_mode in self.metadata["render_modes"]
         self.render_mode = render_mode
+        self.screen_height = self.screen_width = screen_height
 
         if self.render_mode in {"human", "rgb_array"}:
             try:
@@ -158,7 +161,7 @@ def __init__(self, render_mode=None):
                     f"pygame is needed for {self.render_mode} rendering, run with `pip install pettingzoo[classic]`"
                 )
 
-            self.BOARD_SIZE = (400, 400)
+            self.BOARD_SIZE = (self.screen_width, self.screen_height)
             self.window_surface = None
             self.clock = pygame.time.Clock()
             self.cell_size = (self.BOARD_SIZE[0] / 8, self.BOARD_SIZE[1] / 8)

pettingzoo/classic/connect_four/connect_four.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Connect Four
 
@@ -57,6 +57,7 @@
 * v0: Initial versions release (1.0.0)
 
 """
+from __future__ import annotations
 
 import os
 
@@ -82,8 +83,8 @@ def get_image(path):
     return sfc
 
 
-def env(render_mode=None):
-    env = raw_env(render_mode=render_mode)
+def env(**kwargs):
+    env = raw_env(**kwargs)
     env = wrappers.TerminateIllegalWrapper(env, illegal_reward=-1)
     env = wrappers.AssertOutOfBoundsWrapper(env)
     env = wrappers.OrderEnforcingWrapper(env)
@@ -98,7 +99,7 @@ class raw_env(AECEnv):
         "render_fps": 2,
     }
 
-    def __init__(self, render_mode=None):
+    def __init__(self, render_mode: str | None = None, screen_scaling: int = 9):
         super().__init__()
         # 6 rows x 7 columns
         # blank space = 0
@@ -107,6 +108,7 @@ def __init__(self, render_mode=None):
         # flat representation in row major order
         self.screen = None
         self.render_mode = render_mode
+        self.screen_scaling = screen_scaling
 
         self.board = [0] * (6 * 7)
 
@@ -225,8 +227,8 @@ def render(self):
             )
             return
 
-        screen_width = 1287
-        screen_height = 1118
+        screen_width = 99 * self.screen_scaling
+        screen_height = 86 / 99 * screen_width
         if self.render_mode == "human":
             if self.screen is None:
                 pygame.init()

pettingzoo/classic/go/go.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 r"""
 # Go
 
@@ -106,9 +106,9 @@
 * v0: Initial versions release (1.0.0)
 
 """
+from __future__ import annotations
 
 import os
-from typing import Optional
 
 import gymnasium
 import numpy as np
@@ -148,7 +148,11 @@ class raw_env(AECEnv):
     }
 
     def __init__(
-        self, board_size: int = 19, komi: float = 7.5, render_mode: Optional[str] = None
+        self,
+        board_size: int = 19,
+        komi: float = 7.5,
+        render_mode: str | None = None,
+        screen_height: int | None = 800,
     ):
         # board_size: a int, representing the board size (board has a board_size x board_size shape)
         # komi: a float, representing points given to the second player.
@@ -191,6 +195,7 @@ def __init__(
         self.board_history = np.zeros((self._N, self._N, 16), dtype=bool)
 
         self.render_mode = render_mode
+        self.screen_width = self.screen_height = screen_height
 
     def observation_space(self, agent):
         return self.observation_spaces[agent]
@@ -333,22 +338,21 @@ def render(self):
             )
             return
 
-        screen_width = 1026
-        screen_height = 1026
-
         if self.screen is None:
             if self.render_mode == "human":
                 pygame.init()
-                self.screen = pygame.display.set_mode((screen_width, screen_height))
+                self.screen = pygame.display.set_mode(
+                    (self.screen_width, self.screen_height)
+                )
             else:
-                self.screen = pygame.Surface((screen_width, screen_height))
+                self.screen = pygame.Surface((self.screen_width, self.screen_height))
         if self.render_mode == "human":
             pygame.event.get()
 
         size = go_base.N
 
         # Load and scale all of the necessary images
-        tile_size = (screen_width) / size
+        tile_size = self.screen_width / size
 
         black_stone = get_image(os.path.join("img", "GoBlackPiece.png"))
         black_stone = pygame.transform.scale(

pettingzoo/classic/hanabi/hanabi.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Hanabi
 

pettingzoo/classic/rlcard_envs/gin_rummy.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Gin Rummy
 
@@ -108,6 +108,7 @@
 * v0: Initial versions release (1.0.0)
 
 """
+from __future__ import annotations
 
 import gymnasium
 import numpy as np
@@ -148,8 +149,8 @@ def __init__(
         self,
         knock_reward: float = 0.5,
         gin_reward: float = 1.0,
-        opponents_hand_visible=False,
-        render_mode=None,
+        opponents_hand_visible: bool | None = False,
+        render_mode: str | None = None,
     ):
         EzPickle.__init__(
             self,

pettingzoo/classic/rlcard_envs/leduc_holdem.py

@@ -1,4 +1,4 @@
-# noqa
+# noqa: D212, D415
 """
 # Leduc Hold'em
 
@@ -80,6 +80,7 @@
 * v0: Initial versions release (1.0.0)
 
 """
+from __future__ import annotations
 
 import gymnasium
 from rlcard.utils.utils import print_card
@@ -110,7 +111,11 @@ class raw_env(RLCardBase):
         "render_fps": 1,
     }
 
-    def __init__(self, num_players=2, render_mode=None):
+    def __init__(
+        self,
+        num_players: int = 2,
+        render_mode: str | None = None,
+    ):
         super().__init__("leduc-holdem", num_players, (36,))
         self.render_mode = render_mode
 

pettingzoo/classic/rlcard_envs/rlcard_base.py

@@ -6,7 +6,7 @@
 
 
 class RLCardBase(AECEnv):
-    def __init__(self, name, num_players, obs_shape):
+    def __init__(self, name: str, num_players: int, obs_shape: tuple):
         super().__init__()
         self.name = name
         self.num_players = num_players