Class AppConfig

tortoise/config.py:63–99

@dataclass(frozen=True)
class AppConfig:
    models: list[str]
    default_connection: str | None = None
    migrations: str | None = None

    def __post_init__(self) -> None:
        if not isinstance(self.models, list) or not self.models:
            raise ConfigurationError("AppConfig.models must be a non-empty list of strings")
        for model in self.models:
            if not isinstance(model, str) or not model:
                raise ConfigurationError("AppConfig.models must contain non-empty strings")
        if self.default_connection is not None and not isinstance(self.default_connection, str):
            raise ConfigurationError("AppConfig.default_connection must be a string or None")
        if self.migrations is not None and not isinstance(self.migrations, str):
            raise ConfigurationError("AppConfig.migrations must be a string or None")

    def to_dict(self) -> dict[str, Any]:
        data: dict[str, Any] = {"models": self.models}
        if self.default_connection is not None:
            data["default_connection"] = self.default_connection
        if self.migrations is not None:
            data["migrations"] = self.migrations
        return data

    @classmethod
    def from_dict(cls, data: Mapping[str, Any]) -> AppConfig:
        if not isinstance(data, Mapping):
            raise ConfigurationError("AppConfig must be created from a mapping")
        if "models" not in data:
            raise ConfigurationError('AppConfig requires "models"')
        if not isinstance(data["models"], list):
            raise ConfigurationError("AppConfig.models must be a list of strings")
        return cls(
            models=list(data["models"]),
            default_connection=data.get("default_connection"),
            migrations=data.get("migrations"),
        )


@dataclass(frozen=True)