argenta 0.4.10__py3-none-any.whl → 0.5.0a0__py3-none-any.whl

argenta/app/autocompleter/__init__.py

@@ -0,0 +1,4 @@
+__all__ = ["AutoCompleter"]
+
+
+from argenta.app.autocompleter.entity import AutoCompleter

argenta/app/autocompleter/entity.py

@@ -0,0 +1,48 @@
+import os
+
+import readline
+
+
+class AutoCompleter:
+    def __init__(self, history_filename: str = False, autocomplete_button: str = 'tab'):
+        self.history_filename = history_filename
+        self.autocomplete_button = autocomplete_button
+        self.matches = []
+
+    def complete(self, text, state):
+        matches = sorted(cmd for cmd in self.get_history_items() if cmd.startswith(text))
+        if len(matches) > 1:
+            common_prefix = matches[0]
+            for match in matches[1:]:
+                i = 0
+                while i < len(common_prefix) and i < len(match) and common_prefix[i] == match[i]:
+                    i += 1
+                common_prefix = common_prefix[:i]
+            if state == 0:
+                readline.insert_text(common_prefix[len(text):])
+                readline.redisplay()
+            return None
+        elif len(matches) == 1:
+            return matches[0] if state == 0 else None
+        else:
+            return None
+
+    def initial_setup(self, all_commands: list[str]):
+        if self.history_filename:
+            if os.path.exists(self.history_filename):
+                readline.read_history_file(self.history_filename)
+            else:
+                for line in all_commands:
+                    readline.add_history(line)
+
+        readline.set_completer(self.complete)
+        readline.set_completer_delims(readline.get_completer_delims().replace(' ', ''))
+        readline.parse_and_bind(f'{self.autocomplete_button}: complete')
+
+    def exit_setup(self):
+        if self.history_filename:
+            readline.write_history_file(self.history_filename)
+
+    @staticmethod
+    def get_history_items():
+        return [readline.get_history_item(i) for i in range(1, readline.get_current_history_length() + 1)]

argenta/app/defaults.py

@@ -5,4 +5,5 @@ from dataclasses import dataclass
 class PredeterminedMessages:
     USAGE = '[b dim]Usage[/b dim]: [i]<command> <[green]flags[/green]>[/i]'
     HELP = '[b dim]Help[/b dim]: [i]<command>[/i] [b red]--help[/b red]'
+    AUTOCOMPLETE = '[b dim]Autocomplete[/b dim]: [i]<part>[/i] [bold]<tab>'
 

argenta/app/exceptions.py

@@ -3,16 +3,6 @@ class InvalidRouterInstanceException(Exception):
         return "Invalid Router Instance"
 
 
-class InvalidDescriptionMessagePatternException(Exception):
-    def __init__(self, pattern: str):
-        self.pattern = pattern
-    def __str__(self):
-        return ("Invalid Description Message Pattern\n"
-                "Correct pattern example: [{command}] *=*=* {description}\n"
-                "The pattern must contain two variables: `command` and `description` - description of the command\n"
-                f"Your pattern: {self.pattern}")
-
-
 class NoRegisteredRoutersException(Exception):
     def __str__(self):
         return "No Registered Router Found"

argenta/app/models.py

@@ -1,5 +1,6 @@
 from typing import Callable
 from rich.console import Console
+from rich.markup import escape
 from art import text2art
 from contextlib import redirect_stdout
 import io
@@ -8,13 +9,13 @@ import re
 from argenta.command.models import Command, InputCommand
 from argenta.router import Router
 from argenta.router.defaults import system_router
+from argenta.app.autocompleter import AutoCompleter
 from argenta.app.dividing_line.models import StaticDividingLine, DynamicDividingLine
 from argenta.command.exceptions import (UnprocessedInputFlagException,
                                         RepeatedInputFlagsException,
                                         EmptyInputCommandException,
                                         BaseInputCommandException)
 from argenta.app.exceptions import (InvalidRouterInstanceException,
-                                    InvalidDescriptionMessagePatternException,
                                     NoRegisteredRoutersException,
                                     NoRegisteredHandlersException)
 from argenta.app.registered_routers.entity import RegisteredRouters
@@ -26,28 +27,29 @@ class AppInit:
                  prompt: str = '[italic dim bold]What do you want to do?\n',
                  initial_message: str = '\nArgenta\n',
                  farewell_message: str = '\nSee you\n',
-                 exit_command: str = 'Q',
-                 exit_command_description: str = 'Exit command',
-                 system_points_title: str = 'System points:',
+                 exit_command: Command = Command('Q', 'Exit command'),
+                 system_points_title: str | None = 'System points:',
                  ignore_command_register: bool = True,
                  dividing_line: StaticDividingLine | DynamicDividingLine = StaticDividingLine(),
                  repeat_command_groups: bool = True,
                  full_override_system_messages: bool = False,
+                 autocompleter: AutoCompleter = AutoCompleter(),
                  print_func: Callable[[str], None] = Console().print) -> None:
         self._prompt = prompt
         self._print_func = print_func
         self._exit_command = exit_command
-        self._exit_command_description = exit_command_description
         self._system_points_title = system_points_title
         self._dividing_line = dividing_line
         self._ignore_command_register = ignore_command_register
         self._repeat_command_groups_description = repeat_command_groups
         self._full_override_system_messages = full_override_system_messages
+        self._autocompleter = autocompleter
 
         self._farewell_message = farewell_message
         self._initial_message = initial_message
 
-        self._description_message_pattern: str = '[bold red][{command}][/bold red] [blue dim]*=*=*[/blue dim] [bold yellow italic]{description}'
+
+        self._description_message_gen: Callable[[str, str], str] = lambda command, description: f'[bold red]{escape('['+command+']')}[/bold red] [blue dim]*=*=*[/blue dim] [bold yellow italic]{escape(description)}'
         self._registered_routers: RegisteredRouters = RegisteredRouters()
         self._messages_on_startup = []
 
@@ -59,14 +61,8 @@ class AppInit:
 
 
 class AppSetters(AppInit):
-    def set_description_message_pattern(self, pattern: str) -> None:
-        first_check = re.match(r'.*{command}.*', pattern)
-        second_check = re.match(r'.*{description}.*', pattern)
-
-        if bool(first_check) and bool(second_check):
-            self._description_message_pattern: str = pattern
-        else:
-            raise InvalidDescriptionMessagePatternException(pattern)
+    def set_description_message_pattern(self, pattern: Callable[[str, str], str]) -> None:
+        self._description_message_gen: Callable[[str, str], str] = pattern
 
 
     def set_invalid_input_flags_handler(self, handler: Callable[[str], None]) -> None:
@@ -92,11 +88,12 @@ class AppSetters(AppInit):
 class AppPrinters(AppInit):
     def _print_command_group_description(self):
         for registered_router in self._registered_routers:
-            self._print_func(registered_router.get_title())
+            if registered_router.get_title():
+                self._print_func(registered_router.get_title())
             for command_handler in registered_router.get_command_handlers():
-                self._print_func(self._description_message_pattern.format(
-                        command=command_handler.get_handled_command().get_trigger(),
-                        description=command_handler.get_handled_command().get_description()))
+                self._print_func(self._description_message_gen(
+                        command_handler.get_handled_command().get_trigger(),
+                        command_handler.get_handled_command().get_description()))
             self._print_func('')
 
 
@@ -111,7 +108,7 @@ class AppPrinters(AppInit):
 
 class AppNonStandardHandlers(AppPrinters):
     def _is_exit_command(self, command: InputCommand):
-        if command.get_trigger().lower() == self._exit_command.lower():
+        if command.get_trigger().lower() == self._exit_command.get_trigger().lower():
             if self._ignore_command_register:
                 system_router.input_command_handler(command)
                 return True
@@ -125,10 +122,16 @@ class AppNonStandardHandlers(AppPrinters):
         for router_entity in self._registered_routers:
             for command_handler in router_entity.get_command_handlers():
                 handled_command_trigger = command_handler.get_handled_command().get_trigger()
+                handled_command_aliases = command_handler.get_handled_command().get_aliases()
                 if handled_command_trigger.lower() == command.get_trigger().lower() and self._ignore_command_register:
                     return False
                 elif handled_command_trigger == command.get_trigger():
                     return False
+                elif handled_command_aliases:
+                    if command.get_trigger().lower() in [x.lower() for x in handled_command_aliases] and self._ignore_command_register:
+                        return False
+                    elif command.get_trigger() in handled_command_trigger:
+                        return False
         if isinstance(self._dividing_line, StaticDividingLine):
             self._print_func(self._dividing_line.get_full_line())
             self._unknown_command_handler(command)
@@ -167,7 +170,7 @@ class AppSetups(AppValidators, AppPrinters):
     def _setup_system_router(self):
         system_router.set_title(self._system_points_title)
 
-        @system_router.command(Command(self._exit_command, self._exit_command_description))
+        @system_router.command(self._exit_command)
         def exit_command():
             self._exit_command_handler()
 
@@ -188,6 +191,12 @@ class AppSetups(AppValidators, AppPrinters):
         self._validate_number_of_routers()
         self._validate_included_routers()
 
+        all_triggers: list[str] = []
+        for router_entity in self._registered_routers:
+            all_triggers.extend(router_entity.get_triggers())
+            all_triggers.extend(router_entity.get_aliases())
+        self._autocompleter.initial_setup(all_triggers)
+
         self._print_func(self._initial_message)
 
         for message in self._messages_on_startup:
@@ -221,6 +230,7 @@ class App(AppSetters, AppNonStandardHandlers, AppSetups):
                 continue
 
             if self._is_exit_command(input_command):
+                self._autocompleter.exit_setup()
                 return
 
             if self._is_unknown_command(input_command):

argenta/command/models.py

@@ -19,14 +19,19 @@ class BaseCommand:
 class Command(BaseCommand):
     def __init__(self, trigger: str,
                  description: str = None,
-                 flags: Flag | Flags = None):
+                 flags: Flag | Flags = None,
+                 aliases: list[str] = None):
         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'Description for "{self._trigger}" command' if not description else description
+        self._aliases = aliases
 
     def get_registered_flags(self) -> Flags:
         return self._registered_flags
 
+    def get_aliases(self) -> list[str] | None:
+        return self._aliases
+
     def validate_input_flag(self, flag: InputFlag):
         registered_flags: Flags | None = self.get_registered_flags()
         if registered_flags:

argenta/router/command_handler/entity.py

@@ -5,17 +5,17 @@ from argenta.command.flag.models import InputFlags
 
 class CommandHandler:
     def __init__(self, handler: Callable[[], None] | Callable[[InputFlags], None], handled_command: Command):
-        self.handler = handler
-        self.handled_command = handled_command
+        self._handler = handler
+        self._handled_command = handled_command
 
     def handling(self, input_flags: InputFlags = None):
         if input_flags is not None:
-            self.handler(input_flags)
+            self._handler(input_flags)
         else:
-            self.handler()
+            self._handler()
 
     def get_handler(self):
-        return self.handler
+        return self._handler
 
     def get_handled_command(self):
-        return self.handled_command
+        return self._handled_command

argenta/router/entity.py

@@ -7,15 +7,15 @@ from argenta.router.command_handlers.entity import CommandHandlers
 from argenta.router.command_handler.entity import CommandHandler
 from argenta.command.flag.models import Flag, Flags, InputFlags
 from argenta.router.exceptions import (RepeatedFlagNameException,
-                                     TooManyTransferredArgsException,
-                                     RequiredArgumentNotPassedException,
-                                     IncorrectNumberOfHandlerArgsException,
-                                     TriggerCannotContainSpacesException)
+                                       TooManyTransferredArgsException,
+                                       RequiredArgumentNotPassedException,
+                                       IncorrectNumberOfHandlerArgsException,
+                                       TriggerCannotContainSpacesException)
 
 
 class Router:
     def __init__(self,
-                 title: str = 'Commands group title:',
+                 title: str = None,
                  name: str = 'Default'):
         self._title = title
         self._name = name
@@ -54,21 +54,29 @@ class Router:
         for command_handler in self._command_handlers:
             handle_command = command_handler.get_handled_command()
             if input_command_name.lower() == handle_command.get_trigger().lower():
-                if handle_command.get_registered_flags().get_flags():
-                    if input_command_flags.get_flags():
-                        if self._validate_input_flags(handle_command, input_command_flags):
-                            command_handler.handling(input_command_flags)
-                            return
-                    else:
-                        command_handler.handling(input_command_flags)
-                        return
-                else:
-                    if input_command_flags.get_flags():
-                        self._not_valid_flag_handler(input_command_flags[0])
-                        return
-                    else:
-                        command_handler.handling()
-                        return
+                self._validate_input_command(input_command_flags, command_handler)
+            elif handle_command.get_aliases():
+                if input_command_name.lower() in handle_command.get_aliases():
+                    self._validate_input_command(input_command_flags, command_handler)
+
+
+    def _validate_input_command(self, input_command_flags: InputFlags, command_handler: CommandHandler):
+        handle_command = command_handler.get_handled_command()
+        if handle_command.get_registered_flags().get_flags():
+            if input_command_flags.get_flags():
+                if self._validate_input_flags(handle_command, input_command_flags):
+                    command_handler.handling(input_command_flags)
+                    return
+            else:
+                command_handler.handling(input_command_flags)
+                return
+        else:
+            if input_command_flags.get_flags():
+                self._not_valid_flag_handler(input_command_flags[0])
+                return
+            else:
+                command_handler.handling()
+                return
 
 
     def _validate_input_flags(self, handle_command: Command, input_flags: InputFlags):
@@ -110,6 +118,21 @@ class Router:
         self._ignore_command_register = ignore_command_register
 
 
+    def get_triggers(self):
+        all_triggers: list[str] = []
+        for command_handler in self._command_handlers:
+            all_triggers.append(command_handler.get_handled_command().get_trigger())
+        return all_triggers
+
+
+    def get_aliases(self):
+        all_aliases: list[str] = []
+        for command_handler in self._command_handlers:
+            if command_handler.get_handled_command().get_aliases():
+                all_aliases.extend(command_handler.get_handled_command().get_aliases())
+        return all_aliases
+
+
     def get_command_handlers(self) -> CommandHandlers:
         return self._command_handlers
 
@@ -118,7 +141,7 @@ class Router:
         return self._name
 
 
-    def get_title(self) -> str:
+    def get_title(self) -> str | None:
         return self._title
 
 

{argenta-0.4.10.dist-info → argenta-0.5.0a0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: argenta
-Version: 0.4.10
+Version: 0.5.0a0
 Summary: Python library for creating TUI
 License: MIT
 Author: kolo

{argenta-0.4.10.dist-info → argenta-0.5.0a0.dist-info}/RECORD

@@ -1,10 +1,12 @@
 argenta/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 argenta/app/__init__.py,sha256=I8FTXU17ajDI-hbC6Rw0LxLmvDYipdQaos3v1pmu14E,57
-argenta/app/defaults.py,sha256=7ej4G-4dieMlichfuQhw5XgabF15X-vAa8k02ZfkdUs,234
+argenta/app/autocompleter/__init__.py,sha256=VT_p3QA78UnczV7pYR2NnwQ0Atd8mnDUnLazvUQNqJk,93
+argenta/app/autocompleter/entity.py,sha256=ah85zH_RdibypTXQmgzjUU13TdhKdGpep0BgNcT_w_o,1827
+argenta/app/defaults.py,sha256=D0z9yGnfF8hhWUxHCvBhxTrxg6a9rPiySAn2Fyy7TXQ,311
 argenta/app/dividing_line/__init__.py,sha256=jJZDDZix8XYCAUWW4FzGJH0JmJlchYcx0FPWifjgv1I,147
 argenta/app/dividing_line/models.py,sha256=ueBDmy1hfYzGAr1X2G2Mw0hjES7YQBtP7N3TLBDz9h0,700
-argenta/app/exceptions.py,sha256=uCkb1VqEIZQuVDY0ZsfDc3yCbySwLpV5CdIT7iaGYRM,928
-argenta/app/models.py,sha256=burvSSmUW-1FnhGYgHwLTW6jcW3ENFoB1wdmwwyYAog,12121
+argenta/app/exceptions.py,sha256=oTvec3ZGX_tS1nqa0pLLAPqMlhrLS6SsXY2lYiOwIVM,465
+argenta/app/models.py,sha256=yH6LGq_bA525JCq-cCl-O8v_JLbYLC6q30ZftPW5e2k,12736
 argenta/app/registered_routers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 argenta/app/registered_routers/entity.py,sha256=OQZyrF4eoCoDHzRJ22zZxhNEx-bOUDu7NZIFDfO-fuY,688
 argenta/command/__init__.py,sha256=Plo2Da0fhq8H1eo2mg7nA1-OBLuGjK2BYpDGRvGGMIU,67
@@ -12,16 +14,16 @@ argenta/command/exceptions.py,sha256=HOgddtXLDgk9Wx6c_GnzW3bMAMU5CuUnUyxjW3cVHRo
 argenta/command/flag/__init__.py,sha256=PaZAaqU3DgyO1o5do-xKhWV6TyEuOSaQTmE4VbPY6JA,136
 argenta/command/flag/defaults.py,sha256=ktKmDT0rSSBoFUghTlEQ6OletoFxCiD37hRzO73mUUc,875
 argenta/command/flag/models.py,sha256=IY0FHyAFD9O1ZxSaq6NR9gSTkldoQGrKVoGrAbnmEuA,3769
-argenta/command/models.py,sha256=1p_QZ5cQq47t915zHehEx-S0smTqj4DDnjZGn_qZlOA,4436
+argenta/command/models.py,sha256=QhpxFuq-yLoxxegEQay0ZFFJT4-W1GOayDzM0gz_41Q,4594
 argenta/router/__init__.py,sha256=ldrIWTXNLXUAMAGQ8ex4e8nMso_fhi01nZi2DVzHnnk,66
 argenta/router/command_handler/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-argenta/router/command_handler/entity.py,sha256=8sWhP89c0FavFBITJmH9c8wNn2ipW_6-_obzjkwXueU,646
+argenta/router/command_handler/entity.py,sha256=wVBl-Z3oq3aDUYmGBeudM7TxPZZrUEdZw7BImWJL5LE,652
 argenta/router/command_handlers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 argenta/router/command_handlers/entity.py,sha256=KgFKjAMUr_mOcn9xahTxMUKB6lIxXgqCuAsuc4TgP6E,747
 argenta/router/defaults.py,sha256=huftOg1HMjrT_R2SHHOL4eJ5uZHspNEYBSg-mCq9xhU,126
-argenta/router/entity.py,sha256=afQn5jrDBrcd5QUzeBwRPfazOO6x0yYSXcmvHYhJpDw,4997
+argenta/router/entity.py,sha256=d9S9Af9vACAgUaiPq-CgVGrb7KcAZYfYm3oavVAceI8,5900
 argenta/router/exceptions.py,sha256=tdeaR8zDvnytgRYo_wQWKHt3if2brapgauIhhMIsTsA,678
-argenta-0.4.10.dist-info/LICENSE,sha256=zmqoGh2n5rReBv4s8wPxF_gZEZDgauJYSPMuPczgOiU,1082
-argenta-0.4.10.dist-info/METADATA,sha256=uVIrDo-uxIWV7qS1pGXZAHL95Sok2KQ-U8tJoZxovGg,20986
-argenta-0.4.10.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-argenta-0.4.10.dist-info/RECORD,,
+argenta-0.5.0a0.dist-info/LICENSE,sha256=zmqoGh2n5rReBv4s8wPxF_gZEZDgauJYSPMuPczgOiU,1082
+argenta-0.5.0a0.dist-info/METADATA,sha256=5sPiqrm-Ab3I3exQFI1FtBNmPOwXgJqICYpVzkLLcWc,20987
+argenta-0.5.0a0.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+argenta-0.5.0a0.dist-info/RECORD,,