Skip to content

Configuration

magetools.config.MageToolsConfig

Configuration loader for magetools.

Source code in src/magetools/config.py 
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
class MageToolsConfig:
    """Configuration loader for magetools."""

    def __init__(
        self,
        root_path: Path | None = None,
        config_path: Path | None = None,
    ):
        self.root_path = root_path or Path.cwd()

        # Load defaults
        self.magetools_dir_name = os.getenv("MAGETOOLS_DIR_NAME", DEFAULT_MAGETOOLS_DIR)
        self.db_folder_name = os.getenv("MAGETOOLS_DB_FOLDER", DEFAULT_DB_FOLDER)
        self.model_name = os.getenv("MAGETOOLS_MODEL", DEFAULT_MODEL)
        self.embedding_model = os.getenv(
            "MAGETOOLS_EMBEDDING_MODEL", DEFAULT_EMBEDDING_MODEL
        )
        self.debug = os.getenv("MAGETOOLS_DEBUG", "false").lower() == "true"

        # Load from YAML if exists
        self.config_path = config_path or self.root_path / "magetools.yaml"
        if self.config_path.exists():
            self._load_from_yaml(self.config_path)

    def _load_from_yaml(self, path: Path):
        try:
            with open(path, encoding="utf-8") as f:
                data = yaml.safe_load(f)
                if data:
                    self.magetools_dir_name = data.get(
                        "magetools_dir_name", self.magetools_dir_name
                    )
                    self.db_folder_name = data.get(
                        "db_folder_name", self.db_folder_name
                    )
                    self.model_name = data.get("model_name", self.model_name)
                    self.embedding_model = data.get(
                        "embedding_model", self.embedding_model
                    )
                    self.debug = data.get("debug", self.debug)
        except Exception as e:
            logger.error(f"Failed to load config from {path}: {e}")

    @property
    def magetools_root(self) -> Path:
        """Absolute path to the .magetools directory."""
        return (self.root_path / self.magetools_dir_name).resolve()

    @property
    def db_path(self) -> Path:
        """Absolute path to the database folder."""
        return (self.magetools_root / self.db_folder_name).resolve()

    def validate(self, require_magetools_dir: bool = False) -> list[str]:
        """Validate configuration and return list of warnings.

        Args:
            require_magetools_dir: If True, raises ConfigurationError if .magetools doesn't exist.

        Returns:
            List of warning messages (non-fatal issues).
        """
        from .exceptions import ConfigurationError

        warnings = []

        # Check if root_path exists
        if not self.root_path.exists():
            raise ConfigurationError(
                f"Root path does not exist: {self.root_path}. "
                "Provide a valid root_path or check your working directory."
            )

        # Check if magetools directory exists
        if not self.magetools_root.exists():
            if require_magetools_dir:
                raise ConfigurationError(
                    f"Magetools directory not found at {self.magetools_root}. "
                    f"Create a '{self.magetools_dir_name}' folder to store your spells."
                )
            else:
                warnings.append(
                    f"Magetools directory not found at {self.magetools_root}. "
                    "Spell discovery will not find any spells."
                )

        return warnings

db_path property

Absolute path to the database folder.

magetools_root property

Absolute path to the .magetools directory.

validate(require_magetools_dir=False)

Validate configuration and return list of warnings.

Parameters:

Name Type Description Default
require_magetools_dir bool

If True, raises ConfigurationError if .magetools doesn't exist.

 False

Returns:

Type Description
list[str]

List of warning messages (non-fatal issues).
Source code in src/magetools/config.py 
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
def validate(self, require_magetools_dir: bool = False) -> list[str]:
    """Validate configuration and return list of warnings.

    Args:
        require_magetools_dir: If True, raises ConfigurationError if .magetools doesn't exist.

    Returns:
        List of warning messages (non-fatal issues).
    """
    from .exceptions import ConfigurationError

    warnings = []

    # Check if root_path exists
    if not self.root_path.exists():
        raise ConfigurationError(
            f"Root path does not exist: {self.root_path}. "
            "Provide a valid root_path or check your working directory."
        )

    # Check if magetools directory exists
    if not self.magetools_root.exists():
        if require_magetools_dir:
            raise ConfigurationError(
                f"Magetools directory not found at {self.magetools_root}. "
                f"Create a '{self.magetools_dir_name}' folder to store your spells."
            )
        else:
            warnings.append(
                f"Magetools directory not found at {self.magetools_root}. "
                "Spell discovery will not find any spells."
            )

    return warnings