adctk.log Namespace Reference

Functions
	setup_file_handler (path, str log_name="adctk.python.log")
	setup_stream_handler (int level=logging.ERROR)

Variables
	LOGLEVEL = logging.DEBUG
str	LOGFORMAT = "%(asctime)s [%(levelname)s] - %(message)s"
	LOGFORMATTER = logging.Formatter(LOGFORMAT)
	logger = logging.getLogger("adctk")

Function Documentation

setup_file_handler()

adctk.log.setup_file_handler	(		path,
		str	log_name = "adctk.python.log"
	)

def setup_file_handler(path, log_name: str = "adctk.python.log"):
    lp = os.getenv("ADC_LOG_DIRECTORY")
    ll = os.getenv("ADC_LOG_LEVEL")
    if path:
        log_filepath = os.path.join(path, log_name)
    else:
        if lp:
            log_filepath = os.path.join(lp, log_name)
        else:
            log_filepath = os.path.join(".", log_name)
    lhandle = handlers.RotatingFileHandler(log_filepath, maxBytes = 10000000, backupCount = 10)
    if ll:
        lhandle.setLevel(ll)
    else:
        lhandle.setLevel(LOGLEVEL)
    lhandle.setFormatter(LOGFORMATTER)
    logger.addHandler(lhandle)
    logger.debug("Setup file log handler at: %s", log_filepath)
 
 

setup_stream_handler()

adctk.log.setup_stream_handler

(

int

level = logging.ERROR

)

def setup_stream_handler(level: int =logging.ERROR):
    lhandle = logging.StreamHandler()
    lhandle.setFormatter(LOGFORMATTER)
    ll = os.getenv("ADC_LOG_LEVEL")
    if ll:
        numeric_level = getattr(logging, ll.upper(), None)
        if not isinstance(numeric_level, int):
            raise ValueError(f"Invalid log level: {ll}")
        lhandle.setLevel(numeric_level)
    else:
        lhandle.setLevel(level)
    logger.addHandler(lhandle)
    logger.debug("Setup stream log handler")

Variable Documentation

LOGFORMAT

str adctk.log.LOGFORMAT = "%(asctime)s [%(levelname)s] - %(message)s"

LOGFORMATTER

adctk.log.LOGFORMATTER = logging.Formatter(LOGFORMAT)

logger

adctk.log.logger = logging.getLogger("adctk")

LOGLEVEL

adctk.log.LOGLEVEL = logging.DEBUG