progressbar.Bar Class Reference

Inheritance diagram for progressbar.Bar:

Public Member Functions
def	__init__ (self, marker='#', left='|', right='|', fill=' ', fill_left=True)
def	update (self, pbar, width)
Public Member Functions inherited from progressbar.WidgetHFill
def	update (self, pbar, width)
Public Member Functions inherited from progressbar.Widget
def	update (self, pbar)

Public Attributes
	fill
	fill_left
	left
	marker
	right

Static Private Attributes
	__slots__

Additional Inherited Members
Static Public Attributes inherited from progressbar.Widget
	TIME_SENSITIVE

Detailed Description

Definition at line 72 of file progressbar.py.

Constructor & Destructor Documentation

__init__()

def progressbar.Bar.__init__	(		self,
			marker = '#',
			left = '|',
			right = '|',
			fill = ' ',
			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

Definition at line 78 of file progressbar.py.

                 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
        '''
        self.marker = marker
        self.left = left
        self.right = right
        self.fill = fill
        self.fill_left = fill_left

Member Function Documentation

update()

def progressbar.Bar.update	(		self,
			pbar,
			width
	)

Definition at line 94 of file progressbar.py.

References progressbar.Bar.fill, progressbar.Bar.fill_left, progressbar.format_updatable(), createfilelist.int, ShallowClustersProducer::NearDigis.left, JME::bimap< T, U >.left, BinaryOP.left, progressbar.Bar.left, progressbar.Bar.marker, HCAL_HLX::LUMI_RAW_HEADER.marker, ShallowClustersProducer::NearDigis.right, JME::bimap< T, U >.right, KDTreeNodes< DATA, DIM >.right, BinaryOP.right, progressbar.Bar.right, svgfig.Curve.Sample.right, and svgfig.Curve.Samples.right.

Referenced by progressbar.ProgressBar.__next__(), MatrixUtil.Matrix.__setitem__(), MatrixUtil.Steps.__setitem__(), progressbar.ProgressBar.finish(), and MatrixUtil.Steps.overwrite().

    def update(self, pbar, width):
        '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:
            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)

Member Data Documentation

__slots__

progressbar.Bar.__slots__

staticprivate

Definition at line 75 of file progressbar.py.

fill

progressbar.Bar.fill

Definition at line 90 of file progressbar.py.

Referenced by progressbar.Bar.update(), and progressbar.BouncingBar.update().

fill_left

progressbar.Bar.fill_left

Definition at line 91 of file progressbar.py.

Referenced by progressbar.Bar.update(), and progressbar.BouncingBar.update().

left

progressbar.Bar.left

Definition at line 88 of file progressbar.py.

Referenced by svgfig.Curve.Samples.__len__(), progressbar.Bar.update(), and progressbar.BouncingBar.update().

marker

progressbar.Bar.marker

Definition at line 87 of file progressbar.py.

Referenced by progressbar.Bar.update(), and progressbar.BouncingBar.update().

right

progressbar.Bar.right

Definition at line 89 of file progressbar.py.

Referenced by progressbar.Bar.update(), and progressbar.BouncingBar.update().