topostats.logs.logs

Standardise logging.

Module Contents

Functions

setup_logger(→ logging.Logger)

Logger setup.

Attributes

start
LOG_INFO_FORMATTER
LOG_ERROR_FORMATTER
LOGGER_NAME

topostats.logs.logs.start

topostats.logs.logs.LOG_INFO_FORMATTER

topostats.logs.logs.LOG_ERROR_FORMATTER

topostats.logs.logs.LOGGER_NAME = 'topostats'

topostats.logs.logs.setup_logger(log_name: str = LOGGER_NAME) → logging.Logger

Logger setup.

The logger for the module is initialised when the module is loaded (as this functions is called from __init__.py). This creates two stream handlers, one for general output and one for errors which are formatted differently (there is greater information in the error formatter). To use in modules import the ‘LOGGER_NAME’ and create a logger as shown in the Examples, it will inherit the formatting and direction of messages to the correct stream.

Parameters:

log_name (str) – Name under which logging information occurs.

Returns:

Logger object.

Return type:

logging.Logger

Examples

To use the logger in (sub-)modules have the following.

import logging from topostats.logs.logs import LOGGER_NAME

LOGGER = logging.getLogger(LOGGER_NAME)

LOGGER.info(‘This is a log message.’)