Add command line utility

Author: malmeloo

pyproject.toml

@@ -8,6 +8,7 @@ dependencies = [
     "fs>=2.4.16",
     "httpx>=0.28.1",
     "pyelftools>=0.31",
+    "typer>=0.15.1",
     "typing-extensions>=4.12.2",
     "unicorn>=2.1.1",
 ]
@@ -69,6 +70,10 @@ pythonpath = [
   "."
 ]
 
+[project.scripts]
+ani = "anisette.cli:app"
+anisette = "anisette.cli:app"
+
 [build-system]
 requires = ["setuptools", "setuptools-scm"]
 build-backend = "setuptools.build_meta"

src/anisette/__main__.py

@@ -0,0 +1,6 @@
+"""__main__.py."""
+
+if __name__ == "__main__":
+    from .cli import app
+
+    app()

src/anisette/_util.py

@@ -1,5 +1,8 @@
 from __future__ import annotations
 
+import logging
+import os
+import platform
 import re
 from contextlib import contextmanager
 from io import BytesIO
@@ -59,3 +62,29 @@ def open_file(fp: BinaryIO | str | Path, mode: Literal["rb", "wb+"] = "rb") -> I
 
     if do_close:
         file.close()
+
+
+def get_config_dir(dir_name: str) -> Path | None:
+    plat = platform.system()
+    if plat == "Windows":
+        path_str = os.getenv("LOCALAPPDATA")
+    elif plat in ("Linux", "Darwin"):
+        path_str = os.getenv("XDG_CONFIG_HOME")
+        if path_str is None:
+            home = os.getenv("HOME")
+            if home is None:
+                logging.info("Could not determine home directory")
+                return None
+            subpath = os.path.join(home, ".config" if plat == "Linux" else "Library/Preferences")  # noqa: PTH118
+            path_str = os.getenv("XDG_CONFIG_HOME", subpath)
+    else:
+        logging.info("Platform unsupported: %s", plat)
+        return None
+
+    if path_str is None:
+        logging.info("Could not determine config directory")
+        return None
+
+    path = Path(path_str) / dir_name
+    path.mkdir(parents=True, exist_ok=True)
+    return path

src/anisette/cli.py

@@ -0,0 +1,188 @@
+"""CLI functionality."""
+
+# ruff: noqa: T201
+
+from __future__ import annotations
+
+import hashlib
+import json
+import logging
+from typing import TYPE_CHECKING, Annotated
+
+import typer
+from rich.console import Console
+from rich.table import Table
+
+from ._util import get_config_dir
+from .anisette import Anisette
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+app = typer.Typer(no_args_is_help=True)
+console = Console()
+
+
+class _AniError(Exception):
+    pass
+
+
+class _SessionManager:
+    def __init__(self, conf_dir: Path | None = None) -> None:
+        self._conf_dir: Path | None = conf_dir
+
+    @property
+    def can_save(self) -> bool:
+        return self.config_dir is not None
+
+    @property
+    def config_dir(self) -> Path | None:
+        if self._conf_dir is not None:
+            return self._conf_dir
+
+        self._conf_dir = get_config_dir("anisette-py")
+        if self._conf_dir is None:
+            logging.warning("Could not find user config directory")
+            return None
+        return self._conf_dir
+
+    @property
+    def libs_path(self) -> Path | None:
+        if self.config_dir is None:
+            return None
+        return self.config_dir / "libs.bin"
+
+    def _get_prov_path(self, name: str) -> Path:
+        assert self.config_dir is not None
+
+        return self.config_dir / f"{name}.prov"
+
+    def save(self, session: Anisette, name: str) -> None:
+        assert self.config_dir is not None
+
+        prov_path = self._get_prov_path(name)
+        session.save_provisioning(prov_path)
+
+    def get_hash(self, name: str) -> str:
+        assert self.config_dir is not None
+
+        prov_path = self._get_prov_path(name)
+        if not prov_path.exists():
+            msg = f"Session does not exist: '{name}'"
+            raise _AniError(msg)
+
+        with prov_path.open("rb") as f:
+            return hashlib.sha256(f.read()).hexdigest()[:10]
+
+    def new(self, name: str) -> Anisette:
+        assert self.config_dir is not None
+        assert self.libs_path is not None
+
+        prov_path = self._get_prov_path(name)
+        if prov_path.exists():
+            msg = f"Session with name '{name}' already exists"
+            raise _AniError(msg)
+
+        if not self.libs_path.exists():
+            session = Anisette.init()
+            session.save_libs(self.libs_path)
+        else:
+            session = Anisette.init(self.libs_path)
+        self.save(session, name)
+
+        return session
+
+    def remove(self, name: str) -> None:
+        assert self.config_dir is not None
+
+        self._get_prov_path(name).unlink(missing_ok=True)
+
+    def get(self, name: str) -> Anisette:
+        assert self.config_dir is not None
+        assert self.libs_path is not None
+
+        if not self.libs_path.exists():
+            msg = "Libraries are not available"
+            raise _AniError(msg)
+
+        prov_path = self._get_prov_path(name)
+        if not prov_path.exists():
+            msg = f"Session with name '{name}' does not exist"
+            raise _AniError(msg)
+
+        return Anisette.load(self.libs_path, prov_path)
+
+    def list(self) -> list[str]:
+        assert self.config_dir is not None
+
+        return [path.stem for path in self.config_dir.glob("*.prov")]
+
+
+@app.command()
+def new(name: Annotated[str, typer.Argument()] = "default") -> None:
+    """Create a new Anisette session."""
+    sessions = _SessionManager()
+    if not sessions.can_save:
+        print("Unable to figure out a config directory to store new sessions")
+        raise typer.Exit(code=1)
+
+    try:
+        sessions.new(name)
+    except _AniError as e:
+        print(str(e))
+        raise typer.Abort from None
+    print(f"Successfully created new session: '{name}'")
+
+
+@app.command()
+def remove(name: Annotated[str, typer.Argument()] = "default") -> None:
+    """Remove a saved Anisette session."""
+    sessions = _SessionManager()
+    if not sessions.can_save:
+        print("Unable to figure out a config directory to retrieve sessions from")
+        raise typer.Exit(code=1)
+
+    try:
+        sessions.remove(name)
+    except _AniError as e:
+        print(str(e))
+        raise typer.Abort from None
+    print(f"Successfully destroyed session: '{name}'")
+
+
+@app.command()
+def get(name: Annotated[str, typer.Argument()] = "default") -> None:
+    """Get Anisette data for a saved session."""
+    sessions = _SessionManager()
+    if not sessions.can_save:
+        print("Unable to figure out a config directory to retrieve sessions from")
+        raise typer.Exit(code=1)
+
+    try:
+        ani = sessions.get(name)
+    except _AniError as e:
+        print(str(e))
+        raise typer.Abort from None
+    data = ani.get_data()
+    sessions.save(ani, name)
+
+    print(json.dumps(data, indent=2))
+
+
+@app.command(name="list")
+def list_() -> None:
+    """List Anisette sessions."""
+    sessions = _SessionManager()
+    if not sessions.can_save:
+        print("Unable to figure out a config directory to retrieve sessions from")
+        raise typer.Exit(code=1)
+
+    table = Table("Session name", "Revision")
+    for name in sessions.list():
+        digest = sessions.get_hash(name)
+        table.add_row(name, digest)
+    console.print(table)
+
+
+if __name__ == "__main__":
+    app()