override

This module provides functionality to handle overriding variables in a spec file via the command-line interface. It includes functions to validate and replace variables in the spec file or environment block based on user-provided overrides.

error_override_vars(override_vars, spec_filepath)

Warns the user if any given variable name in the override list is not found in the original spec file.

Parameters:

Name	Type	Description	Default
override_vars	Dict[str, str]	A dictionary of variables to override, where keys are variable names and values are their corresponding new values. Can be None if no overrides are provided.	required
spec_filepath	str	The file path to the original spec file.	required

Raises:

Type	Description
ValueError	If any variable name in override_vars is not found in the spec file.

Source code in merlin/spec/override.py

def error_override_vars(override_vars: Dict[str, str], spec_filepath: str):
    """
    Warns the user if any given variable name in the override list is not found
    in the original spec file.

    Args:
        override_vars: A dictionary of variables to override, where keys are
            variable names and values are their corresponding new values. Can
            be `None` if no overrides are provided.
        spec_filepath: The file path to the original spec file.

    Raises:
        ValueError: If any variable name in `override_vars` is not found in the
            spec file.
    """
    if override_vars is None:
        return
    with open(spec_filepath, "r") as ospec:
        original_text = ospec.read()
    for variable in override_vars.keys():
        if variable not in original_text:
            raise ValueError(f"Command line override variable '{variable}' not found in spec file '{spec_filepath}'.")

replace_override_vars(env, override_vars)

Replaces variables in the given environment block with the provided override values.

Parameters:

Name	Type	Description	Default
env	Dict[str, str]	The environment block, represented as a dictionary where keys are environment variable names and values are their corresponding values.	required
override_vars	Dict[str, str]	A dictionary of variables to override, where keys are variable names and values are their corresponding new values. Can be None if no overrides are provided.	required

Returns:

Type	Description
Dict[str, str]	A new environment block with the override variables replaced.

Source code in merlin/spec/override.py

def replace_override_vars(env: Dict[str, str], override_vars: Dict[str, str]) -> Dict[str, str]:
    """
    Replaces variables in the given environment block with the provided override
    values.

    Args:
        env: The environment block, represented as a dictionary where keys are
            environment variable names and values are their corresponding values.
        override_vars: A dictionary of variables to override, where keys are
            variable names and values are their corresponding new values. Can be
            `None` if no overrides are provided.

    Returns:
        A new environment block with the override variables replaced.
    """
    if override_vars is None:
        return env
    result = deepcopy(env)
    for key, val in env.items():
        for var_name, var_val in override_vars.items():
            if var_name in val:
                result[key][var_name] = var_val
    return result