Enlighten Progress Bar

1.14.1 · active · verified Mon Apr 13

Enlighten Progress Bar is a console progress bar module for Python. It allows writing to stdout and stderr without any redirection, offering features for single or multiple progress bars, counters, and status bars, with experimental support for Jupyter Notebooks. As of version 1.14.1, it is actively maintained with regular updates and bug fixes.

Warnings

gotcha Terminal output can become scrambled or cut off if the number of progress bars exceeds terminal height, or if other threads/processes write to standard streams simultaneously with a resize event.
Fix: Close progress bars when complete, or manage terminal height; for multi-threaded/processed applications, ensure `threaded=True` is passed to `get_manager()` to defer resize handling if other writes are expected.
gotcha Enlighten does not work natively in the PyCharm Python console due to `sys.stdout` not referencing a valid TTY. It requires terminal emulation for 'Run' or 'Debug' modes.
Fix: Enable 'Emulate terminal in output console' in PyCharm run configurations (Run -> Edit Configurations -> Templates -> Python).
gotcha Progress bars created with a `Manager` might remain visible after `close()` is called if `leave=True` (the default) or `clear=True` is not explicitly used.
Fix: To remove a bar immediately upon closing, call `counter.close(clear=True)`. Alternatively, set `leave=False` when creating the counter if you want it to be removed automatically by `manager.stop()` or when other bars take its place.
gotcha Failing to call `manager.stop()` at the end of your program can leave progress bars on the terminal, consume resources, and prevent proper cleanup.
Fix: Always call `manager.stop()` when all progress bars are finished or use the `manager` as a context manager (`with enlighten.get_manager() as manager: ...`).
breaking Prior to version 1.12.0, the `elapsed` time on counters might continue to increment even after the counter was conceptually 'closed' or reached its total, leading to incorrect time measurements.
Fix: Upgrade to `enlighten` 1.12.0 or newer to ensure `elapsed` time accurately reflects active progress.
breaking Before version 0.14.0, the column position of the progress bar was not preserved when updating, always returning to the start of the line. This behavior changed to preserve column position.
Fix: If your application relied on the old behavior, adjust your output logic. For the new behavior, upgrade to `enlighten` 0.14.0 or newer.

Install

pip install enlighten Install with pip

Imports

get_manager
```
from enlighten import get_manager
```
The primary entry point for managing multiple progress bars.
Counter
```
from enlighten import Counter
```
Used for individual progress bars or counters, often instantiated via a manager.
Justify
```
from enlighten import Justify
```
An Enum used for justifying status bar text.

Quickstart

This example demonstrates how to use `enlighten` to create and manage multiple progress bars, allowing interleaved console output. It's crucial to call `manager.stop()` for proper cleanup.

import time
import enlighten

# Get a manager instance to handle multiple progress bars
manager = enlighten.get_manager()

# Create two counters/progress bars
ticks = manager.counter(total=100, desc='Ticks', unit='ticks')
tocks = manager.counter(total=20, desc='Tocks', unit='tocks')

for num in range(100):
    time.sleep(0.05) # Simulate work
    print(f"Working on item {num}") # Output outside progress bars

    ticks.update()
    if not num % 5:
        tocks.update()

# Ensure all progress bars are cleaned up from the terminal
manager.stop()

print("Process complete!")

view raw JSON →