argenta 1.0.0a5__tar.gz → 1.0.0b2__tar.gz

{argenta-1.0.0a5 → argenta-1.0.0b2}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: argenta
-Version: 1.0.0a5
-Summary: Python library for creating TUI
+Version: 1.0.0b2
+Summary: Python library for building modular CLI applications
 Author-email: kolo <kolo.is.main@gmail.com>
 License: MIT
 License-File: LICENSE
 Requires-Python: <4.0,>=3.11
 Requires-Dist: art<7.0,>=6.4
-Requires-Dist: pyreadline3<4.0.0,>=3.5.4
+Requires-Dist: pyreadline3>=3.5.4
 Requires-Dist: rich<15.0.0,>=14.0.0
 Description-Content-Type: text/markdown
 
@@ -87,7 +87,7 @@ Description-Content-Type: text/markdown
 
 ---
 
-![preview](https://github.com/koloideal/Argenta/blob/kolo/imgs/mock_app_preview3.png?raw=True)  
+![preview](https://github.com/koloideal/Argenta/blob/kolo/imgs/mock_app_preview4.png?raw=True)  
 An example of the TUI appearance
 
 ---

{argenta-1.0.0a5 → argenta-1.0.0b2}/README.md

@@ -74,7 +74,7 @@
 
 ---
 
-![preview](https://github.com/koloideal/Argenta/blob/kolo/imgs/mock_app_preview3.png?raw=True)  
+![preview](https://github.com/koloideal/Argenta/blob/kolo/imgs/mock_app_preview4.png?raw=True)  
 An example of the TUI appearance
 
 ---

{argenta-1.0.0a5 → argenta-1.0.0b2}/mock/default_mock_app/main.py

@@ -1,8 +1,7 @@
-#from mock.mock_app.handlers.routers import work_router
+from mock.mock_app.handlers.routers import work_router
 
 from argenta.app import App
 from argenta.app.defaults import PredefinedMessages
-from argenta.app.dividing_line import DynamicDividingLine
 from argenta.app.autocompleter import AutoCompleter
 from argenta.orchestrator import Orchestrator
 from argenta.orchestrator.argparser import ArgParser
@@ -10,16 +9,16 @@ from argenta.orchestrator.argparser.arguments import BooleanArgument
 
 
 arg_parser = ArgParser(processed_args=[BooleanArgument('repeat')])
-app: App = App()
+app: App = App(autocompleter=AutoCompleter('.hist'))
 orchestrator: Orchestrator = Orchestrator()
 
 
 def main():
-    #app.include_router(work_router)
+    app.include_router(work_router)
 
-    '''app.add_message_on_startup(PredefinedMessages.USAGE)
+    app.add_message_on_startup(PredefinedMessages.USAGE)
     app.add_message_on_startup(PredefinedMessages.AUTOCOMPLETE)
-    app.add_message_on_startup(PredefinedMessages.HELP)'''
+    app.add_message_on_startup(PredefinedMessages.HELP)
 
     orchestrator.start_polling(app)
 

argenta-1.0.0b2/mock/local_test.py

@@ -0,0 +1,23 @@
+from argenta.response import Response, Status
+from argenta.app import App
+from argenta.app.dividing_line import StaticDividingLine, DynamicDividingLine
+from argenta.app.autocompleter import AutoCompleter
+from argenta.app.defaults import PredefinedMessages
+from argenta.command import Command
+from argenta.command.flags import Flags, InputFlags, InvalidValueInputFlags, UndefinedInputFlags, ValidInputFlags
+from argenta.command.flag import Flag, InputFlag
+from argenta.command.flag.defaults import PredefinedFlags
+from argenta.router import Router
+from argenta.orchestrator import Orchestrator
+
+from argenta.command.models import InputCommand
+import inspect
+
+
+router = Router()
+
+
+@router.command(Command('some'))
+def handler(res: Response) -> Response:
+    pass
+

argenta-1.0.0b2/mock/mock_app/handlers/routers.py

@@ -0,0 +1,31 @@
+from rich.console import Console
+
+from argenta.command import Command
+from argenta.command.flag.defaults import PredefinedFlags
+from argenta.command.flags import Flags
+from argenta.response import Response
+from argenta.router import Router
+
+
+work_router: Router = Router(title='Work points:')
+
+console = Console()
+
+
+@work_router.command(Command('get', 'Get Help', aliases=['help', 'Get_help'], flags=Flags(PredefinedFlags.PORT, PredefinedFlags.HOST)))
+def command_help(response: Response):
+    print(response.status)
+    print(response.undefined_flags.get_flags())
+    print(response.valid_flags.get_flags())
+    print(response.invalid_value_flags.get_flags())
+
+
+@work_router.command('run')
+def command_start_solving(response: Response):
+    print(response.status)
+    print(response.undefined_flags.get_flags())
+    print(response.valid_flags.get_flags())
+    print(response.invalid_value_flags.get_flags())
+
+
+

{argenta-1.0.0a5 → argenta-1.0.0b2}/mock/mock_app/main.py

@@ -11,7 +11,8 @@ from argenta.orchestrator.argparser.arguments import BooleanArgument
 
 arg_parser = ArgParser(processed_args=[BooleanArgument('repeat')])
 app: App = App(dividing_line=DynamicDividingLine(),
-               autocompleter=AutoCompleter('./mock/.hist'))
+               autocompleter=AutoCompleter('./mock/.hist'),
+               repeat_command_groups=False,)
 orchestrator: Orchestrator = Orchestrator(arg_parser)
 
 

{argenta-1.0.0a5 → argenta-1.0.0b2}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "argenta"
-version = "1.0.0-alpha5"
-description = "Python library for creating TUI"
+version = "1.0.0-beta2"
+description = "Python library for building modular CLI applications"
 authors = [{ name = "kolo", email = "kolo.is.main@gmail.com" }]
 requires-python = ">=3.11, <4.0"
 readme = "README.md"
@@ -9,7 +9,7 @@ license = { text = "MIT" }
 dependencies = [
     "rich (>=14.0.0,<15.0.0)",
     "art (>=6.4,<7.0)",
-    "pyreadline3 (>=3.5.4,<4.0.0)",
+    "pyreadline3>=3.5.4",
 ]
 
 [dependency-groups]

{argenta-1.0.0a5 → argenta-1.0.0b2}/src/argenta/app/models.py

@@ -16,6 +16,7 @@ from argenta.command.exceptions import (UnprocessedInputFlagException,
                                         EmptyInputCommandException,
                                         BaseInputCommandException)
 from argenta.app.registered_routers.entity import RegisteredRouters
+from argenta.response import Response
 
 
 
@@ -58,7 +59,7 @@ class BaseApp:
         self._repeated_input_flags_handler: Callable[[str], None] = lambda raw_command: print_func(f'Repeated input flags: {raw_command}')
         self._empty_input_command_handler: Callable[[], None] = lambda: print_func('Empty input command')
         self._unknown_command_handler: Callable[[InputCommand], None] = lambda command: print_func(f"Unknown command: {command.get_trigger()}")
-        self._exit_command_handler: Callable[[], None] = lambda: print_func(self._farewell_message)
+        self._exit_command_handler: Callable[[Response], None] = lambda response: print_func(self._farewell_message)
 
 
     def set_description_message_pattern(self, _: Callable[[str, str], str]) -> None:
@@ -210,30 +211,51 @@ class BaseApp:
         system_router.set_title(self._system_router_title)
 
         @system_router.command(self._exit_command)
-        def exit_command():
-            self._exit_command_handler()
+        def exit_command(response: Response) -> None:
+            self._exit_command_handler(response)
 
         if system_router not in self._registered_routers.get_registered_routers():
             system_router.set_command_register_ignore(self._ignore_command_register)
             self._registered_routers.add_registered_router(system_router)
 
 
+    def _most_similar_command(self, unknown_command: str) -> str | None:
+        all_commands = self._all_registered_triggers_in_lower if self._ignore_command_register else self._all_registered_triggers_in_default_case
+        matches: list[str] | list = sorted(cmd for cmd in all_commands if cmd.startswith(unknown_command))
+        if not matches:
+            matches: list[str] | list = sorted(cmd for cmd in all_commands if unknown_command.startswith(cmd))
+        if len(matches) == 1:
+            return matches[0]
+        elif len(matches) > 1:
+            return sorted(matches, key=lambda cmd: len(cmd))[0]
+        else:
+            return None
+
+
     def _setup_default_view(self) -> None:
         """
         Private. Sets up default app view
         :return: None
         """
-        if not self._override_system_messages:
-            self._initial_message = f'\n[bold red]{text2art(self._initial_message, font="tarty1")}\n\n'
-            self._farewell_message = (f'[bold red]\n{text2art(f"\n{self._farewell_message}\n", font="chanky")}[/bold red]\n'
-                                      f'[red i]github.com/koloideal/Argenta[/red i] | [red bold i]made by kolo[/red bold i]\n')
-            self._description_message_gen = lambda command, description: (f'[bold red]{escape("[" + command + "]")}[/bold red] '
-                                                                          f'[blue dim]*=*=*[/blue dim] '
-                                                                          f'[bold yellow italic]{escape(description)}')
-            self._invalid_input_flags_handler = lambda raw_command: self._print_func(f'[red bold]Incorrect flag syntax: {escape(raw_command)}')
-            self._repeated_input_flags_handler = lambda raw_command: self._print_func(f'[red bold]Repeated input flags: {escape(raw_command)}')
-            self._empty_input_command_handler = lambda: self._print_func('[red bold]Empty input command')
-            self._unknown_command_handler = lambda command: self._print_func(f"[red bold]Unknown command: {escape(command.get_trigger())}")
+        self._prompt = '[italic dim bold]What do you want to do?\n'
+        self._initial_message = f'\n[bold red]{text2art(self._initial_message, font="tarty1")}\n'
+        self._farewell_message = (f'[bold red]\n{text2art(f"\n{self._farewell_message}\n", font="chanky")}[/bold red]\n'
+                                  f'[red i]github.com/koloideal/Argenta[/red i] | [red bold i]made by kolo[/red bold i]\n')
+        self._description_message_gen = lambda command, description: (f'[bold red]{escape("[" + command + "]")}[/bold red] '
+                                                                      f'[blue dim]*=*=*[/blue dim] '
+                                                                      f'[bold yellow italic]{escape(description)}')
+        self._invalid_input_flags_handler = lambda raw_command: self._print_func(f'[red bold]Incorrect flag syntax: {escape(raw_command)}')
+        self._repeated_input_flags_handler = lambda raw_command: self._print_func(f'[red bold]Repeated input flags: {escape(raw_command)}')
+        self._empty_input_command_handler = lambda: self._print_func('[red bold]Empty input command')
+
+        def unknown_command_handler(command: InputCommand) -> None:
+            cmd_trg: str = command.get_trigger()
+            mst_sim_cmd: str | None = self._most_similar_command(cmd_trg)
+            first_part_of_text = f"[red]Unknown command:[/red] [blue]{escape(cmd_trg)}[/blue]"
+            second_part_of_text = ('[red], most similar:[/red] ' + ('[blue]' + mst_sim_cmd + '[/blue]')) if mst_sim_cmd else ''
+            self._print_func(first_part_of_text + second_part_of_text)
+
+        self._unknown_command_handler = unknown_command_handler
 
 
     def _pre_cycle_setup(self) -> None:
@@ -241,7 +263,6 @@ class BaseApp:
         Private. Configures various aspects of the application before the start of the cycle
         :return: None
         """
-        self._setup_default_view()
         self._setup_system_router()
 
         for router_entity in self._registered_routers:
@@ -253,12 +274,15 @@ class BaseApp:
 
         self._autocompleter.initial_setup(self._all_registered_triggers_in_lower)
 
+        if not self._override_system_messages:
+            self._setup_default_view()
+
         self._print_func(self._initial_message)
 
         for message in self._messages_on_startup:
             self._print_func(message)
         if self._messages_on_startup:
-            print('\n\n')
+            print('\n')
 
         if not self._repeat_command_groups_description:
             self._print_command_group_description()
@@ -267,7 +291,7 @@ class BaseApp:
 
 class App(BaseApp):
     def __init__(self,
-                 prompt: str = '[italic dim bold]What do you want to do?\n',
+                 prompt: str = 'What do you want to do?\n',
                  initial_message: str = '\nArgenta\n',
                  farewell_message: str = '\nSee you\n',
                  exit_command: Command = Command('Q', 'Exit command'),
@@ -346,9 +370,6 @@ class App(BaseApp):
                 res: str = f.getvalue()
             self._print_framed_text(res)
 
-            if not self._repeat_command_groups_description:
-                self._print_func(self._prompt)
-
 
     def include_router(self, router: Router) -> None:
         """

{argenta-1.0.0a5 → argenta-1.0.0b2}/src/argenta/command/exceptions.py

@@ -1,4 +1,4 @@
-from argenta.command.flag.models import InputFlag, Flag
+from argenta.command.flag.models import Flag, InputFlag
 
 
 class BaseInputCommandException(Exception):

argenta-1.0.0b2/src/argenta/command/flag/__init__.py

@@ -0,0 +1,4 @@
+__all__ = ["Flag", "InputFlag"]
+
+
+from argenta.command.flag.models import Flag, InputFlag

{argenta-1.0.0a5 → argenta-1.0.0b2}/src/argenta/command/flag/models.py

@@ -1,8 +1,8 @@
 from typing import Literal, Pattern
-from abc import ABC, abstractmethod
 
 
-class BaseFlag(ABC):
+
+class BaseFlag:
     def __init__(self, name: str,
                  prefix: Literal['-', '--', '---'] = '--') -> None:
         """
@@ -36,37 +36,8 @@ class BaseFlag(ABC):
         """
         return self._prefix
 
-
-
-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
-
-    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 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()
 
 
 class Flag(BaseFlag):
@@ -113,106 +84,35 @@ class Flag(BaseFlag):
             return True
 
 
-
-class BaseFlags(ABC):
-    """
-    Private. Base class for groups of flags
-    """
-    __slots__ = ('_flags',)
-
-    @abstractmethod
-    def get_flags(self):
-        """
-        Public. Returns a list of flags
-        :return: list of flags
-        """
-        pass
-
-    @abstractmethod
-    def add_flag(self, flag: Flag | InputFlag):
-        """
-        Public. Adds a flag to the list of flags
-        :param flag: flag to add
-        :return: None
-        """
-        pass
-
-    @abstractmethod
-    def add_flags(self, flags: list[Flag] | list[InputFlag]):
+class InputFlag(BaseFlag):
+    def __init__(self, name: str,
+                 prefix: Literal['-', '--', '---'] = '--',
+                 value: str = None):
         """
-        Public. Adds a list of flags to the list of flags
-        :param flags: list of flags to add
+        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
         """
-        pass
-
-    @abstractmethod
-    def get_flag(self, name: str):
-        """
-        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
-        """
-        pass
-
-    def __iter__(self):
-        return iter(self._flags)
-
-    def __next__(self):
-        return next(iter(self))
-
-    def __getitem__(self, item):
-        return self._flags[item]
-
-
+        super().__init__(name, prefix)
+        self._flag_value = value
 
-class Flags(BaseFlags, ABC):
-    def __init__(self, *flags: Flag):
+    def get_value(self) -> str | None:
         """
-        Public. A model that combines the registered flags
-        :param flags: the flags that will be registered
-        :return: None
+        Public. Returns the value of the flag
+        :return: the value of the flag as str
         """
-        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
-
-
+        return self._flag_value
 
-class InputFlags(BaseFlags, ABC):
-    def __init__(self, *flags: InputFlag):
+    def set_value(self, value):
         """
-        Public. A model that combines the input flags of the input command
-        :param flags: all input flags
+        Private. Sets the value of the flag
+        :param value: the fag value to set
         :return: None
         """
-        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)
+        self._flag_value = 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 __eq__(self, other) -> bool:
+        return self.get_string_entity() == other.get_string_entity() and self.get_value() == other.get_value()
 

argenta-1.0.0b2/src/argenta/command/flags/__init__.py

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

argenta-1.0.0b2/src/argenta/command/flags/models.py

@@ -0,0 +1,87 @@
+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-1.0.0a5 → argenta-1.0.0b2}/src/argenta/command/models.py

@@ -1,4 +1,5 @@
-from argenta.command.flag.models import Flag, InputFlag, Flags, InputFlags
+from argenta.command.flag.models import Flag, InputFlag
+from argenta.command.flags.models import InputFlags, Flags
 from argenta.command.exceptions import (UnprocessedInputFlagException,
                                         RepeatedInputFlagsException,
                                         EmptyInputCommandException)
@@ -38,7 +39,7 @@ class Command(BaseCommand):
         """
         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._description = f'Very useful command' if not description else description
         self._aliases = aliases if isinstance(aliases, list) else []
 
     def get_registered_flags(self) -> Flags:
@@ -55,7 +56,7 @@ class Command(BaseCommand):
         """
         return self._aliases
 
-    def validate_input_flag(self, flag: InputFlag) -> bool:
+    def validate_input_flag(self, flag: InputFlag) -> Literal['Undefined', 'Valid', 'Invalid']:
         """
         Private. Validates the input flag
         :param flag: input flag for validation
@@ -67,14 +68,21 @@ class Command(BaseCommand):
                 if registered_flags.get_string_entity() == flag.get_string_entity():
                     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())
                         if is_valid:
-                            return True
-        return False
+                            return 'Valid'
+                        else:
+                            return 'Invalid'
+                return 'Undefined'
+        return 'Undefined'
 
     def get_description(self) -> str:
         """
@@ -131,11 +139,11 @@ class InputCommand(BaseCommand, Generic[InputCommandType]):
 
         for k, _ in enumerate(list_of_tokens):
             if _.startswith('-'):
-                if current_flag_name or len(_) < 2 or len(_[:_.rfind('-')]) > 3:
+                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 = _
 
@@ -144,9 +152,9 @@ class InputCommand(BaseCommand, Generic[InputCommandType]):
                     if not list_of_tokens[k+1].startswith('-'):
                         continue
 
-                input_flag = InputFlag(name=current_flag_name[current_flag_name.rfind('-')+1:],
+                input_flag = InputFlag(name=current_flag_name[current_flag_name.rfind('-') + 1:],
                                        prefix=cast(Literal['-', '--', '---'],
-                                                   current_flag_name[:current_flag_name.rfind('-')+1]),
+                                              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()]

argenta-1.0.0b2/src/argenta/response/__init__.py

@@ -0,0 +1,5 @@
+__all__ = ["Response", "Status"]
+
+
+from argenta.response.entity import Response
+from argenta.response.status import Status