Function coerce_value

src/ifcedit/ifcedit/coerce.py:28–119

Convert a CLI string argument to the proper Python type based on a type hint. Args: value_str: The raw string from the CLI. type_hint: The type annotation from the function signature. model: The main open IFC model, needed to resolve entity instance references by ID.

(
    value_str: str,
    type_hint,
    model: ifcopenshell.file | None = None,
    lookup_file: ifcopenshell.file | None = None,
)

def coerce_value(
    value_str: str,
    type_hint,
    model: ifcopenshell.file | None = None,
    lookup_file: ifcopenshell.file | None = None,
):
    """Convert a CLI string argument to the proper Python type based on a type hint.

    Args:
        value_str: The raw string from the CLI.
        type_hint: The type annotation from the function signature.
        model: The main open IFC model, needed to resolve entity instance references by ID.
        lookup_file: Override file for entity resolution (e.g. a library file for
            project.append_asset). When provided, entity IDs are looked up here instead
            of in model.

    Returns:
        The converted Python value.

    Raises:
        ValueError: If the value cannot be converted.
        TypeError: If the type hint is not supported.
    """
    # When a library file has been opened, entity IDs are resolved from it, not the main model.
    effective_lookup = lookup_file if lookup_file is not None else model

    if type_hint is None:
        return value_str

    origin = typing.get_origin(type_hint)
    args = typing.get_args(type_hint)

    # Union / Optional
    if origin is typing.Union:
        non_none_types = [a for a in args if a is not type(None)]
        if value_str.lower() == "none":
            if type(None) in args:
                return None
        # Try each non-None type in order
        for t in non_none_types:
            try:
                return coerce_value(value_str, t, model, lookup_file)
            except (ValueError, TypeError):
                continue
        raise ValueError(f"Cannot convert '{value_str}' to any of {non_none_types}")

    # Literal
    if origin is typing.Literal:
        allowed = args
        if value_str in [str(a) for a in allowed]:
            # return the actual literal value with proper type
            for a in allowed:
                if str(a) == value_str:
                    return a
        raise ValueError(f"'{value_str}' is not one of: {', '.join(repr(a) for a in allowed)}")

    # list types
    if origin is list: