Method init

tortoise/context.py:259–368

Initialize this context with database configuration. You can configure using one of: ``config``, ``config_file``, or ``(db_url, modules)``. This method is self-sufficient and can be used directly in tests without going through Tortoise.init(): async wi

(
        self,
        config: dict[str, Any] | TortoiseConfig | None = None,
        *,
        config_file: str | None = None,
        db_url: str | None = None,
        modules: dict[str, Iterable[str | ModuleType]] | None = None,
        _create_db: bool = False,
        use_tz: bool = True,
        timezone: str = "UTC",
        routers: list[str | type] | None = None,
        table_name_generator: Callable[[type[Model]], str] | None = None,
        init_connections: bool = True,
        _enable_global_fallback: bool = False,
    )

        return config

    async def init(
        self,
        config: dict[str, Any] | TortoiseConfig | None = None,
        *,
        config_file: str | None = None,
        db_url: str | None = None,
        modules: dict[str, Iterable[str | ModuleType]] | None = None,
        _create_db: bool = False,
        use_tz: bool = True,
        timezone: str = "UTC",
        routers: list[str | type] | None = None,
        table_name_generator: Callable[[type[Model]], str] | None = None,
        init_connections: bool = True,
        _enable_global_fallback: bool = False,
    ) -> None:
        """
        Initialize this context with database configuration.

        You can configure using one of: ``config``, ``config_file``, or ``(db_url, modules)``.

        This method is self-sufficient and can be used directly in tests without
        going through Tortoise.init():

            async with TortoiseContext() as ctx:
                await ctx.init(db_url="sqlite://:memory:", modules={"models": ["myapp.models"]})
                # Run tests...

        Args:
            config: Full configuration dict or TortoiseConfig with 'connections' and 'apps' keys.
            config_file: Path to .json or .yml file containing configuration.
            db_url: Database URL string (e.g., "sqlite://:memory:").
            modules: Dictionary mapping app labels to lists of model modules.
            _create_db: If True, creates the database if it doesn't exist.
            use_tz: If True, datetime fields will be timezone-aware.
            timezone: Timezone to use, defaults to "UTC".
            routers: List of database router paths or classes.
            table_name_generator: Optional callable to generate table names.
            init_connections: If False, skips initializing connection clients while still
                loading apps and validating connection names against the config.
            _enable_global_fallback: If True, sets this context as the global fallback
                for cross-task access (e.g., asgi-lifespan scenarios). Default is False.

        Raises:
            ConfigurationError: If configuration is invalid or incomplete.
        """
        from tortoise.apps import Apps

        # Handle config_file: load it as config dict
        if config_file is not None:
            if config is not None:
                raise ConfigurationError("Cannot specify both 'config' and 'config_file'")
            config = self._get_config_from_config_file(config_file)

        # Convert input to TortoiseConfig for typed access
        typed_config: TortoiseConfig
        if config is None:
            if db_url is None or modules is None:
                raise ConfigurationError(