Source code for ats_utilities.generator.igenerator

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

'''
Module
    igenerator.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 IGenerator with method(s).
    Creates an interface for template-based file generation from .tgz archives.
'''

from abc import ABC, abstractmethod
from typing import Any
from ats_utilities.generator.generator_bundle import GeneratorBundle

__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.4.0'
__maintainer__: str = 'Vladimir Roncevic'
__email__: str = 'elektron.ronca@gmail.com'
__status__: str = 'Updated'




class IGenerator(ABC):
    '''
        Defines abstract class IGenerator with method(s).
        Creates an interface for template-based file generation from .tgz archives.

        It defines:

            :attributes: None.
            :methods:
                | prepare_template_values - Prepares template values.
                | generate - Generates project modules/files from a .tgz archive.
                | is_initialized - Checks if the generator component is initialized.
                | __str__ - Returns the generator as string representation.
    '''



    @abstractmethod
    def prepare_template_values(self, template_values: dict[str, str]) -> dict[str, str]:
        '''
            Prepares template values.

            :param template_values: Input replacement values.
            :type template_values: <dict[str, str]>
            :return: The updated template values dictionary.
            :rtype: <dict[str, str]>
            :exceptions: None.
        '''
        pass




    @abstractmethod
    def generate(self, generator_bundle: GeneratorBundle) -> bool:
        '''
            Generates project modules/files from a .tgz archive.

            :param generator_bundle: Generator bundle containing template generation parameters.
            :type generator_bundle: <GeneratorBundle>
            :return: True if generation was successful, False otherwise.
            :rtype: <bool>
            :exceptions: None.
        '''
        pass




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

            :return: True (success) | False (fail).
            :rtype: <bool>
            :exceptions: None.
        '''
        pass


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

            :return: The generator as string representation.
            :rtype: <str>
            :exceptions: None.
        '''
        pass