INNER CODE UNIT · Python

get_database_migration_plugin

litestar-org/advanced-alchemy · advanced_alchemy/extensions/fastapi/cli.py:12

def get_database_migration_plugin(app: "FastAPI") -> "AdvancedAlchemy":  # pragma: no cover
    """Retrieve the Advanced Alchemy extension from a FastAPI application instance.

    Args:
        app: The FastAPI application instance.

    Raises:
        ImproperConfigurationError: If the Advanced Alchemy extension is not properly configured.

    Returns:
        The Advanced Alchemy extension instance.
    """
    from advanced_alchemy.exceptions import ImproperConfigurationError

    extension = cast("Optional[AdvancedAlchemy]", getattr(app.state, "advanced_alchemy", None))
    if extension is None:
        msg = "Failed to initialize database CLI. The Advanced Alchemy extension is not properly configured."
        raise ImproperConfigurationError(msg)

View source record →