Get_leaves_str() for printing all the leave values in an OmegaConf object

[songyuc]

Describe the solution you'd like
I want to print all the leave values of an OmegaConf object, so that I can check them directly.

Describe alternatives you've considered
I have implemented it as:

from omegaconf import OmegaConf

s = """
a: b
b: c
list:
- item1
- item2
123: 456
"""
conf = OmegaConf.create(s)
print(OmegaConf.to_yaml(conf))

def get_leaves_str(cfg, parent=None):
    if not OmegaConf.is_config(cfg):
        assert parent, cfg
        return [f"{parent} = {str(cfg)}"]
    if OmegaConf.is_list(cfg):
        items = enumerate(cfg)
    elif OmegaConf.is_config(cfg):
        items = cfg.items()
    else:
        raise NotImplementedError
    string = []
    parent = f"{parent}." if parent else ''
    for k, v in items:
        string += get_leaves_str(v, f"{parent}{k}")
    return string

print("\n".join(get_leaves_str(conf)))

Additional context
Do you think it could be improved? Please share me some guide and advice.

[Jasha10]

The implementation looks good.
The only problem I can see will be handling missing keys. For example, if s == {'abc': '???'} then this implementation will crash. For this reason, I'd recommend checking each key before you access it:

def get_leaves_str(cfg, parent=None):
    if not OmegaConf.is_config(cfg):
        assert parent, cfg
        return [f"{parent} = {str(cfg)}"]
    if OmegaConf.is_list(cfg):
        keys = range(len(cfg))
    elif OmegaConf.is_config(cfg):
        keys = cfg.keys()
    else:
        raise NotImplementedError
    string = []
    parent = f"{parent}." if parent else ""
    for k in keys:
        child_key = f"{parent}{k}"
        if OmegaConf.is_missing(cfg, k):
            string += [f"{child_key} = ???"]
        else:
            v = cfg[k]
            string += get_leaves_str(v, child_key)
    return string

[songyuc]

Thanks sincerely, and I have also modified my implementation as:

def get_leaves_str(cfg, parent=None):
    if not OmegaConf.is_config(cfg):
        assert parent, cfg
        return [f"{parent} = {str(cfg)}"]
    if OmegaConf.is_list(cfg):
        keys = range(len(cfg))
    elif OmegaConf.is_config(cfg):
        keys = cfg.keys()
    else:
        raise NotImplementedError
    string = []
    parent = f"{parent}." if parent else ""
    for k in keys:
        child_key = f"{parent}{k}"
        v = cfg[k] if not OmegaConf.is_missing(cfg, k) else "???"
        string += get_leaves_str(v, child_key)
    return string

[songyuc]

Hi, would you consider adding this get_leaves_str function into OmegaConf, like OmegaConf.get_leaves_str(config)?

[jieru-hu]

hi @songyuc - pls open a feature request as an separate issue :)

[songyuc]

OK, please give me some minutes.

[Jasha10]

Cross-link: #966