plugin¶
- class advanced_alchemy.extensions.litestar.plugins.init.plugin.SQLAlchemyInitPlugin[source]¶
Bases:
InitPluginProtocol
,CLIPluginProtocol
,SlotsBase
SQLAlchemy application lifecycle configuration.
- __init__(config: SQLAlchemyAsyncConfig | SQLAlchemySyncConfig | Sequence[SQLAlchemyAsyncConfig | SQLAlchemySyncConfig]) None [source]¶
Initialize
SQLAlchemyPlugin
.- Parameters:
config¶ – configure DB connection and hook handlers and dependencies.
- on_cli_init(cli: Group) None [source]¶
Called when the CLI is initialized.
This can be used to extend or override existing commands.
- Parameters:
cli¶ – The root
click.Group
of the Litestar CLI
Examples
from litestar import Litestar from litestar.plugins import CLIPluginProtocol from click import Group class CLIPlugin(CLIPluginProtocol): def on_cli_init(self, cli: Group) -> None: @cli.command() def is_debug_mode(app: Litestar): print(app.debug) app = Litestar(plugins=[CLIPlugin()])