Function relations

src/ifcquery/ifcquery/relations.py:182–197

Return relationships for an element, or hierarchy chain if traverse='up'.

(
    model: ifcopenshell.file, element: ifcopenshell.entity_instance, traverse: str | None = None
)

def relations(
    model: ifcopenshell.file, element: ifcopenshell.entity_instance, traverse: str | None = None
) -> dict[str, Any] | list[dict[str, Any]]:
    """Return relationships for an element, or hierarchy chain if traverse='up'."""
    if traverse == "up":
        return _traverse_up(element)
    result = _all_relations(model, element)

    # Flat list of subject + all referenced elements, deduplicated.
    # Allows --format ids to extract all involved IDs without jq.
    seen: set[int] = set()
    elements: list[dict[str, Any]] = []
    _collect_elements(result, seen, elements)
    result["elements"] = elements

    return result