Skip to content

Module: recipe

InfernetRecipe

Bases: TypedDict

Infernet Recipe (see github.com/ritual-net/infernet-recipes)

Source code in src/infernet_cli/recipe.py 
36
37
38
39
40
41
42
43
class InfernetRecipe(TypedDict):
    """Infernet Recipe (see github.com/ritual-net/infernet-recipes)"""

    # Required
    config: RecipeConfig

    # Optional
    inputs: NotRequired[list[RecipeInputs]]

RecipeConfig

Bases: TypedDict

Infernet Recipe Configuration

Source code in src/infernet_cli/recipe.py 
 9
10
11
12
13
14
15
16
17
18
19
class RecipeConfig(TypedDict, total=False):
    """Infernet Recipe Configuration"""

    # Required
    id: str
    image: str

    # Optional
    command: NotRequired[str]
    env: NotRequired[dict[str, Any]]
    description: NotRequired[str]

RecipeInputs

Bases: TypedDict

Infernet Recipe Input Variable

Source code in src/infernet_cli/recipe.py 
22
23
24
25
26
27
28
29
30
31
32
33
class RecipeInputs(TypedDict):
    """Infernet Recipe Input Variable"""

    # Required
    id: str
    type: str
    path: str
    required: bool

    # Optional
    description: NotRequired[str]
    default: NotRequired[Any]

fill_in_recipe(recipe, inputs=None, skip=False)

Fill-in the recipe inputs and return the configuration

If inputs object is provided, use it to fill in the recipe inputs. Otherwise, prompt the user for inputs interactively via the CLI.

Parameters:

Name Type Description Default
recipe dict[str, Any]

The recipe containing the inputs and configuration

 required
inputs Optional[dict[str, Any]]

The inputs to fill in the recipe

 None
skip bool

Whether to skip optional inputs

 False

Returns:

Name Type Description
Any Any

The configuration with the user inputs
Source code in src/infernet_cli/recipe.py 
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
def fill_in_recipe(
    recipe: InfernetRecipe, inputs: Optional[dict[str, Any]] = None, skip: bool = False
) -> Any:
    """Fill-in the recipe inputs and return the configuration

    If inputs object is provided, use it to fill in the recipe inputs. Otherwise,
    prompt the user for inputs interactively via the CLI.

    Args:
        recipe (dict[str, Any]): The recipe containing the inputs and configuration
        inputs (Optional[dict[str, Any]]): The inputs to fill in the recipe
        skip (bool): Whether to skip optional inputs

    Returns:
        Any: The configuration with the user inputs
    """
    config = deepcopy(recipe["config"])

    # Prompt user for inputs if not provided
    if inputs is None:
        inputs = {}
        for var in recipe["inputs"]:
            # Skip optional inputs if specified
            if skip and var["required"] is False:
                continue

            click.echo(
                f"\"{var['id']}\" ({var['type']}): {var['description']} "
                f"({'Required' if var['required'] is True else 'RETURN to skip'}):"
            )
            value = input("    Enter value: ")
            inputs[var["id"]] = value

    # Fill in the recipe inputs
    for var in recipe["inputs"]:
        value = inputs.get(var["id"], None)

        # If skipped, check if required or default value
        if not value:
            # If value if required, exit with error
            if var["required"] is True:
                raise click.ClickException(
                    f"Required value '{var['id']}' not provided."
                )
            # If value is defaulted, use default value
            elif "default" in var:
                value = var["default"]
            # Otherwise, skip
            else:
                continue

        # Handle mid-string substitutions with # notation
        pound_index = var["path"].find("#")
        pound_substr = None
        if pound_index != -1:
            pound_substr = var["path"][pound_index + 1 :]
            keys = var["path"][:pound_index].split(".")
        else:
            keys = var["path"].split(".")

        # Traverse the configuration path
        ptr = config
        for key in keys[:-1]:
            ptr = ptr[key]  # type: ignore

        # Store value in the configuration
        if not pound_substr:
            ptr[keys[-1]] = value  # type: ignore
        else:
            # make the mid-string substitution
            string = json.dumps(ptr[keys[-1]])  # type: ignore
            string = string.replace("${" + pound_substr + "}", str(value))
            ptr[keys[-1]] = json.loads(string)  # type: ignore

    return config