code-battles-cli 1.0.0__tar.gz → 1.1.0__tar.gz

{code_battles_cli-1.0.0 → code_battles_cli-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: code-battles-cli
-Version: 1.0.0
+Version: 1.1.0
 Summary: A CLI for competitors in any Code Battles event!
 License-File: LICENSE.md
 Requires-Python: >=3.8
@@ -77,5 +77,5 @@ print(client.run_simulation("NYC", ["bots/example.py", "bots/another_example.py"
 
 -   [x] Download bots.
 -   [x] Upload bots.
--   [ ] Run no-UI simulations locally.
+-   [x] Run no-UI simulations locally.
 -   [x] Be usable in scripts.

{code_battles_cli-1.0.0 → code_battles_cli-1.1.0}/README.md

@@ -65,5 +65,5 @@ print(client.run_simulation("NYC", ["bots/example.py", "bots/another_example.py"
 
 -   [x] Download bots.
 -   [x] Upload bots.
--   [ ] Run no-UI simulations locally.
+-   [x] Run no-UI simulations locally.
 -   [x] Be usable in scripts.

{code_battles_cli-1.0.0 → code_battles_cli-1.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "code-battles-cli"
-version = "1.0.0"
+version = "1.1.0"
 description = "A CLI for competitors in any Code Battles event!"
 dependencies = [
     "requests>=2.32.3",

{code_battles_cli-1.0.0 → code_battles_cli-1.1.0}/src/code_battles_cli/api.py

@@ -4,19 +4,27 @@ Code Battles Python Client API
 Firestore client implementation inspired by https://medium.com/@bobthomas295/client-side-authentication-with-python-firestore-and-firebase-352e484a2634
 """
 
+import base64
+import datetime
+import logging
+import gzip
 import os
 import json
 import shutil
 import subprocess
 import sys
-from typing import Dict, List, Optional, Union
+from typing import Any, Callable, Dict, List, Optional, Union
 from dataclasses import dataclass
 
 import requests
 from google.oauth2.credentials import Credentials
 from google.cloud.firestore import Client as FirestoreClient
 from rich.prompt import Prompt
-from code_battles_cli.log import console, log
+from code_battles_cli.log import console, log, progress
+
+
+SIMULATION_FINISHED_MARK = b"--- SIMULATION FINISHED ---"
+SIMULATION_STEP_MARK = b"__CODE_BATTLES_ADVANCE_STEP"
 
 
 @dataclass
@@ -35,6 +43,53 @@ class SimulationResults:
     logs: List[LogEntry]
 
 
+@dataclass
+class Simulation:
+    map: str
+    player_names: str
+    game: str
+    version: str
+    timestamp: datetime.datetime
+    logs: list
+    decisions: List[bytes]
+    seed: int
+
+    def dump(self):
+        return base64.b64encode(
+            gzip.compress(
+                json.dumps(
+                    {
+                        "map": self.map,
+                        "playerNames": self.player_names,
+                        "game": self.game,
+                        "version": self.version,
+                        "timestamp": self.timestamp.isoformat(),
+                        "logs": self.logs,
+                        "decisions": [
+                            base64.b64encode(decision).decode()
+                            for decision in self.decisions
+                        ],
+                        "seed": self.seed,
+                    }
+                ).encode()
+            )
+        ).decode()
+
+    @staticmethod
+    def load(file: str):
+        contents: Dict[str, Any] = json.loads(gzip.decompress(base64.b64decode(file)))
+        return Simulation(
+            contents["map"],
+            contents["playerNames"],
+            contents["game"],
+            contents["version"],
+            datetime.datetime.fromisoformat(contents["timestamp"]),
+            contents["logs"],
+            [base64.b64decode(decision) for decision in contents["decisions"]],
+            contents["seed"],
+        )
+
+
 class Client:
     def __init__(
         self,
@@ -141,13 +196,89 @@ class Client:
         """
         self.document.set(bots, merge)
 
+    def _possibly_download(self, force_download=False):
+        code_directory = os.path.expanduser(
+            f"~/.cache/code-battles/{''.join([c for c in self.url.removeprefix("https").removesuffix(".web.app") if c.isalnum()])}"
+        )
+
+        if force_download and os.path.exists(code_directory):
+            shutil.rmtree(code_directory)
+
+        if not os.path.exists(code_directory):
+            os.makedirs(code_directory)
+
+            with console.status("[blue]Fetching configuration from game website..."):
+                pyscript_configuration = requests.get(self.url + "/config.json").json()
+                logging.info(
+                    f"Fetched configuration containing {len(pyscript_configuration["files"])} game files."
+                )
+
+            with progress:
+                progress_id = progress.add_task(
+                    "[blue]Fetching game files...",
+                    total=len(pyscript_configuration["files"]),
+                )
+
+                for url_path, path in pyscript_configuration["files"].items():
+                    if not path.endswith(".py"):
+                        continue
+
+                    local_path = os.path.join(code_directory, *path.split("/"))
+                    os.makedirs(os.path.dirname(local_path), exist_ok=True)
+                    text = requests.get(self.url + url_path).text
+                    with open(local_path, "w") as f:
+                        f.write(text)
+                    progress.update(progress_id, advance=1)
+                progress.update(progress_id, visible=False)
+
+            logging.info("Finished fetching game files.")
+
+        return code_directory
+
+    def _get_simulation_output(
+        self,
+        p: subprocess.Popen,
+        json_output=False,
+        on_step: Optional[Callable[[], None]] = None,
+    ) -> Union[SimulationResults, str]:
+        while True:
+            line: bytes = p.stdout.readline()
+            line = line.strip()
+            if line == SIMULATION_FINISHED_MARK:
+                break
+            elif line == SIMULATION_STEP_MARK:
+                if on_step is not None:
+                    on_step()
+            elif len(line) != 0:
+                logging.info(line.decode())
+
+        output: bytes = p.stdout.read()
+        if json_output:
+            return output.decode()
+
+        output = json.loads(output)
+        return SimulationResults(
+            output["winner_index"],
+            output["winner"],
+            output["steps"],
+            [
+                LogEntry(
+                    entry["step"], entry["text"], entry["color"], entry["player_index"]
+                )
+                for entry in output["logs"]
+            ],
+        )
+
     def run_simulation(
         self,
         map: 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]:
         """
         Runs the given simulation without UI locally.
@@ -164,52 +295,53 @@ class Client:
                 for filename in bot_filenames
             ]
 
-        code_directory = os.path.expanduser(
-            f"~/.cache/code-battles/{''.join([c for c in self.url.removeprefix("https").removesuffix(".web.app") if c.isalnum()])}"
-        )
-
-        if force_download and os.path.exists(code_directory):
-            shutil.rmtree(code_directory)
-
-        if not os.path.exists(code_directory):
-            os.makedirs(code_directory)
-
-            pyscript_configuration = requests.get(self.url + "/config.json").json()
-
-            for url_path, path in pyscript_configuration["files"].items():
-                local_path = os.path.join(
-                    code_directory, *path.replace(".pyi", ".py").split("/")
-                )
-                os.makedirs(os.path.dirname(local_path), exist_ok=True)
-                text = requests.get(self.url + url_path).text
-                with open(local_path, "w") as f:
-                    f.write(text)
+        code_directory = self._possibly_download(force_download=force_download)
 
         p = subprocess.Popen(
             [
                 sys.executable,
                 os.path.join(code_directory, "main.py"),
+                "simulate",
+                str(seed),
+                str(output_file),
                 map,
                 "-".join(bot_names),
             ]
             + [os.path.abspath(f) for f in bot_filenames],
             env={"PYTHONPATH": os.path.join(code_directory, "code_battles")},
             stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
         )
-        p.wait()
-        output = p.stdout.read().split(b"--- SIMULATION FINISHED ---")[-1]
-        if json_output:
-            return output.decode()
 
-        output = json.loads(output)
-        return SimulationResults(
-            output["winner_index"],
-            output["winner"],
-            output["steps"],
+        return self._get_simulation_output(p, json_output, on_step)
+
+    def run_simulation_from_file(
+        self,
+        simulation_file: str,
+        force_download=False,
+        json_output=False,
+        on_step: Optional[Callable[[], None]] = None,
+    ) -> Union[SimulationResults, str]:
+        """
+        Runs the given simulation without UI locally from the given simulation file.
+
+        If required (or ``force_download``), this method downloads the simulation code from the website.
+
+        If ``json_output`` is ``True``, returns the JSON string of the results instead.
+        """
+
+        code_directory = self._possibly_download(force_download=force_download)
+
+        p = subprocess.Popen(
             [
-                LogEntry(
-                    entry["step"], entry["text"], entry["color"], entry["player_index"]
-                )
-                for entry in output["logs"]
+                sys.executable,
+                os.path.join(code_directory, "main.py"),
+                "simulate-from-file",
+                simulation_file,
             ],
+            env={"PYTHONPATH": os.path.join(code_directory, "code_battles")},
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
         )
+
+        return self._get_simulation_output(p, json_output, on_step)

{code_battles_cli-1.0.0 → code_battles_cli-1.1.0}/src/code_battles_cli/cli.py

@@ -4,6 +4,7 @@ import click
 
 
 @click.group()
+@click.version_option(message="%(prog)s %(version)s")
 def cli():
     pass
 

{code_battles_cli-1.0.0 → code_battles_cli-1.1.0}/src/code_battles_cli/commands/download.py

@@ -15,6 +15,7 @@ from code_battles_cli.log import log
 @click.option("-p", "--password", help="Your team's password")
 @click.option(
     "--dump-credentials",
+    is_flag=True,
     default=True,
     show_default=True,
     help="Dump the URL, username and password to a `code-battles.json` file",

code_battles_cli-1.1.0/src/code_battles_cli/commands/run.py

@@ -0,0 +1,114 @@
+import time
+import logging
+import sys
+from typing import List, Optional, Tuple
+
+import click
+
+from code_battles_cli.api import Client, Simulation
+from code_battles_cli.log import log, progress
+
+
+@click.command()
+@click.argument("map", required=False)
+@click.argument("bots", nargs=-1)
+@click.option(
+    "-U", "--url", help="The competitions URL, for example https://code-battles.web.app"
+)
+@click.option("-u", "--username", help="Your team's username, for example mercedes")
+@click.option("-p", "--password", help="Your team's password")
+@click.option(
+    "--dump-credentials",
+    is_flag=True,
+    default=True,
+    show_default=True,
+    help="Dump the URL, username and password to a `code-battles.json` file",
+)
+@click.option(
+    "--force-download",
+    is_flag=True,
+    default=False,
+    show_default=True,
+    help="Re-downloads the simulation code from the website",
+)
+@click.option(
+    "-s", "--seed", type=int, help="Sets the given randomness seed for the simulation"
+)
+@click.option(
+    "-S",
+    "--simulation-file",
+    type=click.Path(exists=True, dir_okay=False),
+    help="Re-downloads the simulation code from the website",
+)
+@click.option(
+    "-O",
+    "output_file",
+    type=click.Path(exists=False),
+    help="Output file to dump the simulation into",
+)
+def run(
+    url: Optional[str],
+    username: Optional[str],
+    password: Optional[str],
+    dump_credentials: bool,
+    map: str,
+    bots: Tuple[str],
+    force_download: bool,
+    seed: Optional[int],
+    simulation_file: Optional[str],
+    output_file: Optional[str],
+):
+    logging.getLogger("rich").setLevel(logging.WARNING)
+    client = Client(url, username, password, dump_credentials)
+    client._possibly_download(force_download)
+    start = time.time()
+
+    with progress:
+        progress_id = progress.add_task("[green]Simulating...", total=None)
+
+        def on_step():
+            progress.update(progress_id, advance=1)
+
+        if simulation_file is not None:
+            assert (
+                map is None
+            ), "The simulation's map is given from the simulation file!"
+            assert (
+                len(bots) == 0
+            ), "The simulation's bots are given from the simulation file!"
+            assert (
+                seed is None
+            ), "The simulation's seed is given from the simulation file!"
+            assert (
+                output_file is None
+            ), "Shouldn't dump simualtion file from existing simulation file!"
+
+            with open(simulation_file, "r") as f:
+                simulation_text = f.read()
+            simulation = Simulation.load(simulation_text)
+            logging.info(
+                f"Detected simulation file of {simulation.game} {simulation.version}"
+            )
+            logging.info(
+                f"Simulation happened in {simulation.map} between {', '.join(simulation.player_names)} with seed {simulation.seed}"
+            )
+            logging.info(f"Simulation contains {len(simulation.decisions)} decisions")
+            progress.update(progress_id, total=len(simulation.decisions) - 1)
+            results = client.run_simulation_from_file(
+                simulation_file, force_download=False, on_step=on_step
+            )
+        else:
+            assert map is not None, "Map is required for simulation!"
+            assert len(bots) > 0, "Bots are required for simulation!"
+
+            results = client.run_simulation(
+                map,
+                list(bots),
+                seed=seed,
+                force_download=False,
+                on_step=on_step,
+                output_file=output_file,
+            )
+    print("The winner is", results.winner, "after", results.steps, "steps.")
+    end = time.time()
+    log.info(f"Simulation took {(end - start) :.2f}s.")

{code_battles_cli-1.0.0 → code_battles_cli-1.1.0}/src/code_battles_cli/commands/upload.py

@@ -15,6 +15,7 @@ from code_battles_cli.log import log
 @click.option("-p", "--password", help="Your team's password")
 @click.option(
     "--dump-credentials",
+    is_flag=True,
     default=True,
     show_default=True,
     help="Dump the URL, username and password to a `code-battles.json` file",

{code_battles_cli-1.0.0 → code_battles_cli-1.1.0}/src/code_battles_cli/log.py

@@ -1,3 +1,4 @@
+import os
 import logging
 
 from rich.console import Console
@@ -25,7 +26,7 @@ def setup_logging():
     FORMAT = "%(message)s"
 
     logging.basicConfig(
-        level=logging.INFO,
+        level=os.environ.get("CODE_BATTLES_LOG_LEVEL", "INFO"),
         format=FORMAT,
         datefmt="[%X]",
         handlers=[RichHandler(console=console, markup=True)],

code_battles_cli-1.0.0/src/code_battles_cli/commands/run.py

@@ -1,46 +0,0 @@
-import time
-import logging
-from typing import List, Optional, Tuple
-
-import click
-
-from code_battles_cli.api import Client
-from code_battles_cli.log import log
-
-
-@click.command()
-@click.argument("map")
-@click.argument("bots", nargs=-1)
-@click.option(
-    "-U", "--url", help="The competitions URL, for example https://code-battles.web.app"
-)
-@click.option("-u", "--username", help="Your team's username, for example mercedes")
-@click.option("-p", "--password", help="Your team's password")
-@click.option(
-    "--dump-credentials",
-    default=True,
-    show_default=True,
-    help="Dump the URL, username and password to a `code-battles.json` file",
-)
-@click.option(
-    "--force-download",
-    default=False,
-    show_default=True,
-    help="Re-downloads the simulation code from the website",
-)
-def run(
-    url: Optional[str],
-    username: Optional[str],
-    password: Optional[str],
-    dump_credentials: bool,
-    map: str,
-    bots: Tuple[str],
-    force_download: bool,
-):
-    logging.getLogger("rich").setLevel(logging.WARNING)
-    client = Client(url, username, password, dump_credentials)
-    start = time.time()
-    results = client.run_simulation(map, list(bots), force_download=force_download)
-    print("The winner is", results.winner, "after", results.steps, "steps.")
-    end = time.time()
-    log.info(f"Simulation took {(end - start) :.2f}s.")