Python v3.7.0 , flask_restful v0.3.7
基本参数
from flask_restful import reqparse
parser = reqparse.RequestParser()
parser.add_argument("method", help="[method] cannot be converted") # Python3中参数的默认类型为str
parser.add_argument("parameters", type=dict, help="[parameters] cannot be converted")
args = parser.parse_args()
如果指定了help 变量的值，那么在解析请求参数时，如果出现了类型错误，那么会将它渲染为错误信息；若未指定help的值，那么默认的行为是返回类型错误信息本身。如下所示：
help中的信息允许包含一个特殊的插入符号{error_msg}，它将会替换成类型错误的字符串表示。这种方式能够实现自定义错误消息，同时保留原始的错误消息。如下所示：
from flask_restplus import reqparse
parser = reqparse.RequestParser()
parser.add_argument(
'foo',
choices=('one', 'two'),
help='Bad choice: {error_msg}'
)
# 如果请求中的'foo'参数值为'three'，那么错误信息将会如下所示：
{
"message": {
"foo": "Bad choice: three is not a valid choice",
}
}
在默认情况下，参数不是必需的。并且，如果传入了RequestParser中未声明的参数，则这些参数将会被自动忽略，可以在调用parse_args时传入strict=True，以确保在请求中包含解析器没有定义的参数时抛出错误。
必须参数
若要确保某个参数必需提供，那么可以在调用add_argument()时传入required=True参数项。
parser.add_argument("method",required=True, help="[method] cannot be converted")
参数位置
默认情况下，RequestParser尝试从 flask.Request.values和 flask.Request.json 中解析值。
在 add_argument() 中使用location参数，来指定获取值的其他位置，可以使用 flask.Request 对象上的任何变量，例如：
# 仅在 POST body中查找
parser.add_argument("method", location="form")
# 仅在querystring中查找
parser.add_argument("PageSize", location="args")
# 从请求头中查找
parser.add_argument("User-Agent", location="headers")
# 从http cookies中查找
parser.add_argument("session_id", location="cookies")
# 从上传文件中查找
parser.add_argument("picture", type=werkzeug.datastructures.FileStorage, location="files")
Request是flask的请求对象，这个请求对象封装了从客户端发来的请求报文，我们能从其中获取请求报文中的所有数据。Request提供的常用属性和方法如下：
需要注意的是，和普通的字典类型不同，当从request对象的类型为MutliDict或ImmutableMultiDict的属性（比如files、form、args）中直接使用键作为索引获取数据时（比如request.args['name']），如果没有对应的键，那么会返回HTTP 400错误响应（Bad Request，表示请求无效），而不是抛出KeyError异常，为了避免这个错误，我们应该使用get（）方法获取数据，如果没有对应的值则返回None；get()方法的第二个参数可以设置默认值。
参数多位置
为location参数赋一个列表就能为参数指定多个位置：
parser.add_argument('text', location=['headers', 'values'])
当指定多个参数位置时，那么所有指定位置的参数将会组成一个MultiDict。其中，列表中最后位置处的参数将会优先存储在结果集中。
如果参数位置列表中包含headers位置，那么参数名将变成对大小写敏感，并且必须匹配它们的标题大小写名称（见str.title()）。
指定location='headers'（而不是作为列表的某个元素）将保留大小写不敏感的特性。
高级类型处理
有时，我们需要其他原始类型来处理输入验证问题。为此，inputs模块中提供了一些常用的类型处理方法，如下:
- boolean用于广泛的布尔值处理
- ipv4和ipv6用于IP地址
- date_from_iso8601和 datetime_from_iso8601则用于ISO8601 date和datetime处理
from flask_restful import inputs
...
parser.add_argument("flag", type=inputs.boolean, help="The expected field type is a Boolean type")
解析器继承
很多情况下，我们都需要为不同的资源指定不同的解析器。不过，如果这些不同的解析器之间存在大量相同的字段的话，将会存在大量重复编码的问题。为此，我们可以编写一个父解析器，父解析器中包含所有共同的参数，然后利用copy()方法来扩展解析器。另外，也可以利用replace_argument()来覆写父解析器中的任何参数，或者利用remove_argument()完全移除父解析器中的某个参数。例如：
from flask_restful import Resource, reqparse, inputs
# 父解析器
parser_root = reqparse.RequestParser()
parser_root.add_argument("author")
# 解析器继承
parser_index = parser_root.copy()
parser_index,add_argument("email") # 子解析器parser_index拥有author和email两个参数
parser_index.replace_argument('author', type=int, required=True, location='json')
# 此时，'author'参数变成了一个必需的int类型的参数，并且查找位置为json；而不再是父解析器中定义的str类型的可选参数
parser_index.remove_argument('author')
# 此时，parser_index中不再包含'author'参数
错误处理
RequestParser处理错误的默认方式是在第一个错误产生时中断。当我们拥有需要花费一定时间来处理的参数时，这种方式是有好处的。然而，通常来说，将所有产生的错误都绑定在一起，然后同时一次性返回给客户端，这种方式则更加友好。这种方式既可以在Flask应用级别指定，也可以在特定的RequestParser实例级别指定。为了调用一个包含错误绑定选项的RequestParser，需要传入参数bundle_errors。例如:
from flask_restplus import reqparse
parser = reqparse.RequestParser(bundle_errors=True)
parser.add_argument('foo', type=int, required=True)
parser.add_argument('bar', type=int, required=True)
# 如果某个请求中同时不包含'foo'和'bar'，那么返回的错误将看起来如下所示：
{
"message": {
"foo": "foo error message",
"bar": "bar error message"
}
}
# 默认操作将仅仅返回第一个错误
parser = RequestParser()
parser.add_argument('foo', type=int, required=True)
parser.add_argument('bar', type=int, required=True)
{
"message": {
"foo": "foo error message"
}
}
应用级别的配置key为“BUNDLE_ERRORS”。例如：
from flask import Flask
app = Flask(__name__)
app.config['BUNDLE_ERRORS'] = True
警告：BUNDLE_ERRORS是一个全局设置，它将覆盖每个RequestParser实例中的bundle_errors选项值。
除上面介绍的内容之外，add_argument 还支持以下可选参数：
- default：默认值，如果这个参数没有值，那么将使用这个参数指定的值。
- choices：选项。提交上来的值只有满足这个选项中的值才符合验证通过，否则验证不通过。
- trim：是否要去掉前后的空格。
其中的type，可以使用python自带的一些数据类型，也可以使用flask_restful.inputs下的一些特定的数据类型来强制转换。比如一些常用的：
- url：会判断这个参数的值是否是一个url，如果不是，那么就会抛出异常。
- regex：正则表达式。
- date：将这个字符串转换为datetime.date数据类型。如果转换不成功，则会抛出一个异常
原文地址：https://www.cnblogs.com/leejack/p/9164208.html ， HackHan
网友评论