code-battles 1.0.0 → 1.1.0

package/dist/code_battles/battles.py

@@ -21,7 +21,9 @@ APIType = TypeVar("APIType")
 PlayerRequestsType = TypeVar("PlayerRequestsType")
 
 
-class CodeBattles(Generic[GameStateType, APIImplementationType, APIType, PlayerRequestsType]):
+class CodeBattles(
+    Generic[GameStateType, APIImplementationType, APIType, PlayerRequestsType]
+):
     """
     The base class for a Code Battles game.
 
@@ -92,15 +94,15 @@ class CodeBattles(Generic[GameStateType, APIImplementationType, APIType, PlayerR
         """
 
         raise NotImplementedError("make_decisions")
-    
+
     def apply_decisions(self, decisions: bytes) -> None:
         """
         **You must override this method.**
 
         Use the current state and the specified decisions to update the current state to be the next state.
-        
+
         This function should not take a lot of time.
-        
+
         Do NOT update :attr:`step`.
         """
 
@@ -123,13 +125,13 @@ class CodeBattles(Generic[GameStateType, APIImplementationType, APIType, PlayerR
         """
 
         raise NotImplementedError("create_initial_state")
-    
+
     def create_initial_player_requests(self, player_index: int) -> PlayerRequestsType:
         """
         **You must override this method.**
 
         Create the initial player requests for each simulation, to store in the :attr:`player_requests` attribute.
-        
+
         Should probably be empty.
         """
 
@@ -157,6 +159,11 @@ class CodeBattles(Generic[GameStateType, APIImplementationType, APIType, PlayerR
 
         pass
 
+    def configure_extra_width(self) -> int:
+        """Optionally add extra height to the right of the boards. 0 by default."""
+
+        return 0
+
     def configure_extra_height(self) -> int:
         """Optionally add extra height below the boards. 0 by default."""
 
@@ -187,6 +194,24 @@ class CodeBattles(Generic[GameStateType, APIImplementationType, APIType, PlayerR
 
         return "CodeBattlesBot"
 
+    def configure_bot_globals(self) -> Dict[str, Any]:
+        """
+        Configure additional available global items, such as libraries from the Python standard library, bots can use.
+
+        By default, this is math, time and random.
+
+        .. warning::
+           Bots will also have `api`, `context`, `player_api`, and the bot base class name (CodeBattlesBot by default) available as part of the globals, alongside everything in `api`.
+
+           Any additional imports will be stripped (not as a security mechanism).
+        """
+
+        return {
+            "math": math,
+            "time": time,
+            "random": random,
+        }
+
     def download_images(
         self, sources: List[Tuple[str, str]]
     ) -> asyncio.Future[Dict[str, Image]]:
@@ -237,7 +262,7 @@ class CodeBattles(Generic[GameStateType, APIImplementationType, APIType, PlayerR
     def run_bot_method(self, player_index: int, method_name: str):
         """
         Runs the specifid method of the given player.
-        
+
         Upon exception, shows an alert (does not terminate the bot).
         """
 
@@ -268,7 +293,6 @@ class CodeBattles(Generic[GameStateType, APIImplementationType, APIType, PlayerR
                 "fa-solid fa-exclamation",
             )
 
-
     def eliminate_player(self, player_index: int, reason=""):
         """Eliminate the specified player for the specified reason from the simulation."""
 
@@ -337,41 +361,47 @@ class CodeBattles(Generic[GameStateType, APIImplementationType, APIType, PlayerR
         console_visible: bool,
         verbose: bool,
     ):
-        self.map = map
-        self.player_names = player_names
-        self.map_image = await download_image(self.configure_map_image_url(map))
-        self.background = background
-        self.console_visible = console_visible
-        self.verbose = verbose
-        self.step = 0
-        self.active_players = list(range(len(player_names)))
-        self.state = self.create_initial_state()
-        self.player_requests = [self.create_initial_player_requests(i) for i in range(len(player_names))]
-        self._eliminated = []
-        self._player_globals = self._get_initial_player_globals(player_codes)
-        if not self.background:
-            self.canvas = GameCanvas(
-                document.getElementById("simulation"),
-                self.configure_board_count(),
-                self.map_image,
-                document.body.clientWidth - 440
-                if console_visible
-                else document.body.clientWidth - 40,
-                document.body.clientHeight - 280,
-                self.configure_extra_height(),
-            )
-        await self.setup()
+        try:
+            self.map = map
+            self.player_names = player_names
+            self.map_image = await download_image(self.configure_map_image_url(map))
+            self.background = background
+            self.console_visible = console_visible
+            self.verbose = verbose
+            self.step = 0
+            self.active_players = list(range(len(player_names)))
+            self.state = self.create_initial_state()
+            self.player_requests = [
+                self.create_initial_player_requests(i) for i in range(len(player_names))
+            ]
+            self._eliminated = []
+            self._player_globals = self._get_initial_player_globals(player_codes)
+            if not self.background:
+                self.canvas = GameCanvas(
+                    document.getElementById("simulation"),
+                    self.configure_board_count(),
+                    self.map_image,
+                    document.body.clientWidth - 440
+                    if console_visible
+                    else document.body.clientWidth - 40,
+                    document.body.clientHeight - 280,
+                    self.configure_extra_width(),
+                    self.configure_extra_height(),
+                )
+            await self.setup()
 
-        if not self.background:
-            if not hasattr(self, "_initialized"):
-                self._initialize()
+            if not self.background:
+                if not hasattr(self, "_initialized"):
+                    self._initialize()
 
-            # Show that loading finished
-            document.getElementById("loader").style.display = "none"
-            self.render()
+                # Show that loading finished
+                document.getElementById("loader").style.display = "none"
+                self.render()
 
-        if self.background:
-            await self._play_pause()
+            if self.background:
+                await self._play_pause()
+        except Exception:
+            traceback.print_exc()
 
     def _get_initial_player_globals(self, player_codes: List[str]):
         contexts = [
@@ -381,15 +411,13 @@ class CodeBattles(Generic[GameStateType, APIImplementationType, APIType, PlayerR
 
         player_globals = [
             {
-                "math": math,
-                "time": time,
-                "random": random,
                 "api": self.get_api(),
                 bot_base_class_name: getattr(self.get_api(), bot_base_class_name),
                 "player_api": None,
                 "context": context,
                 **self.get_api().__dict__,
             }
+            | self.configure_bot_globals()
             for context in contexts
         ]
         for index, api_code in enumerate(player_codes):
@@ -456,6 +484,8 @@ class CodeBattles(Generic[GameStateType, APIImplementationType, APIType, PlayerR
     def _step(self):
         if not self.over:
             self.apply_decisions(self.make_decisions())
+
+        if not self.over:
             self.step += 1
 
         if self.over:
@@ -518,11 +548,16 @@ class CodeBattles(Generic[GameStateType, APIImplementationType, APIType, PlayerR
         await asyncio.sleep(0.05)
         while self._should_play():
             start = time.time()
-            self._step()
+            try:
+                self._step()
+            except Exception:
+                traceback.print_exc()
             if not self.background:
                 await asyncio.sleep(
                     max(
-                        1 / self.configure_steps_per_second() / self._get_playback_speed()
+                        1
+                        / self.configure_steps_per_second()
+                        / self._get_playback_speed()
                         - (time.time() - start),
                         0,
                     )

package/dist/code_battles/js.pyi

@@ -14,7 +14,23 @@ class TwoDContext:
     ]
     font: str
     fillStyle: str
+    strokeStyle: str
 
+    @staticmethod
+    def beginPath(): ...
+    @staticmethod
+    def arc(
+        x: int,
+        y: int,
+        radius: float,
+        startAngle: float,
+        endAngle: float,
+        counterclockwise=False,
+    ): ...
+    @staticmethod
+    def stroke(): ...
+    @staticmethod
+    def fill(): ...
     @staticmethod
     def fillText(text: str, x: int, y: int): ...
     @staticmethod

package/dist/code_battles/utilities.py

@@ -1,6 +1,7 @@
 """Generic useful utilities for creating games with PyScript."""
 
 import asyncio
+import math
 from typing import Callable, List, Union
 from enum import Enum
 
@@ -75,12 +76,14 @@ class GameCanvas:
         map_image: Image,
         max_width: int,
         max_height: int,
+        extra_width: int,
         extra_height: int,
     ):
         self.canvas = canvas
         self.player_count = player_count
         self.map_image = map_image
         self.extra_height = extra_height
+        self.extra_width = extra_width
 
         self._fit_into(max_width, max_height)
 
@@ -140,6 +143,23 @@ class GameCanvas:
         self.context.fillStyle = color
         self.context.fillText(text, x, y)
 
+    def draw_circle(
+        self,
+        x: int,
+        y: int,
+        radius: float,
+        fill="black",
+        stroke="transparent",
+        board_index=0,
+    ):
+        x, y = self._translate_position(board_index, x, y)
+        self.context.fillStyle = fill
+        self.context.strokeStyle = stroke
+        self.context.beginPath()
+        self.context.arc(x, y, radius, 0, 2 * math.pi)
+        self.context.stroke()
+        self.context.fill()
+
     def clear(self):
         """Clears the canvas and re-draws the players' maps."""
 
@@ -165,10 +185,8 @@ class GameCanvas:
     def _fit_into(self, max_width: int, max_height: int):
         if self.map_image.width == 0 or self.map_image.height == 0:
             raise Exception("Map image invalid!")
-        aspect_ratio = (
-            self.map_image.width
-            * self.player_count
-            / (self.map_image.height + self.extra_height)
+        aspect_ratio = (self.map_image.width * self.player_count + self.extra_width) / (
+            self.map_image.height + self.extra_height
         )
         width = min(max_width, max_height * aspect_ratio)
         height = width / aspect_ratio
@@ -176,12 +194,16 @@ class GameCanvas:
         self.canvas.style.height = f"{height}px"
         self.canvas.width = width * window.devicePixelRatio
         self.canvas.height = height * window.devicePixelRatio
-        self._scale = self.canvas.width / self.player_count / self.map_image.width
+        self._scale = self.canvas.width / (
+            self.player_count * self.map_image.width + self.extra_width
+        )
         self.context = self.canvas.getContext("2d")
         self.context.textAlign = "center"
         self.context.textBaseline = "middle"
 
-        self.canvas_map_width = self.canvas.width / self.player_count
+        self.canvas_map_width = (
+            self.canvas.width - self._scale * self.extra_width
+        ) / self.player_count
         self.canvas_map_height = (
             self.canvas_map_width * self.map_image.height / self.map_image.width
         )

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "code-battles",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A library for building interactive competitive coding battles",
   "repository": "https://github.com/noamzaks/code-battles",
   "homepage": "https://code-battles.readthedocs.org",