Package backend :: Package satellite_tools :: Module progress_bar :: Class ProgressBar
[hide private]
[frames] | no frames]

Class ProgressBar

source code

A simplete progress bar class. See example in main below.

Instance Methods [hide private]
 
__init__(self, prompt='working: ', endTag=' - done', finalSize=100.0, finalBarLength=10, barChar='#', stream=sys.stdin, redrawYN=1) source code
 
reinit(self) source code
 
printAll(self, contextYN=0)
Prints/reprints the prompt and current level of hashmarks.
source code
 
printIncrement(self)
visually updates the bar.
source code
 
printComplete(self)
Completes the bar reguardless of current object status (and then updates the object's status to complete).
source code
 
update(self, newSize)
Update the status of the class to the newSize of the bar.
source code
 
addTo(self, additionalSize)
Update the object's status to an additional bar size.
source code
 
complete(self) source code
Method Details [hide private]

printAll(self, contextYN=0)

source code 
Prints/reprints the prompt and current level of hashmarks.
Eg:             ____________________
    Processing: ###########
NOTE: The underscores only occur if you turn on contextYN.