Skip to main content

A Python Progressbar library to provide visual (yet text based) progress to long running operations.

Project description

Travis status:

https://travis-ci.org/WoLpH/python-progressbar.png?branch=master

Coverage:

https://coveralls.io/repos/WoLpH/python-progressbar/badge.png?branch=master

Introduction

NOTE: This version has been completely rewritten and might not be 100% compatible with the old version. If you encounter any problems while using it please let me know: https://github.com/WoLpH/python-progressbar/issues

A text progress bar is typically used to display the progress of a long running operation, providing a visual cue that processing is underway.

The ProgressBar class manages the current progress, and the format of the line is given by a number of widgets. A widget is an object that may display differently depending on the state of the progress bar. There are many types of widgets:

  • Timer

  • ETA

  • AdaptiveETA

  • FileTransferSpeed

  • AdaptiveTransferSpeed

  • AnimatedMarker

  • Counter

  • Percentage

  • FormatLabel

  • SimpleProgress

  • Bar

  • ReverseBar

  • BouncingBar

  • RotatingMarker

  • DynamicMessage

The progressbar module is very easy to use, yet very powerful. It will also automatically enable features like auto-resizing when the system supports it.

Usage

There are many ways to use Python Progressbar, you can see a few basic examples here but there are many more in the examples file.

Wrapping an iterable

import time
import progressbar

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

Context wrapper

import time
import progressbar

with progressbar.ProgressBar(max_value=10) as bar:
    for i in range(10):
        time.sleep(0.1)
        bar.update(i)

Combining progressbars with print output

import time
import progressbar

bar = progressbar.ProgressBar(redirect_stdout=True)
for i in range(100):
    print 'Some text', i
    time.sleep(0.1)
    bar.update(i)

Progressbar with unknown length

import time
import progressbar

bar = progressbar.ProgressBar(max_value=progressbar.UnknownLength)
for i in range(20):
    time.sleep(0.1)
    bar.update(i)

Bar with custom widgets

import time
import progressbar

bar = progressbar.ProgressBar(widgets=[
    ' [', progressbar.Timer(), '] ',
    progressbar.Bar(),
    ' (', progressbar.ETA(), ') ',
])
for i in bar(range(20)):
    time.sleep(0.1)

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

progressbar2-3.11.0.tar.gz (24.2 kB view details)

Uploaded Source

Built Distribution

progressbar2-3.11.0-py2.py3-none-any.whl (20.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file progressbar2-3.11.0.tar.gz.

File metadata

File hashes

Hashes for progressbar2-3.11.0.tar.gz
Algorithm Hash digest
SHA256 327d8bcd3f729464a6fffcc8d3220e513e639b0027372f780c128ca6bc1579d2
MD5 ff8286d6f3499ba30d66416b29588c4a
BLAKE2b-256 2e85923a8663fa779bbfbc906716871eb8b5c514a5f89cabfa25313134ae6da3

See more details on using hashes here.

File details

Details for the file progressbar2-3.11.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for progressbar2-3.11.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 95365c24a8de9cd4f0a461063720657cff3b110d803064357d2d7b773516c5cc
MD5 a54690d75858b4624648650f8bcf5103
BLAKE2b-256 daf2aeb94978b792b26f47f31fe03d8368e5e3622a455023915513764cdc948a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page