1.7 万 Star!一个简单实用的 Python 进度条库

【导读】:有的 Python 程序较大,执行需要花费较长的时间,有的用户在“盲目”地等待运行结果,但又不能明确知道程序进展到什么程度的时候,很有可能因心情急躁而终止程序。

本文介绍的这个有着 1.7 万 Star 的开源库,就能解决这个烦恼。

https://github.com/tqdm/tqdm

1、Tqdm 简介

使用 Python Tqdm 进度条库,可以让 python 程序执行进度可视化。

示例

在阿拉姆语(Aramaic)、希伯来语(Hebrew)、和阿拉伯语(Arabic)中,闪米特语(Semitic)词根q-d-m通常与前进取得进步的意思挂钩。例如,阿拉伯语单词 taqaddum (تقدّم) 的意思是“进步”。进步是重要的,就像每一部令人愉悦的电影都会向你传达一个哲理——旅途和目的地一样重要。

大多数程序都有一个明确目标,那就是程序运行的最终(结束)状态,成功还是失败!但是往往有时候程序的运行可能需要很长时间。尽管计算机没有情感,不在乎程序执行时间的长短,可是人们是在乎的。

随着时间推移,程序运行人员或用户的疑问会不断蔓延(程序崩溃了吗?磁盘跳动了吗?操作系统是否将所有计算资源分配给了其他任务?)当程序运行过程中长时间没有任何的进展迹象时,程序运行人员可能会疑虑、烦躁,不愿意继续等待下去。而本文讲的 tqdm 库便有助于明确显示程序的执行进度。

2、使用方法

tqdm 库模块可以在命令控制台一起使用,但是也支持我最喜欢的开发环境之一的 Jupyter notebook。如果想在 Jupyter notebook 中使用 tqdm,notebook 模块与 tqdm 接口兼容,需要导入 notebook 子模块并安装ipywidget

这就意味着你可以在导入 tqdm 库操作之前做一下条件判断,这个判断方法是检查_main_模块中是否有get_ipython全局变量。虽然上面这个判断导库方法是一个启发式的,但它是一个相当准确的方法:

import sys
if hasattr(sys.modules["__main__"],"get_ipython"):
    from tqdm import notebook as tqdm
else:
    import tqdm

举个最简单的情况来助于理解一下,某程序需要执行一定数量的迭代(迭代次数预先可知),但是这些迭代中的每一次迭代花费大约相同的时间。例如,一个可以计算任意数字平方根的算法,算法是从1开始,然后计算一个进度估计。

def improve_guess(rt, n):
    return (rt + n/rt) / 2

对以上代码的少许改进可以让你更容易理解:

guess = 1
target = 2
for i in tqdm.trange(10):
    guess = improve_guess(guess, target)

精确到小数点后十位:

round(2 - guess*guess, 10)
0.0

再举一个稍微复杂的tqdm例子,当处理的元素数量已知且计算每个元素的时间相似。例如,计算一些随机数字的乘机:

import random
numbers = [random.uniform(0, 2.8) for i in range(100)]
numbers[:5]
[2.6575636572230916,
0.1286674965830302,
1.0634250104041332,
1.1760969844376505,
0.45192978568125486]

数值元素有了,接下来使用tqdm显示进度条,使用tqdm最简单的方法是封装Python中可迭代的对象。

result = 1
for num in tqdm.tqdm(numbers):
    result *= num
result
2.4081854901728303

但是,不是所有的事情都是可预测的,其中不可预测的事情之一是网络速度。下载大文件时,衡量进度的唯一的方法是显示已经下载了多少文件:

url = "https://www.python.org/ftp/python/3.9.0/Python-3.9.0.tgz"
import httpx
with httpx.stream("GET", url) as response:
    total = int(response.headers["Content-Length"])
    with tqdm.tqdm(total=total) as progress:
        for chunk in response.iter_bytes():
            progress.update(len(chunk))

有时,“嵌套”进度条是有意义的。例如,如果正在下载一个目录,则需要一个跟踪文件的进度条和每个文件的进度条。
下面是一个示例(但没有实际下载目录):

files = [f"vid-{i}.mp4" for i in range(4)]
for fname in tqdm.tqdm(files, desc="files"):
    total = random.randrange(10**9, 2 * 10**9)
    with tqdm.tqdm(total=total, desc=fname) as progress:
        current = 0
        while current < total:
            chunk_size = min(random.randrange(10**3, 10**5), total - current)
            current += chunk_size
            if random.uniform(0, 1) < 0.01:
                time.sleep(0.1)
            progress.update(chunk_size)

因此,如果你的程序需要一段时间才能显示最终结果,为了避免用户感到沮丧:显示它的进度情况!

开源前哨 日常分享热门、有趣和实用的开源项目。参与维护 10万+ Star 的开源技术资源库,包括:Python、Java、C/C++、Go、JS、CSS、Node.js、PHP、.NET 等。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,968评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,601评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,220评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,416评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,425评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,144评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,432评论 3 401
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,088评论 0 261
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,586评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,028评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,137评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,783评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,343评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,333评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,559评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,595评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,901评论 2 345

推荐阅读更多精彩内容