argenta 0.5.0b0__py3-none-any.whl → 1.0.0__py3-none-any.whl

argenta/app/registered_routers/entity.py

@@ -1,21 +1,34 @@
+from typing import Iterator
+
 from argenta.router import Router
 
 
 class RegisteredRouters:
     def __init__(self, registered_routers: list[Router] = None) -> None:
+        """
+        Private. Combines registered routers
+        :param registered_routers: list of the registered routers
+        :return: None
+        """
         self._registered_routers = registered_routers if registered_routers else []
 
     def get_registered_routers(self) -> list[Router]:
+        """
+        Private. Returns the registered routers
+        :return: registered routers as list[Router]
+        """
         return self._registered_routers
 
-    def add_registered_router(self, router: Router):
+    def add_registered_router(self, router: Router) -> None:
+        """
+        Private. Adds a new registered router
+        :param router: registered router
+        :return: None
+        """
         self._registered_routers.append(router)
 
-    def add_registered_routers(self, *routers: Router):
-        self._registered_routers.extend(routers)
-
-    def __iter__(self):
+    def __iter__(self) -> Iterator[Router]:
         return iter(self._registered_routers)
 
-    def __next__(self):
-        return next(iter(self._registered_routers))
+    def __next__(self) -> Router:
+        return next(iter(self._registered_routers))

argenta/command/__init__.py

@@ -1,3 +1,3 @@
 __all__ = ["Command"]
 
-from argenta.command.models import Command
+from argenta.command.models import Command

argenta/command/exceptions.py

@@ -1,23 +1,42 @@
-from argenta.command.flag.models import InputFlag, Flag
+from argenta.command.flag.models import Flag, InputFlag
 
 
 class BaseInputCommandException(Exception):
+    """
+    Private. Base exception class for all exceptions raised when parse input command
+    """
+
     pass
 
 
 class UnprocessedInputFlagException(BaseInputCommandException):
+    """
+    Private. Raised when an unprocessed input flag is detected
+    """
+
     def __str__(self):
         return "Unprocessed Input Flags"
 
 
 class RepeatedInputFlagsException(BaseInputCommandException):
+    """
+    Private. Raised when repeated input flags are detected
+    """
+
     def __init__(self, flag: Flag | InputFlag):
         self.flag = flag
+
     def __str__(self):
-        return ("Repeated Input Flags\n"
-                f"Duplicate flag was detected in the input: '{self.flag.get_string_entity()}'")
+        return (
+            "Repeated Input Flags\n"
+            f"Duplicate flag was detected in the input: '{self.flag.get_string_entity()}'"
+        )
 
 
 class EmptyInputCommandException(BaseInputCommandException):
+    """
+    Private. Raised when an empty input command is detected
+    """
+
     def __str__(self):
         return "Input Command is empty"

argenta/command/flag/__init__.py

@@ -1,4 +1,4 @@
-__all__ = ('InputFlags', 'InputFlag', 'Flag', 'Flags')
+__all__ = ["Flag", "InputFlag"]
 
 
-from argenta.command.flag.models import InputFlags, InputFlag, Flags, Flag
+from argenta.command.flag.models import Flag, InputFlag

argenta/command/flag/defaults.py

@@ -4,18 +4,28 @@ import re
 
 
 @dataclass
-class PredeterminedFlags:
-    HELP = Flag(name='help', possible_values=False)
-    SHORT_HELP = Flag(name='h', prefix='-', possible_values=False)
+class PredefinedFlags:
+    """
+    Public. A dataclass with predefined flags and most frequently used flags for quick use
+    """
 
-    INFO = Flag(name='info', possible_values=False)
-    SHORT_INFO = Flag(name='i', prefix='-', possible_values=False)
+    HELP = Flag(name="help", possible_values=False)
+    SHORT_HELP = Flag(name="H", prefix="-", possible_values=False)
 
-    ALL = Flag(name='all', possible_values=False)
-    SHORT_ALL = Flag(name='a', prefix='-', possible_values=False)
+    INFO = Flag(name="info", possible_values=False)
+    SHORT_INFO = Flag(name="I", prefix="-", possible_values=False)
 
-    HOST = Flag(name='host', possible_values=re.compile(r'^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$'))
-    SHORT_HOST = Flag(name='h', prefix='-', possible_values=re.compile(r'^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$'))
+    ALL = Flag(name="all", possible_values=False)
+    SHORT_ALL = Flag(name="A", prefix="-", possible_values=False)
 
-    PORT = Flag(name='port', possible_values=re.compile(r'^\d{1,5}$'))
-    SHORT_PORT = Flag(name='p', prefix='-', possible_values=re.compile(r'^\d{1,5}$'))
+    HOST = Flag(
+        name="host", possible_values=re.compile(r"^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")
+    )
+    SHORT_HOST = Flag(
+        name="H",
+        prefix="-",
+        possible_values=re.compile(r"^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$"),
+    )
+
+    PORT = Flag(name="port", possible_values=re.compile(r"^\d{1,5}$"))
+    SHORT_PORT = Flag(name="P", prefix="-", possible_values=re.compile(r"^\d{1,5}$"))

argenta/command/flag/models.py

@@ -1,48 +1,66 @@
 from typing import Literal, Pattern
-from abc import ABC, abstractmethod
 
 
 class BaseFlag:
-    def __init__(self, name: str,
-                 prefix: Literal['-', '--', '---'] = '--'):
+    def __init__(self, name: str, prefix: Literal["-", "--", "---"] = "--") -> None:
+        """
+        Private. Base class for flags
+        :param name: the name of the flag
+        :param prefix: the prefix of the flag
+        :return: None
+        """
         self._name = name
         self._prefix = prefix
 
-    def get_string_entity(self):
+    def get_string_entity(self) -> str:
+        """
+        Public. Returns a string representation of the flag
+        :return: string representation of the flag as str
+        """
         string_entity: str = self._prefix + self._name
         return string_entity
 
-    def get_name(self):
+    def get_name(self) -> str:
+        """
+        Public. Returns the name of the flag
+        :return: the name of the flag as str
+        """
         return self._name
 
-    def get_prefix(self):
+    def get_prefix(self) -> str:
+        """
+        Public. Returns the prefix of the flag
+        :return: the prefix of the flag as str
+        """
         return self._prefix
 
-
-
-class InputFlag(BaseFlag):
-    def __init__(self, name: str,
-                 prefix: Literal['-', '--', '---'] = '--',
-                 value: str = None):
-        super().__init__(name, prefix)
-        self._flag_value = value
-
-    def get_value(self) -> str | None:
-        return self._flag_value
-
-    def set_value(self, value):
-        self._flag_value = value
-
+    def __eq__(self, other) -> bool:
+        return self.get_string_entity() == other.get_string_entity()
 
 
 class Flag(BaseFlag):
-    def __init__(self, name: str,
-                 prefix: Literal['-', '--', '---'] = '--',
-                 possible_values: list[str] | Pattern[str] | False = True):
+    def __init__(
+        self,
+        name: str,
+        prefix: Literal["-", "--", "---"] = "--",
+        possible_values: list[str] | Pattern[str] | False = True,
+    ) -> None:
+        """
+        Public. The entity of the flag being registered for subsequent processing
+        :param name: The name of the flag
+        :param prefix: The prefix of the flag
+        :param possible_values: The possible values of the flag, if False then the flag cannot have a value
+        :return: None
+        """
         super().__init__(name, prefix)
         self.possible_values = possible_values
 
     def validate_input_flag_value(self, input_flag_value: str | None):
+        """
+        Private. Validates the input flag value
+        :param input_flag_value: The input flag value to validate
+        :return: whether the entered flag is valid as bool
+        """
         if self.possible_values is False:
             if input_flag_value is None:
                 return True
@@ -67,74 +85,37 @@ class Flag(BaseFlag):
             return True
 
 
+class InputFlag(BaseFlag):
+    def __init__(
+        self, name: str, prefix: Literal["-", "--", "---"] = "--", value: str = None
+    ):
+        """
+        Public. The entity of the flag of the entered command
+        :param name: the name of the input flag
+        :param prefix: the prefix of the input flag
+        :param value: the value of the input flag
+        :return: None
+        """
+        super().__init__(name, prefix)
+        self._flag_value = value
 
-class BaseFlags(ABC):
-    __slots__ = ('_flags',)
-
-    @abstractmethod
-    def get_flags(self):
-        pass
-
-    @abstractmethod
-    def add_flag(self, flag: Flag | InputFlag):
-        pass
-
-    @abstractmethod
-    def add_flags(self, flags: list[Flag] | list[InputFlag]):
-        pass
-
-    @abstractmethod
-    def get_flag(self, name: str):
-        pass
-
-    def __iter__(self):
-        return iter(self._flags)
-
-    def __next__(self):
-        return next(iter(self))
-
-    def __getitem__(self, item):
-        return self._flags[item]
-
-
-
-class Flags(BaseFlags, ABC):
-    def __init__(self, *flags: Flag):
-        self._flags = flags if flags else []
-
-    def get_flags(self) -> list[Flag]:
-        return self._flags
-
-    def add_flag(self, flag: Flag):
-        self._flags.append(flag)
-
-    def add_flags(self, flags: list[Flag]):
-        self._flags.extend(flags)
-
-    def get_flag(self, name: str) -> Flag | None:
-        if name in [flag.get_name() for flag in self._flags]:
-            return list(filter(lambda flag: flag.get_name() == name, self._flags))[0]
-        else:
-            return None
-
-
-
-class InputFlags(BaseFlags, ABC):
-    def __init__(self, *flags: InputFlag):
-        self._flags = flags if flags else []
-
-    def get_flags(self) -> list[InputFlag]:
-        return self._flags
-
-    def add_flag(self, flag: InputFlag):
-        self._flags.append(flag)
-
-    def add_flags(self, flags: list[InputFlag]):
-        self._flags.extend(flags)
+    def get_value(self) -> str | None:
+        """
+        Public. Returns the value of the flag
+        :return: the value of the flag as str
+        """
+        return self._flag_value
 
-    def get_flag(self, name: str) -> InputFlag | None:
-        if name in [flag.get_name() for flag in self._flags]:
-            return list(filter(lambda flag: flag.get_name() == name, self._flags))[0]
-        else:
-            return None
+    def set_value(self, value):
+        """
+        Private. Sets the value of the flag
+        :param value: the fag value to set
+        :return: None
+        """
+        self._flag_value = value
 
+    def __eq__(self, other) -> bool:
+        return (
+            self.get_string_entity() == other.get_string_entity()
+            and self.get_value() == other.get_value()
+        )

argenta/command/flags/__init__.py

@@ -0,0 +1,16 @@
+__all__ = [
+    "Flags",
+    "InputFlags",
+    "UndefinedInputFlags",
+    "InvalidValueInputFlags",
+    "ValidInputFlags",
+]
+
+
+from argenta.command.flags.models import (
+    Flags,
+    InputFlags,
+    UndefinedInputFlags,
+    InvalidValueInputFlags,
+    ValidInputFlags,
+)

argenta/command/flags/models.py

@@ -0,0 +1,90 @@
+from argenta.command.flag.models import InputFlag, Flag
+from typing import Generic, TypeVar
+
+
+FlagType = TypeVar("FlagType")
+
+
+class BaseFlags(Generic[FlagType]):
+    def __init__(self, *flags: FlagType):
+        """
+        Public. A model that combines the registered flags
+        :param flags: the flags that will be registered
+        :return: None
+        """
+        self._flags = flags if flags else []
+
+    def get_flags(self) -> list[FlagType]:
+        """
+        Public. Returns a list of flags
+        :return: list of flags as list[FlagType]
+        """
+        return self._flags
+
+    def add_flag(self, flag: FlagType):
+        """
+        Public. Adds a flag to the list of flags
+        :param flag: flag to add
+        :return: None
+        """
+        self._flags.append(flag)
+
+    def add_flags(self, flags: list[FlagType]):
+        """
+        Public. Adds a list of flags to the list of flags
+        :param flags: list of flags to add
+        :return: None
+        """
+        self._flags.extend(flags)
+
+    def get_flag(self, name: str) -> FlagType | None:
+        """
+        Public. Returns the flag entity by its name or None if not found
+        :param name: the name of the flag to get
+        :return: entity of the flag or None
+        """
+        if name in [flag.get_name() for flag in self._flags]:
+            return list(filter(lambda flag: flag.get_name() == name, self._flags))[0]
+        else:
+            return None
+
+    def __iter__(self):
+        return iter(self._flags)
+
+    def __next__(self):
+        return next(iter(self))
+
+    def __getitem__(self, item):
+        return self._flags[item]
+
+    def __bool__(self):
+        return bool(self._flags)
+
+    def __eq__(self, other):
+        if len(self.get_flags()) != len(other.get_flags()):
+            return False
+        else:
+            for flag, other_flag in zip(self.get_flags(), other.get_flags()):
+                if not flag == other_flag:
+                    return False
+        return True
+
+
+class Flags(BaseFlags[Flag]):
+    pass
+
+
+class InputFlags(BaseFlags[InputFlag]):
+    pass
+
+
+class ValidInputFlags(InputFlags):
+    pass
+
+
+class UndefinedInputFlags(InputFlags):
+    pass
+
+
+class InvalidValueInputFlags(InputFlags):
+    pass

argenta/command/models.py

@@ -1,73 +1,153 @@
-from argenta.command.flag.models import Flag, InputFlag, Flags, InputFlags
-from argenta.command.exceptions import (UnprocessedInputFlagException,
-                                         RepeatedInputFlagsException,
-                                         EmptyInputCommandException)
+from argenta.command.flag.models import Flag, InputFlag
+from argenta.command.flags.models import InputFlags, Flags
+from argenta.command.exceptions import (
+    UnprocessedInputFlagException,
+    RepeatedInputFlagsException,
+    EmptyInputCommandException,
+)
 from typing import Generic, TypeVar, cast, Literal
 
 
-InputCommandType = TypeVar('InputCommandType')
+InputCommandType = TypeVar("InputCommandType")
 
 
 class BaseCommand:
-    def __init__(self, trigger: str):
+    def __init__(self, trigger: str) -> None:
+        """
+        Private. Base class for all commands
+        :param trigger: A string trigger, which, when entered by the user, indicates that the input corresponds to the command
+        """
         self._trigger = trigger
 
     def get_trigger(self) -> str:
+        """
+        Public. Returns the trigger of the command
+        :return: the trigger of the command as str
+        """
         return self._trigger
 
 
 class Command(BaseCommand):
-    def __init__(self, trigger: str,
-                 description: str = None,
-                 flags: Flag | Flags = None,
-                 aliases: list[str] = None):
+    def __init__(
+        self,
+        trigger: str,
+        description: str = None,
+        flags: Flag | Flags = None,
+        aliases: list[str] = None,
+    ):
+        """
+        Public. The command that can and should be registered in the Router
+        :param trigger: A string trigger, which, when entered by the user, indicates that the input corresponds to the command
+        :param description: the description of the command
+        :param flags: processed commands
+        :param aliases: string synonyms for the main trigger
+        """
         super().__init__(trigger)
-        self._registered_flags: Flags = flags if isinstance(flags, Flags) else Flags(flags) if isinstance(flags, Flag) else Flags()
-        self._description = f'Description for "{self._trigger}" command' if not description else description
-        self._aliases = aliases
+        self._registered_flags: Flags = (
+            flags
+            if isinstance(flags, Flags)
+            else Flags(flags)
+            if isinstance(flags, Flag)
+            else Flags()
+        )
+        self._description = "Very useful command" if not description else description
+        self._aliases = aliases if isinstance(aliases, list) else []
 
     def get_registered_flags(self) -> Flags:
+        """
+        Private. Returns the registered flags
+        :return: the registered flags as Flags
+        """
         return self._registered_flags
 
-    def get_aliases(self) -> list[str] | None:
+    def get_aliases(self) -> list[str] | list:
+        """
+        Public. Returns the aliases of the command
+        :return: the aliases of the command as list[str] | list
+        """
         return self._aliases
 
-    def validate_input_flag(self, flag: InputFlag):
+    def validate_input_flag(
+        self, flag: InputFlag
+    ) -> Literal["Undefined", "Valid", "Invalid"]:
+        """
+        Private. Validates the input flag
+        :param flag: input flag for validation
+        :return: is input flag valid as bool
+        """
         registered_flags: Flags | None = self.get_registered_flags()
         if registered_flags:
             if isinstance(registered_flags, Flag):
                 if registered_flags.get_string_entity() == flag.get_string_entity():
-                    is_valid = registered_flags.validate_input_flag_value(flag.get_value())
+                    is_valid = registered_flags.validate_input_flag_value(
+                        flag.get_value()
+                    )
                     if is_valid:
-                        return True
+                        return "Valid"
+                    else:
+                        return "Invalid"
+                else:
+                    return "Undefined"
             else:
                 for registered_flag in registered_flags:
                     if registered_flag.get_string_entity() == flag.get_string_entity():
-                        is_valid = registered_flag.validate_input_flag_value(flag.get_value())
+                        is_valid = registered_flag.validate_input_flag_value(
+                            flag.get_value()
+                        )
                         if is_valid:
-                            return True
-        return False
+                            return "Valid"
+                        else:
+                            return "Invalid"
+                return "Undefined"
+        return "Undefined"
 
     def get_description(self) -> str:
+        """
+        Private. Returns the description of the command
+        :return: the description of the command as str
+        """
         return self._description
 
 
-
 class InputCommand(BaseCommand, Generic[InputCommandType]):
-    def __init__(self, trigger: str,
-                 input_flags: InputFlag | InputFlags = None):
+    def __init__(self, trigger: str, input_flags: InputFlag | InputFlags = None):
+        """
+        Private. The model of the input command, after parsing
+        :param trigger:the trigger of the command
+        :param input_flags: the input flags
+        :return: None
+        """
         super().__init__(trigger)
-        self._input_flags: InputFlags = input_flags if isinstance(input_flags, InputFlags) else InputFlags(input_flags) if isinstance(input_flags, InputFlag) else InputFlags()
-
-    def _set_input_flags(self, input_flags: InputFlags):
+        self._input_flags: InputFlags = (
+            input_flags
+            if isinstance(input_flags, InputFlags)
+            else InputFlags(input_flags)
+            if isinstance(input_flags, InputFlag)
+            else InputFlags()
+        )
+
+    def _set_input_flags(self, input_flags: InputFlags) -> None:
+        """
+        Private. Sets the input flags
+        :param input_flags: the input flags to set
+        :return: None
+        """
         self._input_flags = input_flags
 
     def get_input_flags(self) -> InputFlags:
+        """
+        Private. Returns the input flags
+        :return: the input flags as InputFlags
+        """
         return self._input_flags
 
-
     @staticmethod
     def parse(raw_command: str) -> InputCommandType:
+        """
+        Private. Parse the raw input command
+        :param raw_command: raw input command
+        :return: model of the input command, after parsing as InputCommand
+        """
         if not raw_command:
             raise EmptyInputCommandException()
 
@@ -78,26 +158,32 @@ class InputCommand(BaseCommand, Generic[InputCommandType]):
         current_flag_name, current_flag_value = None, None
 
         for k, _ in enumerate(list_of_tokens):
-            if _.startswith('-'):
-                if current_flag_name or len(_) < 2 or len(_[:_.rfind('-')]) > 3:
+            if _.startswith("-"):
+                if len(_) < 2 or len(_[: _.rfind("-")]) > 3:
                     raise UnprocessedInputFlagException()
                 current_flag_name = _
             else:
-                if not current_flag_name:
+                if not current_flag_name or current_flag_value:
                     raise UnprocessedInputFlagException()
                 current_flag_value = _
 
             if current_flag_name:
-                if not len(list_of_tokens) == k+1:
-                    if not list_of_tokens[k+1].startswith('-'):
+                if not len(list_of_tokens) == k + 1:
+                    if not list_of_tokens[k + 1].startswith("-"):
                         continue
 
-                input_flag = InputFlag(name=current_flag_name[current_flag_name.rfind('-')+1:],
-                                       prefix=cast(Literal['-', '--', '---'],
-                                                   current_flag_name[:current_flag_name.rfind('-')+1]),
-                                       value=current_flag_value)
-
-                all_flags = [flag.get_string_entity() for flag in input_flags.get_flags()]
+                input_flag = InputFlag(
+                    name=current_flag_name[current_flag_name.rfind("-") + 1 :],
+                    prefix=cast(
+                        Literal["-", "--", "---"],
+                        current_flag_name[: current_flag_name.rfind("-") + 1],
+                    ),
+                    value=current_flag_value,
+                )
+
+                all_flags = [
+                    flag.get_string_entity() for flag in input_flags.get_flags()
+                ]
                 if input_flag.get_string_entity() not in all_flags:
                     input_flags.add_flag(input_flag)
                 else:
@@ -109,4 +195,3 @@ class InputCommand(BaseCommand, Generic[InputCommandType]):
             raise UnprocessedInputFlagException()
         else:
             return InputCommand(trigger=command, input_flags=input_flags)
-

argenta/orchestrator/__init__.py

@@ -0,0 +1,4 @@
+__all__ = ["Orchestrator"]
+
+
+from argenta.orchestrator.entity import Orchestrator