一图看懂 tqdm 模块：一个可在循环和命令行中使用的快速、可扩展的进度条，资料整理+笔记（大全）

本文由 大侠(AhcaoZhu)原创，转载请声明。
链接: https://blog.csdn.net/Ahcao2008

🧊摘要

• 全文介绍python的 tqdm 模块（一个可在循环和命令行中使用的快速、可扩展的进度条）、函数、类及类的方法和属性。
• 它通过代码抓取并经AI智能翻译和人工校对。
• 是一部不可多得的权威字典类工具书。它是系列集的一部分。后续陆续发布、敬请关注。【原创：AhcaoZhu大侠】

🧊模块图

tqdm
	tqdm._monitor
		◆atexit
	tqdm._tqdm_pandas
	tqdm.utils
		◆colorama
	tqdm.std
	tqdm._dist_ver
	tqdm.version
	tqdm.cli
	tqdm.gui

🧊类关系图

◆object
	◆BaseException
		◆Exception
			◆LookupError
				◆KeyError
					tqdm.std.TqdmKeyError
			◆TypeError
				tqdm.std.TqdmTypeError
			◆Warning
				◆DeprecationWarning
					tqdm.std.TqdmWarning
						tqdm.std.TqdmDeprecationWarning
						tqdm.std.TqdmExperimentalWarning
						tqdm.std.TqdmMonitorWarning
				◆FutureWarning
					tqdm.std.TqdmWarning
				◆RuntimeWarning
					tqdm._monitor.TqdmSynchronisationWarning
					tqdm.std.TqdmWarning
				tqdm.std.TqdmWarning
	◆threading.Thread
		tqdm._monitor.TMonitor
	tqdm.std.Bar
	tqdm.std.EMA
	tqdm.std.TqdmDefaultWriteLock
	tqdm.utils.Comparable
		tqdm.std.tqdm
			tqdm.gui.tqdm_gui
	tqdm.utils.FormatReplace
	tqdm.utils.ObjectWrapper
		tqdm.utils.CallbackIOWrapper
		tqdm.utils.DisableOnWriteError
		tqdm.utils.SimpleTextIOWrapper

🧊模块全展开

☘️【tqdm】

tqdm, fullname=tqdm, file=tqdm_init_.py

🔵统计

序号	类别	数量
4	str	5
6	list	2
8	dict	1
9	module	8
10	class	10
11	function	6
13	residual	3
14	system	11
15	private	3
16	all	35

🔵模块

🌿1 tqdm._monitor

_monitor, fullname=tqdm._monitor, file=tqdm_monitor.py

🌿2 tqdm._tqdm_pandas

_tqdm_pandas, fullname=tqdm._tqdm_pandas, file=tqdm_tqdm_pandas.py

🌿3 tqdm.utils

utils, fullname=tqdm.utils, file=tqdm\utils.py

`tqdm.std` 所需的一般帮助程序。

🌿4 tqdm.std

std, fullname=tqdm.std, file=tqdm\std.py

为迭代器定制进度条装饰器。
包含一个默认的`range` 迭代器，打印到`stderr` 。
用法：
    >>> from tqdm import trange, tqdm
    >>> for i in trange(10):
    ...     ...

🌿5 tqdm._dist_ver

_dist_ver, fullname=tqdm._dist_ver, file=tqdm_dist_ver.py

🌿6 tqdm.version

version, fullname=tqdm.version, file=tqdm\version.py

`tqdm` 版本检测器。优先级:已安装的dist, git， 'UNKNOWN'。

🌿7 tqdm.cli

cli, fullname=tqdm.cli, file=tqdm\cli.py

用于监控CLI管道的模块版本(`... | python -m tqdm | ...`)。

🌿8 tqdm.gui

gui, fullname=tqdm.gui, file=tqdm\gui.py

用于迭代器的Matplotlib GUI进度条装饰器。
用法:
    >>> from tqdm.gui import trange, tqdm
    >>> for i in trange(10):
    ...     ...

🔵函数

🌿9 tqdm_pandas(tclass, **tqdm_kwargs)

tqdm_pandas(tclass, **tqdm_kwargs), module=tqdm._tqdm_pandas, line:7 at site-packages\tqdm_tqdm_pandas.py

用`pandas.core.groupby.DataFrameGroupBy.progress_apply`注册给定的`tqdm` 实例。

🌿10 main(fp=<_io.TextIOWrapper name=‘’ mode=‘w’ encoding=‘GB18030’>, argv=None)

main(fp=<_io.TextIOWrapper name=‘’ mode=‘w’ encoding=‘GB18030’>, argv=None), module=tqdm.cli, line:144 at site-packages\tqdm\cli.py

    参数(仅内部使用)
    ---------
    fp  : tqdm的类文件对象
    argv  : 列表 (默认: sys.argv[1:])

🌿11 tgrange(*args, **kwargs)

tgrange(*args, **kwargs), module=tqdm.gui, line:179 at site-packages\tqdm\gui.py

`tqdm.gui.tqdm(range(*args), **kwargs)` 的快捷方式。

🌿12 trange(*args, **kwargs)

trange(*args, **kwargs), module=tqdm.std, line:1519 at site-packages\tqdm\std.py

tqdm(range(*args), **kwargs) 的快捷方式。

🌿13 tqdm_notebook(*args, **kwargs)

tqdm_notebook(*args, **kwargs), module=tqdm, line:20 at site-packages\tqdm_init_.py

请参阅tqdm.notebook.tqdm以获得完整的文档

🌿14 tnrange(*args, **kwargs)

tnrange(*args, **kwargs), module=tqdm, line:31 at site-packages\tqdm_init_.py

`tqdm.notebook.tqdm(range(*args), **kwargs)` 的快捷方式。

🔵类

🌿15 tqdm._monitor.TMonitor

TMonitor, tqdm._monitor.TMonitor, module=tqdm._monitor, line:15 at site-packages\tqdm_monitor.py

监视线程的tqdm条。
    监视tqdm条是否花费太多时间来显示，并在必要时自动重新调整最小值。
    参数：
    ----------
    tqdm_cls  : class
        tqdm类使用(可以是核心tqdm或子模块)。
    sleep_interval  : float
        监控检查之间的睡眠时间。

method

1 exit(self)

kind=method class=TMonitor objtype=function line:41 at …\lib\site-packages\tqdm_monitor.py

2 get_instances(self)

kind=method class=TMonitor objtype=function line:47 at …\lib\site-packages\tqdm_monitor.py

3 report(self)

kind=method class=TMonitor objtype=function line:94 at …\lib\site-packages\tqdm_monitor.py

4 run(self)

kind=method class=TMonitor objtype=function line:53 at …\lib\site-packages\tqdm_monitor.py

🌿16 tqdm._monitor.TqdmSynchronisationWarning

TqdmSynchronisationWarning, tqdm._monitor.TqdmSynchronisationWarning, module=tqdm._monitor, line:9 at site-packages\tqdm_monitor.py

tqdm multi-thread/-process 错误，可能导致不正确的嵌套，但没有其他不利影响

🌿17 tqdm.gui.tqdm_gui

tqdm_gui, tqdm.gui.tqdm_gui, module=tqdm.gui, line:24 at site-packages\tqdm\gui.py

实验Matplotlib GUI版的tqdm!

method

1 clear(self, *_, **__)

kind=method class=tqdm_gui objtype=function line:107 at …\lib\site-packages\tqdm\gui.py

2 close(self)

kind=method class=tqdm_gui objtype=function line:88 at …\lib\site-packages\tqdm\gui.py

3 display(self, *_, **__)

kind=method class=tqdm_gui objtype=function line:110 at …\lib\site-packages\tqdm\gui.py

🌿18 tqdm.std.TqdmDeprecationWarning

TqdmDeprecationWarning, tqdm.std.TqdmDeprecationWarning, module=tqdm.std, line:56 at site-packages\tqdm\std.py

🌿19 tqdm.std.TqdmExperimentalWarning

TqdmExperimentalWarning, tqdm.std.TqdmExperimentalWarning, module=tqdm.std, line:51 at site-packages\tqdm\std.py

beta功能，不稳定的API和行为

🌿20 tqdm.std.TqdmKeyError

TqdmKeyError, tqdm.std.TqdmKeyError, module=tqdm.std, line:35 at site-packages\tqdm\std.py

🌿21 tqdm.std.TqdmMonitorWarning

TqdmMonitorWarning, tqdm.std.TqdmMonitorWarning, module=tqdm.std, line:61 at site-packages\tqdm\std.py

TQDM监控不影响外部功能的错误

🌿22 tqdm.std.TqdmTypeError

TqdmTypeError, tqdm.std.TqdmTypeError, module=tqdm.std, line:31 at site-packages\tqdm\std.py

🌿23 tqdm.std.TqdmWarning

TqdmWarning, tqdm.std.TqdmWarning, module=tqdm.std, line:39 at site-packages\tqdm\std.py

所有TQDM警告的基类。用于非外部代码破坏错误，如乱码打印。

🌿24 tqdm.std.tqdm

tqdm, tqdm.std.tqdm, module=tqdm.std, line:244 at site-packages\tqdm\std.py

修饰一个可迭代对象，返回一个与原始可迭代对象完全相同的迭代器，但每次请求值时都会打印一个动态更新的进度条。

data

1 monitor=None kind:data type:NoneType class:<class ‘tqdm.std.tqdm’>
2 monitor_interval=10 kind:data type:int class:<class ‘tqdm.std.tqdm’>

property

3 format_dict=<property object at 0x0000017E575FC9F8> kind:property type:property class:<class ‘tqdm.std.tqdm’>

method

4 clear(self, nolock=False)

kind=method class=tqdm objtype=function line:1306 at …\lib\site-packages\tqdm\std.py

清除当前条显示。

5 close(self)

kind=method class=tqdm objtype=function line:1262 at …\lib\site-packages\tqdm\std.py

清理并(如果leave=False)关闭进度条。

6 display(self, msg=None, pos=None)

kind=method class=tqdm objtype=function line:1461 at …\lib\site-packages\tqdm\std.py

使用`self.sp`在指定的`pos`中显示`msg`。
    考虑在继承时重载此函数以使用，例如:`self.some_frontend(**self.format_dict)` 而不是`self.sp` 。
    参数:
    ----------
    msg  : str, optional. 显示内容 (默认: `repr(self)`).
    pos  : int, 可选。`moveto`的位置 (默认: `abs(self.pos)`

7 moveto(self, n)

kind=method class=tqdm objtype=function line:1438 at …\lib\site-packages\tqdm\std.py

8 refresh(self, nolock=False, lock_args=None)

kind=method class=tqdm objtype=function line:1322 at …\lib\site-packages\tqdm\std.py

强制刷新此栏的显示。
    参数
    ----------
    nolock  : bool, 可选
        如果 `True`, 则不锁定。
        如果 [default: `False`]: 在内部锁上调用 `acquire()`。
    lock_args  : tuple, optional
        传递给内部锁的 `acquire()`。
        如果指定，将只在 `acquire()` 返回 `True` 时 `display()`。

9 reset(self, total=None)

kind=method class=tqdm objtype=function line:1357 at …\lib\site-packages\tqdm\std.py

为重复使用将迭代重置为0。
    考虑与`leave=True`组合使用。
    参数
    ----------
    total  : int or float, 可选。总用于新进度条。

10 set_description(self, desc=None, refresh=True)

kind=method class=tqdm objtype=function line:1379 at …\lib\site-packages\tqdm\std.py

设置/修改进度条描述。
    参数：
    ----------
    desc  : str, 可选
    refresh  : bool, optional  强制刷新[默认值:True]。

11 set_description_str(self, desc=None, refresh=True)

kind=method class=tqdm objtype=function line:1393 at …\lib\site-packages\tqdm\std.py

设置/修改没有':'的描述。

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

kind=method class=tqdm objtype=function line:1399 at …\lib\site-packages\tqdm\std.py

使用基于数据类型的自动格式化设置/修改后缀(附加统计)。
    参数
    ----------
    ordered_dict  : dict or OrderedDict, 可选
    refresh  : bool, optional   可选强制刷新[默认值:True]。
    kwargs  : dict, 可选

13 set_postfix_str(self, s=‘’, refresh=True)

kind=method class=tqdm objtype=function line:1430 at …\lib\site-packages\tqdm\std.py

没有字典扩展的后缀，类似于前缀处理。

14 unpause(self)

kind=method class=tqdm objtype=function line:1349 at …\lib\site-packages\tqdm\std.py

从上次打印时间重新启动tqdm定时器。

15 update(self, n=1)

kind=method class=tqdm objtype=function line:1195 at …\lib\site-packages\tqdm\std.py

手动更新进度条，对读取文件等流很有用。
    例如:
    >>> t = tqdm(total=filesize) # Initialise
    >>> for current_buffer in stream:
    ...    ...
    ...    t.update(len(current_buffer))
    >>> t.close()
    强烈推荐最后一行，但如果`t.update()`将以精确到达并打印`filesize`的方式调用，则可能没有必要。

    参数：
    -----
    n  : int or float, 可选的
        增量添加到迭代的内部计数器(默认值:1)。如果使用float，请考虑指定 `{n:.3f}` 或类似的`bar_format`，或指定`unit_scale`。
    返回：
    -----
    out  : bool 或 None 如果触发了`display()`，则返回True。

static method

16 format_interval(t)

kind=static method class=tqdm objtype=staticmethod line:286 at …\lib\site-packages\tqdm\std.py

staticmethod(function) -> method将函数转换为静态方法。

17 format_meter(n, total, elapsed, ncols=None, prefix=‘’, ascii=False, unit=‘it’,

kind=static method class=tqdm objtype=staticmethod line:353 at …\lib\site-packages\tqdm\std.py

staticmethod(function) -> method将函数转换为静态方法。

18 format_num(n)

kind=static method class=tqdm objtype=staticmethod line:308 at …\lib\site-packages\tqdm\std.py

staticmethod(function) -> method将函数转换为静态方法。

19 format_sizeof(num, suffix=‘’, divisor=1000)

kind=static method class=tqdm objtype=staticmethod line:256 at …\lib\site-packages\tqdm\std.py

静态方法。

20 status_printer(file)

kind=static method class=tqdm objtype=staticmethod line:327 at …\lib\site-packages\tqdm\std.py

静态方法。

class method

21 external_write_mode(cls, file=None, nolock=False)

kind=class method class=tqdm objtype=classmethod line:615 at …\lib\site-packages\tqdm\std.py

将函数转换为类方法。

22 get_lock(cls)

kind=class method class=tqdm objtype=classmethod line:649 at …\lib\site-packages\tqdm\std.py

将函数转换为类方法。

23 pandas(cls, **tqdm_kwargs)

kind=class method class=tqdm objtype=classmethod line:656 at …\lib\site-packages\tqdm\std.py

将函数转换为类方法。

24 set_lock(cls, lock)

kind=class method class=tqdm objtype=classmethod line:644 at …\lib\site-packages\tqdm\std.py

将函数转换为类方法。

25 wrapattr(cls, stream, method, total=None, bytes=True, **tqdm_kwargs)

kind=class method class=tqdm objtype=classmethod line:1499 at …\lib\site-packages\tqdm\std.py

将函数转换为类方法。

26 write(cls, s, file=None, end=“\n”, nolock=False)

kind=class method class=tqdm objtype=classmethod line:605 at …\lib\site-packages\tqdm\std.py

将函数转换为类方法。

🔵私有或局部

25 _monitor <module ‘tqdm._monitor’ from ‘…\lib\site-packages\tqdm_monitor.py’>
26 _tqdm_pandas <module ‘tqdm._tqdm_pandas’ from ‘…\lib\site-packages\tqdm_tqdm_pandas.py’>
27 _dist_ver <module ‘tqdm._dist_ver’ from ‘…\lib\site-packages\tqdm_dist_ver.py’>

☘️【tqdm._monitor】

_monitor, fullname=tqdm._monitor, file=tqdm_monitor.py

☘️【tqdm._tqdm_pandas】

_tqdm_pandas, fullname=tqdm._tqdm_pandas, file=tqdm_tqdm_pandas.py

☘️【tqdm.utils】

utils, fullname=tqdm.utils, file=tqdm\utils.py

☘️【tqdm.std】

std, fullname=tqdm.std, file=tqdm\std.py

☘️【tqdm._dist_ver】

_dist_ver, fullname=tqdm._dist_ver, file=tqdm_dist_ver.py

☘️【tqdm.version】

version, fullname=tqdm.version, file=tqdm\version.py

☘️【tqdm.cli】

cli, fullname=tqdm.cli, file=tqdm\cli.py

☘️【tqdm.gui】

gui, fullname=tqdm.gui, file=tqdm\gui.py

☘️【atexit】

atexit, fullname=atexit, file=

☘️【sys】

sys, fullname=sys, file=

☘️【os】

os, fullname=os, file=os.py

☘️【re】

re, fullname=re, file=re.py

☘️【colorama】

colorama, fullname=colorama, file=colorama_init_.py

☘️【logging】

logging, fullname=logging, file=logging_init_.py