python进度条 tqdm使用教程

安装tqdm

tqdm是一个显示进度条的python工具包。安装命令如下

conda install tqdm

或

pip install tqdm

在循环中显示进度条

from tqdm import tqdm, trange

1. 使用tqdm.tqdm()实现进度条

示例：

for i in tqdm(range(20), desc='It\'s a test'):
    time.sleep(0.1)

2. tqdm()主要参数默认值与解释

iterable=None，可迭代对象。如上一节中的range(20)
desc=None，传入str类型，作为进度条标题。如上一节中的desc='It\'s a test'
total=None，预期的迭代次数。一般不填，默认为iterable的长度。
leave=True，迭代结束时，是否保留最终的进度条。默认保留。
file=None，输出指向位置，默认是终端，一般不需要设置。
ncols=None，可以自定义进度条的总长度
unit，描述处理项目的文字，默认’it’，即100it/s；处理照片设置为’img’，则为100img/s
postfix，以字典形式传入详细信息，将显示在进度条中。例如postfix={'value': 520}
unit_scale，自动根据国际标准进行项目处理速度单位的换算，例如100000it/s换算为100kit/s

3. tqdm()的返回值

tqdm()的返回值是一个可迭代对象，迭代的每一个元素就是iterable的每一个参数。该返回值可以修改进度条信息。示例

with tqdm(range(100), desc='Test') as tbar:
    for i in tbar:
        tbar.set_postfix(loss=i/100, x=i)
        tbar.update()  # 默认参数n=1，每update一次，进度+n
        time.sleep(0.2)

4. tqdm.trange()

该函数实际上是封装了一下tqdm()。源代码为

def trange(*args, **kwargs):
    """
    A shortcut for tqdm(xrange(*args), **kwargs).
    On Python3+ range is used instead of xrange.
    """
    return tqdm(_range(*args), **kwargs)

显然，trange()的第一个参数为可迭代对象的长度，其余参数与tqdm()一致。
示例

for i in trange(100, desc='Test1'):
    time.sleep(0.2)

或

with trange(100, desc='Test2') as tbar:
    for i in range(100):
        tbar.set_postfix(loss=i/100, x=i)
        tbar.update()
        time.sleep(0.2)

5. 循环过程中输出额外内容

在循环进行中，你可能想要输出一些内容，但是直接使用print输出会导致进度条出现多行。

解决方法有两种

1. 参考【3. tqdm()的返回值】示例中的tbar.set_postfix方法，将内容直接显示在进度条尾部。
2. 使用tqdm.write('你要显示的内容。')方法；若使用pycharm的Run窗口运行，该方法仍无效或存在格式问题，可能是pycharm的bug，此时请使用方法1或改用终端(Terminal)运行代码。

for i in tqdm(range(5), desc='Test'):
    tqdm.write('当前i={}'.format(i))
    time.sleep(0.5)

6. 无法获取迭代器长度的坑

有些迭代器是只能迭代一次的（如zip()），甚至连len()方法都没有，即tqdm就无法得知它的总长度，从而导致进度条显示不出来（如下图）

解决方法：你必须指定total参数，如下

x = range(20)
y = range(20)
data = zip(x, y)
for i in tqdm(data, desc='Test', total=len(x)):
    time.sleep(0.1)

*其他方法实现进度条

def process_bar(current, total, prefix='', auto_rm=True):
    bar = '=' * int(current / total * 50)
    bar = f' {prefix} |{bar.ljust(50)}| ({current}/{total}) {current / total:.1%} | '
    print(bar, end='\r', flush=True)
    if auto_rm and current == total:
        print(end=('\r' + ' ' * len(bar) + '\r'), flush=True)

for i in range(0, 100):
    time.sleep(0.1)
    process_bar(i+1, 100, '首部信息', auto_rm=False)

print('进度条演示')