在处理字符串集的 pydantic 模型中使用正则表达式

Question

我正在使用pydantic模型来表示fastapi中的请求正文。

from pydantic import BaseModel, Schema
class Files(BaseModel):
'''Class for file URLs'''
urls: Set[str] = Schema(..., title='Urls to files')

这会将请求正文限制为定义为str的 URL 集。

我想知道是否有办法通过使用例如正则表达式来进一步限制正文中发送的 url 的"类型"。我知道Schema有一个regex标志，但我认为这仅适用于单个输入(或者至少它不适用于我的列表(。

Answer 1

你可以像这样使用 ConscuredStr 类型：

import pydantic
from typing import Set
MyUrlsType =pydantic.constr(regex="^[a-z]$")
class MyForm(pydantic.BaseModel):
urls : Set[MyUrlsType]

它仅在创建对象时起作用：

MyForm(urls={"a", "B"})
Traceback (most recent call last):
File "<pyshell#7>", line 1, in <module>
MyForm(urls={"a", "B"})
File "C:UsersXXXXAppDataLocalProgramsPythonPython37-32libsite-packagespydanticmain.py", line 275, in __init__
values, fields_set, _ = validate_model(__pydantic_self__, data)
File "C:UsersXXXXAppDataLocalProgramsPythonPython37-32libsite-packagespydanticmain.py", line 785, in validate_model
raise err
pydantic.error_wrappers.ValidationError: 1 validation error for MyForm
urls -> 1
string does not match regex "^[a-z]$" (type=value_error.str.regex; pattern=^[a-z]$)

ConscuredStr 类型不会在 Set add 方法上强制执行：

f = MyForm(urls={"a", "b"})
>>> <MyForm urls={'b', 'a'}>
f.urls.add("c")
f.urls.add("yolo")
f.urls
>>> {'b', 'a', 'yolo', 'c'}