WoLpH/python-progressbar


Progressbar 2 - A progress bar for Python 2 and Python 3 - "pip install progressbar2"

http://progressbar-2.readthedocs.org/en/latest/

License: BSD-3-Clause

Language: Python

Keywords: bar, cli, console, eta, gui, library, percentage, progress, progress-bar, progressbar, python, rate, terminal, time


Text progress bar library for Python.

Travis status:

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

Coverage:

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

Install

The package can be installed through pip (this is the recommended method):

pip install progressbar2

Or if pip is not available, easy_install should work as well:

easy_install progressbar2

Or download the latest release from Pypi (https://pypi.python.org/pypi/progressbar2) or Github.

Note that the releases on Pypi are signed with my GPG key (https://pgp.mit.edu/pks/lookup?op=vindex&search=0xE81444E9CE1F695D) and can be checked using GPG:

gpg --verify progressbar2-<version>.tar.gz.asc progressbar2-<version>.tar.gz

Introduction

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:

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.

Known issues

Due to limitations in both the IDLE shell and the Jetbrains (Pycharm) shells this progressbar cannot function properly within those.

Links

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

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

Progressbars with logging

Progressbars with logging require stderr redirection _before_ the StreamHandler is initialized. To make sure the stderr stream has been redirected on time make sure to call progressbar.streams.wrap_stderr() before you initialize the logger.

One option to force early initialization is by using the WRAP_STDERR environment variable, on Linux/Unix systems this can be done through:

# WRAP_STDERR=true python your_script.py

If you need to flush manually while wrapping, you can do so using:

import progressbar

progressbar.streams.flush()

In most cases the following will work as well, as long as you initialize the StreamHandler after the wrapping has taken place.

import time
import logging
import progressbar

progressbar.streams.wrap_stderr()
logging.basicConfig()

for i in progressbar.progressbar(range(10)):
    logging.error('Got %d', i)
    time.sleep(0.2)

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

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

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

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

Bar with wide Chinese (or other multibyte) characters

# vim: fileencoding=utf-8
import time
import progressbar


def custom_len(value):
    # These characters take up more space
    characters = {
        '': 2,
        '': 2,
    }

    total = 0
    for c in value:
        total += characters.get(c, 1)

    return total


bar = progressbar.ProgressBar(
    widgets=[
        '进度: ',
        progressbar.Bar(),
        ' ',
        progressbar.Counter(format='%(value)02d/%(max_value)d'),
    ],
    len_func=custom_len,
)
for i in bar(range(10)):
    time.sleep(0.1)

Project Statistics

Sourcerank 16
Repository Size 699 KB
Stars 507
Forks 78
Watchers 17
Open issues 6
Dependencies 2
Contributors 33
Tags 78
Created
Last updated
Last pushed

Top Contributors See all

Rick van Hattem Jan Stürtz Thomas Kluyver Check your git settings! Terence Honles Nilton Volpato Matthew Wardrop Joseph O'Brien Antognini Moritz Lüdecke Max Arnold Carli Samuele Thomas Nestmeyer nxsofsys Andy Lapidas Alexander Zelenyak Rory Geoghegan Clemens Brunner Christophe Catherine Slychan Ilya Konstantinov Paul Ganssle

Packages Referencing this Repo

progressbar2
A Python Progressbar library to provide visual (yet text based) progress to long running operations.
Latest release 3.43.1 - Updated - 507 stars

Recent Tags See all

v3.43.1 August 21, 2019
v3.43.0 July 13, 2019
v3.42.1 July 13, 2019
v3.42.0 May 29, 2019
v3.41.0 May 27, 2019
v3.40.0 May 27, 2019
v3.39.3 March 13, 2019
v3.39.2 December 17, 2018
v3.39.2 December 17, 2018
v3.39.1 December 16, 2018
v3.39.0 December 16, 2018
v3.38.0 May 26, 2018
v3.37.1 April 11, 2018
v3.37.0 April 05, 2018
v3.37.0 April 05, 2018

Something wrong with this page? Make a suggestion

Last synced: 2019-08-21 14:21:59 UTC

Login to resync this repository