tqdm 是一个进度显示工具,当任务执行的等待时间较长时,通过tqdm模块可以模拟出一个进度条,由此可以看到任务执行进度,获得更好的体验。
文章目录
- 一、tqdm的安装
- 二、tqdm的使用
- 2.1 基于可迭代对象
- 2.2 手动进度更新
- 2.3 命令行模式
一、tqdm的安装
tqdm是一个第三方模块,需要额外安装,可以使用pip install tqdm命令安装模块:
pip install tqdm
二、tqdm的使用
tqdm的使用非常简单,可以直接应用在迭代对象上,随着迭代过程自动更新进度,或者通过在迭代过程中手动调用.update()方法更新进度。甚至还可以应该在linux命令中。
2.1 基于可迭代对象
可迭代对象通常会放在for循环中进行迭代,为显示for循环的执行进度,只需要将可迭代对象放入tqdm()中,循环时即会显示进度条和完成全部迭代预计的剩余时间。为了计算任务进度并显示进度条,tqdm 函数要获取一个能使用 len 函数确定大小的可迭代对象,或者在参数(total)中指定预期的迭代总数。
示例:这里这里每次循环睡眠0.02秒,方便观察:
from tqdm import tqdm
from time import sleep
for i in tqdm(range(100)):
sleep(0.02)
tqdm(range(N))还有一个特别优化过的写法trange(N),上面的代码也可以写成:
from tqdm import trange
from time import sleep
for i in trange(100):
sleep(0.02)
2.2 手动进度更新
tqdm还可以手动更新,将其对象赋给一个变量,然后调用.update(N)方法来更新进度,tqdm()有个可选的参数设置迭代总数,然后通过update方法进行累加,每次执行update都会打印一次当前进度。
示例:新建一个tqdm实例,total=100表示迭代总数为100
percent = tqdm(total=100)
调用update(N)方法,表示完成N次迭代,进度条则会显示对应的百分比
percent.update(1)
再次调用会进行累加:
percent.update(90)
完成后记得调用close()方法关闭对象,否则可能遇到显示多个进度条的情况:
percent.close()
你也可以直接用上下文管理器with来自动关闭tqdm对象,2.1的示例可以改写如下,这里每次循环后主动调用percent.update(1)来更新进度:
from tqdm import tqdm
from time import sleep
with tqdm(total=100) as percent:
for I in range(100):
sleep(0.02)
percent.update(1)
2.3 命令行模式
在命令行中使用tqdm时,只要通过管道将要监控的命令连接起来:
cat db_backup.sql | tqdm | mysql test
这里由于没有提供total参数,所以在运行过程中无法计算完成比例,仅仅显示了迭代的次数,示例中的158it就是迭代次数(it是单位)。
我们给tqdm增加几个参数,–bytes表示统计处理的字节数,–total 表示文件的总大小(用操作系统命令查看),这两个参数结合起来可以计算处理进度。–desc Importing…进度条前的描述符,可以自行定义:
cat db_backup.sql | tqdm --bytes --total 23886278 --desc Importing… | mysql test
对于进度条跳动比较突兀的情况,你还可以增加一个–mininterval=0.01 参数来指定进度条更新间隔,让其动画更加流畅。