feat: add basic logging (#14)

Author: mtth

src/git_draft/__init__.py

@@ -1,7 +1,11 @@
+import logging
+
 from .assistants import Assistant, Session, Toolbox
 
 __all__ = [
     "Assistant",
     "Session",
     "Toolbox",
 ]
+
+logging.getLogger(__name__).addHandler(logging.NullHandler())

src/git_draft/__main__.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import importlib.metadata
+import logging
 import optparse
 import sys
 import textwrap
@@ -10,6 +11,9 @@
 from .manager import Manager, enclosing_repo
 
 
+logging.basicConfig(level=logging.INFO)
+
+
 EPILOG = """\
     More information via `man git-draft` and https://mtth.github.io/git-draft.
 """

src/git_draft/assistants/openai.py

@@ -14,39 +14,38 @@
     {
         "type": "function",
         "function": {
-            "name": "get_current_temperature",
-            "description": "Get the current temperature for a specific location",
+            "name": "read_file",
+            "description": "Get a file's contents",
             "parameters": {
                 "type": "object",
                 "properties": {
-                    "location": {
+                    "path": {
                         "type": "string",
-                        "description": "The city and state, e.g., San Francisco, CA",
-                    },
-                    "unit": {
-                        "type": "string",
-                        "enum": ["Celsius", "Fahrenheit"],
-                        "description": "The temperature unit to use. Infer this from the user's location.",
+                        "description": "Path of the file to be read",
                     },
                 },
-                "required": ["location", "unit"],
+                "required": ["path"],
             },
         },
     },
     {
         "type": "function",
         "function": {
-            "name": "get_rain_probability",
-            "description": "Get the probability of rain for a specific location",
+            "name": "write_file",
+            "description": "Update a file's contents",
             "parameters": {
                 "type": "object",
                 "properties": {
-                    "location": {
+                    "path": {
                         "type": "string",
-                        "description": "The city and state, e.g., San Francisco, CA",
-                    }
+                        "description": "Path of the file to be updated",
+                    },
+                    "contents": {
+                        "type": "string",
+                        "description": "New contents of the file",
+                    },
                 },
-                "required": ["location"],
+                "required": ["path", "contents"],
             },
         },
     },

src/git_draft/manager.py

@@ -3,14 +3,19 @@
 import dataclasses
 import git
 import json
+import logging
 from pathlib import PurePosixPath
 import re
 import tempfile
+import time
 from typing import Callable, ClassVar, Match, Self, Sequence
 
 from .assistants import Assistant, Toolbox
 
 
+_logger = logging.getLogger(__name__)
+
+
 def enclosing_repo(path: str | None = None) -> git.Repo:
     """Returns the repository to which the given path belongs"""
     return git.Repo(path, search_parent_directories=True)
@@ -31,6 +36,7 @@ def read(cls, repo: git.Repo, ref: str) -> Self | None:
         for line in repo.git.notes("show", ref).splitlines():
             if line.startswith(cls.__prefix):
                 data = json.loads(line[len(cls.__prefix) :])
+                _logger.debug("Read %r note. [ref=%s]", cls.__prefix, ref)
                 return cls(**data)
         return None
 
@@ -41,6 +47,7 @@ def write(self, repo: git.Repo, ref: str) -> None:
         repo.git.notes(
             "append", "--no-separator", "-m", f"{self.__prefix}{value}", ref
         )
+        _logger.debug("Write %r note. [ref=%s]", self.__prefix, ref)
 
 
 @dataclasses.dataclass(frozen=True)
@@ -80,6 +87,9 @@ def needs_rebase(self, repo: git.Repo) -> bool:
         head_commit = repo.commit(self.init_note.origin_branch)
         return origin_commit != head_commit
 
+    def __str__(self) -> str:
+        return self.name
+
     @classmethod
     def create(cls, repo: git.Repo, sync: Callable[[], str | None]) -> _Branch:
         if not repo.active_branch:
@@ -159,12 +169,20 @@ def generate_draft(
 
         branch = _Branch.active(self._repo)
         if branch:
+            _logger.debug("Reusing active branch %s.", branch)
             self._sync()
         else:
             branch = _Branch.create(self._repo, self._sync)
+            _logger.debug("Created branch %s.", branch)
+
+        start_time = time.perf_counter()
+        session = assistant.run(prompt, _Toolbox(self._repo))
+        end_time = time.perf_counter()
+        commit = self._repo.index.commit(f"draft! prompt\n\n{prompt}")
+        note = _SessionNote(session.token_count, end_time - start_time)
+        note.write(self._repo, commit.hexsha)
+        _logger.info("Generated draft. [token_count=%s]", session.token_count)
 
-        assistant.run(prompt, _Toolbox(self._repo))
-        self._repo.index.commit(f"draft! prompt\n\n{prompt}")
         if checkout:
             self._repo.git.checkout("--", ".")