Pydantic BaseModel多字段验证

Question

在我的fastapi应用中，我创建了一个pydantic的基础模型，这个模型有两个字段（还有其他字段）：'relation_type'和'document_list'（这两个字段都是可选的）。我想要验证的是，如果'relation_type'有值，那么'document_list'必须至少有一个元素。否则就会出现验证错误。我该怎么做呢？

class TipoRelacionEnum(str, Enum):
    nota_credito = "01"
    nota_debito = "02"
    devolucion_mercancias = "03"
    sustitucion = "04"
    traslado = "05"
    facturacion_generada = "06"
    anticipo = "07"

class Cfdi(BaseModel):
    relation_type: Optional[Annotated[TipoRelacionEnum, Field(title="Tipo de Relación",
                                                                description="""Se debe registrar la clave de la relación que existe entre este
                                                                                comprobante que se está generando y el o los CFDI previos.""",
                                                                examples=[
                                                                    "04",
                                                                    "01",
                                                                ],
                                                                max_length=2)]] = None

    document_list: list[str] | None = None

Answer 1

是的，你可以使用 model_validator 来实现这个功能。

from pydantic import BaseModel, model_validator
from typing import Optional


class Cfdi(BaseModel):
    relation_type: Optional[...] = None
    document_list: Optional[list[str]] = None
    
    @model_validator(mode="after")
    @classmethod
    def check_two_fields_together(cls, data: dict) -> dict:
        if relation_type and len(document_list) < 1:
            raise ValueError("Error text")
        return data