Source code for returns.generated.box

# -*- coding: utf-8 -*-


def _box(function):
    """
    Boxes function's input parameter from a regular value to a container.

    In other words, it modifies the function
    signature from: ``a -> Container[b]`` to: ``Container[a] -> Container[b]``

    This is how it should be used:

    .. code:: python

      >>> from returns.functions import box
      >>> from returns.maybe import Maybe, Some
      >>> def example(argument: int) -> Maybe[int]:
      ...     return Some(argument + 1)
      ...
      >>> box(example)(Some(1)) == Some(2)
      True

    """
    return lambda container: container.bind(function)