argenta 1.0.0b1__py3-none-any.whl → 1.0.1__py3-none-any.whl

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

@@ -5,6 +5,7 @@ class BaseInputCommandException(Exception):
     """
     Private. Base exception class for all exceptions raised when parse input command
     """
+
     pass
 
 
@@ -12,6 +13,7 @@ class UnprocessedInputFlagException(BaseInputCommandException):
     """
     Private. Raised when an unprocessed input flag is detected
     """
+
     def __str__(self):
         return "Unprocessed Input Flags"
 
@@ -20,16 +22,21 @@ 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/defaults.py

@@ -8,17 +8,24 @@ class PredefinedFlags:
     """
     Public. A dataclass with predefined flags and most frequently used flags for quick use
     """
-    HELP = Flag(name='help', possible_values=False)
-    SHORT_HELP = Flag(name='H', prefix='-', possible_values=False)
 
-    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,10 +1,8 @@
 from typing import Literal, Pattern
 
 
-
 class BaseFlag:
-    def __init__(self, name: str,
-                 prefix: Literal['-', '--', '---'] = '--') -> None:
+    def __init__(self, name: str, prefix: Literal["-", "--", "---"] = "--") -> None:
         """
         Private. Base class for flags
         :param name: the name of the flag
@@ -36,11 +34,17 @@ class BaseFlag:
         """
         return self._prefix
 
+    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) -> None:
+    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
@@ -82,9 +86,9 @@ class Flag(BaseFlag):
 
 
 class InputFlag(BaseFlag):
-    def __init__(self, name: str,
-                 prefix: Literal['-', '--', '---'] = '--',
-                 value: str = None):
+    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
@@ -110,3 +114,8 @@ class InputFlag(BaseFlag):
         """
         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

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

argenta/command/flags/models.py

@@ -2,8 +2,7 @@ from argenta.command.flag.models import InputFlag, Flag
 from typing import Generic, TypeVar
 
 
-
-FlagType = TypeVar('FlagType')
+FlagType = TypeVar("FlagType")
 
 
 class BaseFlags(Generic[FlagType]):
@@ -58,18 +57,34 @@ class BaseFlags(Generic[FlagType]):
     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 Flags(BaseFlags[Flag]):
+    pass
 
-class InputFlags(BaseFlags[InputFlag]): pass
 
+class InputFlags(BaseFlags[InputFlag]):
+    pass
 
-class ValidInputFlags(InputFlags): pass
 
+class ValidInputFlags(InputFlags):
+    pass
 
-class UndefinedInputFlags(InputFlags): pass
 
+class UndefinedInputFlags(InputFlags):
+    pass
 
-class InvalidValueInputFlags(InputFlags): pass
 
+class InvalidValueInputFlags(InputFlags):
+    pass

argenta/command/models.py

@@ -1,12 +1,14 @@
 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 argenta.command.exceptions import (
+    UnprocessedInputFlagException,
+    RepeatedInputFlagsException,
+    EmptyInputCommandException,
+)
 from typing import Generic, TypeVar, cast, Literal
 
 
-InputCommandType = TypeVar('InputCommandType')
+InputCommandType = TypeVar("InputCommandType")
 
 
 class BaseCommand:
@@ -26,10 +28,13 @@ class BaseCommand:
 
 
 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
@@ -38,8 +43,14 @@ class Command(BaseCommand):
         :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._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:
@@ -56,7 +67,9 @@ class Command(BaseCommand):
         """
         return self._aliases
 
-    def validate_input_flag(self, flag: InputFlag) -> Literal['Undefined', 'Valid', 'Invalid']:
+    def validate_input_flag(
+        self, flag: InputFlag
+    ) -> Literal["Undefined", "Valid", "Invalid"]:
         """
         Private. Validates the input flag
         :param flag: input flag for validation
@@ -66,23 +79,27 @@ class Command(BaseCommand):
         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 'Valid'
+                        return "Valid"
                     else:
-                        return 'Invalid'
+                        return "Invalid"
                 else:
-                    return 'Undefined'
+                    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 'Valid'
+                            return "Valid"
                         else:
-                            return 'Invalid'
-                return 'Undefined'
-        return 'Undefined'
+                            return "Invalid"
+                return "Undefined"
+        return "Undefined"
 
     def get_description(self) -> str:
         """
@@ -92,10 +109,8 @@ class Command(BaseCommand):
         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
@@ -103,7 +118,13 @@ class InputCommand(BaseCommand, Generic[InputCommandType]):
         :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()
+        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:
         """
@@ -120,7 +141,6 @@ class InputCommand(BaseCommand, Generic[InputCommandType]):
         """
         return self._input_flags
 
-
     @staticmethod
     def parse(raw_command: str) -> InputCommandType:
         """
@@ -138,8 +158,8 @@ class InputCommand(BaseCommand, Generic[InputCommandType]):
         current_flag_name, current_flag_value = None, None
 
         for k, _ in enumerate(list_of_tokens):
-            if _.startswith('-'):
-                if len(_) < 2 or len(_[:_.rfind('-')]) > 3:
+            if _.startswith("-"):
+                if len(_) < 2 or len(_[: _.rfind("-")]) > 3:
                     raise UnprocessedInputFlagException()
                 current_flag_name = _
             else:
@@ -148,16 +168,22 @@ class InputCommand(BaseCommand, Generic[InputCommandType]):
                 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:
@@ -169,4 +195,3 @@ class InputCommand(BaseCommand, Generic[InputCommandType]):
             raise UnprocessedInputFlagException()
         else:
             return InputCommand(trigger=command, input_flags=input_flags)
-

argenta/orchestrator/argparser/__init__.py

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

argenta/orchestrator/argparser/arguments/__init__.py

@@ -1,6 +1,8 @@
 __all__ = ["BooleanArgument", "PositionalArgument", "OptionalArgument"]
 
 
-from argenta.orchestrator.argparser.arguments.models import (BooleanArgument,
-                                                             PositionalArgument,
-                                                             OptionalArgument)
+from argenta.orchestrator.argparser.arguments.models import (
+    BooleanArgument,
+    PositionalArgument,
+    OptionalArgument,
+)

argenta/orchestrator/argparser/arguments/models.py

@@ -6,6 +6,7 @@ class BaseArgument(ABC):
     """
     Private. Base class for all arguments
     """
+
     @abstractmethod
     def get_string_entity(self) -> str:
         """
@@ -28,7 +29,7 @@ class PositionalArgument(BaseArgument):
 
 
 class OptionalArgument(BaseArgument):
-    def __init__(self, name: str, prefix: Literal['-', '--', '---'] = '--'):
+    def __init__(self, name: str, prefix: Literal["-", "--", "---"] = "--"):
         """
         Public. Optional argument, must have the value
         :param name: name of the argument
@@ -42,7 +43,7 @@ class OptionalArgument(BaseArgument):
 
 
 class BooleanArgument(BaseArgument):
-    def __init__(self, name: str, prefix: Literal['-', '--', '---'] = '--'):
+    def __init__(self, name: str, prefix: Literal["-", "--", "---"] = "--"):
         """
         Public. Boolean argument, does not require a value
         :param name: name of the argument

argenta/orchestrator/argparser/entity.py

@@ -1,16 +1,20 @@
 from argparse import ArgumentParser
 
-from argenta.orchestrator.argparser.arguments.models import (BooleanArgument,
-                                                             OptionalArgument,
-                                                             PositionalArgument)
+from argenta.orchestrator.argparser.arguments.models import (
+    BooleanArgument,
+    OptionalArgument,
+    PositionalArgument,
+)
 
 
 class ArgParser:
-    def __init__(self,
-                 processed_args: list[PositionalArgument | OptionalArgument | BooleanArgument],
-                 name: str = 'Argenta',
-                 description: str = 'Argenta available arguments',
-                 epilog: str = 'github.com/koloideal/Argenta | made by kolo') -> None:
+    def __init__(
+        self,
+        processed_args: list[PositionalArgument | OptionalArgument | BooleanArgument],
+        name: str = "Argenta",
+        description: str = "Argenta available arguments",
+        epilog: str = "github.com/koloideal/Argenta | made by kolo",
+    ) -> None:
         """
         Public. Cmd argument parser and configurator at startup
         :param name: the name of the ArgParse instance
@@ -22,10 +26,16 @@ class ArgParser:
         self.description = description
         self.epilog = epilog
 
-        self.entity: ArgumentParser = ArgumentParser(prog=name, description=description, epilog=epilog)
-        self.args: list[PositionalArgument | OptionalArgument | BooleanArgument] | None = processed_args
+        self.entity: ArgumentParser = ArgumentParser(
+            prog=name, description=description, epilog=epilog
+        )
+        self.args: (
+            list[PositionalArgument | OptionalArgument | BooleanArgument] | None
+        ) = processed_args
 
-    def set_args(self, *args: PositionalArgument | OptionalArgument | BooleanArgument) -> None:
+    def set_args(
+        self, *args: PositionalArgument | OptionalArgument | BooleanArgument
+    ) -> None:
         """
         Public. Sets the arguments to be processed
         :param args: processed arguments
@@ -46,4 +56,4 @@ class ArgParser:
             elif type(arg) is OptionalArgument:
                 self.entity.add_argument(arg.get_string_entity())
             elif type(arg) is BooleanArgument:
-                self.entity.add_argument(arg.get_string_entity(), action='store_true')
+                self.entity.add_argument(arg.get_string_entity(), action="store_true")

argenta/orchestrator/entity.py

@@ -33,4 +33,3 @@ class Orchestrator:
             return self.arg_parser.entity.parse_args()
         else:
             return None
-        

argenta/response/entity.py

@@ -1,12 +1,21 @@
-from argenta.command.flags.models import ValidInputFlags, UndefinedInputFlags, InvalidValueInputFlags
 from argenta.response.status import Status
+from argenta.command.flags import (
+    ValidInputFlags,
+    UndefinedInputFlags,
+    InvalidValueInputFlags,
+)
 
 
 class Response:
-    def __init__(self, status: Status = None,
-                 valid_flags: ValidInputFlags = ValidInputFlags(),
-                 undefined_flags: UndefinedInputFlags = UndefinedInputFlags(),
-                 invalid_value_flags: InvalidValueInputFlags = InvalidValueInputFlags()):
+    __slots__ = ("status", "valid_flags", "undefined_flags", "invalid_value_flags")
+
+    def __init__(
+        self,
+        status: Status = None,
+        valid_flags: ValidInputFlags = ValidInputFlags(),
+        undefined_flags: UndefinedInputFlags = UndefinedInputFlags(),
+        invalid_value_flags: InvalidValueInputFlags = InvalidValueInputFlags(),
+    ):
         """
         Public. The entity of the user input sent to the handler
         :param status: the status of the response

argenta/response/status.py

@@ -2,8 +2,7 @@ from enum import Enum
 
 
 class Status(Enum):
-    ALL_FLAGS_VALID = 'ALL_FLAGS_VALID'
-    UNDEFINED_FLAGS = 'UNDEFINED_FLAGS'
-    INVALID_VALUE_FLAGS = 'INVALID_VALUE_FLAGS'
-    UNDEFINED_AND_INVALID_FLAGS = 'UNDEFINED_AND_INVALID_FLAGS'
-
+    ALL_FLAGS_VALID = "ALL_FLAGS_VALID"
+    UNDEFINED_FLAGS = "UNDEFINED_FLAGS"
+    INVALID_VALUE_FLAGS = "INVALID_VALUE_FLAGS"
+    UNDEFINED_AND_INVALID_FLAGS = "UNDEFINED_AND_INVALID_FLAGS"

argenta/router/__init__.py

@@ -1,4 +1,4 @@
 __all__ = ["Router"]
 
 
-from argenta.router.entity import Router
+from argenta.router.entity import Router

argenta/router/command_handler/entity.py

@@ -64,4 +64,4 @@ class CommandHandlers:
         return iter(self.command_handlers)
 
     def __next__(self) -> CommandHandler:
-        return next(iter(self.command_handlers))
+        return next(iter(self.command_handlers))

argenta/router/defaults.py

@@ -1,4 +1,4 @@
 from argenta.router import Router
 
 
-system_router = Router(title='System points:')
+system_router = Router(title="System points:")