终端中的文本进度条与块字符

Question

我写了一个简单的控制台应用程序，用来从FTP服务器上传和下载文件，使用的是ftplib这个库。

我希望这个应用能给用户显示一些下载和上传的进度信息；每当下载一小部分数据时，我想让它提供一个进度更新，哪怕只是简单的百分比表示。

很重要的一点是，我希望在打印更新的进度时，不要把之前在控制台上打印的所有文字都清除掉（也就是说，我不想在更新进度时“清空”整个终端）。

这似乎是一个比较常见的任务——我该如何制作一个进度条或者类似的可视化效果，让它在控制台上输出，同时又能保留之前的程序输出呢？

Answer 1

tqdm：让你的循环加上进度条，只需一秒钟:

>>> import time
>>> from tqdm import tqdm
>>> for i in tqdm(range(100)):
...     time.sleep(1)
... 
|###-------| 35/100  35% [elapsed: 00:35 left: 01:05,  1.00 iters/sec]

Answer 2

写入 '\r' 会把光标移动到行的开头。

这段代码会显示一个百分比计数器：

import time
import sys

for i in range(101):
    time.sleep(0.05)
    sys.stdout.write("\r%d%%" % i)
    sys.stdout.flush()

Answer 3

Python 3

一个简单可定制的进度条

这里汇集了很多下面答案中的内容，我经常使用这些（不需要导入任何库）。

注意：本答案中的所有代码都是为Python 3编写的；如果你想在Python 2中使用这些代码，请查看答案的最后部分。

# Print iterations progress
def printProgressBar (iteration, total, prefix = '', suffix = '', decimals = 1, length = 100, fill = '█', printEnd = "\r"):
    """
    Call in a loop to create terminal progress bar
    @params:
        iteration   - Required  : current iteration (Int)
        total       - Required  : total iterations (Int)
        prefix      - Optional  : prefix string (Str)
        suffix      - Optional  : suffix string (Str)
        decimals    - Optional  : positive number of decimals in percent complete (Int)
        length      - Optional  : character length of bar (Int)
        fill        - Optional  : bar fill character (Str)
        printEnd    - Optional  : end character (e.g. "\r", "\r\n") (Str)
    """
    percent = ("{0:." + str(decimals) + "f}").format(100 * (iteration / float(total)))
    filledLength = int(length * iteration // total)
    bar = fill * filledLength + '-' * (length - filledLength)
    print(f'\r{prefix} |{bar}| {percent}% {suffix}', end = printEnd)
    # Print New Line on Complete
    if iteration == total: 
        print()

示例用法

import time

# A List of Items
items = list(range(0, 57))
l = len(items)

# Initial call to print 0% progress
printProgressBar(0, l, prefix = 'Progress:', suffix = 'Complete', length = 50)
for i, item in enumerate(items):
    # Do stuff...
    time.sleep(0.1)
    # Update Progress Bar
    printProgressBar(i + 1, l, prefix = 'Progress:', suffix = 'Complete', length = 50)

示例输出

Progress: |█████████████████████████████████████████████-----| 90.0% Complete

更新

评论中讨论了一个选项，可以让进度条根据终端窗口的宽度动态调整。虽然我不推荐这样做，但这里有一个链接，实现了这个功能（并说明了注意事项）。

上述功能的单次调用版本

下面的评论提到了一篇很好的回答，是针对类似问题的。我喜欢它展示的易用性，于是写了一个类似的版本，但选择不导入sys模块，同时添加了一些原始printProgressBar函数的功能。

这种方法相比于上面的原始函数有一些好处，包括不需要初始调用函数来打印0%的进度条，以及使用enumerate变得可选（也就是说，不再需要明确调用它才能让函数正常工作）。

def progressBar(iterable, prefix = '', suffix = '', decimals = 1, length = 100, fill = '█', printEnd = "\r"):
    """
    Call in a loop to create terminal progress bar
    @params:
        iterable    - Required  : iterable object (Iterable)
        prefix      - Optional  : prefix string (Str)
        suffix      - Optional  : suffix string (Str)
        decimals    - Optional  : positive number of decimals in percent complete (Int)
        length      - Optional  : character length of bar (Int)
        fill        - Optional  : bar fill character (Str)
        printEnd    - Optional  : end character (e.g. "\r", "\r\n") (Str)
    """
    total = len(iterable)
    # Progress Bar Printing Function
    def printProgressBar (iteration):
        percent = ("{0:." + str(decimals) + "f}").format(100 * (iteration / float(total)))
        filledLength = int(length * iteration // total)
        bar = fill * filledLength + '-' * (length - filledLength)
        print(f'\r{prefix} |{bar}| {percent}% {suffix}', end = printEnd)
    # Initial Call
    printProgressBar(0)
    # Update Progress Bar
    for i, item in enumerate(iterable):
        yield item
        printProgressBar(i + 1)
    # Print New Line on Complete
    print()

示例用法

import time

# A List of Items
items = list(range(0, 57))

# A Nicer, Single-Call Usage
for item in progressBar(items, prefix = 'Progress:', suffix = 'Complete', length = 50):
    # Do stuff...
    time.sleep(0.1)

示例输出

Progress: |█████████████████████████████████████████████-----| 90.0% Complete

Python 2

要在Python 2中使用上述函数，请在脚本的顶部设置编码为UTF-8：

# -*- coding: utf-8 -*-

并将这一行中的Python 3字符串格式替换为：

print(f'\r{prefix} |{bar}| {percent}% {suffix}', end = printEnd)

使用Python 2的字符串格式：

print('\r%s |%s| %s%% %s' % (prefix, bar, percent, suffix), end = printEnd)