1TQDM(1) TQDM(1)
2
6 tqdm - fast, extensible progress bar for Python and CLI
7
9 tqdm [options]
10
12 See <https://github.com/tqdm/tqdm>. Can be used as a pipe:
13 $ # count lines of code
15 $ cat *.py | tqdm | wc -l
16 327it [00:00, 981773.38it/s]
17 327
18 $ # find all files
20 $ find . -name "*.py" | tqdm | wc -l
21 432it [00:00, 833842.30it/s]
22 432
23 # ... and more info
25 $ find . -name '*.py' -exec wc -l \{} \; \
26 | tqdm --total 432 --unit files --desc counting \
27 | awk '{ sum += $1 }; END { print sum }'
28 counting: 100%|█████████| 432/432 [00:00<00:00, 794361.83files/s]
29 131998
30
32 -h, --help
33 Print this help and exit
34 -v, --version
36 Print version and exit
37 --desc=desc
39 str, optional. Prefix for the progressbar.
40 --total=total
42 int, optional. The number of expected iterations. If unspeci‐
43 fied, len(iterable) is used if possible. As a last resort, only
44 basic progress statistics are displayed (no ETA, no progress‐
45 bar). If gui is True and this parameter needs subsequent updat‐
46 ing, specify an initial arbitrary large positive integer, e.g.
47 int(9e9).
48 --leave=leave
50 bool, optional. If [default: True], keeps all traces of the
51 progressbar upon termination of iteration.
52 --ncols=ncols
54 int, optional. The width of the entire output message. If
55 specified, dynamically resizes the progressbar to stay within
56 this bound. If unspecified, attempts to use environment width.
57 The fallback is a meter width of 10 and no limit for the counter
58 and statistics. If 0, will not print any meter (only stats).
59 --mininterval=mininterval
61 float, optional. Minimum progress display update interval [de‐
62 fault: 0.1] seconds.
63 --maxinterval=maxinterval
65 float, optional. Maximum progress display update interval [de‐
66 fault: 10] seconds. Automatically adjusts miniters to corre‐
67 spond to mininterval after long display update lag. Only works
68 if dynamic_miniters or monitor thread is enabled.
69 --miniters=miniters
71 int, optional. Minimum progress display update interval, in it‐
72 erations. If 0 and dynamic_miniters, will automatically adjust
73 to equal mininterval (more CPU efficient, good for tight loops).
74 If > 0, will skip display of specified number of iterations.
75 Tweak this and mininterval to get very efficient loops. If your
76 progress is erratic with both fast and slow iterations (network,
77 skipping items, etc) you should set miniters=1.
78 --ascii=ascii
80 bool, optional. If unspecified or False, use unicode (smooth
81 blocks) to fill the meter. The fallback is to use ASCII charac‐
82 ters 1-9 #.
83 --disable=disable
85 bool, optional. Whether to disable the entire progressbar wrap‐
86 per [default: False]. If set to None, disable on non-TTY.
87 --unit=unit
89 str, optional. String that will be used to define the unit of
90 each iteration [default: it].
91 --unit_scale=unit_scale
93 bool or int or float, optional. If 1 or True, the number of it‐
94 erations will be reduced/scaled automatically and a metric pre‐
95 fix following the International System of Units standard will be
96 added (kilo, mega, etc.) [default: False]. If any other non-ze‐
97 ro number, will scale total and n.
98 --dynamic_ncols=dynamic_ncols
100 bool, optional. If set, constantly alters ncols to the environ‐
101 ment (allowing for window resizes) [default: False].
102 --smoothing=smoothing
104 float, optional. Exponential moving average smoothing factor
105 for speed estimates (ignored in GUI mode). Ranges from 0 (aver‐
106 age speed) to 1 (current/instantaneous speed) [default: 0.3].
107 --bar_format=bar_format
109 str, optional. Specify a custom bar string formatting. May im‐
110 pact performance. [default: '{l_bar}{bar}{r_bar}'], where
111 l_bar='{desc}: {percentage:3.0f}%|' and r_bar='| {n_fmt}/{to‐
112 tal_fmt} [{elapsed}<{remaining}, ' '{rate_fmt}{postfix}]' Possi‐
113 ble vars: l_bar, bar, r_bar, n, n_fmt, total, total_fmt, per‐
114 centage, rate, rate_fmt, rate_noinv, rate_noinv_fmt, rate_inv,
115 rate_inv_fmt, elapsed, remaining, desc, postfix. Note that a
116 trailing ": " is automatically removed after {desc} if the lat‐
117 ter is empty.
118 --initial=initial
120 int, optional. The initial counter value. Useful when restart‐
121 ing a progress bar [default: 0].
122 --position=position
124 int, optional. Specify the line offset to print this bar
125 (starting from 0) Automatic if unspecified. Useful to manage
126 multiple bars at once (eg, from threads).
127 --postfix=postfix
129 dict or *, optional. Specify additional stats to display at the
130 end of the bar. Calls set_postfix(**postfix) if possible
131 (dict).
132 --unit_divisor=unit_divisor
134 float, optional. [default: 1000], ignored unless unit_scale is
135 True.
136 --delim=delim
138 chr, optional. Delimiting character [default: '']. Use '' for
139 null. N.B.: on Windows systems, Python converts '' to ''.
140 --buf_size=buf_size
142 int, optional. String buffer size in bytes [default: 256] used
143 when delim is specified.
144 --bytes=bytes
146 bool, optional. If true, will count bytes, ignore delim, and
147 default unit_scale to True, unit_divisor to 1024, and unit to
148 'B'.
149 --manpath=manpath
151 str, optional. Directory in which to install tqdm man pages.
152 --log=log
154 str, optional. CRITICAL|FATAL|ERROR|WARN(ING)|[default: 'IN‐
155 FO']|DEBUG|NOTSET.
156
158 tqdm developers <https://github.com/tqdm>.
159tqdm User Manuals 2015-2018 TQDM(1)