Columns

Progress columns for customizing bar layout. Pass a columns tuple via a runtime's backend_options (see the Customizing columns example) — entries are Rich ProgressColumns or format strings, and these are mqdm's own. Write your own by subclassing rich.progress.ProgressColumn.

mqdm.columns.TwoToneColumn

TwoToneColumn(
    *args, started_style: str | None = None, **kw
)

Bases: BarColumn

BarColumn that shades a task's started field as a second tone.

mqdm.columns.MofNColumn

MofNColumn(bytes=False, separator='/', **kw)

Bases: DownloadColumn

A progress column that shows the current vs. total count of items.

mqdm.columns.SpeedColumn

SpeedColumn(bytes=False, unit_scale=1, **kw)

Bases: TransferSpeedColumn

Renders human readable transfer speed.

render

render(task)

Show data transfer speed.

mqdm.columns.TimeElapsedColumn

TimeElapsedColumn(compact: bool = False, **kw)

Bases: TimeRemainingColumn

Renders time elapsed.

render

render(task)

Show time elapsed.

The following column objects are available from rich.progress:

• BarColumn Displays the bar.
• TextColumn Displays text.
• TimeElapsedColumn Displays the time elapsed.
• TimeRemainingColumn Displays the estimated time remaining.
• MofNCompleteColumn Displays completion progress as "{task.completed}/{task.total}" (works best if completed and total are ints).
• FileSizeColumn Displays progress as file size (assumes the steps are bytes).
• TotalFileSizeColumn Displays total file size (assumes the steps are bytes).
• DownloadColumn Displays download progress (assumes the steps are bytes).
• TransferSpeedColumn Displays transfer speed (assumes the steps are bytes).
• SpinnerColumn Displays a "spinner" animation.
• RenderableColumn Displays an arbitrary Rich renderable in the column.