Flask-Marshmallow的init_app()实际上是否必要?

时间:2018-01-31 13:00:56

标签: python flask sqlalchemy flask-sqlalchemy marshmallow

Flask-Marshmallow documentationMarshmallow.init_app()

有这个说法
  

使用扩展名初始化应用程序。

code behind it似乎做了一些与SQLAlchemy会话管理相关的重要事项:

def init_app(self, app):
    app.extensions = getattr(app, 'extensions', {})

    # If using Flask-SQLAlchemy, attach db.session to ModelSchema
    if has_sqla and 'sqlalchemy' in app.extensions:
        db = app.extensions['sqlalchemy'].db
        self.ModelSchema.OPTIONS_CLASS.session = db.session
    app.extensions[EXTENSION_NAME] = self

但我一直在使用和开发我的应用程序一段时间没有在任何地方打电话给init_app,而且它似乎工作得很好。我使用的是SQLAlchemy,Flask-SQLAlchemy和Marshmallow-SQLAlchemy(以及Flask-Marshmallow)。

由于没有ma.init_app(app),我造成了什么问题?为什么一切似乎都有用?

目前,我有一个database和一个schema模块; database看起来像这样:

from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()

class Customer(db.Model):
    ...

schema是这样的:

from flask_marshmallow import Marshmallow
from database import Customer

ma = Marshmallow()

class CustomerSchema(ma.ModelSchema):
    class Meta:
        model = Customer

在我的顶级__init__.py中,我这样做:

from flask import Flask
from database import db

app = Flask(__name__)
db.init_app(app)
with app.app_context():
    db.create_all()

这是一个MVCE(放入mvce/__init__.py,使用PYTHONPATH=. FLASK_APP=mvce flask run运行,然后向localhost:5000发出POST请求,并将name表单字段设置为某个值,然后进行GET请求查看Customer已正确提交到数据库):

from flask import Flask, request
from flask_sqlalchemy import SQLAlchemy
from flask_marshmallow import Marshmallow

app = Flask(__name__)
app.config["SQLALCHEMY_DATABASE_URI"] = "sqlite:///database.db"

@app.route("/")
def get():
    return CustomerSchema(many=True).jsonify(Customer.query.all())
@app.route("/", methods=["POST"])
def new():
    customer, errors = CustomerSchema().load(request.form)
    if errors:
        return errors, 400
    db.session.add(customer)
    db.session.commit()
    return CustomerSchema().jsonify(customer)

db = SQLAlchemy()
class Customer(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String)

ma = Marshmallow()  # Not passing `app`
class CustomerSchema(ma.ModelSchema):
    class Meta:
        model = Customer

db.init_app(app)
with app.app_context():
    db.create_all()
# Note that we don't ever call `ma.init_app(app)`!

2 个答案:

答案 0 :(得分:2)

调用flask_marshmallow.Marshmallow.init_app()会将Flask-SQLAlchemy创建的作用域会话绑定到flask_marshmallow.ModelSchemaflask_marshmallow.ModelSchemamarshmallow_sqlalchemy.ModelSchema相同,但可以避免手动传递会话对象。< / p>

flask_marshmallow.ModelSchema可以generate schema fields from existing SQLAlchemy model为您,并直接将数据反序列化为SQLAlchemy模型。如果您不使用此功能,您可能根本不需要Flask-Marshmallow,但我建议您使用它,使用init_app调用Flask-Marshmallow ModelSchema().load是必要的}。

答案 1 :(得分:1)

总结对该问题的评论(非常感谢georgexsh):

是的,init_app是必需的,否则当您尝试使用主键schema.load()时,您会收到错误。此外,必须在创建任何模式之前调用它,并且必须在对(Flask-SQLAlchemy)数据库对象执行相同操作后调用它。 IOW,你必须按顺序做事:

db = flask_sqlalchemy.SQLAlchemy()
ma = flask_marshmallow.Marshmallow()
db.init_app(app)
ma.init_app(app)
class CustomerSchema(ma.ModelSchema):
    ...

所以将app直接传递给构造函数可能更容易:

db = flask_sqlalchemy.SQLAlchemy(app)
ma = flask_marshmallow.Marshmallow(app)

如果您的应用程序架构使这一点变得棘手(例如,您在app中定义myapp/__init__.py,而在myapp/database.py中定义数据库模型,在myapp/schema.py中定义模式),则可以移动定义app到一个单独的模块,例如myapp/app.py,然后执行类似

的操作
from myapp.app import app
db = flask_sqlalchemy.SQLAlchemy(app)

您需要使用它的任何地方。