fixup! 6ef1b77

Author: mtth

src/git_draft/__init__.py

@@ -2,15 +2,15 @@
 
 import logging
 
-from .bots import Action, Bot, Goal, UserFeedback, WorkTree
+from .bots import Action, Bot, Goal, UserFeedback, Worktree
 
 
 __all__ = [
     "Action",
     "Bot",
     "Goal",
     "UserFeedback",
-    "WorkTree",
+    "Worktree",
 ]
 
 logging.getLogger(__name__).addHandler(logging.NullHandler())

src/git_draft/bots/__init__.py

@@ -5,15 +5,15 @@
 import sys
 
 from ..common import BotConfig, reindent
-from .common import Action, Bot, Goal, UserFeedback, WorkTree
+from .common import Action, Bot, Goal, UserFeedback, Worktree
 
 
 __all__ = [
     "Action",
     "Bot",
     "Goal",
     "UserFeedback",
-    "WorkTree",
+    "Worktree",
 ]
 
 

src/git_draft/bots/common.py

@@ -19,7 +19,7 @@ class Goal:
     # TODO: Add timeout.
 
 
-class WorkTree(Protocol):
+class Worktree(Protocol):
     """File operations
 
     Implementations may not be thread-safe. Concurrent operations should be
@@ -111,7 +111,7 @@ def state_folder_path(cls, ensure_exists: bool = False) -> Path:
         return path
 
     async def act(
-        self, goal: Goal, tree: WorkTree, feedback: UserFeedback
+        self, goal: Goal, tree: Worktree, feedback: UserFeedback
     ) -> Action:
         """Runs the bot, striving to achieve the goal"""
         raise NotImplementedError()

src/git_draft/bots/openai.py

@@ -21,7 +21,7 @@
 import openai
 
 from ..common import JSONObject, UnreachableError, config_string, reindent
-from .common import Action, Bot, Goal, UserFeedback, WorkTree
+from .common import Action, Bot, Goal, UserFeedback, Worktree
 
 
 _logger = logging.getLogger(__name__)
@@ -173,7 +173,7 @@ def params(self) -> Sequence[openai.types.chat.ChatCompletionToolParam]:
 
 
 class _ToolHandler[V]:
-    def __init__(self, tree: WorkTree) -> None:
+    def __init__(self, tree: Worktree) -> None:
         self._tree = tree
         self.question: str | None = None
 
@@ -235,7 +235,7 @@ def __init__(self, client: openai.OpenAI, model: str) -> None:
         self._model = model
 
     async def act(
-        self, goal: Goal, tree: WorkTree, _feedback: UserFeedback
+        self, goal: Goal, tree: Worktree, _feedback: UserFeedback
     ) -> Action:
         tools = _ToolsFactory(strict=False).params()
         tool_handler = _CompletionsToolHandler(tree)
@@ -321,7 +321,7 @@ def _load_assistant_id(self) -> str:
         return assistant_id
 
     async def act(
-        self, goal: Goal, tree: WorkTree, _feedback: UserFeedback
+        self, goal: Goal, tree: Worktree, _feedback: UserFeedback
     ) -> Action:
         assistant_id = self._load_assistant_id()
 
@@ -346,7 +346,7 @@ async def act(
 
 class _EventHandler(openai.AssistantEventHandler):
     def __init__(
-        self, client: openai.Client, tree: WorkTree, action: Action
+        self, client: openai.Client, tree: Worktree, action: Action
     ) -> None:
         super().__init__()
         self._client = client
@@ -404,7 +404,7 @@ class _ToolOutput(TypedDict):
 
 
 class _ThreadToolHandler(_ToolHandler[_ToolOutput]):
-    def __init__(self, tree: WorkTree, call_id: str) -> None:
+    def __init__(self, tree: Worktree, call_id: str) -> None:
         super().__init__(tree)
         self._call_id = call_id
 

src/git_draft/drafter.py

@@ -19,7 +19,7 @@
 from .prompt import TemplatedPrompt
 from .store import Store, sql
 from .user_feedbacks import BatchUserFeedback
-from .work_trees import GitWorkTree, WorkTreeHooks
+from .worktrees import GitWorktree, WorktreeHooks
 
 
 _logger = logging.getLogger(__name__)
@@ -115,7 +115,7 @@ async def generate_draft(
         with self._progress.spinner("Preparing prompt...") as spinner:
             # Handle prompt templating and editing. We do this first in case
             # this fails, to avoid creating unnecessary branches.
-            tree, dirty = GitWorkTree.for_working_dir(self._repo)
+            tree, dirty = GitWorktree.for_working_dir(self._repo)
             with spinner.hidden():
                 prompt_contents = self._prepare_prompt(
                     prompt,
@@ -333,7 +333,7 @@ def _prepare_prompt(
         self,
         prompt: str | TemplatedPrompt,
         prompt_transform: Callable[[str], str] | None,
-        tree: GitWorkTree,
+        tree: GitWorktree,
     ) -> str:
         if isinstance(prompt, TemplatedPrompt):
             contents = prompt.render(tree)
@@ -349,7 +349,7 @@ async def _generate_change(
         self,
         bot: Bot,
         goal: Goal,
-        tree: GitWorkTree,
+        tree: GitWorktree,
         feedback: UserFeedback,
     ) -> _Change:
         old_tree_sha = tree.sha()
@@ -433,7 +433,7 @@ class _Change:
     is_noop: bool
 
 
-class _OperationRecorder(WorkTreeHooks):
+class _OperationRecorder(WorktreeHooks):
     """Visitor which keeps track of which operations have been performed
 
     This is useful to store a summary of each change in our database for later

src/git_draft/prompt.py

@@ -14,9 +14,9 @@
 import docopt
 import jinja2
 
-from .bots import WorkTree
+from .bots import Worktree
 from .common import Config, Table, package_root
-from .work_trees import EmptyWorkTree
+from .worktrees import EmptyWorktree
 
 
 _extension = "jinja"
@@ -37,8 +37,8 @@ def public(cls, name: PromptName, args: Sequence[str]) -> Self:
         _check_public_template_name(name)
         return cls(name, tuple(args))
 
-    def render(self, work_tree: WorkTree) -> str:
-        prompt = _load_prompt(_jinja_environment(), self.name, work_tree)
+    def render(self, worktree: Worktree) -> str:
+        prompt = _load_prompt(_jinja_environment(), self.name, worktree)
         return prompt.render(self.args)
 
 
@@ -86,7 +86,7 @@ def _load_layouts() -> Mapping[str, str]:
 class _Context(TypedDict):
     prompt: Mapping[str, str]
     program: PromptName
-    work_tree: WorkTree
+    worktree: Worktree
 
 
 @dataclasses.dataclass(frozen=True)
@@ -182,13 +182,13 @@ def _template_path(template: jinja2.Template) -> Path:
 
 
 def _load_prompt(
-    env: jinja2.Environment, name: PromptName, work_tree: WorkTree
+    env: jinja2.Environment, name: PromptName, worktree: Worktree
 ) -> _Prompt:
     rel_path = Path(f"{name}.{_extension}")
     assert env.loader, "No loader in environment"
     template = env.loader.load(env, str(rel_path))
     context: _Context = dict(
-        program=name, prompt=_load_layouts(), work_tree=work_tree
+        program=name, prompt=_load_layouts(), worktree=worktree
     )
     try:
         module = template.make_module(vars=cast(dict, context))
@@ -204,22 +204,22 @@ def _load_prompt(
 
 def find_prompt_metadata(name: PromptName) -> PromptMetadata | None:
     try:
-        prompt = _load_prompt(_jinja_environment(), name, EmptyWorkTree())
+        prompt = _load_prompt(_jinja_environment(), name, EmptyWorktree())
     except jinja2.TemplateNotFound:
         return None
     return prompt.metadata
 
 
 def templates_table(*, include_local: bool = True) -> Table:
     env = _jinja_environment(include_local=include_local)
-    work_tree = EmptyWorkTree()
+    worktree = EmptyWorktree()
     table = Table.empty()
     table.data.field_names = ["name", "local", "description"]
     for rel_path in env.list_templates(extensions=[_extension]):
         if any(p.startswith(".") for p in rel_path.split(os.sep)):
             continue
         name, _ext = os.path.splitext(rel_path)
-        prompt = _load_prompt(env, name, work_tree)
+        prompt = _load_prompt(env, name, worktree)
         metadata = prompt.metadata
         local = "y" if metadata.is_local() else "n"
         table.data.add_row([name, local, metadata.description or ""])

src/git_draft/prompts/.MACROS.jinja

@@ -1,5 +1,5 @@
 {% macro file_list() %}
-{% set paths = work_tree.list_files() %}
+{% set paths = worktree.list_files() %}
 {% if paths %}
 For reference, here is the list of all currently available files in the
 repository:

src/git_draft/work_trees.py src/git_draft/worktrees.pysrc/git_draft/work_trees.py renamed to src/git_draft/worktrees.py

@@ -1,4 +1,4 @@
-"""Work tree implementations"""
+"""Worktree implementations"""
 
 from __future__ import annotations
 
@@ -11,15 +11,15 @@
 import tempfile
 from typing import Protocol, Self, override
 
-from .bots import WorkTree
+from .bots import Worktree
 from .common import UnreachableError
 from .git import SHA, GitError, Repo, null_delimited
 
 
 _logger = logging.getLogger(__name__)
 
 
-class EmptyWorkTree(WorkTree):
+class EmptyWorktree(Worktree):
     """No-op read-only work tree
 
     This tree is used when gathering template metadata.
@@ -52,7 +52,7 @@ def edit_files(self) -> contextlib.AbstractContextManager[Path]:
         raise RuntimeError()
 
 
-class GitWorkTree(WorkTree):
+class GitWorktree(Worktree):
     """Git-backed worktree implementation
 
     All files are directly read from and written to a standalone tree. This
@@ -73,7 +73,7 @@ def __init__(
         self,
         repo: Repo,
         start_rev: SHA,
-        hooks: WorkTreeHooks | None = None,
+        hooks: WorktreeHooks | None = None,
     ) -> None:
         call = repo.git("rev-parse", "--verify", f"{start_rev}^{{tree}}")
         self._sha = call.stdout
@@ -109,7 +109,7 @@ def ls_files(*args: str) -> Iterator[str]:
                 worktree_path / path_str if worktree_path else Path(path_str),
             )
 
-    def with_hooks(self, hooks: WorkTreeHooks) -> Self:
+    def with_hooks(self, hooks: WorktreeHooks) -> Self:
         return self.__class__(self._repo, self.sha(), hooks)
 
     def sha(self) -> SHA:
@@ -118,7 +118,7 @@ def sha(self) -> SHA:
             updates.clear()
         return self._sha
 
-    def _dispatch(self, effect: Callable[[WorkTreeHooks], None]) -> None:
+    def _dispatch(self, effect: Callable[[WorktreeHooks], None]) -> None:
         if hook := self._hooks:
             effect(hook)
 
@@ -225,7 +225,7 @@ def _edit(self) -> Iterator[Path]:
                 self._repo.git("worktree", "remove", "-f", path_str)
 
 
-class WorkTreeHooks(Protocol):
+class WorktreeHooks(Protocol):
     """Tool usage hook"""
 
     def on_list_files(

tests/git_draft/drafter_test.py

@@ -4,7 +4,7 @@
 
 import pytest
 
-from git_draft.bots import Action, Bot, Goal, UserFeedback, WorkTree
+from git_draft.bots import Action, Bot, Goal, UserFeedback, Worktree
 from git_draft.common import Progress
 import git_draft.drafter as sut
 from git_draft.git import SHA, GitError, Repo
@@ -30,7 +30,7 @@ def prompt(cls) -> Self:
         return cls({"PROMPT": lambda goal: goal.prompt})
 
     async def act(
-        self, goal: Goal, tree: WorkTree, _feedback: UserFeedback
+        self, goal: Goal, tree: Worktree, _feedback: UserFeedback
     ) -> Action:
         for key, value in self._contents.items():
             path = PurePosixPath(key)

tests/git_draft/prompt_test.py

@@ -1,7 +1,7 @@
 import pytest
 
 import git_draft.prompt as sut
-from git_draft.work_trees import GitWorkTree
+from git_draft.worktrees import GitWorktree
 
 
 class TestCheckPublicTemplateName:
@@ -18,7 +18,7 @@ def test_raises(self, name: str) -> None:
 class TestTemplatedPrompt:
     @pytest.fixture(autouse=True)
     def setup(self, repo) -> None:
-        self._tree = GitWorkTree(repo, "HEAD")
+        self._tree = GitWorktree(repo, "HEAD")
 
     def test_ok(self) -> None:
         prompt = sut.TemplatedPrompt("add-test", ("--symbol=foo",))