Source code for ats_utilities.logging.ilogger_manager

# -*- coding: UTF-8 -*-

'''
Module
    ilogger_manager.py
Copyright
    Copyright (C) 2017 - 2026 Vladimir Roncevic <elektron.ronca@gmail.com>
    ats_utilities is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by the
    Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
    ats_utilities is distributed in the hope that it will be useful, but
    WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
    See the GNU General Public License for more details.
    You should have received a copy of the GNU General Public License along
    with this program. If not, see <http://www.gnu.org/licenses/>.
Info
    Defines abstract class ILoggerManager with method(s).
    Interface for the ATS logging manager mechanism.
'''

from abc import ABC, abstractmethod
from ats_utilities.logging.ilogger import ILogger

__author__: str = 'Vladimir Roncevic'
__copyright__: str = '(C) 2026, https://vroncevic.github.io/ats_utilities'
__credits__: list[str] = ['Vladimir Roncevic', 'Python Software Foundation']
__license__: str = 'https://github.com/vroncevic/ats_utilities/blob/dev/LICENSE'
__version__: str = '3.3.8'
__maintainer__: str = 'Vladimir Roncevic'
__email__: str = 'elektron.ronca@gmail.com'
__status__: str = 'Updated'




class ILoggerManager(ABC):
    '''
        Defines abstract class ILoggerManager with method(s).
        Interface for the ATS logging manager mechanism.

        It defines:

            :attributes: None
            :methods:
                | get_logger - Gets logger instance.
                | write_log - Writes message to log output.
                | ok - Checks if logger manager component is ok.
                | __str__ - Returns the ATS logger manager as string representation.
    '''



    @abstractmethod
    def get_logger(self) -> ILogger:
        '''
            Gets logger instance.

            :return: Logger instance
            :rtype: <ILogger>
            :exceptions: NotImplementedError.
        '''
        raise NotImplementedError("Method get_logger() must be implemented.")




    @abstractmethod
    def write_log(self, message: str | None, ctrl: int) -> bool:
        '''
            Writes message to log output.

            :param message: Log message in string format for log output | None
            :type message: <str | None>
            :param ctrl: Control flag (debug, warning, critical, errors, info)
            :type ctrl: <int>
            :return: True (success) | False (fail)
            :rtype: <bool>
            :exceptions: NotImplementedError.
        '''
        raise NotImplementedError("Method write_log() must be implemented.")




    @abstractmethod
    def is_initialized(self) -> bool:
        '''
            Checks if logger component is ok.

            :return: True (success) | False (fail)
            :rtype: <bool>
            :exceptions: NotImplementedError.
        '''
        raise NotImplementedError("Method ok() must be implemented.")


    @abstractmethod
    def __str__(self) -> str:
        '''
            Returns the ATS logger manager as string representation.

            :return: The ATS logger manager as string representation.
            :rtype: <str>
            :exceptions: NotImplementedError.
        '''
        raise NotImplementedError("Method __str__() must be implemented.")