utils.py

from __future__ import annotations

from functools import wraps
from inspect import getsource
from typing import Any, Callable, TypeVar


T = TypeVar("T")


def serialize_callable(
    value: Callable[..., T] | str, keep_callable=False
) -> Callable[..., T] | str:
    """Serializes a given function or string.

    If 'keep_callable' is True, the original callable is returned.
    Otherwise, attempts to return the source code of the callable using 'getsource'.
    If serialization fails, returns the string representation.
    """
    if keep_callable:
        return value
    else:
        try:
            return getsource(value)
        except (TypeError, OSError):
            return str(value)


def maybe_serialize(
    val: Callable[..., T] | Any, keep_callable=False
) -> Callable[..., T] | Any:
    """Conditionally serializes a value if it is callable."""

    return (
        serialize_callable(val, keep_callable=keep_callable) if callable(val) else val
    )


def create_mc_choices(choices: list[str], choice_delimiter: str | None = "\n") -> str:
    """Creates a multiple-choice question format from a list of choices."""
    if len(choices) < 2:
        raise ValueError(
            "At least two choices are required for a multiple-choice question."
        )
    if choice_delimiter is None:
        choice_delimiter = "\n"

    formatted_choices = [f"{chr(65 + i)}. {choice}" for i, choice in enumerate(choices)]
    return choice_delimiter.join(formatted_choices)


def doc_to_closure(fn: Callable[..., T]) -> Callable[..., T]:
    """Closure that allows the function to be called with 'self'."""

    @wraps(fn)
    def closure(self: Any, *args, **kwargs):
        return fn(*args, **kwargs)

    return closure