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

Question

我正在使用 pydantic 模型来表示fastapi.

from pydantic import BaseModel, Schema

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

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

我想知道是否有一种方法可以通过使用例如正则表达式来进一步限制正文中发送的网址的“类型”。我知道Schema有一个regex标志，但我认为这只适用于单个输入（或者至少它不适用于我的列表）。

Answer 1

您可以像这样使用 ConstrainedStr 类型：

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:\Users\XXXX\AppData\Local\Programs\Python\Python37-32\lib\site-packages\pydantic\main.py", line 275, in __init__
    values, fields_set, _ = validate_model(__pydantic_self__, data)
  File "C:\Users\XXXX\AppData\Local\Programs\Python\Python37-32\lib\site-packages\pydantic\main.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]$)

Set add 方法不强制使用 ConstrainedStr 类型：

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