python.ProgressBar.progressBar Class Reference

Collaboration diagram for python.ProgressBar.progressBar:

Public Member Functions
def	__init__ (self, minValue=0, maxValue=10, totalWidth=12, prefix="", suffix="")
def	update (self, newAmount=0)
def	done (self)
def	__str__ (self)

Public Attributes
	progBar
	min
	max
	span
	amount
	nextUpdate
	prefix
	suffix
	width

Detailed Description

Definition at line 5 of file ProgressBar.py.

Constructor & Destructor Documentation

__init__()

def python.ProgressBar.progressBar.__init__	(		self,
			minValue = 0,
			maxValue = 10,
			totalWidth = 12,
			prefix = "",
			suffix = ""
	)

Definition at line 6 of file ProgressBar.py.

    def __init__(self, minValue = 0, maxValue = 10, totalWidth=12, prefix="", suffix=""):
        self.progBar = "[]"   # This holds the progress bar string
        self.min = minValue
        self.max = maxValue
        self.span = maxValue - minValue
        self.amount = 0       # When amount == max, we are 100% done
        self.nextUpdate = minValue+float(self.span/100.0)
        if len(prefix):
            self.prefix=prefix+" ["
        else:
            self.prefix="["
        if len(suffix):
            self.suffix="] " + suffix
        else:
            self.suffix="]"
        self.width = totalWidth - len(self.prefix) - len(self.suffix)
        self.update(0)  # Build progress bar string
 

Member Function Documentation

__str__()

def python.ProgressBar.progressBar.__str__

(

self

)

Definition at line 64 of file ProgressBar.py.

    def __str__(self):
        return str(self.progBar)

done()

def python.ProgressBar.progressBar.done

(

self

)

Definition at line 59 of file ProgressBar.py.

    def done(self):
        self.update(self.max)
        sys.stdout.write('\r' + self.progBar + '\n')
        sys.stdout.flush()# force updating of screen
 

update()

def python.ProgressBar.progressBar.update	(		self,
			newAmount = 0
	)

Definition at line 24 of file ProgressBar.py.

    def update(self, newAmount = 0):
        if newAmount < self.min:
            newAmount = self.min
        if newAmount > self.max:
            newAmount = self.max
 
        #=== only continue if something new to draw
        if newAmount < self.nextUpdate and newAmount<self.max :
            return
        self.nextUpdate = self.nextUpdate+float(self.span/100.0)
        self.amount = newAmount
 
        # Figure out the new percent done, round to an integer
        diffFromMin = float(self.amount - self.min)
        percentDone = (diffFromMin / float(self.span)) * 100.0 if self.span>0 else 100.
        percentDone = round(percentDone)
        percentDone = int(percentDone)
 
        # Figure out how many hash bars the percentage should be
        numHashes = (percentDone / 100.0) * self.width
        numHashes = int(round(numHashes))
 
        # build a progress bar with hashes and spaces
        self.progBar = self.prefix + '#'*numHashes + ' '*(self.width-numHashes) + self.suffix
 
        # figure out where to put the percentage, roughly centered
        percentPlace = (len(self.progBar) // 2) - len(str(percentDone))
        percentString = str(percentDone) + "%"
 
        # slice the percentage into the bar
        self.progBar = self.progBar[0:percentPlace] + percentString + self.progBar[percentPlace+len(percentString):]
 
        sys.stdout.write('\r' + self.progBar)
        sys.stdout.flush()# force updating of screen
 

Member Data Documentation

amount

python.ProgressBar.progressBar.amount

Definition at line 11 of file ProgressBar.py.

max

python.ProgressBar.progressBar.max

Definition at line 9 of file ProgressBar.py.

min

python.ProgressBar.progressBar.min

Definition at line 8 of file ProgressBar.py.

nextUpdate

python.ProgressBar.progressBar.nextUpdate

Definition at line 12 of file ProgressBar.py.

prefix

python.ProgressBar.progressBar.prefix

Definition at line 14 of file ProgressBar.py.

progBar

python.ProgressBar.progressBar.progBar

Definition at line 7 of file ProgressBar.py.

span

python.ProgressBar.progressBar.span

Definition at line 10 of file ProgressBar.py.

suffix

python.ProgressBar.progressBar.suffix

Definition at line 18 of file ProgressBar.py.

width

python.ProgressBar.progressBar.width

Definition at line 21 of file ProgressBar.py.

---

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

• ProgressBar.py