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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for progressbar2-3.10.1.tar.gz
Algorithm Hash digest
SHA256 0bf46fb3e41c1d64698c07f37a306524e3fecae21e9e526168c668b95fef3169
MD5 4b482eb8e6030ea6c9f3948e4b63ccd5
BLAKE2b-256 1cdea2f5feaf4048c941070e06e5814cb2adad73cdf47778920cb6c762145f17

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for progressbar2-3.10.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9eecd7cdf4ba2db4bed85c1b591059e88912e00a2dc76ee820d6a9dc974460b4
MD5 342edc9439a8e5890c0ec4cf2ad276df
BLAKE2b-256 aa137fc75289f0f6a46d83913bfbe3db8003f0d56fd96a8564f6b334b830d461

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