pymonad.tools
index
/usr/home/jason/Files/projects/pymonad/pymonad/tools.py

The tools module contains useful functions that don't really belong anywhere else.

 
Modules
       
pymonad.monad

 
Functions
       
curry = _curry_internal(*arguments: List[Any])
Creates a curried function from a normal function of callable object.
 
The curry function is itself curried and can be partially
applied. It can be used either as a normal function call or as a
decorator. The required number_of_arguments parameter makes it
possible to curry functions which take a variable number of
arguments like the built-in 'map' function.
 
    Usage:
 
    curried_map = curry(2, map)
 
    @curry(2)
    def some_func(x, y, z):
        return x + y - z
 
Args:
    number_of_arguments: The number of arguments function_to_curry
    takes as input. If function_to_curry takes a variable number of
    arguments, then number of curried arguments desired in the
    result: function_to_curry will be called once this many
    arguments have been supplied.
    function_to_curry: The function that we wish to curry
 
Returns:
    A new function which may be partially applied simply by passing
    the desired number of arguments.
identity(value: ~T) -> ~T
Returns it's input value unchanged.
kleisli_compose(function_f: Callable[[~R], pymonad.monad.Monad[~S]], function_g: Callable[[~S], pymonad.monad.Monad[~T]]) -> Callable[[~R], pymonad.monad.Monad[~T]]
Composes two Kleisli functions.
 
Kleisli functions are functions which take as input a 'bare' value
and return an 'embellished' value. For instance, if we have a
function f which maps a's to b's, it's type is:
  f :: a -> b
 
Then the corresponding Kleisli function, f_kleisli has the type:
  f_kleisli :: a -> (b, m)
 
The type (b, m) corresponds to the internal representation of the
Monad class, so in terms of pymonad, a Kleisli function is one
which maps values of type a to values of some sub-class of Monad.
 
  Example:
    def fail_if_zero(x):
        return Nothing if x is zero else Just(x)
 
    def add1(x):
        return Just(x + 1)
 
    new_function = kleisli_compose(add1, fail_if_zero)
    new_function(0) # returns Just(1)
    new_function(-1) # returns Nothing
 
add1 and fail_if_zero are Kleisli functions and new_function is
the function which results from first performing add1 followed by
fail_if_zero.
 
Args:
  function_f: a function with type: a -> (b, m)
  function_g: a function with type: b -> (c, m)
 
Returns:
  A new Kleisli function with type: a -> (c, m)

 
Data
        Any = typing.Any
Callable = typing.Callable
List = typing.List
R = ~R
S = ~S
T = ~T