python - db.session.commit 是否会更改 Flask-SQLAlchemy 中的应用程序上下文？

Question

我正在为创建 Flask 应用程序实例的 pytest 配置 fixture 。我的应用程序是用 Application Factories pattern 创建的.我正处于将它连接到数据库的阶段，并且很难理解 2 种模式之间的区别。

# project/__init__.py
import os
from flask import Flask
from flask_sqlalchemy import SQLAlchemy


db = SQLAlchemy()


def create_app():
    app = Flask(__name__)

    app_settings = os.getenv('APP_SETTINGS')
    app.config.from_object(app_settings)

    db.init_app(app)

    [blueprint code]

    return app

在我的装置中，我想我明白需要:

• db.create_all() 在设置期间:创建我的表
• db.drop_all() 拆解期间:测试后清理数据库
• db.session.remove() 在拆解期间:避免在测试中频繁访问数据库时对 postgres 进行一些奇怪的锁定

第一个设置(受 Miguel Grinberg book 启发)对我来说很有意义:

import pytest
from project import create_app, db


@pytest.fixture
def app():
    app = create_app()
    with app.app_context():
        db.create_all()
        yield app
        db.session.remove()
        db.drop_all()

它也符合我在交互式 session 中获得的行为，我需要激活/推送 app_context 来绑定(bind)数据库:

Python 3.6.1 (default, Jun 21 2017, 18:45:41) 
[GCC 4.9.2] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from project import create_app, db
>>> app = create_app()
>>> db
<SQLAlchemy engine=None>
>>> app_ctx = app.app_context()
>>> app_ctx.push()
>>> db.create_all()
>>> db
<SQLAlchemy engine='postgres://postgres:postgres@users-db:5432/users_dev'>

第二个设置(受 testdriven.io 启发)也适用于 pytest，但我不知道为什么:

import pytest
from project import create_app, db


@pytest.fixture
def app():
    app = create_app()
    db.create_all()
    db.session.commit()  # fail when this is removed
    yield app
    db.session.remove()
    db.drop_all()

实际上，如果我尝试在交互式 session 中做同样的事情，我会得到一个错误:

Python 3.6.1 (default, Jun 21 2017, 18:45:41) 
[GCC 4.9.2] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from project import create_app, db
>>> app = create_app()
>>> db.create_all()
[...] timeError: application not registered on db instance and no application bound to current context

我尝试在没有 db.session.commit() 的情况下运行 fixture，我想也许默认情况下我在应用程序上下文中(类似于我对 with app_context() 所做的 在第一个 fixture 中)。但如果我删除它，它就会失败。

Answer 1

第一个问题是第二个设置(通过 testdriven.io)没有使用应用程序工厂模式，它们显式实例化数据库并绑定(bind)应用程序(例如，db = SQLAlchemy(app) 对比 db = SQLAlchemy() 和 create_app() 中的 db.init(app)) .如果您使用的是应用程序工厂模式，您会在执行 db.create_all()、保留/删除 db.session.commit() 后得到在交互式 session 中看到的错误 无论哪种方式都无济于事。

我知道您在每次尝试中都使用了两个不同的from project import create_app, db，并为交互式 shell 使用了应用程序工厂模式。

无论如何，您实际上是在问两个问题。

1) 为什么在使用应用程序工厂模式时需要推送应用程序上下文才能运行 db.create_all()？

如果您查看 SQLAlchemy 中的 __init__ 方法，您会注意到您可以传递一个应用程序，在这种情况下，该应用程序将绑定(bind)到 SQLAlchemy对象，self.app = app。但是，因为您使用的是应用程序工厂模式，所以该应用程序永远不会显式绑定(bind)，即使在您运行 db.init_app(app) 之后也是如此。现在查看 create_all()，它需要一个可选的 app，您不会通过它，所以当我们到达 get_app 时，我们跳过 reference_app 因为它是 None，我们继续 current_app，它查看 Flask 的应用程序上下文(参见 from flask import current_app)，如果你没有推送上下文，这也是None，最后我们检查是否有self.app，但是这个也是 None 因为我们正在使用应用程序工厂模式，因此 application 未在 db 实例上注册并且没有应用程序绑定(bind)到当前上下文错误。

2) 在 SQLAlchemy 实例化期间绑定(bind)应用程序时，为什么我需要在运行 db.create_all 之后显式运行 db.session.commit()(例如，db = SQLAlchemy(app))?**

我似乎无法重现此错误，我在下面添加了一个代码块来向您展示我正在使用的内容，我从 testdriven.io 站点获得了这些片段。但是，您不需要 db.session.commit()，这是使用应用程序工厂模式和使用应用程序实例化 SQLAlchemy 之间的唯一区别(例如，db = SQLAlchemy(app) ) 是，对于前者，您需要在 create_all(app) 中传递应用程序或推送应用程序上下文。

import pytest
import os
import datetime
from flask import Flask, jsonify
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)

db = SQLAlchemy(app)


@pytest.fixture
def app():
    app = create_app()
    db.create_all()
    # db.session.commit()  # Try this with and without this line
    yield app
    db.session.remove()
    db.drop_all()

---

引用资料:

https://github.com/mitsuhiko/flask-sqlalchemy/blob/d71afea650e0186348d81f02cca5181ed7c466e9/flask_sqlalchemy/init.py

http://flask-sqlalchemy.pocoo.org/2.1/contexts/