as_flask_sqlalchemy

函数源码

db: _SQLAlchemyDB = as_flask_sqlalchemy(db: _SQLAlchemyDB)
db: SQLAlchemyProxy[_SQLAlchemyLiteDB_co, _ModelLite_co] = as_flask_sqlalchemy(
     db: _SQLAlchemyLiteDB_co,
     model_class: Type[_ModelLite_co],
)

令db按照flask_sqlalchemy的方式工作。

别名

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

import flask_sqlalchemy_compat as fsc


fsc.as_flask_sqlalchemy
fsc.flask_sa_api.as_flask_sqlalchemy

参数

输入

参数	类型	必选	说明
db	_SQLAlchemyDB | _SQLAlchemyLiteDB_co		需要封装的数据库扩展实例。
model_class	Type[_ModelLite_co]		若db并非来自flask_sqlalchemy时，用来模拟db.Model行为的基模型。须知这种情况下，为了添加诸如、自动表名称、query方法等兼容性功能，以和flask_sqlalchemy.SQLAlchemy().Model对齐，该值将会被原处修改。 若db来自flask_sqlalchemy，不应提供该值。

• 其中，_SQLAlchemyDB是fsc.protocols.SQLAlchemyProtocol的TypeVar。
• 其中，_SQLAlchemyLiteDB_co是fsc.protocols.SQLAlchemyLiteProtocol的TypeVar。
• 其中，_ModelLite_co是sa.orm.DeclarativeBase的TypeVar。

输出

参数	类型	说明
db	flask_sqlalchemy.SQLAlchemy | SQLAlchemyProxy(db, model_class)	若db来自flask_sqlalchemy，直接原样返回。 若db来自flask_sqlalchemy_lite，返回它的代理封装。该封装和flask_sqlalchemy.SQLAlchemy()有着相同的API，但底层是藉由flask_sqlalchemy_lite.SQLAlchemy()实现的。