Function _shape_method_docs

src/ifcmcp/ifcmcp/core.py:92–136

Return full documentation for a single ShapeBuilder method.

(method_name: str)

def _shape_method_docs(method_name: str) -> dict:
    """Return full documentation for a single ShapeBuilder method."""
    import typing

    from ifcedit.discover import (
        _extract_params,
        _format_type_hint,
        _parse_docstring_body,
        _parse_param_docs,
        _parse_return_doc,
    )
    from ifcopenshell.util.shape_builder import ShapeBuilder

    if method_name.startswith("_"):
        raise ValueError(f"ShapeBuilder has no method '{method_name}'")
    fn = getattr(ShapeBuilder, method_name, None)
    if fn is None:
        raise ValueError(f"ShapeBuilder has no method '{method_name}'")

    doc = fn.__doc__ or ""
    description, long_description = _parse_docstring_body(doc)
    params = _extract_params(fn)
    for param in params:
        param_desc = _parse_param_docs(doc)
        if param["name"] in param_desc:
            param["description"] = param_desc[param["name"]]

    try:
        hints = typing.get_type_hints(fn)
    except Exception:
        hints = {}

    result: dict[str, Any] = {
        "method": method_name,
        "description": description,
        "long_description": long_description,
        "params": params,
    }
    return_type = _format_type_hint(hints.get("return"))
    if return_type:
        result["return_type"] = return_type
    return_description = _parse_return_doc(doc)
    if return_description:
        result["return_description"] = return_description
    return result


def _coerce_shape_params(fn: Callable, raw_kwargs: dict, model: ifcopenshell.file) -> dict: