Skip to content

References

pipable

This package try to mimic pipe operation by overriding the bitwise-or operator, turn it into an infix function that take the output of previous expression as the first argument of the current function.

Pipe

Bases: object

This class create the Pipe object that mimic pipe operation:

  • instatiate by creating partial of existing function
  • turn the bitwise-or operator | into an infix function that accept the output of previous expression. ie. pipe operator
Source code in pipable/__init__.py 
 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
class Pipe(object):
    """This class create the `Pipe` object that mimic pipe operation:

    - instatiate by creating partial of existing function
    - turn the bitwise-or operator `|` into an infix function that accept the output of previous expression.
    ie. pipe operator
    """

    def __init__(self, func: Callable, /, *args, **kwargs) -> None:
        """create pipable partial for the target func

        Args:
            func (Callable): func to be pipable
        """
        self.pipe = partial(func, *args, **kwargs)

    def __ror__(self, precedent: Any):
        """override the builit-in `|` operator, turn it into pipe"""
        # return partial(self.func, precedent)
        return self.pipe(precedent)

    def __rrshift__(self, precedent: Iterable):
        """override the builit-in `>>` operator, pass precedent as destructured iterable to the pipe"""
        return self.pipe(*precedent)

    def __rlshift__(self, precedent: dict):
        """override the builit-in `<<` operator, pass as destructured dict to the pipe"""
        return self.pipe(**precedent)

    def __call__(self, *args, **kwargs):
        """replace arguments of the pipable partial"""
        return Pipe(self.pipe.func, *args, **kwargs)

__call__(*args, **kwargs)

replace arguments of the pipable partial

Source code in pipable/__init__.py 
38
39
40
def __call__(self, *args, **kwargs):
    """replace arguments of the pipable partial"""
    return Pipe(self.pipe.func, *args, **kwargs)

__init__(func: Callable, /, *args, **kwargs) -> None

create pipable partial for the target func

Parameters:

Name Type Description Default
func Callable

func to be pipable

 required
Source code in pipable/__init__.py 
17
18
19
20
21
22
23
def __init__(self, func: Callable, /, *args, **kwargs) -> None:
    """create pipable partial for the target func

    Args:
        func (Callable): func to be pipable
    """
    self.pipe = partial(func, *args, **kwargs)

__rlshift__(precedent: dict)

override the builit-in << operator, pass as destructured dict to the pipe

Source code in pipable/__init__.py 
34
35
36
def __rlshift__(self, precedent: dict):
    """override the builit-in `<<` operator, pass as destructured dict to the pipe"""
    return self.pipe(**precedent)

__ror__(precedent: Any)

override the builit-in | operator, turn it into pipe

Source code in pipable/__init__.py 
25
26
27
28
def __ror__(self, precedent: Any):
    """override the builit-in `|` operator, turn it into pipe"""
    # return partial(self.func, precedent)
    return self.pipe(precedent)

__rrshift__(precedent: Iterable)

override the builit-in >> operator, pass precedent as destructured iterable to the pipe

Source code in pipable/__init__.py 
30
31
32
def __rrshift__(self, precedent: Iterable):
    """override the builit-in `>>` operator, pass precedent as destructured iterable to the pipe"""
    return self.pipe(*precedent)