Python webargs 模块的简单使用

Python webargs 模块是一个用于验证和从请求中提取参数的工具包。它有助于在开发 Web 应用时处理复杂的查询参数，并提供了一个简单的解决方案来处理数据验证和转换。

安装

webargs 可以通过 pip 安装：

pip install webargs

基本用法

1. 引入 webargs：

from webargs import fields
from webargs import validate
from webargs.flaskparser import use_args

1. 创建参数 schema：

user_schema = {
    'name': fields.Str(required=True),
    'email': fields.Email(required=True),
}

上述 schema 定义了两个参数：name 和 email，并且两个参数都为必填项。

具体参数值类型和参数验证函数可以在 fields 和 validate 中找到更多选项。

1. 在视图函数中使用参数 schema：

@app.route('/create_user', methods=['POST'])
@use_args(user_schema)
def create_user(args):
    # 创建用户逻辑
    return jsonify({'user': args})

上述视图函数使用了 use_args 装饰器，会根据 user_schema 中定义的参数进行数据提取和验证，提取出来的参数会作为 create_user 的参数传递。如果提取和验证成功，就可以进行后续的业务逻辑处理。

示例说明

下面是两个示例，用于演示 webargs 的使用方法。

示例一

场景：用户注册。

参数：

• 用户名（String）
• 邮箱（Email，且不为空）
• 密码（String，且长度大于等于6）

视图函数：

from flask import Flask, jsonify
from webargs import fields, validate
from webargs.flaskparser import use_args

app = Flask(__name__)

user_schema = {
    'username': fields.Str(required=True),
    'email': fields.Email(required=True),
    'password': fields.Str(required=True, validate=validate.Length(min=6)),
}

@app.route('/register', methods=['POST'])
@use_args(user_schema)
def register(args):
    return jsonify({'msg': '注册成功！', 'user': args})

if __name__ == '__main__':
    app.run()

在上述代码中，我们定义了一个 user_schema，包含了注册用户需要提供的参数。其中，username、email 和 password 都是必填参数，email 的类型必须是 email，password 的长度必须大于等于 6。

在 register 视图函数中，使用了 use_args 装饰器，它会自动根据 user_schema 中定义的参数来提取参数，并且验证参数是否合法。

示例二

场景：矩形的面积计算。

参数：

• 长（Float，且大于0）
• 宽（Float，且大于0）

视图函数：

from flask import Flask, jsonify
from webargs import fields, validate
from webargs.flaskparser import use_kwargs

app = Flask(__name__)

rect_schema = {
    'length': fields.Float(required=True, validate=validate.Range(min=0.0)),
    'width': fields.Float(required=True, validate=validate.Range(min=0.0)),
}

@app.route('/rectangle', methods=['GET'])
@use_kwargs(rect_schema)
def rectangle_area(length, width):
    return jsonify({'area': length * width})

if __name__ == '__main__':
    app.run()

在上述代码中，我们定义了一个 rect_schema，包含了计算矩形面积需要提供的参数。其中，length 和 width 都是必填参数，并且值必须大于 0。

在 rectangle_area 视图函数中，使用了 use_kwargs 装饰器，它会根据 rect_schema 中定义的参数提取参数，并赋值给函数定义的 length 和 width 参数。在此函数中，使用这两个参数计算出矩形面积。最后，返回 area 字段和计算出来的面积值。