ubelt.progiter module

A Progress Iterator:

The API is compatible with TQDM!

We have our own ways of running too! You can divide the runtime overhead by two as many times as you want.

CommandLine:

python -m ubelt.progiter __doc__:0

Example

>>> # SCRIPT
>>> import ubelt as ub
>>> def is_prime(n):
...     return n >= 2 and not any(n % i == 0 for i in range(2, n))
>>> for n in ub.ProgIter(range(1000000), verbose=1):
>>>     # do some work
>>>     is_prime(n)

class ubelt.progiter.ProgIter(iterable=None, desc=None, total=None, freq=1, initial=0, eta_window=64, clearline=True, adjust=True, time_thresh=2.0, show_times=True, enabled=True, verbose=None, stream=None, **kwargs)

Bases: ubelt.progiter._TQDMCompat, ubelt.progiter._BackwardsCompat

Prints progress as an iterator progresses

Note

USE tqdm INSTEAD. The main difference between ProgIter and tqdm is that ProgIter does not use threading where as tqdm does. ProgIter is simpler than tqdm and thus more stable in certain circumstances. However, tqdm is recommended for the majority of use cases.

Note

The API on ProgIter will change to become inter-compatible with tqdm.

Variables:

• iterable (iterable) – An iterable iterable
• desc (str) – description label to show with progress
• total (int) – Maximum length of the process (estimated from iterable if not specified)
• freq (int) – How many iterations to wait between messages.
• adjust (bool) – if True freq is adjusted based on time_thresh
• eta_window (int) – number of previous measurements to use in eta calculation
• clearline (bool) – if true messages are printed on the same line
• adjust – if True freq is adjusted based on time_thresh
• time_thresh (float) – desired amount of time to wait between messages if adjust is True otherwise does nothing
• show_times (bool) – shows rate, eta, and wall (defaults to True)
• initial (int) – starting index offset (defaults to 0)
• stream (file) – defaults to sys.stdout
• enabled (bool) – if False nothing happens.
• verbose (int) – verbosity mode 0 - no verbosity, 1 - verbosity with clearline=True and adjust=True 2 - verbosity without clearline=False and adjust=True 3 - verbosity without clearline=False and adjust=False

SeeAlso:

tqdm - https://pypi.python.org/pypi/tqdm

Reference:

http://datagenetics.com/blog/february12017/index.html

Notes

Either use ProgIter in a with statement or call prog.end() at the end of the computation if there is a possibility that the entire iterable may not be exhausted.

Example

>>> 
>>> import ubelt as ub
>>> def is_prime(n):
...     return n >= 2 and not any(n % i == 0 for i in range(2, n))
>>> for n in ub.ProgIter(range(100), verbose=1):
>>>     # do some work
>>>     is_prime(n)
100/100... rate=... Hz, total=..., wall=... EST

set_extra(extra)

specify a custom info appended to the end of the next message TODO: come up with a better name and rename

Example

>>> import ubelt as ub
>>> prog = ub.ProgIter(range(100, 300, 100), show_times=False, verbose=3)
>>> for n in prog:
>>>     prog.set_extra('processesing num {}'.format(n))
0/2...
1/2...processesing num 100
2/2...processesing num 200

step(inc=1)

Manually step progress update, either directly or by an increment.

Parameters:

• idx (int) – current step index (default None) if specified, takes precidence over inc
• inc (int) – number of steps to increment (defaults to 1)

Example

>>> import ubelt as ub
>>> n = 3
>>> prog = ub.ProgIter(desc='manual', total=n, verbose=3)
>>> # Need to manually begin and end in this mode
>>> prog.begin()
>>> for _ in range(n):
...     prog.step()
>>> prog.end()

Example

>>> import ubelt as ub
>>> n = 3
>>> # can be used as a context manager in manual mode
>>> with ub.ProgIter(desc='manual', total=n, verbose=3) as prog:
...     for _ in range(n):
...         prog.step()

begin()

Initializes information used to measure progress

end()

format_message()

builds a formatted progres message with the current values. This contains the special characters needed to clear lines.

CommandLine:

python -m ubelt.progiter ProgIter.format_message

Example

>>> self = ProgIter(clearline=False, show_times=False)
>>> print(repr(self.format_message()))
'    0/?... \n'
>>> self.begin()
>>> self.step()
>>> print(repr(self.format_message()))
' 1/?... \n'

ensure_newline()

use before any custom printing when using the progress iter to ensure your print statement starts on a new line instead of at the end of a progress line

Example

>>> # Unsafe version may write your message on the wrong line
>>> import ubelt as ub
>>> prog = ub.ProgIter(range(4), show_times=False, verbose=1)
>>> for n in prog:
...     print('unsafe message')
 0/4...  unsafe message
 1/4...  unsafe message
unsafe message
unsafe message
 4/4...
>>> # apparently the safe version does this too.
>>> print('---')
---
>>> prog = ub.ProgIter(range(4), show_times=False, verbose=1)
>>> for n in prog:
...     prog.ensure_newline()
...     print('safe message')
 0/4...
safe message
 1/4...
safe message
safe message
safe message
 4/4...

display_message()

Writes current progress to the output stream