The PyPrind (Python Progress Indicator) module provides a progress bar and a percentage indicator object that let you track the progress of a loop structure or other iterative computation.
Typical applications include the processing of large data sets to provide an intuitive estimate
at runtime about the progress of the computation.
(Screenshot of Pypring executed in an IPython notebook)
Example demonstration videos:
You can use the following command to install PyPrind:
pip install pyprind
or
easy_install pyprind
Alternatively, you download the package manually from the Python Package Index https://pypi.python.org/pypi/PyPrind, unzip it, navigate into the package, and use the command:
python setup.py install
or
python3 setup.py install
PyPrind consists of two class objects that can visualize the progress of a computation on the output screen.
Progress bars are visualized via a ProgBar() object, and alternatively, the progress can be tracked and shown as percentage via a ProgPercent() object.
The general usage of ProgBar() and ProgPercent() consists of 2 basic steps:
1) initialize a new ProgBar() or ProgPercent() object with the number of iterations of the computation that is to be performed
2) update the ProgBar() or ProgPercent() object for each iteration via the .update()method
n = 10000000
my_prbar = pyprind.ProgBar(n) # 1) initialization with number of iterations
for i in range(n):
# do some computation
my_prbar.update() # 2) update the progress visualization
class ProgBar(Prog): """ Initializes a progress bar object that allows visuzalization of an iterational computation in the standard output screen. Keyword Arguments: iterations (int): number of iterations of the computation track_time (bool): default True. Prints elapsed time when loop has finished width (int): default 30. Sets the progress bar width in characters. stream (int): default 2. Takes 1 for stdout, 2 for stderr, or given stream object title (str): default ''. A title for the progress bar monitor (bool): default False. Monitors CPU and memory usage if True (requires 'psutil' package). """
class ProgPercent(Prog): """ Initializes a percentage indicator object that allows visuzalization of an iterational computation in the standard output screen. Keyword Arguments: iterations (int): number of iterations of the computation track_time (bool): default True. Prints elapsed time when loop has finished stream (int): default 2. Takes 1 for stdout, 2 for stderr, or given stream object title (str): default ''. A title for the progress bar monitor (bool): default False. Monitors CPU and memory usage if True (requires 'psutil' package). """
def update(self, iterations=1, item_id=None): """ Updates the progress bar / percentage indicator in every iteration of the task. Keyword arguments: iterations (int): default argument can be changed to integer values >=1 in order to update the progress indicators more than once per iteration. item_id (str): prints item id behind the progress bar. """
my_prog = pyprind.ProgBar(n, width=70) # default = 50
The optional track_time parameter can be set for both ProgBar() and ProgPercent() objects.
my_prbar = pyprind.ProgBar(n, track_time=False) # default = True
my_perc = pyprind.ProgPercent(n, track_time=False) # default = True
ProgBar objects will print the estimated time left and the total time
when the computation has finished.
ProgPercent objects reports the elapsed time during the computation and prints
the estimated finish time of the loop.
By default, pyprind objects writes output to the Standard error stream (stderr). If you
want to direct the output to the Standard output (stdout), you can initialize pyprind
with the argument stream=2.
my_prbar = pyprind.ProgBar(n, stream=1) # writes to stdout my_prbar = pyprind.ProgBar(n, stream=2) # writes to stderr, default
You can also just use a given stream by passing it directly:
Example:
my_prbar = pyprind.ProgBar(n, stream=self.stdout) # writes to given stream
If a tracking object is initialized with a title, it is printed when a new tracking
object is initialized.
The title and elapsed time can be printed via the print() function after the tracking has finished.
my_prbar = pyprind.ProgBar(n, title='My Progress Bar') Screen output: My Progress Bar 0% 100% [##############################] | ETA[sec]: 0.000
The print() function can be invoked after the tracking is completed to
print the title and elapsed time to the screen.
n = 1000000
my_bar = pyprind.ProgBar(n, title='My Progress Bar')
for i in range(n):
# do some computation
my_bar.update()
print('\n\nPrint tracking object ...\n')
print(my_bar)
Screen output:
My Progress Bar
0% 100%
[##############################] | ETA[sec]: 0.000
Total time elapsed: 6.399 sec
Title: My Progress Bar
Started: 04/18/2014 19:12:07
Finished: 04/18/2014 19:12:14
Total time elapsed: 6.399 sec
If we additionally want to print() the CPU and memory usage after a run has completed,
we have to set the monitor argument to True when we initialize a new tracking object. (Note: the monitor mode requires the psutil package.)
n = 1000000
my_bar = pyprind.ProgBar(n, title='My Progress Bar', monitor=True)
for i in range(n):
# do some computation
my_bar.update()
print('\n\nPrint tracking object ...\n')
print(my_bar)
Screen output:
My Progress Bar
0% 100%
[##############################] | ETA[sec]: 0.000
Total time elapsed: 6.391 sec
Title: My Progress Bar
Started: 04/18/2014 19:16:55
Finished: 04/18/2014 19:17:02
Total time elapsed: 6.391 sec
CPU %: 91.200000
Memory %: 0.098133
Django gives you a stdout object on the BaseCommand class. You will need to pass this to
pyprind as done above. Also note that by default, Django appends a newline to every write.
This uglyfies pyprind output, so ensure the write function gets passed ending="".
pyprind will NOT do this for you.
A subset of examples is given in the section below, more examples can be found in this IPython Demo Notebook.
import pyprind
n = 10000000
my_prbar = pyprind.ProgBar(n)
for i in range(n):
# do some computation
my_prbar.update()
Screen Output
sebastian > python3 ./examples/ex1_progress_bar.py 0% 100% [########################################] - ETA[sec]: 0.000 Total time elapsed: 4.481 sec
import pyprind
n = 1000000
my_perc = pyprind.ProgPercent(n)
for i in range(n):
# do some computation
my_perc.update()
Screen Output
sebastian > python3 ./examples/ex1_percentage_indicator.py [ 34 %] elapsed [sec]: 1.377 | ETA [sec]: 2.570
If you have any questions or comments about PyPrind, please feel free to contact me via
eMail: se.raschka@gmail.com
or Twitter: @rasbt
The pyprind module can be found on GitHub at https://github.com/rasbt/pyprind
VERSION 2.8.0
.stop() method to stop the progress bar / percentage indicator early..update() method accepts an item_id argument now in order to display
which item is currently processed next to the progress bar / percentage indicator.
E.g.,
Job1 0% 100% [####################] | ETA[sec]: 0.000 | Item ID: file_xyz.csv
VERSION 2.7.0
VERSION 2.6.2
VERSION 2.6.1
VERSION 2.6.0
VERSION 2.5.0
monitor=False was added to ProgBar() and ProgPercent() objects to monitor memory and CPU usage (via psutil) if monitor is set to True.VERSION 2.4.0
.update(iterations=1) methods to increment the count by more than 1 per
iteration.VERSION 2.3.1
VERSION 2.3.0
VERSION 2.2.0
VERSION 2.1.1
VERSION 2.1.0
VERSION 2.0.3
stream parameter.VERSION 2.0.2
ProgBar()
object was seeded with n=48VERSION 2.0.1
VERSION 2.0.0
Added ProgBar and ProgPerc default argument stream=2 to write to stderr by
default. Set stream=1 to write to stdout.
my_prbar = pyprind.ProgBar(n, stream=1) # writes to stdout my_prbar = pyprind.ProgBar(n, stream=2) # writes to stderr, default
Does not redirect data to the standard output or error stream if program is not outputting to a terminal
VERSION 1.1.1
VERSION 1.1.0
VERSION 1.0.4
VERSION 1.0.3
VERSION 1.0.2
VERSION 1.0.1