get_flask_sqlalchemy

函数源码

db: flask_sqlalchemy.SQLAlchemy = get_flask_sqlalchemy(
    model_class: type[sa_orm.DeclarativeBase],
    app: Flask | None = None,
    engine_options: Mapping[str, Any] | None = None,
    session_options: Mapping[str, Any] | None = None,
)

在兼容前提下，获取Flask SQLAlchemy数据库扩展实例。

该方法将试图获取flask_sqlalchemy.SQLAlchemy数据库扩展对象。若失败（所依赖的包未安装），则退回到使用flask_sqlalchemy_lite.SQLAlchemy模拟flask_sqlalchemy.SQLAlchemy接口的做法。

别名

该函数可以按以下方式之一获取

import flask_sqlalchemy_compat as fsc


fsc.get_flask_sqlalchemy
fsc.auto.get_flask_sqlalchemy

参数

输入

参数	类型	必选	说明
model_class	type[sa.orm.DeclarativeBase]		应用到整个数据库的基础 ORM 模型类型。若flask_sqlalchemy可用，该类型将会作为model_class传递给数据库扩展实例的构造函数，并用来创建扩展实例所持有的基模型类。不过，若数据库对象退回到了flask_sqlalchemy_lite提供的版本，该类型将会受到原处修改，以便其能支持flask_sqlalchemy.SQLAlchemy().Model的特性。
app	Flask | None		向该 Flask 应用调用init_app方法。若未指定该值，则不会调用init_app。
engine_options	Mapping[str, Any] | None		该配置将会在创建每个引擎时，传递给构造函数sqlalchemy.create_engine。
session_options	Mapping[str, Any] | None		用来配置sessionmaker的参数。

输出

参数	类型	说明
db	flask_sqlalchemy.SQLAlchemy	SQLAlchemy 扩展实例。当所需的包可用时，该值将是flask_sqlalchemy.SQLAlchemy的实例。 若缺少所需的包，会尝试返回SQLAlchemyProxy[flask_sqlalchemy_lite.SQLAlchemy, _ModelLite]实例。但这种情况下，返回值仍然会注解为flask_sqlalchemy.SQLAlchemy。亦即是说，用户应当使用flask_sqlalchemy开发代码，并将该返回值作为一个备选来处理。