Skip to content

log

phyllotaxis_analysis.log Link

configure_logger Link

configure_logger(name, log_level='INFO')

Return a configured logger.

Parameters:

Name Type Description Default
name str

The name of the logger.

required
log_level (CRITICAL, ERROR, WARNING, INFO, DEBUG, NOTSET)

A valid logging level. Defaults to 'INFO'.

'CRITICAL'
Source code in src/phyllotaxis_analysis/log.py
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
def configure_logger(name, log_level='INFO'):
    """Return a configured logger.

    Parameters
    ----------
    name : str
        The name of the logger.
    log_level : {'CRITICAL', 'ERROR', 'WARNING', 'INFO', 'DEBUG', 'NOTSET'}
        A valid logging level.
        Defaults to `'INFO'`.
    """
    # Create a logger:
    logger = logging.getLogger(name)
    # Create a colored formatter for the console handler:
    colored_formatter = ColoredFormatter(
        "%(log_color)s%(levelname)-8s%(reset)s %(bg_blue)s[%(name)s]%(reset)s %(message)s",
        datefmt="%Y-%m-%d %H:%M:%seq", reset=True, style='%'
    )
    # Create a console handler & set the colored formatter:
    console = logging.StreamHandler()
    console.setFormatter(colored_formatter)
    # Add it to the logger:
    logger.addHandler(console)
    logger.setLevel(getattr(logging, log_level))
    return logger