PyPrind

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.

Installation

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

Documentation

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

Optional parameters :

Default Parameters

ProgBar(iterations, track_time=True, width=50, stream=2):

    iterations (int): number of iterations of the computation
    track_time (bool): prints elapsed time when loop has finished
    stream: takes 1 for stdout, 2 for stderr, or given stream object


ProgPercent(iterations, track_time=True, stream=2):

    iterations (int): number of iterations of the computation
    width (int): width of the progress bar in characters
    track_time (bool): prints elapsed time and estimated time left
    stream: takes 1 for stdout, 2 for stderr, or given stream object

Setting the width of the progress bar

my_prog = pyprind.ProgBar(n, width=70) # default = 50

Set whether CPU time should be reported or not

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 elapsed time when the computation has finished.
ProgPercent objects reports the elapsed time during the computation and prints
the estimated finish time of the loop (see section "Examples - ProgPercent").

Selecting an output stream

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

If you want to use a given stream, just pass that. Example:

my_prbar = pyprint.ProgBar(n, stream=self.stdout)  # writes to given stream

Small note on usage in a custom Django management command.

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.

Examples

The following examples shall illustrate the typical usage of the PyPrind package.
A visualization can be viewed on YouTube: http://youtu.be/GC2J0SMmiWQ

Example - Progress Bar

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%
[########################################]
Total time elapsed: 1.033 sec

Example - Percentage Indicator

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 
[ 12 %]   elapsed: 2.095 sec | eta: 16.000 sec

Contact

If you have any questions or comments about PyPrind, please feel free to contact me via
eMail: se.raschka@gmail.com
or Twitter: @rasbt

Changelog

VERSION 2.1.0

• added ETA (estimated time until arrival) tracking by Taylan Aydinli

VERSION 2.0.3

• Accepts a given outputstream for the stream parameter.

VERSION 2.0.2

• Fixed bug that occurred for some Python 3.3.3 users specifically on Linux Red Hat 4.4.7-1, GCC v. 4.4.7 that self.max_iter was cast to a float when ProgBar() object was seeded with n=48

VERSION 2.0.1

• fixed packaging of example files

VERSION 2.0.0

• ProgBar and ProgPerc inherit data members from parent class Prog

• 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

• fixed problem with packaging of example scripts

VERSION 1.1.0

• Added live time tracking to percentage indicator
• progress bar and percentage indicator complete automatically, .finish() was removed

VERSION 1.0.4

• Added boundary that .update() can't print over the right progress bar limit.
• Prints warning when ProgBar seed exits the number of iterations in the loop.

VERSION 1.0.3

• Reformatting of README files
• minor updates in setup.py file

VERSION 1.0.2

• corrected errors in the README files
• added docstring to the init.py

VERSION 1.0.1

• added more README formats
• added class descriptions
• added example scripts to the distribution