refactor: switch to sqlite (#17)

This will be needed to support application-wide configurations, for
example to enable reusing OpenAI assistants. Another benefit is that is
allows us to reduce our reliance on (and the number of) commits.

Author: mtth

poetry.lock

@@ -7,11 +7,12 @@ readme = 'README.md'
 dynamic = ['version']
 requires-python = '>=3.12'
 dependencies = [
-  'gitpython >=3.1.44,<4',
+  'gitpython (>=3.1.44,<4)',
+  "xdg-base-dirs (>=6.0.2,<7.0.0)",
 ]
 
 [project.optional-dependencies]
-openai = ['openai >=1.64.0,<2']
+openai = ['openai (>=1.64.0,<2)']
 
 [project.scripts]
 git-draft = 'git_draft.__main__:main'

pyproject.toml

@@ -7,7 +7,7 @@
 import textwrap
 
 from .assistants import load_assistant
-from .common import open_editor
+from .common import Store, open_editor
 from .manager import Manager
 
 
@@ -41,9 +41,9 @@ def callback(_option, _opt, _value, parser) -> None:
     )
 
 
-add_command("discard", help="discard all drafts associated with a branch")
+add_command("discard", help="discard the current draft")
 add_command("finalize", help="apply the current draft to the original branch")
-add_command("generate", help="draft a new change from a prompt")
+add_command("generate", help="start a new draft from a prompt")
 
 parser.add_option(
     "-a",
@@ -61,7 +61,7 @@ def callback(_option, _opt, _value, parser) -> None:
 parser.add_option(
     "-d",
     "--delete",
-    help="delete the draft after finalizing or discarding",
+    help="delete draft after finalizing or discarding",
     action="store_true",
 )
 parser.add_option(
@@ -76,6 +76,12 @@ def callback(_option, _opt, _value, parser) -> None:
     help="reset index before generating a new draft",
     action="store_true",
 )
+parser.add_option(
+    "-s",
+    "--sync",
+    help="commit prior worktree changes separately",
+    action="store_true",
+)
 
 
 EDITOR_PLACEHOLDER = """\
@@ -86,7 +92,7 @@ def callback(_option, _opt, _value, parser) -> None:
 def main() -> None:
     (opts, _args) = parser.parse_args()
 
-    manager = Manager.enclosing()
+    manager = Manager.create(Store.persistent())
 
     command = getattr(opts, "command", "generate")
     if command == "generate":

src/git_draft/__main__.py

@@ -1,3 +1,8 @@
+"""Assistant interfaces and built-in implementations
+
+* https://aider.chat/docs/leaderboards/
+"""
+
 from typing import Any, Mapping
 
 from .common import Assistant, Session, Toolbox

src/git_draft/assistants/__init__.py

@@ -6,6 +6,10 @@
 
 
 class Toolbox(Protocol):
+    # TODO: Something similar to https://aider.chat/docs/repomap.html,
+    # including inferring the most important files, and allowing returning
+    # signature-only versions.
+
     def list_files(self) -> Sequence[PurePosixPath]: ...
     def read_file(self, path: PurePosixPath) -> str: ...
     def write_file(self, path: PurePosixPath, contents: str) -> None: ...

src/git_draft/assistants/common.py

@@ -87,6 +87,7 @@ class OpenAIAssistant(Assistant):
 
     * https://platform.openai.com/docs/assistants/tools/function-calling
     * https://platform.openai.com/docs/assistants/deep-dive#runs-and-run-steps
+    * https://platform.openai.com/docs/api-reference/assistants-streaming/events
     * https://github.com/openai/openai-python/blob/main/src/openai/resources/beta/threads/runs/runs.py
     """
 

src/git_draft/assistants/openai.py

@@ -1,8 +1,18 @@
+from __future__ import annotations
+
+import contextlib
+import functools
 import os
+from pathlib import Path
+import random
 import shutil
+import sqlite3
 import subprocess
+import string
 import sys
 import tempfile
+from typing import ContextManager
+import xdg_base_dirs
 
 
 _default_editors = ["vim", "emacs", "nano"]
@@ -43,3 +53,50 @@ def open_editor(placeholder="") -> str:
 
         with open(temp.name, mode="r") as reader:
             return reader.read()
+
+
+NAMESPACE = "git-draft"
+
+
+def _ensure_state_home() -> Path:
+    path = xdg_base_dirs.xdg_state_home() / NAMESPACE
+    path.mkdir(parents=True, exist_ok=True)
+    return path
+
+
+class Store:
+    _name = "db.v1.sqlite3"
+
+    def __init__(self, conn: sqlite3.Connection) -> None:
+        self._connection = conn
+
+    @classmethod
+    def persistent(cls) -> Store:
+        path = _ensure_state_home() / cls._name
+        conn = sqlite3.connect(str(path), autocommit=False)
+        return cls(conn)
+
+    @classmethod
+    def in_memory(cls) -> Store:
+        return cls(sqlite3.connect(":memory:"))
+
+    def cursor(self) -> ContextManager[sqlite3.Cursor]:
+        return contextlib.closing(self._connection.cursor())
+
+
+_query_root = Path(__file__).parent / "queries"
+
+
+@functools.cache
+def sql(name: str) -> str:
+    path = _query_root / f"{name}.sql"
+    with open(path) as reader:
+        return reader.read()
+
+
+_random = random.Random()
+_alphabet = string.ascii_lowercase + string.digits
+
+
+def random_id(n: int) -> str:
+    return "".join(_random.choices(_alphabet, k=n))