Skip to content

Compose

Define and store pipeline as object to be executed.

Unlike pipe, compose will not evaluate when initialized. These are two separate steps. See Examples for more details.

Parameters:

Name Type Description Default
*functions Callable

Arbitrary number of functions to chain together.

 ()

Returns:

Type Description
Callable

Nested function in order of function(s) passed.

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
>>>
>>> summation = compose(add_two, add_n(10), add_n(-4))
>>> assert summation(12) == 20
Source code in src/tidy_tools/workflow/pipeline.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
def compose(*functions: Callable) -> Callable:
    """
    Define and store pipeline as object to be executed.

    Unlike `pipe`, `compose` will not evaluate when initialized.
    These are two separate steps. See Examples for more details.

    Parameters
    ----------
    *functions : Callable
        Arbitrary number of functions to chain together.

    Returns
    -------
    Callable
        Nested function in order of function(s) passed.

    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
    >>>
    >>> summation = compose(add_two, add_n(10), add_n(-4))
    >>> assert summation(12) == 20
    """
    return lambda instance: pipe(instance, *functions)