【python】tqdm 进度条详解

最新推荐文章于 2024-04-12 17:40:02 发布
最新推荐文章于 2024-04-12 17:40:02 发布
阅读量3.5k 收藏 35
点赞数 37
分类专栏： Python趣味应用 python语法技巧 文章标签： python 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_44844635/article/details/135747093
版权

全文一览

一、前言

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

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 中，进度条打印的信息已经非常详细了，但或许这还不能满足我们定制化的需要！

当安装一个含多个组件的软件时，如何显示当前安装到哪个组件了呢？

  tqdm 为此编写了 set_description、set_description_str、set_postfix、set_postfix_str 等常用函数，在此仅以 set_description 和 set_postfix 为例进行演示。

import time
import random
from tqdm import tqdm

# 组件中文名称
install_components_cn = ["运行时库和依赖项", "驱动程序", "数据库", "命令行工具", "网络组件", "第三方库和框架"]

progress_bar = tqdm(install_components_cn)
count = 0
for info in progress_bar:
    count += 1
    # 前缀
    progress_bar.set_description(f"正在安装{info}")
    # 后缀
    progress_bar.set_postfix({"info": f"第{count}项"})
    # 模拟安装时间，设置随机 0.5~3.0 秒
    time.sleep(random.uniform(0.5, 3.0))

  set_description 以字符串为参数，为进度条设置前缀；set_postfix 以字典为参数，为进度条添加备注信息。
前后缀

set_description_str 方法跟 set_description 方法目的、用法一致；
set_postfix_str 方法跟 set_postfix 方法目标一致，但前者传入字符串，后者传入字典。

2.3.2 自定义刻度

  在实际处理工作流 stream 时，每个文件 file 的大小并不完全一样，处理后进度条的进展不能视作均等的 1/n 。

那么，如何设置进度条前进的刻度跟文件大小成正相关呢？

  这时候，不能直接使用 tqdm 函数对工作流进行包装，而应该使用 total 关键字设置总刻度的长度，再用 update 方法让进度条前进一定的刻度。
  注意：此时 total 关键字的参数必须进行设置，因为其默认为 None！否则虽然会显示进度，但不会有进度条！

import time
import random
from tqdm import tqdm

# 模拟多个文件，每个文件分别有 4、9、3、7 段
files = [[1, 2, 3, 4], [1, 2, 3, 4, 5, 6, 7, 8, 9], [1, 2, 3], [1, 2, 3, 4, 5, 6, 7]]

# 设置进度条总长度 total 为 files 的总段数
progress_bar = tqdm(total=sum(len(file) for file in files))
count = 0
for file in files:
    count += 1
    # 设置前后缀
    # progress_bar.set_description(f"file:{file}")
    # progress_bar.set_postfix({"info": f"第{count}项"})
    time.sleep(random.uniform(0.5, 3.0))
    # 进度条向前滚动 len(file) 刻度
    progress_bar.update(len(file))
progress_bar.close()

  “progress_bar.close()” 强烈推荐保留，其作用在于确保进度条能够达到 100% 并完成显示！
update
  在更新进度条的时候，我们同样还可以设置前后缀！

将 tqdm 的 total 关键字设置为 1，然后将 update 的参数设置为 len(file) / sum(len(file) for file in files)，仍能达到相同的效果。

三、实战演示

  以安装 my_app 的软件为例，其基本信息如下 my_app 字典所示：

import time
import random
from tqdm import tqdm

my_app = {"运行时库和依赖项": 7, "驱动程序": 19, "数据库": 4,
          "命令行工具": 3, "网络组件": 4, "第三方库和框架": 23}


def set_up(app):
    total_size = sum(v for k, v in app.items())  # 总大小为 100
    progress_bar = tqdm(app, total=total_size)
    for component in progress_bar:
        size = app[component]
        progress_bar.set_description(f"正在安装{component}")
        # progress_bar.set_description_str(f"正在安装{component}")
        progress_bar.set_postfix({"size": f"{size}MB"})
        # progress_bar.set_postfix_str(f"size:{size}MB")
        time.sleep(random.uniform(0.5, 3.0))  # 模拟安装用时
        progress_bar.update(size)
    progress_bar.close()


if __name__ == '__main__':
    set_up(my_app)

  运行结果如下图所示：
进度条展示

四、运行效率

引入这样一个实时显示进度的功能，会对我们的代码执行效率有多大影响呢？

  对此，我们设计简单的加法运算和耗时的处理两种场景，代入不同大小的 n，分析使用 tqdm 与否的执行时间差。

4.1 简单加法

  编写是否使用 tqdm 进行求和的两个函数，比较它们在 n = 100、100 000、100 000 000 时各自的运行时间：
  

import time
from tqdm import trange


def run_without_tqdm(n):
    start_time = time.time()
    res = 0
    for i in range(n):
        res += i
    print(time.time() - start_time)


def run_with_tqdm(n):
    start_time = time.time()
    res = 0
    for i in trange(n):
        res += i
    print(time.time() - start_time)


if __name__ == '__main__':
    # n = 10 ** 2
    n = 10 ** 5
    # n = 10 ** 8
    run_without_tqdm(n)
    run_with_tqdm(n)

  如下图所示，带 tqdm 的运行时间是原函数的无数倍、13倍、4倍：
对比1

4.2 循环体耗时运算

  编写是否使用 tqdm 进行等待的两个函数，比较它们在 n = 100、1 000、10 000 时各自的运行时间：
  

import time
from tqdm import trange


def run_without_tqdm(n):
    start_time = time.time()
    for i in range(n):
        time.sleep(0.001)
    print(time.time() - start_time)


def run_with_tqdm(n):
    start_time = time.time()
    for i in trange(n):
        time.sleep(0.001)
    print(time.time() - start_time)


if __name__ == '__main__':
    # n = 10 ** 2
    # n = 10 ** 3
    n = 10 ** 4
    run_without_tqdm(n)
    run_with_tqdm(n)

  如下图，带 tqdm 的运行时间是原函数的2倍、1倍、1倍：
对比2

4.3 结论

  从 1.1 和 4.2 的对比结果中，不难看出，使用 tqdm 会带来一定的额外消耗。但当循环足够多或者循环体耗时较长时，tqdm 对效率的影响可以忽略不计！

五、完整代码

#!/usr/bin/env python
# -*- coding:utf-8 -*-
# @FileName  : progress_bar.py
# @Time      : 2024/1/22 14:31
# @Author    : Carl.Zhang
# Function   : progress_bar

# 2.2 快速上手 —— trange
import tqdm
import time

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

# # 2.2 快速上手 —— 其他 Iterable：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


# # 2.3 定制化显示 —— 前缀、后缀
# import time
# import random
# from tqdm import tqdm
#
# # 组件中英文名称
# # install_components_en = ["Runtime libraries and dependencies", "Drivers", "Database", "Command-line tools",
# #                          "Networking components", "Third-party libraries and frameworks"]
# install_components_cn = ["运行时库和依赖项", "驱动程序", "数据库", "命令行工具", "网络组件", "第三方库和框架"]
#
# progress_bar = tqdm(install_components_cn)
# count = 0
# for component in progress_bar:
#     count += 1
#     # 前缀
#     # progress_bar.set_description(f"正在安装{component}")
#     # 后缀
#     progress_bar.set_postfix({"info": f"第{count}项"})
#     # 模拟安装时间，设置随机 0.5~3.0 秒
#     time.sleep(random.uniform(0.5, 3.0))


# # # 2.3 定制化 —— stream流 与 update更新
# import time
# import random
# from tqdm import tqdm
#
# # 模拟多个文件，每个文件分别有 4、9、3、7 段
# files = [[1, 2, 3, 4], [1, 2, 3, 4, 5, 6, 7, 8, 9], [1, 2, 3], [1, 2, 3, 4, 5, 6, 7]]
#
# # 设置进度条总长度 total 为 files 的总段数
# progress_bar = tqdm(total=sum(len(file) for file in files))
# count = 0
# for file in files:
#     count += 1
#     # 设置前后缀
#     progress_bar.set_description(f"file:{file}")
#     progress_bar.set_postfix({"info": f"第{count}项"})
#     time.sleep(random.uniform(0.5, 3.0))
#     # 进度条向前滚动 len(file)/total 刻度
#     progress_bar.update(len(file))
# progress_bar.close()


# # 3 实战演示
# import time
# import random
# from tqdm import tqdm
#
# my_app = {"运行时库和依赖项": 7, "驱动程序": 19, "数据库": 4,
#           "命令行工具": 3, "网络组件": 4, "第三方库和框架": 22}
#
#
# def set_up(app):
#     total_size = sum(v for k, v in app.items())  # 总大小为 100
#     progress_bar = tqdm(app, total=total_size)
#     for component, size in app.items():
#         progress_bar.set_description(f"正在安装{component}")
#         # progress_bar.set_description_str(f"正在安装{component}")
#         # progress_bar.set_postfix({"size": f"{size}MB"})
#         progress_bar.set_postfix_str(f"size:{size}MB")
#         time.sleep(random.uniform(0.5, 3.0))  # 模拟安装用时
#         progress_bar.update(size)
#     progress_bar.close()
#
#
# if __name__ == '__main__':
#     set_up(my_app)


# # 4.1 运行效率 —— 简单加法
# import time
# from tqdm import trange
#
#
# def run_without_tqdm(n):
#     start_time = time.time()
#     res = 0
#     for i in range(n):
#         res += i
#     print(time.time() - start_time)
#
#
# def run_with_tqdm(n):
#     start_time = time.time()
#     res = 0
#     for i in trange(n):
#         res += i
#     print(time.time() - start_time)
#
#
# if __name__ == '__main__':
#     # n = 10 ** 2
#     n = 10 ** 5
#     # n = 10 ** 8
#     run_without_tqdm(n)
#     run_with_tqdm(n)


# # 4.2 运行效率 —— 循环体耗时运算
# import time
# from tqdm import trange
#
#
# def run_without_tqdm(n):
#     start_time = time.time()
#     for i in range(n):
#         time.sleep(0.001)
#     print(time.time() - start_time)
#
#
# def run_with_tqdm(n):
#     start_time = time.time()
#     for i in trange(n):
#         time.sleep(0.001)
#     print(time.time() - start_time)
#
#
# if __name__ == '__main__':
#     # n = 10 ** 2
#     # n = 10 ** 3
#     n = 10 ** 4
#     run_without_tqdm(n)
#     run_with_tqdm(n)


# # 封面
# import time
# from tqdm import trange
#
# download = trange(15)
# for i in download:
#     download.set_description("下载中...")
#
#
# install = trange(20)
# for i in install:
#     install.set_description("安装中...")
#
#
# update = trange(35)
# for i in update:
#     update.set_description("升级中...")
#     time.sleep(0.5)

更多 python 的使用方法和应用，敬请关注后续更新~

今夕晚风依旧
关注
  • 37
    点赞
  • 踩
  • 35
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
专栏目录
Python进度条之 tqdm
01-21
Python进度条之 tqdmtqdm的安装与导入tqdm的一些简单的例子自拟定显示信息高级应用多进程进度条注意： tqdm是一个使用简单，且美观的进度条的包，下面看一下效果。 使用这个库，我分首先要导入库函数 tqdm的安装与导入 pip install tqdm 1.2 导入 from tqdm import tqdm 后面的这个tqdm是一个类，前面的tqdm是一个package，当然这个包里面还有其他的方法和类了。 tqdm的一些简单的例子 from tqdm import tqdm pbar = tqdm(range(1000)) for char in pbar: t
Python 任务进度条展示tqdm实现 示例代码
最新发布
06-14
使用tqdm实现进度条显示资源为python实现任务进度条的示例代码，使用tqdm实现进度条显示资源为python实现任务进度条的示例代码，使用tqdm实现进度条显示资源为python实现任务进度条的示例代码，使用tqdm实现进度条...
python 解决tqdm模块不能单行显示的问题
09-17
主要介绍了python 解决tqdm模块不能单行显示的问题，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
Python 进度显示工具（tqdm）
Vincent的博客
04-12 1058
tqdm 是一个进度显示工具，当任务执行的等待时间较长时，通过tqdm模块可以模拟出一个进度条，由此可以看到任务执行进度，获得更好的体验。
详细介绍Python进度条tqdm的使用
12-31
前言 有时候在使用Python处理比较耗时操作的时候，为了便于观察处理进度，这时候就需要通过进度条将处理情况进行可视化展示，以便我们能够及时了解情况。这对于第三方库非常丰富的Python来说，想要实现这一功能并不是什么难事。 tqdm就能非常完美的支持和解决这些问题，可以实时输出处理进度而且占用的CPU资源非常少，支持windows、Linux、mac等系统，支持循环处理、多进程、递归处理、还可以结合linux的命令来查看处理情况，等进度展示。 大家先看看tqdm的进度条效果 安装 github地址：https://github.com/tqdm/tqdm 想要安装tqdm也是非常简单的
tqdm详细教程，实现tqdm进度条完美设计；解决进度条多行一直刷新的问题；如何使得滚动条不上下滚动(保持一行内滚动)
点赞的都能无bug通过！
12-09 4898
tqdm是一个python进度条库，可以在 Python长循环中添加一个进度提示信息。
Python工具——tqdm:进度条
zhenaoxi1077的博客
07-10 611
进度条工具 1）安装 pip3 install tqdm 2)使用： from time import sleep from tqdm import tqdm pbar=tqdm(range(15)) for i in pbar: sleep(1)
tqdm进度条使用简介
chumingqian的博客
05-07 3033
1. tqdm 进度条可视化库，它的名字叫做 tqdm ，可以帮助我们监测程序运行的进度，用户只需要封装可迭代对象即可。 2. 使用方式 不同运行环境使用方式稍有不同，可根据警告自行调整。 tqdm 主要参数可选参数众多，我们先看一下常用的一些参数。 主要参数： iterable: 可迭代的对象, 在手动更新时不需要进行设置 desc: str, 左边进度条的描述性文字 total: 总的项目数 leave: bool, 执行完成后是否保留进度条 file: 输出指向位置, 默认是终端, 一般不需要设置 n
python使用tqdm库实现进度条详解
IT之一小佬的博客
04-23 6143
python使用tqdm库实现进度条详解
Python进度条工具tqdm
人无远虑，必有近忧
12-21 3313
　在日常运行程序的过程中常常涉及到循环迭代过程，对于执行时间很短的程序来说倒无所谓，但对于运行过程有明显耗时的涉及循环迭代的程序，为其加上进度条（progress bar），是帮助我们监测代码执行进度以及处理中间异常错误非常实用的技巧。
Python进度条tqdm详细介绍
热门推荐
修炼之路
07-28 2万+
前言 有时候在使用Python处理比较耗时操作的时候，为了便于观察处理进度，这时候就需要通过进度条将处理情况进行可视化展示，以便我们能够及时了解情况。这对于第三方库非常丰富的Python来说，想要实现这一功能并不是什么难事。 tqdm就能非常完美的支持和解决这些问题，可以实时输出处理进度而且占用的CPU资源非常少，支持windows、Linux、mac等系统，支持循环处理、多进程、递归处理、还可以...
【python】tqdm库：在循环中显示进度条
qq_43308156的博客
04-19 915
是一个python库，可以用于在，方便用户了解程序执行的进度。tqdm 的全称是"progress bar (progressive meter)"，读作"taqadum"，意思是"进展"或"前进"。
python tqdm实现进度条的示例代码
01-19
\quad \quad 有时候在使用Python处理比较耗时操作的时候，为了便于观察处理进度，这时候就需要通过进度条将处理情况进行可视化展示，以便我们能够及时了解情况。这对于第三方库非常丰富的Python来说，想要实现这一...
6.进阶-tqdm-进度条
小白的博客
11-02 605
基于迭代对象运行: tqdm(iterator) import tqdm for i in tqdm.tqdm(range(10), desc="测试进度条"): time.sleep(1) 手动更新 import tqdm with tqdm.tqdm(total=100) as pbar: pbar.set_description("测试进度条") for i in range(10): time.sleep(1) pbar.update(10)
【python第三方库】tqdm——超详细解读
AI_dataloads的博客
11-01 1万+
tqdm是一个快速、可扩展的Python进度条，可以在Python长循环中添加一个进度提示信息，用户只需要封装任意的迭代器tqdm(iterator)。它可以帮助我们监测程序运行的进度，估计运行的时长，甚至可以协助debug。对于在长时间运行的任务中显示进度很有用，因为它可以让用户知道任务正在进行。
让你的代码动起来:Python进度条神器tqdm详解及应用实例
woaimx_1314的博客
06-05 2136
from tqdm import tqdm # 假设我们有一个训练数据集 train_dataloader 和一个模型 model for epoch in range(num_epochs): epoch_iterator = tqdm(train_dataloader, desc= "Training (Epoch %d)" % epoch) for step, batch in enumerate(epoch_iterator): # 模型训练的代码 # ...这种等待的痛苦，我想你我都有切身体会。
python打造可视化进度条
xiaoganbuaiuk的博客
12-22 1334
通过以上示例，我们之道如何在 Python 中使用tqdm库以及其他第三方库创建文本进度条，以及如何通过tkinter创建图形化进度条。这些示例代码可以直接应用于你的项目中，提升用户体验，同时让你更好地掌握进度条的使用技巧。在实际项目中，根据需求和场景的不同，你还可以进一步定制和扩展这些进度条的功能。感兴趣的小伙伴，赠送全套Python学习资料，包含面试题、简历资料等具体看下方。一、Python所有方向的学习路线。
tqdm进度条
kundezui的博客
03-14 681
参数说明 官方文档 class tqdm(): def __init__(self, #所有参数均为【可选】 iterable=None, #可迭代对象，在手动更新时不需要进行设置 desc=None, #str， 左边进度条描述文章（类似说明） total=None, #总的项目数 leave=True, #迭代完成后是否保留进度条 file=None, #输出指向位置，默认是终端，一般不需要设置 ncols=None, #调整进度条宽度，默认是根
tqdm进度条基本用例，以及在pytorch中的使用
Decennie的博客
07-29 5494
文章目录方法一: 传入可迭代对象方法二: trange方法三: 可以为进度条设置描述方法四：write 方法方法五：手动控制进度条： Tqdm 是 Python 进度条库，可以在 Python 长循环中添加一个进度提示信息。用户只需要封装任意的迭代器，是一个快速、扩展性强的进度条工具库。 用法： tqdm(iterator) 安装方法： pip install tqdm 方法一: 传入可迭代对象 import time from tqdm import * for i in tqdm(range(10
tqdm
05-31
tqdm 是 Python 中一个非常实用的进度条库，可以用来显示迭代过程中的进度条和剩余时间等信息。在训练过程中，特别是对于大规模数据集和深度学习模型，通常需要很长时间才能完成，这时候使用 tqdm 可以让我们更好地了解训练的进展情况，以及避免让训练过程变得过于枯燥乏味。用法非常简单，只需在循环中使用 tqdm 函数即可。例如： ``` from tqdm import tqdm for i in tqdm(range(10000)): # do something here ``` 这样就可以在循环过程中显示进度条了。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

今夕晚风依旧

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值