在程序执行过程中显示进度条之——tqdm

tqdm 是一个在 Python 中非常实用的用于显示进度条的第三方库，它可以让你直观地看到循环或者长时间运行的任务的执行进度。

1. 基本作用与使用场景

在执行一些耗时的操作时，例如遍历大规模数据集、训练复杂的机器学习模型（可能需要迭代很多轮次）或者处理大量文件等，若没有进度指示，很难直观知晓任务执行到了什么阶段以及大概还需要多久完成。tqdm 就能很好地解决这个问题，它会在终端等输出界面动态显示一个进度条，展示当前任务的进度百分比、已耗时、预计剩余时间等信息，极大地提升了用户体验，并且方便你把控程序运行的时间情况。

2. 安装

使用 pip 命令就可以很方便地安装 ：pip install tqdm。

3. 基本使用方法

3.1 在简单循环中使用

最常见的是用于 for 循环中显示进度，以下是一个示例，假设有一个列表，需要遍历该列表并对每个元素执行一些操作（这里简单打印元素）：

from tqdm import tqdm
import time

mylist = list(range(100))
for element in tqdm(mylist):
    time.sleep(0.1)  # 模拟耗时操作
    print(element)

在 for 循环中，将 mylist 作为参数传递给 tqdm，这样在循环执行过程中，就会在终端显示出一个进度条，随着循环的推进，进度条会逐渐填满，同时还能看到已耗时以及预计剩余时间等信息。这里通过 time.sleep(0.1) 模拟了每个元素处理时的耗时操作。

3.2 在嵌套循环中使用

如果有嵌套的循环结构，也可以很好地使用 tqdm 来展示进度，示例如下：

from tqdm import tqdm
import time

outer_list = list(range(5))
inner_list = list(range(10))
for outer_element in tqdm(outer_list):
    for inner_element in tqdm(inner_list):
        time.sleep(0.05)  # 模拟耗时操作
        print(f"Outer: {outer_element}, Inner: {inner_element}")

4. 自定义进度条显示内容

4.1 设置描述信息

可以通过 desc 参数来设置进度条上方显示的描述性文字，让用户更清楚当前进度条对应的任务是什么。

from tqdm import tqdm
import time

mylist = list(range(100))
for element in tqdm(mylist, desc="Processing list elements"):
    time.sleep(0.1)  # 模拟耗时操作
    print(element)

4.2 动态更新其他显示信息

有时候可能希望在进度条上显示除了默认的进度、耗时等之外的其他自定义信息，比如在处理文件时显示当前处理的文件名等，可以通过 tqdm 的 set_postfix 方法来实现。

from tqdm import tqdm
import time

file_list = ["file1.txt", "file2.txt", "file3.txt"]
for file in tqdm(file_list, desc="Processing files"):
    time.sleep(0.5)  # 模拟耗时操作
    progress_bar = tqdm(total=100, desc="Inner operation")  # 创建内层进度条用于模拟其他操作进度
    for i in range(100):
        progress_bar.update(1)
        progress_bar.set_postfix(file=file)  # 设置自定义信息，显示当前文件名
    progress_bar.close()

5. 在 Jupyter Notebook中使用

from tqdm.notebook import tqdm
import time

mylist = list(range(100))
for element in tqdm(mylist):
    time.sleep(0.1)  # 模拟耗时操作
    print(element)

这样就能在 Jupyter Notebook 的单元格输出区域正确地显示进度条了，和在终端使用时功能类似，但显示效果会适配 Jupyter Notebook 的界面风格。