logger

oxytcmri.infrastructure.logger

Logging configuration module for the package.

Functions:

Name	Description
setup_logging	Set up logging configuration for the package.

setup_logging(log_level='INFO', save_to_file=True, log_to_console=False)

Set up logging configuration for the package.

Parameters:

Name	Type	Description	Default
log_level	str	The logging level.	'INFO'
save_to_file	bool	Whether to save logs to a file.	True
log_to_console	bool	Whether to log to console.	False

Source code in oxytcmri/infrastructure/logger.py

def setup_logging(log_level="INFO", save_to_file=True, log_to_console=False):
    """
    Set up logging configuration for the package.

    Parameters
    ----------
    log_level : str
        The logging level.
    save_to_file : bool
        Whether to save logs to a file.
    log_to_console : bool
        Whether to log to console.
    """
    log_handlers = []
    if log_to_console:
        log_handlers.append(logging.StreamHandler(sys.stdout))

    if save_to_file:
        logs_folder = Path(__file__).parents[2] / "logs"
        if not logs_folder.exists():
            raise FileNotFoundError(f"Logs folder not found: '{logs_folder}'.")
        log_file = logs_folder / f"{datetime.now().strftime('%Y-%m-%d_%H-%M-%S')}_oxytcmri.log"
        log_handlers.append(logging.FileHandler(log_file))

    logging.basicConfig(
        level=log_level,
        format="%(asctime)s [%(levelname)s] %(name)s: %(message)s",
        handlers=log_handlers
    )