log.py

__author__ = 'Huang Kaibo <kamp_kbh@hotmail.com>'
# The following code, derived from the bulbs project, carries this
# license:
"""
Copyright (c) 2017 Huang Kaibo (kamp_kbh@hotmail.com)
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
3. The name of the author may not be used to endorse or promote products
   derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
"""


import config as CONF
from tool import get_root
import logging as lg
from logging.handlers import TimedRotatingFileHandler
from sys import stdout



__all__ = [] # It should not be imported anything.


FMT_DETAIL = lg.Formatter(fmt='[%(asctime)s-%(levelname)-4s- %(filename)-10s %(funcName)-12s :%(lineno)03s]%(message)s.'
                          , datefmt='%Y%m%dT%H%M%S')
# FMT_LITE = lg.Formatter(fmt='%(asctime)s — %(name)s — %(levelname)s — %(message)s', datefmt='%Y%m%d:%H%M%S')


def get_console_handler() -> lg.StreamHandler:
   handler = lg.StreamHandler(stdout)
   handler.setLevel(lg.NOTSET)
   handler.setFormatter(FMT_DETAIL)
   return handler


def get_file_handler(file:str) -> lg.FileHandler:
    handler = TimedRotatingFileHandler(file, when='midnight', encoding='utf-8', backupCount=24, delay=True)
    handler.setLevel(lg.NOTSET)
    handler.setFormatter(FMT_DETAIL)
    return handler


def config_root_logger():
    log_file = get_root().joinpath(CONF.LOG_FILE)
    if CONF.RELEASE:
        lg.root.addHandler(get_file_handler(str(log_file)))
    else:
        if CONF.DEVEOPMENT:
            lg.root.addHandler(get_console_handler())
        else:
            lg.root.addHandler(get_file_handler(str(log_file)))
            lg.root.addHandler(get_console_handler())
    lg.root.setLevel(CONF.LOG_LEVEL)


config_root_logger()