code-battles-cli 1.2.2__py3-none-any.whl → 1.2.4__py3-none-any.whl

code_battles_cli/__init__.py

@@ -1 +1 @@
-from code_battles_cli.cli import main
+from code_battles_cli.cli import main as main

code_battles_cli/__main__.py

@@ -1,4 +1,5 @@
-from code_battles_cli.cli import main
 import sys
 
+from code_battles_cli.cli import main
+
 sys.exit(main())

code_battles_cli/api.py

@@ -4,6 +4,8 @@ Code Battles Python Client API
 Firestore client implementation inspired by https://medium.com/@bobthomas295/client-side-authentication-with-python-firestore-and-firebase-352e484a2634
 """
 
+from __future__ import annotations
+
 import base64
 import datetime
 import gzip
@@ -15,12 +17,13 @@ import subprocess
 import sys
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Any, Callable, Dict, List, Optional, Union
+from typing import Any, Callable, Literal
 
 import requests
 from google.cloud.firestore import Client as FirestoreClient
 from google.oauth2.credentials import Credentials
 from rich.prompt import Prompt
+from typing_extensions import overload
 
 from code_battles_cli.log import console, log
 
@@ -28,7 +31,7 @@ SIMULATION_FINISHED_MARK = b"--- SIMULATION FINISHED ---"
 SIMULATION_STEP_MARK = b"__CODE_BATTLES_ADVANCE_STEP"
 
 
-def normalize(url: str):
+def normalize(url: str) -> str:
     if url.startswith("https"):
         url = url[5:]
 
@@ -45,7 +48,7 @@ class SimulationException(Exception):
         self.stderr = stderr
         self.exit_code = exit_code
 
-    def __str__(self):
+    def __str__(self) -> str:
         return (
             f"Simulation failed with exit code {self.exit_code}. Output:\n"
             + self.stderr.decode()
@@ -57,7 +60,7 @@ class LogEntry:
     step: int
     text: str
     color: str
-    player_index: Optional[int]
+    player_index: int | None
 
 
 @dataclass
@@ -65,22 +68,23 @@ class SimulationResults:
     winner_index: int
     winner: str
     steps: int
-    logs: List[LogEntry]
+    logs: list[LogEntry]
 
 
 @dataclass
 class Simulation:
-    parameters: Dict[str, str]
+    parameters: dict[str, str]
+    statistics: dict[str, float]
     player_names: str
     game: str
     version: str
     timestamp: datetime.datetime
-    logs: list
-    alerts: list
-    decisions: List[bytes]
+    logs: list[Any]
+    alerts: list[Any]
+    decisions: list[bytes]
     seed: int
 
-    def dump(self):
+    def dump(self) -> str:
         return base64.b64encode(
             gzip.compress(
                 json.dumps(
@@ -97,18 +101,20 @@ class Simulation:
                             for decision in self.decisions
                         ],
                         "seed": self.seed,
+                        "statistics": self.statistics,
                     }
                 ).encode()
             )
         ).decode()
 
     @staticmethod
-    def load(file: str):
-        contents: Dict[str, Any] = json.loads(gzip.decompress(base64.b64decode(file)))
+    def load(file: str) -> Simulation:
+        contents: dict[str, Any] = json.loads(gzip.decompress(base64.b64decode(file)))
         return Simulation(
             contents["parameters"]
             if "parameters" in contents
             else {"map": contents["map"]},
+            contents.get("statistics", {}),
             contents["playerNames"],
             contents["game"],
             contents["version"],
@@ -123,10 +129,10 @@ class Simulation:
 class Client:
     def __init__(
         self,
-        url: Optional[str] = None,
-        username: Optional[str] = None,
-        password: Optional[str] = None,
-        dump_credentials=True,
+        url: str | None = None,
+        username: str | None = None,
+        password: str | None = None,
+        dump_credentials: bool = True,
     ):
         """
         Creates a client for getting and setting the bots for a Code Battles hosted at `url`
@@ -146,16 +152,13 @@ class Client:
         if dump_credentials:
             self._dump_credentials()
 
-    def _get_credentials(self):
+    def _get_credentials(self) -> None:
         if os.path.exists("code-battles.json"):
-            try:
-                with open("code-battles.json", "r") as f:
-                    configuration = json.load(f)
-                self.url: str = configuration["url"]
-                self.username: str = configuration["username"]
-                self.password: str = configuration["password"]
-            except Exception:
-                pass
+            with open("code-battles.json", "r") as f:
+                configuration = json.load(f)
+            self.url = configuration["url"]
+            self.username = configuration["username"]
+            self.password = configuration["password"]
 
         if (
             not hasattr(self, "url")
@@ -171,14 +174,14 @@ class Client:
 
             self.username = Prompt.ask("Enter your team's username", console=console)
 
-            if not self.username == self.username.lower():
+            if self.username != self.username.lower():
                 log.warning("Your username should most likely be lowercased.")
 
             self.password = Prompt.ask(
                 "Enter your team's password", console=console, password=True
             )
 
-    def _dump_credentials(self):
+    def _dump_credentials(self) -> None:
         with open("code-battles.json", "w") as f:
             json.dump(
                 {"url": self.url, "username": self.username, "password": self.password},
@@ -188,12 +191,12 @@ class Client:
             "Credentials were dumped to `code-battles.json`. Make sure other teams don't have access to this file!"
         )
 
-    def _get_firebase_data(self):
+    def _get_firebase_data(self) -> None:
         configuration = requests.get(self.url + "/firebase-configuration.json").json()
         self.firebase_api_key: str = configuration["apiKey"]
         self.firebase_project_id: str = configuration["projectId"]
 
-    def _sign_in(self, email_domain="gmail.com"):
+    def _sign_in(self, email_domain: str = "gmail.com") -> None:
         try:
             response = requests.post(
                 f"https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key={self.firebase_api_key}",
@@ -203,27 +206,29 @@ class Client:
                     "returnSecureToken": True,
                 },
             ).json()
-        except Exception:
-            raise Exception(
+        except Exception as e:
+            raise RuntimeError(
                 "Sign in failed! Make sure the username and password are correct."
-            )
+            ) from e
 
         self.credentials = Credentials(response["idToken"], response["refreshToken"])
         self.client = FirestoreClient(self.firebase_project_id, self.credentials)
         self.document = self.client.document(f"bots/{self.username}")
 
-    def get_bots(self) -> Dict[str, str]:
+    def get_bots(self) -> dict[str, str]:
         """Returns a mapping from a bot's name to their Python code."""
-        return self.document.get().to_dict()
+        result = self.document.get().to_dict()
+        assert result is not None
+        return result
 
-    def set_bots(self, bots: Dict[str, str], merge=True) -> None:
+    def set_bots(self, bots: dict[str, str], merge: bool = True) -> None:
         """
         Sets the bots in the website to the specified bots.
         Doesn't remove any bot unless ``merge`` is ``False``, in which case only bots specified in ``bots`` will remain.
         """
         self.document.set(bots, merge)
 
-    def _possibly_download(self, force_download=False):
+    def _possibly_download(self, force_download: bool = False) -> str:
         directory_name = "".join(
             [c for c in normalize(self.url) if c.isalnum() or c == "-"]
         )
@@ -245,14 +250,16 @@ class Client:
 
     def _get_simulation_output(
         self,
-        p: subprocess.Popen,
-        json_output=False,
-        on_step: Optional[Callable[[], None]] = None,
-    ) -> Union[SimulationResults, str]:
+        p: subprocess.Popen[bytes],
+        json_output: bool = False,
+        on_step: Callable[[], None] | None = None,
+    ) -> SimulationResults | str:
         while True:
-            if p.poll() is not None and p.returncode != 0:
+            if p.poll() is not None:
+                assert p.stderr is not None
                 raise SimulationException(p.stderr.read(), p.returncode)
 
+            assert p.stdout is not None
             line: bytes = p.stdout.readline()
             line = line.strip()
             if line == SIMULATION_FINISHED_MARK:
@@ -267,19 +274,20 @@ class Client:
         if json_output:
             return output.decode()
 
-        output = json.loads(output)
+        output_json = json.loads(output)
         result = SimulationResults(
-            output["winner_index"],
-            output["winner"],
-            output["steps"],
+            output_json["winner_index"],
+            output_json["winner"],
+            output_json["steps"],
             [
                 LogEntry(
                     entry["step"], entry["text"], entry["color"], entry["player_index"]
                 )
-                for entry in output["logs"]
+                for entry in output_json["logs"]
             ],
         )
 
+        assert p.stderr is not None
         error: bytes = p.stderr.read()
         exit_code = p.wait()
         if exit_code != 0:
@@ -287,17 +295,43 @@ class Client:
 
         return result
 
+    @overload
+    def run_simulation(
+        self,
+        parameters: dict[str, str],
+        bot_filenames: list[str],
+        bot_names: list[str] | None = None,
+        seed: int | None = None,
+        force_download: bool = False,
+        json_output: Literal[False] = False,
+        on_step: Callable[[], None] | None = None,
+        output_file: str | None = None,
+    ) -> SimulationResults: ...
+
+    @overload
+    def run_simulation(
+        self,
+        parameters: dict[str, str],
+        bot_filenames: list[str],
+        bot_names: list[str] | None = None,
+        seed: int | None = None,
+        force_download: bool = False,
+        json_output: Literal[True] = True,
+        on_step: Callable[[], None] | None = None,
+        output_file: str | None = None,
+    ) -> str: ...
+
     def run_simulation(
         self,
-        parameters: Dict[str, str],
-        bot_filenames: List[str],
-        bot_names: Optional[List[str]] = None,
-        seed: Optional[int] = None,
-        force_download=False,
-        json_output=False,
-        on_step: Optional[Callable[[], None]] = None,
-        output_file: Optional[str] = None,
-    ) -> Union[SimulationResults, str]:
+        parameters: dict[str, str],
+        bot_filenames: list[str],
+        bot_names: list[str] | None = None,
+        seed: int | None = None,
+        force_download: bool = False,
+        json_output: bool = False,
+        on_step: Callable[[], None] | None = None,
+        output_file: str | None = None,
+    ) -> SimulationResults | str:
         """
         Runs the given simulation without UI locally.
         If ``bot_names`` is not specified, they will be the filenames without the extension.
@@ -340,10 +374,10 @@ class Client:
     def run_simulation_from_file(
         self,
         simulation_file: str,
-        force_download=False,
-        json_output=False,
-        on_step: Optional[Callable[[], None]] = None,
-    ) -> Union[SimulationResults, str]:
+        force_download: bool = False,
+        json_output: bool = False,
+        on_step: Callable[[], None] | None = None,
+    ) -> SimulationResults | str:
         """
         Runs the given simulation without UI locally from the given simulation file.
 

code_battles_cli/cli.py

@@ -1,22 +1,20 @@
-import datetime
-
 import click
 
 
 @click.group()
 @click.version_option(message="%(prog)s %(version)s")
-def cli():
+def cli() -> None:
     pass
 
 
 def main() -> int:
-    from code_battles_cli.log import setup_logging, log
+    from code_battles_cli.log import setup_logging
 
     setup_logging()
 
     from code_battles_cli.commands.download import download
-    from code_battles_cli.commands.upload import upload
     from code_battles_cli.commands.run import run
+    from code_battles_cli.commands.upload import upload
 
     cli.add_command(download)
     cli.add_command(upload)

code_battles_cli/commands/download.py

@@ -1,5 +1,6 @@
+from __future__ import annotations
+
 import os
-from typing import Optional
 
 import click
 
@@ -35,18 +36,18 @@ from code_battles_cli.log import log
     help="The directory to download the bots into",
 )
 def download(
-    url: Optional[str],
-    username: Optional[str],
-    password: Optional[str],
+    url: str | None,
+    username: str | None,
+    password: str | None,
     dump_credentials: bool,
-    bot: Optional[str],
+    bot: str | None,
     d: str,
-):
+) -> None:
     client = Client(url, username, password, dump_credentials)
     bots = client.get_bots()
     if bot is not None:
         if bot not in bots:
-            raise Exception(f"The specified bot '{bot}' does not exist!")
+            raise KeyError(bot)
         bots = {bot: bots[bot]}
 
     if not os.path.exists(d):

code_battles_cli/commands/run.py

@@ -1,8 +1,8 @@
+from __future__ import annotations
+
 import json
 import logging
-import sys
 import time
-from typing import List, Optional, Tuple
 
 import click
 
@@ -50,17 +50,17 @@ from code_battles_cli.log import log, progress
     help="Output file to dump the simulation into",
 )
 def run(
-    url: Optional[str],
-    username: Optional[str],
-    password: Optional[str],
+    url: str | None,
+    username: str | None,
+    password: str | None,
     dump_credentials: bool,
-    parameters: Optional[str],
-    bots: Tuple[str],
+    parameters: str | None,
+    bots: tuple[str],
     force_download: bool,
-    seed: Optional[int],
-    simulation_file: Optional[str],
-    output_file: Optional[str],
-):
+    seed: int | None,
+    simulation_file: str | None,
+    output_file: str | None,
+) -> None:
     logging.getLogger("rich").setLevel(logging.WARNING)
     client = Client(url, username, password, dump_credentials)
     client._possibly_download(force_download)
@@ -69,7 +69,7 @@ def run(
     with progress:
         progress_id = progress.add_task("[green]Simulating...", total=None)
 
-        def on_step():
+        def on_step() -> None:
             progress.update(progress_id, advance=1)
 
         if simulation_file is not None:
@@ -103,6 +103,7 @@ def run(
         else:
             assert map is not None, "Map is required for simulation!"
             assert len(bots) > 0, "Bots are required for simulation!"
+            assert parameters is not None, "Parameters are required for simulation!"
 
             results = client.run_simulation(
                 json.loads(parameters),

code_battles_cli/commands/upload.py

@@ -1,5 +1,6 @@
+from __future__ import annotations
+
 import os
-from typing import Optional
 
 import click
 
@@ -33,12 +34,12 @@ from code_battles_cli.log import log
 )
 def upload(
     file: str,
-    name: Optional[str],
-    url: Optional[str],
-    username: Optional[str],
-    password: Optional[str],
+    name: str | None,
+    url: str | None,
+    username: str | None,
+    password: str | None,
     dump_credentials: bool,
-):
+) -> None:
     bot_name = name if name is not None else os.path.splitext(os.path.basename(file))[0]
     with open(file, "r") as f:
         bot_code = f.read()

code_battles_cli/log.py

@@ -1,11 +1,11 @@
-import os
 import logging
+import os
 
 from rich.console import Console
+from rich.logging import RichHandler
 from rich.progress import BarColumn, MofNCompleteColumn, Progress, TextColumn
 from rich.table import Column
 from rich.traceback import install
-from rich.logging import RichHandler
 
 log = logging.getLogger("rich")
 console = Console()
@@ -22,7 +22,7 @@ progress = Progress(
 )
 
 
-def setup_logging():
+def setup_logging() -> None:
     FORMAT = "%(message)s"
 
     logging.basicConfig(

{code_battles_cli-1.2.2.dist-info → code_battles_cli-1.2.4.dist-info}/METADATA

@@ -1,12 +1,12 @@
 Metadata-Version: 2.3
 Name: code-battles-cli
-Version: 1.2.2
+Version: 1.2.4
 Summary: A CLI for competitors in any Code Battles event!
-Requires-Python: >=3.8
-Requires-Dist: click>=8.1.7
-Requires-Dist: google-cloud-firestore>=2.19.0
 Requires-Dist: requests>=2.32.3
+Requires-Dist: google-cloud-firestore>=2.19.0
 Requires-Dist: rich>=13.9.3
+Requires-Dist: click>=8.1.7
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 
 <p align="center">
@@ -27,8 +27,6 @@ Description-Content-Type: text/markdown
     🏃 <a href="#getting-started">Getting Started</a>
     &nbsp;&middot&nbsp;
     💡 <a href="#features">Features</a>
-    &nbsp;&middot&nbsp;
-    🚗 <a href="#roadmap">Roadmap</a>
 </p>
 
 # Getting Started
@@ -72,9 +70,6 @@ print(client.get_bots())
 print(client.run_simulation("NYC", ["bots/example.py", "bots/another_example.py"]))
 ```
 
-# Roadmap
+# Development
 
--   [x] Download bots.
--   [x] Upload bots.
--   [x] Run no-UI simulations locally.
--   [x] Be usable in scripts.
+For development, you should set up the pre-commit hooks with `uv run pre-commit install`.

code_battles_cli-1.2.4.dist-info/RECORD

@@ -0,0 +1,13 @@
+code_battles_cli/__init__.py,sha256=e4yZ-ISH6W6yB4H3LfSwWqgLCoDq590AqLc9oDBJm28,46
+code_battles_cli/__main__.py,sha256=GPfXVInXFwXguLMPetLgyZMpurU_JTLZSA-434qa5FQ,68
+code_battles_cli/api.py,sha256=wgJvasD4KRjMvKm7mY439VVbCqTznq2G1KmHuH8ySwE,13242
+code_battles_cli/cli.py,sha256=i_q52rrwhgcvJAMPw22TWjnux8ZJuqTBmtpRmZ8Sij8,501
+code_battles_cli/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+code_battles_cli/commands/download.py,sha256=3t0if_umsLVdLL6Ub16uabnKJ1lYahxl6Vl_q6QcttQ,1562
+code_battles_cli/commands/run.py,sha256=Sn6ae_gKKPCdQeVc0ngs5Sc158kAYEQxB3nkC9_IM5M,3936
+code_battles_cli/commands/upload.py,sha256=yQnDFV32q7Ceca1d7uhBjSKh0q9nEwNUWIFI55Cxs2s,1393
+code_battles_cli/log.py,sha256=cptG9uKvfFt_qQqWiFy3HwTsJOgl-kQ1RGsf7C1MD8E,868
+code_battles_cli-1.2.4.dist-info/WHEEL,sha256=cmC5s21ojypbVslldL7IJq3hjZH-tINy4rziKePFsG0,81
+code_battles_cli-1.2.4.dist-info/entry_points.txt,sha256=kBhS-oNCbSPAyLJql9I0uPxnYqgcnhCIgDM9ZpdLiKs,56
+code_battles_cli-1.2.4.dist-info/METADATA,sha256=3msqI8ydwhsX75du8SEIgZCfOhlrOjwPvJOfgWOmMgI,2439
+code_battles_cli-1.2.4.dist-info/RECORD,,

{code_battles_cli-1.2.2.dist-info → code_battles_cli-1.2.4.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.26.3
+Generator: uv 0.12.23
 Root-Is-Purelib: true
 Tag: py3-none-any

{code_battles_cli-1.2.2.dist-info → code_battles_cli-1.2.4.dist-info}/entry_points.txt

@@ -1,2 +1,3 @@
 [console_scripts]
 code-battles = code_battles_cli:main
+

code_battles_cli-1.2.2.dist-info/RECORD

@@ -1,14 +0,0 @@
-code_battles_cli/__init__.py,sha256=BST1iXWs0ner82h-LTYTgVNjLtOpVZnvBMiCEiBkOXE,38
-code_battles_cli/__main__.py,sha256=HguVXadDv5QVywZWoB-BETvX1WV4VPYxclfnKhvOrZc,67
-code_battles_cli/api.py,sha256=iv7peRbTsjL29lU5XjrjfFo9cZ3QUubA5Q4kziz2SAo,12056
-code_battles_cli/cli.py,sha256=yfUAlU85FBykU_pHB6HHQCc7_ZN0KiPbc8ssB4TOgIc,515
-code_battles_cli/log.py,sha256=Ume7UPFdKNqu-DI2hpc6cefyMZQeFavc_cWizKooq98,860
-code_battles_cli/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-code_battles_cli/commands/download.py,sha256=ZLwbHdcqak6uuXEMb1Mp4fXW7QxkdbIlpKxSUR-WQDA,1600
-code_battles_cli/commands/run.py,sha256=J3IFVVoUAJWLa7ZtDvDhrFYt7Yx3aQYbVo9Z2SomeWQ,3872
-code_battles_cli/commands/upload.py,sha256=8Y6kKS4ynnmsmfM0IqtljF6gT7PUcrcJz9ilzrKUuTk,1389
-code_battles_cli-1.2.2.dist-info/METADATA,sha256=S5v0En-U7awBMja-F0AbF8p7HfWsBjRZNb4NDWRL8vE,2523
-code_battles_cli-1.2.2.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-code_battles_cli-1.2.2.dist-info/entry_points.txt,sha256=U_iQUEDK-9L09jXd_sJg0IgKLWeN3rccCyNVUeJuQxw,55
-code_battles_cli-1.2.2.dist-info/licenses/LICENSE.md,sha256=eYDByTiNbk3_TPH_i-FU-bHnfNb6VidN57zMO2dfaUM,1087
-code_battles_cli-1.2.2.dist-info/RECORD,,

code_battles_cli-1.2.2.dist-info/licenses/LICENSE.md

@@ -1,7 +0,0 @@
-Copyright 2024 Noam Zaks and Code Battles Contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.