Source code for armpicom.infrastructure.command.icommand_executor

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

'''
Module
    icommand_executor.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 abstract ICommandExecutor strategy interface.
'''

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'



[docs]
@runtime_checkable
class ICommandExecutor[DefinitionType, ParametersType, ReturnType, ServiceType](Protocol):
    '''
        Abstract ICommandExecutor strategy interface.

        It defines:

            :methods:
                | execute - Executes the command strategy.
                | get_definition - Returns the command definition metadata.
    '''


[docs]
    def execute(self, *, params: ParametersType, service: ServiceType) -> ReturnType:
        '''
            Executes this command strategy.

            :param params: The command parameters parsed from CLI.
            :param service: The service instance.
            :return: The execution result.
        '''



[docs]
    def get_definition(self) -> DefinitionType:
        '''
            Returns the command definition metadata.

            :return: The command definition metadata.
        '''