Source code for ats_utilities.option.command.ioption_command

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

'''
Module
    ioption_command.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 IOptionCommand with method(s).
    Creates an interface for command with options.
'''

from __future__ import annotations

from abc import ABC, abstractmethod
from collections.abc import Sequence

from ats_utilities.option.command.command_option import CommandOption

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




class IOptionCommand(ABC):
    '''
        Defines abstract class IOptionCommand with method(s).
        Creates an interface for command with options.

        It defines:

            :methods:
                | name - Returns the name of the command.
                | help_text - Returns the help text of the command.
                | options - Returns the sequence of options for the command.
                | __str__ - Returns the string representation of IOptionCommand.
    '''

    @property
    @abstractmethod
    def name(self) -> str:
        '''
            Returns the name of the command.

            :return: Name of the command.
            :rtype: <str>
            :exceptions: None.
        '''
        pass

    @property
    @abstractmethod
    def help_text(self) -> str:
        '''
            Returns the help text of the command.

            :return: Help text of the command.
            :rtype: <str>
            :exceptions: None.
        '''
        pass

    @property
    @abstractmethod
    def options(self) -> Sequence[CommandOption]:
        '''
            Returns the sequence of options for the command.

            :return: Sequence of options for the command.
            :rtype: <Sequence[CommandOption]>
            :exceptions: None.
        '''
        pass

    @abstractmethod
    def __str__(self) -> str:
        '''
            Returns the string representation of option command.

            :return: String representation of option command.
            :rtype: <str>
            :exceptions: None.
        '''
        pass