ats_utilities.generator.itar_processor module

Module

itar_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 ITarProcessor with method(s). Interface for tar archive extraction and template rendering.

class ats_utilities.generator.itar_processor.ITarProcessor

Bases: ABC

Defines abstract class ITarProcessor with method(s). Interface for tar archive extraction and template rendering.

It defines:

attributes:

None.

methods:

process_tar_member - Processes a single tar archive member.

process - Processes the tar archive members.

is_initialized - Checks if the processor is initialized.

__str__ - Returns the processor 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 process(tar_process_bundle: TarProcessBundle) → None

Processes the tar archive members.

Parameters:

tar_process_bundle (<TarProcessBundle>) – Parameters defining what to do with the tar archive.

Exceptions:

None.

abstractmethod process_tar_member(tar_process_member_bundle: TarProcessMemberBundle) → None

Extracts and processes a single tar member (creates dirs or renders files).

Parameters:

tar_process_member_bundle (<TarProcessMemberBundle>) – Parameters defining what to do with the tar archive member.

Exceptions:

None.