Interactive REPL for python -m tasauria

Author: scarletcafe

requirements.txt

@@ -1,2 +1,5 @@
 aiohttp >= 3.11, < 4
+
+# For __main__
 click >= 8.1, < 9
+ipython

tasauria/__init__.py

@@ -24,7 +24,7 @@ class VersionInfo(NamedTuple):
     micro: int
 
 
-version_info: VersionInfo = VersionInfo(major=1, minor=0, micro=5)
+version_info: VersionInfo = VersionInfo(major=1, minor=0, micro=6)
 
 __title__ = 'tasauria'
 __author__ = 'scarletcafe'

tasauria/__main__.py

@@ -0,0 +1,109 @@
+# -*- coding: utf-8 -*-
+
+"""
+
+tasauria.__main__
+==================
+
+Script that is run when using `python -m tasauria`.
+
+This drops you into an IPython shell where `emu` is an already-connected TASauria instance.
+
+
+:copyright: (c) 2025-present Devon (scarlet.cafe) R
+:license: MIT, see LICENSE for more details.
+
+"""
+
+import logging
+import sys
+import typing
+
+import click
+import IPython
+from traitlets.config import Config
+
+
+STARTUP_SCRIPT = """
+
+import click
+from tasauria import TASauria
+
+click.secho('Attempting to connect on: ', fg='green', nl=False)
+click.secho(TASAURIA_URL, fg='blue', nl=False)
+click.secho(' ...', fg='green')
+
+try:
+    emu = TASauria(TASAURIA_URL)
+    await emu.connect()
+except Exception as error:
+    raise RuntimeError("Failed to connect to TASauria server") from error
+else:
+    click.secho('Successfully connected, access emulator using ', fg='green', nl=False)
+    click.secho('`', fg='black', nl=False)
+    click.secho('emu', fg='white', nl=False)
+    click.secho('`', fg='black')
+
+VERSION_INFO = await emu.get_version_info()
+GAME_INFO = await emu.get_game_info()
+
+if VERSION_INFO.is_development_version:
+    BIZHAWK_VERSION = f'BizHawk {VERSION_INFO.git_hash} (dev)'
+else:
+    BIZHAWK_VERSION = f'BizHawk {VERSION_INFO.stable_version}'
+
+if GAME_INFO.loaded:
+    click.secho(f'{BIZHAWK_VERSION} playing ', fg='green', nl=False)
+    click.secho(GAME_INFO.name, fg='blue', nl=False)
+    click.secho(f" ({GAME_INFO.hash})", fg='cyan', nl=False)
+    click.secho(' on ', fg='green', nl=False)
+    click.secho(GAME_INFO.system, fg='blue')
+else:
+    click.secho("No game loaded", fg='green')
+
+""".strip().split("\n\n")
+
+
+LOG_FORMAT: logging.Formatter = logging.Formatter('%(asctime)s:%(levelname)s:%(name)s: %(message)s')
+LOG_STREAM: logging.Handler = logging.StreamHandler(stream=sys.stdout)
+LOG_STREAM.setFormatter(LOG_FORMAT)
+
+
+@click.command()
+@click.option('--log-level', '-v', default='INFO')
+@click.option('--log-file', '-l', default=None)
+@click.option('--port', '-p', default=20251)
+@click.option('--url', '-u', default=None)
+def entrypoint(
+    log_level: str,
+    log_file: typing.Optional[str] = None,
+    port: int = 20251,
+    url: typing.Optional[str] = None,
+):
+
+    logger = logging.getLogger()
+    logger.setLevel(getattr(logging, log_level))
+    logger.addHandler(LOG_STREAM)
+
+    if log_file:
+        log_file_handler: logging.Handler = logging.FileHandler(filename=log_file, encoding='utf-8', mode='a')
+        log_file_handler.setFormatter(LOG_FORMAT)
+        logger.addHandler(log_file_handler)
+
+    if url is None:
+        url = f"http://127.0.0.1:{port}/"
+
+    config = Config()
+    config.InteractiveShellApp.exec_lines = [
+        f"TASAURIA_URL = {url!r}",
+        *STARTUP_SCRIPT
+    ]
+
+    IPython.start_ipython(
+        using='asyncio',
+        config=config
+    )
+
+
+if __name__ == '__main__':
+    entrypoint()

tasauria/client.py

@@ -19,7 +19,7 @@
 
 from tasauria.adapters.async_ import AsyncAdapter, HTTPAdapter, WebSocketAdapter
 from tasauria.commands import AnyCommand, Command, PythonCommandInput, ServerCommandInput, ServerCommandOutput, PythonCommandOutput
-from tasauria.commands.client import ClientFrameStatusCommand, ClientFrameAdvanceCommand, ClientGameCommand, FrameStatus, GameInfo
+from tasauria.commands.client import ClientFrameStatusCommand, ClientFrameAdvanceCommand, ClientGameCommand, ClientVersionCommand, FrameStatus, GameInfo, VersionInfo
 from tasauria.commands.joypad import JoypadGetCommand, JoypadSetCommand
 from tasauria.commands.memory import MemoryReadFloatCommand, MemoryReadIntegerCommand, MemoryReadRangeCommand, MemoryWriteFloatCommand, MemoryWriteIntegerCommand, MemoryWriteRangeCommand
 from tasauria.commands.meta import MetaBatchCommand, MetaPingCommand
@@ -221,6 +221,20 @@ async def get_game_info(
             ClientGameCommand
         )
 
+    async def get_version_info(
+        self
+    ) -> VersionInfo:
+        """
+        <section>client</section>
+
+        <description language="en">
+        Gets information about the client version.
+        </description>
+        """
+        return await self._execute_command(
+            ClientVersionCommand
+        )
+
     # -- Joypad --
     async def get_joypad(
         self,

tasauria/commands/client.py

@@ -56,7 +56,7 @@ def unmarshal_output(
 
 
 class ClientFrameAdvanceInput(typing.TypedDict):
-    unpause: bool
+    unpause: typing.Optional[bool]
 
 
 class ClientFrameAdvanceCommand(Command[ClientFrameAdvanceInput, ClientFrameAdvanceInput, ClientFrameStatusServerOutput, FrameStatus]):
@@ -141,3 +141,50 @@ def unmarshal_output(
             database_status_bad=payload["databaseStatusBad"],
             game_options=payload["gameOptions"],
         )
+
+
+class ClientVersionServerOutput(typing.TypedDict):
+    stableVersion: str
+    releaseDate: str
+    gitBranch: str
+    gitHash: str
+    gitRevision: str
+    isDevelopmentVersion: bool
+    customBuildString: typing.Optional[str]
+
+
+@dataclasses.dataclass
+class VersionInfo:
+    stable_version: str
+    release_date: str
+    git_branch: str
+    git_hash: str
+    git_revision: str
+    is_development_version: bool
+    custom_build_string: typing.Optional[str]
+
+
+class ClientVersionCommand(Command[NoArguments, NoArguments, ClientVersionServerOutput, VersionInfo]):
+    @staticmethod
+    def marshal_input(
+        **kwargs: typing.Any,
+    ) -> typing.Tuple[str, NoArguments]:
+        return (
+            "/client/version",
+            {}
+        )
+
+    @staticmethod
+    def unmarshal_output(
+        payload: ClientVersionServerOutput,
+        **kwargs: typing.Any
+    ) -> VersionInfo:
+        return VersionInfo(
+            stable_version=payload["stableVersion"],
+            release_date=payload["releaseDate"],
+            git_branch=payload["gitBranch"],
+            git_hash=payload["gitHash"],
+            git_revision=payload["gitRevision"],
+            is_development_version=payload["isDevelopmentVersion"],
+            custom_build_string=payload["customBuildString"],
+        )