Flask,棉花糖3和webargs use_args无法解析参数

时间:2020-06-20 01:56:47

标签: python flask marshmallow webargs

对于Flask 1.1.2,棉花糖3.6.1和webargs 6.1.0,我所有的参数始终为missing

模式:

class ExportSearchSchema(Schema):
    limit = fields.Integer(required=False, allow_none=False, default=10, missing=10)
    offset = fields.Integer(required=False, allow_none=False, default=0, missing=0)
    status = fields.Str(required=False)

    class Meta:
        unknown = RAISE

    @validates('status')
    def validate_status(self, value):
        if value and value not in ['complete', 'pending', 'failed']:
            raise ValidationError('Invalid status: {}'.format(value))

    @validates('limit')
    def validate_limit(self, value):
        if value > 100:
            raise ValidationError('Max limit is 100')
        if value < 1:
            raise ValidationError('Limit must be a positive number and less than 100')

    @validates('offset')
    def validate_offset(self, value):
        if value < 0:
            raise ValidationError('Offset must be equal to, or greater than 0')

blueprint.py:

from flask import jsonify, Response
from flask import Blueprint
from marshmallow import Schema, fields, validates, ValidationError, RAISE
from webargs.flaskparser import use_args

exports = Blueprint('exports', __name__)

@exports.route('exports/',
               methods=['GET'], strict_slashes=False)
@use_args(ExportSearchSchema(unknown=RAISE))
def get_export_list(qparams):
  log.info("qparams {}".format(qparams)
  response = jsonify({'data': 'export_list'})
  response.mimetype = 'application/json'
  return response

当我卷曲limitoffset的任何值时,它总是使用default的值。

curl http://localhost:8000/exports?limit=5930

log: "qparams {'limit': 10, 'offset': 0}"}

我希望提高ValidationError,因为限制应大于100。

当我卷曲未知参数时,我希望它会提高ValidationError,因为它是未知参数。这也无法按预期工作。

curl http://localhost:8000/exports?lkfjdskl=fkjdsl

返回200并且没有qparams

在将webargsFlaskmarshmallow组合在一起时,我在做什么错了?

1 个答案:

答案 0 :(得分:1)

逻辑在webargs 6中已更改。

在webargs 6之前,解析器将迭代架构的字段,并且默认情况下在多个位置搜索以找到值。

在webargs 6中,解析器仅将数据从单个位置传递到架构。该位置默认为"json"

由于您使用的是查询参数,因此需要明确指定:

@use_args(ExportSearchSchema(unknown=RAISE), location="query")

由于您未指定位置,因此假设使用json主体,因此一无所获,并使用默认值。

这在webargs文档:"upgrading to 6.0"中有记录。