本文由 大侠(AhcaoZhu)原创，转载请声明。
链接: https://blog.csdn.net/Ahcao2008
一图看懂 tqdm 模块：一个可在循环和命令行中使用的快速、可扩展的进度条，资料整理+笔记（大全）
- 🧊摘要
- 🧊模块图
- 🧊类关系图
- 🧊模块全展开
- ☘️【tqdm】
- 🔵统计
- 🔵模块
- 🔵函数
- 🔵类
- 🌿15 tqdm._monitor.TMonitor
- 🌿16 tqdm._monitor.TqdmSynchronisationWarning
- 🌿17 tqdm.gui.tqdm_gui
- 🌿18 tqdm.std.TqdmDeprecationWarning
- 🌿19 tqdm.std.TqdmExperimentalWarning
- 🌿20 tqdm.std.TqdmKeyError
- 🌿21 tqdm.std.TqdmMonitorWarning
- 🌿22 tqdm.std.TqdmTypeError
- 🌿23 tqdm.std.TqdmWarning
- 🌿24 tqdm.std.tqdm
- data
- property
- method
- 4 clear(self, nolock=False)
- 5 close(self)
- 6 display(self, msg=None, pos=None)
- 7 moveto(self, n)
- 8 refresh(self, nolock=False, lock_args=None)
- 9 reset(self, total=None)
- 10 set_description(self, desc=None, refresh=True)
- 11 set_description_str(self, desc=None, refresh=True)
- 12 set_postfix(self, ordered_dict=None, refresh=True, **kwargs)
- 13 set_postfix_str(self, s='', refresh=True)
- 14 unpause(self)
- 15 update(self, n=1)
- static method
- 16 format_interval(t)
- 17 format_meter(n, total, elapsed, ncols=None, prefix='', ascii=False, unit='it',
- 18 format_num(n)
- 19 format_sizeof(num, suffix='', divisor=1000)
- 20 status_printer(file)
- class method
- 21 external_write_mode(cls, file=None, nolock=False)
- 22 get_lock(cls)
- 23 pandas(cls, **tqdm_kwargs)
- 24 set_lock(cls, lock)
- 25 wrapattr(cls, stream, method, total=None, bytes=True, **tqdm_kwargs)
- 26 write(cls, s, file=None, end="\n", nolock=False)
- 🔵私有或局部
- ☘️【tqdm._monitor】
- ☘️【tqdm._tqdm_pandas】
- ☘️【tqdm.utils】
- ☘️【tqdm.std】
- ☘️【tqdm._dist_ver】
- ☘️【tqdm.version】
- ☘️【tqdm.cli】
- ☘️【tqdm.gui】
- ☘️【atexit】
- ☘️【sys】
- ☘️【os】
- ☘️【re】
- ☘️【colorama】
- ☘️【logging】
🧊摘要
🧊模块图
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】
🔵统计
🔵模块
🌿1 tqdm._monitor
🌿2 tqdm._tqdm_pandas
🌿3 tqdm.utils
`tqdm.std` 所需的一般帮助程序。
🌿4 tqdm.std
为迭代器定制进度条装饰器。
包含一个默认的`range` 迭代器，打印到`stderr` 。
用法：
>>> from tqdm import trange, tqdm
>>> for i in trange(10):
... ...
🌿5 tqdm._dist_ver
🌿6 tqdm.version
`tqdm` 版本检测器。优先级:已安装的dist, git， 'UNKNOWN'。
🌿7 tqdm.cli
用于监控CLI管道的模块版本(`... | python -m tqdm | ...`)。
🌿8 tqdm.gui
用于迭代器的Matplotlib GUI进度条装饰器。
用法:
>>> from tqdm.gui import trange, tqdm
>>> for i in trange(10):
... ...
🔵函数
🌿9 tqdm_pandas(tclass, **tqdm_kwargs)
用`pandas.core.groupby.DataFrameGroupBy.progress_apply`注册给定的`tqdm` 实例。
🌿10 main(fp=<_io.TextIOWrapper name=‘’ mode=‘w’ encoding=‘GB18030’>, argv=None)
参数(仅内部使用)
---------
fp : tqdm的类文件对象
argv : 列表 (默认: sys.argv[1:])
🌿11 tgrange(*args, **kwargs)
`tqdm.gui.tqdm(range(*args), **kwargs)` 的快捷方式。
🌿12 trange(*args, **kwargs)
tqdm(range(*args), **kwargs) 的快捷方式。
🌿13 tqdm_notebook(*args, **kwargs)
请参阅tqdm.notebook.tqdm以获得完整的文档
🌿14 tnrange(*args, **kwargs)
`tqdm.notebook.tqdm(range(*args), **kwargs)` 的快捷方式。
🔵类
🌿15 tqdm._monitor.TMonitor
监视线程的tqdm条。
监视tqdm条是否花费太多时间来显示，并在必要时自动重新调整最小值。
参数：
----------
tqdm_cls : class
tqdm类使用(可以是核心tqdm或子模块)。
sleep_interval : float
监控检查之间的睡眠时间。
method
🌿16 tqdm._monitor.TqdmSynchronisationWarning
tqdm multi-thread/-process 错误，可能导致不正确的嵌套，但没有其他不利影响
🌿17 tqdm.gui.tqdm_gui
实验Matplotlib GUI版的tqdm!
method
🌿18 tqdm.std.TqdmDeprecationWarning
🌿19 tqdm.std.TqdmExperimentalWarning
beta功能，不稳定的API和行为
🌿20 tqdm.std.TqdmKeyError
🌿21 tqdm.std.TqdmMonitorWarning
TQDM监控不影响外部功能的错误
🌿22 tqdm.std.TqdmTypeError
🌿23 tqdm.std.TqdmWarning
所有TQDM警告的基类。用于非外部代码破坏错误，如乱码打印。
🌿24 tqdm.std.tqdm
修饰一个可迭代对象，返回一个与原始可迭代对象完全相同的迭代器，但每次请求值时都会打印一个动态更新的进度条。
data
property
method
清除当前条显示。
清理并(如果leave=False)关闭进度条。
使用`self.sp`在指定的`pos`中显示`msg`。
考虑在继承时重载此函数以使用，例如:`self.some_frontend(**self.format_dict)` 而不是`self.sp` 。
参数:
----------
msg : str, optional. 显示内容 (默认: `repr(self)`).
pos : int, 可选。`moveto`的位置 (默认: `abs(self.pos)`
强制刷新此栏的显示。
参数
----------
nolock : bool, 可选
如果 `True`, 则不锁定。
如果 [default: `False`]: 在内部锁上调用 `acquire()`。
lock_args : tuple, optional
传递给内部锁的 `acquire()`。
如果指定，将只在 `acquire()` 返回 `True` 时 `display()`。
为重复使用将迭代重置为0。
考虑与`leave=True`组合使用。
参数
----------
total : int or float, 可选。总用于新进度条。
设置/修改进度条描述。
参数：
----------
desc : str, 可选
refresh : bool, optional 强制刷新[默认值:True]。
设置/修改没有':'的描述。
使用基于数据类型的自动格式化设置/修改后缀(附加统计)。
参数
----------
ordered_dict : dict or OrderedDict, 可选
refresh : bool, optional 可选强制刷新[默认值:True]。
kwargs : dict, 可选
没有字典扩展的后缀，类似于前缀处理。
从上次打印时间重新启动tqdm定时器。
手动更新进度条，对读取文件等流很有用。
例如:
>>> 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
staticmethod(function) -> method将函数转换为静态方法。
staticmethod(function) -> method将函数转换为静态方法。
staticmethod(function) -> method将函数转换为静态方法。
静态方法。
静态方法。
class method
将函数转换为类方法。
将函数转换为类方法。
将函数转换为类方法。
将函数转换为类方法。
将函数转换为类方法。
将函数转换为类方法。