pydantic：在将其分配到字段之前转换值？

Question

我有以下模型

class Window(BaseModel):
    size: tuple[int, int]

，我想这样实例化：

fields = {'size': '1920x1080'}
window = Window(**fields)

当然，这会失败，因为'size'的值不是正确的类型。但是，我想添加逻辑，以便在x上拆分该值，即：

def transform(raw: str) -> tuple[int, int]:
    x, y = raw.split('x')
    return int(x), int(y)

Pydantic支持这一点吗？

Answer 1

pydantic 2.x（编辑）

pydantic 2.0引入了 field_validator 装饰器，您可以以非常简单的方式实现这种行为。给定原始解析功能：

from pydantic import BaseModel, field_validator

class Window(BaseModel):
    size: tuple[int, int]

    @field_validator("size", mode="before")
    @classmethod
    def transform(cls, raw: str) -> tuple[int, int]:
        x, y = raw.split("x")
        return int(x), int(y)

注意：

• 验证方法是一种类方法，如cls第一个参数所示。将其作为实例方法实现（使用self）会引起错误。
• mode =“在”装饰器中的在这里至关重要，正如预期的那样，这就是该方法在检查“大小”之前运行的方法。

---

Pydantic 1.x（原始答案）

您可以使用Pydantic的验证器实现这种行为。给定预定义的函数：

def transform(raw: str) -> tuple[int, int]:
    x, y = raw.split('x')
    return int(x), int(y)

您可以在类中实现它：

from pydantic import BaseModel, validator


class Window(BaseModel):
    
    size: tuple[int, int]
    _extract_size = validator('size', pre=True, allow_reuse=True)(transform)

注意传递给验证器的pre = true参数。这意味着它将在之前运行，默认验证器检查size是一个元组。

---

现在：

fields = {'size': '1920x1080'}
window = Window(**fields)
print(window)
# output: size=(1920, 1080)

请注意，在那之后，您将无法用元组来实例化窗口。

fields2 = {'size': (800, 600)}
window2 = Window(**fields2)
# AttributeError: 'tuple' object has no attribute 'split'

为了克服这一点，如果通过稍微更改代码通过元组，您可以简单地绕过该功能：

pydantic 2.x

class Window(BaseModel):
    size: tuple[int, int]

    @field_validator("size", mode="before")
    def transform(cls, raw: str | tuple[int, int]) -> tuple[int, int]:
        if isinstance(raw, tuple):
            return raw
        x, y = raw.split("x")
        return int(x), int(y)

pydantic 1.x 1.x

def transform(raw: str | tuple[int, int]) -> tuple[int, int]:
    if isinstance(raw, tuple):
        return raw
    x, y = raw.split('x')
    return int(x), int(y)

class Window(BaseModel):

    size: tuple[int, int]
    _extract_size = validator('size', pre=True, allow_reuse=True)(transform)

应该给出：

fields2 = {'size': (800, 600)}
window2 = Window(**fields2)
print(window2)
# output: size:(800, 600)

Answer 2

如果您想将转换/验证逻辑保持更模块化或与类本身分离，还有另一个选择。

from pydantic import BaseModel, AfterValidator
from typing_extensions import Annotated

def transform(raw: str) -> tuple[int, int]:
    x, y = raw.split('x')
    return int(x), int(y)

WindowSize = Annotated[str, AfterValidator(transform)]

class Window(BaseModel):
    size: WindowSize

fields = {'size': '1920x1080'}
window = Window(**fields)

print(window.size)  # (1920, 1080)