开发者

Python 中的Schema数据结构及类型校验详解

开发者 https://www.devze.com 2023-11-23 09:18 出处：网络 作者： jruing
目录AndOrConstOptionalUseRegexForbidden使用 schema 库来执行数据结构的校验。schema 是一个简单而强大的库，用于定义和验证 python 数据结构的约束
相关专题：Python SchemaPython Schema数据结构Python Schema类型校验
目录
  • And
  • Or
  • Const
  • Optional
  • Use
  • Regex
  • Forbidden

使用 schema 库来执行数据结构的校验。schema 是一个简单而强大的库，用于定义和验证 python 数据结构的约束

And

And 代表必选，数据结构里必须包含这个 schema，如下方声明了 name ，则代表这个name必须存在与字典中

from schema import Schema, And, SchemaError
user_schema = Schema([
    {
        "name": And(str)
    }
])
user_data_1 = [{
    "name": "jruing",
}]
user_data_2 = [{
    "name": 666,
}]
try:
    user_result_1 = user_schema.validate(user_data_1)
    print(f"数据校验user_result_1：{user_result_1}")
except SchemaError as e:
    print(f"数据校验异常user_result_1:{e}")
try:
    user_result_2 = user_schema.validate(user_data_2)
    print(f"数据校验user_result_2：{user_result_2}")
except SchemaError as e:
    print(f"数据校验异常user_result_2:{e}")
==========调用结果==========
数据校验user_result_1：[{'name': 'jruing'}]
数据校验异常user_result_2:Or({'name': And(<class 'str'>)}) did not validate {'name': 666}
Key 'name' error:gbGvZDFcTn
666 should be instance of 'str'

Or

Or 代表值的类型必须为某两个类型，比如int 或 float，tuple或list

from schema import Schema, And, SchemaError, Or
user_schema = Schema([
    {
        "name": And(str),
        "money": Or(int,float)
    }
])
user_data_1 = [{
    "name": "jruing",
    "money": 1000,
}]
user_data_2 = [{
    "name": "jruing",
    "money": 1000.1,
}]
user_data_3 = [{
    "name": "jruing",
    "money": "1000.1",
}]
try:
    user_result_1 = user_schema.validate(user_data_1)
    print(f"数据校验user_result_1：{user_result_1}")
except SchemaError as e:
    print(f"数据校验异常user_result_1:{e}")
try:
    user_result_2 = user_schema.validate(user_data_2)
    print(f"数据校验user_result_2：{user_result_2}")
except SchemaError as e:
    print(f"数据校验异常user_result_2:{e}")
try:
    user_result_3 = user_schema.validate(user_data_3)
    print(f"数据校验user_result_3：{user_result_3}")
except SchemaError as e:
    print(f"数据校验异常user_result_3:{e}")
==========调用结果==========
数据校验user_result_1：[{'name': 'jruing', 'money': 1000, 'addr': '中国', 'country': '中国', 'email': '123456@qq.com'}]
数据校验异常user_result_2:Or({'name': And(<class 'str'>), 'money': Or(<class 'int'>, <class 'float'>), Optional('addr'): And(<class 'str'>), Optional('email'): And(<class 'str'>, Regex('^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$', flags=re.IGNORECASE)), 'country': Const('中国')}) did not validate {'name': 'jruing', 'money': 1000.1, 'addr': '1111', 'country': '山西', 'email': '123456'}
Key 'country' error:
'中国' does not match '山西'

Const

Const 代表值必须为指定的某个常量，比如下面的 country必须为中国

import re
from schema import Schema, And, SchemaError, Or, Optional, Regex, Const
user_schema = Schema([
    {
        "name": And(str),
        "money": Or(int, float),
        Optional("addr"): And(str),
        Optional("email"): And(str, Regex(r'^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$', flags=re.I)),
        "country": Const("中国")
    }
])
user_data_1 = [{
    "name": "jruing",
    "money": 1000,
    "addr": "中国",
    "country": "中国",
    "email": "123456@qq.com"
}]
user_data_2 = [{
    "name": "jruing",
    "money": 1000.1,
    "addr": "1111",
    "country": "山西",
    "email": "123456"
}]
try:
    user_result_1 = user_schema.validate(user_data_1)
    print(f"数据校验user_result_1：{user_rjavascriptesult_1}")
except SchemaError as e:
    print(f"数据校验异常user_result_1:{e}")
try:
    user_result_2 = user_schema.validate(user_data_2)
    print(f"数据校验user_result_2：{user_result_2}")
except SchemaError as e:
    print(f"数据校验异常user_result_2:{e}")
==========调用结果==========
数据校验user_result_1：[{'name': 'jruing', 'money': 1000, 'addr': '中国', 'country': '中国', 'email': '123456@qq.com'}]
数据校验异常user_result_2:Or({'name': And(<class 'str'>), 'money': Or(<class 'int'>, <class 'float'>), Optional('addr'): And(<class 'str'>), Optional('email'): And(<class 'str'>, Regex('^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$', flags=re.IGNORECASE)), 'country': Const('中国')}) did not validate {'name': 'jruing', 'money': 1000.1, 'addr': '1111', 'country': '山西', 'email': '123456'}
Key 'country' error:
'中国' does not match '山西'

Optional

Optional 代表这个key或者元素为非必选，可有可无

from schema import Schema, And, SchemaError, Or, Optional
user_schema = Schema([
    {
        "name": And(str),
        "money": Or(int, float),
        Optional("addr"): And(str)
    }
])
user_data_1 = [{
    "name": "jruing",
    "money": 1000,
    "addr": "中国"
}]
user_data_2 = [{
    "name": "jruing",
    "money": 1000.1,
}]
try:
    user_result_1 = user_schema.validate(user_data_1)
    print(f"数据校验user_result_1：{user_result_1}")
except SchemaError as e:
    print(f"数据校验异常user_result_1:{e}")
try:
    user_result_2 = user_schema.validate(user_data_2)
    print(f"数据校验user_result_2：{user_result_2}")
except SchemaError as e:
    print(f"数据校验异常user_result_2:{e}")
==========调用结果==========
数据校验user_result_1：[{'name': 'jruing', 'money': 1000, 'addr': '中国'}]
数据校验user_result_2：[{'name': 'jruing', 'money': 1000.1}]

Use

Use 函数允许你在验证前对数据进行转换。这对于在验证之前对数据进行清理、格式化或其他操作非常有用。

import re
from schema import Schema, And, SchemaError, Or, Optional, Regex, Const, Use
user_schema = Schema([
    {
        "name": And(str),
        "money": Or(int, float),
        "age": Use(int),
        Optional("addr"): And(str),
        Optional("email"): And(str, Regex(r'^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$', flags=re.I)),
        Optional("country"): Const("中国")
    }
])
user_data_1 = [{
    "name": "jruing",
    "money": 1000,
    "age": 11,
    "addr": "中国",
    "country": "中国",
    "email": "123456@qq.com"
}]
user_data_2 = [{
    "name": "jruing",
    "money": 1000.1,
    "age": "18",
    "addr": "1111",
    "email": "123456@qq.com"
}]
user_data_3 = [{
    "name": "jruing",
    "money": 1000.1,
    "age": "fff",
    "addr": "1111",
    "email": "123456@qq.com"
}]
try:
    user_result_1 = user_schema.validate(user_data_1)
    print(f"数据校验user_result_1：{user_result_1}")
except SchemaError as e:
    print(f"数据校验异常user_result_1:{e}")
try:
    user_result_2 = user_schema.validate(user_data_2)
    print(f"数据校验user_result_2：{user_result_2}")
except SchemaError as e:
    print(f"数据校验异常user_result_2:{e}")
try:
    user_result_3 = user_schema.validate(user_data_3)
    print(f"数据校验user_result_3：{user_result_3}")
except SchemaError as e:
    print(f"数据校验异常user_result_3:{e}")
==========调用结果==========
数据校验user_result_1：[{'name': 'jruing', 'money': 1000, 'age': 11, 'addr': '中国', 'country': '中国', 'email': '123456@qq.com'}]
数据校验user_result_2：[{'name': 'jruing', 'money': 1000.1, 'age': 18, 'addr': '1111', 'email': '123456@qq.com'}]
数据校验异常user_result_3:Or({'name': And(<class 'str'>), 'money': Or(<class 'int'>, <class 'float'>), 'age': Use(<class 'int'>), Optional('addr'): And(<class 'str'>), Optional('email'): And(<class 'str'>, Regex('^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$', flags=re.IGNORECASE)), Optional('country'): Const('中国')}) did not validate {'name': 'jruing', 'money': 1000.1, 'age': 'fff', 'addr': '1111', 'email': '123456@qq.com'}
Key 'age' error:
int('fff') raised ValueError("invalid literal for int() with base 10: 'fff'")

Regex

通过正则表达式，对值进行匹配校验，常用的就是邮箱，手机号等场景

import re
from schema import Schema, And, SchemaError, Or, Optional, Regex
user_schema = Schema([
    {
        "name": And(str),
        "money": Or(int, float),
        Optional("addr"): And(str),
        Optional("email"): And(str, Regex(r'^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$', flags=re.I))
    }
])
user_data_1 = [{
    "name": "jruing",
    "money": 1000,
    "addr": "中国",
    "email": "123456@qq.com"
}]
user_data_2 = [{
    "name": "jruing",
    "money": 1000.1,
    "addr": "1111",
    "email": "123456"
}]
try:
    user_result_1 = user_schema.validate(user_data_1)
    print(f"数据校验user_result_1：{user_result_1}")
except SchemaError as e:
    print(f"数据校验异常user_result_1:{e}")
t编程客栈ry:
    user_result_2 = user_schema.validate(user_data_2)
    print(f"数据校验user_result_2：{user_result_2}")
except SchemaError as e:
    print(f"数据校验异常user_result_2:{e}")
==========调用结果==========
数据校验user_result_1：[{'name': 'jruing', 'money': 1000, 'addr': '中国', 'email': '123456@qq.com'}]
数据校验异常user_result_2:Or({'name': And(<class 'str'>), 'money': Or(<class 'int'>, <class 'float'>), Optional('addr'): And(<class 'str'>), Optional('email'): And(<class 'str'>, Regex('^[a-zA-Z0-9_http://www.devze.com.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$', flags=re.IGNORECASE))}) did not validate {'name': 'jruing', 'money': 1000.1, 'addr': '1111', 'email': '123456'}
Key 'email' error:
Regex('^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$', flags=re.IGNORECASE) does not match '123456'

Forbidden

Forbidder 允许你定义一些不被允许的值，如果数据中包含这些值，验证将失败，下面的例子表示密码 password字段的值不允许设置为123456

import re
from schema import Schema, And, SchemaError, Or, Optional, Regex, Const, Use, Forbidden
user_schema = Schema([
    {
        "name": And(str),
        "money": Or(int, float),
        "age": Use(int),
        Optional("addr"): And(str),
        Optional("email"): And(str, Regex(r'^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$', flags=re.I)),
        Optional("country"): Const("中国"),
        "password": And(str, Forbidden("123456"))
    }
])
user_data_1 = [{
    "name": "jruing",
    "money": 1000,
    "age": 11,
    "addr": "中国",
    "country": "中国",
    "email": "123456@qq.com",
    "password": "123456"
}]
user_data_2 = [{
    "name": "jruing",
    "money": 1000.1,
    "age": "18",
    "addr": "1111",
    "email": "123456@qq.com",
    "password": "1234561"
}]
try:
    user_result_1 = user_schema.validate(user_data_1)
    print(f"数据校验user_result_1：{user_result_1}")
except SchemaError as e:
    print(f"数据校验异常user_result_1:{e}")
try:
    user_result_2 = user_schema.validate(user_data_2)
    print(f"数据校验user_result_2：{user_result_2}")
except SchemaError as e:
    print(f"数据校验异常user_result_2:{e}")
==========调用结果==========    
数据校验user_result_1：[{'name': 'jruing', 'money': 1000, 'age': 11, 'addr': '中国', 'country': '中国', 'egbGvZDFcTnmail': '123456@qq.com', 'password': '123456'}]
数据校验异常user_result_2:Or({'name': And(<class 'str'>), 'money': Or(<class 'int'>, <class 'float'>), 'age': Use(<class 'int'>), Optional('addr'): And(<class 'str'>), Optional('email'): And(<class 'str'>, Regex('^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$', flags=re.IGNORECASE)), Optional('country'): Const('中国'), 'password': And(<class 'str'>, Forbidden('123456'))}) did not validate {'name': 'jruing', 'money': 1000.1, 'age': '18', 'addr': '1111', 'email': '123456@qq.com', 'password': '1234561'}
Key 'password' error:
'123456' does not match '1234561'

到此这篇关于Python 中的Schema数据结构及类型校验的文章就介绍到这了,更多相关Python Schema数据结构内容请搜索编程客栈(www.devze.com)以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程客栈(www.devze.com)！

0

上一篇:

:下一篇

更多 开发 相关资讯：

精彩评论

暂无评论...
登录 注册
Qedev.com
验证码 换一张
取 消

关注公众号

热门标签

图文推荐

SpringBoot整合Liquibase实现对数据库管理和迁移

SpringBoot整合Liquibase实现对数据库管理和迁移
javacv ffmpeg使用原生ffmpeg命令方式

javacv ffmpeg使用原生ffmpeg命令方式
Linux管道揭秘之匿名管道连接进程世界的方法

Linux管道揭秘之匿名管道连接进程世界的方法
SpringBoot配置文件启动加载顺序的方法步骤

SpringBoot配置文件启动加载顺序的方法步骤
SpringBoot前后端传输加密设计实现方案

SpringBoot前后端传输加密设计实现方案
SpringBoot参数校验的一些实战应用

SpringBoot参数校验的一些实战应用
Springboot3集成Knife4j的步骤以及使用(最完整版)

Springboot3集成Knife4j的步骤以及使用(最完整版)
SpringBoot中的@Configuration、@MapperScan注解

SpringBoot中的@Configuration、@MapperScan注解

开发者开发者网给大家分享系统运维,大数据运维,云计算,编程开发技巧,路由交换,运维和开发相关的资讯及技术文章，同时StackOverflow中文社区，知识经验交流分享。

法律声明：本站内容均为网友上传，网站举办方负责审核和监督，如存在版权或非法内容，欢迎举报，我们将尽快予以删除。邮箱：devze@qq.com

Copyright © 2018-2020 开发者. All rights reserved. Powered by 开发者ICP备案号: 京ICP备10032868号-9