Mercurial > repos > rliterman > csp2

comparison CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/lib/python3.8/site-packages/tqdm/tqdm.1 @ 68:5028fdace37b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 16:23:26 -0400
parents
children
comparison
equal deleted inserted replaced
67:0e9998148a16 68:5028fdace37b
1 .\" Automatically generated by Pandoc 1.19.2
2 .\"
3 .TH "TQDM" "1" "2015\-2021" "tqdm User Manuals" ""
4 .hy
5 .SH NAME
6 .PP
7 tqdm \- fast, extensible progress bar for Python and CLI
8 .SH SYNOPSIS
9 .PP
10 tqdm [\f[I]options\f[]]
11 .SH DESCRIPTION
12 .PP
13 See <https://github.com/tqdm/tqdm>.
14 Can be used as a pipe:
15 .IP
16 .nf
17 \f[C]
18 $\ #\ count\ lines\ of\ code
19 $\ cat\ *.py\ |\ tqdm\ |\ wc\ \-l
20 327it\ [00:00,\ 981773.38it/s]
21 327
22
23 $\ #\ find\ all\ files
24 $\ find\ .\ \-name\ "*.py"\ |\ tqdm\ |\ wc\ \-l
25 432it\ [00:00,\ 833842.30it/s]
26 432
27
28 #\ ...\ and\ more\ info
29 $\ find\ .\ \-name\ \[aq]*.py\[aq]\ \-exec\ wc\ \-l\ \\{}\ \\;\ \\
30 \ \ |\ tqdm\ \-\-total\ 432\ \-\-unit\ files\ \-\-desc\ counting\ \\
31 \ \ |\ awk\ \[aq]{\ sum\ +=\ $1\ };\ END\ {\ print\ sum\ }\[aq]
32 counting:\ 100%|█████████|\ 432/432\ [00:00<00:00,\ 794361.83files/s]
33 131998
34 \f[]
35 .fi
36 .SH OPTIONS
37 .TP
38 .B \-h, \-\-help
39 Print this help and exit.
40 .RS
41 .RE
42 .TP
43 .B \-v, \-\-version
44 Print version and exit.
45 .RS
46 .RE
47 .TP
48 .B \-\-desc=\f[I]desc\f[]
49 str, optional.
50 Prefix for the progressbar.
51 .RS
52 .RE
53 .TP
54 .B \-\-total=\f[I]total\f[]
55 int or float, optional.
56 The number of expected iterations.
57 If unspecified, len(iterable) is used if possible.
58 If float("inf") or as a last resort, only basic progress statistics are
59 displayed (no ETA, no progressbar).
60 If \f[C]gui\f[] is True and this parameter needs subsequent updating,
61 specify an initial arbitrary large positive number, e.g.
62 9e9.
63 .RS
64 .RE
65 .TP
66 .B \-\-leave
67 bool, optional.
68 If [default: True], keeps all traces of the progressbar upon termination
69 of iteration.
70 If \f[C]None\f[], will leave only if \f[C]position\f[] is \f[C]0\f[].
71 .RS
72 .RE
73 .TP
74 .B \-\-ncols=\f[I]ncols\f[]
75 int, optional.
76 The width of the entire output message.
77 If specified, dynamically resizes the progressbar to stay within this
78 bound.
79 If unspecified, attempts to use environment width.
80 The fallback is a meter width of 10 and no limit for the counter and
81 statistics.
82 If 0, will not print any meter (only stats).
83 .RS
84 .RE
85 .TP
86 .B \-\-mininterval=\f[I]mininterval\f[]
87 float, optional.
88 Minimum progress display update interval [default: 0.1] seconds.
89 .RS
90 .RE
91 .TP
92 .B \-\-maxinterval=\f[I]maxinterval\f[]
93 float, optional.
94 Maximum progress display update interval [default: 10] seconds.
95 Automatically adjusts \f[C]miniters\f[] to correspond to
96 \f[C]mininterval\f[] after long display update lag.
97 Only works if \f[C]dynamic_miniters\f[] or monitor thread is enabled.
98 .RS
99 .RE
100 .TP
101 .B \-\-miniters=\f[I]miniters\f[]
102 int or float, optional.
103 Minimum progress display update interval, in iterations.
104 If 0 and \f[C]dynamic_miniters\f[], will automatically adjust to equal
105 \f[C]mininterval\f[] (more CPU efficient, good for tight loops).
106 If > 0, will skip display of specified number of iterations.
107 Tweak this and \f[C]mininterval\f[] to get very efficient loops.
108 If your progress is erratic with both fast and slow iterations (network,
109 skipping items, etc) you should set miniters=1.
110 .RS
111 .RE
112 .TP
113 .B \-\-ascii=\f[I]ascii\f[]
114 bool or str, optional.
115 If unspecified or False, use unicode (smooth blocks) to fill the meter.
116 The fallback is to use ASCII characters " 123456789#".
117 .RS
118 .RE
119 .TP
120 .B \-\-disable
121 bool, optional.
122 Whether to disable the entire progressbar wrapper [default: False].
123 If set to None, disable on non\-TTY.
124 .RS
125 .RE
126 .TP
127 .B \-\-unit=\f[I]unit\f[]
128 str, optional.
129 String that will be used to define the unit of each iteration [default:
130 it].
131 .RS
132 .RE
133 .TP
134 .B \-\-unit\-scale=\f[I]unit_scale\f[]
135 bool or int or float, optional.
136 If 1 or True, the number of iterations will be reduced/scaled
137 automatically and a metric prefix following the International System of
138 Units standard will be added (kilo, mega, etc.) [default: False].
139 If any other non\-zero number, will scale \f[C]total\f[] and \f[C]n\f[].
140 .RS
141 .RE
142 .TP
143 .B \-\-dynamic\-ncols
144 bool, optional.
145 If set, constantly alters \f[C]ncols\f[] and \f[C]nrows\f[] to the
146 environment (allowing for window resizes) [default: False].
147 .RS
148 .RE
149 .TP
150 .B \-\-smoothing=\f[I]smoothing\f[]
151 float, optional.
152 Exponential moving average smoothing factor for speed estimates (ignored
153 in GUI mode).
154 Ranges from 0 (average speed) to 1 (current/instantaneous speed)
155 [default: 0.3].
156 .RS
157 .RE
158 .TP
159 .B \-\-bar\-format=\f[I]bar_format\f[]
160 str, optional.
161 Specify a custom bar string formatting.
162 May impact performance.
163 [default: \[aq]{l_bar}{bar}{r_bar}\[aq]], where l_bar=\[aq]{desc}:
164 {percentage:3.0f}%|\[aq] and r_bar=\[aq]| {n_fmt}/{total_fmt}
165 [{elapsed}<{remaining}, \[aq] \[aq]{rate_fmt}{postfix}]\[aq] Possible
166 vars: l_bar, bar, r_bar, n, n_fmt, total, total_fmt, percentage,
167 elapsed, elapsed_s, ncols, nrows, desc, unit, rate, rate_fmt,
168 rate_noinv, rate_noinv_fmt, rate_inv, rate_inv_fmt, postfix,
169 unit_divisor, remaining, remaining_s, eta.
170 Note that a trailing ": " is automatically removed after {desc} if the
171 latter is empty.
172 .RS
173 .RE
174 .TP
175 .B \-\-initial=\f[I]initial\f[]
176 int or float, optional.
177 The initial counter value.
178 Useful when restarting a progress bar [default: 0].
179 If using float, consider specifying \f[C]{n:.3f}\f[] or similar in
180 \f[C]bar_format\f[], or specifying \f[C]unit_scale\f[].
181 .RS
182 .RE
183 .TP
184 .B \-\-position=\f[I]position\f[]
185 int, optional.
186 Specify the line offset to print this bar (starting from 0) Automatic if
187 unspecified.
188 Useful to manage multiple bars at once (eg, from threads).
189 .RS
190 .RE
191 .TP
192 .B \-\-postfix=\f[I]postfix\f[]
193 dict or *, optional.
194 Specify additional stats to display at the end of the bar.
195 Calls \f[C]set_postfix(**postfix)\f[] if possible (dict).
196 .RS
197 .RE
198 .TP
199 .B \-\-unit\-divisor=\f[I]unit_divisor\f[]
200 float, optional.
201 [default: 1000], ignored unless \f[C]unit_scale\f[] is True.
202 .RS
203 .RE
204 .TP
205 .B \-\-write\-bytes
206 bool, optional.
207 Whether to write bytes.
208 If (default: False) will write unicode.
209 .RS
210 .RE
211 .TP
212 .B \-\-lock\-args=\f[I]lock_args\f[]
213 tuple, optional.
214 Passed to \f[C]refresh\f[] for intermediate output (initialisation,
215 iterating, and updating).
216 .RS
217 .RE
218 .TP
219 .B \-\-nrows=\f[I]nrows\f[]
220 int, optional.
221 The screen height.
222 If specified, hides nested bars outside this bound.
223 If unspecified, attempts to use environment height.
224 The fallback is 20.
225 .RS
226 .RE
227 .TP
228 .B \-\-colour=\f[I]colour\f[]
229 str, optional.
230 Bar colour (e.g.
231 \[aq]green\[aq], \[aq]#00ff00\[aq]).
232 .RS
233 .RE
234 .TP
235 .B \-\-delay=\f[I]delay\f[]
236 float, optional.
237 Don\[aq]t display until [default: 0] seconds have elapsed.
238 .RS
239 .RE
240 .TP
241 .B \-\-delim=\f[I]delim\f[]
242 chr, optional.
243 Delimiting character [default: \[aq]\\n\[aq]].
244 Use \[aq]\\0\[aq] for null.
245 N.B.: on Windows systems, Python converts \[aq]\\n\[aq] to
246 \[aq]\\r\\n\[aq].
247 .RS
248 .RE
249 .TP
250 .B \-\-buf\-size=\f[I]buf_size\f[]
251 int, optional.
252 String buffer size in bytes [default: 256] used when \f[C]delim\f[] is
253 specified.
254 .RS
255 .RE
256 .TP
257 .B \-\-bytes
258 bool, optional.
259 If true, will count bytes, ignore \f[C]delim\f[], and default
260 \f[C]unit_scale\f[] to True, \f[C]unit_divisor\f[] to 1024, and
261 \f[C]unit\f[] to \[aq]B\[aq].
262 .RS
263 .RE
264 .TP
265 .B \-\-tee
266 bool, optional.
267 If true, passes \f[C]stdin\f[] to both \f[C]stderr\f[] and
268 \f[C]stdout\f[].
269 .RS
270 .RE
271 .TP
272 .B \-\-update
273 bool, optional.
274 If true, will treat input as newly elapsed iterations, i.e.
275 numbers to pass to \f[C]update()\f[].
276 Note that this is slow (~2e5 it/s) since every input must be decoded as
277 a number.
278 .RS
279 .RE
280 .TP
281 .B \-\-update\-to
282 bool, optional.
283 If true, will treat input as total elapsed iterations, i.e.
284 numbers to assign to \f[C]self.n\f[].
285 Note that this is slow (~2e5 it/s) since every input must be decoded as
286 a number.
287 .RS
288 .RE
289 .TP
290 .B \-\-null
291 bool, optional.
292 If true, will discard input (no stdout).
293 .RS
294 .RE
295 .TP
296 .B \-\-manpath=\f[I]manpath\f[]
297 str, optional.
298 Directory in which to install tqdm man pages.
299 .RS
300 .RE
301 .TP
302 .B \-\-comppath=\f[I]comppath\f[]
303 str, optional.
304 Directory in which to place tqdm completion.
305 .RS
306 .RE
307 .TP
308 .B \-\-log=\f[I]log\f[]
309 str, optional.
310 CRITICAL|FATAL|ERROR|WARN(ING)|[default: \[aq]INFO\[aq]]|DEBUG|NOTSET.
311 .RS
312 .RE
313 .SH AUTHORS
314 tqdm developers <https://github.com/tqdm>.