Source code for fpylib.functors.functor

from typing import Any, Callable, Generic, Optional

from fpylib.curring import currify 
from fpylib.types import _S, _T


class Functor(Generic[_T]):
    """
    Class Functor is a generic class that implements the Functor type class.


    :param value: The value of the functor.
    :type value: T
    :return: A functor with the given value.
    """

    def __init__(self, value: Optional[_T] = None) -> None:
        """
        Initialize a functor with the given value.

        :param value: The value of the functor.
        :type value: Optional[T]
        :return: A functor with the given value.
        """

        def frozen_setattr(cls, __name: str, __value: Any) -> None:
            raise AttributeError("This object is not modifiable")

        object.__setattr__(self, "_Functor__value", value)
        object.__setattr__(self, "__setattr__", frozen_setattr)

    def get(self) -> _T:
        """
        Get the value of the functor.

        :return: The value of the functor.
        """
        return self.__value

    def fmap(self, func: Callable[["Functor[_T]"], "Functor[_S]"]) -> "Functor[_S]":
        """
        Apply a function to the value of the functor.

        :param func: The function to apply.
        :type func: Callable[["Functor[T]"], "Functor[S]"]
        :return: A functor with the value of the functor after applying the function.
        """
        return Functor(func(self.get()))


@currify
def fmap(func: Callable[[Functor[_T]], Functor[_S]], ft: Functor[_T]) -> Functor[_S]:
    """
    This function is a functor's fmap function.

    :param func: Callable[[Functor[T]], Functor[S]]
    :param ft: Functor[T]
    :return: Functor[S]
    """
    return ft.fmap(func)