pymor.core.logger

This module contains pyMOR’s logging facilities.

pyMOR’s logging facilities are based on the logging module of the Python standard library. To obtain a new logger object use getLogger. Logging can be configured via the set_log_format and set_log_levels methods.

Module Contents

class pymor.core.logger.ColoredFormatter

Bases: logging.Formatter

A logging.Formatter that colors loglevel keyword output.

Coloring can be disabled by setting the PYMOR_COLORS_DISABLE environment variable to 1.

Methods

format	Format the specified record as text.
format_html

format(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.

format_html(record)

class pymor.core.logger.DummyLogger

Methods

block
getChild
getEffectiveLevel
info2
info3
isEnabledFor
nop

critical

debug

error

exception

info

log

propagate = False

warn

warning

block(msg, *args, **kwargs)

getChild()

getEffectiveLevel()

info2(msg, *args, **kwargs)

info3(msg, *args, **kwargs)

isEnabledFor(lvl)

nop(*args, **kwargs)

class pymor.core.logger.LogIndenter(logger, doit)

class pymor.core.logger.PyMORLogger(name, level=NOTSET)

Bases: logging.Logger

Instances of the Logger class represent a single logging channel. A “logging channel” indicates an area of an application. Exactly how an “area” is defined is up to the application developer. Since an application can have any number of areas, logging channels are identified by a unique string. Application areas can be nested (e.g. an area of “input processing” might include sub-areas “read CSV files”, “read XLS files” and “read Gnumeric files”). To cater for this natural nesting, channel names are organized into a namespace hierarchy where levels are separated by periods, much like the Java or Python package namespace. So in the instance given above, channel names might be “input” for the upper level, and “input.csv”, “input.xls” and “input.gnu” for the sub-levels. There is no arbitrary limit to the depth of nesting.

Methods

block
info2
info3

block(msg: str, *args, **kwargs) → LogIndenter

info2(msg: str, *args, **kwargs) → None

info3(msg: str, *args, **kwargs) → None

class pymor.core.logger.RichAwareHandler(level=NOTSET)

Bases: logging.Handler

Handler instances dispatch logging events to specific destinations.

The base handler class. Acts as a placeholder which defines the Handler interface. Handlers can optionally use Formatter instances to format records as desired. By default, no formatter is specified; in this case, the ‘raw’ message as determined by record.message is logged.

Methods

emit	Do whatever it takes to actually log the specified logging record.

emit(record)

Do whatever it takes to actually log the specified logging record.

This version is intended to be implemented by subclasses and so raises a NotImplementedError.

pymor.core.logger.default_handler(filename=None)

pymor.core.logger.getLogger(module, level=None, filename=None) → PyMORLogger

Get the logger of the respective module for pyMOR’s logging facility.

In addition to the logging methods inherited from Logger all returned loggers get a block, info2, info3 method for the respective new levels. Plus all warnings methods get a XXX_once method that caches the msg and only emits the log entry the first time (per logger instance, not globally).

Parameters:

• module – Name of the module.

• level – If set, logger.setLevel(level) is called (see setLevel).

• filename – If not empty, path of an existing file where everything logged will be written to.

pymor.core.logger.log_levels(level_mapping)

Change levels for given loggers on entry and reset to before state on exit.

Parameters:

level_mapping – a dict of logger name -> level name

pymor.core.logger.set_log_format(max_hierarchy_level=1, indent_blocks=True, block_timings=False)

Set log levels for pyMOR’s logging facility.

Parameters:

• max_hierarchy_level – The number of components of the loggers name which are printed. (The first component is always stripped, the last component always preserved.)

• indent_blocks – If True, indent log messages inside a code block started with with logger.block(...).

• block_timings – If True, measure the duration of a code block started with with logger.block(...).

pymor.core.logger.set_log_levels(levels=None)

Set log levels for pyMOR’s logging facility.

Parameters:

levels – Dict of log levels. Keys are names of loggers (see logging.getLogger), values are the log levels to set for the loggers of the given names (see setLevel).

pymor.core.logger.BLOCK

pymor.core.logger.BLOCK_TIME

pymor.core.logger.BLOCK_TIMINGS = True

pymor.core.logger.BOLD_SEQ = '\x1b[1m'

pymor.core.logger.COLORS

pymor.core.logger.COLOR_SEQ = '\x1b[1;%dm'

pymor.core.logger.CSSCOLORS

pymor.core.logger.INDENT = 0

pymor.core.logger.INDENT_BLOCKS = True

pymor.core.logger.INFO2

pymor.core.logger.INFO3

pymor.core.logger.LAST_TIMESTAMP_LENGTH = 0

pymor.core.logger.MAX_HIERARCHY_LEVEL = 1

pymor.core.logger.RESET_SEQ = '\x1b[0m'

pymor.core.logger.dummy_logger

pymor.core.logger.start_time