Skip to content

progress

Classes:

Functions:

FPSColumn

Bases: ProgressColumn

Progress rendering.

Methods:

render 

render(task: Task) -> Text

Render bar.

Source code in vstools/functions/render/progress.py 
35
36
37
38
39
40
def render(self, task: Task) -> Text:
    """
    Render bar.
    """

    return Text(f"{task.speed or 0:.02f} fps")

RenderProgressCTX 

RenderProgressCTX(progress: Progress, task_id: TaskID)

Methods:

Attributes:

Source code in vstools/functions/render/progress.py 
44
45
46
def __init__(self, progress: Progress, task_id: TaskID) -> None:
    self.progress = progress
    self.task_id = task_id

progress instance-attribute 

progress = progress

task_id instance-attribute 

task_id = task_id

update 

update(
    completed: int | None = None,
    total: int | None = None,
    advance: int = 1,
    **kwargs: Any,
) -> None
Source code in vstools/functions/render/progress.py 
57
58
def update(self, completed: int | None = None, total: int | None = None, advance: int = 1, **kwargs: Any) -> None:
    return self.progress.update(self.task_id, completed=completed, total=total, advance=advance, **kwargs)

get_render_progress 

get_render_progress(
    *, console: Console | None = None, **kwargs: Any
) -> Progress

get_render_progress(
    title: str, total: int, console: Console = ..., **kwargs: Any
) -> RenderProgressCTX

get_render_progress(
    title: str | None = None,
    total: int | None = None,
    console: Console | None = None,
    **kwargs: Any,
) -> RenderProgressCTX | Progress

Return render progress.

Source code in vstools/functions/render/progress.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
def get_render_progress(
    title: str | None = None,
    total: int | None = None,
    console: Console | None = None,
    **kwargs: Any,
) -> RenderProgressCTX | Progress:
    """
    Return render progress.
    """

    if title and total:
        progress = get_render_progress(console=console, **kwargs)

        return RenderProgressCTX(progress, progress.add_task(title, True, total))

    return Progress(
        TextColumn("{task.description}"),
        BarColumn(),
        TextColumn("{task.completed}/{task.total}"),
        TextColumn("{task.percentage:>3.02f}%"),
        FPSColumn(),
        TimeElapsedColumn(),
        TimeRemainingColumn(),
        console=console or Console(stderr=True),
        **kwargs,
    )