Skip to content

node_deployer.debug

debug_guard(f)

A decorator that contextually enables debug mode for the decorated function

Parameters:

Name Type Description Default
f Callable

The function to decorate

 required

Raises:

Type Description
Exit

Exit CLI if the dev group is not installed

Returns:

Name Type Description
Callable Callable

The decorated function
Source code in src/node_deployer/debug.py 
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
41
42
43
44
45
46
47
48
49
50
51
def debug_guard(f: Callable) -> Callable:
    """A decorator that contextually enables debug mode for the decorated function

    Args:
        f (Callable): The function to decorate

    Raises:
        typer.Exit: Exit CLI if the dev group is not installed

    Returns:
        Callable: The decorated function
    """
    if not config.DEBUG:
        return f
    try:
        import snoop  # type: ignore
    except ImportError:
        typer.echo("Debug mode requires the dev group to be installed")
        raise typer.Exit(1)
    else:
        snoop.install(**config.snoop["install"])

    @wraps(f)
    def debug_mode(
        *args,
        **kwargs,
    ) -> Callable:
        typer.echo(f"Debug mode enabled: {inspect.stack()[1].filename}")
        debug_f = get_debug_f(f)
        if kwargs.get("debug", False):
            # Snoop depth is set to compensate for wrapper stack frames
            return debug_f(*args, **kwargs)
        else:
            return f(*args, **kwargs)

    return debug_mode
Last update: November 7, 2023
Created: November 7, 2023