2.3.19. vacumm.misc.log – Logging utilities

2.3.19.1. Overview

Attributes:

default

hascurses

logger

Functions:

check_level() convert_level() filter_name()

get_int_level() get_int_levels()

get_str_level() get_str_levels()

Classes:

ColoredStreamHandler colors level_colors format() get_level_color() Formatter LogLevelError Logger default_date_format default_encoding default_format default_level default_max_file_backup default_max_file_size default initial_level shared_handlers addHandler() add_argparser_options() add_handler() add_optparser_options() add_rotating_file_handler() add_shared_handler() add_stream_handler() apply_argparser_options() apply_class_argparser_options() apply_class_optparser_options() apply_optparser_options() clean() colorize() config() default_colorize() filter_name() findCaller() get_date_format() get_default_colorize() get_default_date_format() get_default_format() get_default_level() get_format() get_level_name() get_level() get_name_filters() get_name() is_debug() is_verbose() load_config() log() new_formatter() new_rotating_file_handler() new_stream_handler() notice() removeHandler() remove_handler() setLevel() set_date_format() set_default_colorize() set_default_date_format() set_default_format() set_default_level() set_default_max_file_backup() set_default_max_file_size() set_format() set_handler_formats() set_level_console() set_level_logfile() set_level() set_name_filters() set_name() showwarning() skipCaller() start_redirections() stop_redirections() verbose() LoggerAdapter get_logger() is_debug() is_verbose() notice() process() verbose() StreamLogWrapper write()

2.3.19.2. Content

Logging features

class ColoredStreamHandler(stream, *args, **kwargs)

Bases: logging.StreamHandler

colors = {'blackb': 40, 'blackf': 30, 'blueb': 44, 'bluef': 34, 'boldoff': 22, 'boldon': 1, 'cyanb': 46, 'cyanf': 36, 'greenb': 42, 'greenf': 32, 'invoff': 27, 'invon': 7, 'italicsoff': 23, 'italicson': 3, 'purpleb': 45, 'purplef': 35, 'redb': 41, 'redf': 31, 'reset': 0, 'uloff': 24, 'ulon': 4, 'whiteb': 47, 'whitef': 37, 'yellowb': 43, 'yellowf': 33}

format(record)

Format the specified record.

If a formatter is set, use it. Otherwise, use the default formatter for the module.

get_level_color(level)

level_colors = {0: 'reset', 10: 'cyanf', 15: 'bluef', 20: 'greenf', 25: 'greenf,boldon', 30: 'yellowf,boldon', 40: 'redf,boldon', 50: 'purplef,boldon'}

class Formatter(fmt=None, datefmt=None)

Bases: logging.Formatter

exception LogLevelError(level)

Bases: exceptions.Exception

class Logger(name=None, level=None, format=None, date_format=None, console=True, colorize=True, logfile=None, redirect_warnings=False, redirect_stdout=False, redirect_stderr=False, name_filters=None, config=None)

Bases: logging.Logger

Logger based on the standard python logging package.

addHandler(handler, **kwargs)

classmethod add_argparser_options(*args, **kwargs)

add_handler(handler, **kwargs)

classmethod add_optparser_options(*args, **kwargs)

add_rotating_file_handler(*args, **kwargs)

classmethod add_shared_handler(handler)

add_stream_handler(*args, **kwargs)

apply_argparser_options(*args, **kwargs)

classmethod apply_class_argparser_options(*args, **kwargs)

classmethod apply_class_optparser_options(*args, **kwargs)

apply_optparser_options(*args, **kwargs)

clean()

colorize(active=None)

config(*args, **kwargs)

Get or set logging configuration

This method uses the get_* and set_* methods.

Params:

• args: depending of the type:

  • basestring: (getter) return the corresponding value(s)
  • Logger: (setter) use this logger’s configuration
  • dict: (setter) use this dict’s configuration

• kwargs: key/value pairs of configuration which are to be set

Getter:

>>> logger.config('level')
%(default_level)r
>>> logger.config('level', 'format')
(%(default_level)r, %(default_format)r)
>>> logger.config() # return complete configuration as a dict
TODO

Setter:

>>> logger.config(level=%(default_level)r)
>>> logger.config(level=%(default_level)r, format=%(default_format)r)
>>> logger.config(configdict) # use a dict as config key/value pairs
>>> logger.config(otherlogger) # use another logger's configuration

default = <vacumm.misc.log.Logger object>

classmethod default_colorize(active=None)

default_date_format = {'console': '', 'default': '%Y-%m-%d %H:%M:%S %Z', 'logfile': '%Y-%m-%d %H:%M:%S %Z'}

default_encoding = None

default_format = {'console': '[%(name)s %(levelname)s] %(message)s', 'default': '[%(asctime)s %(name)s %(levelname)s] %(message)s', 'logfile': '[%(asctime)s %(name)s %(levelname)s] %(message)s'}

default_level = 20

default_max_file_backup = 0

default_max_file_size = 512000

filter_name(value, default)

Used by the set_{level,format,date_format} instance methods. The logger get_name() and instance variable self.__name_filters are evaluated against the couples name1=value1[,name2=value2,…] in value to determine the value to return, default is returned if nothing match, value is return if it isn’t a filter expression.

findCaller()

Find the stack frame of the caller so that we can note the source file name, line number and function name.

get_date_format()

classmethod get_default_colorize(active=None)

classmethod get_default_date_format(target=None)

Get the default date format for the specified target, or all formats dict if target is None

classmethod get_default_format(target=None)

Get the default format for the specified target, or all formats dict if target is None

classmethod get_default_level()

get_format()

get_level()

get_level_name()

get_name()

get_name_filters()

initial_level = 20

instances = <_weakrefset.WeakSet object>

is_debug()

is_verbose()

load_config(cfgo=None, nested=True)

log(level, msg, *args, **kwargs)

Log ‘msg % args’ with the integer severity ‘level’.

To pass exception information, use the keyword argument exc_info with a true value, e.g.

logger.log(level, “We have a %s”, “mysterious problem”, exc_info=1)

classmethod new_formatter(format=None, date_format=None, formatter=None)

classmethod new_rotating_file_handler(filePath=None, mode='a', maxFileSize=None, maxFileBkp=None, encoding=None, level=None, format=None, date_format=None, **kwargs)

classmethod new_stream_handler(stream=<open file '<stderr>', mode 'w'>, colorize=False, level=None, format=None, date_format=None, **kwargs)

notice(msg, *args, **kwargs)

removeHandler(hdlr)

remove_handler(hdlr)

setLevel(level, filter=False)

set_date_format(format, filter=False)

classmethod set_default_colorize(active=None)

classmethod set_default_date_format(format, target=None, filter=False)

classmethod set_default_format(format, target=None, filter=False)

classmethod set_default_level(level, filter=False)

classmethod set_default_max_file_backup(value, filter=False)

classmethod set_default_max_file_size(value, filter=False)

set_format(format, filter=False)

classmethod set_handler_formats(handler, format=None, date_format=None)

set_level(level, filter=False)

set_level_console(level, filter=False)

set_level_logfile(level, filter=False)

set_name(name)

set_name_filters(filters)

shared_handlers = []

showwarning(message, category, filename, lineno, file=None)

skipCaller(caller=None, skip=True)

Register a function, method, code or set/list/tuple of codes to be skipped by findCaller

start_redirections(which='all')

stop_redirections(which='all')

verbose(msg, *args, **kwargs)

class LoggerAdapter(**kwargs)

Bases: logging.LoggerAdapter

get_logger()

is_debug()

Return True if the logger level is debug (or greater)

is_verbose()

Return True if the logger level is verbose (or greater)

notice(msg, *args, **kwargs)

Delegate a log call to the underlying logger, after adding contextual information from this adapter instance.

process(msg, kwargs)

Process the logging message and keyword arguments passed in to a logging call to insert contextual information. You can either manipulate the message itself, the keyword args or both. Return the message and kwargs modified (or not) to suit your needs.

Normally, you’ll only need to override this one method in a LoggerAdapter subclass for your specific needs.

verbose(msg, *args, **kwargs)

Delegate a log call to the underlying logger, after adding contextual information from this adapter instance.

class StreamLogWrapper(stream, logger, name='')

Bases: object

write(s)

check_level(level)

convert_level(level)

Convert a level from int/str to str/int

filter_name(names, value, default)

get_int_level(level)

Get the int level for the given int/str level

get_int_levels()

get_str_level(level)

Get the str level for the given int/str level

get_str_levels()