Home       Trees       Index       Help   

epydoc 3.0alpha2

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

Class ConsoleLogger
source code

Instance Methods [hide private]
  __init__(self, verbosity)
  start_block(self, header)
Start a new message block.
  end_block(self)
End a warning block.
  _format(self, prefix, message, color)
Rewrap the message; but preserve newlines, and don't touch any lines that begin with spaces.
  log(self, level, message)
Display a message.
  _report(self, message)
  progress(self, percent, message='')
Update the progress display.
  _timestr(self, dt)
  start_progress(self, header=None)
Begin displaying progress for a new task.
  end_progress(self)
Finish off the display of progress for the current task.
  print_times(self)

Instance Variables [hide private]
supressed_docstring_warning This variable will be incremented once every time a docstring warning is reported tothe logger, but the verbosity level is too low for it to be displayed.

Method Details [hide private]

__init__(self, verbosity)
(Constructor)

source code 

start_block(self, header)

source code 
Start a new message block. Any calls to info, warn, or error that occur between a call to start_block and a corresponding call to end_block will be grouped together, and displayed with a common header. start_block can be called multiple times (to form nested blocks), but every call to start_block must be balanced by a call to end_block.
Overrides: log.Logger.start_block
(inherited documentation)

end_block(self)

source code 
End a warning block. See start_block for details.
Overrides: log.Logger.end_block
(inherited documentation)

_format(self, prefix, message, color)

source code 
Rewrap the message; but preserve newlines, and don't touch any lines that begin with spaces.

log(self, level, message)

source code 
Display a message.
Overrides: log.Logger.log
(inherited documentation)

_report(self, message)

source code 

progress(self, percent, message='')

source code 
Update the progress display.
Overrides: log.Logger.progress
(inherited documentation)

_timestr(self, dt)

source code 

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 

Instance Variable Details [hide private]

supressed_docstring_warning

This variable will be incremented once every time a docstring warning is reported tothe logger, but the verbosity level is too low for it to be displayed.

   Home       Trees       Index       Help   

epydoc 3.0alpha2

Generated by Epydoc 3.0alpha2 on Tue Apr 11 17:34:00 2006 http://epydoc.sf.net