当前位置：首页 > article >正文

tqdm 显示进度条模块

article 2024/11/17 19:19:50

Python中可以使用tqdm包来显示进度条。进度条的原理其实很简单，就是不断地删除已经打印的内容，然后重新写出新的进度，从而完成在同一行中的进度条再不断增长的效果。tqdm不是Python自有的模块，需要安装，比如使用pip安装

pip install tqdm

可以从包tqdm中引入所有类：

from tqdm import *

更好的一种方式是根据需求引入一些常用的或者需要的类、方法：

from tqdm import tqdm, trange

注意，第一个tqdm是包名，第二个tqdm是类名，恰好同名，不要误用 import tqdm,trange 这样的代码来（错误地）引入tqdm类和trange方法。

一、tqdm的使用方法

1.1 直接封装可迭代对象

可以直接使用tqdm创建一个类实例，第一个参数是一个可迭代对象，即tqdm可以直接包装一个可迭代对象，从而进行迭代时就会使用进度条了，比如range(100)一个简单的可迭代对象：

from tqdm import tqdm
import time, random

for i in tqdm(range(10)):
    time.sleep(0.1)

在这里插入图片描述

1.2 使用简单的trange

上文中一个简单的使用tqdm直接封装range可迭代对象的代码可以简单地使用trange代替，即 trange(X) = tqdm(range(X))，例如下边的例子等同于上边中的第一个例子：

from tqdm import trange
import time, random

for i in trange(10):
    time.sleep(1)

1.3 实例化一个tqdm类

如果想对进度条进行更加详细的定制，可以实例化一个tqdm类的实例，然后使用它的方法来更好地发挥作用

实例化tqdm类时有一些其他的可能比较常用的参数：

iterable（第一个参数）：一个可迭代对象
desc：对进度条的描述，会显示在进度条前边
total：预期的总迭代次数（默认会等于iterable的总次数，如果可数的话）
ncols：总长度
mininterval：最小的更新时间间隔，默认为0.1
maxinterval：最大的更新时间间隔，默认为10

一个tqdm实例的常用方法：

set_description：设置显示在进度条前边的内容
set_postfix：设置显示在进度条后边的内容
update：对进度进行手动更新
close：关闭进度条实例，实际上，最好在使用完一个- tqdm类的实例后使用 close 方法清理资源，就像使用open打开的文件一样，从而释放内存。

举个例子：

from tqdm import tqdm
import time, random

p_bar = tqdm(range(10), desc="A Processing Bar Sample: ", total=10, ncols=100)

for i in p_bar:
    time.sleep(random.random())
    p_bar.set_postfix(loss=random.random(), acc=random.random() * 100)

p_bar.close()

在这里插入图片描述

1.4 使用with语句

因为一个实例化的tqdm也需要在使用完毕后通过close方法清理资源，这和打开一个文件进行处理是很类似的，因此同样可以使用with语句，让其在执行完后自动清理，就不再需要使用close方法手动关闭了：

from tqdm import tqdm
import time, random

with tqdm(total=100) as p_bar:
    for i in range(50):
        time.sleep(random.random())
        p_bar.update(2)
        p_bar.set_description("Processing {}-th iteration".format(i+1))

在这里插入图片描述