python - 使用 DB 数据模型生成 SQLAlchemy 模型、模式和 JSON 响应

Question

将 Flask 和 SQLAlchemy 用于 Python webapp，我的目标是创建一个系统，我可以在其中:

1. 从现有的 PostgreSQL 数据库导入数据模型，并将它们映射到相应 SQLAlchemy 模型中的字段
2. 使用这些 SQLAlchemy 模型自动生成架构。然后，该架构将用于对用户提交的数据执行数据验证。(我目前正在尝试使用 Marshmallow，但愿意接受其他建议)。
3. 使用第 2 步中生成的模式执行 JSON 响应格式化。(我目前正在尝试根据 JsonAPI 的模式格式化我的响应 - 如果需要，这可能会改变，但我更喜欢它)。

所有这些都将打包在一个单一的层中，该层应该允许在编写 API 时进行简单的数据访问、验证和响应格式化，希望无需手动定义数据模型或模式超过已经存在的定义数据库。这引出了我的问题:

我可以利用现有的框架来完成我想要完成的所有事情吗？我不希望有一个库可以完成所有事情，但我希望能够利用几个现有的框架。但是，我遇到了直接冲突，尤其是在第 2 步和第 3 步中。到目前为止，我一直尝试使用的堆栈如下:

• Flask(我的网络框架)
• SQLAlchemy(用于通过反射访问我的数据，见下文)
• Flask-Marshmallow(生成数据验证模式)
• Marshmallow-JsonAPI(根据 JsonAPI 规范格式化 JSON 响应)

我有第 1 步的解决方案:SQLAlchemy 的反射。这允许我读取现有数据库中的表并将它们映射到 SQLAlchemy 模型。这很好用。

第 2 步和第 3 步的结合使它变得模糊 - 我正在尝试使用 Flask-Marshmallow 和 Marshmallow-JsonAPI。 Flask-Marshmallow 有 ModelSchema class ，它允许您通过将现有的 SQLAlchemy 模型传递给模式来生成模式。我可以将我在步骤 1 中生成的 SQLAlchemy 模型传递给它，满足我在步骤 2 中的标准。至于 Marshmallow-JsonAPI，它具有这样的功能，您可以为您的模型定义模式，它会自动创建符合 JSONAPI 的响应，满足我对第 3 步的标准。我可以单独使用这些框架中的每一个来执行我需要的操作。

不幸的是，由于我的模式必须从 Flask-Marshmallow 和 Marshmallow-JSONAPI 中的模式类继承，所以我遇到了问题。我的“虚拟”类模型如下所示:

import flask
from marshmallow_jsonapi import Schema, fields
from sqlalchemy.ext.declarative import DeferredReflection
from flask_marshmallow import Marshmallow
from flask_sqlalchemy import SQLAlchemy

app = flask.Flask(__name__)
DB = SQLAlchemy()
DB.init_app(app)
MA = Marshmallow(app)
DeferredReflection.prepare(DB.get_engine(app))

class Dummy(DeferredReflection, DB.Model):
    __tablename__ = "dummy"  # This model will be reflected from the Dummy table


class DummySchema(MA.ModelSchema, Schema):  # The problem line
    class Meta:
        model = Dummy  # Create schema for the Dummy model

在尝试启动我的 API 时，出现了如下奇怪的错误:

api_1        | [2017-01-05 23:16:13,379] ERROR in app: Exception on /api/dummy [POST]
api_1        | Traceback (most recent call last):
api_1        |   File "/usr/local/lib/python3.5/site-packages/flask/app.py", line 1612, in full_dispatch_request
api_1        |     rv = self.dispatch_request()
api_1        |   File "/usr/local/lib/python3.5/site-packages/flask/app.py", line 1598, in dispatch_request
api_1        |     return self.view_functions[rule.endpoint](**req.view_args)
api_1        |   File "/usr/local/lib/python3.5/site-packages/flask_restful/__init__.py", line 477, in wrapper
api_1        |     resp = resource(*args, **kwargs)
api_1        |   File "/usr/local/lib/python3.5/site-packages/flask/views.py", line 84, in view
api_1        |     return self.dispatch_request(*args, **kwargs)
api_1        |   File "/usr/local/lib/python3.5/site-packages/flask_restful/__init__.py", line 587, in dispatch_request
api_1        |     resp = meth(*args, **kwargs)
api_1        |   File "/dummyproj/api/src/dummyproj/api/v1/dummy_resource.py", line 34, in post
api_1        |     dummy_schema = dummy.DummySchema()
api_1        |   File "/usr/local/lib/python3.5/site-packages/marshmallow_sqlalchemy/schema.py", line 143, in __init__
api_1        |     super(ModelSchema, self).__init__(*args, **kwargs)
api_1        |   File "/usr/local/lib/python3.5/site-packages/marshmallow_jsonapi/schema.py", line 81, in __init__
api_1        |     super(Schema, self).__init__(*args, **kwargs)
api_1        |   File "/usr/local/lib/python3.5/site-packages/marshmallow/schema.py", line 358, in __init__
api_1        |     self._update_fields(many=many)
api_1        |   File "/usr/local/lib/python3.5/site-packages/marshmallow/schema.py", line 750, in _update_fields
api_1        |     self.__set_field_attrs(ret)
api_1        |   File "/usr/local/lib/python3.5/site-packages/marshmallow/schema.py", line 772, in __set_field_attrs
api_1        |     self.on_bind_field(field_name, field_obj)
api_1        |   File "/usr/local/lib/python3.5/site-packages/marshmallow_jsonapi/schema.py", line 164, in on_bind_field
api_1        |     field_obj.load_from = self.inflect(field_name)
api_1        |   File "/usr/local/lib/python3.5/site-packages/marshmallow_jsonapi/schema.py", line 190, in inflect
api_1        |     return self.opts.inflect(text) if self.opts.inflect else text
api_1        | AttributeError: 'SchemaOpts' object has no attribute 'inflect'

似乎因为我的 Schema 类继承自两个不同的父类(super class)，所以它会导致问题。我希望这两个棉花糖库非常兼容，但似乎确实有一个 issue有了这个。

所有这一切的结果是我不太确定接下来要尝试什么。我并不是真的期待任何关于 Marshmallow 框架的具体建议，更多的只是想展示我的思路。围绕这种设计是否有任何最佳实践，或者我是否试图一次解决太多问题？

(Python 和 SO 的新手 - 如果有任何不清楚的地方，我们深表歉意)。

Answer 1

我成功地结合了 marshmallow-jsonapi + marshmallow-sqlalchemy。神奇之处在于:

import marshmallow
import marshmallow_jsonapi
import marshmallow_jsonapi.flask
import marshmallow_sqlalchemy

import myapp.database as db


def make_jsonapi_schema_class(model_class):
    class SchemaOpts(marshmallow_sqlalchemy.SQLAlchemyAutoSchemaOpts, marshmallow_jsonapi.SchemaOpts):
        pass

    class Schema(marshmallow_sqlalchemy.SQLAlchemyAutoSchema, marshmallow_jsonapi.flask.Schema):
        OPTIONS_CLASS = SchemaOpts

        @marshmallow.post_load
        def make_instance(self, data, **kwargs):
            # Return deserialized data as a dict, not a model instance
            return data

        # You can add default behavior here, for example
        # id = fields.Str(dump_only=True)

    # https://marshmallow-sqlalchemy.readthedocs.io/en/latest/recipes.html#automatically-generating-schemas-for-sqlalchemy-models
    class Meta:
        # Marshmallow-SQLAlchemy
        model = model_class
        sqla_session = db.session

        # Marshmallow-JSONAPI
        type_ = model_class.__name__.lower()
        self_view = type_ + '_detail'
        self_view_kwargs = {'id': '<id>'}
        self_view_many = type_ + '_list'

    schema_class = type(model_class.__name__ + 'Schema', (Schema,), {'Meta': Meta})
    return schema_class

然后你打电话

FooSchema = make_jsonapi_schema_class(Foo)

从您的 SQLAlchemy 声明性模型生成 Marshmallow 模式类。如果您想对其进行自定义，则可以依次子类化该类。

(为了实现 REST API，我使用了 Flask-REST-JSONAPI ，它构建在 Flask + SQLAlchemy + marshmallow-jsonapi 之上。)