setup_logging

support.logs.setup_logging(logger=None, logfile=None, logLevel=10, handlers=None, **kwargs)

setup up some logging.getLogger instance with console logging and file logging handlers (StreamHandler and FileHandler handlers, respectively.)

Examples:

Super basic setup, with no file logging.

import logging

from support.logs import setup_logging

logger = logging.getLogger("")
setup_logging(logger=logger)

Add a file handler:

import logging

from support.logs import setup_logging

logger = logging.getLogger("")
setup_logging(logger=logger, logfile="/path/to/logfile.log", logLevel=logging.INFO)

Setup a custom email handler that uses TLS encryption:

import logging

from support.logs import setup_logging, setup_email_handler

handler = setup_email_handler(["me@domain.com"])
logger = logging.getLogger("")
setup_logging(logger=logger, logfile="/path/to/logfile.log",
    logLevel=logging.INFO, handlers=handler)
Parameters

  • logger (logging.getLogger, optional) – logging instance to which to add handlers

  • logfile (str, optional) – logfile to log to. If this isn’t provided, no FileHandler will be set up.

  • logLevel (int, optional) – logLevel for StreamHandler.

  • handlers (list/logging.Handler, optional) – Additional handlers to add to logging instance.

  • **kwargs – Extra keyword arguments, not used here.

Returns

logging instance with new handlers added

Return type

logging.getLogger