# Welcome to Progress Bar’s documentation!¶

## Text progress bar library for Python.¶

Travis status:

Coverage:

### 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
• FileTransferSpeed
• 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)


# 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


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

bar = progressbar.ProgressBar()
for i in bar(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

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)