【python】tqdm 进度条详解

一、前言

  很多时候，当我们的循环时间较长时，往往想要实时了解当前的进度，以期预知剩余的时间，这让我们对代码的输出有了更强的反馈感。那么，要如何实现呢？

1.1 需求来源

  在循环体里添加 print 语句或许能够帮上忙，但是这样又会遮蔽有用的信息。很自然地，我们会想到：

能不能设计一个类似下载安装进度条那样的东西，来简洁直观地展示进度呢？

  这也正是 tqdm 要实现的目标！

1.2 tqdm 快速安装

  由于 tqdm 不是 Python 的内置库，在使用前需要先进行安装。我们可以在终端输入以下命令进行安装：

# 直接安装，略慢
# pip install tqdm
# 使用国内（清华）镜像安装，推荐
pip install tqdm -i https://pypi.tuna.tsinghua.edu.cn/simple

二、代码解析

2.1 原理简介

  在 tqdm 库中，可以使用 tqdm 函数对可迭代类型（Iterable）数据进行装饰，返回 tqdm.std.tqdm 类型的可迭代数据（Iterable）。

  可见，装饰前后，二者都是可迭代的，区别在于后者会自动显示进度条！

  注意：tqdm.std.tqdm 类型只能遍历一次，不能重复使用！

2.2 快速上手

2.2.1 trange

  trange 函数是 tqdm 中最常用的函数，从其源码中可以看出，trange 是 tqdm 对 range 类型数据的装饰：

def trange(*args, **kwargs):
    """Shortcut for tqdm(range(*args), **kwargs)."""
    return tqdm(range(*args), **kwargs)

  使用 trange 可以 替代 range 进行迭代，并显示进度条：

import tqdm
import time

for i in tqdm.trange(20):
    pass
    time.sleep(0.5)

2.2.2 其他 Iterable

  除了对 range 类型，tqdm 还能装饰所有常见的可迭代类型：str、tuple、list、set、dict ……

import tqdm

a = "abcdefg"
b = (1, 2, 3, 4, 5)
c = ['a', 'b', 'c', 'd', 'e', 'f', 'g']
d = {
   'apple', 'banana', 'cherry', 'date'}
e = {
   'a': "Apple", 'b': "Banana", 'c': "Cherry", 'd': "Date"}

for i in tqdm.tqdm(a): pass
for i in tqdm.tqdm(b): pass
for i in tqdm.tqdm(c): pass
for i in tqdm.tqdm(d): pass
for i in tqdm.tqdm(e): pass

  这些 Iterable 类型都能用于创建进度条：

2.3 定制化显示

  在使用设置函数前，应特意将 tqdm 对象命名为新的变量（如 “progress_bar ”），以便调用函数使用。

2.3.1 自定义前后缀

  虽然在 2.2 中，进度条打印的信息已经非常详细