Hydra框架中嵌套Dataclass未传参时的初始化问题

问题场景 #

我用Hydra框架编写了如下简化代码，定义了嵌套的dataclass：FooBar包含Foo和Bar实例，且Foo、Bar都有默认属性值。我认为配置文件无需显式初始化Foo/Bar，但运行时却报错。

Python代码（dummy_hydra.py） #

# dummy_hydra.py

from dataclasses import dataclass

import hydra
from hydra.core.config_store import ConfigStore
from omegaconf import DictConfig, OmegaConf


@dataclass
class Foo:
    x: int = 0
    y: int = 1


@dataclass
class Bar:
    a: int = 0
    b: int = 1


@dataclass
class FooBar:
    foo: Foo
    bar: Bar


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


@hydra.main(config_name="dummy_config", config_path=".", version_base=None)
def main(config: DictConfig):
    config_obj: FooBar = OmegaConf.to_object(config)
    print(config_obj)


if __name__ == '__main__':
    main()

配置文件（dummy_config.yaml） #

# dummy_config.yaml
defaults:
  - config_schema
  - _self_

foo:
  x: 123
  y: 456

报错信息 #

omegaconf.errors.MissingMandatoryValue: Structured config of type `FooBar` has missing mandatory value: bar
    full_key: bar
    object_type=FooBar

解决方案 #

问题根源在于：FooBar中的foo和bar字段没有设置默认值，尽管Foo、Bar自身有默认属性，OmegaConf仍会将它们视为必填项。要实现无需显式初始化子配置，可通过以下两种方式修改FooBar的定义：

方法1：给子配置字段设置默认实例 #

直接在FooBar中为foo和bar字段初始化默认的Foo、Bar实例，这样配置文件未指定时会自动使用默认值：

@dataclass
class FooBar:
    foo: Foo = Foo()
    bar: Bar = Bar()

修改后运行代码，输出会自动包含bar的默认值：

FooBar(foo=Foo(x=123, y=456), bar=Bar(a=0, b=1))

方法2：标记字段为可选（适用于允许子配置为None的场景） #

如果允许bar字段为None，可使用Optional类型标记并设置默认值None：

from typing import Optional

@dataclass
class FooBar:
    foo: Foo
    bar: Optional[Bar] = None

这种情况下，若配置文件未指定bar，config_obj.bar会是None，而非Bar的默认实例。

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