Class MarvinLog

tools/marvin/marvin/marvinLog.py:31–192

@Name : MarvinLog @Desc : provides interface for logging to marvin @Input : logger_name : name for logger

class MarvinLog:

    '''
    @Name  : MarvinLog
    @Desc  : provides interface for logging to marvin
    @Input : logger_name : name for logger
    '''
    logFormat = logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")
    _instance = None

    def __new__(cls, logger_name):
        if not cls._instance:
            cls._instance = super(MarvinLog, cls).__new__(cls)
            return cls._instance

    def __init__(self, logger_name):
        '''
        @Name: __init__
        @Input: logger_name for logger
        '''
        self.__loggerName = logger_name
        '''
        Logger for Logging Info
        '''
        self.__logger = None
        '''
        Log Folder Directory
        '''
        self.__logFolderDir = None
        self.__setLogger()

    def __setLogger(self):
        '''
        @Name : __setLogger
        @Desc : Sets the Logger and Level
        '''
        self.__logger = logging.getLogger(self.__loggerName)
        self.__logger.setLevel(logging.DEBUG)

    def __setLogHandler(self, log_file_path,
                        log_format=None,
                        log_level=logging.DEBUG):
        '''
        @Name : __setLogHandler
        @Desc: Adds the given Log handler to the current logger
        @Input: log_file_path: Log File Path as where to store the logs
               log_format : Format of log messages to be dumped
               log_level : Determines the level of logging for this logger
        @Output: SUCCESS if no issues else FAILED
        '''
        try:
            if log_file_path is not None:
                stream = logging.FileHandler(log_file_path)
            else:
                stream = logging.StreamHandler(stream=sys.stdout)

            if log_format is not None:
                stream.setFormatter(log_format)