logger.py

import logging
import logging.config
import os


_INIT_LOGGER = True


def init_logger():
    """Initialize the Logger instance."""
    # pylint: disable=W0603
    global _INIT_LOGGER

    this_dir, _ = os.path.split(__file__)
    path = os.path.join(this_dir, "logging.conf")

    # See
    # https://docs.python.org/3.5/library/logging.config.html#logging.config.fileConfig
    # for a discussion of why or why not to set disable_existing_loggers
    # to False. The long and short of it is that if you don't set it to
    # False it ruins external module's abilities to use the logging
    # facility.
    logging.config.fileConfig(path, disable_existing_loggers=False)

    # Only initialize the logger once.
    _INIT_LOGGER = False


def get_logger():
    """Return a Logger instance appropriate for using in a Tap or a Target."""
    if _INIT_LOGGER:
        init_logger()

    return logging.getLogger()


def log_debug(msg, *args, **kwargs):
    get_logger().debug(msg, *args, **kwargs)


def log_info(msg, *args, **kwargs):
    get_logger().info(msg, *args, **kwargs)


def log_warning(msg, *args, **kwargs):
    get_logger().warning(msg, *args, **kwargs)


def log_error(msg, *args, **kwargs):
    get_logger().error(msg, *args, **kwargs)


def log_critical(msg, *args, **kwargs):
    get_logger().critical(msg, *args, **kwargs)


def log_fatal(msg, *args, **kwargs):
    get_logger().fatal(msg, *args, **kwargs)


def log_exception(msg, *args, **kwargs):
    get_logger().exception(msg, *args, **kwargs)