是否可以在棉花糖中定义具有互斥字段的嵌套模式？

Question

我正在使用 marshmallow 来验证我在烧瓶 restful api 中收到的 json 数据。然而在 post 请求中有一个 互斥字段 .
例如： {"predict": {"id": "5hgy667y4h7f"}} 或 {"predict": {"text": "This is a sample sentence"}}
但是 NOT id 和 text 应该一起发送。此外，根据收到的天气 id 或 text 调用不同的方法。

问）我如何在 marshmallow 中构建一个允许我验证上述内容的模式？

我对任一字段的示例代码如下 -

from flask import Flask, request
from flask_restful import Resource, Api, abort
from marshmallow import Schema, fields, ValidationError
app = Flask(__name__)
api = Api(app)

class Mutex1(Schema):
    text = fields.Str(required=True)
    class Meta:
        strict = True

class Mutex2(Schema):
    id_ = fields.Str(required=True)
    class Meta:
        strict = True

class MySchema(Schema):
    predict = fields.Nested(Mutex1)
    class Meta:
        strict = True

class Test(Resource):
    def post(self):
        input_req = request.get_json(force=True)
        try:
            result = MySchema().load(input_req)
        except ValidationError:
            return {'message': 'Validation Error'}, 500
        else:
            return {'message': 'Successful validation'}, 200

api.add_resource(Test, '/test')
app.run(host='0.0.0.0', port=5000, debug=True)

此代码仅接受 text，以及 text 和 id_，但它仅拒绝 id_。知道如何让它接受 id_ 并在一起传递时拒绝 text 和 id_ 吗？

Answer 1

创建一个包含 text 和 id_ 的 Mutex 架构，如果两者都提供，则添加 schema-level validation 以失败。

class Mutex(Schema):

    @validates_schema
    def validate_numbers(self, data):
        if (
               ('text' in data and 'id_' in data) or
               ('text' not in data and 'id_' not in data)
           ):
            raise ValidationError('Only one of text and _id is allowed')

    text = fields.Str()
    id_ = fields.Str()
    class Meta:
        strict = True

旁注：

输入验证错误不应 return 500（服务器错误）而是 422。
我不熟悉 flask-restful，但看起来您可以通过使用 webargs 解析资源输入来节省一些样板文件。

是否可以在棉花糖中定义具有互斥字段的嵌套模式？

Is it possible to define a nested schema with mutually exclusive fields in marshmallow?

python

python-3.x

flask

flask-restful

marshmallow