将 Flask 和 SQLAlchemy 用于 Python Web 应用程序,我的目标是创建一个系统,在其中我可以:
- 从现有 PostgreSQL 数据库导入数据模型,并将它们映射到相应 SQLAlchemy 模型中的字段
- 使用这些 SQLAlchemy 模型自动生成架构。然后,该模式将用于对用户提交的数据执行数据验证。(我目前正在尝试使用 Marshmallow,但我愿意接受其他建议)。
- 使用步骤 2 中生成的架构执行 JSON 响应格式化。(我目前正在尝试根据 JsonAPI 的架构格式化我的响应 - 如果需要,这可以更改,但我更喜欢它)。
所有这些都将打包在一个层中,在编写 API 时应允许简单的数据访问、验证和响应格式化,希望无需手动定义超出数据库中已存在的定义的数据模型或模式。这引出了我的问题:
我可以利用现有框架来完成我想要完成的所有事情吗?我并不期望有一个库可以完成所有工作,但我希望能够利用多个现有框架。然而,我遇到了直接冲突,特别是在步骤 2 和 3 中。到目前为止我一直尝试使用的堆栈如下:
- Flask(我的网络框架)
- SQLAlchemy(用于通过反射访问我的数据,见下文)
- Flask-Marshmallow(生成数据验证模式)
- Marshmallow-JsonAPI(根据 JsonAPI 规范格式化 JSON 响应)
我有第 1 步的解决方案:SQLAlchemy 的反射。这使我能够读取现有数据库中的表并将它们映射到 SQLAlchemy 模型。这效果很好。
步骤 2 和 3 的组合是它变得模糊的地方 - 我正在尝试使用 Flask-Marshmallow 和 Marshmallow-JsonAPI。烧瓶棉花糖有模型架构类 https://flask-marshmallow.readthedocs.io/en/latest/#flask_marshmallow.sqla.ModelSchema,它允许您通过向其传递现有的 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 类继承自两个不同的超类,因此会导致问题。我希望这两个棉花糖库非常兼容,但似乎确实有一个issue https://github.com/marshmallow-code/marshmallow-jsonapi/issues/3有了这个。
所有这一切的结果是我不太确定下一步该尝试什么。我并不是真的期待任何有关 Marshmallow 框架的具体建议,更多只是想展示我的思路。是否有围绕这种设计的最佳实践,或者我是否试图一次解决太多问题?
(对于 Python 和 SO 来说都是新的 - 如果有任何不清楚的地方,我们深表歉意)。