Source code for ats_utilities.splasher.iext_infrastructure

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

'''
Module
    iext_infrastructure.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 IExtInfrastructure with method(s).
    Interface for processing hyperlinks for splash screen.
'''

from abc import ABC, abstractmethod
from typing import Any

__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 IExtInfrastructure(ABC):
    '''
        Defines abstract class IExtInfrastructure with method(s).
        Interface for processing hyperlinks for splash screen.

        It defines:

            :attributes: None.
            :methods:
                | infrastructure_property - Property methods for set/get operations.
                | get_info_text - Pre-processes info text for splash screen.
                | get_issue_text - Pre-processes issue text for splash screen.
                | get_author_text - Pre-processes author text for splash screen.
                | __str__ - Returns the external infrastructure as string representation.
    '''

    @property
    @abstractmethod
    def infrastructure_property(self) -> dict[Any, Any] | None:
        '''
            Property method for getting infrastructure property.

            :return: Formatted infrastructure property in dict format | None.
            :rtype: <dict[Any, Any] | None>
            :exceptions: NotImplementedError.
        '''
        raise NotImplementedError("Method infrastructure_property() must be implemented.")

    @infrastructure_property.setter
    @abstractmethod
    def infrastructure_property(self, infrastructure_property_setup: dict[Any, Any] | None) -> None:
        '''
            Property method for setting project infrastructure property.

            :param infrastructure_property_setup: Project infrastructure property in dict format | None.
            :type infrastructure_property_setup: <dict[Any, Any] | None>
            :exceptions: NotImplementedError.
        '''
        raise NotImplementedError("Method infrastructure_property() must be implemented.")



    @abstractmethod
    def get_info_text(self) -> str:
        '''
            Pre-processes info text for splash screen.

            :return: Hyperlink with info text.
            :rtype: <str>
            :exceptions: NotImplementedError.
        '''
        raise NotImplementedError("Method get_info_text() must be implemented.")




    @abstractmethod
    def get_issue_text(self) -> str:
        '''
            Pre-processes issue text for splash screen.

            :return: Hyperlink with issue info.
            :rtype: <str>
            :exceptions: NotImplementedError.
        '''
        raise NotImplementedError("Method get_issue_text() must be implemented.")




    @abstractmethod
    def get_author_text(self) -> str:
        '''
            Pre-processes author text for splash screen.

            :return: Hyperlink with author info.
            :rtype: <str>
            :exceptions: NotImplementedError.
        '''
        raise NotImplementedError("Method get_author_text() must be implemented.")


    @abstractmethod
    def __str__(self) -> str:
        '''
            Returns the external infrastructure as string representation.

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