Skip to content

cli_app.utils.progress

cli_app.utils.progress

generate_progress_bar 

generate_progress_bar(
    *columns,
    console="project",
    auto_refresh=True,
    refresh_per_second=1,
    speed_estimate_period=30.0,
    transient=False,
    redirect_stdout=True,
    redirect_stderr=True,
    get_time=None,
    disable=False,
    expand=False,
)

Build a Rich Progress bar, using the project console by default or an internal one.

Source code in src/cli_app/utils/progress.py 
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
41
42
43
44
def generate_progress_bar(
    *columns: str | ProgressColumn,
    console: Literal["internal", "project"] | Console = "project",
    auto_refresh: bool = True,
    refresh_per_second: float = 1,
    speed_estimate_period: float = 30.0,
    transient: bool = False,
    redirect_stdout: bool = True,
    redirect_stderr: bool = True,
    get_time: Callable[[], float] | None = None,
    disable: bool = False,
    expand: bool = False,
) -> Progress:
    """Build a Rich Progress bar, using the project console by default or an internal one."""
    resolved_console: Console | None
    if console == "project":
        resolved_console = get_console()
    elif console == "internal":
        resolved_console = None
    else:
        raise RuntimeError("Incorrect console type")

    return Progress(
        *columns,
        console=resolved_console,
        auto_refresh=auto_refresh,
        refresh_per_second=refresh_per_second,
        speed_estimate_period=speed_estimate_period,
        transient=transient,
        redirect_stdout=redirect_stdout,
        redirect_stderr=redirect_stderr,
        get_time=get_time,
        disable=disable,
        expand=expand,
    )