Flask-SQLAlchemy 导入/上下文问题

Posted 2023-02-15

【中文标题】Flask-SQLAlchemy 导入/上下文问题

【英文标题】：Flask-SQLAlchemy import/context issue

【发布时间】：2012-03-30 09:08:34

【问题描述】：

我想构建我的 Flask 应用程序，如下所示：

./site.py
./apps/members/__init__.py
./apps/members/models.py

apps.members 是一个 Flask 蓝图。

现在，为了创建模型类，我需要拥有应用程序，例如：

# apps.members.models
from flask import current_app
from flaskext.sqlalchemy import SQLAlchemy

db = SQLAlchemy(current_app)

class Member(db.Model):
    # fields here
    pass

但如果我尝试将该模型导入我的蓝图应用程序，我会得到可怕的RuntimeError: working outside of request context。如何在此处正确获取我的应用程序？相对导入可能有效，但它们非常丑陋并且有自己的上下文问题，例如：

from ...site import app

# ValueError: Attempted relative import beyond toplevel package

【参考方案1】：

flask_sqlalchemy 模块不必立即使用应用程序初始化 - 您可以这样做：

# apps.members.models
from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()

class Member(db.Model):
    # fields here
    pass

然后在您的应用程序设置中，您可以调用init_app：

# apps.application.py
from flask import Flask
from apps.members.models import db

app = Flask(__name__)
# later on
db.init_app(app)

这样可以避免循环导入。

此模式不需要您将所有模型放在一个文件中。只需将 db 变量导入您的每个模型模块即可。

示例

# apps.shared.models
from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()

# apps.members.models
from apps.shared.models import db

class Member(db.Model):
    # TODO: Implement this.
    pass

# apps.reporting.members
from flask import render_template
from apps.members.models import Member

def report_on_members():
    # TODO: Actually use arguments
    members = Member.filter(1==1).all()
    return render_template("report.html", members=members)

# apps.reporting.routes
from flask import Blueprint
from apps.reporting.members import report_on_members

reporting = Blueprint("reporting", __name__)

reporting.route("/member-report", methods=["GET","POST"])(report_on_members)

# apps.application
from flask import Flask
from apps.shared import db
from apps.reporting.routes import reporting

app = Flask(__name__)
db.init_app(app)
app.register_blueprint(reporting)

_{注意：这是它为您提供的一些功能的草图 - 显然，您可以做更多的事情来使开发更加平衡更容易（使用create_app 模式，在某些文件夹中自动注册蓝图等）}

【讨论】：

你可以多次这样做吗？例如，如果我有多个 models.py 文件？

@BradWright - 如果您只为您拥有的每个数据库创建 db 实例，它会更容易。如果你有一个模型包，你可以把它放在__init__.py。无论您选择这样做，您只需将该位置的db 变量导入您的其他模型文件并正常使用它。加载它们后，一切都会正确解决。

你会碰巧有一个以这种方式设置的项目的链接吗？

@Mbrevda - 你可以在这里看到这个模式的一个例子github.com/svieira/Budget-Manager

.ext. 命名空间已弃用 - 最好从真正的命名空间 (flask_sqlalchemy) 导入。

【参考方案2】：

一个原创的app.py：https://flask-sqlalchemy.palletsprojects.com/en/2.x/quickstart/

...

app = flask.Flask(__name__)
app.config['DEBUG'] = True
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:////tmp/test.db'
db = flask.ext.sqlalchemy.SQLAlchemy(app)

class Person(db.Model):
    id = db.Column(db.Integer, primary_key=True)
...

class Computer(db.Model):
    id = db.Column(db.Integer, primary_key=True)
...

# Create the database tables.
db.create_all()

...

# start the flask loop
app.run()

我只是在没有使用蓝图的情况下将一个 app.py 拆分为 app.py 和 model.py。在这种情况下，上述答案不起作用。需要一行代码才能工作。

之前：

db.init_app(app)

之后：

db.app = app
db.init_app(app)

而且，下面的链接非常有用。

http://piotr.banaszkiewicz.org/blog/2012/06/29/flask-sqlalchemy-init_app/

【讨论】：

db.app = app 因为 init_app 没有设置 app. +1

db.app = app（后面是db.init_app(app)）对我来说是缺失的部分。添加该行后完美运行（结合 Sean Vieira 的回答）

第一个链接已过时。

添加db.app = app 立即生效.. 这应该添加到官方文档中。