lsst.log.utils Namespace Reference

Classes
class	LogRedirect

Functions
	traceSetAt (name, number)
	temporaryLogLevel (name, level)
	enable_notebook_logging (dest=sys.stderr)
	disable_notebook_logging ()

Variables
	_redirect = None

Function Documentation

disable_notebook_logging()

lsst.log.utils.disable_notebook_logging

(

)

Stop notebook output for log4cxx messages.

Definition at line 147 of file utils.py.

def disable_notebook_logging():
    """Stop notebook output for log4cxx messages."""
    global _redirect
    if _redirect is not None:
        _redirect.finish()
        _redirect = None

enable_notebook_logging()

lsst.log.utils.enable_notebook_logging

(

dest = sys.stderr

)

Enable notebook output for log4cxx messages.

Definition at line 140 of file utils.py.

def enable_notebook_logging(dest=sys.stderr):
    """Enable notebook output for log4cxx messages."""
    global _redirect
    if _redirect is None:
        _redirect = LogRedirect(dest=dest)
 
 

temporaryLogLevel()

lsst.log.utils.temporaryLogLevel	(		name,
			level
	)

A context manager that temporarily sets the level of a `Log`.

Parameters
----------
name : `str`
    Name of the log to modify.
level : `int`
    Integer enumeration constant indicating the temporary log level.

Definition at line 58 of file utils.py.

def temporaryLogLevel(name, level):
    """A context manager that temporarily sets the level of a `Log`.
 
    Parameters
    ----------
    name : `str`
        Name of the log to modify.
    level : `int`
        Integer enumeration constant indicating the temporary log level.
    """
    log = Log.getLogger(name)
    old = log.getLevel()
    log.setLevel(level)
    try:
        yield
    finally:
        log.setLevel(old)
 
 

traceSetAt()

lsst.log.utils.traceSetAt	(		name,
			number
	)

Adjusts logging level to display messages with the trace number being
less than or equal to the provided value.

Parameters
----------
name : `str`
    Name of the logger.
number : `int`
    The trace number threshold for display.

Definition at line 41 of file utils.py.

def traceSetAt(name, number):
    """Adjusts logging level to display messages with the trace number being
    less than or equal to the provided value.
 
    Parameters
    ----------
    name : `str`
        Name of the logger.
    number : `int`
        The trace number threshold for display.
    """
    for i in range(6):
        level = Log.INFO if i > number else Log.DEBUG
        Log.getLogger('TRACE%d.%s' % (i, name)).setLevel(level)
 
 
@contextmanager

Variable Documentation

_redirect

lsst.log.utils._redirect = None

protected

Definition at line 137 of file utils.py.