Колба-успокоительная:маршалировать сложный объект в json
-
21-12-2019 - |
Вопрос
У меня вопрос относительно расширения flask restful.Я только начал им пользоваться и столкнулся с одной проблемой.У меня есть flask-sqlalchemy
объекты, которые связаны отношением «многие к одному», и я хочу, чтобы эта спокойная конечная точка возвращала родительский объект со всеми его дочерними элементами в json
используя маршаллер.В моем случае Set содержит много параметров.Я посмотрел на флягу-спокойно документы но не было никакого объяснения, как решить это дело.
Кажется, я упускаю что-то очевидное, но не могу найти решения.Вот мой код:
# 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
Поэтому мне нужен способ правильно определить set_marshaller, чтобы конечная точка возвращала этот json:
{
"id": : "1",
"title": "any-title",
"parameters": [
{"flag": "any-flag", "value": "any-value" },
{"flag": "any-flag", "value": "any-value" },
.....
]
}
Я ценю любую помощь.
Решение
Решение этой проблемы я нашел сам.
После игры с flask-restful
я обнаружил, что допустил несколько ошибок:
Во-первых set_marshaller
должно выглядеть так:
blob_marshaller = {
'id': fields.String,
'title': fields.String,
'parameters': fields.Nested(parameter_marshaller)
}
Беспокойный маршаллер может обрабатывать случай, если параметр является списком и маршалирует json
список.
Другая проблема заключалась в том, что параметры набора API имели отложенную загрузку, поэтому, когда я пытался маршалировать набор, я получал 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")
Другие советы
Это дополнение к Зигимантас's отвечать:
Я использую 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) как групповой аргумент позволяет мне настроить представление так, как я хочу.У меня здесь только «плоский», но любую логику можно записать и передать более глубоко вложенным объектам.
3) сущности загружаются только по мере необходимости.