ats_utilities.generator.igenerator module

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.

class ats_utilities.generator.igenerator.IGenerator[source]

Bases: 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.
_abc_impl = <_abc._abc_data object>
abstractmethod generate(generator_bundle: GeneratorBundle) → bool[source]

Generates project modules/files from a .tgz archive.

Parameters:

generator_bundle (<GeneratorBundle>) – Generator bundle containing template generation parameters.

Returns:

True if generation was successful, False otherwise.

Return type:

<bool>

Exceptions:

None.

abstractmethod is_initialized() → bool[source]

Checks if generator component is initialized.

Returns:

True (success) | False (fail).

Return type:

<bool>

Exceptions:

None.

abstractmethod prepare_template_values(template_values: dict[str, str]) → dict[str, str][source]

Prepares template values.

Parameters:

template_values (<dict[str, str]>) – Input replacement values.

Returns:

The updated template values dictionary.

Return type:

<dict[str, str]>

Exceptions:

None.