#!/usr/bin/python
# -*- coding: utf-8 -*-
from __future__ import print_function
import functools
import random
import sys
import time
import progressbar
examples = []
def example(fn):
'''Wrap the examples so they generate readable output'''
@functools.wraps(fn)
def wrapped():
try:
sys.stdout.write('Running: %s\n' % fn.__name__)
fn()
sys.stdout.write('\n')
except KeyboardInterrupt:
sys.stdout.write('\nSkipping example.\n\n')
# Sleep a bit to make killing the script easier
time.sleep(0.2)
examples.append(wrapped)
return wrapped
@example
def shortcut_example():
for i in progressbar.progressbar(range(10)):
time.sleep(0.1)
@example
def prefixed_shortcut_example():
for i in progressbar.progressbar(range(10), prefix='Hi: '):
time.sleep(0.1)
@example
def templated_shortcut_example():
for i in progressbar.progressbar(range(10), suffix='{seconds_elapsed:.1}'):
time.sleep(0.1)
@example
def with_example_stdout_redirection():
with progressbar.ProgressBar(max_value=10, redirect_stdout=True) as p:
for i in range(10):
if i % 3 == 0:
print('Some print statement %i' % i)
# do something
p.update(i)
time.sleep(0.1)
@example
def basic_widget_example():
widgets = [progressbar.Percentage(), progressbar.Bar()]
bar = progressbar.ProgressBar(widgets=widgets, max_value=10).start()
for i in range(10):
# do something
time.sleep(0.1)
bar.update(i + 1)
bar.finish()
@example
def file_transfer_example():
widgets = [
'Test: ', progressbar.Percentage(),
' ', progressbar.Bar(marker=progressbar.RotatingMarker()),
' ', progressbar.ETA(),
' ', progressbar.FileTransferSpeed(),
]
bar = progressbar.ProgressBar(widgets=widgets, max_value=1000).start()
for i in range(100):
# do something
bar.update(10 * i + 1)
bar.finish()
@example
def custom_file_transfer_example():
class CrazyFileTransferSpeed(progressbar.FileTransferSpeed):
"It's bigger between 45 and 80 percent"
def update(self, bar):
if 45 < bar.percentage() < 80:
return 'Bigger Now ' + progressbar.FileTransferSpeed.update(
self, bar)
else:
return progressbar.FileTransferSpeed.update(self, bar)
widgets = [
CrazyFileTransferSpeed(),
' ',
progressbar.Percentage(),
' ',
progressbar.ETA(),
]
bar = progressbar.ProgressBar(widgets=widgets, max_value=1000)
# maybe do something
bar.start()
for i in range(200):
# do something
bar.update(5 * i + 1)
bar.finish()
@example
def double_bar_example():
widgets = [
progressbar.Bar('>'), ' ',
progressbar.ETA(), ' ',
progressbar.ReverseBar(' 400:
time.sleep(0.1)
else:
time.sleep(0.01)
bar.update(i + 1)
bar.finish()
@example
def adaptive_eta_without_value_change():
# Testing progressbar.AdaptiveETA when the value doesn't actually change
bar = progressbar.ProgressBar(widgets=[
progressbar.AdaptiveETA(),
progressbar.AdaptiveTransferSpeed(),
], max_value=2, poll_interval=0.0001)
bar.start()
for i in range(100):
bar.update(1)
time.sleep(0.1)
bar.finish()
@example
def iterator_with_max_value():
# Testing using progressbar as an iterator with a max value
bar = progressbar.ProgressBar()
for n in bar(iter(range(100)), 100):
# iter range is a way to get an iterator in both python 2 and 3
pass
@example
def eta():
widgets = [
'Test: ', progressbar.Percentage(),
' | ETA: ', progressbar.ETA(),
' | AbsoluteETA: ', progressbar.AbsoluteETA(),
' | AdaptiveETA: ', progressbar.AdaptiveETA(),
]
bar = progressbar.ProgressBar(widgets=widgets, max_value=50).start()
for i in range(50):
time.sleep(0.1)
bar.update(i + 1)
bar.finish()
@example
def dynamic_message():
# Use progressbar.DynamicMessage to keep track of some parameter(s) during
# your calculations
widgets = [
progressbar.Percentage(),
progressbar.Bar(),
progressbar.DynamicMessage('loss'),
progressbar.DynamicMessage('username', width=12, precision=12),
]
with progressbar.ProgressBar(max_value=100, widgets=widgets) as bar:
min_so_far = 1
for i in range(100):
val = random.random()
if val < min_so_far:
min_so_far = val
bar.update(i, loss=min_so_far, username='Some user %02d' % i)
@example
def format_custom_text():
format_custom_text = progressbar.FormatCustomText(
'Spam: %(spam).1f kg, eggs: %(eggs)d',
dict(
spam=0.25,
eggs=3,
),
)
bar = progressbar.ProgressBar(widgets=[
format_custom_text,
' :: ',
progressbar.Percentage(),
])
for i in bar(range(25)):
format_custom_text.update_mapping(eggs=i * 2)
time.sleep(0.1)
@example
def simple_api_example():
bar = progressbar.ProgressBar(widget_kwargs=dict(fill=''))
for i in bar(range(200)):
time.sleep(0.02)
@example
def ETA_on_generators():
def gen():
for x in range(200):
yield None
widgets = [progressbar.AdaptiveETA(), ' ',
progressbar.ETA(), ' ',
progressbar.Timer()]
bar = progressbar.ProgressBar(widgets=widgets)
for i in bar(gen()):
time.sleep(0.02)
@example
def percentage_on_generators():
def gen():
for x in range(200):
yield None
widgets = [progressbar.Counter(), ' ',
progressbar.Percentage(), ' ',
progressbar.SimpleProgress(), ' ']
bar = progressbar.ProgressBar(widgets=widgets)
for i in bar(gen()):
time.sleep(0.02)
def test(*tests):
if tests:
for example in examples:
for test in tests:
if test in example.__name__:
example()
break
else:
print('Skipping', example.__name__)
else:
for example in examples:
example()
if __name__ == '__main__':
try:
test(*sys.argv[1:])
except KeyboardInterrupt:
sys.stdout('\nQuitting examples.\n')