コンソールのテキストプログレスバー[終了]

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

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

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

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

シンプルでカスタマイズ可能なプログレスバー

以下は、私が定期的に使用する以下の多くの回答の集約です（インポートは必要ありません）。

# 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('\r%s |%s| %s%% %s' % (prefix, bar, percent, suffix), end = printEnd)
    # Print New Line on Complete
    if iteration == total: 
        print()

注：これはPython 3用です。Python 2でこれを使用する方法の詳細については、コメントを参照してください。

使用例

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

更新

進行状況バーを端末ウィンドウの幅に動的に調整できるようにするオプションに関するコメントで議論がありました。私はこれをお勧めしませんが、この機能を実装する要点を以下に示します（警告に注意）。

'\ r'を書き込むと、カーソルが行の先頭に戻ります。

これはパーセントカウンターを表示します：

import time
import sys

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

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]

を\rコンソールに書き込みます。これは「キャリッジリターン」であり、それ以降のすべてのテキストは行の先頭にエコーされます。何かのようなもの：

def update_progress(progress):
    print '\r[{0}] {1}%'.format('#'*(progress/10), progress)

これはあなたに次のようなものを与えます： [ ########## ] 100%

コードは10行未満です。

ここに要点：https : //gist.github.com/vladignatyev/06860ec2040cb497f0f3

import sys


def progress(count, total, suffix=''):
    bar_len = 60
    filled_len = int(round(bar_len * count / float(total)))

    percents = round(100.0 * count / float(total), 1)
    bar = '=' * filled_len + '-' * (bar_len - filled_len)

    sys.stdout.write('[%s] %s%s ...%s\r' % (bar, percents, '%', suffix))
    sys.stdout.flush()  # As suggested by Rom Ruben

Pythonのモーツァルト、Armin Ronacherによって書かれたクリックライブラリを試してください。

$ pip install click # both 2 and 3 compatible

シンプルな進行状況バーを作成するには：

import click

with click.progressbar(range(1000000)) as bar:
    for i in bar:
        pass 

これは次のようになります。

# [###-------------------------------]    9%  00:01:14

心に合わせてコンテンツをカスタマイズ：

import click, sys

with click.progressbar(range(100000), file=sys.stderr, show_pos=True, width=70, bar_template='(_(_)=%(bar)sD(_(_| %(info)s', fill_char='=', empty_char=' ') as bar:
    for i in bar:
        pass

カスタムルック：

(_(_)===================================D(_(_| 100000/100000 00:00:02

さらに多くのオプションがあります。APIドキュメントを参照してください。

 click.progressbar(iterable=None, length=None, label=None, show_eta=True, show_percent=None, show_pos=False, item_show_func=None, fill_char='#', empty_char='-', bar_template='%(label)s [%(bar)s] %(info)s', info_sep=' ', width=36, file=None, color=None)

私はゲームに遅れていることに気づきましたが、これは私が書いたわずかにYumスタイル（Red Hat）のものです（ここでは100％の精度は得られませんが、そのレベルの精度のプログレスバーを使用している場合は、とにかく間違っています）：

import sys

def cli_progress_test(end_val, bar_length=20):
    for i in xrange(0, end_val):
        percent = float(i) / end_val
        hashes = '#' * int(round(percent * bar_length))
        spaces = ' ' * (bar_length - len(hashes))
        sys.stdout.write("\rPercent: [{0}] {1}%".format(hashes + spaces, int(round(percent * 100))))
        sys.stdout.flush()

このようなものを生成する必要があります：

Percent: [##############      ] 69%

...ブラケットが静止し、ハッシュだけが増加する場所。

これは、デコレータとしてうまく機能する可能性があります。別の日のために...

このライブラリを確認してください：clint

進行状況バーを含む多くの機能があります：

from time import sleep  
from random import random  
from clint.textui import progress  
if __name__ == '__main__':
    for i in progress.bar(range(100)):
        sleep(random() * 0.2)

    for i in progress.dots(range(100)):
        sleep(random() * 0.2)

このリンクは、その機能の簡単な概要を提供します

Pythonで書かれたプログレスバーの良い例は次のとおりです：http : //nadiana.com/animated-terminal-progress-bar-in-python

しかし、あなたがそれを自分で書きたいなら。あなたはcurses物事をより簡単にするためにモジュールを使うことができます:)

[編集]おそらくより簡単なのは、呪いの言葉ではありません。しかし、本格的なcuiを作成する場合は、cursesが多くのことを行います。

[編集]古いリンクが死んでいるので、Pythonプログレスバーの独自のバージョンを用意しました。https：//github.com/WoLpH/python-progressbarから入手してください。

import time,sys

for i in range(100+1):
    time.sleep(0.1)
    sys.stdout.write(('='*i)+(''*(100-i))+("\r [ %d"%i+"% ] "))
    sys.stdout.flush()

出力

[29％] ===================

パイルに追加するために、ここに使用できるオブジェクトがあります

import sys

class ProgressBar(object):
    DEFAULT_BAR_LENGTH = 65
    DEFAULT_CHAR_ON  = '='
    DEFAULT_CHAR_OFF = ' '

    def __init__(self, end, start=0):
        self.end    = end
        self.start  = start
        self._barLength = self.__class__.DEFAULT_BAR_LENGTH

        self.setLevel(self.start)
        self._plotted = False

    def setLevel(self, level):
        self._level = level
        if level < self.start:  self._level = self.start
        if level > self.end:    self._level = self.end

        self._ratio = float(self._level - self.start) / float(self.end - self.start)
        self._levelChars = int(self._ratio * self._barLength)

    def plotProgress(self):
        sys.stdout.write("\r  %3i%% [%s%s]" %(
            int(self._ratio * 100.0),
            self.__class__.DEFAULT_CHAR_ON  * int(self._levelChars),
            self.__class__.DEFAULT_CHAR_OFF * int(self._barLength - self._levelChars),
        ))
        sys.stdout.flush()
        self._plotted = True

    def setAndPlot(self, level):
        oldChars = self._levelChars
        self.setLevel(level)
        if (not self._plotted) or (oldChars != self._levelChars):
            self.plotProgress()

    def __add__(self, other):
        assert type(other) in [float, int], "can only add a number"
        self.setAndPlot(self._level + other)
        return self
    def __sub__(self, other):
        return self.__add__(-other)
    def __iadd__(self, other):
        return self.__add__(other)
    def __isub__(self, other):
        return self.__add__(-other)

    def __del__(self):
        sys.stdout.write("\n")

if __name__ == "__main__":
    import time
    count = 150
    print "starting things:"

    pb = ProgressBar(count)

    #pb.plotProgress()
    for i in range(0, count):
        pb += 1
        #pb.setAndPlot(i + 1)
        time.sleep(0.01)
    del pb

    print "done"

結果は：

starting things:
  100% [=================================================================]
done

これは最も一般的であると考えられますが、頻繁に使用する場合に便利です。

tqdm。（pip install tqdm）をインストールし、次のように使用します。

import time
from tqdm import tqdm
for i in tqdm(range(1000)):
    time.sleep(0.01)

これは、次のような出力が表示される10秒の進行状況バーです。

47%|██████████████████▊                     | 470/1000 [00:04<00:05, 98.61it/s]

これをPythonコマンドラインで実行します（IDEまたは開発環境ではありません）。

>>> import threading
>>> for i in range(50+1):
...   threading._sleep(0.5)
...   print "\r%3d" % i, ('='*i)+('-'*(50-i)),

私のWindowsシステムで正常に動作します。

• http://code.activestate.com/recipes/168639-progress-bar-class/（2002）
• http://code.activestate.com/recipes/299207-console-text-progress-indicator-class/（2004）
• http://pypi.python.org/pypi/progressbar（2006）

そしてグーグルされるのを待っている多くのチュートリアル。

redditの進捗状況を使用しています。すべての項目の進行状況を1行で印刷でき、プログラムから印刷結果が消去されないため、気に入っています。

編集：固定リンク

上記の回答とCLIプログレスバーに関する他の同様の質問に基づいて、私はそれらすべてに一般的な一般的な回答を得たと思います。https://stackoverflow.com/a/15860757/2254146で確認してください

要約すると、コードは次のとおりです。

import time, sys

# update_progress() : Displays or updates a console progress bar
## Accepts a float between 0 and 1. Any int will be converted to a float.
## A value under 0 represents a 'halt'.
## A value at 1 or bigger represents 100%
def update_progress(progress):
    barLength = 10 # Modify this to change the length of the progress bar
    status = ""
    if isinstance(progress, int):
        progress = float(progress)
    if not isinstance(progress, float):
        progress = 0
        status = "error: progress var must be float\r\n"
    if progress < 0:
        progress = 0
        status = "Halt...\r\n"
    if progress >= 1:
        progress = 1
        status = "Done...\r\n"
    block = int(round(barLength*progress))
    text = "\rPercent: [{0}] {1}% {2}".format( "#"*block + "-"*(barLength-block), progress*100, status)
    sys.stdout.write(text)
    sys.stdout.flush()

のように見えます

パーセント：[##########] 99.0％

私はtqdm- https: //pypi.python.org/pypi/tqdm-を使用することをお勧めします。これにより、イテラブルまたはプロセスをプログレスバーに簡単に変換でき、必要な端末に関するすべての混乱を処理します。

ドキュメントから：「tqdmは、コールバック/フックと手動更新を簡単にサポートできます。urllibの例を次に示します」

import urllib
from tqdm import tqdm

def my_hook(t):
  """
  Wraps tqdm instance. Don't forget to close() or __exit__()
  the tqdm instance once you're done with it (easiest using `with` syntax).

  Example
  -------

  >>> with tqdm(...) as t:
  ...     reporthook = my_hook(t)
  ...     urllib.urlretrieve(..., reporthook=reporthook)

  """
  last_b = [0]

  def inner(b=1, bsize=1, tsize=None):
    """
    b  : int, optional
        Number of blocks just transferred [default: 1].
    bsize  : int, optional
        Size of each block (in tqdm units) [default: 1].
    tsize  : int, optional
        Total size (in tqdm units). If [default: None] remains unchanged.
    """
    if tsize is not None:
        t.total = tsize
    t.update((b - last_b[0]) * bsize)
    last_b[0] = b
  return inner

eg_link = 'http://www.doc.ic.ac.uk/~cod11/matryoshka.zip'
with tqdm(unit='B', unit_scale=True, miniters=1,
          desc=eg_link.split('/')[-1]) as t:  # all optional kwargs
    urllib.urlretrieve(eg_link, filename='/dev/null',
                       reporthook=my_hook(t), data=None)

このパッケージをインストールしてみてください pip install progressbar2：：

import time
import progressbar

for i in progressbar.progressbar(range(100)):
    time.sleep(0.02)

プログレスバーgithub：https : //github.com/WoLpH/python-progressbar

非常に簡単な解決策は、このコードをループに入れることです：

これをファイルの本文（つまり上部）に配置します。

import sys

これをループの本文に入れます。

sys.stdout.write("-") # prints a dash for each iteration of loop
sys.stdout.flush() # ensures bar is displayed incrementally

import sys
def progresssbar():
         for i in range(100):
            time.sleep(1)
            sys.stdout.write("%i\r" % i)

progressbar()

注：これをインタラクティブinterepterで実行すると、追加の番号が印刷されます。

笑私はこれについて全体を書いただけですコードはブロックアスキーを実行するときにユニコードを使用できないことに注意してください私はcp437を使用します

import os
import time
def load(left_side, right_side, length, time):
    x = 0
    y = ""
    print "\r"
    while x < length:
        space = length - len(y)
        space = " " * space
        z = left + y + space + right
        print "\r", z,
        y += "█"
        time.sleep(time)
        x += 1
    cls()

そしてあなたはそれをそのように呼びます

print "loading something awesome"
load("|", "|", 10, .01)

こんな感じ

loading something awesome
|█████     |

上記のすばらしいアドバイスを使って、進行状況バーを確認します。

しかし、いくつかの欠点を指摘したいと思います

1. プログレスバーがフラッシュされるたびに、新しい行から始まります

   print('\r[{0}]{1}%'.format('#' * progress* 10, progress))  

   このように：
   [] 0％
   [＃] 10％
   [##] 20％
   [###] 30％

2.角括弧「]」と右側のパーセント値は、「###」が長くなるにつれて右にシフトします。
3.式 'progress / 10'が整数を返せない場合、エラーが発生します。

そして、次のコードは上記の問題を修正します。

def update_progress(progress, total):  
    print('\r[{0:10}]{1:>2}%'.format('#' * int(progress * 10 /total), progress), end='')

Pythonターミナルプログレスバーのコード

import sys
import time

max_length = 5
at_length = max_length
empty = "-"
used = "%"

bar = empty * max_length

for i in range(0, max_length):
    at_length -= 1

    #setting empty and full spots
    bar = used * i
    bar = bar+empty * at_length

    #\r is carriage return(sets cursor position in terminal to start of line)
    #\0 character escape

    sys.stdout.write("[{}]\0\r".format(bar))
    sys.stdout.flush()

    #do your stuff here instead of time.sleep
    time.sleep(1)

sys.stdout.write("\n")
sys.stdout.flush()

私は簡単なプログレスバーを書きました：

def bar(total, current, length=10, prefix="", filler="#", space=" ", oncomp="", border="[]", suffix=""):
    if len(border) != 2:
        print("parameter 'border' must include exactly 2 symbols!")
        return None

    print(prefix + border[0] + (filler * int(current / total * length) +
                                      (space * (length - int(current / total * length)))) + border[1], suffix, "\r", end="")
    if total == current:
        if oncomp:
            print(prefix + border[0] + space * int(((length - len(oncomp)) / 2)) +
                  oncomp + space * int(((length - len(oncomp)) / 2)) + border[1], suffix)
        if not oncomp:
            print(prefix + border[0] + (filler * int(current / total * length) +
                                        (space * (length - int(current / total * length)))) + border[1], suffix)

ご覧のとおり、バーの長さ、プレフィックスとサフィックス、フィラー、スペース、100％（oncomp）のバーのテキストと境界線

ここに例：

from time import sleep, time
start_time = time()
for i in range(10):
    pref = str((i+1) * 10) + "% "
    complete_text = "done in %s sec" % str(round(time() - start_time))
    sleep(1)
    bar(10, i + 1, length=20, prefix=pref, oncomp=complete_text)

進行中：

30% [######              ]

完全に：

100% [   done in 9 sec   ] 

ここで見つけたいくつかのアイデアをまとめ、残りの推定時間を追加します。

import datetime, sys

start = datetime.datetime.now()

def print_progress_bar (iteration, total):

    process_duration_samples = []
    average_samples = 5

    end = datetime.datetime.now()

    process_duration = end - start

    if len(process_duration_samples) == 0:
        process_duration_samples = [process_duration] * average_samples

    process_duration_samples = process_duration_samples[1:average_samples-1] + [process_duration]
    average_process_duration = sum(process_duration_samples, datetime.timedelta()) / len(process_duration_samples)
    remaining_steps = total - iteration
    remaining_time_estimation = remaining_steps * average_process_duration

    bars_string = int(float(iteration) / float(total) * 20.)
    sys.stdout.write(
        "\r[%-20s] %d%% (%s/%s) Estimated time left: %s" % (
            '='*bars_string, float(iteration) / float(total) * 100,
            iteration,
            total,
            remaining_time_estimation
        ) 
    )
    sys.stdout.flush()
    if iteration + 1 == total:
        print 


# Sample usage

for i in range(0,300):
    print_progress_bar(i, 300)

Python 3の場合：

def progress_bar(current_value, total):
    increments = 50
    percentual = ((current_value/ total) * 100)
    i = int(percentual // (100 / increments ))
    text = "\r[{0: <{1}}] {2}%".format('=' * i, increments, percentual)
    print(text, end="\n" if percentual == 100 else "")

さてここに動作するコードがあり、投稿する前にテストしました：

import sys
def prg(prog, fillchar, emptchar):
    fillt = 0
    emptt = 20
    if prog < 100 and prog > 0:
        prog2 = prog/5
        fillt = fillt + prog2
        emptt = emptt - prog2
        sys.stdout.write("\r[" + str(fillchar)*fillt + str(emptchar)*emptt + "]" + str(prog) + "%")
        sys.stdout.flush()
    elif prog >= 100:
        prog = 100
        prog2 = prog/5
        fillt = fillt + prog2
        emptt = emptt - prog2
        sys.stdout.write("\r[" + str(fillchar)*fillt + str(emptchar)*emptt + "]" + str(prog) + "%" + "\nDone!")
        sys.stdout.flush()
    elif prog < 0:
        prog = 0
        prog2 = prog/5
        fillt = fillt + prog2
        emptt = emptt - prog2
        sys.stdout.write("\r[" + str(fillchar)*fillt + str(emptchar)*emptt + "]" + str(prog) + "%" + "\nHalted!")
        sys.stdout.flush()

長所：

• 20文字のバー（5ごとに1文字（数字））
• カスタム塗りつぶし文字
• カスタムの空の文字
• 停止（0未満の任意の数）
• 完了（100および100を超える任意の数）
• 進捗カウント（0-100（特殊機能に使用される以下））
• バーの横にあるパーセンテージ数、それは単一の行です

短所：

• 整数のみをサポートします（ただし、除算を整数の除算にすることで変更できますので、に変更prog2 = prog/5してくださいprog2 = int(prog/5)）。

これが私のPython 3ソリューションです：

import time
for i in range(100):
    time.sleep(1)
    s = "{}% Complete".format(i)
    print(s,end=len(s) * '\b')

'\ b'は、文字列の各文字のバックスラッシュです。これは、Windows cmdウィンドウ内では機能しません。

Greenstickの関数2.7：

def printProgressBar (iteration, total, prefix = '', suffix = '',decimals = 1, length = 100, fill = '#'):

percent = ("{0:." + str(decimals) + "f}").format(100 * (iteration / float(total)))
filledLength = int(length * iteration // total)
bar = fill * filledLength + '-' * (length - filledLength)
print'\r%s |%s| %s%% %s' % (prefix, bar, percent, suffix),
sys.stdout.flush()
# Print New Line on Complete                                                                                                                                                                                                              
if iteration == total:
    print()

Pythonモジュールのプログレスバーは良い選択です。これが私の典型的なコードです：

import time
import progressbar

widgets = [
    ' ', progressbar.Percentage(),
    ' ', progressbar.SimpleProgress(format='(%(value_s)s of %(max_value_s)s)'),
    ' ', progressbar.Bar('>', fill='.'),
    ' ', progressbar.ETA(format_finished='- %(seconds)s  -', format='ETA: %(seconds)s', ),
    ' - ', progressbar.DynamicMessage('loss'),
    ' - ', progressbar.DynamicMessage('error'),
    '                          '
]

bar = progressbar.ProgressBar(redirect_stdout=True, widgets=widgets)
bar.start(100)
for i in range(100):
    time.sleep(0.1)
    bar.update(i + 1, loss=i / 100., error=i)
bar.finish()