Text progress bar library for Python.
The package can be installed through pip (this is the recommended method):
pip install progressbar2
Or if pip is not available, easy_install should work as well:
Or download the latest release from Pypi (https://pypi.python.org/pypi/progressbar2) or Github.
Note that the releases on Pypi are signed with my GPG key (https://pgp.mit.edu/pks/lookup?op=vindex&search=0xE81444E9CE1F695D) and can be checked using GPG:
gpg --verify progressbar2-<version>.tar.gz.asc progressbar2-<version>.tar.gz
A text progress bar is typically used to display the progress of a long running operation, providing a visual cue that processing is underway.
The ProgressBar class manages the current progress, and the format of the line is given by a number of widgets. A widget is an object that may display differently depending on the state of the progress bar. There are many types of widgets:
The progressbar module is very easy to use, yet very powerful. It will also automatically enable features like auto-resizing when the system supports it.
Due to limitations in both the IDLE shell and the Jetbrains (Pycharm) shells this progressbar cannot function properly within those.
- The IDLE editor doesn't support these types of progress bars at all: https://bugs.python.org/issue23220
- The Jetbrains (Pycharm) editors partially work but break with fast output. As a workaround make sure you only write to either sys.stdout (regular print) or sys.stderr at the same time. If you do plan to use both, make sure you wait about ~200 milliseconds for the next output or it will break regularly. Linked issue: https://github.com/WoLpH/python-progressbar/issues/115
- Package homepage
- My blog
There are many ways to use Python Progressbar, you can see a few basic examples here but there are many more in the examples file.
Wrapping an iterable
import time import progressbar bar = progressbar.ProgressBar() for i in bar(range(100)): time.sleep(0.02)
Progressbars with logging
Progressbars with logging require stderr redirection _before_ the StreamHandler is initialized. To make sure the stderr stream has been redirected on time make sure to call progressbar.streams.wrap_stderr() before you initialize the logger.
One option to force early initialization is by using the WRAP_STDERR environment variable, on Linux/Unix systems this can be done through:
# WRAP_STDERR=true python your_script.py
In most cases the following will work as well, as long as you initialize the StreamHandler after the wrapping has taken place.
import time import logging import progressbar progressbar.streams.wrap_stderr() logging.basicConfig() bar = progressbar.ProgressBar() for i in bar(range(10)): logging.error('Got %d', i) time.sleep(0.2)
import time import progressbar with progressbar.ProgressBar(max_value=10) as bar: for i in range(10): time.sleep(0.1) bar.update(i)
Combining progressbars with print output
import time import progressbar bar = progressbar.ProgressBar(redirect_stdout=True) for i in range(100): print 'Some text', i time.sleep(0.1) bar.update(i)
Progressbar with unknown length
import time import progressbar bar = progressbar.ProgressBar(max_value=progressbar.UnknownLength) for i in range(20): time.sleep(0.1) bar.update(i)
Bar with custom widgets
import time import progressbar bar = progressbar.ProgressBar(widgets=[ ' [', progressbar.Timer(), '] ', progressbar.Bar(), ' (', progressbar.ETA(), ') ', ]) for i in bar(range(20)): time.sleep(0.1)