Skip to content

error_handler

handle_user_errors(function)

Decorator that catches user errors and displays friendly messages without stack traces.

Why

CLI commands should show clean error messages for expected user errors (invalid YAML, missing files) while preserving stack traces for unexpected errors. This decorator wraps all command functions.

Example 
@app.command()
@handle_user_errors
def my_command():
    # Any RenderCVUserError gets caught and displayed cleanly
    pass

Parameters:

  • function (Callable[P, None]) –

    CLI command function to wrap.

Returns:

  • Callable[P, None] –

    Wrapped function with error handling.

Source code in src/rendercv/cli/error_handler.py 
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
41
42
43
44
45
46
47
48
49
50
51
def handle_user_errors[T, **P](function: Callable[P, None]) -> Callable[P, None]:
    """Decorator that catches user errors and displays friendly messages without stack traces.

    Why:
        CLI commands should show clean error messages for expected user errors
        (invalid YAML, missing files) while preserving stack traces for
        unexpected errors. This decorator wraps all command functions.

    Example:
        ```py
        @app.command()
        @handle_user_errors
        def my_command():
            # Any RenderCVUserError gets caught and displayed cleanly
            pass
        ```

    Args:
        function: CLI command function to wrap.

    Returns:
        Wrapped function with error handling.
    """

    @functools.wraps(function)
    def wrapper(*args: P.args, **kwargs: P.kwargs) -> None:
        try:
            return function(*args, **kwargs)
        except RenderCVUserError as e:
            if e.message:
                print(
                    rich.panel.Panel(
                        e.message,
                        title="[bold red]Error[/bold red]",
                        title_align="left",
                        border_style="bold red",
                    )
                )
            raise typer.Exit(code=1) from e

    return wrapper