utils_templates

customize_template(*, template_name, replacements, script_path)

Customize a bash-script template and write it to disk.

PARAMETER	DESCRIPTION
template_name	Name of the template that will be customized. TYPE: str
replacements	List of replacements for template customization. TYPE: set[tuple[str, str]]
script_path	Local path where the customized template will be written. TYPE: str

Source code in fractal_server/tasks/v2/utils_templates.py

def customize_template(
    *,
    template_name: str,
    replacements: set[tuple[str, str]],
    script_path: str,
) -> None:
    """
    Customize a bash-script template and write it to disk.

    Args:
        template_name: Name of the template that will be customized.
        replacements: List of replacements for template customization.
        script_path: Local path where the customized template will be written.
    """
    _check_pixi_frozen_option(replacements=replacements)

    # Read template
    template_path = TEMPLATES_DIR / template_name
    with template_path.open("r") as f:
        template_data = f.read()
    # Customize template
    script_data = template_data
    for old_new in replacements:
        script_data = script_data.replace(old_new[0], old_new[1])
    # Create parent folder if needed
    Path(script_path).parent.mkdir(exist_ok=True)
    # Write script locally
    with open(script_path, "w") as f:
        f.write(script_data)

parse_script_pip_show_stdout(stdout)

Parse standard output of 4_pip_show.sh

Source code in fractal_server/tasks/v2/utils_templates.py

def parse_script_pip_show_stdout(stdout: str) -> dict[str, str]:
    """
    Parse standard output of 4_pip_show.sh
    """
    searches = [
        ("Python interpreter:", "python_bin"),
        ("Package name:", "package_name"),
        ("Package version:", "package_version"),
        ("Package parent folder:", "package_root_parent"),
        ("Manifest absolute path:", "manifest_path"),
    ]
    stdout_lines = stdout.splitlines()
    attributes = dict()
    for search, attribute_name in searches:
        matching_lines = [_line for _line in stdout_lines if search in _line]
        if len(matching_lines) == 0:
            raise ValueError(f"String '{search}' not found in stdout.")
        elif len(matching_lines) > 1:
            raise ValueError(
                f"String '{search}' found too many times "
                f"({len(matching_lines)})."
            )
        else:
            actual_line = matching_lines[0]
            attribute_value = actual_line.split(search)[-1].strip(" ")
            attributes[attribute_name] = attribute_value
    return attributes