habitat.core.logging.HabitatLogger class

Methods

def _log(self, level, msg, args, exc_info = None, extra = None, stack_info = False, stacklevel = 1)
Low-level logging routine which creates a LogRecord and then calls all the handlers of this logger to handle the record.
def addFilter(self, filter)
Add the specified filter to this handler.
def addHandler(self, hdlr)
Add the specified handler to this logger.
def add_filehandler(self, log_filename)
def callHandlers(self, record)
Pass a record to all relevant handlers.
def critical(self, msg, *args, **kwargs)
Log ‘msg % args’ with severity ‘CRITICAL’.
def debug(self, msg, *args, **kwargs)
Log ‘msg % args’ with severity ‘DEBUG’.
def error(self, msg, *args, **kwargs)
Log ‘msg % args’ with severity ‘ERROR’.
def exception(self, msg, *args, exc_info = True, **kwargs)
Convenience method for logging an ERROR with exception information.
def fatal(self, msg, *args, **kwargs)
Log ‘msg % args’ with severity ‘CRITICAL’.
def filter(self, record)
Determine if a record is loggable by consulting all the filters.
def findCaller(self, stack_info = False, stacklevel = 1)
Find the stack frame of the caller so that we can note the source file name, line number and function name.
def getChild(self, suffix)
Get a logger which is a descendant to this one.
def getEffectiveLevel(self)
Get the effective level for this logger.
def handle(self, record)
Call the handlers for the specified record.
def hasHandlers(self)
See if this logger has any handlers configured.
def info(self, msg, *args, **kwargs)
Log ‘msg % args’ with severity ‘INFO’.
def isEnabledFor(self, level)
Is this logger enabled for level ‘level’?
def log(self, level, msg, *args, **kwargs)
Log ‘msg % args’ with the integer severity ‘level’.
def makeRecord(self, name, level, fn, lno, msg, args, exc_info, func = None, extra = None, sinfo = None)
A factory method which can be overridden in subclasses to create specialized LogRecords.
def removeFilter(self, filter)
Remove the specified filter from this handler.
def removeHandler(self, hdlr)
Remove the specified handler from this logger.
def setLevel(self, level)
Set the logging level of this logger. level must be an int or a str.
def warn(self, msg, *args, **kwargs)
def warning(self, msg, *args, **kwargs)
Log ‘msg % args’ with severity ‘WARNING’.

Special methods

def __init__(self, name, level, filename = None, filemode = 'a', stream = None, format_str = None, dateformat = None, style = '%')
def __reduce__(self)
def __repr__(self)

Data

manager
root

Method documentation

def habitat.core.logging.HabitatLogger.callHandlers(self, record)

Pass a record to all relevant handlers.

Loop through all handlers for this logger and its parents in the logger hierarchy. If no handler was found, output a one-off error message to sys.stderr. Stop searching up the hierarchy whenever a logger with the “propagate” attribute set to zero is found - that will be the last logger whose handlers are called.

def habitat.core.logging.HabitatLogger.critical(self, msg, *args, **kwargs)

Log ‘msg % args’ with severity ‘CRITICAL’.

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

logger.critical(“Houston, we have a %s”, “major disaster”, exc_info=1)

def habitat.core.logging.HabitatLogger.debug(self, msg, *args, **kwargs)

Log ‘msg % args’ with severity ‘DEBUG’.

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

logger.debug(“Houston, we have a %s”, “thorny problem”, exc_info=1)

def habitat.core.logging.HabitatLogger.error(self, msg, *args, **kwargs)

Log ‘msg % args’ with severity ‘ERROR’.

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

logger.error(“Houston, we have a %s”, “major problem”, exc_info=1)

def habitat.core.logging.HabitatLogger.fatal(self, msg, *args, **kwargs)

Log ‘msg % args’ with severity ‘CRITICAL’.

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

logger.critical(“Houston, we have a %s”, “major disaster”, exc_info=1)

def habitat.core.logging.HabitatLogger.getChild(self, suffix)

Get a logger which is a descendant to this one.

This is a convenience method, such that

logging.getLogger(‘abc’).getChild(‘def.ghi’)

is the same as

logging.getLogger(‘abc.def.ghi’)

It’s useful, for example, when the parent logger is named using __name__ rather than a literal string.

def habitat.core.logging.HabitatLogger.getEffectiveLevel(self)

Get the effective level for this logger.

Loop through this logger and its parents in the logger hierarchy, looking for a non-zero logging level. Return the first one found.

def habitat.core.logging.HabitatLogger.handle(self, record)

Call the handlers for the specified record.

This method is used for unpickled records received from a socket, as well as those created locally. Logger-level filtering is applied.

def habitat.core.logging.HabitatLogger.hasHandlers(self)

See if this logger has any handlers configured.

Loop through all handlers for this logger and its parents in the logger hierarchy. Return True if a handler was found, else False. Stop searching up the hierarchy whenever a logger with the “propagate” attribute set to zero is found - that will be the last logger which is checked for the existence of handlers.

def habitat.core.logging.HabitatLogger.info(self, msg, *args, **kwargs)

Log ‘msg % args’ with severity ‘INFO’.

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

logger.info(“Houston, we have a %s”, “interesting problem”, exc_info=1)

def habitat.core.logging.HabitatLogger.log(self, 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)

def habitat.core.logging.HabitatLogger.warning(self, msg, *args, **kwargs)

Log ‘msg % args’ with severity ‘WARNING’.

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

logger.warning(“Houston, we have a %s”, “bit of a problem”, exc_info=1)