Package epydoc :: Module cli :: Class UnifiedProgressConsoleLogger
[hide private]
[frames] | no frames]

ClassType UnifiedProgressConsoleLogger

source code


Instance Methods [hide private]
 
__init__(self, verbosity, stages, progress_mode=None) source code
 
progress(self, percent, message='')
Update the progress display.
source code
 
start_progress(self, header=None)
Begin displaying progress for a new task.
source code
 
end_progress(self)
Finish off the display of progress for the current task.
source code
 
print_times(self) source code

Inherited from ConsoleLogger: end_block, log, start_block

Inherited from ConsoleLogger (private): _format, _report, _timestr

Inherited from log.Logger: close

Instance Variables [hide private]

Inherited from ConsoleLogger: reported_message_levels, suppressed_docstring_warning

Method Details [hide private]

__init__(self, verbosity, stages, progress_mode=None)
(Constructor)

source code 
Overrides: ConsoleLogger.__init__

progress(self, percent, message='')

source code 

Update the progress display.

Parameters:
  • percent - A float from 0.0 to 1.0, indicating how much progress has been made.
  • message - A message indicating the most recent action that contributed towards that progress.
Overrides: log.Logger.progress
(inherited documentation)

start_progress(self, header=None)

source code 

Begin displaying progress for a new task. header is a description of the task for which progress is being reported. Each call to start_progress must be followed by a call to end_progress (with no intervening calls to start_progress).

Overrides: log.Logger.start_progress
(inherited documentation)

end_progress(self)

source code 

Finish off the display of progress for the current task. See start_progress for more information.

Overrides: log.Logger.end_progress
(inherited documentation)

print_times(self)

source code 
Overrides: ConsoleLogger.print_times