对于非内置类型（如 pandas DataFrame）的 pydantic @validate_arguments 的最佳实践

Question

我目前正在尝试使用 pydantic 验证函数的输入参数。这适用于内置数据类型，但不适用于 pandas.DataFrame 或 numpy.array 等类型。例子：

@validate_arguments
def some_function(params: pd.DataFrame,
                  var_name: str
                  ) -> dict:
    # do something
    return my_dict

调用 some_function 时显示以下错误：

RuntimeError: no validator found for <class 'pandas.core.frame.DataFrame'>, see `arbitrary_types_allowed` in Config`

我的第一个想法是定义我自己的 DataFrame 类型，如下所示：

class MyDF(pd.DataFrame):
    @classmethod
    def __get_validators__(cls):
        yield cls.validate

    @classmethod
    def validate(cls, val):
        return pd.DataFrame(val)

我不确定这是否是最佳实践。有人有更好的想法吗？

Answer 1

您可以定义自定义配置以允许任意类型，以便 pydantic 检查参数是否为该类型的实例。

例如：

@validate_arguments(config=dict(arbitrary_types_allowed=True))
def some_function(params: pd.DataFrame,
                  var_name: str
                  ) -> dict:
    # do something
    return my_dict

模型配置选项的文档可在此处找到