Get config basics down

Author: djcopley

pyproject.toml

@@ -7,7 +7,8 @@ name = "shelloracle"
 version = "0.0.1"
 dependencies = [
     "httpx",
-    "prompt-toolkit"
+    "prompt-toolkit",
+    "tomlkit"
 ]
 authors = [
     { name = "Daniel Copley", email = "djcopley@users.noreply.github.com" },
@@ -24,7 +25,7 @@ classifiers = [
 ]
 
 [tool.setuptools]
-packages = ["shelloracle", "shelloracle.provider"]
+packages = ["shelloracle", "shelloracle.config", "shelloracle.provider"]
 
 [project.scripts]
 shor = "shelloracle.shelloracle:cli"

shelloracle/config.py

@@ -0,0 +1,2 @@
+from .config import Configuration, data_home
+from .setting import Setting

shelloracle/config/__init__.py

@@ -0,0 +1,43 @@
+from pathlib import Path
+from typing import TextIO
+
+from tomlkit import document, table, load
+
+data_home = Path.home() / "Library/Application Support" / "shelloracle"
+
+
+def _default_config():
+    doc = document()
+    shelloracle = table()
+    shelloracle.add("provider", "ollama")
+    doc.add("shelloracle", shelloracle)
+    return doc
+
+
+class SingletonMeta(type):
+    _instances = {}
+
+    def __call__(cls, *args, **kwargs):
+        if cls not in cls._instances:
+            cls._instances[cls] = super().__call__(*args, **kwargs)
+        return cls._instances[cls]
+
+
+class Configuration(metaclass=SingletonMeta):
+    filepath = data_home / "config.toml"
+
+    def __init__(self):
+        self.file: TextIO | None = None
+        self._ensure_config_exists()
+
+    def _ensure_config_exists(self):
+        if not self.filepath.exists():
+            data_home.mkdir(exist_ok=True)
+            self.filepath.write_text(_default_config())
+
+    @property
+    def provider(self) -> str | None:
+        with self.filepath.open("r") as config_file:
+            file = load(config_file)
+        return file.get("shelloracle", {}).get("provider", None)
+

shelloracle/config/config.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+from typing import TypeVar, Generic, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ..provider import Provider
+
+T = TypeVar("T")
+
+
+class Setting(Generic[T]):
+    def __init__(self, *, default: T | None = None):
+        self.default = default
+
+    def __set_name__(self, owner: Provider, name: str) -> None:
+        self.name = name
+
+    def __get__(self, instance: Provider, owner: type[Provider]) -> T:
+        return self.default
+
+    def __set__(self, instance: Provider, value: T) -> None:
+        self.default = value

shelloracle/config/setting.py

@@ -14,7 +14,7 @@ class Provider(Protocol):
 
     All LLM backends must implement this interface.
     """
-    name = ""
+    name: str
 
     @abstractmethod
     def generate(self, prompt: str) -> AsyncGenerator[str, None, None]:
@@ -36,6 +36,6 @@ def get_provider(name: str) -> type[Provider]:
     """
     from .ollama import Ollama
     providers = {
-        "ollama": Ollama
+        "Ollama": Ollama
     }
     return providers[name]

shelloracle/provider/__init__.py

@@ -1,10 +1,24 @@
 import json
 from collections.abc import AsyncGenerator
 from dataclasses import dataclass, asdict
+from typing import Any
 
 import httpx
 
 from . import Provider, ProviderError
+from ..config import Setting
+
+
+def dataclass_to_json(obj: Any) -> dict[str, Any]:
+    """Convert dataclass to a json dict
+
+    This function filters out 'None' values.
+
+    :param obj: the dataclass to serialize
+    :return: serialized dataclass
+    :raises TypeError: if obj is not a dataclass
+    """
+    return {k: v for k, v in asdict(obj).items() if v is not None}
 
 
 @dataclass
@@ -33,29 +47,35 @@ class GenerateRequest:
     the raw parameter if you are specifying a full templated prompt in your request to the API, and are managing 
     history yourself. JSON mode"""
 
-    def to_json(self):
-        return json.dumps(asdict(self))
+
+system_prompt = (
+    "Based on the following user description, generate a corresponding Bash command. Focus solely on interpreting "
+    "the requirements and translating them into a single, executable Bash command. Ensure accuracy and relevance "
+    "to the user's description. The output should be a valid Bash command that directly aligns with the user's "
+    "intent, ready for execution in a command-line environment. Output nothing except for the command. No code "
+    "block, no English explanation, no start/end tags."
+)
 
 
 class Ollama(Provider):
     name = "Ollama"
 
-    host = "localhost"
-    port = 11434
-    endpoint = f"http://{host}:{port}/api/generate"
+    host = Setting(default="localhost")
+    port = Setting(default=11434)
+    model = Setting(default="codellama:13b")
+    system_prompt = Setting(default=system_prompt)
 
-    model = "codellama:13b"
-    system_prompt = """Based on the following user description, generate a corresponding Bash command. Focus solely on 
-    interpreting the requirements and translating them into a single, executable Bash command. Ensure accuracy and 
-    relevance to the user's description. The output should be a valid Bash command that directly aligns with the user's 
-    intent, ready for execution in a command-line environment. Output nothing except for the command. No code block, no 
-    English explanation, no start/end tags."""
+    @property
+    def endpoint(self):
+        # computed property because python descriptors need to be bound to an instance before access
+        return f"http://{self.host}:{self.port}/api/generate"
 
     async def generate(self, prompt: str) -> AsyncGenerator[str, None, None]:
+        request = GenerateRequest(self.model, prompt, system=system_prompt, stream=True)
+        data = dataclass_to_json(request)
         try:
-            request = GenerateRequest(self.model, prompt, system=self.system_prompt, stream=True).to_json()
             async with httpx.AsyncClient() as client:
-                async with client.stream("POST", self.endpoint, content=request, timeout=20.0) as stream:
+                async with client.stream("POST", self.endpoint, json=data, timeout=20.0) as stream:
                     async for line in stream.aiter_lines():
                         yield json.loads(line)["response"]
         except (httpx.HTTPError, httpx.StreamError) as e:

shelloracle/provider/ollama.py

@@ -6,8 +6,8 @@
 from prompt_toolkit.application import create_app_session_from_tty
 from prompt_toolkit.history import FileHistory
 
-from .provider import get_provider
 from .config import Configuration, data_home
+from .provider import get_provider
 
 
 async def prompt_user(default_prompt: str | None = None) -> str: