utils.py

import logging
import operator
import datetime
from typing_extensions import Literal

logLevelType = Literal["info", "warn", "error"]
operators = {"Sum": operator.add,
             "Product": operator.mul, "WeightedSum": operator.add}


def logger(message: str, logLevel: logLevelType = "info", noConsolePrint: bool = False):
    """
    Generates logs for the system in both command line and logger file

    Parameters
    ----------
    message: str
        A message to be shown in both logger file and command line
        example: "My Sample Message"
    logLevel: Literal, optional (default to "info)
        The level of logs. Possible values are "info", "warn", and "error"
        example: "warn"
    noConsolePrint: bool, optional (default to False)
        If True, the log will only be printed in the logger file
        example: True
    """
    # Create a console log by default
    if (not noConsolePrint):
        print(message)
    # Create a log in the log file
    currentMoment = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
    printMessage = f'[{currentMoment}] {message}'
    if (logLevel is 'warn'):
        logging.warn(printMessage)
    elif (logLevel is 'error'):
        logging.error(printMessage)
    else:
        logging.info(printMessage)


def textToOperator(operator: str, operands: list, weights: list | None = None):
    """
    Converts a pre-defined text into operator
    Parameters
    ----------
    operator: str
        A message to be shown in both logger file and command line
        example: "Sum"
    """
    if operator != 'WeightedSum':
        weights = [1] * len(operands)
    else:
        if weights is None:
            raise ValueError("Weights missing")

    # Final result initialized by effect-less value
    result = 1 if operator == 'Product' else 0
    for weight, operand in zip(weights, operands):
        result = operators[operator](result, weight * operand)
    return result