pyreporting.progress_bar.TerminalProgressBar#

class TerminalProgressBar(**kwargs)[source]#

Bases: ProgressBar

A terminal dialog used to report progress information using enlighten

Initialise progress bar

Parameters:

parent – when using a GUI, the parent object to whicih the progress bar should be attached

Methods

cancel_clicked

Return True if the cancel button was clicked by the user

close

Destroy progress bar

set_parent

Set the parent object for GUI progress bars

update

Update progress bar
cancel_clicked()[source]#

Return True if the cancel button was clicked by the user

close()[source]#

Destroy progress bar

set_parent(parent)#

Set the parent object for GUI progress bars

update(label=None, value=None, title=None)[source]#

Update progress bar

Parameters:

  • label – If defined, change the text label for the progress bar

  • value – If defined, change the progress completion value

  • title – If defined, change the progress window title