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.16.0.tar.gz (25.9 kB view details)

Uploaded Source

Built Distribution

progressbar2-3.16.0-py2.py3-none-any.whl (21.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for progressbar2-3.16.0.tar.gz
Algorithm Hash digest
SHA256 2472df1f98e458d36294e5e43439825ca1fc64dd8e44bdb4740005bd38f963ba
MD5 8d8a6d1e3fb1bbc77a4ad6a88fb6d7bd
BLAKE2b-256 3c3ec4a8aca4eb5ce2e462d56a9c6bfc54f8502f07708462786b1b6caf91b7a2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for progressbar2-3.16.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a9c2aeddfe54c6ac548b26460d4388af830629ca0bd08974984a609df27ca3e8
MD5 699bd8adf9d4e3e91de6fb3bbc421f78
BLAKE2b-256 26f1da09fe962f5efb61b94a009edbaf49814cbd81e6424896908b8d16267f5e

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