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

$ seq 9999999 | tqdm --bytes | wc -l
75.2MB [00:00, 217MB/s]
9999999
$ tar -zcf - docs/ | tqdm --bytes --total `du -sb docs/ | cut -f1` \
backup.tgz
 32%|██████████▍                      | 8.89G/27.9G [00:42<01:31, 223MB/s]
`

2

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

$ seq 9999999 | tqdm --bytes | wc -l 75.2MB [00:00, 217MB/s] 9999999 $ tar -zcf - docs/ | tqdm --bytes --total `du -sb docs/ | cut -f1` \

backup.tgz

32%|██████████▍ | 8.89G/27.9G [00:42<01:31, 223MB/s]

Nội dung chính Show

`

3

Backing up a large directory?

$ seq 9999999 | tqdm --bytes | wc -l
75.2MB [00:00, 217MB/s]
9999999
$ tar -zcf - docs/ | tqdm --bytes --total `du -sb docs/ | cut -f1` \
backup.tgz
 32%|██████████▍                      | 8.89G/27.9G [00:42<01:31, 223MB/s]
`

4

This can be beautified further:

$ seq 9999999 | tqdm --bytes | wc -l 75.2MB [00:00, 217MB/s] 9999999 $ tar -zcf - docs/ | tqdm --bytes --total `du -sb docs/ | cut -f1` \

backup.tgz

32%|██████████▍ | 8.89G/27.9G [00:42<01:31, 223MB/s]

`

5

Or done on a file level using 7-zip:

$ seq 9999999 | tqdm --bytes | wc -l
75.2MB [00:00, 217MB/s]
9999999
$ tar -zcf - docs/ | tqdm --bytes --total `du -sb docs/ | cut -f1` \
backup.tgz
 32%|██████████▍                      | 8.89G/27.9G [00:42<01:31, 223MB/s]
`

6

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

$ seq 9999999 | tqdm --bytes | wc -l 75.2MB [00:00, 217MB/s] 9999999 $ tar -zcf - docs/ | tqdm --bytes --total `du -sb docs/ | cut -f1` \

backup.tgz

32%|██████████▍ | 8.89G/27.9G [00:42<01:31, 223MB/s]

`

7

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

• Consoles in general: require support for carriage return (CR, \r).
  • Some cloud logging consoles which don’t support \r properly (cloudwatch, K8s) may benefit fromexport TQDM_POSITION=-1.
• Nested progress bars:
  • Consoles in general: require support for moving cursors up to the previous line. For example, , ConEmu and PyCharm (also here, here, and ) lack full support.
  • Windows: additionally may require the Python module coloramato ensure nested bars stay within their respective lines.
• Unicode:
  • Environments which report that they support unicode will have solid smooth progressbars. The fallback is an ascii-only bar.
  • Windows consoles often only partially support unicode and thus (also here). This is due to either normal-width unicode characters being incorrectly displayed as “wide”, or some unicode characters not rendering.
• Wrapping generators:
  • Generator wrapper functions tend to hide the length of iterables.tqdm does not.
  • Replace tqdm(enumerate(...)) with enumerate(tqdm(...)) ortqdm(enumerate(x), total=len(x), ...). The same applies to numpy.ndenumerate.
  • Replace tqdm(zip(a, b)) with zip(tqdm(a), b) or evenzip(tqdm(a), tqdm(b)).
  • The same applies to itertools.
  • Some useful convenience functions can be found under tqdm.contrib.
• No intermediate output in docker-compose: use docker-compose run instead of docker-compose up and tty: true.
• Overriding defaults via environment variables: e.g. in CI/cloud jobs, export TQDM_MININTERVAL=5 to avoid log spam. This override logic is handled by the tqdm.utils.envwrap decorator (useful independent of tqdm).

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

(Since 19 May 2016)

$ seq 9999999 | tqdm --bytes | wc -l
75.2MB [00:00, 217MB/s]
9999999
$ tar -zcf - docs/ | tqdm --bytes --total `du -sb docs/ | cut -f1` \
backup.tgz
 32%|██████████▍                      | 8.89G/27.9G [00:42<01:31, 223MB/s]
`

8

#### 

iterableiterable, optional  
Iterable to decorate with a progressbar. Leave blank to manually manage the updates.
descstr, optional  
Prefix for the progressbar.
totalint or float, 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 number, e.g. 9e9.
leavebool, optional  
If \[default: True\], keeps all traces of the progressbar upon termination of iteration. If None, will leave only if position is 0.
fileio.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.
ncolsint, 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).
minintervalfloat, optional  
Minimum progress display update interval \[default: 0.1\] seconds.
maxintervalfloat, optional  
Maximum progress display update interval \[default: 10\] seconds. Automatically adjusts miniters to correspond to minintervalafter long display update lag. Only works if dynamic\_minitersor monitor thread is enabled.
minitersint or float, optional  
Minimum progress display update interval, in iterations. If 0 and dynamic\_miniters, will automatically adjust to equalmininterval (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.
asciibool or str, optional  
If unspecified or False, use unicode (smooth blocks) to fill the meter. The fallback is to use ASCII characters “ 123456789#”.
disablebool, optional  
Whether to disable the entire progressbar wrapper \[default: False\]. If set to None, disable on non-TTY.
unitstr, optional  
String that will be used to define the unit of each iteration \[default: it\].
unit\_scalebool 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\_ncolsbool, optional  
If set, constantly alters ncols and nrows to the environment (allowing for window resizes) \[default: False\].
smoothingfloat, 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\_formatstr, 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, 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, eta. Note that a trailing “: “ is automatically removed after {desc} if the latter is empty.
initialint or float, optional  
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.
positionint, 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).
postfixdict or \*, optional  
Specify additional stats to display at the end of the bar. Calls set\_postfix(\*\*postfix) if possible (dict).
unit\_divisorfloat, optional  
\[default: 1000\], ignored unless unit\_scale is True.
write\_bytesbool, optional  
Whether to write bytes. If (default: False) will write unicode.
lock\_argstuple, optional  
Passed to refresh for intermediate output (initialisation, iterating, and updating).
nrowsint, optional  
The screen height. If specified, hides nested bars outside this bound. If unspecified, attempts to use environment height. The fallback is 20.
colourstr, optional  
Bar colour (e.g. ‘green’, ‘
# 00ff00’).
delayfloat, optional  
Don’t display until \[default: 0\] seconds have elapsed.

#### 

out : decorated iterator.

$ seq 9999999 | tqdm --bytes | wc -l 75.2MB [00:00, 217MB/s] 9999999 $ tar -zcf - docs/ | tqdm --bytes --total `du -sb docs/ | cut -f1` \

backup.tgz

32%|██████████▍ | 8.89G/27.9G [00:42<01:31, 223MB/s]

`

9

pip install tqdm

0

pip install tqdm

1

The tqdm.contrib package also contains experimental modules:

• tqdm.contrib.itertools: Thin wrappers around itertools
• tqdm.contrib.concurrent: Thin wrappers around concurrent.futures
• tqdm.contrib.slack: Posts to Slack bots
• tqdm.contrib.discord: Posts to Discord bots
• tqdm.contrib.telegram: Posts to Telegram bots
• tqdm.contrib.bells: Automagically enables all optional features
  • auto, pandas, slack, discord, telegram

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

Custom information can be displayed and updated dynamically on tqdm bars with the desc and postfix arguments:

pip install tqdm

2

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
• 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 overridingformat_dict, and the bar itself may be modified using ascii:

pip install tqdm

3

pip install tqdm

4

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"

tqdm supports nested progress bars. Here’s an example:

pip install tqdm

5

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

pip install tqdm

6

Note that in Python 3, tqdm.write is thread-safe:

pip install tqdm

7

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.

[…]

pip install tqdm

8

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 writemethods, use CallbackIOWrapper:

pip install tqdm

9

Alternatively, use the even simpler wrapattr convenience function, which would condense both the urllib and CallbackIOWrapper examples down to:

pip install "git+https://github.com/tqdm/tqdm.git@devel
# egg=tqdm"

0

The requests equivalent is nearly identical:

pip install "git+https://github.com/tqdm/tqdm.git@devel
# egg=tqdm"

1

Custom callback

tqdm is known for intelligently skipping unnecessary displays. To make a custom callback take advantage of this, simply use the return value ofupdate(). This is set to True if a display() was triggered.

pip install "git+https://github.com/tqdm/tqdm.git@devel
# egg=tqdm"

2

Note that break isn’t currently caught by asynchronous iterators. This means that tqdm cannot clean up after itself in this case:

pip install "git+https://github.com/tqdm/tqdm.git@devel
# egg=tqdm"

3

Instead, either call pbar.close() manually or use the context manager syntax:

pip install "git+https://github.com/tqdm/tqdm.git@devel
# egg=tqdm"

4

Due to popular demand we’ve added support for pandas – here’s an example for DataFrame.progress_apply and DataFrameGroupBy.progress_apply:

pip install "git+https://github.com/tqdm/tqdm.git@devel
# egg=tqdm"

5

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

A keras callback is also available:

pip install "git+https://github.com/tqdm/tqdm.git@devel
# egg=tqdm"

6

A dask callback is also available:

pip install "git+https://github.com/tqdm/tqdm.git@devel
# egg=tqdm"

7

IPython/Jupyter is supported via the tqdm.notebook submodule:

pip install "git+https://github.com/tqdm/tqdm.git@devel
# egg=tqdm"

8

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:

pip install "git+https://github.com/tqdm/tqdm.git@devel
# egg=tqdm"

9

Note that this will issue a TqdmExperimentalWarning if run in a notebook since it is not meant to be possible to distinguish between jupyter notebookand 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, either