|
# -*- coding: utf-8 -*- # # progressbar - Text progress bar library for Python. # Copyright (c) 2005 Nilton Volpato # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License as published by the Free Software Foundation; either # version 2.1 of the License, or (at your option) any later version. # # This library is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # Lesser General Public License for more details. # # You should have received a copy of the GNU Lesser General Public # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
except ImportError: AbstractWidget = object abstractmethod = lambda fn: fn else:
if hasattr(updatable, 'update'): return updatable.update(pbar) else: return updatable
"""The base class for all widgets.
The ProgressBar will call the widget's update value when the widget should be updated. The widget's size may change between calls, but the widget may display incorrectly if the size changes drastically and repeatedly.
The boolean TIME_SENSITIVE informs the ProgressBar that it should be updated more often because it is time sensitive. """
def update(self, pbar): """Updates the widget.
pbar - a reference to the calling ProgressBar """
"""The base class for all variable width widgets.
This widget is much like the \\hfill command in TeX, it will expand to fill the line. You can use more than one in the same line, and they will all have the same width, and together will fill the line. """
def update(self, pbar, width): """Updates the widget providing the total width the widget must fill.
pbar - a reference to the calling ProgressBar width - The total width the widget must fill """
"""Widget which displays the elapsed seconds."""
self.format_string = format
def format_time(seconds): """Formats time as the string "HH:MM:SS"."""
return str(datetime.timedelta(seconds=int(seconds)))
"""Updates the widget to show the elapsed time."""
return self.format_string % self.format_time(pbar.seconds_elapsed)
"""Widget which attempts to estimate the time of arrival."""
"""Updates the widget to show the ETA or total time when finished."""
if pbar.maxval is UnknownLength or pbar.currval == 0: return 'ETA: --:--:--' elif pbar.finished: return 'Time: %s' % self.format_time(pbar.seconds_elapsed) else: elapsed = pbar.seconds_elapsed eta = elapsed * pbar.maxval / pbar.currval - elapsed return 'ETA: %s' % self.format_time(eta)
"""Widget which attempts to estimate the time of arrival.
Uses a weighted average of two estimates: 1) ETA based on the total progress and time elapsed so far 2) ETA based on the progress as per the last 10 update reports
The weight depends on the current progress so that to begin with the total progress is used and at the end only the most recent progress is used. """
sample = (currval, elapsed) if not hasattr(self, 'samples'): self.samples = [sample] * (self.NUM_SAMPLES + 1) else: self.samples.append(sample) return self.samples.pop(0)
return elapsed * maxval / float(currval) - elapsed
"""Updates the widget to show the ETA or total time when finished.""" if pbar.maxval is UnknownLength or pbar.currval == 0: return 'ETA: --:--:--' elif pbar.finished: return 'Time: %s' % self.format_time(pbar.seconds_elapsed) else: elapsed = pbar.seconds_elapsed currval1, elapsed1 = self._update_samples(pbar.currval, elapsed) eta = self._eta(pbar.maxval, pbar.currval, elapsed) if pbar.currval > currval1: etasamp = self._eta(pbar.maxval - currval1, pbar.currval - currval1, elapsed - elapsed1) weight = (pbar.currval / float(pbar.maxval)) ** 0.5 eta = (1 - weight) * eta + weight * etasamp return 'ETA: %s' % self.format_time(eta)
"""Widget for showing the transfer speed (useful for file transfers)."""
self.unit = unit
"""Updates the widget with the current SI prefixed speed."""
if pbar.seconds_elapsed < 2e-6 or pbar.currval < 2e-6: # =~ 0 scaled = power = 0 else: speed = pbar.currval / pbar.seconds_elapsed power = int(math.log(speed, 1000)) scaled = speed / 1000.**power
return self.FMT % (scaled, self.PREFIXES[power], self.unit)
"""An animated marker for the progress bar which defaults to appear as if it were rotating. """
self.markers = markers self.curmark = -1
"""Updates the widget to show the next marker or the first marker when finished"""
if pbar.finished: return self.markers[0]
self.curmark = (self.curmark + 1) % len(self.markers) return self.markers[self.curmark]
# Alias for backwards compatibility
"""Displays the current count."""
self.format_string = format
return self.format_string % pbar.currval
"""Displays the current percentage as a number with a percent sign."""
return '%3d%%' % pbar.percentage()
"""Displays a formatted label."""
'elapsed': ('seconds_elapsed', Timer.format_time), 'finished': ('finished', None), 'last_update': ('last_update_time', None), 'max': ('maxval', None), 'seconds': ('seconds_elapsed', None), 'start': ('start_time', None), 'value': ('currval', None) }
self.format_string = format
context = {} for name, (key, transform) in self.mapping.items(): try: value = getattr(pbar, key)
if transform is None: context[name] = value else: context[name] = transform(value) except: pass
return self.format_string % context
"""Returns progress as a count of the total (e.g.: "5 of 47")."""
self.sep = sep
return '%d%s%s' % (pbar.currval, self.sep, pbar.maxval)
"""A progress bar which stretches to fill the line."""
fill_left=True): """Creates a customizable progress bar.
marker - string or updatable object to use as a marker left - string or updatable object to use as a left border right - string or updatable object to use as a right border fill - character to use for the empty part of the progress bar fill_left - whether to fill from the left or the right """
"""Updates the progress bar and its subcomponents."""
left, marked, right = (format_updatable(i, pbar) for i in (self.left, self.marker, self.right))
width -= len(left) + len(right) # Marked must *always* have length of 1 if pbar.maxval is not UnknownLength and pbar.maxval: marked *= int(pbar.currval / pbar.maxval * width) else: marked = ''
if self.fill_left: return '%s%s%s' % (left, marked.ljust(width, self.fill), right) else: return '%s%s%s' % (left, marked.rjust(width, self.fill), right)
"""A bar which has a marker which bounces from side to side."""
fill_left=False): """Creates a customizable progress bar.
marker - string or updatable object to use as a marker left - string or updatable object to use as a left border right - string or updatable object to use as a right border fill - character to use for the empty part of the progress bar fill_left - whether to fill from the left or the right """ self.marker = marker self.left = left self.right = right self.fill = fill self.fill_left = fill_left
"""Updates the progress bar and its subcomponents."""
left, marker, right = (format_updatable(i, pbar) for i in (self.left, self.marker, self.right))
width -= len(left) + len(right)
if pbar.finished: return '%s%s%s' % (left, width * marker, right)
position = int(pbar.currval % (width * 2 - 1)) if position > width: position = width * 2 - position lpad = self.fill * (position - 1) rpad = self.fill * (width - len(marker) - len(lpad))
# Swap if we want to bounce the other way if not self.fill_left: rpad, lpad = lpad, rpad
return '%s%s%s%s%s' % (left, lpad, marker, rpad, right) |