Package grizzled :: Module log :: Class WrappingLogFormatter

Class WrappingLogFormatter

logging.Formatter --+
                    |
                   WrappingLogFormatter

A logging Formatter class that writes each message wrapped on line boundaries. Here's a typical usage scenario:

import logging
import sys
from grizzled.log import WrappingLogFormatter

stderr_handler = logging.StreamHandler(sys.stderr)
formatter = WrappingLogFormatter(format='%(levelname)s %(message)s")
stderr_handler.setLevel(logging.WARNING)
stderr_handler.setFormatter(formatter)
logging.getLogger('').handlers = [stderr_handler]

Instance Methods

__init__(self, format=None, date_format=None, max_width=79)
Initialize a new WrappingLogFormatter.

format(self, record)
Format the specified record as text.

Inherited from logging.Formatter: formatException, formatTime

Class Variables
Inherited from `logging.Formatter`: `converter`

Method Details

init(self, format=None, date_format=None, max_width=79)
(Constructor)

Initialize a new WrappingLogFormatter.

Parameters:

format (str) - The format to use, or None for the logging default
date_format (str) - Date format, or None for the logging default
max_width (int) - Maximum line width, or None to default to 79./

Overrides: logging.Formatter.__init__

format(self, record)

Format the specified record as text.

The record's attribute dictionary is used as the operand to a string formatting operation which yields the returned string. Before formatting the dictionary, a couple of preparatory steps are carried out. The message attribute of the record is computed using LogRecord.getMessage(). If the formatting string contains "%(asctime)", formatTime() is called to format the event time. If there is exception information, it is formatted using formatException() and appended to the message.

Overrides: logging.Formatter.format: (inherited documentation)

Class WrappingLogFormatter

__init__(self, format=None, date_format=None, max_width=79) (Constructor)

format(self, record)

init(self, format=None, date_format=None, max_width=79)
(Constructor)