前言
使用 reqparse.RequestParser() 解析器校验请求参数时,如果没传这个参数,解析后会给个None值,导致更新数据的时候非常不方便。
遇到问题
下面代码有3个请求参数,都是非必须的,在更新数据的时候, 期望传什么参数就更新什么参数的内容,没传过来的参数不要给默认值None
代码语言:javascript复制from flask_restx import Namespace, Resource, reqparse
api = Namespace('api', description='项目')
parser = reqparse.RequestParser()
parser.add_argument('name', location='json', type=str)
parser.add_argument('email', location='json', type=str)
parser.add_argument('address', location='json', type=str)
@api.route('/demo')
class ProjectDemoView(Resource):
def put(self):
"""新增项目"""
print('PUT 请求参数', parser.parse_args())
return {"msg": "ok"}
PUT 请求参数示例
代码语言:javascript复制{"name": "yoyo"}
打印参数结果
代码语言:javascript复制POST 请求参数 {'name': 'yoyo', 'email': None, 'address': None}
如果直接拿这个校验后的数据去更新,会导致数据库已有的数据被更新为None了。
prepare_args_for_parser(parser) 函数
有时候不想要为未设置的参数设置默认None,仅仅是想更新传过来的参数。可以使用prepare_args_for_parser(parser) 函数中设置 store_missing=False
from flask_restful import Resource, reqparse
def prepare_args_for_parser(parser):
""" Modifies all the args of a Parser to better defaults. """
if not isinstance(parser, reqparse.RequestParser):
raise ValueError('Expecting a parser')
for arg in parser.args:
arg.store_missing = False
arg.help = "Error: {error_msg}. Field description: %s" % arg.help
return parser
parser = reqparse.RequestParser()
parser.add_argument('name', location='json', type=str)
parser.add_argument('email', location='json', type=str)
parser.add_argument('address', location='json', type=str)
parser = prepare_args_for_parser(parser) # 多加这一句
PUT 请求参数示例
代码语言:javascript复制{"name": "yoyo"}
打印参数结果
代码语言:javascript复制POST 请求参数 {'name': 'yoyo'}
于是可以看到,没传过来的参数被移除了。
参考文档https://github.com/flask-restful/flask-restful/issues/610
2022年第 12期《python接口web自动化 测试开发》课程,9月17号开学!
本期上课时间:2022年9月17号 - 2022年12月17号,周六周日上午9:00-11:00