Add Git support (#72)

Author: nicovank

src/cwhy/functions.py

@@ -7,6 +7,7 @@
 import openai
 
 from . import clangd_lsp_integration
+from . import git_integration
 
 
 class Functions:
@@ -23,6 +24,18 @@ def as_tools(self) -> list[openai.types.responses.FunctionToolParam]:
 
         if clangd_lsp_integration.is_available():
             fns.append(self.find_definition)
+        else:
+            print(
+                "[WARNING] clangd is not available. The 'find_definition' function will not be made available."
+            )
+
+        if git_integration.is_available():
+            fns.append(self.git_status)
+            fns.append(self.git_diff)
+        else:
+            print(
+                "[WARNING] `git status` is not available. The associated git functions will not be made available."
+            )
 
         for f in fns:
             assert f.__doc__
@@ -55,6 +68,12 @@ def dispatch(
                 return self.find_definition(
                     arguments["filename"], arguments["line_number"], arguments["symbol"]
                 )
+            elif function_call.name == "git_status":
+                return self.git_status()
+            elif function_call.name == "git_diff":
+                return self.git_diff(arguments["filename"])
+            else:
+                print(f"[ERROR] Unknown function: {function_call.name}")
         except Exception as e:
             print(e)
         return None
@@ -121,7 +140,7 @@ def list_directory(self, path: str) -> str:
         result = "\n".join(entries)
         print(result)
         return result
-    
+
     def find_definition(self, filename: str, line_number: int, symbol: str) -> str:
         """
         {
@@ -148,6 +167,47 @@ def find_definition(self, filename: str, line_number: int, symbol: str) -> str:
             }
         }
         """
-        result = clangd_lsp_integration.definition_plus_heuristics(filename, line_number, symbol)
+        result = clangd_lsp_integration.definition_plus_heuristics(
+            filename, line_number, symbol
+        )
         print(result)
         return result
+
+    def git_status(self) -> str:
+        """
+        {
+            "description": "Returns the git status (--porcelain) of the current repository.",
+            "strict": true,
+            "parameters": {
+                "type": "object",
+                "properties": {},
+                "required": [],
+                "additionalProperties": false
+            }
+        }
+        """
+        status = git_integration.get_git_status_porcelain()
+        print(status)
+        return status
+
+    def git_diff(self, filename: str) -> str:
+        """
+        {
+            "description": "Returns the diff since the last commit of the given file.",
+            "strict": true,
+            "parameters": {
+                "type": "object",
+                "properties": {
+                    "filename": {
+                        "type": "string",
+                        "description": "The filename path to get the git diff for (relative to the current directory)."
+                    }
+                },
+                "required": ["filename"],
+                "additionalProperties": false
+            }
+        }
+        """
+        diff = git_integration.get_git_diff(filename)
+        print(diff)
+        return diff

src/cwhy/git_integration.py

@@ -0,0 +1,33 @@
+import subprocess
+
+
+def is_available() -> bool:
+    try:
+        return (
+            subprocess.run(
+                ["git", "status"],
+                stdout=subprocess.DEVNULL,
+                stderr=subprocess.DEVNULL,
+            ).returncode
+            == 0
+        )
+    except FileNotFoundError:
+        return False
+
+
+def get_git_status_porcelain() -> str:
+    return subprocess.run(
+        ["git", "status", "--porcelain"],
+        stdout=subprocess.PIPE,
+        stderr=subprocess.DEVNULL,
+        text=True,
+    ).stdout.strip()
+
+
+def get_git_diff(filename: str) -> str:
+    return subprocess.run(
+        ["git", "diff", filename],
+        stdout=subprocess.PIPE,
+        stderr=subprocess.DEVNULL,
+        text=True,
+    ).stdout.strip()