tqdm

tqdm(self, iterable=None, desc=None, total=None, leave=True, file=None, ncols=None, mininterval=0.1, maxinterval=10.0, miniters=None, ascii=None, disable=False, unit='it', unit_scale=False, dynamic_ncols=False, smoothing=0.3, bar_format=None, initial=0, position=None, postfix=None, unit_divisor=1000, write_bytes=None, gui=False, **kwargs)

Decorate an iterable object, returning an iterator which acts exactly like the original iterable, but prints a dynamically updating progressbar every time a value is requested.

__init__

tqdm.__init__(self, iterable=None, desc=None, total=None, leave=True, file=None, ncols=None, mininterval=0.1, maxinterval=10.0, miniters=None, ascii=None, disable=False, unit='it', unit_scale=False, dynamic_ncols=False, smoothing=0.3, bar_format=None, initial=0, position=None, postfix=None, unit_divisor=1000, write_bytes=None, gui=False, **kwargs)

Parameters

  • iterable : iterable, optional
    Iterable to decorate with a progressbar. Leave blank to manually manage the updates.
  • desc : str, optional
    Prefix for the progressbar.
  • total : int, optional
    The number of expected iterations. If unspecified, len(iterable) is used if possible. If float("inf") or as a last resort, only basic progress statistics are displayed (no ETA, no progressbar). If gui is True and this parameter needs subsequent updating, specify an initial arbitrary large positive integer, e.g. int(9e9).
  • leave : bool, optional
    If [default: True], keeps all traces of the progressbar upon termination of iteration. If None, will leave only if position is 0.
  • file : io.TextIOWrapper or io.StringIO, optional
    Specifies where to output the progress messages (default: sys.stderr). Uses file.write(str) and file.flush() methods. For encoding, see write_bytes.
  • ncols : int, optional
    The width of the entire output message. If specified, dynamically resizes the progressbar to stay within this bound. If unspecified, attempts to use environment width. The fallback is a meter width of 10 and no limit for the counter and statistics. If 0, will not print any meter (only stats).
  • mininterval : float, optional
    Minimum progress display update interval [default: 0.1] seconds.
  • maxinterval : float, optional
    Maximum progress display update interval [default: 10] seconds. Automatically adjusts miniters to correspond to mininterval after long display update lag. Only works if dynamic_miniters or monitor thread is enabled.
  • miniters : int, optional
    Minimum progress display update interval, in iterations. If 0 and dynamic_miniters, will automatically adjust to equal mininterval (more CPU efficient, good for tight loops). If > 0, will skip display of specified number of iterations. Tweak this and mininterval to get very efficient loops. If your progress is erratic with both fast and slow iterations (network, skipping items, etc) you should set miniters=1.
  • ascii : bool or str, optional
    If unspecified or False, use unicode (smooth blocks) to fill the meter. The fallback is to use ASCII characters " 123456789#".
  • disable : bool, optional
    Whether to disable the entire progressbar wrapper [default: False]. If set to None, disable on non-TTY.
  • unit : str, optional
    String that will be used to define the unit of each iteration [default: it].
  • unit_scale : bool or int or float, optional
    If 1 or True, the number of iterations will be reduced/scaled automatically and a metric prefix following the International System of Units standard will be added (kilo, mega, etc.) [default: False]. If any other non-zero number, will scale total and n.
  • dynamic_ncols : bool, optional
    If set, constantly alters ncols to the environment (allowing for window resizes) [default: False].
  • smoothing : float, optional
    Exponential moving average smoothing factor for speed estimates (ignored in GUI mode). Ranges from 0 (average speed) to 1 (current/instantaneous speed) [default: 0.3].
  • bar_format : str, optional
    Specify a custom bar string formatting. May impact performance. [default: '{l_bar}{bar}{r_bar}'], where l_bar='{desc}: {percentage:3.0f}%|' and r_bar='| {n_fmt}/{total_fmt} [{elapsed}<{remaining}, ' '{rate_fmt}{postfix}]' Possible vars: l_bar, bar, r_bar, n, n_fmt, total, total_fmt, percentage, rate, rate_fmt, rate_noinv, rate_noinv_fmt, rate_inv, rate_inv_fmt, elapsed, elapsed_s, remaining, remaining_s, desc, postfix, unit. Note that a trailing ": " is automatically removed after {desc} if the latter is empty.
  • initial : int, optional
    The initial counter value. Useful when restarting a progress bar [default: 0].
  • position : int, optional
    Specify the line offset to print this bar (starting from 0) Automatic if unspecified. Useful to manage multiple bars at once (eg, from threads).
  • postfix : dict or *, optional
    Specify additional stats to display at the end of the bar. Calls set_postfix(**postfix) if possible (dict).
  • unit_divisor : float, optional
    [default: 1000], ignored unless unit_scale is True.
  • write_bytes : bool, optional
    If (default: None) and file is unspecified, bytes will be written in Python 2. If True will also write bytes. In all other cases will default to unicode.
  • gui : bool, optional
    WARNING: internal parameter - do not use. Use tqdm_gui(...) instead. If set, will attempt to use matplotlib animations for a graphical output [default: False].

Returns

  • out : decorated iterator.

update

tqdm.update(self, n=1)

Manually update the progress bar, useful for streams such as reading files. E.g.:

>>> t = tqdm(total=filesize) # Initialise
>>> for current_buffer in stream:
...    ...
...    t.update(len(current_buffer))
>>> t.close()

The last line is highly recommended, but possibly not necessary if t.update() will be called in such a way that filesize will be exactly reached and printed.

Parameters

  • n : int, optional
    Increment to add to the internal counter of iterations [default: 1].

close

tqdm.close(self)

Cleanup and (if leave=False) close the progressbar.

clear

tqdm.clear(self, nolock=False)

Clear current bar display.

refresh

tqdm.refresh(self, nolock=False)

Force refresh the display of this bar.

unpause

tqdm.unpause(self)

Restart tqdm timer from last print time.

reset

tqdm.reset(self, total=None)

Resets to 0 iterations for repeated use.

Consider combining with leave=True.

Parameters

  • total : int, optional. Total to use for the new bar.

set_description

tqdm.set_description(self, desc=None, refresh=True)

Set/modify description of the progress bar.

Parameters

  • desc : str, optional
  • refresh : bool, optional
    Forces refresh [default: True].

set_description_str

tqdm.set_description_str(self, desc=None, refresh=True)

Set/modify description without ': ' appended.

set_postfix

tqdm.set_postfix(self, ordered_dict=None, refresh=True, **kwargs)

Set/modify postfix (additional stats) with automatic formatting based on datatype.

Parameters

  • ordered_dict : dict or OrderedDict, optional
  • refresh : bool, optional
    Forces refresh [default: True].
  • kwargs : dict, optional

set_postfix_str

tqdm.set_postfix_str(self, s='', refresh=True)

Postfix without dictionary expansion, similar to prefix handling.

write

tqdm.write(s, file=None, end='\n', nolock=False)

Print a message via tqdm (without overlap with bars).

format_dict

Public API for read-only member access.

pandas

tqdm.pandas(*targs, **tkwargs)

Registers the given tqdm class with pandas.core. ( frame.DataFrame | series.Series | groupby.(generic.)DataFrameGroupBy | groupby.(generic.)SeriesGroupBy ).progress_apply

A new instance will be create every time progress_apply is called, and each instance will automatically close() upon completion.

Parameters

targs, tkwargs : arguments for the tqdm instance

Examples

>>> import pandas as pd
>>> import numpy as np
>>> from tqdm import tqdm, tqdm_gui
>>>
>>> df = pd.DataFrame(np.random.randint(0, 100, (100000, 6)))
>>> tqdm.pandas(ncols=50)  # can use tqdm_gui, optional kwargs, etc
>>> # Now you can use `progress_apply` instead of `apply`
>>> df.groupby(0).progress_apply(lambda x: x**2)

References

https://stackoverflow.com/questions/18603270/ progress-indicator-during-pandas-operations-python

get_lock

tqdm.get_lock()

Get the global lock. Construct it if it does not exist.

set_lock

tqdm.set_lock(lock)

Set the global lock.

display

tqdm.display(self, msg=None, pos=None)

Use self.sp to display msg in the specified pos.

Consider overloading this function when inheriting to use e.g.: self.some_frontend(**self.format_dict) instead of self.sp.

Parameters

  • msg : str, optional. What to display (default: repr(self)).
  • pos : int, optional. Position to moveto
    (default: abs(self.pos)).

status_printer

tqdm.status_printer(file)

Manage the printing and in-place updating of a line of characters. Note that if the string is longer than a line, then in-place updating may not work (it will print a new line at each refresh).

external_write_mode

tqdm.external_write_mode(file=None, nolock=False)

Disable tqdm within context and refresh tqdm when exits. Useful when writing to standard output stream

format_interval

tqdm.format_interval(t)

Formats a number of seconds as a clock time, [H:]MM:SS

Parameters

  • t : int
    Number of seconds.

Returns

  • out : str
    [H:]MM:SS

format_meter

tqdm.format_meter(n, total, elapsed, ncols=None, prefix='', ascii=False, unit='it', unit_scale=False, rate=None, bar_format=None, postfix=None, unit_divisor=1000, **extra_kwargs)

Return a string-based progress bar given some parameters

Parameters

  • n : int
    Number of finished iterations.
  • total : int
    The expected total number of iterations. If meaningless (), only basic progress statistics are displayed (no ETA).
  • elapsed : float
    Number of seconds passed since start.
  • ncols : int, optional
    The width of the entire output message. If specified, dynamically resizes the progress meter to stay within this bound [default: None]. The fallback meter width is 10 for the progress bar + no limit for the iterations counter and statistics. If 0, will not print any meter (only stats).
  • prefix : str, optional
    Prefix message (included in total width) [default: '']. Use as {desc} in bar_format string.
  • ascii : bool, optional or str, optional
    If not set, use unicode (smooth blocks) to fill the meter [default: False]. The fallback is to use ASCII characters " 123456789#".
  • unit : str, optional
    The iteration unit [default: 'it'].
  • unit_scale : bool or int or float, optional
    If 1 or True, the number of iterations will be printed with an appropriate SI metric prefix (k = 10^3, M = 10^6, etc.) [default: False]. If any other non-zero number, will scale total and n.
  • rate : float, optional
    Manual override for iteration rate. If [default: None], uses n/elapsed.
  • bar_format : str, optional
    Specify a custom bar string formatting. May impact performance. [default: '{l_bar}{bar}{r_bar}'], where l_bar='{desc}: {percentage:3.0f}%|' and r_bar='| {n_fmt}/{total_fmt} [{elapsed}<{remaining}, ' '{rate_fmt}{postfix}]' Possible vars: l_bar, bar, r_bar, n, n_fmt, total, total_fmt, percentage, rate, rate_fmt, rate_noinv, rate_noinv_fmt, rate_inv, rate_inv_fmt, elapsed, elapsed_s, remaining, remaining_s, desc, postfix, unit. Note that a trailing ": " is automatically removed after {desc} if the latter is empty.
  • postfix : *, optional
    Similar to prefix, but placed at the end (e.g. for additional stats). Note: postfix is usually a string (not a dict) for this method, and will if possible be set to postfix = ', ' + postfix. However other types are supported (#382).
  • unit_divisor : float, optional
    [default: 1000], ignored unless unit_scale is True.

Returns

  • out : Formatted meter and stats, ready to display.

format_num

tqdm.format_num(n)

Intelligent scientific notation (.3g).

Parameters

  • n : int or float or Numeric
    A Number.

Returns

  • out : str
    Formatted number.

format_sizeof

tqdm.format_sizeof(num, suffix='', divisor=1000)

Formats a number (greater than unity) with SI Order of Magnitude prefixes.

Parameters

  • num : float
    Number ( >= 1) to format.
  • suffix : str, optional
    Post-postfix [default: ''].
  • divisor : float, optional
    Divisor between prefixes [default: 1000].

Returns

  • out : str
    Number with Order of Magnitude SI unit postfix.

Comparable

Comparable(self, /, *args, **kwargs)

Assumes child has self._comparable attr/@property