def update_nested_dict()

in runtool/runtool/utils.py [0:0]

• 10 lines of code
• 4 McCabe index (conditional complexity)

def update_nested_dict(data: dict, to_update: dict) -> dict:
    """
    Returns an updated version of the `data` dict updated with any changes from the `to_update` dict.
    This behaves differently from the builting`dict.update` method, see the example below.

    Example using `update_nested_dict`:

    >>> data = {"root": {"smth": 10, "smth_else": 20}}
    >>> to_update = {"root": {"smth": {"hello" : "world"}}}
    >>> update_nested_dict(data, to_update)
    {'root': {'smth': {'hello': 'world'}, 'smth_else': 20}}

    Example using the builtin `dict.update`:
    >>> data.update(to_update)
    >>> print(data)
    {'root': {'smth': {'hello': 'world'}}}

    Parameters
    ----------
    data
        The base dictionary which should be updated.
    to_update
        The changes which should be added to the data.
    Returns
    -------
    dict
        The updated dictionary.
    """
    for key, value in to_update.items():
        if isinstance(data, dict):
            if isinstance(value, dict):
                data[key] = update_nested_dict(data.get(key, {}), value)
            else:
                data[key] = to_update[key]
        else:
            data = {key: to_update[key]}
    return data