Reference

Find constructor arguments, methods and command-line options for the part of progressbar2 you are using. Each reference explains the available controls and links to the corresponding classes and functions.

Bars and parallel work

Configure a ProgressBar

Set the value range, widgets, output stream and redraw intervals. Look up ProgressBar methods and the related DataTransferBar, NullBar and FastProgressBar classes.

Manage rows with MultiBar

Control labels, row ordering and the display of waiting and finished jobs. MultiBar keeps the child bars together and redraws them from its background thread.

Choose a parallel execution API

Look up map, imap, amap and the other batch helpers. Compare worker pools, result ordering, concurrency limits and error handling, including reusable Pool and AsyncPool objects.

Widgets, commands and modules

Find the widget for your display

Choose a percentage, timer, transfer speed or live value by what you need to show. The widget table identifies which displays need a known total, with a runnable example for each widget.

Percentage, Bar, ETA, Variable

Look up command-line options

Track bytes or lines moving through a pipe or between files with the progressbar command. Check size, rate and output options, including the compatibility flags that are accepted but have no effect.

progressbar and bar name the same command.

Browse the full module listing

Find classes, functions and modules in the generated API documentation, including helpers beyond the focused reference pages above.

progressbar.bar, progressbar.multi, progressbar.widgets