Function _apply_view_docs

app/api/agentops/common/route_config.py:41–68

Applies documentation-related attributes to the wrapper function from a class based view.

(wrapper: Callable, view_class: type[TBaseView])

def _apply_view_docs(wrapper: Callable, view_class: type[TBaseView]) -> None:
    """Applies documentation-related attributes to the wrapper function from a class based view."""
    call_method = getattr(view_class, '__call__')
    call_sig = inspect.signature(call_method)

    params = []
    has_request_param = any(name == 'request' for name in call_sig.parameters.keys())

    for name, param in call_sig.parameters.items():
        if name == 'self':
            # Only replace 'self' with 'request: Request' if there's no existing 'request' parameter
            if not has_request_param:
                param = inspect.Parameter(
                    'request',
                    inspect.Parameter.POSITIONAL_OR_KEYWORD,
                    annotation=Request,
                )
            else:
                # Skip 'self' parameter if there's already a 'request' parameter
                continue
        params.append(param)

    wrapper.__doc__ = view_class.__doc__  # use the view class docstring
    wrapper.__name__ = view_class.__dict__.get('__name__', view_class.__name__)
    wrapper.__signature__ = inspect.Signature(
        parameters=params,
        return_annotation=call_sig.return_annotation,
    )


@dataclass