Skip to main content

Module progress_columns

Module progress_columns 

Source
Expand description

11 progress column types: bar, text, spinner, time, file size, transfer speed. Progress column types — equivalent to Python Rich’s progress column system (SpinnerColumn, BarColumn, TextColumn, etc.).

Structs§

BarColumn
Renders the progress bar itself.
DownloadColumn
Shows “completed/total” with file size formatting.
FileSizeColumn
Shows the completed file size in human-readable format.
MofNCompleteColumn
Shows “completed / total” style.
SpinnerColumn
Shows a spinner for tasks that are not finished, and “✓” when complete.
TaskProgressColumn
Shows percentage complete as text.
TextColumn
Displays a formatted text field. The text is taken from task.fields["key"] and formatted with the given format string.
TimeElapsedColumn
Shows elapsed time since task started.
TimeRemainingColumn
Shows estimated time remaining.
TotalFileSizeColumn
Shows the total file size in human-readable format.
TransferSpeedColumn
Shows transfer speed in human-readable format (e.g., “1.5 MB/s”).

Traits§

ProgressColumn
A column in a progress display. Each column renders one cell per task.

Functions§

format_size
Format bytes into human-readable form using decimal (1000-based) units.
format_speed
Format a transfer speed (bytes per second) into human-readable form.