Python3:数据校验机制

在日常编码环节,很大比例的错误处理工作和参数的输入有关。当程序里的某些数据直接来自用户输入时,必须先校验这些输入值,再进行之后的处理,否则就会出现难以预料的错误。

需求:

写一个命令行小程序,它要求用户输入一个 0~100 范围的数字。假如用户输入的内容无效,就要求其重新输入。

常规方案:

示例代码如下:

def input_a_number():
    """要求用户输入一个 0~100 的数字,如果无效则重新输入"""
    while True:
        number = input('Please input a number (0-100): ')
        
        if not number:
            print('Input can not be empty!')
            continue
        if not number.isdigit():
            print('Your input is not a valid number!')
            continue
        if not (0 <= int(number) <= 100):
            print('Please input a number between 0 and 100!')
            continue

        number = int(number)
        break

    print(f'Your number is {number}')

测试结果:

Please input a number (0-100):
Input can not be empty!
Please input a number (0-100): hello
Your input is not a valid number!
Please input a number (0-100): 80
Your number is 80

这个虽然可以满足我们的需求,但是如果需要校验的输入有很多,那这个检验逻辑就会很复杂冗余。

使用pydantic专业数据校验模块:

来看下ChatGPT的介绍:

Pydantic 是一个 Python 的数据验证库,它可以让你定义数据模型并自动验证输入数据的类型和结构。它的主要目标是使数据验证变得简单、快速和可靠。

以下是 Pydantic 的一些主要功能和优点:

  1. 声明式模型定义:使用 Pydantic,你可以通过简单的 Python 类来定义数据模型。这些类使用类型提示来定义字段的类型,并且支持各种 Python 原生类型、自定义类以及第三方库的类型。

  2. 自动验证:定义好数据模型后,Pydantic 将自动验证输入数据的类型和结构是否符合模型的要求。如果数据不符合模型定义,Pydantic 将会引发验证错误。

  3. 数据解析:Pydantic 提供了方便的方法来解析原始数据(如 JSON、字典等)并将其转换为定义的数据模型实例。

  4. 序列化输出:除了解析输入数据,Pydantic 还可以将数据模型实例序列化为 JSON 字符串或字典等格式,以便于输出或传输。

  5. 数据转换:Pydantic 允许你定义字段的转换函数,以在数据验证或解析过程中对字段进行转换或预处理。

  6. 内置验证器:Pydantic 提供了许多内置的验证器,如 EmailValidatorLengthValidator 等,用于验证字段的特定属性。

  7. 与 FastAPI 集成:Pydantic 与 FastAPI 框架深度集成,可以直接将 Pydantic 模型用作 FastAPI 路径操作的请求和响应模型。

总的来说,Pydantic 是一个功能强大且易于使用的数据验证库,特别适用于构建需要处理大量数据输入和输出的 Python 应用程序,如 Web 服务、API 和数据处理工具。

上面的需求,重新实现一次: 

from pydantic import BaseModel, conint, ValidationError
class NumberInput(BaseModel):
    # 使用类型注解 conint 定义 number 属性的取值范围
    number: conint(ge=0, le=100)


def input_a_number_with_pydantic():
    while True:
        number = input('Please input a number (0-100): ')

        # 实例化为 pydantic 模型,捕获校验错误异常
        try:
            number_input = NumberInput(number=number)
        except ValidationError as e:
            print(e)
            continue

        number = number_input.number
        break

    print(f'Your number is {number}')

其它场景:

在编写代码时,应当尽量避免手动校验任何数据(一般搜下都会有专门的模块)。因为数据校验任务独立性很强,所以应该引入合适的第三方校验模块(或者自己实现),让它们来处理这部分专业工作。

比如你在开发 Web 应用,数据校验工作通常来说比较容易。比如 Django 框架就有自己的表单验证模块,Flask 也可以使用 WTForms 模块来进行数据校验。

WTForms模块介绍:

WTForms 是一个 Python 的 Web 表单验证和渲染库,用于处理 Web 应用程序中的表单。它提供了一个简单而灵活的方式来定义表单,验证用户输入并生成 HTML 表单字段。

一个简单而灵活的方式来定义表单,验证用户输入并生成 HTML 表单字段。

以下是 WTForms 的一些主要特点和优点:

  1. 简单易用:WTForms 提供了一个简洁的 API,使得定义和处理表单变得简单和直观。

  2. 表单验证:WTForms 允许你定义表单字段以及它们的验证规则,例如必填、长度限制、数据类型等。当用户提交表单时,WTForms 会自动验证用户输入是否符合定义的规则,并返回相应的错误消息。

  3. CSRF 保护:WTForms 内置了 CSRF(Cross-Site Request Forgery)保护,可以帮助你防止 CSRF 攻击。

  4. 支持多种字段类型:WTForms 支持多种常见的 HTML 表单字段类型,如文本框、密码框、复选框、下拉框等,同时也支持自定义字段类型。

  5. 表单渲染:WTForms 可以根据表单定义自动生成 HTML 表单字段,简化了前端开发的工作。

  6. 与 Flask 和 Django 集成:WTForms 可以与 Flask 和 Django 等流行的 Web 框架无缝集成,方便在这些框架中使用。

下面是一个简单的示例,演示如何使用 WTForms 在 Flask 中创建一个简单的登录表单:

from flask import Flask, render_template, request
from wtforms import Form, StringField, PasswordField, validators

# 创建 Flask 应用程序
app = Flask(__name__)

# 定义登录表单
class LoginForm(Form):
    username = StringField('Username', [validators.Length(min=4, max=25)])
    password = PasswordField('Password', [validators.DataRequired()])

# 定义登录路由
@app.route('/login', methods=['GET', 'POST'])
def login():
    # 创建登录表单实例
    form = LoginForm(request.form)
    # 检查表单是否已提交且通过验证
    if request.method == 'POST' and form.validate():
        # 获取表单中的用户名和密码
        username = form.username.data
        password = form.password.data
        # 在这里可以进行用户认证等操作
        return f'Welcome, {username}!'
    # 渲染登录页面并传入表单实例
    return render_template('login.html', form=form)

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

在上面的示例中,我们首先定义了一个名为 LoginForm 的表单类,其中包含了用户名和密码两个字段,并指定了它们的验证规则。然后,我们在登录路由中使用该表单类创建了表单实例,并在提交表单时进行了验证。如果表单验证通过,就可以获取用户名和密码并进行相应的处理。

当然,你需要在 Flask 应用程序的模板中创建一个 HTML 文件来渲染登录表单,但这超出了代码示例的范围。

相关推荐

  1. Python3数据校验机制

    2024-04-23 11:14:04       14 阅读
  2. vue3——登录校验

    2024-04-23 11:14:04       27 阅读
  3. SpringBoot数据校验

    2024-04-23 11:14:04       39 阅读
  4. Vue 数据校验

    2024-04-23 11:14:04       10 阅读
  5. Python3 数据结构

    2024-04-23 11:14:04       7 阅读

最近更新

  1. TCP协议是安全的吗?

    2024-04-23 11:14:04       16 阅读
  2. 阿里云服务器执行yum,一直下载docker-ce-stable失败

    2024-04-23 11:14:04       16 阅读
  3. 【Python教程】压缩PDF文件大小

    2024-04-23 11:14:04       15 阅读
  4. 通过文章id递归查询所有评论(xml)

    2024-04-23 11:14:04       18 阅读

热门阅读

  1. Leetcode 20:有效的括号

    2024-04-23 11:14:04       14 阅读
  2. MySQL数据库创建用户并授权查询某个表

    2024-04-23 11:14:04       15 阅读
  3. selenium上传文件时打开指定本地文件路径

    2024-04-23 11:14:04       15 阅读
  4. python使用selenium如何切换ifrem

    2024-04-23 11:14:04       15 阅读
  5. 重庆思庄技术分享——Bug 12861117 RMAN 会话旋转

    2024-04-23 11:14:04       14 阅读
  6. 【设计模式】9、facade 外观模式

    2024-04-23 11:14:04       12 阅读
  7. 设计模式|原型模式(Prototype Pattern)

    2024-04-23 11:14:04       14 阅读
  8. Unity 帧同步游戏解决方案梳理

    2024-04-23 11:14:04       14 阅读
  9. Qt Android 无法加载 assets 目录下 lua 校准脚本

    2024-04-23 11:14:04       15 阅读
  10. 火绒安全的用法

    2024-04-23 11:14:04       12 阅读
  11. 火绒安全的用法

    2024-04-23 11:14:04       12 阅读