tqdm derives from the Arabic word taqaddum (تقدّم) which can mean “progress,” and is an abbreviation for “I love you so much” in Spanish (te quiero demasiado).

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

76%|████████████████████████ | 7568/10000 [00:33<00:10, 229.00it/s]

trange(N) can be also used as a convenient shortcut for tqdm(range(N)) .

It can also be executed as a module with pipes:

Overhead is low – about 60ns per iteration (80ns with tqdm.gui ), and is unit tested against performance regression. By comparison, the well-established ProgressBar has an 800ns/iter overhead.

In addition to its low overhead, tqdm uses smart algorithms to predict the remaining time and to skip unnecessary iteration displays, which allows for a negligible overhead in most cases.

tqdm works on any platform (Linux, Windows, Mac, FreeBSD, NetBSD, Solaris/SunOS), in any console or in a GUI, and is also friendly with IPython/Jupyter notebooks.

tqdm does not require any dependencies (not even curses !), just Python and an environment supporting carriage return \r and line feed

control characters.

There are other (unofficial) places where tqdm may be downloaded, particularly for CLI use:

Note than snap binaries are purely for CLI use (not import -able), and automatically set up bash tab-completion.

There are 3 channels to choose from:

Pull and install in the current directory:

The list of all changes is available either on GitHub’s Releases: , on the wiki , or on the website .

Pre-existing CLI programs already outputting basic progress information will benefit from tqdm ’s --update and --update_to flags:

Or done on a file level using 7-zip:

This can be beautified further:

Note that the usual arguments for tqdm can also be specified.

The example below demonstrated counting the number of lines in all Python files in the current directory, with timing information included.

Perhaps the most wonderful use of tqdm is in a script or on the command line. Simply inserting tqdm (or python -m tqdm ) between pipes will pass through all stdin to stdout while printing progress to stderr .

with is also optional (you can just assign tqdm() to a variable, but in this case don’t forget to del or close() at the end:

If the optional variable total (or an iterable with len() ) is provided, predictive stats are displayed.

Manual control of tqdm() updates using a with statement:

Instantiation outside of the loop allows for manual control over tqdm() :

tqdm is very versatile and can be used in a number of ways. The three main ones are given below.

If you come across any other difficulties, browse and file .

The most common issues relate to excessive output on multiple lines, instead of a neat one-line progress bar.

""" A shortcut for `tqdm(xrange(*args), **tqdm_kwargs)`. On Python3+, `range` is used instead of `xrange`. """

""" stream : file-like object. method : str, "read" or "write". The result of ``read()`` and the first argument of ``write()`` should have a ``len()``. >>> with tqdm.wrapattr(file_obj, "read", total=file_obj.size) as fobj: ... while True: ... chunk = fobj.read(chunk_size) ... if not chunk: ... break """

""" 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)``). """

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

""" 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 """

""" Resets to 0 iterations for repeated use. Consider combining with ``leave=True``. Parameters ---------- total : int or float, optional. Total to use for the new bar. """

""" Force refresh the display of this bar. Parameters ---------- nolock : bool, optional If ``True``, does not lock. If [default: ``False``]: calls ``acquire()`` on internal lock. lock_args : tuple, optional Passed to internal lock's ``acquire()``. If specified, will only ``display()`` if ``acquire()`` returns ``True``. """

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

""" 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 or float, optional Increment to add to the internal counter of iterations [default: 1]. If using float, consider specifying ``{n:.3f}`` or similar in ``bar_format``, or specifying ``unit_scale``. Returns ------- out : bool or None True if a ``display()`` was triggered. """

The screen height. If specified, hides nested bars outside this bound. If unspecified, attempts to use environment height. The fallback is 20.

Passed to refresh for intermediate output (initialisation, iterating, and updating).

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.

[default: 1000], ignored unless unit_scale is True.

Specify additional stats to display at the end of the bar. Calls set_postfix(**postfix) if possible (dict).

Specify the line offset to print this bar (starting from 0) Automatic if unspecified. Useful to manage multiple bars at once (eg, from threads).

The initial counter value. Useful when restarting a progress bar [default: 0]. If using float, consider specifying {n:.3f} or similar in bar_format , or specifying unit_scale .

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, elapsed, elapsed_s, ncols, nrows, desc, unit, rate, rate_fmt, rate_noinv, rate_noinv_fmt, rate_inv, rate_inv_fmt, postfix, unit_divisor, remaining, remaining_s. Note that a trailing “: ” is automatically removed after {desc} if the latter is empty.

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].

If set, constantly alters ncols and nrows to the environment (allowing for window resizes) [default: False].

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 .

String that will be used to define the unit of each iteration [default: it].

Whether to disable the entire progressbar wrapper [default: False]. If set to None, disable on non-TTY.

If unspecified or False, use unicode (smooth blocks) to fill the meter. The fallback is to use ASCII characters ” 123456789#”.

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.

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.

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).

Specifies where to output the progress messages (default: sys.stderr). Uses file.write(str) and file.flush() methods. For encoding, see write_bytes .

If [default: True], keeps all traces of the progressbar upon termination of iteration. If None , will leave only if position is 0 .

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 number, e.g. 9e9.

Iterable to decorate with a progressbar. Leave blank to manually manage the updates.

""" 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. """

The tqdm.contrib package also contains experimental modules:

See the examples folder;

import the module and run help() ;

; consult the wiki; this has an excellent article on how to make a great progressbar;

check out the slides from PyData London, or

run the or .

Description and additional stats Custom information can be displayed and updated dynamically on tqdm bars with the desc and postfix arguments: from tqdm import tqdm , trange from random import random , randint from time import sleep with trange ( 10 ) as t : for i in t : # Description will be displayed on the left t . set_description ( 'GEN %i ' % i ) # Postfix will be displayed on the right, # formatted automatically based on argument's datatype t . set_postfix ( loss = random (), gen = randint ( 1 , 999 ), str = 'h' , lst = [ 1 , 2 ]) sleep ( 0.1 ) with tqdm ( total = 10 , bar_format = " {postfix[0]} {postfix[1][value]:>8.2g} " , postfix = [ "Batch" , dict ( value = 0 )]) as t : for i in range ( 10 ): sleep ( 0.1 ) t . postfix [ 1 ][ "value" ] = i / 2 t . update () Points to remember when using {postfix[...]} in the bar_format string: postfix also needs to be passed as an initial argument in a compatible format, and

also needs to be passed as an initial argument in a compatible format, and postfix will be auto-converted to a string if it is a dict -like object. To prevent this behaviour, insert an extra item into the dictionary where the key is not a string. Additional bar_format parameters may also be defined by overriding format_dict , and the bar itself may be modified using ascii : from tqdm import tqdm class TqdmExtraFormat ( tqdm ): """Provides a `total_time` format parameter""" @property def format_dict ( self ): d = super ( TqdmExtraFormat , self ) . format_dict total_time = d [ "elapsed" ] * ( d [ "total" ] or 0 ) / max ( d [ "n" ], 1 ) d . update ( total_time = self . format_interval ( total_time ) + " in total" ) return d for i in TqdmExtraFormat ( range ( 9 ), ascii = " .oO0" , bar_format = " {total_time} : {percentage:.0f} %| {bar}{r_bar} " ): if i == 4 : break 00:00 in total: 44%|0000. | 4/9 [00:00<00:00, 962.93it/s] Note that {bar} also supports a format specifier [width][type] . width unspecified (default): automatic to fill ncols int >= 0 : fixed width overriding ncols logic int < 0 : subtract from the automatic default

type a : ascii ( ascii=True override) u : unicode ( ascii=False override) b : blank ( ascii=" " override)

This means a fixed bar with right-justified text may be created by using: bar_format="{l_bar}{bar:10}|{bar:-10b}right-justified"

Nested progress bars tqdm supports nested progress bars. Here’s an example: from tqdm.auto import trange from time import sleep for i in trange ( 4 , desc = '1st loop' ): for j in trange ( 5 , desc = '2nd loop' ): for k in trange ( 50 , desc = '3rd loop' , leave = False ): sleep ( 0.01 ) On Windows colorama will be used if available to keep nested bars on their respective lines. For manual control over positioning (e.g. for multi-processing use), you may specify position=n where n=0 for the outermost bar, n=1 for the next, and so on. However, it’s best to check if tqdm can work without manual position first. from time import sleep from tqdm import trange , tqdm from multiprocessing import Pool , freeze_support L = list ( range ( 9 )) def progresser ( n ): interval = 0.001 / ( n + 2 ) total = 5000 text = "# {} , est. {:<04.2} s" . format ( n , interval * total ) for _ in trange ( total , desc = text , position = n ): sleep ( interval ) if __name__ == '__main__' : freeze_support () # for Windows support p = Pool ( initializer = tqdm . set_lock , initargs = ( tqdm . get_lock (),)) p . map ( progresser , L ) Note that in Python 3, tqdm.write is thread-safe: from time import sleep from tqdm import tqdm , trange from concurrent.futures import ThreadPoolExecutor L = list ( range ( 9 )) def progresser ( n ): interval = 0.001 / ( n + 2 ) total = 5000 text = "# {} , est. {:<04.2} s" . format ( n , interval * total ) for _ in trange ( total , desc = text ): sleep ( interval ) if n == 6 : tqdm . write ( "n == 6 completed." ) tqdm . write ( "`tqdm.write()` is thread-safe in py3!" ) if __name__ == '__main__' : with ThreadPoolExecutor () as p : p . map ( progresser , L )

Hooks and callbacks tqdm can easily support callbacks/hooks and manual updates. Here’s an example with urllib : ``urllib.urlretrieve`` documentation […] If present, the hook function will be called once on establishment of the network connection and once after each block read thereafter. The hook will be passed three arguments; a count of blocks transferred so far, a block size in bytes, and the total size of the file. […] import urllib , os from tqdm import tqdm class TqdmUpTo ( tqdm ): """Provides `update_to(n)` which uses `tqdm.update(delta_n)`.""" def update_to ( self , b = 1 , bsize = 1 , tsize = None ): """ b : int, optional Number of blocks transferred so far [default: 1]. bsize : int, optional Size of each block (in tqdm units) [default: 1]. tsize : int, optional Total size (in tqdm units). If [default: None] remains unchanged. """ if tsize is not None : self . total = tsize return self . update ( b * bsize - self . n ) # also sets self.n = b * bsize eg_link = "https://caspersci.uk.to/matryoshka.zip" with TqdmUpTo ( unit = 'B' , unit_scale = True , unit_divisor = 1024 , miniters = 1 , desc = eg_link . split ( '/' )[ - 1 ]) as t : # all optional kwargs urllib . urlretrieve ( eg_link , filename = os . devnull , reporthook = t . update_to , data = None ) t . total = t . n Inspired by twine#242. Functional alternative in examples/tqdm_wget.py. It is recommend to use miniters=1 whenever there is potentially large differences in iteration speed (e.g. downloading a file over a patchy connection). Wrapping read/write methods To measure throughput through a file-like object’s read or write methods, use CallbackIOWrapper : from tqdm.auto import tqdm from tqdm.utils import CallbackIOWrapper with tqdm ( total = file_obj . size , unit = 'B' , unit_scale = True , unit_divisor = 1024 ) as t : fobj = CallbackIOWrapper ( t . update , file_obj , "read" ) while True : chunk = fobj . read ( chunk_size ) if not chunk : break t . reset () # ... continue to use `t` for something else Alternatively, use the even simpler wrapattr convenience function, which would condense both the urllib and CallbackIOWrapper examples down to: import urllib , os from tqdm import tqdm eg_link = "https://caspersci.uk.to/matryoshka.zip" with tqdm . wrapattr ( open ( os . devnull , "wb" ), "write" , miniters = 1 , desc = eg_link . split ( '/' )[ - 1 ]) as fout : for chunk in urllib . urlopen ( eg_link ): fout . write ( chunk ) The requests equivalent is nearly identical, albeit with a total : import requests , os from tqdm import tqdm eg_link = "https://caspersci.uk.to/matryoshka.zip" response = requests . get ( eg_link , stream = True ) with tqdm . wrapattr ( open ( os . devnull , "wb" ), "write" , miniters = 1 , desc = eg_link . split ( '/' )[ - 1 ], total = int ( response . headers . get ( 'content-length' , 0 ))) as fout : for chunk in response . iter_content ( chunk_size = 4096 ): fout . write ( chunk ) Custom callback tqdm is known for intelligently skipping unnecessary displays. To make a custom callback take advantage of this, simply use the return value of update() . This is set to True if a display() was triggered. from tqdm.auto import tqdm as std_tqdm def external_callback ( * args , ** kwargs ): ... class TqdmExt ( std_tqdm ): def update ( self , n = 1 ): displayed = super ( TqdmExt , self ) . update ( n ): if displayed : external_callback ( ** self . format_dict ) return displayed

Pandas Integration Due to popular demand we’ve added support for pandas – here’s an example for DataFrame.progress_apply and DataFrameGroupBy.progress_apply : import pandas as pd import numpy as np from tqdm import tqdm df = pd . DataFrame ( np . random . randint ( 0 , 100 , ( 100000 , 6 ))) # Register `pandas.progress_apply` and `pandas.Series.map_apply` with `tqdm` # (can use `tqdm.gui.tqdm`, `tqdm.notebook.tqdm`, optional kwargs, etc.) tqdm . pandas ( desc = "my bar!" ) # Now you can use `progress_apply` instead of `apply` # and `progress_map` instead of `map` df . progress_apply ( lambda x : x ** 2 ) # can also groupby: # df.groupby(0).progress_apply(lambda x: x**2) In case you’re interested in how this works (and how to modify it for your own callbacks), see the examples folder or import the module and run help() .

Keras Integration A keras callback is also available: from tqdm.keras import TqdmCallback ... model . fit ( ... , verbose = 0 , callbacks = [ TqdmCallback ()])

IPython/Jupyter Integration IPython/Jupyter is supported via the tqdm.notebook submodule: from tqdm.notebook import trange , tqdm from time import sleep for i in trange ( 3 , desc = '1st loop' ): for j in tqdm ( range ( 100 ), desc = '2nd loop' ): sleep ( 0.01 ) In addition to tqdm features, the submodule provides a native Jupyter widget (compatible with IPython v1-v4 and Jupyter), fully working nested bars and colour hints (blue: normal, green: completed, red: error/interrupt, light blue: no ETA); as demonstrated below. The notebook version supports percentage or pixels for overall width (e.g.: ncols='100%' or ncols='480px' ). It is also possible to let tqdm automatically choose between console or notebook versions by using the autonotebook submodule: from tqdm.autonotebook import tqdm tqdm . pandas () Note that this will issue a TqdmExperimentalWarning if run in a notebook since it is not meant to be possible to distinguish between jupyter notebook and jupyter console . Use auto instead of autonotebook to suppress this warning. Note that notebooks will display the bar in the cell where it was created. This may be a different cell from the one where it is used. If this is not desired, the creation of the bar must be delayed/moved to the cell where it is desired to be displayed. Another possibility is to have a single bar (near the top of the notebook) which is constantly re-used (using reset() rather than close() ). For this reason, the notebook version (unlike the CLI version) does not automatically call close() upon Exception . from tqdm.notebook import tqdm pbar = tqdm () # different cell iterable = range ( 100 ) pbar . reset ( total = len ( iterable )) # initialise with new `total` for i in iterable : pbar . update () pbar . refresh () # force print final status but don't `close()`

Custom Integration To change the default arguments (such as making dynamic_ncols=True ), simply use built-in Python magic: from functools import partial from tqdm import tqdm as std_tqdm tqdm = partial ( std_tqdm , dynamic_ncols = True ) For further customisation, tqdm may be inherited from to create custom callbacks (as with the TqdmUpTo example above) or for custom frontends (e.g. GUIs such as notebook or plotting packages). In the latter case: def __init__() to call super().__init__(..., gui=True) to disable terminal status_printer creation. Redefine: close() , clear() , display() . Consider overloading display() to use e.g. self.frontend(**self.format_dict) instead of self.sp(repr(self)) . Some submodule examples of inheritance which don’t (yet) strictly conform to the above recommendation: tqdm/notebook.py

tqdm/gui.py

tqdm/contrib/telegram.py

tqdm/contrib/discord.py

Dynamic Monitor/Meter You can use a tqdm as a meter which is not monotonically increasing. This could be because n decreases (e.g. a CPU usage monitor) or total changes. One example would be recursively searching for files. The total is the number of objects found so far, while n is the number of those objects which are files (rather than folders): from tqdm import tqdm import os.path def find_files_recursively ( path , show_progress = True ): files = [] # total=1 assumes `path` is a file t = tqdm ( total = 1 , unit = "file" , disable = not show_progress ) if not os . path . exists ( path ): raise IOError ( "Cannot find:" + path ) def append_found_file ( f ): files . append ( f ) t . update () def list_found_dir ( path ): """returns os.listdir(path) assuming os.path.isdir(path)""" listing = os . listdir ( path ) # subtract 1 since a "file" we found was actually this directory t . total += len ( listing ) - 1 # fancy way to give info without forcing a refresh t . set_postfix ( dir = path [ - 10 :], refresh = False ) t . update ( 0 ) # may trigger a refresh return listing def recursively_search ( path ): if os . path . isdir ( path ): for f in list_found_dir ( path ): recursively_search ( os . path . join ( path , f )) else : append_found_file ( path ) recursively_search ( path ) t . set_postfix ( dir = path ) t . close () return files Using update(0) is a handy way to let tqdm decide when to trigger a display refresh to avoid console spamming.

Writing messages This is a work in progress (see #737). Since tqdm uses a simple printing mechanism to display progress bars, you should not write any message in the terminal using print() while a progressbar is open. To write messages in the terminal without any collision with tqdm bar display, a .write() method is provided: from tqdm.auto import tqdm , trange from time import sleep bar = trange ( 10 ) for i in bar : # Print using tqdm class method .write() sleep ( 0.1 ) if not ( i % 3 ): tqdm . write ( "Done task %i " % i ) # Can also use bar.write() By default, this will print to standard output sys.stdout . but you can specify any file-like object using the file argument. For example, this can be used to redirect the messages writing to a log file or class.

Redirecting writing If using a library that can print messages to the console, editing the library by replacing print() with tqdm.write() may not be desirable. In that case, redirecting sys.stdout to tqdm.write() is an option. To redirect sys.stdout , create a file-like class that will write any input string to tqdm.write() , and supply the arguments file=sys.stdout, dynamic_ncols=True . A reusable canonical example is given below: from time import sleep import contextlib import sys from tqdm import tqdm from tqdm.contrib import DummyTqdmFile @contextlib . contextmanager def std_out_err_redirect_tqdm (): orig_out_err = sys . stdout , sys . stderr try : sys . stdout , sys . stderr = map ( DummyTqdmFile , orig_out_err ) yield orig_out_err [ 0 ] # Relay exceptions except Exception as exc : raise exc # Always restore sys.stdout/err if necessary finally : sys . stdout , sys . stderr = orig_out_err def some_fun ( i ): print ( "Fee, fi, fo," . split ()[ i ]) # Redirect stdout to tqdm.write() (don't forget the `as save_stdout`) with std_out_err_redirect_tqdm () as orig_stdout : # tqdm needs the original stdout # and dynamic_ncols=True to autodetect console width for i in tqdm ( range ( 3 ), file = orig_stdout , dynamic_ncols = True ): sleep ( . 5 ) some_fun ( i ) # After the `with`, printing is restored print ( "Done!" )