dependency inject app configuration

Author: djcopley

pyproject.toml

@@ -57,6 +57,7 @@ dependencies = [
     "pytest-xdist~=3.6",
     "pytest-asyncio~=0.24",
     "pytest-httpx~=0.30",
+    "tomli-w>=1.2.0",
 ]
 
 [[tool.hatch.envs.hatch-test.matrix]]

src/shelloracle/__main__.py

@@ -1,68 +1,4 @@
-import argparse
-import logging
-import sys
-from importlib.metadata import version
-
-from shelloracle import shelloracle
-from shelloracle.config import initialize_config
-from shelloracle.settings import Settings
-from shelloracle.tty_log_handler import TtyLogHandler
-
-logger = logging.getLogger(__name__)
-
-
-def configure_logging():
-    root_logger = logging.getLogger()
-    root_logger.setLevel(logging.DEBUG)
-
-    file_formatter = logging.Formatter("%(asctime)s - %(levelname)s - %(name)s - %(message)s")
-    file_handler = logging.FileHandler(Settings.shelloracle_home / "shelloracle.log")
-    file_handler.setLevel(logging.DEBUG)
-    file_handler.setFormatter(file_formatter)
-
-    tty_formatter = logging.Formatter("%(message)s")
-    tty_handler = TtyLogHandler()
-    tty_handler.setLevel(logging.WARNING)
-    tty_handler.setFormatter(tty_formatter)
-
-    root_logger.addHandler(file_handler)
-    root_logger.addHandler(tty_handler)
-
-
-def configure():
-    # nest this import in a function to avoid expensive module loads
-    from shelloracle.bootstrap import bootstrap_shelloracle
-
-    bootstrap_shelloracle()
-
-
-def parse_args() -> argparse.Namespace:
-    parser = argparse.ArgumentParser()
-    parser.add_argument("--version", action="version", version=f"{__package__} {version(__package__)}")
-
-    subparsers = parser.add_subparsers()
-    configure_subparser = subparsers.add_parser("configure", help=f"install {__package__} keybindings")
-    configure_subparser.set_defaults(action=configure)
-
-    return parser.parse_args()
-
-
-def main() -> None:
-    args = parse_args()
-    configure_logging()
-
-    if action := getattr(args, "action", None):
-        action()
-        sys.exit(0)
-
-    try:
-        initialize_config()
-    except FileNotFoundError:
-        logger.warning("ShellOracle configuration not found. Run `shor configure` to initialize.")
-        sys.exit(1)
-
-    shelloracle.cli()
-
-
 if __name__ == "__main__":
+    from shelloracle.cli import main
+
     main()

src/shelloracle/bootstrap.py

@@ -12,7 +12,6 @@
 from prompt_toolkit.shortcuts import confirm
 
 from shelloracle.providers import Provider, Setting, get_provider, list_providers
-from shelloracle.settings import Settings
 
 if TYPE_CHECKING:
     from collections.abc import Iterator, Sequence
@@ -104,7 +103,7 @@ def correct_name_setting():
     yield from correct_name_setting()
 
 
-def write_shelloracle_config(provider: type[Provider], settings: dict[str, Any]) -> None:
+def write_shelloracle_config(provider: type[Provider], settings: dict[str, Any], config_path: Path) -> None:
     config = tomlkit.document()
 
     shor_table = tomlkit.table()
@@ -119,8 +118,7 @@ def write_shelloracle_config(provider: type[Provider], settings: dict[str, Any])
         provider_configuration_table.add(setting, value)
     provider_table.add(provider.name, provider_configuration_table)
 
-    filepath = Settings.shelloracle_home / "config.toml"
-    with filepath.open("w") as config_file:
+    with config_path.open("w") as config_file:
         tomlkit.dump(config, config_file)
 
 
@@ -164,7 +162,7 @@ def user_select_provider() -> type[Provider]:
     return get_provider(provider_name)
 
 
-def bootstrap_shelloracle() -> None:
+def bootstrap_shelloracle(config_path: Path) -> None:
     try:
         provider = user_select_provider()
         settings = user_configure_settings(provider)
@@ -173,5 +171,5 @@ def bootstrap_shelloracle() -> None:
         return
     except KeyboardInterrupt:
         return
-    write_shelloracle_config(provider, settings)
+    write_shelloracle_config(provider, settings, config_path)
     install_keybindings()

src/shelloracle/cli/__init__.py

@@ -1,24 +1,24 @@
 import logging
 import sys
-from importlib.metadata import version
+from pathlib import Path
 
 import click
 
 from shelloracle import shelloracle
+from shelloracle.cli.application import Application
 from shelloracle.cli.config import config
-from shelloracle.config import initialize_config
-from shelloracle.settings import Settings
+from shelloracle.config import Configuration
 from shelloracle.tty_log_handler import TtyLogHandler
 
 logger = logging.getLogger(__name__)
 
 
-def configure_logging():
+def configure_logging(log_path: Path):
     root_logger = logging.getLogger()
     root_logger.setLevel(logging.DEBUG)
 
     file_formatter = logging.Formatter("%(asctime)s - %(levelname)s - %(name)s - %(message)s")
-    file_handler = logging.FileHandler(Settings.shelloracle_home / "shelloracle.log")
+    file_handler = logging.FileHandler(log_path)
     file_handler.setLevel(logging.DEBUG)
     file_handler.setFormatter(file_formatter)
 
@@ -32,21 +32,26 @@ def configure_logging():
 
 
 @click.group(invoke_without_command=True)
-@click.version_option(version=version("shelloracle"))
+@click.version_option()
 @click.pass_context
 def cli(ctx):
     """ShellOracle command line interface."""
-    configure_logging()
+    app = Application()
+    configure_logging(app.log_path)
 
-    # If no subcommand is invoked, run the main CLI
-    if ctx.invoked_subcommand is None:
-        try:
-            initialize_config()
-        except FileNotFoundError:
-            logger.warning("ShellOracle configuration not found. Run `shor config init` to initialize.")
-            sys.exit(1)
+    try:
+        app.configuration = Configuration.from_file(app.config_path)
+    except FileNotFoundError:
+        logger.warning("Configuration not found. Run `shor config init` to initialize.")
+        sys.exit(1)
 
-        shelloracle.cli()
+    ctx.obj = app
+
+    if ctx.invoked_subcommand is not None:
+        # If no subcommand is invoked, run the main CLI
+        return
+
+    shelloracle.cli(app)
 
 
 cli.add_command(config)

src/shelloracle/cli/application.py

@@ -0,0 +1,14 @@
+from pathlib import Path
+
+from shelloracle.config import Configuration
+
+shelloracle_home = Path.home() / ".shelloracle"
+shelloracle_home.mkdir(exist_ok=True)
+
+
+class Application:
+    configuration: Configuration
+
+    def __init__(self):
+        self.config_path = shelloracle_home / "config.toml"
+        self.log_path = shelloracle_home / "shelloracle.log"

src/shelloracle/cli/config/init.py

@@ -1,10 +1,13 @@
 import click
 
+from shelloracle.cli import Application
+
 
 @click.command()
-def init():
+@click.pass_obj
+def init(app: Application):
     """Install shelloracle keybindings."""
     # nest this import in a function to avoid expensive module loads
     from shelloracle.bootstrap import bootstrap_shelloracle
 
-    bootstrap_shelloracle()
+    bootstrap_shelloracle(app.config_path)

src/shelloracle/config.py

@@ -7,11 +7,10 @@
 
 from yaspin.spinners import SPINNERS_DATA
 
-from shelloracle.settings import Settings
-
 if TYPE_CHECKING:
     from pathlib import Path
 
+
 if sys.version_info < (3, 11):
     import tomli as tomllib
 else:
@@ -21,15 +20,13 @@
 
 
 class Configuration(Mapping):
-    def __init__(self, filepath: Path) -> None:
+    def __init__(self, config: dict[str, Any]) -> None:
         """ShellOracle application configuration
 
-        :param filepath: Path to the configuration file
+        :param config: configuration dict
         :raises FileNotFoundError: if the configuration file does not exist
         """
-        self.filepath = filepath
-        with filepath.open("rb") as config_file:
-            self._config = tomllib.load(config_file)
+        self._config = config
 
     def __getitem__(self, key: str) -> Any:
         return self._config[key]
@@ -46,6 +43,10 @@ def __str__(self):
     def __repr__(self) -> str:
         return str(self)
 
+    @property
+    def raw_config(self) -> dict[str, Any]:
+        return self._config
+
     @property
     def provider(self) -> str:
         return self["shelloracle"]["provider"]
@@ -60,31 +61,8 @@ def spinner_style(self) -> str | None:
             return None
         return style
 
-
-_config: Configuration | None = None
-
-
-def initialize_config() -> None:
-    """Initialize the configuration file
-
-    :raises RuntimeError: if the config is already initialized
-    :raises FileNotFoundError: if the config file is not found
-    """
-    global _config  # noqa: PLW0603
-    if _config:
-        msg = "Configuration already initialized"
-        raise RuntimeError(msg)
-    filepath = Settings.shelloracle_home / "config.toml"
-    _config = Configuration(filepath)
-
-
-def get_config() -> Configuration:
-    """Returns the global configuration object.
-
-    :return: the global configuration
-    :raises RuntimeError: if the configuration is not initialized
-    """
-    if _config is None:
-        msg = "Configuration not initialized"
-        raise RuntimeError(msg)
-    return _config
+    @classmethod
+    def from_file(cls, filepath: Path):
+        with filepath.open("rb") as config_file:
+            config = tomllib.load(config_file)
+        return cls(config)

src/shelloracle/providers/__init__.py

@@ -1,13 +1,13 @@
 from __future__ import annotations
 
 from abc import abstractmethod
-from typing import TYPE_CHECKING, Generic, Protocol, TypeVar, runtime_checkable
-
-from shelloracle.config import get_config
+from typing import TYPE_CHECKING, Generic, Protocol, TypeVar
 
 if TYPE_CHECKING:
     from collections.abc import AsyncIterator
 
+    from shelloracle.config import Configuration
+
 system_prompt = (
     "Based on the following user description, generate a corresponding shell command. Focus solely "
     "on interpreting the requirements and translating them into a single, executable Bash command. "
@@ -22,7 +22,6 @@ class ProviderError(Exception):
     """LLM providers raise this error to gracefully indicate something has gone wrong."""
 
 
-@runtime_checkable
 class Provider(Protocol):
     """
     LLM Provider Protocol
@@ -31,6 +30,10 @@ class Provider(Protocol):
     """
 
     name: str
+    config: Configuration
+
+    def __init__(self, config: Configuration) -> None:
+        self.config = config
 
     @abstractmethod
     def generate(self, prompt: str) -> AsyncIterator[str]:
@@ -64,9 +67,8 @@ def __get__(self, instance: Provider, owner: type[Provider]) -> T:
             # inspect.get_members from determining the object type
             msg = "Settings must be accessed through a provider instance."
             raise AttributeError(msg)
-        config = get_config()
         try:
-            return config["provider"][owner.name][self.name]
+            return instance.config["provider"][owner.name][self.name]
         except KeyError:
             if self.default is None:
                 raise

src/shelloracle/providers/deepseek.py

@@ -11,7 +11,8 @@ class Deepseek(Provider):
     api_key = Setting(default="")
     model = Setting(default="deepseek-chat")
 
-    def __init__(self):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
         if not self.api_key:
             msg = "No API key provided"
             raise ProviderError(msg)

src/shelloracle/providers/google.py

@@ -11,7 +11,8 @@ class Google(Provider):
     api_key = Setting(default="")
     model = Setting(default="gemini-2.0-flash")  # Assuming a default model name
 
-    def __init__(self):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
         if not self.api_key:
             msg = "No API key provided"
             raise ProviderError(msg)

src/shelloracle/providers/localai.py

@@ -16,7 +16,8 @@ class LocalAI(Provider):
     def endpoint(self) -> str:
         return f"http://{self.host}:{self.port}"
 
-    def __init__(self):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
         # Use a placeholder API key so the client will work
         self.client = AsyncOpenAI(api_key="sk-xxx", base_url=self.endpoint)
 

src/shelloracle/providers/openai.py

@@ -11,7 +11,8 @@ class OpenAI(Provider):
     api_key = Setting(default="")
     model = Setting(default="gpt-3.5-turbo")
 
-    def __init__(self):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
         if not self.api_key:
             msg = "No API key provided"
             raise ProviderError(msg)

src/shelloracle/providers/openai_compat.py

@@ -12,7 +12,8 @@ class OpenAICompat(Provider):
     api_key = Setting(default="")
     model = Setting(default="")
 
-    def __init__(self):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
         if not self.api_key:
             msg = "No API key provided. Use a dummy placeholder if no key is required"
             raise ProviderError(msg)