Skip to content

Pipeline

Apply arbitrary number of functions to instance in succession.

Parameters:

Name Type Description Default
instance Any

Scalar object.

 required
*functions Callable

Functions.

 ()

Returns:

Type Description
Any

Result of applying all function(s) to instance. Does not necessarily need to be the same type as it was at the start of the pipeline.

Examples:

>>> # works with unary function
>>> add_two = lambda x: x + 2
>>>
>>> # works with partial functions
>>> add_n = lambda x, n: x + n
>>>
>>> # works with closures
>>> def add_n(n: int) -> Callable:
>>>     def closure(x):
>>>         return x + n
>>>     return closure
>>>
>>> result = pipe(12, add_two, add_n(10), add_n(-4))
>>> assert result == 20
Source code in src/tidy_tools/workflow/pipeline.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
def pipe(instance: Any, *functions: Callable) -> Any:
    """
    Apply arbitrary number of functions to `instance` in succession.

    Parameters
    ----------
    instance : Any
        Scalar object.
    *functions : Callable
        Functions.

    Returns
    -------
    Any
        Result of applying all function(s) to `instance`. Does not necessarily
        need to be the same type as it was at the start of the pipeline.

    Examples
    --------
    >>> # works with unary function
    >>> add_two = lambda x: x + 2
    >>>
    >>> # works with partial functions
    >>> add_n = lambda x, n: x + n
    >>>
    >>> # works with closures
    >>> def add_n(n: int) -> Callable:
    >>>     def closure(x):
    >>>         return x + n
    >>>     return closure
    >>>
    >>> result = pipe(12, add_two, add_n(10), add_n(-4))
    >>> assert result == 20
    """
    return functools.reduce(lambda init, func: func(init), functions, instance)