fix: refactored get_project_dir helper function

Author: ErikBjare

gptme/dirs.py

@@ -1,4 +1,5 @@
 import os
+import subprocess
 from pathlib import Path
 
 from platformdirs import user_config_dir, user_data_dir
@@ -40,6 +41,51 @@ def get_logs_dir() -> Path:
     return path
 
 
+def get_project_gptme_dir() -> Path | None:
+    """
+    Walks up the directory tree from the working dir to find the project root,
+    which is a directory containing a `gptme.toml` file.
+    Or if none exists, the first parent directory with a git repo.
+
+    Meant to be used in scripts/tools to detect a suitable location to store agent data/logs.
+    """
+    path = Path.cwd()
+    while path != Path("/"):
+        if (path / "gptme.toml").exists():
+            return path
+        path = path.parent
+
+    # if no gptme.toml file was found, look for a git repo
+    return _get_project_git_dir_walk()
+
+
+def get_project_git_dir() -> Path | None:
+    return _get_project_git_dir_walk()
+
+
+def _get_project_git_dir_walk() -> Path | None:
+    # if no gptme.toml file was found, look for a git repo
+    path = Path.cwd()
+    while path != Path("/"):
+        if (path / ".git").exists():
+            return path
+        path = path.parent
+    return None
+
+
+def _get_project_git_dir_call() -> Path | None:
+    try:
+        projectdir = subprocess.run(
+            ["git", "rev-parse", "--show-toplevel"],
+            capture_output=True,
+            text=True,
+            check=True,
+        ).stdout.strip()
+        return Path(projectdir)
+    except subprocess.CalledProcessError:
+        return None
+
+
 def _init_paths():
     # create all paths
     for path in [get_config_dir(), get_data_dir(), get_logs_dir()]:

gptme/prompts.py

@@ -14,9 +14,10 @@
 
 from .__version__ import __version__
 from .config import get_config, get_project_config
+from .dirs import get_project_git_dir
 from .message import Message
 from .tools import ToolFormat
-from .util import document_prompt_function, get_project_dir
+from .util import document_prompt_function
 
 PromptType = Literal["full", "short"]
 
@@ -142,7 +143,7 @@ def prompt_gptme(interactive: bool) -> Generator[Message, None, None]:
 Proceed directly with the most appropriate actions to complete the task.
 """.strip()
 
-    projectdir = get_project_dir()
+    projectdir = get_project_git_dir()
     project_config = get_project_config(projectdir)
     base_prompt = (
         project_config.base_prompt
@@ -189,7 +190,7 @@ def prompt_project() -> Generator[Message, None, None]:
     """
     Generate the project-specific prompt based on the current Git repository.
     """
-    projectdir = get_project_dir()
+    projectdir = get_project_git_dir()
     if not projectdir:
         return
 

gptme/tools/rag.py

@@ -42,9 +42,9 @@
 from pathlib import Path
 
 from ..config import RagConfig, get_project_config
+from ..dirs import get_project_gptme_dir
 from ..llm import _chat_complete
 from ..message import Message
-from ..util import get_project_dir
 from .base import ToolSpec, ToolUse
 
 logger = logging.getLogger(__name__)
@@ -163,7 +163,7 @@ def init() -> ToolSpec:
         return replace(tool, available=False)
 
     # Check project configuration
-    project_dir = get_project_dir()
+    project_dir = get_project_gptme_dir()
     if project_dir and (config := get_project_config(project_dir)):
         enabled = config.rag.enabled
         if not enabled:

gptme/util/__init__.py

@@ -6,7 +6,6 @@
 import logging
 import re
 import shutil
-import subprocess
 import sys
 import textwrap
 from datetime import datetime, timedelta
@@ -216,17 +215,3 @@ def get_installed_programs(candidates: tuple[str, ...]) -> set[str]:
         if shutil.which(candidate) is not None:
             installed.add(candidate)
     return installed
-
-
-def get_project_dir() -> Path | None:
-    try:
-        projectdir = subprocess.run(
-            ["git", "rev-parse", "--show-toplevel"],
-            capture_output=True,
-            text=True,
-            check=True,
-        ).stdout.strip()
-        return Path(projectdir)
-    except subprocess.CalledProcessError:
-        logger.debug("Unable to determine Git repository root.")
-        return None