ats_utilities.generator.itemplate_processor module

Module

itemplate_processor.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 ITemplateProcessor with method(s). Interface for rendering template placeholders.

class ats_utilities.generator.itemplate_processor.ITemplateProcessor

Bases: ABC

Defines abstract class ITemplateProcessor with method(s). Interface for rendering template placeholders.

It defines:

attributes:

None.

methods:

render - Decodes and renders template placeholders.

is_initialized - Checks if component is initialized.

__str__ - Returns the component as string representation.

_abc_impl = <_abc._abc_data object>

abstractmethod is_initialized() → bool

Checks if component is initialized.

Returns:

True (success) | False (fail).

Return type:

<bool>

Exceptions:

None.

abstractmethod render(raw_content: bytes, vals: dict[str, str]) → str | bytes

Decodes and renders template placeholders.

Parameters:

• raw_content (<bytes>) – The raw byte content of the file.

• vals (<dict[str, str]>) – String replacement values.

Returns:

Rendered text content string, or raw bytes if binary format.

Return type:

<str | bytes>

Exceptions:

None.