Top

grizzled.log module

Provides some classes and functions for use with the standard Python logging module.

Functions

def init_simple_stream_logging(

level=20, streams=None, format=None, date_format=None)

Useful for simple command-line tools, this method configures the Python logging API to:

  • log to one or more open streams (defaulting to standard output) and
  • use a WrappingLogFormatter

Parameters

  • level (int): Desired log level
  • streams (list of file like objects): List of files or file-like objects to which to log, or None to log to standard output.
  • format (str): A log format to use, or none for "%(asctime)s %(message)s"
  • date_format (str): strftime date format to use in log messages, or None for "%H:%M:%S"

Classes

class 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]

Ancestors (in MRO)

Class variables

var default_msec_format

var default_time_format

Static methods

def __init__(

self, format=None, date_format=None, max_width=None)

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. The default is the value of the environment variable "COLUMNS" (minus 1), or 79 if the environment variable is not set.

def 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 uses the time (as determined by a call to usesTime(), formatTime() is called to format the event time. If there is exception information, it is formatted using formatException() and appended to the message.

def formatException(

self, ei)

Format and return the specified exception information as a string.

This default implementation just uses traceback.print_exception()

def formatMessage(

self, record)

def formatStack(

self, stack_info)

This method is provided as an extension point for specialized formatting of stack information.

The input data is a string as returned from a call to :func:traceback.print_stack, but with the last trailing newline removed.

The base implementation just returns the value passed in.

def formatTime(

self, record, datefmt=None)

Return the creation time of the specified LogRecord as formatted text.

This method should be called from format() by a formatter which wants to make use of a formatted time. This method can be overridden in formatters to provide for any specific requirement, but the basic behaviour is as follows: if datefmt (a string) is specified, it is used with time.strftime() to format the creation time of the record. Otherwise, an ISO8601-like (or RFC 3339-like) format is used. The resulting string is returned. This function uses a user-configurable function to convert the creation time to a tuple. By default, time.localtime() is used; to change this for a particular formatter instance, set the 'converter' attribute to a function with the same signature as time.localtime() or time.gmtime(). To change it for all formatters, for example if you want all logging times to be shown in GMT, set the 'converter' attribute in the Formatter class.

def usesTime(

self)

Check if the format uses the creation time of the record.

Instance variables

var wrapper