progressbar.ProgressBar Class Reference

Inheritance diagram for progressbar.ProgressBar:

Public Member Functions
def	__call__
def	__init__
def	__iter__
def	__next__
def	finish
def	percentage
def	start
def	update

Public Attributes
	currval
	fd
	finished
	last_update_time
	left_justify
	maxval
	next_update
	num_intervals
	poll
	seconds_elapsed
	signal_set
	start_time
	term_width
	update_interval
	widgets

Static Public Attributes
	next = __next__

Properties
	percent = property(percentage)

Private Member Functions
def	_env_size
def	_format_line
def	_format_widgets
def	_handle_resize
def	_need_update
def	_update_widgets

Private Attributes
	__iterable
	_time_sensitive

Static Private Attributes
tuple	__slots__
int	_DEFAULT_MAXVAL = 100
int	_DEFAULT_TERMSIZE = 80

Detailed Description

The ProgressBar class which updates and prints the bar.

A common way of using it is like:
>>> pbar = ProgressBar().start()
>>> for i in range(100):
...    # do something
...    pbar.update(i+1)
...
>>> pbar.finish()

You can also use a ProgressBar as an iterator:
>>> progress = ProgressBar()
>>> for i in progress(some_iterable):
...    # do something
...

Since the progress bar is incredibly customizable you can specify
different widgets of any type in any order. You can even write your own
widgets! However, since there are already a good number of widgets you
should probably play around with them before moving on to create your own
widgets.

The term_width parameter represents the current terminal width. If the
parameter is set to an integer then the progress bar will use that,
otherwise it will attempt to determine the terminal width falling back to
80 columns if the width cannot be determined.

When implementing a widget's update method you are passed a reference to
the current progress bar. As a result, you have access to the
ProgressBar's methods and attributes. Although there is nothing preventing
you from changing the ProgressBar you should treat it as read only.

Useful methods and attributes include (Public API):
 - currval: current progress (0 <= currval <= maxval)
 - maxval: maximum (and final) value
 - finished: True if the bar has finished (reached 100%)
 - start_time: the time when start() method of ProgressBar was called
 - seconds_elapsed: seconds elapsed since start_time and last call to
                    update
 - percentage(): progress in percent [0..100]

Definition at line 163 of file progressbar.py.

Constructor & Destructor Documentation

def progressbar.ProgressBar.__init__	(		self,
			maxval = None,
			widgets = None,
			term_width = None,
			poll = 1,
			left_justify = True,
			fd = sys.stderr
	)

Initializes a progress bar with sane defaults

Definition at line 216 of file progressbar.py.

                 left_justify=True, fd=sys.stderr):
        '''Initializes a progress bar with sane defaults'''

        self.maxval = maxval
        self.widgets = widgets
        self.fd = fd
        self.left_justify = left_justify

        self.signal_set = False
        if term_width is not None:
            self.term_width = term_width
        else:
            try:
                self._handle_resize()
                signal.signal(signal.SIGWINCH, self._handle_resize)
                self.signal_set = True
            except (SystemExit, KeyboardInterrupt): raise
            except:
                self.term_width = self._env_size()

        self.__iterable = None
        self._update_widgets()
        self.currval = 0
        self.finished = False
        self.last_update_time = None
        self.poll = poll
        self.seconds_elapsed = 0
        self.start_time = None
        self.update_interval = 1