告别 constr：用自定义验证器解锁 FastAPI 字符串验证的威力

python

2024-03-19 19:03:16

告别 constr：在 FastAPI 中使用自定义验证器

引言

在使用 FastAPI 和 Pydantic 的项目中，constr 一直是验证字符串的得力助手。然而，随着它的弃用，我们需要寻找一种现代的替代方案，既能保持 constr 的验证功能，又符合当前最佳实践。

自定义验证器的魅力

自定义验证器是取代 constr 的推荐方法。它允许你创建满足特定需求的验证器，并具有灵活性、可重用性和可扩展性。

创建自定义验证器

创建一个自定义验证器需要你实现 Pydantic 的 Validator 协议。下面是一个验证字符串长度和格式的示例：

from pydantic import validator, ValidationError
from typing import List, Optional

class CustomStrValidator:
    @validator
    def validate_string(cls, value: str) -> str:
        if len(value) > 4:
            raise ValidationError("String is too long")
        if not value.isupper():
            raise ValidationError("String is not uppercase")
        return value

应用自定义验证器

要应用自定义验证器，可以使用 validator 装饰器：

from pydantic import BaseModel, Field

class Site(BaseModel):
    site_code: str = Field(..., validators=[CustomStrValidator()])

在 FastAPI 中使用

自定义验证器可以在 FastAPI 中与 constr 相同的方式使用：

from fastapi import FastAPI, HTTPException

app = FastAPI()

@app.get("/{site_code}", summary="Read a site")
async def get_site(site_code: Site) -> str:
    return "..."