refactor: rename assistant to bot (#20)

Author: mtth

src/git_draft/__init__.py

@@ -1,10 +1,10 @@
 import logging
 
-from .assistants import Assistant, Session, Toolbox
+from .bots import Action, Bot, Toolbox
 
 __all__ = [
-    "Assistant",
-    "Session",
+    "Action",
+    "Bot",
     "Toolbox",
 ]
 

src/git_draft/__main__.py

@@ -6,7 +6,7 @@
 import sys
 import textwrap
 
-from .assistants import load_assistant
+from .bots import load_bot
 from .common import Store, open_editor
 from .manager import Manager
 
@@ -47,9 +47,9 @@ def callback(_option, _opt, _value, parser) -> None:
 
 parser.add_option(
     "-a",
-    "--assistant",
-    dest="assistant",
-    help="assistant key",
+    "--bot",
+    dest="bot",
+    help="bot key",
     default="openai",
 )
 parser.add_option(
@@ -96,15 +96,15 @@ def main() -> None:
 
     command = getattr(opts, "command", "generate")
     if command == "generate":
-        assistant = load_assistant(opts.assistant, {})
+        bot = load_bot(opts.bot, {})
         prompt = opts.prompt
         if not prompt:
             if sys.stdin.isatty():
                 prompt = open_editor(textwrap.dedent(EDITOR_PLACEHOLDER))
             else:
                 prompt = sys.stdin.read()
         manager.generate_draft(
-            prompt, assistant, checkout=opts.checkout, reset=opts.reset
+            prompt, bot, checkout=opts.checkout, reset=opts.reset
         )
     elif command == "finalize":
         manager.finalize_draft(delete=opts.delete)

src/git_draft/assistants/__init__.py

@@ -0,0 +1,26 @@
+"""Bot interfaces and built-in implementations
+
+* https://aider.chat/docs/leaderboards/
+"""
+
+from typing import Any, Mapping
+
+from .common import Action, Bot, Toolbox
+
+__all__ = [
+    "Action",
+    "Bot",
+    "Toolbox",
+]
+
+
+def load_bot(entry: str, kwargs: Mapping[str, Any]) -> Bot:
+    if entry == "openai":
+        return _load_openai_bot(**kwargs)
+    raise NotImplementedError()  # TODO
+
+
+def _load_openai_bot(**kwargs) -> Bot:
+    from .openai import OpenAIBot
+
+    return OpenAIBot(**kwargs)

src/git_draft/assistants/common.py

@@ -0,0 +1,98 @@
+from __future__ import annotations
+
+import dataclasses
+from datetime import datetime
+from pathlib import PurePosixPath
+from typing import Callable, Sequence
+
+from ..common import JSONObject
+
+
+class Toolbox:
+    """File-system intermediary
+
+    Note that the toolbox is not thread-safe. Concurrent operations should be
+    serialized by the caller.
+    """
+
+    # TODO: Something similar to https://aider.chat/docs/repomap.html,
+    # including inferring the most important files, and allowing returning
+    # signature-only versions.
+
+    def __init__(self, hook: OperationHook | None = None) -> None:
+        self.operations = list[Operation]()
+        self._operation_hook = hook
+
+    def _record_operation(
+        self, reason: str | None, tool: str, **kwargs
+    ) -> None:
+        op = Operation(
+            tool=tool, details=kwargs, reason=reason, start=datetime.now()
+        )
+        self.operations.append(op)
+        if self._operation_hook:
+            self._operation_hook(op)
+
+    def list_files(self, reason: str | None = None) -> Sequence[PurePosixPath]:
+        self._record_operation(reason, "list_files")
+        return self._list()
+
+    def read_file(
+        self,
+        path: PurePosixPath,
+        reason: str | None = None,
+    ) -> str:
+        self._record_operation(reason, "read_file", path=str(path))
+        return self._read(path)
+
+    def write_file(
+        self,
+        path: PurePosixPath,
+        contents: str,
+        reason: str | None = None,
+    ) -> None:
+        self._record_operation(
+            reason, "write_file", path=str(path), size=len(contents)
+        )
+        return self._write(path, contents)
+
+    def delete_file(
+        self,
+        path: PurePosixPath,
+        reason: str | None = None,
+    ) -> None:
+        self._record_operation(reason, "delete_file", path=str(path))
+        return self._delete(path)
+
+    def _list(self) -> Sequence[PurePosixPath]:
+        raise NotImplementedError()
+
+    def _read(self, path: PurePosixPath) -> str:
+        raise NotImplementedError()
+
+    def _write(self, path: PurePosixPath, contents: str) -> None:
+        raise NotImplementedError()
+
+    def _delete(self, path: PurePosixPath) -> None:
+        raise NotImplementedError()
+
+
+@dataclasses.dataclass(frozen=True)
+class Operation:
+    tool: str
+    details: JSONObject
+    reason: str | None
+    start: datetime
+
+
+type OperationHook = Callable[[Operation], None]
+
+
+@dataclasses.dataclass(frozen=True)
+class Action:
+    title: str | None = None
+
+
+class Bot:
+    def act(self, prompt: str, toolbox: Toolbox) -> Action:
+        raise NotImplementedError()

src/git_draft/bots/__init__.py

@@ -5,7 +5,7 @@
 import textwrap
 from typing import Any, Mapping, Self, Sequence, override
 
-from .common import Assistant, Session, Toolbox
+from .common import Action, Bot, Toolbox
 
 
 _logger = logging.getLogger(__name__)
@@ -86,8 +86,8 @@ def _function_tool_param(
 """
 
 
-class OpenAIAssistant(Assistant):
-    """An OpenAI-backed assistant
+class OpenAIBot(Bot):
+    """An OpenAI-backed bot
 
     See the following links for resources:
 
@@ -100,7 +100,7 @@ class OpenAIAssistant(Assistant):
     def __init__(self) -> None:
         self._client = openai.OpenAI()
 
-    def run(self, prompt: str, toolbox: Toolbox) -> Session:
+    def act(self, prompt: str, toolbox: Toolbox) -> Action:
         # TODO: Reuse assistant.
         assistant = self._client.beta.assistants.create(
             instructions=_INSTRUCTIONS,
@@ -123,7 +123,7 @@ def run(self, prompt: str, toolbox: Toolbox) -> Session:
         ) as stream:
             stream.until_done()
 
-        return Session(0)
+        return Action()
 
 
 class _EventHandler(openai.AssistantEventHandler):

src/git_draft/bots/common.py

@@ -2,6 +2,7 @@
 
 import contextlib
 import dataclasses
+from datetime import datetime
 import functools
 import logging
 import os
@@ -14,7 +15,7 @@
 import sys
 import tempfile
 import tomllib
-from typing import Iterator, Mapping, Self
+from typing import Any, Iterator, Mapping, Self
 import xdg_base_dirs
 
 
@@ -25,6 +26,7 @@
 class Config:
     log_level: int
     bots: Mapping[str, BotConfig]
+    # TODO: Add (prompt) templates.
 
     @classmethod
     def default(cls) -> Self:
@@ -50,10 +52,14 @@ def load(cls) -> Self:
             )
 
 
+type JSONValue = Any
+type JSONObject = Mapping[str, JSONValue]
+
+
 @dataclasses.dataclass(frozen=True)
 class BotConfig:
     loader: str
-    kwargs: Mapping[str, bool | float | str] | None = None
+    kwargs: JSONObject | None = None
     pythonpath: str | None = None
 
 
@@ -101,6 +107,12 @@ def open_editor(placeholder="") -> str:
             return reader.read()
 
 
+sqlite3.register_adapter(datetime, lambda d: d.isoformat())
+sqlite3.register_converter(
+    "timestamp", lambda v: datetime.fromisoformat(v.decode())
+)
+
+
 class Store:
     _name = "db.v1.sqlite3"