如何为Pydantic模型字段指定不同的输入类型？

要解决字段类型提示错误的问题，核心是让模型字段的类型标注与实际存储的类型保持一致，同时通过验证器兼容多种输入格式（比如逗号分隔字符串或直接传入列表）。以下是修正后的实现：

修正后的Pydantic V1代码 #

import typing
from pydantic import BaseSettings, Field, validator

class Config(BaseSettings):
    systems: typing.List[str] = Field([], description="系统列表，可传入逗号分隔字符串（如'sys1,sys2'）或直接传入字符串列表")

    @validator("systems", pre=True)
    def parse_systems(cls, v):
        # 如果输入是字符串，拆分并过滤空值
        if isinstance(v, str):
            if not v:
                return []
            return list(filter(None, v.split(",")))
        # 如果输入已经是列表，直接返回
        return v

if __name__ == "__main__":
    # 测试逗号分隔字符串输入
    c1 = Config(**{"systems": "foo,bar"})
    print(c1.systems)  # 输出: ['foo', 'bar']
    print(type(c1.systems))  # 输出: <class 'list'>

    # 测试直接传入列表
    c2 = Config(**{"systems": ["baz", "qux"]})
    print(c2.systems)  # 输出: ['baz', 'qux']

    # 测试空字符串输入
    c3 = Config(**{"systems": ""})
    print(c3.systems)  # 输出: []

关键修改点说明 #

• 类型标注修正：将systems的类型从str改为typing.List[str]，与实际存储的类型一致，彻底解决IDE类型提示错误。
• 添加pre=True参数：让验证器在Pydantic默认类型校验之前执行，先把字符串转换成列表，再交给Pydantic验证是否符合list[str]类型。
• 兼容多输入格式：验证器中判断输入类型，既支持逗号分隔字符串，也支持直接传入字符串列表，提升使用灵活性。

Pydantic V2 写法参考 #

如果你使用Pydantic V2，语法有所调整，推荐使用field_validator配合mode="before"：

from pydantic import BaseSettings, Field, field_validator
from typing import List

class Config(BaseSettings):
    systems: List[str] = Field([], description="系统列表，可传入逗号分隔字符串（如'sys1,sys2'）或直接传入字符串列表")

    @field_validator("systems", mode="before")
    def parse_systems(cls, v):
        if isinstance(v, str):
            if not v:
                return []
            return list(filter(None, v.split(",")))
        return v

if __name__ == "__main__":
    c = Config(systems="foo,bar")
    print(c.systems)  # 输出: ['foo', 'bar']

内容的提问来源于stack exchange，提问作者cylon86