web-dev-qa-db-ja.com

Flask-restful：複雑なオブジェクトをjsonにマーシャリングする

flask Restful Extensionについて質問があります。使い始めたばかりで、1つの問題に直面しました。多対1の関係で接続されているflask-sqlalchemyエンティティがあります。安らかなエンドポイントがマーシャラーを使用してjson内のすべての子を持つ親エンティティを返すようにします。私の場合、Setには多くのパラメーターが含まれています。flask-restful 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" },
       .....
   ]
}

私はどんな助けにも感謝します。

pythonjsonrestflaskflask-restful
15
Zygimantas Gatelis

私はその問題の解決策を自分で見つけました。

flask-restfulで遊んだ後、私はいくつかの間違いをしたことがわかりました。

まず、set_marshallerは次のようになります。

blob_marshaller = {
    'id': fields.String,
    'title': fields.String,
    'parameters': fields.Nested(parameter_marshaller)
}

パラメータがlistであり、json listにマーシャリングする場合、落ち着きのないマーシャラーはケースを処理できます。

もう1つの問題は、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")
22
Zygimantas Gatelis

これは 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）group引数を使用すると、表現を自由にカスタマイズできます。ここには「フラット」しかありませんが、任意のロジックを記述して、より深いネストされたオブジェクトに渡すことができます。

3）エンティティは必要な場合にのみロードされます。

7
Tjorriemorrie