☰

ブロック文字を含むターミナルのテキスト進捗バー [closed] 質問する

tag-icon • tag-icon python console progress updating
ブロック文字を含むターミナルのテキスト進捗バー [closed] 質問する

ftplib を使用して FTP サーバーからファイルをアップロードおよびダウンロードするための簡単なコンソール アプリを作成しました。

アプリでダウンロード/アップロードの進行状況をユーザーに視覚的に表示し、データ チャンクがダウンロードされるたびに、たとえそれがパーセンテージなどの数値表現であっても、進行状況の更新を提供したいと思います。

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

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

ベストアンサー1

Python3 について

シンプルでカスタマイズ可能な進捗バー

以下は、私が定期的に使用する多くの回答の集約です (インポートは不要)。

注:この回答のすべてのコードは 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)

おすすめ記事