Skip to content

log

Functions:

Name Description
config_logger

Configure global logger add handlers and set formatters.

config_logger

config_logger(
    logger: Logger, verbose: bool = False
) -> None

Configure global logger add handlers and set formatters.

Parameters:

Name Type Description Default

logger

Logger

Logger instance

required

verbose

bool

Turn on/off verbose mode

False
Source code in src/dcspy/log.py
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
def config_logger(logger: Logger, verbose: bool = False) -> None:
    """
    Configure global logger add handlers and set formatters.

    :param logger: Logger instance
    :param verbose: Turn on/off verbose mode
    """
    logger.setLevel(DEBUG)
    file_hand = RotatingFileHandler(filename=Path(gettempdir()) / 'dcspy.log', mode='a', encoding='utf-8', maxBytes=5 * 1024 * 1024, backupCount=1)
    file_hand.setFormatter(Formatter(fmt=LOG_FULL_FMT))
    file_hand.setLevel(INFO)
    stream_hand = StreamHandler()
    stream_hand.setLevel(INFO)
    if verbose:
        file_hand.setLevel(DEBUG)
        stream_hand.setLevel(DEBUG)
    stream_hand.setFormatter(Formatter(fmt=LOG_SHORT_FMT))
    logger.addHandler(stream_hand)
    logger.addHandler(file_hand)
    header = '#' * 60
    logger.debug(f'\n{header}\nStart session: {datetime.now()}\n{header}')
    logger.info(f'Log file store at: {file_hand.baseFilename}')