Utilities

This documents general purpose utility functions available in Logbook.

logbook.debug(self, *args, **kwargs)

Logs a LogRecord with the level set to DEBUG.

logbook.info(self, *args, **kwargs)

Logs a LogRecord with the level set to INFO.

logbook.warn(self, *args, **kwargs)

Logs a LogRecord with the level set to WARNING. This function has an alias named warning().

logbook.warning(self, *args, **kwargs)

Alias for warn().

logbook.notice(self, *args, **kwargs)

Logs a LogRecord with the level set to NOTICE.

logbook.error(self, *args, **kwargs)

Logs a LogRecord with the level set to ERROR.

logbook.exception(self, *args, **kwargs)

Works exactly like error() just that the message is optional and exception information is recorded.

logbook.catch_exceptions(self, *args, **kwargs)

A context manager that catches exceptions and calls exception() for exceptions caught that way. Example:

with logger.catch_exceptions():
    execute_code_that_might_fail()

logbook.critical(self, *args, **kwargs)

Logs a LogRecord with the level set to CRITICAL.

logbook.log(self, level, *args, **kwargs)

Logs a LogRecord with the level set to the level parameter. Because custom levels are not supported by logbook, this method is mainly used to avoid the use of reflection (e.g.: getattr()) for programmatic logging.