Package epydoc :: Module cli :: Class ConsoleLogger

[hide private]
[frames] | no frames]

# Class ConsoleLogger

source code

Instance Methods | [hide private]

__init__(self, verbosity, progress_mode=None) | source code

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

end_block(self) End a warning block. | source code

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

log(self, level, message) Display a message. | source code

_report(self, message) | source code

progress(self, percent, message=`'````'`) Update the progress display. | source code

_timestr(self, dt) | 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 `log.Logger`: `close`

Instance Variables | [hide private]

| reported_message_levels This set contains all the message levels (WARNING, ERROR, etc) that have been reported.
| suppressed_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]

### start_block(self, header)

source code

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: 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)

### log(self, level, message)

source code

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

### 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)

Instance Variable Details | [hide private]

### reported_message_levels

This set contains all the message levels (WARNING, ERROR, etc) that have been reported. It is used by the options --fail-on-warning etc to determine the return value.