progress_panel

CompletedStep(timing_ms, message, paths) dataclass

message instance-attribute

paths instance-attribute

timing_ms instance-attribute

ProgressPanel(quiet=False)

Bases: Live

Live-updating terminal panel showing CV generation progress with timing.

Example

with ProgressPanel(quiet=False) as progress:
    progress.update_progress("50", "Generated PDF", [Path("cv.pdf")])
    progress.finish_progress()
# Displays: ✓ 50 ms   Generated PDF: ./cv.pdf

Parameters:

• quiet (bool, default: False ) –

  Suppress all terminal output.

Source code in src/rendercv/cli/render_command/progress_panel.py

def __init__(self, quiet: bool = False):
    self.quiet = quiet
    self.completed_steps: list[CompletedStep] = []
    super().__init__(
        rich.panel.Panel(
            "...",
            title="Rendering your CV...",
            title_align="left",
            border_style="bright_black",
        ),
        refresh_per_second=4,
    )

completed_steps = [] instance-attribute

quiet = quiet instance-attribute

clear()

Clear all completed steps and panel display.

Source code in src/rendercv/cli/render_command/progress_panel.py

def clear(self) -> None:
    """Clear all completed steps and panel display."""
    self.completed_steps.clear()
    self.update("")

finish_progress()

Display final success panel and clear state.

Source code in src/rendercv/cli/render_command/progress_panel.py

def finish_progress(self) -> None:
    """Display final success panel and clear state."""
    self.print_progress_panel(title="Your CV is ready")
    self.completed_steps.clear()

print_progress_panel(title)

Render progress panel with all completed steps.

Parameters:

• title (str) –

  Panel title text.

Source code in src/rendercv/cli/render_command/progress_panel.py

def print_progress_panel(self, title: str) -> None:
    """Render progress panel with all completed steps.

    Args:
        title: Panel title text.
    """
    if self.quiet:
        return

    lines: list[str] = []
    for step in self.completed_steps:
        paths_str = ""
        if step.paths:
            with contextlib.suppress(ValueError):
                step.paths = [
                    path.relative_to(pathlib.Path.cwd()) for path in step.paths
                ]
            paths_as_strings = [f"./{path}" for path in step.paths]
            paths_str = "; ".join(paths_as_strings)

        timing = f"[bold green]{step.timing_ms + ' ms':<8}[/bold green]"
        message = step.message + (": " if paths_str else ".")
        paths_display = f"[purple]{paths_str}[/purple]" if paths_str else ""
        lines.append(f"[green]✓[/green] {timing} {message:<26} {paths_display}")

    content = "\n".join(lines) if lines else "Rendering..."

    self.update(
        rich.panel.Panel(
            content,
            title=title,
            title_align="left",
            border_style="bright_black",
        )
    )

print_user_error(user_error)

Display error panel and exit with error code.

Parameters:

• user_error (RenderCVUserError) –

  User-facing error to display.

Source code in src/rendercv/cli/render_command/progress_panel.py

def print_user_error(self, user_error: RenderCVUserError) -> None:
    """Display error panel and exit with error code.

    Args:
        user_error: User-facing error to display.
    """
    self.clear()
    self.update(
        rich.panel.Panel(
            user_error.message or "An unknown error occurred.",
            title="[bold red]Error[/bold red]",
            title_align="left",
            border_style="bold red",
        )
    )
    raise typer.Exit(code=1)

print_validation_errors(errors)

Display validation errors in table format and exit.

Why

Pydantic validation errors are parsed into user-friendly messages with YAML locations. Table shows exactly which field failed and why.

Parameters:

• errors (list[RenderCVValidationError]) –

  List of validation errors with location, input, and message.

Source code in src/rendercv/cli/render_command/progress_panel.py

def print_validation_errors(self, errors: list[RenderCVValidationError]) -> None:
    """Display validation errors in table format and exit.

    Why:
        Pydantic validation errors are parsed into user-friendly messages with
        YAML locations. Table shows exactly which field failed and why.

    Args:
        errors: List of validation errors with location, input, and message.
    """
    self.completed_steps.clear()
    table = rich.table.Table(expand=True, show_lines=True, box=rich.box.ROUNDED)
    table.add_column("Location", style="cyan", no_wrap=True)
    table.add_column("Input Value", style="magenta", no_wrap=True)
    table.add_column("Explanation", style="orange4")

    for error_object in errors:
        table.add_row(
            ".".join(error_object.location),
            error_object.input,
            error_object.message,
        )

    self.update(
        rich.panel.Panel(
            table,
            title="[bold red]There are errors in the input file![/bold red]",
            title_align="left",
            border_style="bold red",
        )
    )

    raise typer.Exit(code=1)

update_progress(time_took, message, paths)

Add completed step to progress display.

Parameters:

• time_took (str) –

  Execution time in milliseconds as string.

• message (str) –

  Step description.

• paths (list[Path]) –

  Generated file paths to display.

Source code in src/rendercv/cli/render_command/progress_panel.py

def update_progress(
    self, time_took: str, message: str, paths: list[pathlib.Path]
) -> None:
    """Add completed step to progress display.

    Args:
        time_took: Execution time in milliseconds as string.
        message: Step description.
        paths: Generated file paths to display.
    """
    self.completed_steps.append(CompletedStep(time_took, message, paths))
    self.print_progress_panel(title="Rendering your CV...")