Textfortschrittsbalken im Terminal mit Blockzeichen

Question

Ich habe eine einfache Konsolenanwendung zum Hoch- und Herunterladen von Dateien von einem FTP-Server unter Verwendung der ftplib geschrieben.

Ich möchte, dass die App eine Visualisierung des Download/Upload-Fortschritts für den Benutzer anzeigt; jedes Mal, wenn ein Datenpaket heruntergeladen wird, möchte ich, dass sie eine Fortschrittsaktualisierung bereitstellt, auch wenn es nur eine numerische Darstellung wie ein Prozentsatz ist.

Wichtig ist, dass ich vermeiden möchte, den gesamten Text zu löschen, der in den vorherigen Zeilen auf der Konsole ausgegeben wurde (d. h. ich möchte nicht das gesamte Terminal "löschen", während ich den aktualisierten Fortschritt ausdrucke).

Dies scheint eine ziemlich häufige Aufgabe - wie kann ich über die Erstellung eines Fortschrittsbalken oder ähnliche Visualisierung, die Ausgaben zu meiner Konsole unter Beibehaltung der vorherigen Programmausgabe gehen?

Answer 1

Python 3

Ein einfacher, anpassbarer Fortschrittsbalken

Hier finden Sie eine Zusammenfassung vieler der unten aufgeführten Antworten, die ich regelmäßig verwende (keine Importe erforderlich).

Anmerkung: Der gesamte Code in dieser Antwort wurde für Python 3 erstellt; siehe Ende der Antwort, um diesen Code mit Python 2 zu verwenden.

# 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()

Verwendungsbeispiele

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)

Beispielhafte Ausgabe

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

Update

In den Kommentaren wurde über eine Option diskutiert, die es ermöglicht, den Fortschrittsbalken dynamisch an die Breite des Terminalfensters anzupassen. Ich empfehle dies zwar nicht, aber hier ist eine . die diese Funktion implementiert (und auf die Vorbehalte hinweist).

Einzelaufruf-Version des oben genannten

In einem Kommentar wurde auf eine schöne Antwort als Antwort auf eine ähnliche Frage gepostet. Mir gefiel die Benutzerfreundlichkeit, die darin demonstriert wurde, und ich schrieb eine ähnliche Antwort, verzichtete aber auf den Import der sys Modul, wobei einige der Funktionen des ursprünglichen printProgressBar Funktion oben.

Zu den Vorteilen dieses Ansatzes gegenüber der obigen Originalfunktion gehören der Wegfall des ersten Funktionsaufrufs, um den Fortschrittsbalken bei 0 % zu drucken, und die Verwendung von enumerate wird optional (d.h. sie ist nicht mehr ausdrücklich erforderlich, damit die Funktion funktioniert).

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()

Verwendungsbeispiele

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)

Beispielhafte Ausgabe

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

Python 2

Um die oben genannten Funktionen in Python 2 zu verwenden, setzen Sie die Kodierung am Anfang Ihres Skripts auf UTF-8:

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

Und ersetzen Sie die Python 3 String-Formatierung in dieser Zeile:

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

Mit Python 2 String-Formatierung:

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

Answer 2

Schreiben ' \r ' setzt den Cursor zurück an den Anfang der Zeile.

Hier wird ein Prozentzähler angezeigt:

import time
import sys

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

Answer 3

tqdm: Fügen Sie in einer Sekunde eine Fortschrittsanzeige zu Ihren Schleifen hinzu :

>>> 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 4

Schreiben Sie eine \r an die Konsole. Das ist eine "Wagenrücklauf" was dazu führt, dass der gesamte nachfolgende Text am Anfang der Zeile wiedergegeben wird. Etwa so:

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

was Ihnen etwas wie: [ ########## ] 100%

Answer 5

Sie besteht aus weniger als 10 Zeilen Code.

Das Wesentliche hier: 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