Колба-restful: маршал сложный объект для json

у меня есть вопрос относительно расширения колбы restful. Я только начал его использовать и столкнулся с одной проблемой. У меня flask-sqlalchemy сущности, которые связаны отношением "многие-к-одному", и я хочу, чтобы конечная точка restful возвращала родительскую сущность со всеми ее дочерними элементами в json использование marshaller. В моем случае Set содержит много параметров. Я посмотрел на фляжку-спокойно!--7-->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

поэтому мне нужен способ правильно определить set_marshaller, что конечная точка возвращает этот json:

{
  "id": : "1",
  "title": "any-title",
  "parameters": [
       {"flag": "any-flag", "value": "any-value" },
       {"flag": "any-flag", "value": "any-value" },
       .....
   ]
}

Я ценю любую помощь.

12
flask flask-restful json python rest

2 ответов

Я сам нашел решение этой проблемы.

после игры с 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")
20

Это дополнение к Zygimantasбыл ' 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) субъектами являются только загружается по мере необходимости.

6