質問

ftplibを使ってFTPサーバーからファイルをアップロードしたりダウンロードしたりする簡単なコンソールアプリを書きました。

データチャンクがダウンロードされるたびに、パーセントのような数値表現でもいいので、アプリがダウンロード/アップロードの進捗状況を視覚的に表示するようにしたいのです。

重要なのは、前の行でコンソールに出力されたテキストをすべて消去しないようにしたいことです (つまり、更新された進捗状況を出力する間にターミナル全体を "clear" したくないのです)。

これはかなり一般的なタスクのようです。以前のプログラム出力を維持しながらコンソールに出力するプログレスバーまたは同様の視覚化を行うにはどうすればよいでしょうか？

どのように解決するのですか？

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)