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丿丶黑羽'

这里的 user 是 User 的一个实例。对象的初始化会执行所有解析和验证,如果没有引发 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

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

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

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/165704.html原文链接:https://javaforall.net

赞 (0)
全栈程序员-站长的头像全栈程序员-站长


相关推荐

  • 一文读懂C++虚函数的内存模型[通俗易懂]

    一文读懂C++虚函数的内存模型[通俗易懂]一文彻底读懂C++虚函数表的实现机制(使用GDB内存布局)1、虚函数简介2、虚函数表简介3、有继承关系的虚函数表剖析3.1、单继承无虚函数覆盖的情况3.2、单继承有虚函数覆盖的情况3.3、多重继承的情况3.4、多层继承的情况4、总结1、虚函数简介C++中有两种方式实现多态,即重载和覆盖。重载:是指允许存在多个同名函数,而这些函数的参数表不同(参数个数不同、参数类型不同或者两者都不同)。覆盖:是指子类重新定义父类的虚函数的做法,简而言之就是用父类型别的指针指向其子类的实例,然后通过父类的指针调用实际

    2022年7月26日
  • mirna预测靶基因结果怎么看_基因预测

    mirna预测靶基因结果怎么看_基因预测上一篇《动物miRNA靶基因预测方法(一)——软件安装》介绍了4种靶基因预测软件的下载与安装,本篇则介绍每个软件的使用说明。事实上,软件的使用是很简单的,只要准备好miRNA和mRNA的序列数据,运行一两条命令就可获得预测结果,难就难在数据的准备,往往你的数据并符合软件运行的格式,所以这里会更多的介绍如何获得各软件的数据格式。1、miRanda的使用阅读说明文档README这里提取一…

    2022年10月26日
  • 刚刚弄的51cto 谢谢我的兄弟

    刚刚弄的51cto 谢谢我的兄弟

    2021年8月11日
  • navicat 15 激活码【中文破解版】

    (navicat 15 激活码)JetBrains旗下有多款编译器工具(如:IntelliJ、WebStorm、PyCharm等)在各编程领域几乎都占据了垄断地位。建立在开源IntelliJ平台之上,过去15年以来,JetBrains一直在不断发展和完善这个平台。这个平台可以针对您的开发工作流进行微调并且能够提供…

    2022年3月26日
  • Hibernate二级缓存以及ehcache的搭建配置「建议收藏」

    Hibernate二级缓存以及ehcache的搭建配置「建议收藏」Session级别的以及缓存总是有效的,当应用保持持久化实体、修改持久化实体时,Session并不会吧这种改变flush到数据库,而是缓存在当前Session的一级缓存中,除非程序显示调用session的flush方法,或者查询关闭session时,才会把这先改变一次性的flush到底层数据库,这样可以减少与数据库的交互,从而提高数据库的访问性能。SessionFactory级别的二级缓存是全局的,应用的所有的Seeion都共享这个二级缓存,当Session需要抓取数据时,Session就会优

    2022年5月10日
  • 卸载Symantec Endpoint Protection, 无需密码的卸载方法

    卸载Symantec Endpoint Protection, 无需密码的卸载方法最近一次偶然的机会,被人装了个Symantec在电脑上,搞得各种报警,验证,烦死.然后就自然而然的想卸载掉这个该死的杀毒软件,没想到这个杀毒软件居然还是个流氓杀毒软件,卸

    2022年5月30日

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

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