Pydantic 学习随笔

这里是零散的记录一些学习过程中随机的理解，因此这里的记录不成体系。如果是想学习 Pydantic 建议看官方文档，写的很详细并且成体系。如果有问题需要交流，欢迎私信或者评论。

siwa 报 500

Pydantic 可以和 siwa 结合使用，这样既能做到参数校验，又可以把参数转为一个类实例方便引用。

当校验失败时，服务端会返回 500，原因是 Pydantic 在实例化一个实例时，如果参数不对就会抛异常 ValidationError，因此 web 框架会返回 500

Arbitrary class instances

这个特性就是允许通过其他类实例来生成并初始化一个 Pydantic 实例。

# 下面是官方 demo

from typing import List

from sqlalchemy import Column, Integer, String
from sqlalchemy.dialects.postgresql import ARRAY
from sqlalchemy.ext.declarative import declarative_base

from pydantic import BaseModel, ConfigDict, constr

Base = declarative_base()


class CompanyOrm(Base):
    __tablename__ = 'companies'

    id = Column(Integer, primary_key=True, nullable=False)
    public_key = Column(String(20), index=True, nullable=False, unique=True)
    name = Column(String(63), unique=True)
    domains = Column(ARRAY(String(255)))


class CompanyModel(BaseModel):
    model_config = ConfigDict(from_attributes=True)

    id: int
    public_key: constr(max_length=20)
    name: constr(max_length=63)
    domains: List[constr(max_length=255)]


co_orm = CompanyOrm(
    id=123,
    public_key='foobar',
    name='Testing',
    domains=['example.com', 'foobar.com'],
)
print(co_orm)
#> <__main__.CompanyOrm object at 0x0123456789ab>

# 如果字段或值类型不匹配则会抛异常
co_model = CompanyModel.model_validate(co_orm)
print(co_model)
"""
id=123 public_key='foobar' name='Testing' domains=['example.com', 'foobar.com']
"""

同时，这种方式可以定义 Model（如：CompanyModel） 和目标类（如：CompanyOrm）中字段的映射关系，这样可以保证在两端字段（属性名）不一致时也能正常转换

# 官方 demo

import typing

import sqlalchemy as sa
from sqlalchemy.ext.declarative import declarative_base

from pydantic import BaseModel, ConfigDict, Field


class MyModel(BaseModel):
    model_config = ConfigDict(from_attributes=True)

    # 建立映射关系
    metadata: typing.Dict[str, str] = Field(alias='metadata_')


Base = declarative_base()


class SQLModel(Base):
    __tablename__ = 'my_table'
    id = sa.Column('id', sa.Integer, primary_key=True)
    # 'metadata' is reserved by SQLAlchemy, hence the '_'
    metadata_ = sa.Column('metadata', sa.JSON)


sql_model = SQLModel(metadata_={'key': 'val'}, id=1)

pydantic_model = MyModel.model_validate(sql_model)

print(pydantic_model.model_dump())
#> {'metadata': {'key': 'val'}}
print(pydantic_model.model_dump(by_alias=True))
#> {'metadata_': {'key': 'val'}}

model_validate 函数

这个函数的参数可以是字典也可以是对象。

需要注意的是，当参数是对象实例时，需要在 Model 中设置 model_config = ConfigDict(from_attributes=True) 否则会报错。

from pydantic import BaseModel, ConfigDict, Field

class MyModel(BaseModel):
    # 如果没有这一行设置，则 aa 变量那一行会报错
    model_config = ConfigDict(from_attributes=True)

    id: int
    name: str

class Person:
    def __init__(self, * , id: int, name: str):
      self.id = id
      self.name = name

aa = MyModel.model_validate(Person(id=1, name="aa"))
bb = MyModel.model_validate({"id": 2, "name": "bb"})

print('{} *** {}'.format(aa, bb))
# id=1 name='aa' *** id=2 name='bb'