tqdm/README.md

1.3 KiB

tqdm

Instantly make your loops show a progress meter - just wrap any iterable with "tqdm(iterable)", and you're done!

ScreenShot

tqdm (read taqadum, تقدّم) means "progress" in arabic.

You can also use trange(N) as a shortcut for tqdm(xrange(N))

Here's the doc:

def tqdm(iterable, desc='', total=None, leave=False, mininterval=0.5, miniters=1):
    """
    Get an iterable object, and return an iterator which acts exactly like the
    iterable, but prints a progress meter and updates it every time a value is
    requested.
    'desc' can contain a short string, describing the progress, that is added
    in the beginning of the line.
    'total' can give the number of expected iterations. If not given,
    len(iterable) is used if it is defined.
    If leave is False, tqdm deletes its traces from screen after it has finished
    iterating over all elements.
    If less than mininterval seconds or miniters iterations have passed since
    the last progress meter update, it is not updated again.
    """

def trange(*args, **kwargs):
    """A shortcut for writing tqdm(xrange)"""
    return tqdm(xrange(*args), **kwargs)

Running tests

Please make sure tox (http://tox.testrun.org/) is installed and type tox from the command line