Source code for armpicom.core.service.isubprocessor

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

'''
Module
    isubprocessor.py
Copyright
    Copyright (C) 2026 Vladimir Roncevic <elektron.ronca@gmail.com>
    armpicom 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.
    armpicom 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 the abstract interface for sub-process execution.
    Provides an interface for the sub-process factory.
'''

from __future__ import annotations

from typing import Protocol, runtime_checkable

__author__ = 'Vladimir Roncevic'
__copyright__ = '(C) 2026, https://vroncevic.github.io/armpicom'
__credits__ = ['Vladimir Roncevic', 'Python Software Foundation']
__license__ = 'https://github.com/vroncevic/armpicom/blob/dev/LICENSE'
__version__ = '2.0.3'
__maintainer__ = 'Vladimir Roncevic'
__email__ = 'elektron.ronca@gmail.com'
__status__ = 'Updated'




@runtime_checkable
class ISubProcessor[SubProcessorParamsType, SubProcessorResultType](Protocol):
    '''
        Defines the abstract interface for sub-process execution.
        Provides an interface for the sub-process factory.

        It defines:

            :methods:
                | run - Runs a sub-process.
                | is_initialized - Checks if the subprocessor is initialized.
    '''



    def run(self,  *, params: SubProcessorParamsType) -> SubProcessorResultType:
        '''
            Runs a sub-process.

            :param params: The parameters for the sub-process execution.
            :return: The result of the execution.
        '''




    def is_initialized(self) -> bool:
        '''
            Checks if the subprocessor is initialized.

            :return: True if the subprocessor is initialized, False otherwise.
        '''