Module __main__ :: Class ConsoleLogger

Class ConsoleLogger

epydoc.log.Logger --+
                    |
                   ConsoleLogger

Known Subclasses:

UnifiedProgressConsoleLogger

Instance Methods

[hide private]

__init__(self, verbosity, progress_mode=None)

_format(self, prefix, message, color)
Rewrap the message; but preserve newlines, and don't touch any lines that begin with spaces.

_report(self, message)

_timestr(self, dt)

end_block(self)
End a warning block.

end_progress(self)
Finish off the display of progress for the current task.

log(self, level, message)
Display a message.

print_times(self)

progress(self, percent, message='')
Update the progress display.

start_block(self, header)
Start a new message block.

start_progress(self, header=None)
Begin displaying progress for a new task.

Inherited from epydoc.log.Logger: close

Method Details

[hide private]

end_block(self)

End a warning block. See start_block for details.

Overrides: epydoc.log.Logger.end_block: (inherited documentation)

end_progress(self)

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

Overrides: epydoc.log.Logger.end_progress: (inherited documentation)

log(self, level, message)

Display a message.

Parameters:

message - The message string to display. message may contain newlines, but does not need to end in a newline.
level - An integer value indicating the severity of the message.

Overrides: epydoc.log.Logger.log

(inherited documentation)

progress(self, percent, message=`''`)

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: epydoc.log.Logger.progress

(inherited documentation)

start_block(self, header)

Start a new message block. Any calls to info(), warning(), 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: epydoc.log.Logger.start_block: (inherited documentation)

start_progress(self, header=None)

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: epydoc.log.Logger.start_progress: (inherited documentation)