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.
- Download
Column - Shows “completed/total” with file size formatting.
- File
Size Column - Shows the completed file size in human-readable format.
- MofN
Complete Column - Shows “completed / total” style.
- Spinner
Column - Shows a spinner for tasks that are not finished, and “✓” when complete.
- Task
Progress Column - Shows percentage complete as text.
- Text
Column - Displays a formatted text field. The text is taken from
task.fields["key"]and formatted with the given format string. - Time
Elapsed Column - Shows elapsed time since task started.
- Time
Remaining Column - Shows estimated time remaining.
- Total
File Size Column - Shows the total file size in human-readable format.
- Transfer
Speed Column - Shows transfer speed in human-readable format (e.g., “1.5 MB/s”).
Traits§
- Progress
Column - 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.