progressbar.ProgressBar Class Reference

Inheritance diagram for progressbar.ProgressBar:

Public Member Functions
def	__init__ (self, maxval=100, widgets=default_widgets, term_width=None, fd=sys.stderr)
def	handle_resize (self, signum, frame)
def	percentage (self)
def	update (self, value)
def	start (self)
def	finish (self)

Public Attributes
	maxval
	widgets
	fd
	signal_set
	term_width
	currval
	finished
	prev_percentage
	start_time
	seconds_elapsed

Private Member Functions
def	_format_widgets (self)
def	_format_line (self)
def	_need_update (self)

Detailed Description

This is the ProgressBar class, it updates and prints the bar.

The term_width parameter may be an integer. Or None, in which case
it will try to guess it, if it fails it will default to 80 columns.

The simple use is like this:
>>> pbar = ProgressBar().start()
>>> for i in xrange(100):
...    # do something
...    pbar.update(i+1)
...
>>> pbar.finish()

But anything you want to do is possible (well, almost anything).
You can supply different widgets of any type in any order. And you
can even write your own widgets! There are many widgets already
shipped and you should experiment with them.

When implementing a widget update method you may access any
attribute or function of the ProgressBar object calling the
widget's update method. The most important attributes you would
like to access are:
- currval: current value of the progress, 0 <= currval <= maxval
- maxval: maximum (and final) value of the progress
- finished: True if the bar is have finished (reached 100%), False o/w
- start_time: first time update() method of ProgressBar was called
- seconds_elapsed: seconds elapsed since start_time
- percentage(): percentage of the progress (this is a method)

Definition at line 194 of file progressbar.py.

Constructor & Destructor Documentation

def progressbar.ProgressBar.__init__	(		self,
			maxval = 100,
			widgets = default_widgets,
			term_width = None,
			fd = sys.stderr
	)

Definition at line 225 of file progressbar.py.

                 fd=sys.stderr):
        assert maxval > 0
        self.maxval = maxval
        self.widgets = widgets
        self.fd = fd
        self.signal_set = False
        if term_width is None:
            try:
                self.handle_resize(None,None)
                signal.signal(signal.SIGWINCH, self.handle_resize)
                self.signal_set = True
            except:
                self.term_width = 79
        else:
            self.term_width = term_width

        self.currval = 0
        self.finished = False
        self.prev_percentage = -1
        self.start_time = None
        self.seconds_elapsed = 0

Member Function Documentation

def progressbar.ProgressBar._format_line (   self )

private

Definition at line 276 of file progressbar.py.

    def _format_line(self):
        return ''.join(self._format_widgets()).ljust(self.term_width)

def progressbar.ProgressBar._format_widgets (   self )

private

Definition at line 255 of file progressbar.py.

    def _format_widgets(self):
        r = []
        hfill_inds = []
        num_hfill = 0
        currwidth = 0
        for i, w in enumerate(self.widgets):
            if isinstance(w, ProgressBarWidgetHFill):
                r.append(w)
                hfill_inds.append(i)
                num_hfill += 1
            elif isinstance(w, str):
                r.append(w)
                currwidth += len(w)
            else:
                weval = w.update(self)
                currwidth += len(weval)
                r.append(weval)
        for iw in hfill_inds:
            r[iw] = r[iw].update(self, (self.term_width-currwidth)//num_hfill)
        return r

def progressbar.ProgressBar._need_update (   self )

private

Definition at line 279 of file progressbar.py.

    def _need_update(self):
        return int(self.percentage()) != int(self.prev_percentage)

def progressbar.ProgressBar.finish

(

self

)

Used to tell the progress is finished.

Definition at line 312 of file progressbar.py.

    def finish(self):
        """Used to tell the progress is finished."""
        self.update(self.maxval)
        if self.signal_set:
            signal.signal(signal.SIGWINCH, signal.SIG_DFL)
        

def progressbar.ProgressBar.handle_resize	(		self,
			signum,
			frame
	)

Definition at line 247 of file progressbar.py.

    def handle_resize(self, signum, frame):
        h,w=array('h', ioctl(self.fd,termios.TIOCGWINSZ,'\0'*8))[:2]
        self.term_width = w

def progressbar.ProgressBar.percentage

(

self

)

Definition at line 251 of file progressbar.py.

    def percentage(self):
        "Returns the percentage of the progress."
        return self.currval*100.0 / self.maxval

def progressbar.ProgressBar.start

(

self

)

Start measuring time, and prints the bar at 0%.

It returns self so you can use it like this:
>>> pbar = ProgressBar().start()
>>> for i in xrange(100):
...    # do something
...    pbar.update(i+1)
...
>>> pbar.finish()

Definition at line 298 of file progressbar.py.

    def start(self):
        """Start measuring time, and prints the bar at 0%.

        It returns self so you can use it like this:
        >>> pbar = ProgressBar().start()
        >>> for i in xrange(100):
        ...    # do something
        ...    pbar.update(i+1)
        ...
        >>> pbar.finish()
        """
        self.update(0)
        return self

def progressbar.ProgressBar.update	(		self,
			value
	)

Definition at line 282 of file progressbar.py.

    def update(self, value):
        "Updates the progress bar to a new value."
        assert 0 <= value <= self.maxval
        self.currval = value
        if not self._need_update() or self.finished:
            return
        if not self.start_time:
            self.start_time = time.time()
        self.seconds_elapsed = time.time() - self.start_time
        self.prev_percentage = self.percentage()
        if value != self.maxval:
            self.fd.write(self._format_line() + '\r')
        else:
            self.finished = True
            self.fd.write(self._format_line() + '\n')

Member Data Documentation

progressbar.ProgressBar.currval

Definition at line 241 of file progressbar.py.

progressbar.ProgressBar.fd

Definition at line 229 of file progressbar.py.

progressbar.ProgressBar.finished

Definition at line 242 of file progressbar.py.

progressbar.ProgressBar.maxval

Definition at line 227 of file progressbar.py.

progressbar.ProgressBar.prev_percentage

Definition at line 243 of file progressbar.py.

progressbar.ProgressBar.seconds_elapsed

Definition at line 245 of file progressbar.py.

progressbar.ProgressBar.signal_set

Definition at line 230 of file progressbar.py.

progressbar.ProgressBar.start_time

Definition at line 244 of file progressbar.py.

progressbar.ProgressBar.term_width

Definition at line 237 of file progressbar.py.

progressbar.ProgressBar.widgets

Definition at line 228 of file progressbar.py.

---

The documentation for this class was generated from the following file:

• duneopdet/duneopdet/OpticalDetector/validation/progressbar.py