Pydantic中BaseConfig的具体使用

最新推荐文章于 2024-08-24 08:00:00 发布
最新推荐文章于 2024-08-24 08:00:00 发布
阅读量30 收藏
点赞数
文章标签： python 前端 java
原文链接：https://blog.csdn.net/jixiaoyu0209/article/details/139610483
版权

本文主要介绍了Pydantic中BaseConfig的具体使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
Python客栈送红包、纸质书

概述
Pydantic是一个用于数据验证和设置管理的Python库。它可以通过类型注解来自动生成验证和解析逻辑。BaseConfig是Pydantic模型配置的基类，允许用户定制模型的行为和验证规则。

官方文档链接
Pydantic官方文档 - BaseConfig

基础功能

基本配置
BaseConfig提供了许多选项来配置Pydantic模型的行为。下面是一些常用的配置选项：

title: 给模型一个标题。
anystr_strip_whitespace: 自动去除字符串前后的空白。
min_anystr_length: 字符串的最小长度。
max_anystr_length: 字符串的最大长度。
validate_assignment: 在模型实例创建后进行属性分配时验证。

示例代码

from pydantic import BaseModel
 
class User(BaseModel):
    name: str
    age: int
     
    class Config:
        title = "User Model"
        anystr_strip_whitespace = True
        min_anystr_length = 2
        max_anystr_length = 50
        validate_assignment = True
 
# 创建模型实例
user = User(name=" John Doe ", age=30)
print(user.name)  # 输出: "John Doe"

在这个例子中，User模型去除了name字段的前后空白，并设置了字符串的最小和最大长度。

进阶功能

自定义验证器
可以在配置类中定义自定义验证器来增加验证逻辑。

from pydantic import BaseModel, validator
 
class User(BaseModel):
    name: str
    age: int
     
    class Config:
        validate_assignment = True
 
    @validator('age')
    def age_must_be_positive(cls, value):
        if value <= 0:
            raise ValueError('Age must be a positive number')
        return value
 
# 创建模型实例
user = User(name="Jane Doe", age=25)
 
# 赋值时验证
user.age = 30  # 成功
user.age = -5  # 抛出 ValueError: Age must be a positive number

高级教程

配置继承
可以通过继承BaseConfig类创建一个通用的配置类，并在多个模型中复用。

from pydantic import BaseModel
 
class CommonConfig:
    anystr_strip_whitespace = True
    min_anystr_length = 2
    max_anystr_length = 50
 
class User(BaseModel):
    name: str
    age: int
     
    class Config(CommonConfig):
        title = "User Model"
 
class Product(BaseModel):
    name: str
    price: float
     
    class Config(CommonConfig):
        title = "Product Model"
 
# 创建模型实例
user = User(name=" John Doe ", age=30)
product = Product(name="  Laptop ", price=999.99)
 
print(user.name)  # 输出: "John Doe"
print(product.name)  # 输出: "Laptop"

通过这种方式，可以将公共配置集中管理，减少重复代码。

参数详解

  1. title

为模型指定一个标题。

from pydantic import BaseModel
 
class User(BaseModel):
    name: str
    age: int
     
    class Config:
        title = "User Model"
 
print(User.schema())  # 输出包含 "title": "User Model"
  1. anystr_lower

将所有字符串转换为小写。

class User(BaseModel):
    name: str
     
    class Config:
        anystr_lower = True
 
user = User(name="John Doe")
print(user.name)  # 输出: "john doe"
  1. anystr_strip_whitespace

去除字符串前后的空白。

class User(BaseModel):
    name: str
     
    class Config:
        anystr_strip_whitespace = True
 
user = User(name=" John Doe ")
print(user.name)  # 输出: "John Doe"
  1. min_anystr_length

字符串的最小长度。

class User(BaseModel):
    name: str
     
    class Config:
        min_anystr_length = 2
 
# user = User(name="A")  # 将抛出验证错误
user = User(name="Ab")
print(user.name)  # 输出: "Ab"
  1. max_anystr_length

字符串的最大长度。

class User(BaseModel):
    name: str
     
    class Config:
        max_anystr_length = 10
 
# user = User(name="John Doe Long Name")  # 将抛出验证错误
user = User(name="John Doe")
print(user.name)  # 输出: "John Doe"
  1. validate_all

验证所有字段，而不仅仅是提供的数据字段。

class User(BaseModel):
    name: str
    age: int
     
    class Config:
        validate_all = True
 
# user = User(name="John")  # 将抛出验证错误，因为缺少age字段
user = User(name="John", age=30)
print(user)  # 输出: name='John' age=30
  1. extra

决定在模型中是否允许额外的字段。选项有Extra.ignore, Extra.allow, Extra.forbid。

from pydantic import Extra
 
class User(BaseModel):
    name: str
     
    class Config:
        extra = Extra.forbid
 
# user = User(name="John", age=30)  # 将抛出验证错误，因为age是多余字段
user = User(name="John")
print(user)  # 输出: name='John'
  1. allow_mutation

是否允许修改模型实例的属性。

class User(BaseModel):
    name: str
     
    class Config:
        allow_mutation = False
 
user = User(name="John")
# user.name = "Doe"  # 将抛出验证错误，因为模型不可变
print(user.name)  # 输出: "John"
  1. frozen

如果为True，则模型实例将是不可变的（与allow_mutation相同）。

class User(BaseModel):
    name: str
     
    class Config:
        frozen = True
 
user = User(name="John")
# user.name = "Doe"  # 将抛出验证错误，因为模型是冻结的
print(user.name)  # 输出: "John"
  1. allow_population_by_field_name

是否允许通过字段名称填充数据，而不是别名。

class User(BaseModel):
    full_name: str
     
    class Config:
        allow_population_by_field_name = True
        fields = {
            'full_name': 'name'
        }
 
user = User(name="John Doe")
print(user.full_name)  # 输出: "John Doe"
  1. use_enum_values

使用枚举值而不是枚举实例。

from enum import Enum
 
class Color(Enum):
    RED = 'red'
    BLUE = 'blue'
 
class Car(BaseModel):
    color: Color
     
    class Config:
        use_enum_values = True
 
car = Car(color=Color.RED)
print(car.color)  # 输出: "red"
  1. fields

字段的配置信息，字典形式，键为字段名，值为别名或包含别名及其他配置信息的字典。

class User(BaseModel):
    name: str
     
    class Config:
        fields = {
            'name': {'alias': 'full_name'}
        }
 
user = User(full_name="John Doe")
print(user.name)  # 输出: "John Doe"
  1. validate_assignment

分配新值时验证字段。

class User(BaseModel):
    age: int
     
    class Config:
        validate_assignment = True
 
user = User(age=25)
user.age = 30
# user.age = -5  # 将抛出验证错误，因为age必须是正整数
print(user.age)  # 输出: 30
  1. error_msg_templates

自定义错误消息模板。

class User(BaseModel):
    age: int
     
    class Config:
        error_msg_templates = {
            'value_error': 'Invalid value provided.'
        }
 
# user = User(age=-5)  # 将抛出验证错误: Invalid value provided.
user = User(age=25)
print(user.age)  # 输出: 25
  1. arbitrary_types_allowed

允许使用任意类型。

class CustomType:
    pass
 
class User(BaseModel):
    custom: CustomType
     
    class Config:
        arbitrary_types_allowed = True
 
user = User(custom=CustomType())
print(user.custom)  # 输出: <__main__.CustomType object at 0x...>
  1. orm_mode

启用ORM支持，允许从ORM对象填充数据。

class UserOrm:
    def __init__(self, name):
        self.name = name
 
class User(BaseModel):
    name: str
     
    class Config:
        orm_mode = True
 
user_orm = UserOrm(name="John Doe")
user = User.from_orm(user_orm)
print(user.name)  # 输出: "John Doe"
  1. getter_dict

自定义getter字典类。

class CustomGetterDict(GetterDict):
    def get(self, item, default=None):
        return f'custom_{super().get(item, default)}'
 
class User(BaseModel):
    name: str
     
    class Config:
        getter_dict = CustomGetterDict
 
data = {'name': 'John Doe'}
user = User.parse_obj(data)
print(user.name)  # 输出: "custom_John Doe"
  1. alias_generator

别名生成器函数，用于自动生成字段别名。

class User(BaseModel):
    full_name: str
     
    class Config:
        alias_generator = lambda x: x.upper()
 
user = User(FULL_NAME="John Doe")
print(user.full_name)  # 输出: "John Doe"
  1. keep_untouched

保持未修改的类型元组。

class SomeType:
    pass
 
class User(BaseModel):
    some: SomeType
     
    class Config:
        keep_untouched = (SomeType,)
 
user = User(some=SomeType())
print(user.some)  # 输出: <__main__.SomeType object at 0x...>
  1. schema_extra

额外的JSON模式定义，可以是字典或返回字典的可调用对象。

class User(BaseModel):
    name: str
    age: int
     
    class Config:
        schema_extra = {
            "example": {
                "name": "John Doe",
                "age": 30
            }
        }
 
print(User.schema_json(indent=2))  # 输出包含 "example": {"name": "John Doe", "age": 30}
  1. json_loads

自定义JSON加载函数。

import json
 
def custom_json_loads(value):
    return json.loads(value)
 
class User(BaseModel):
    name: str
     
    class Config:
        json_loads = custom_json_loads
 
user = User.parse_raw('{"name": "John Doe"}')
print(user.name)  # 输出: "John Doe"
  1. json_dumps

自定义JSON序列化函数。

import json
 
def custom_json_dumps(value, **kwargs):
    return json.dumps(value, **kwargs)
 
class User(BaseModel):
    name: str
     
    class Config:
        json_dumps = custom_json_dumps
 
user = User(name="John Doe")
print(user.json())  # 输出: {"name": "John Doe"}
  1. json_encoders

自定义JSON编码器字典，键为类型或字符串，值为编码函数。

from datetime import datetime
 
class User(BaseModel):
    created_at: datetime
     
    class Config:
        json_encoders = {
            datetime: lambda v: v.isoformat()
        }
 
user = User(created_at=datetime(2020, 1, 1))
print(user.json())  # 输出: {"created_at": "2020-01-01T00:00:00"}
  1. underscore_attrs_are_private

以下划线开头的属性是否被视为私有。

class User(BaseModel):
    _private: str
     
    class Config:
        underscore_attrs_are_private = True
 
user = User(_private="secret")
print(user.dict())  # 输出: {}
  1. copy_on_model_validation

是否在模型验证时复制继承的模型。

class BaseModelWithConfig(BaseModel):
    class Config:
        copy_on_model_validation = True
 
class User(BaseModelWithConfig):
    name: str
 
user = User(name="John")
print(user.name)  # 输出: "John"
  1. smart_union

是否在尝试转换前检查所有允许的类型。

from typing import Union
 
class User(BaseModel):
    value: Union[int, str]
     
    class Config:
        smart_union = True
 
user = User(value="123")
print(user.value)  # 输出: "123"

希望这些示例代码能帮助你更好地理解Pydantic中BaseConfig类的各个参数及其用法。

总结
BaseConfig提供了强大的配置选项，使得Pydantic模型更加灵活和可定制。通过掌握这些配置选项，可以更加高效地进行数据验证和管理。

到此这篇关于Pydantic中BaseConfig的具体使用的文章就介绍到这了,更多相关Pydantic BaseConfig内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持vb.net教程C#教程python教程SQL教程access 2010教程xin3721自学网

Oona_01
关注
如何在不同版本的Pydantic中高效使用LangChain：从基础到高级的全面实践指南
m0_57781768的博客
08-24 45
LangChain是一个专为自然语言处理和生成任务设计的开放源代码工具链。它的核心目标是简化语言模型的开发、微调和部署过程。通过LangChain，开发者可以快速集成各种NLP模型，无需深入了解底层的实现细节。LangChain提供了模块化的设计，使得开发者可以通过组合不同的组件来构建复杂的应用，从而提高开发效率和代码的可维护性。模型集成：支持与主流语言模型（如OpenAI、Anthropic等）的无缝集成。工具和API：提供了丰富的API，帮助开发者处理从数据预处理到模型输出的整个流程。可扩展性。
java连接Hive
m0_49359581的博客
01-09 1742
java连接Hive一、BaseConfig类二、BaseDao类三、Result类 一、BaseConfig类 import java.io.FileReader; import java.sql.Connection; import java.sql.DriverManager; import java.sql.SQLException; import java.util.Properties; import java.util.regex.Matcher; import java.util.rege
Pydantic学习
xueyu188的博客
10-12 1132
Pydantic 是一个 Python 的数据验证和模型声明库，旨在建立正确使用对象化方法的简单，快速，和可扩展方式。它可以省去你把琐碎数据验证任务，保证你的数据总是整洁有序。Pydantic为你提供一种更优雅的方式完成你的任务，使你可以专注于开发解决方案，而不是验证数据的任务。Pydantic可以用来定义模型，以便于格式化数据并转换成Python数据对象。它也可以在输入和输出之间执行类型转换，并根据你定义的规则进行数据验证。
python设置_python设置报错日志baseconfig配置
weixin_39605706的博客
11-26 302
使用Python的logging模块能很好的帮我们完成程序的错误日志功能。1）像其它的语言那样，python里的logging信息同样也是分为5个等级，从低到高依次是:DEBUG,INFO,WARNING,ERROR,CRITICAL2）python中，logging由logger，handler，filter，formater四个部分组成，logger是提供我们记录日志的方法；handler是让...
Swift-常用知识点BaseConfig
dibu3564的博客
12-24 188
①气泡图片设置填充方式 选中该图片->设置Slicing方式 ②便利构造函数convenience extension UIButton { // convenience : 便利,使用convenience修饰的构造函数叫做便利构造函数 // 遍历构造函数通常用在对系统的类进行构造函数的扩充时使用 /* ...
Android Studio导入项目，报错 Error:Unsupported method: BaseConfig.getApplicationIdSuffix().
a704397849的博客
08-14 395
转载 https://www.cnblogs.com/wobuyayi/p/8617774.html 从GitHub上clone下来的第三方库，由于时间间隔很长，gradle的版本和本机的版本不一致，导入到Android Studio中会报错，错误信息如下： Error:Unsupported method: BaseConfig.getApplicationIdSuffix(). The version of Gradle you connect to does not support that met
pydantic-django:对Django ORM的实验性Pydantic支持
03-27
重要提示：该项目应被视为实验性的进行中项目。 当前的API设计和行为尚未最终确定，并且尚未确定特定的版本支持。 安装 pip install pydantic-django 用法 要求：Python 3.7+，Django 2+ 基本用法的示例： class ...
Pydantic serialisation 中文文档(完整版)
????Fender的博客????
08-12 1431
Pydantic serialisation 国内唯一中文文档(完整版)
python库pydantic的简易入门教程.pdf
06-12
Pydantic的优点在于它可以与IDE和静态类型检查器（如mypy）无缝配合，允许开发者使用现有的类型注解来定义类实例。此外，Pydantic的BaseSettings类可以用于验证请求数据和读取系统设置，使其具有多用途性。 安装...
pydantic_core._pydantic_core.ValidationError: 1 validation error for DeepSpeedZeroConfig 解决方案
最新发布
weixin_43178406的博客
08-24 1万+
本文主要介绍了pydantic_core._pydantic_core.ValidationError: 1 validation error for DeepSpeedZeroConfig解决方案，希望能对使用deepspeed的同学们有所帮助。 文章目录 1. 问题描述 2. 解决方案
创建BaseConfig轻松获取AppSetting
weixin_34336526的博客
02-04 99
       我们经常存储一些配制信息在AppSettings中，是不是经常要写取它们值的代码。让我们写一个简单的基类吧： 1: /// &lt;summary&gt; 2: /// BaseWebConfig 3: /// &lt;/summary&gt; 4: public class BaseWebConfig 5: { ...
iOS-BaseConfig-工程基础配置
dibu3564的博客
07-15 272
Xcode Workspace就如同工厂, Xcode Project如同车间,每个车间可以独立于工厂来生产产品( project可独立于 workspace存在),但是各个车间组合起来就需要工厂来组织(如果用了 cocopods,就需要用 workspace)。 Xcode Target是一条条的流水线,一条流水线上面只生产一种产品。 Build Settings是生产产品的秘方,...
Python logging 模块之 logging.basicConfig 用法和参数详解
静堂先生的博客
06-06 5万+
Python 函数之 logging.basicConfig 用法和参数详解 先举例个例子： import logging logging.basicConfig(level=logging.INFO, format='%(asctime)s %(filename)s %(levelname)s %(message)s', ...
FastAPI学习（1）- Pydantic
jaffe的博客
06-03 2168
Response Model 响应模型
Pydantic官方文档
热门推荐
Bossen的学习历程
04-28 5万+
简介 Pydantic 是一个使用Python类型提示来进行数据验证和设置管理的库。Pydantic定义数据应该如何使用纯Python规范用并进行验证。PEP 484 从Python3.5开始引入了类型提示的功能，PEP 526 使用Python3.6中的变量注释语法对其进行了拓展。Pydantic使用这些注释来验证不受信任的数据是否采用了您想要的形式。 示例： from datetime imp...
AndroidStudio编译失败，提示 Unsupported method: BaseConfig.getApplicationIdSuffix().
小小希
06-02 3969
        升级AndroidStudio3.0后，有一些老项目没有打开过。今天打开一个老项目时，编译失败，提示 Unsupported method: BaseConfig.getApplicationIdSuffix()          翻译一下： gradle 同步失败，由于不支持方法: BaseConfig.getApplicationIdSuffix(). 你使用的gradle版本...
带你了解最全的webpack.base.config.js文件中文注释
愚人码头的博客
11-28 799
'use strict' const path = require('path') // 引入Node.js的Path模块 const utils = require('./utils') // 引入utils文件,此处主要用到了assetsPath()方法,用来根据开发模式或生产模式来使用config文件下的相应配置 const config = require('../config') // ...
FastAPI准备之pydantic类型检查工具
qq_44291044的博客
03-06 5186
pip install pydantic from typing import List from datetime import datetime from pydantic import BaseModel, ValidationError class User(BaseModel): id: int name = "chr" signUp_ts: dateti...
pydantic 使用例子
05-17
以下是一个使用 Pydantic 的例子： ```python from pydantic import BaseModel ...这些属性值是从 `user_data` 中提取的，并且由于我们使用了 Pydantic，这些属性值已经被验证和转换为正确的类型。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值