Python Progressbar2 Library

4.5.0 · active · verified Sun Mar 29

progressbar2 is an actively maintained Python library designed to provide visual, text-based progress bars for long-running operations in CLI applications. It is a fork of the original `progressbar` package, aiming for backwards compatibility while offering enhanced features and ongoing development. The current stable version is 4.5.0.

Warnings

gotcha The installed package is named `progressbar2`, but you must import `progressbar` in your Python code. Attempting to `import progressbar2` will result in an `ImportError`.
Fix: Always use `import progressbar` or `from progressbar import ...`.
gotcha In Jupyter notebooks or environments that buffer `sys.stdout`, the progress bar output might appear mixed or delayed.
Fix: To resolve this, explicitly flush stdout after updates or at critical points: `import sys; sys.stdout.flush()`.
gotcha When using Jetbrains IDEs (like PyCharm), especially for advanced features like `MultiBar` support or to prevent interleaved output between the progress bar (which often writes to stderr) and `print` statements (writing to stdout), you may need to enable 'Enable terminal in output console' in your run configuration. Alternatively, redirect the progress bar to `sys.stdout`.
Fix: In PyCharm, check 'Enable terminal in output console'. For code, consider `ProgressBar(fd=sys.stdout)` to unify output streams.

Install

pip install progressbar2 Install stable version

Imports

ProgressBar
```
from progressbar import ProgressBar
```
Despite the package being named `progressbar2`, the primary module to import is `progressbar`.
widgets
```
from progressbar import Bar, Percentage, ETA
```
Commonly imported widgets include `Bar`, `Percentage`, `ETA`, `Timer`, `AdaptiveETA`, etc.
progressbar
```
import progressbar
```
The top-level `progressbar` module can be imported directly, often used when wrapping iterables like `progressbar.progressbar(range(100))`.

Quickstart

This example demonstrates basic usage with the context manager pattern. It initializes a progress bar with a maximum value and updates it in a loop. The bar automatically handles starting and finishing.

import time
import progressbar

MAX_VALUE = 100

with progressbar.ProgressBar(max_value=MAX_VALUE) as bar:
    for i in range(MAX_VALUE):
        # Simulate a task
        time.sleep(0.02)
        bar.update(i + 1)

print("Task completed!")

view raw JSON →