feat: support interactive feedback

Author: mtth

src/git_draft/__init__.py

@@ -3,12 +3,14 @@
 import logging
 
 from .bots import Action, Bot, Goal
+from .feedback import Feedback
 from .toolbox import Toolbox
 
 
 __all__ = [
     "Action",
     "Bot",
+    "Feedback",
     "Goal",
     "Toolbox",
 ]

src/git_draft/bots/common.py

@@ -6,6 +6,7 @@
 from pathlib import Path
 
 from ..common import ensure_state_home, qualified_class_name
+from ..feedback import Feedback
 from ..toolbox import Toolbox
 
 
@@ -14,7 +15,14 @@ class Goal:
     """Bot request"""
 
     prompt: str
-    # TODO: Add timeout.
+    # TODO: Add timeout here.
+
+
+class Feedback:
+    """teractive user feedback interface"""
+
+    def ask(self, question: str) -> str | None:
+        raise NotImplementedError()
 
 
 @dataclasses.dataclass
@@ -66,6 +74,8 @@ def state_folder_path(cls, ensure_exists: bool = False) -> Path:
             path.mkdir(parents=True, exist_ok=True)
         return path
 
-    async def act(self, goal: Goal, toolbox: Toolbox) -> Action:
+    async def act(
+        self, goal: Goal, toolbox: Toolbox, feedback: Feedback
+    ) -> Action:
         """Runs the bot, striving to achieve the goal with the given toolbox"""
         raise NotImplementedError()

src/git_draft/drafter.py

@@ -15,6 +15,7 @@
 
 from .bots import Action, Bot, Goal
 from .common import JSONObject, Progress, qualified_class_name, reindent
+from .feedback import Feedback
 from .git import SHA, Repo
 from .prompt import TemplatedPrompt
 from .store import Store, sql
@@ -106,6 +107,7 @@ async def generate_draft(
         bot: Bot,
         merge_strategy: DraftMergeStrategy | None = None,
         prompt_transform: Callable[[str], str] | None = None,
+        feedback: Feedback | None = None,
     ) -> Draft:
         with self._progress.spinner("Preparing prompt...") as spinner:
             # Handle prompt templating and editing. We do this first in case
@@ -146,12 +148,11 @@ async def generate_draft(
             change = await self._generate_change(
                 bot,
                 Goal(prompt_contents),
-                toolbox.with_visitors(
-                    [operation_recorder],
-                ),
+                toolbox.with_visitors([operation_recorder]),
+                feedback,
             )
             if change.action.question:
-                self._progress.report("Requested progress.")
+                self._progress.report("Requested feedback.")
             spinner.update(
                 "Completed bot run.",
                 runtime=round(change.walltime.total_seconds(), 1),
@@ -346,12 +347,13 @@ async def _generate_change(
         bot: Bot,
         goal: Goal,
         toolbox: RepoToolbox,
+        feedback: Feedback,
     ) -> _Change:
         old_tree_sha = toolbox.tree_sha()
 
         start_time = time.perf_counter()
         _logger.debug("Running bot... [bot=%s]", bot)
-        action = await bot.act(goal, toolbox)
+        action = await bot.act(goal, toolbox, feedback)
         _logger.info("Completed bot action. [action=%s]", action)
         end_time = time.perf_counter()
 

src/git_draft/feedback.py

@@ -0,0 +1,13 @@
+"""user feedback capabilities"""
+
+
+class Feedback:
+    """Interactive user feedback interface"""
+
+    def ask(self, question: str) -> str | None:
+        raise NotImplementedError()
+
+
+class LiveFeedback(Feedback):
+    def ask(self, question: str) -> str | None:
+        raise NotImplementedError()

src/git_draft/toolbox.py

@@ -11,7 +11,7 @@
 import tempfile
 from typing import Protocol, Self, override
 
-from .common import UnreachableError
+from .common import UnreachableError, UserFeedback
 from .git import SHA, GitError, Repo, null_delimited
 
 
@@ -32,10 +32,6 @@ class Toolbox:
     # TODO: Support a diff-based edit method.
     # https://gist.github.com/noporpoise/16e731849eb1231e86d78f9dfeca3abc
 
-    # TODO: Add user feedback tool here. This will make it possible to request
-    # feedback more than once during a bot action, which leads to a better
-    # experience when used interactively.
-
     def __init__(self, visitors: Sequence[ToolVisitor] | None = None) -> None:
         self._visitors = visitors or []
 
@@ -133,13 +129,15 @@ def on_delete_file(
     ) -> None: ...  # pragma: no cover
 
     def on_rename_file(
-        self,
-        src_path: PurePosixPath,
-        dst_path: PurePosixPath,
+        self, src_path: PurePosixPath, dst_path: PurePosixPath
     ) -> None: ...  # pragma: no cover
 
     def on_expose_files(self) -> None: ...  # pragma: no cover
 
+    def on_request_feedback(
+        self, question: str
+    ) -> None: ...  # pragma: no cover
+
 
 class NoopToolbox(Toolbox):
     """No-op read-only toolbox"""
@@ -179,18 +177,22 @@ def __init__(
         self,
         repo: Repo,
         start_rev: SHA,
+        user_feedback: UserFeedback | None = None,
         visitors: Sequence[ToolVisitor] | None = None,
     ) -> None:
         super().__init__(visitors)
         call = repo.git("rev-parse", "--verify", f"{start_rev}^{{tree}}")
         self._tree_sha = call.stdout
         self._tree_updates = list[_TreeUpdate]()
         self._repo = repo
+        self._user_feedback = user_feedback
 
     @classmethod
-    def for_working_dir(cls, repo: Repo) -> tuple[Self, bool]:
+    def for_working_dir(
+        cls, repo: Repo, user_feedback: UserFeedback | None = None
+    ) -> tuple[Self, bool]:
         index_tree_sha = repo.git("write-tree").stdout
-        toolbox = cls(repo, index_tree_sha)
+        toolbox = cls(repo, user_feedback, index_tree_sha)
         toolbox._sync_updates()  # Apply any changes from the working directory
         head_tree_sha = repo.git("rev-parse", "HEAD^{tree}").stdout
         return toolbox, toolbox.tree_sha() != head_tree_sha