我有一个关于烧瓶平稳扩展的问题。我刚刚开始使用它,遇到了一个问题。我有flask-sqlalchemy
个实体,它们之间存在多对一关系,并且我希望该静态端点使用marshaller返回其所有子实体在json
中的父实体。就我而言,Set包含许多参数。我查看了烧瓶不稳定的docs,但没有任何解决方法的解释。
似乎我缺少明显的东西,但找不到任何解决方案。这是我的代码:
# entities
class Set(db.Model):
id = db.Column("id", db.Integer, db.Sequence("set_id_seq"), primary_key=True)
title = db.Column("title", db.String(256))
parameters = db.relationship("Parameters", backref="set", cascade="all")
class Parameters(db.Model):
id = db.Column("id", db.Integer, db.Sequence("parameter_id_seq"), primary_key=True)
flag = db.Column("flag", db.String(256))
value = db.Column("value", db.String(256))
set_id = db.Column("set_id", db.Integer, db.ForeignKey("set.id"))
# marshallers
from flask.ext.restful import fields
parameter_marshaller = {
"flag": fields.String,
"value": fields.String
}
set_marshaller = {
'id': fields.String,
'title': fields.String,
'parameters': fields.List(fields.Nested(parameter_marshaller))
}
# endpoint
class SetApi(Resource):
@marshal_with(marshallers.set_marshaller)
def get(self, set_id):
entity = Set.query.get(set_id)
return entity
restful_api = Api(app)
restful_api.add_resource(SetApi, "/api/set/<int:set_id>")
现在当我打电话给/api/set/1
时,我收到服务器错误:
TypeError: 'Set' object is unsubscriptable
因此,我需要一种正确定义端点返回此json的set_marshaller的方法:
{
"id": : "1",
"title": "any-title",
"parameters": [
{"flag": "any-flag", "value": "any-value" },
{"flag": "any-flag", "value": "any-value" },
.....
]
}
感谢您的帮助。
我自己找到了解决该问题的方法。
[玩弄flask-restful
之后,我发现自己犯了一些错误:
首先set_marshaller
应该看起来像这样:
set_marshaller = {
'id': fields.String,
'title': fields.String,
'parameters': fields.Nested(parameter_marshaller)
}
如果参数是列表,并且编组到json
列表,则鲁R编组可以处理情况。
[另一个问题是,在API Set中,参数具有延迟加载,因此当我尝试编组Set时,我得到了KeyError: 'parameters'
,因此我需要像这样显式加载参数:
class SetApi(Resource):
@marshal_with(marshallers.set_marshaller)
def get(self, set_id):
entity = Set.query.get(set_id)
entity.parameters # loads parameters from db
return entity
或者另一个选择是更改模型关系:
parameters = db.relationship("Parameters", backref="set", cascade="all" lazy="joined")
这是Zygimantas的answer:
我正在使用Flask-RESTful,这是加载嵌套属性的一种解决方案。
您可以将可调用对象传递给元帅装饰器:
class OrgsController(Resource):
@marshal_with(Organization.__json__())
def get(self):
return g.user.member.orgs
然后更新模型以返回其自身实体的资源字段。因此,嵌套实体将相对地返回其实体的资源字段。
class Organization(db.Model):
id = db.Column(db.Integer, primary_key=True)
...
@staticmethod
def __json__(group=None):
_json = {
'id': fields.String,
'login': fields.String,
'description': fields.String,
'avatar_url': fields.String,
'paid': fields.Boolean,
}
if group == 'flat':
return _json
from app.models import Repository
_json['repos'] = fields.Nested(Repository.__json__('flat'))
return _json
class Repository(db.Model):
id = db.Column(db.Integer, primary_key=True)
owner_id = db.Column(db.Integer, db.ForeignKey('organization.id'))
owner = db.relationship('Organization', lazy='select', backref=db.backref('repos', lazy='select'), foreign_keys=[owner_id])
...
@staticmethod
def __json__(group=None):
_json = {
'id': fields.String,
'name': fields.String,
'updated_at': fields.DateTime(dt_format='iso8601'),
}
if group == 'flat':
return _json
from app.models import Organization
_json['owner'] = fields.Nested(Organization.__json__('flat'))
return _json
这给出了我正在寻找的表示形式,并尊重了延迟加载:
[
{
"avatar_url": "https://avatars.githubusercontent.com/u/18945?v=3",
"description": "lorem ipsum.",
"id": "1805",
"login": "foobar",
"paid": false,
"repos":
[
{
"id": "9813",
"name": "barbaz",
"updated_at": "2014-01-23T13:51:30"
},
{
"id": "12860",
"name": "bazbar",
"updated_at": "2015-04-17T11:06:36"
}
]
}
]
我喜欢
1)这种方法如何允许我为每个实体定义我的资源字段,并且可用于应用程序中的所有资源路由。
2)组参数如何允许我根据需要自定义表示。我这里只有'flat',但是可以编写任何逻辑并将其传递给更深层的嵌套对象。
3)实体仅在必要时加载。