python进阶(22)pydantic–数据类型校验

python进阶(22)pydantic–数据类型校验pydantic库的作用pydantic库是一种常用的用于数据接口schema定义与检查的库。Pydantic在运行时强制执行类型提示,并在数据无效时提供用户友好的错误信息。pydantic安

大家好,又见面了,我是你们的朋友全栈君。如果您正在找激活码,请点击查看最新教程,关注关注公众号 “全栈程序员社区” 获取激活教程,可能之前旧版本教程已经失效.最新Idea2022.1教程亲测有效,一键激活。

Jetbrains全系列IDE使用 1年只要46元 售后保障 童叟无欺

pydantic库的作用

  • pydantic库是一种常用的用于数据接口schema定义与检查的库。
  • Pydantic 在运行时强制执行类型提示,并在数据无效时提供用户友好的错误信息。
     

pydantic安装

pip install pydantic

 

用法详解

 

模型

  • pydantic中定义对象的主要方法是通过模型(模型是继承自 BaseModel 的类)。
  • 将模型看作严格类型语言中的类型(例如Java),或者看作API中单个端点的需求。
  • 不受信任的数据可以传递给模型,在解析和验证之后,pydantic保证结果模型实例的字段将符合模型上定义的字段类型。

注意事项

  • pydantic是一个解析库,而不是一个验证库。
  • 验证是达到目的的一种手段:构建符合所提供的类型和约束的模型。
  • 换句话说,pydantic保证输出模型的类型和约束,而不是输入数据。
     

基础模型使用

from pydantic import BaseModel


class User(BaseModel):
    id: int
    name = "Silent丿丶黑羽"
  • User这是一个有两个字段的模型
  • id是一个整型,必填项
  • name是一个有默认值的字符串,不是必填项

为什么name字段不需要声明类型

  • name 的类型是从其默认值推断来的,因此,类型注解不是必需的
  • 有些字段没有指定类型,可能会引发字段顺序的警告
user = User(id="123")
print(type(user))  # <class '__main__.User'>
print(user)  # id=123 name='Silent丿丶黑羽'

这里的 userUser 的一个实例。对象的初始化会执行所有解析和验证,如果没有引发 ValidationError 异常,则表明结果模型实例是有效的。

这里我们传入了的id是一个字符串,但实际打印出来却是整型,是因为pydantic在数据传输时会直接进行数据转换
 

模型属性

模型有多个属性和方法,我们依次介绍
 

dict()

返回模型的字段和值的字典

user = User(id=123)
print(user.dict())  # {'id': 123, 'name': 'jkc'}
print(type(user.dict()))  # <class 'dict'>

 

json()

返回表示 dict()JSON 字符串

user = User(id=123)
print(user.json())  # {"id": 123, "name": "jkc"}
print(type(user.json()))  # <class 'str'>

 

copy()

返回模型的拷贝,默认是浅拷贝

user = User(id=123)
print(user.copy())  # id=123 name='jkc'

 

parse_obj()

这与模型的_init__方法非常相似,只是它采用dict而不是关键字参数。如果传递的对象不是dict,将引发ValidationError

user = User(id=123)
print(user.parse_obj({"id": 3, "name": "jkc"}))  # id=3 name='jkc'
print(user.parse_obj(['a']))  # 引发ValidationError错误

parse_raw()

用于加载多种格式字符串的实用程序

user = User(id=123)
print(user.parse_raw('{"id": 3, "name": "jkc"}'))  # id=3 name='jkc'

 

parse_file()

parse_raw() 类似,但是是接收文件路径,读取文件并将内容传递给parse_raw

path = Path('data.json')
path.write_text('{"id": 123, "name": "James"}')
m = User.parse_file(path)
print(m)  # id=123 signup_ts=None name='James'

 

schema()

返回以 JSON Schema 形式返回模型,以字典格式

user = User(id=123, name="jkc")
print(user.schema())
print(type(user.schema()))

# 输出结果
{
    "title":"User",
    "type":"object",
    "properties":{
        "id":{
            "title":"Id",
            "type":"integer"
        },
        "name":{
            "title":"Name",
            "default":"jkc",
            "type":"string"
        }
    },
    "required":[
        "id"
    ]
}

<class 'dict'>

 

schema_json()

返回以 JSON Schema 形式返回模型,以JSON字符串形式

user = User(id=123, name="jkc")
print(user.schema_json())
print(type(user.schema_json()))

# 输出结果
{
    "title":"User",
    "type":"object",
    "properties":{
        "id":{
            "title":"Id",
            "type":"integer"
        },
        "name":{
            "title":"Name",
            "default":"jkc",
            "type":"string"
        }
    },
    "required":[
        "id"
    ]
}

<class 'str'>

 

fields_set

返回用户初始化对象时提供了什么字段

user = User(id=123)
print(user.__fields_set__)  # {'id'}

user = User(id=123, name="jkc")
print(user.__fields_set__)  # {'name', 'id'}

 

config

模型的配置类(后续更新)

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

发布者:全栈程序员-用户IM,转载请注明出处:https://javaforall.cn/165358.html原文链接:https://javaforall.cn

【正版授权,激活自己账号】: Jetbrains全家桶Ide使用,1年售后保障,每天仅需1毛

【官方授权 正版激活】: 官方授权 正版激活 支持Jetbrains家族下所有IDE 使用个人JB账号...

(0)


相关推荐

  • centos7 输入 ifconfig 不显示 ip 地址 连接不上的解决方法(亲测成功)「建议收藏」

    centos7 输入 ifconfig 不显示 ip 地址 连接不上的解决方法(亲测成功)「建议收藏」最近又把自己的虚拟机打开了玩玩集群,遇到一个小问题,我发现虚拟机的内存不够了,就把虚拟机关机加大了内存,谁知道开机后,ifconfig或者ipaddr显示没有ip地址,只显示一个lo,没有ens33,没有ip地址就没法用xshell连接,很蛋疼,网上也有很多解决方案,但都写的乱七八糟的,而且很多都不好使,今天就来介绍一下我最后解决的方法.我说一下我的虚拟机的情况,我三台虚拟机,之前是mas………

    2022年10月23日
  • docker stats详解_docker socket

    docker stats详解_docker socketOS:Centos    1.安装编译时所需文件       yuminstallbisongccgcc-c++autoconfautomakezlib*libxml*ncurses-devellibtool-ltdl-devel*    2.安装Cmake       wgethttp://www.cmake.org/fi

  • SqlTransaction.Dispose,RollBack ?「建议收藏」

    SqlTransaction.Dispose,RollBack ?「建议收藏」一个体会记在此:SqlTransaction.Dispose 如果之前没有提交事务,譔方法就会调用RollBack(Willrollbackifnotcommited)。之前写的代码:using(SqlConnectionconn=dbo.CreateCo

  • 电脑上怎么看用户名和密码_电脑超级用户名和密码

    电脑上怎么看用户名和密码_电脑超级用户名和密码大家好,我是时间财富网智能客服时间君,上述问题将由我为大家进行解答。以windows7为例,电脑的用户名和密码的查看方法是:1、找到“我的电脑”或计算机;2、单击鼠标右键,打开“管理”;3、点击“本地用户和组”;4、选择用户,单击打开;5、查看用户及密码,也可以开机启动Windows,当运行到“正在启动WindowsXP”的提示界面时,按“F8”键调出系统启动选择菜单,选择“带命令行安全模式”;…

    2022年10月11日
  • JMeter参数化4种实现方式「建议收藏」

    JMeter参数化4种实现方式「建议收藏」前言下面是目前JMeter系列已有博文列表,持续更新中:JMeter安装与接口测试入门JMeter接口测试之断言实现JMeter逻辑控制器JMeter配置元件JMeter操作Mysql数据库BeanShellSampler与BeanShell断言JMeterLinux下执行测试JMeter自定义日志与日志分析1参数化释义什么是参数化?从字面上去理解的话,就是事先准备好数据(广义上来说,可以是具体的数据值,也可以是数据生成规则),而非在脚本中写死,脚本执行时从准备好的数据中

  • hdu2058_upa68ha

    hdu2058_upa68ha主要是对于等差数列求和公式进行变换,dfs果断超时了;下面这个有比较详细的解释;(https://blog.csdn.net/qq_32767041/article/details/53457796)

发表回复

您的电子邮箱地址不会被公开。

关注全栈程序员社区公众号