progressbar

2.5 · abandoned · verified Wed Apr 15

The `progressbar` library (version 2.5) provides text-based progress bars for long-running operations in Python. This version is largely unmaintained and is compatible only with Python 2. For modern Python projects, the actively maintained `progressbar2` library is recommended, which offers backward compatibility and Python 3 support.

Warnings

breaking The `progressbar` (version 2.5) library is Python 2 only. It will not run on Python 3 environments without significant modifications or, more practically, replacement. Python 2 reached its end-of-life in 2020.
Fix: Migrate to `progressbar2` (pip install progressbar2), which is Python 3 compatible and actively maintained.
deprecated The original `progressbar` library is abandoned and unmaintained. Its development ceased, leading to the creation of `progressbar2` as a direct, backward-compatible fork.
Fix: Always use `progressbar2` for new projects or when updating existing projects. Install via `pip install progressbar2`.
gotcha Installing `progressbar` via `pip install progressbar` will install the old, abandoned Python 2-only version (2.5). Users intending to use an actively maintained progress bar library for Python 3 should explicitly install `progressbar2`.
Fix: To get the modern, maintained version, use `pip install progressbar2`. The import statement remains `import progressbar` for `progressbar2` due to backward compatibility.
gotcha Progress bars might not update visually during runtime in certain environments (e.g., some IDEs, Jupyter notebooks, or when long-running tasks block the event loop in GUI applications). This can lead to the bar appearing only at the end or updating erratically.
Fix: Ensure the output stream (typically `sys.stderr`) is flushed, or consider running long tasks in a separate thread if using GUI toolkits like Tkinter. The `progressbar2` library also offers `with progressbar.ProgressBar(...) as bar:` for better handling.

Install

pip install progressbar For original progressbar (Python 2 only)
pip install progressbar2 Recommended for Python 3 (maintained fork)

Imports

ProgressBar
```
import progressbar; pbar = progressbar.ProgressBar()
```
While `from progressbar import ProgressBar` might work in some contexts, the idiomatic usage often involves importing the module directly and accessing classes/functions through it, especially for widgets. For `progressbar2`, the context manager is a common pattern.

Quickstart

This quickstart demonstrates a basic progress bar with several common widgets. While `progressbar` (v2.5) is Python 2 only, this code is illustrative of the general API. For Python 3, it is critical to use `progressbar2` (pip install progressbar2) as a replacement. The `ProgressBar` class manages the progress, and various `widgets` define the display format.

import time
import progressbar

def main():
    print("Using progressbar (v2.5) for demonstration (Python 2 example if run directly)")
    print("**It is HIGHLY recommended to use 'progressbar2' instead: pip install progressbar2**\n")

    # This quickstart pattern is derived from progressbar2 examples,
    # which aims for backward compatibility with the original 'progressbar'.
    widgets = [
        'Test: ', progressbar.Percentage(),
        ' ', progressbar.Bar(marker=progressbar.RotatingMarker()),
        ' ', progressbar.ETA(),
        ' ', progressbar.FileTransferSpeed(),
    ]

    # For Python 2, range(100) is fine. For Python 3, use list(range(100)) or ensure xrange behavior.
    # As this library is Python 2, simple range is shown.
    bar = progressbar.ProgressBar(widgets=widgets, maxval=100).start()
    for i in range(100):
        # Simulate some work
        time.sleep(0.01)
        bar.update(i + 1)
    bar.finish()

    print("\nExample complete.")

if __name__ == '__main__':
    main()

view raw JSON →