Function run_foreach

src/ifcedit/ifcedit/foreach.py:33–76

Apply an API function to each item in a list, substituting {field} placeholders. Opens the model once, applies the mutation for every item, and returns a summary. The caller is responsible for saving the model. Args: model: The open IFC model (mutated in place). module:

(
    model: ifcopenshell.file,
    module: str,
    function: str,
    raw_kwargs_template: dict[str, str],
    items: list[dict],
)

def run_foreach(
    model: ifcopenshell.file,
    module: str,
    function: str,
    raw_kwargs_template: dict[str, str],
    items: list[dict],
) -> dict:
    """Apply an API function to each item in a list, substituting {field} placeholders.

    Opens the model once, applies the mutation for every item, and returns a summary.
    The caller is responsible for saving the model.

    Args:
        model: The open IFC model (mutated in place).
        module: API module name (e.g. "root").
        function: Function name (e.g. "remove_product").
        raw_kwargs_template: Arg templates with {field} placeholders, e.g. {"product": "{id}"}.
        items: List of dicts (e.g. from ifcquery select output).

    Returns:
        {"ok": True, "count": N, "errors": []} on full success,
        {"ok": False, "count": N, "errors": [{...}]} if any item failed.
    """
    errors = []
    count = 0

    for i, item in enumerate(items):
        if not isinstance(item, dict):
            errors.append({"index": i, "item": item, "error": "item is not a dict"})
            continue

        substituted = {k: _substitute(v, item) for k, v in raw_kwargs_template.items()}
        result = run_api(model, module, function, substituted)

        if result["ok"]:
            count += 1
        else:
            errors.append({"index": i, "item": item, "error": result["error"]})

    return {
        "ok": len(errors) == 0,
        "count": count,
        "errors": errors,
    }