是否可以在 hydra-core python 包的结构化配置中使用 Pydantic 而不是数据类？

Question

最近我开始使用hydra 来管理我的应用程序中的配置。我使用 Structured Configs 为 .yaml 配置文件创建架构。 Hyda 中的结构化配置使用dataclasses 进行类型检查。但是，我还想对我在结构化配置中指定的某些参数使用某种验证器（类似于 this）。

您知道是否有可能为此目的使用 Pydantic？当我尝试使用 Pydantic 时，OmegaConf 抱怨它：

omegaconf.errors.ValidationError: Input class 'SomeClass' is not a structured config. did you forget to decorate it as a dataclass?

Answer 1

对于那些想知道它是如何工作的人，这里有一个例子：

import hydra
from hydra.core.config_store import ConfigStore
from omegaconf import OmegaConf
from pydantic.dataclasses import dataclass
from pydantic import validator


@dataclass
class MyConfigSchema:
    some_var: float

    @validator("some_var")
    def validate_some_var(cls, some_var: float) -> float:
        if some_var < 0:
            raise ValueError(f"'some_var' can't be less than 0, got: {some_var}")
        return some_var


cs = ConfigStore.instance()
cs.store(name="config_schema", node=MyConfigSchema)


@hydra.main(config_path="/path/to/configs", config_name="config")
def my_app(config: MyConfigSchema) -> None:
    # The 'validator' methods will be called when you run the line below
    OmegaConf.to_object(config)


if __name__ == "__main__":    
    my_app()

还有config.yaml：

defaults:
  - config_schema

some_var: -1  # this will raise a ValueError

Answer 2

请参阅 pydantic.dataclasses.dataclass，它是标准库数据类的直接替代品，带有一些额外的类型检查。