Skip to content

tree_logger

Logging util for outputting function calls as trees!

This is currently exposed through the --tree-log pytest command, which will log each test case to stdout.

We log every method of the CLASSES, so to change what is logged, modify that list. Also, we color the statements, based on the class, using the CLASS_TO_COLOR mapping.

override_classes()

Override the getattribute on the classes we want to track, so that whenever a method is retrieved from them, it will wrap it in a logger first.

Source code in lineapy/utils/tree_logger.py 
108
109
110
111
112
113
114
def override_classes():
    """
    Override the __getattribute__ on the classes we want to track, so that whenever a method is retrieved from them,
    it will wrap it in a logger first.
    """
    for c in CLASSES:
        c.__getattribute__ = _tree_log_getattribute  # type: ignore

print_tree_log()

Print the tree log with rich.

Source code in lineapy/utils/tree_logger.py 
55
56
57
58
59
60
def print_tree_log() -> None:
    """
    Print the tree log with rich.
    """
    global TOP_TREE
    rich.print(TOP_TREE)

render_call(fn, args, kwargs)

Render the function, args, and kwargs as a string for printing with rich.

It uses some styles to color the classes and bold/underline the function names: https://rich.readthedocs.io/en/stable/style.html

Source code in lineapy/utils/tree_logger.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
def render_call(
    fn: Callable, args: Iterable[object], kwargs: Dict[str, object]
) -> str:
    """
    Render the function, args, and kwargs as a string for printing with rich.

    It uses some styles to color the classes and bold/underline the function names:
    https://rich.readthedocs.io/en/stable/style.html
    """
    qualname = fn.__qualname__
    parts = qualname.split(".")
    # If it's a classname.function, try coloring the classname
    if len(parts) == 2:
        cls_str, fn_str = parts
        colored_fn = f"[{CLASS_TO_COLOR.get(cls_str, 'black')}]{cls_str}.[bold underline]{fn_str}[/bold underline][/]"
    else:
        colored_fn = f"[bold underline]{qualname}[/bold underline]"

    args_str = ", ".join(
        [repr(a) for a in args] + [f"{k}={v}" for k, v in kwargs.items()]
    )
    return f"{colored_fn}({args_str})"

start_tree_log(label)

Starts logging, by overriding the classes, and also sets the top level label for the tree.

Source code in lineapy/utils/tree_logger.py 
45
46
47
48
49
50
51
52
def start_tree_log(label: str) -> None:
    """
    Starts logging, by overriding the classes, and also sets the top level label for the tree.
    """
    global TOP_TREE, CURRENT_TREE
    TOP_TREE = Tree(label=label)
    CURRENT_TREE = TOP_TREE
    override_classes()

tree_log(fn)

Decorator to enable logging for a function. Should preserve its behavior, but logs whenever it is called.

Source code in lineapy/utils/tree_logger.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
def tree_log(fn: C) -> C:
    """
    Decorator to enable logging for a function. Should preserve its behavior,
    but logs whenever it is called.
    """

    @wraps(fn)
    def inner(*args, **kwargs):
        global CURRENT_TREE
        assert CURRENT_TREE
        prev_tree = CURRENT_TREE
        CURRENT_TREE = CURRENT_TREE.add(render_call(fn, args, kwargs))
        res = fn(*args, **kwargs)
        if res is not None:
            CURRENT_TREE.add(f"{res}", style="bold")
        CURRENT_TREE = prev_tree
        return res

    return cast(C, inner)

Was this helpful?

Help us improve docs with your feedback!