Function set

salt/modules/grains.py:620–736

Set a key to an arbitrary value. It is used like setval but works with nested keys. This function is conservative. It will only overwrite an entry if its value and the given one are not a list or a dict. The ``force`` parameter is used to allow overwriting in all cases. ..

(key, val="", force=False, destructive=False, delimiter=DEFAULT_TARGET_DELIM)

def set(key, val="", force=False, destructive=False, delimiter=DEFAULT_TARGET_DELIM):
    """
    Set a key to an arbitrary value. It is used like setval but works
    with nested keys.

    This function is conservative. It will only overwrite an entry if
    its value and the given one are not a list or a dict. The ``force``
    parameter is used to allow overwriting in all cases.

    .. versionadded:: 2015.8.0

    :param force: Force writing over existing entry if given or existing
                  values are list or dict. Defaults to False.
    :param destructive: If an operation results in a key being removed,
                  delete the key, too. Defaults to False.
    :param delimiter:
        Specify an alternate delimiter to use when traversing a nested dict,
        the default being ``:``

    CLI Example:

    .. code-block:: bash

        salt '*' grains.set 'apps:myApp:port' 2209
        salt '*' grains.set 'apps:myApp' '{port: 2209}'
    """

    ret = {"comment": "", "changes": {}, "result": True}

    # Get val type
    _new_value_type = "simple"
    if isinstance(val, dict):
        _new_value_type = "complex"
    elif isinstance(val, list):
        _new_value_type = "complex"

    _non_existent = object()
    _existing_value = get(key, _non_existent, delimiter)
    _value = _existing_value

    _existing_value_type = "simple"
    if _existing_value is _non_existent:
        _existing_value_type = None
    elif isinstance(_existing_value, dict):
        _existing_value_type = "complex"
    elif isinstance(_existing_value, list):
        _existing_value_type = "complex"

    if (
        _existing_value_type is not None
        and _existing_value == val
        and (val is not None or destructive is not True)
    ):
        ret["comment"] = "Grain is already set"
        return ret

    if _existing_value is not None and not force:
        if _existing_value_type == "complex":