release v1.0.0a1

.gitignore

@@ -1,7 +1,9 @@
 .venv
 .idea
 dist
-poetry.lock
+uv.lock
 *__pycache__/
 *.hist*
+build
+source
 

argenta/app/dividing_line/models.py

@@ -1,24 +0,0 @@
-class BaseDividingLine:
-    def __init__(self, unit_part: str = '-'):
-        self.unit_part = unit_part
-
-    def get_unit_part(self):
-        if len(self.unit_part) == 0:
-            return ' '
-        else:
-            return self.unit_part[0]
-
-class StaticDividingLine(BaseDividingLine):
-    def __init__(self, unit_part: str = '-', length: int = 25):
-        super().__init__(unit_part)
-        self.length = length
-
-    def get_full_line(self):
-        return f'\n[dim]{self.length * self.get_unit_part()}[/dim]\n'
-
-
-class DynamicDividingLine(BaseDividingLine):
-    def get_full_line(self, length: int):
-        return f'\n[dim]{self.get_unit_part() * length}[/dim]\n'
-
-

argenta/app/models.py

@@ -1,265 +0,0 @@
-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
-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 (NoRegisteredRoutersException,
-                                    NoRegisteredHandlersException)
-from argenta.app.registered_routers.entity import RegisteredRouters
-
-
-
-class AppInit:
-    def __init__(self,
-                 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: 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,
-                 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._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._override_system_messages = override_system_messages
-        self._autocompleter = autocompleter
-
-        self._farewell_message = farewell_message
-        self._initial_message = initial_message
-
-
-        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 = []
-
-        self._invalid_input_flags_handler: Callable[[str], None] = lambda raw_command: print_func(f'[red bold]Incorrect flag syntax: {escape(raw_command)}')
-        self._repeated_input_flags_handler: Callable[[str], None] = lambda raw_command: print_func(f'[red bold]Repeated input flags: {escape(raw_command)}')
-        self._empty_input_command_handler: Callable[[], None] = lambda: print_func('[red bold]Empty input command')
-        self._unknown_command_handler: Callable[[InputCommand], None] = lambda command: print_func(f"[red bold]Unknown command: {escape(command.get_trigger())}")
-        self._exit_command_handler: Callable[[], None] = lambda: print_func(self._farewell_message)
-
-
-class AppSetters(AppInit):
-    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:
-        self._invalid_input_flags_handler = handler
-
-
-    def set_repeated_input_flags_handler(self, handler: Callable[[str], None]) -> None:
-        self._repeated_input_flags_handler = handler
-
-
-    def set_unknown_command_handler(self, handler: Callable[[str], None]) -> None:
-        self._unknown_command_handler = handler
-
-
-    def set_empty_command_handler(self, handler: Callable[[], None]) -> None:
-        self._empty_input_command_handler = handler
-
-
-    def set_exit_command_handler(self, handler: Callable[[], None]) -> None:
-        self._exit_command_handler = handler
-
-
-class AppPrinters(AppInit):
-    def _print_command_group_description(self):
-        for registered_router in self._registered_routers:
-            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_gen(
-                        command_handler.get_handled_command().get_trigger(),
-                        command_handler.get_handled_command().get_description()))
-            self._print_func('')
-
-
-    def _print_framed_text_with_dynamic_line(self, text: str):
-        clear_text = re.sub(r'\u001b\[[0-9;]*m', '', text)
-        max_length_line = max([len(line) for line in clear_text.split('\n')])
-        max_length_line = max_length_line if 10 <= max_length_line <= 80 else 80 if max_length_line > 80 else 10
-        self._print_func(self._dividing_line.get_full_line(max_length_line))
-        print(text.strip('\n'))
-        self._print_func(self._dividing_line.get_full_line(max_length_line))
-
-
-    def _print_framed_text(self, text: str):
-        if isinstance(self._dividing_line, StaticDividingLine):
-            self._print_func(self._dividing_line.get_full_line())
-            self._print_func(text)
-            self._print_func(self._dividing_line.get_full_line())
-        elif isinstance(self._dividing_line, DynamicDividingLine):
-            self._print_framed_text_with_dynamic_line(text)
-
-
-class AppNonStandardHandlers(AppPrinters):
-    def _is_exit_command(self, command: InputCommand):
-        if command.get_trigger().lower() == self._exit_command.get_trigger().lower():
-            if self._ignore_command_register:
-                system_router.input_command_handler(command)
-                return True
-            elif command.get_trigger() == self._exit_command.get_trigger():
-                system_router.input_command_handler(command)
-                return True
-        return False
-
-
-    def _is_unknown_command(self, command: InputCommand):
-        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)
-            self._print_func(self._dividing_line.get_full_line())
-        elif isinstance(self._dividing_line, DynamicDividingLine):
-            with redirect_stdout(io.StringIO()) as f:
-                self._unknown_command_handler(command)
-                res: str = f.getvalue()
-            self._print_framed_text_with_dynamic_line(res)
-        return True
-
-
-    def _error_handler(self, error: BaseInputCommandException, raw_command: str) -> None:
-        match error:
-            case UnprocessedInputFlagException():
-                self._invalid_input_flags_handler(raw_command)
-            case RepeatedInputFlagsException():
-                self._repeated_input_flags_handler(raw_command)
-            case EmptyInputCommandException():
-                self._empty_input_command_handler()
-
-
-class AppValidators(AppInit):
-    def _validate_number_of_routers(self) -> None:
-        if not self._registered_routers:
-            raise NoRegisteredRoutersException()
-
-
-    def _validate_included_routers(self) -> None:
-        for router in self._registered_routers:
-            if not router.get_command_handlers():
-                raise NoRegisteredHandlersException(router.get_name())
-
-
-class AppSetups(AppValidators, AppPrinters):
-    def _setup_system_router(self):
-        system_router.set_title(self._system_points_title)
-
-        @system_router.command(self._exit_command)
-        def exit_command():
-            self._exit_command_handler()
-
-        if system_router not in self._registered_routers.get_registered_routers():
-            system_router.set_ignore_command_register(self._ignore_command_register)
-            self._registered_routers.add_registered_router(system_router)
-
-    def _setup_default_view(self):
-        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')
-
-    def _pre_cycle_setup(self):
-        self._setup_default_view()
-        self._setup_system_router()
-        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:
-            self._print_func(message)
-        print('\n\n')
-
-        if not self._repeat_command_groups_description:
-            self._print_command_group_description()
-
-
-class App(AppSetters, AppNonStandardHandlers, AppSetups):
-    def start_polling(self) -> None:
-        self._pre_cycle_setup()
-        while True:
-            if self._repeat_command_groups_description:
-                self._print_command_group_description()
-
-            raw_command: str = Console().input(self._prompt)
-
-            try:
-                input_command: InputCommand = InputCommand.parse(raw_command=raw_command)
-            except BaseInputCommandException as error:
-                with redirect_stdout(io.StringIO()) as f:
-                    self._error_handler(error, raw_command)
-                    res: str = f.getvalue()
-                self._print_framed_text(res)
-                continue
-
-            if self._is_exit_command(input_command):
-                self._autocompleter.exit_setup()
-                return
-
-            if self._is_unknown_command(input_command):
-                continue
-
-            with redirect_stdout(io.StringIO()) as f:
-                for registered_router in self._registered_routers:
-                    registered_router.input_command_handler(input_command)
-                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:
-        router.set_ignore_command_register(self._ignore_command_register)
-        self._registered_routers.add_registered_router(router)
-
-
-    def include_routers(self, *routers: Router) -> None:
-        for router in routers:
-            self.include_router(router)
-
-
-    def add_message_on_startup(self, message: str) -> None:
-        self._messages_on_startup.append(message)
-

argenta/app/registered_routers/entity.py

@@ -1,21 +0,0 @@
-from argenta.router import Router
-
-
-class RegisteredRouters:
-    def __init__(self, registered_routers: list[Router] = None) -> None:
-        self._registered_routers = registered_routers if registered_routers else []
-
-    def get_registered_routers(self) -> list[Router]:
-        return self._registered_routers
-
-    def add_registered_router(self, router: Router):
-        self._registered_routers.append(router)
-
-    def add_registered_routers(self, *routers: Router):
-        self._registered_routers.extend(routers)
-
-    def __iter__(self):
-        return iter(self._registered_routers)
-
-    def __next__(self):
-        return next(iter(self._registered_routers))

argenta/router/__init__.py

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

argenta/router/command_handler/entity.py

@@ -1,21 +0,0 @@
-from typing import Callable
-from argenta.command import Command
-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
-
-    def handling(self, input_flags: InputFlags = None):
-        if input_flags is not None:
-            self._handler(input_flags)
-        else:
-            self._handler()
-
-    def get_handler(self):
-        return self._handler
-
-    def get_handled_command(self):
-        return self._handled_command

argenta/router/command_handlers/entity.py

@@ -1,21 +0,0 @@
-from argenta.router.command_handler.entity import CommandHandler
-
-
-class CommandHandlers:
-    def __init__(self, command_handlers: list[CommandHandler] = None):
-        self.command_handlers = command_handlers if command_handlers else []
-
-    def get_command_handlers(self) -> list[CommandHandler]:
-        return self.command_handlers
-
-    def add_command_handler(self, command_handler: CommandHandler):
-        self.command_handlers.append(command_handler)
-
-    def add_command_handlers(self, *command_handlers: CommandHandler):
-        self.command_handlers.extend(command_handlers)
-
-    def __iter__(self):
-        return iter(self.command_handlers)
-
-    def __next__(self):
-        return next(iter(self.command_handlers))

argenta/router/defaults.py

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

argenta/router/entity.py

@@ -1,149 +0,0 @@
-from typing import Callable, Any
-from inspect import getfullargspec
-
-from argenta.command import Command
-from argenta.command.models import InputCommand
-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)
-
-
-class Router:
-    def __init__(self,
-                 title: str = None,
-                 name: str = 'Default'):
-        self._title = title
-        self._name = name
-
-        self._command_handlers: CommandHandlers = CommandHandlers()
-        self._ignore_command_register: bool = False
-        self._not_valid_flag_handler: Callable[[Flag], None] = lambda flag: print(f"Undefined or incorrect input flag: {flag.get_string_entity()}{(' '+flag.get_value()) if flag.get_value() else ''}")
-
-
-    def command(self, command: Command) -> Callable[[Any],  Any]:
-        self._validate_command(command)
-
-        def command_decorator(func):
-            Router._validate_func_args(command, func)
-            self._command_handlers.add_command_handler(CommandHandler(func, command))
-
-            def wrapper(*args, **kwargs):
-                return func(*args, **kwargs)
-            return wrapper
-
-        return command_decorator
-
-
-    def set_invalid_input_flag_handler(self, func):
-        processed_args = getfullargspec(func).args
-        if len(processed_args) != 1:
-            raise IncorrectNumberOfHandlerArgsException()
-        else:
-            self._not_valid_flag_handler = func
-
-
-    def input_command_handler(self, input_command: InputCommand):
-        input_command_name: str = input_command.get_trigger()
-        input_command_flags: InputFlags = input_command.get_input_flags()
-
-        for command_handler in self._command_handlers:
-            handle_command = command_handler.get_handled_command()
-            if input_command_name.lower() == handle_command.get_trigger().lower():
-                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):
-        for flag in input_flags:
-            is_valid = handle_command.validate_input_flag(flag)
-            if not is_valid:
-                self._not_valid_flag_handler(flag)
-                return False
-        return True
-
-
-    @staticmethod
-    def _validate_command(command: Command):
-        command_name: str = command.get_trigger()
-        if command_name.find(' ') != -1:
-            raise TriggerCannotContainSpacesException()
-
-        flags: Flags = command.get_registered_flags()
-        if flags:
-            flags_name: list = [x.get_string_entity().lower() for x in flags]
-            if len(set(flags_name)) < len(flags_name):
-                raise RepeatedFlagNameException()
-
-
-    @staticmethod
-    def _validate_func_args(command: Command, func: Callable):
-        registered_args = command.get_registered_flags()
-        transferred_args = getfullargspec(func).args
-        if registered_args.get_flags() and transferred_args:
-           if len(transferred_args) != 1:
-                raise TooManyTransferredArgsException()
-        elif registered_args.get_flags() and not transferred_args:
-            raise RequiredArgumentNotPassedException()
-        elif not registered_args.get_flags() and transferred_args:
-            raise TooManyTransferredArgsException()
-
-
-    def set_ignore_command_register(self, ignore_command_register: bool):
-        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
-
-
-    def get_name(self) -> str:
-        return self._name
-
-
-    def get_title(self) -> str | None:
-        return self._title
-
-
-    def set_title(self, title: str):
-        self._title = title

argenta/router/exceptions.py

@@ -1,23 +0,0 @@
-class RepeatedFlagNameException(Exception):
-    def __str__(self):
-        return "Repeated registered_flag name in register command"
-
-
-class TooManyTransferredArgsException(Exception):
-    def __str__(self):
-        return "Too many transferred arguments"
-
-
-class RequiredArgumentNotPassedException(Exception):
-    def __str__(self):
-        return "Required argument not passed"
-
-
-class IncorrectNumberOfHandlerArgsException(Exception):
-    def __str__(self):
-        return "Handler has incorrect number of arguments"
-
-
-class TriggerCannotContainSpacesException(Exception):
-    def __str__(self):
-        return "Command trigger cannot contain spaces"

mock/default_mock_app/main.py

@@ -1,9 +1,7 @@
 from argenta.app import App
-from argenta.app.defaults import PredeterminedMessages
-
+from argenta.orchestrator import Orchestrator
 
 app = App(repeat_command_groups=True)
 
-app.add_message_on_startup(PredeterminedMessages.USAGE + '\n\n')
-
-app.start_polling()
+orchestrator = Orchestrator()
+orchestrator.start_polling(app)

mock/local_test.py

@@ -1,14 +1,13 @@
-from argenta.app import App
-from argenta.command import Command
-from argenta.router import Router
+from argenta.command.flag.defaults import PredefinedFlags
 
 router = Router()
+flag = PredefinedFlags.SHORT_HELP
 
-@router.command(Command('test'))
-def test():
-    print('test command')
+@router.command(Command('test', flags=flag))
+def test(args: InputFlags):
+    print(f'help for {args.get_flag('h').get_name()} flag')
 
-app = App(ignore_command_register=False)
+app = App(override_system_messages=True,
+          print_func=print)
 app.include_router(router)
-app.set_unknown_command_handler(lambda command: print(f'Unknown command: {command.get_trigger()}'))
-app.start_polling()
+app.run_polling()

mock/mock_app/handlers/routers.py

@@ -1,35 +1,22 @@
 from rich.console import Console
 
 from argenta.command import Command
-from argenta.command.flag import Flags, InputFlags
-from argenta.command.flag.defaults import PredeterminedFlags
 from argenta.router import Router
-from .handlers_implementation.help_command import help_command
 
 
 work_router: Router = Router(title='Work points:')
 
-settings_router: Router = Router()
-
 console = Console()
 
 
 @work_router.command(Command('get', 'Get Help', aliases=['help', 'Get_help']))
 def command_help():
-    help_command()
+    pass
 
 
-@work_router.command(Command('start', 'Start Solving',
-                             flags=Flags(PredeterminedFlags.HOST, PredeterminedFlags.PORT),
-                             aliases=['starting']))
-def command_start_solving(args: InputFlags):
-    print(args.get_flag('host'))
-
-
-@settings_router.command(Command('update', 'Update WordMath'))
-def command_update():
-    print('eeeeeee')
-
+@work_router.command(Command('run', 'Run All'))
+def command_start_solving():
+    pass
 
 
 

mock/mock_app/main.py

@@ -1,24 +1,28 @@
-from mock.mock_app.handlers.routers import work_router, settings_router
+from mock.mock_app.handlers.routers import work_router
 
 from argenta.app import App
-from argenta.app.defaults import PredeterminedMessages
+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
+from argenta.orchestrator.argparser.arguments import BooleanArgument
 
 
-autocompleter = AutoCompleter('./mock/.hist')
+arg_parser = ArgParser(processed_args=[BooleanArgument('repeat')])
 app: App = App(dividing_line=DynamicDividingLine(),
-               autocompleter=autocompleter)
+               autocompleter=AutoCompleter('./mock/.hist'))
+orchestrator: Orchestrator = Orchestrator(arg_parser)
 
 
 def main():
-    app.include_routers(work_router, settings_router)
+    app.include_router(work_router)
 
-    app.add_message_on_startup(PredeterminedMessages.USAGE)
-    app.add_message_on_startup(PredeterminedMessages.AUTOCOMPLETE)
-    app.add_message_on_startup(PredeterminedMessages.HELP)
+    app.add_message_on_startup(PredefinedMessages.USAGE)
+    app.add_message_on_startup(PredefinedMessages.AUTOCOMPLETE)
+    app.add_message_on_startup(PredefinedMessages.HELP)
 
-    app.start_polling()
+    orchestrator.start_polling(app)
 
 if __name__ == "__main__":
     main()

pyproject.toml

@@ -1,15 +1,21 @@
 [project]
 name = "argenta"
-version = "0.5.0"
+version = "1.0.0-alpha1"
 description = "Python library for creating TUI"
-authors = [
-    {name = "kolo", email = "kolo.is.main@gmail.com"}
-]
-license = {text = "MIT"}
+authors = [{ name = "kolo", email = "kolo.is.main@gmail.com" }]
+requires-python = ">=3.11, <4.0"
 readme = "README.md"
-requires-python = ">=3.11"
-dependencies = ["rich (>=14.0.0,<15.0.0)", "art (>=6.4,<7.0)"]
+license = { text = "MIT" }
+dependencies = [
+    "rich (>=14.0.0,<15.0.0)",
+    "art (>=6.4,<7.0)",
+    "pyreadline3 (>=3.5.4,<4.0.0)",
+]
 
+[dependency-groups]
+dev = [
+    "pydoc-markdown>=4.8.2,<5",
+]
 
 [tool.ruff]
 exclude = [
@@ -21,11 +27,7 @@ exclude = [
     "tests"
     ]
 
-
 [build-system]
-requires = ["poetry-core>=2.0.0,<3.0.0"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.poetry.group.dev.dependencies]
-pyreadline3 = "^3.5.4"
+requires = ["hatchling"]
+build-backend = "hatchling.build"
 

src/argenta/app/autocompleter/entity.py

@@ -3,13 +3,25 @@ import readline
 
 
 class AutoCompleter:
-    def __init__(self, history_filename: str = False, autocomplete_button: str = 'tab'):
+    def __init__(self, history_filename: str = False, autocomplete_button: str = 'tab') -> None:
+        """
+        Public. Configures and implements auto-completion of input command
+        :param history_filename: the name of the file for saving the history of the autocompleter
+        :param autocomplete_button: the button for auto-completion
+        :return: None
+        """
         self.history_filename = history_filename
         self.autocomplete_button = autocomplete_button
-        self.matches = []
+        self.matches: list[str] = []
 
-    def complete(self, text, state):
-        matches = sorted(cmd for cmd in self.get_history_items() if cmd.startswith(text))
+    def complete(self, text, state) -> str | None:
+        """
+        Private. Auto-completion function
+        :param text: part of the command being entered
+        :param state: the current cursor position is relative to the beginning of the line
+        :return: the desired candidate as str or None
+        """
+        matches: list[str] = 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:]:
@@ -26,7 +38,12 @@ class AutoCompleter:
         else:
             return None
 
-    def initial_setup(self, all_commands: list[str]):
+    def initial_setup(self, all_commands: list[str]) -> None:
+        """
+        Private. Initial setup function
+        :param all_commands: Registered commands for adding them to the autocomplete history
+        :return: None
+        """
         if self.history_filename:
             if os.path.exists(self.history_filename):
                 readline.read_history_file(self.history_filename)
@@ -38,10 +55,18 @@ class AutoCompleter:
         readline.set_completer_delims(readline.get_completer_delims().replace(' ', ''))
         readline.parse_and_bind(f'{self.autocomplete_button}: complete')
 
-    def exit_setup(self):
+    def exit_setup(self) -> None:
+        """
+        Private. Exit setup function
+        :return: None
+        """
         if self.history_filename:
             readline.write_history_file(self.history_filename)
 
     @staticmethod
-    def get_history_items():
+    def get_history_items() -> list[str] | list:
+        """
+        Private. Returns a list of all commands entered by the user
+        :return: all commands entered by the user as list[str]
+        """
         return [readline.get_history_item(i) for i in range(1, readline.get_current_history_length() + 1)]

src/argenta/app/defaults.py

@@ -2,7 +2,10 @@ from dataclasses import dataclass
 
 
 @dataclass
-class PredeterminedMessages:
+class PredefinedMessages:
+    """
+    Public. A dataclass with predetermined messages for quick use
+    """
     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>'

src/argenta/app/dividing_line/models.py

@@ -0,0 +1,68 @@
+from abc import ABC
+
+
+class BaseDividingLine(ABC):
+    def __init__(self, unit_part: str = '-') -> None:
+        """
+        Private. The basic dividing line
+        :param unit_part: the single part of the dividing line
+        :return: None
+        """
+        self._unit_part = unit_part
+
+    def get_unit_part(self) -> str:
+        """
+        Private. Returns the unit part of the dividing line
+        :return: unit_part of dividing line as str
+        """
+        if len(self._unit_part) == 0:
+            return ' '
+        else:
+            return self._unit_part[0]
+
+
+class StaticDividingLine(BaseDividingLine):
+    def __init__(self, unit_part: str = '-', length: int = 25) -> None:
+        """
+        Public. The static dividing line
+        :param unit_part: the single part of the dividing line
+        :param length: the length of the dividing line
+        :return: None
+        """
+        super().__init__(unit_part)
+        self.length = length
+
+    def get_full_static_line(self, is_override: bool) -> str:
+        """
+        Private. Returns the full line of the dividing line
+        :param is_override: has the default text layout been redefined
+        :return: full line of dividing line as str
+        """
+        if is_override:
+            return f'\n{self.length * self.get_unit_part()}\n'
+        else:
+            return f'\n[dim]{self.length * self.get_unit_part()}[/dim]\n'
+
+
+class DynamicDividingLine(BaseDividingLine):
+    def __init__(self, unit_part: str = '-') -> None:
+        """
+        Public. The dynamic dividing line
+        :param unit_part: the single part of the dividing line
+        :return: None
+        """
+        super().__init__(unit_part)
+
+    def get_full_dynamic_line(self, length: int, is_override: bool) -> str:
+        """
+        Private. Returns the full line of the dividing line
+        :param length: the length of the dividing line
+        :param is_override: has the default text layout been redefined
+        :return: full line of dividing line as str
+        """
+        if is_override:
+            return f'\n{length * self.get_unit_part()}\n'
+        else:
+            return f'\n[dim]{self.get_unit_part() * length}[/dim]\n'
+
+

src/argenta/app/exceptions.py

@@ -1,10 +1,8 @@
-class NoRegisteredRoutersException(Exception):
-    def __str__(self):
-        return "No Registered Router Found"
-
-
 class NoRegisteredHandlersException(Exception):
-    def __init__(self, router_name):
+    """
+    The router has no registered handlers
+    """
+    def __init__(self, router_name) -> None:
         self.router_name = router_name
     def __str__(self):
         return f"No Registered Handlers Found For '{self.router_name}'"

src/argenta/app/models.py

@@ -0,0 +1,393 @@
+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
+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 NoRegisteredHandlersException
+from argenta.app.registered_routers.entity import RegisteredRouters
+
+
+
+class BaseApp:
+    def __init__(self,
+                 prompt: str,
+                 initial_message: str,
+                 farewell_message: str,
+                 exit_command: Command,
+                 system_router_title: str | None,
+                 ignore_command_register: bool,
+                 dividing_line: StaticDividingLine | DynamicDividingLine,
+                 repeat_command_groups: bool,
+                 override_system_messages: bool,
+                 autocompleter: AutoCompleter,
+                 print_func: Callable[[str], None]) -> None:
+
+        self._prompt = prompt
+        self._print_func = print_func
+        self._exit_command = exit_command
+        self._system_router_title = system_router_title
+        self._dividing_line = dividing_line
+        self._ignore_command_register = ignore_command_register
+        self._repeat_command_groups_description = repeat_command_groups
+        self._override_system_messages = override_system_messages
+        self._autocompleter = autocompleter
+
+        self._farewell_message = farewell_message
+        self._initial_message = initial_message
+
+
+        self._description_message_gen: Callable[[str, str], str] = lambda command, description: f'[{command}] *=*=* {description}'
+        self._registered_routers: RegisteredRouters = RegisteredRouters()
+        self._messages_on_startup: list[str] = []
+
+        self._all_registered_triggers_in_lower: list[str] = []
+        self._all_registered_triggers_in_default_case: list[str] = []
+
+        self._invalid_input_flags_handler: Callable[[str], None] = lambda raw_command: print_func(f'Incorrect flag syntax: {raw_command}')
+        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)
+
+
+    def set_description_message_pattern(self, pattern: Callable[[str, str], str]) -> None:
+        """
+        Public. Sets the output pattern of the available commands
+        :param pattern: output pattern of the available commands
+        :return: None
+        """
+        self._description_message_gen: Callable[[str, str], str] = pattern
+
+
+    def set_invalid_input_flags_handler(self, handler: Callable[[str], None]) -> None:
+        """
+        Public. Sets the handler for incorrect flags when entering a command
+        :param handler: handler for incorrect flags when entering a command
+        :return: None
+        """
+        self._invalid_input_flags_handler = handler
+
+
+    def set_repeated_input_flags_handler(self, handler: Callable[[str], None]) -> None:
+        """
+        Public. Sets the handler for repeated flags when entering a command
+        :param handler: handler for repeated flags when entering a command
+        :return: None
+        """
+        self._repeated_input_flags_handler = handler
+
+
+    def set_unknown_command_handler(self, handler: Callable[[str], None]) -> None:
+        """
+        Public. Sets the handler for unknown commands when entering a command
+        :param handler: handler for unknown commands when entering a command
+        :return: None
+        """
+        self._unknown_command_handler = handler
+
+
+    def set_empty_command_handler(self, handler: Callable[[], None]) -> None:
+        """
+        Public. Sets the handler for empty commands when entering a command
+        :param handler: handler for empty commands when entering a command
+        :return: None
+        """
+        self._empty_input_command_handler = handler
+
+
+    def set_exit_command_handler(self, handler: Callable[[], None]) -> None:
+        """
+        Public. Sets the handler for exit command when entering a command
+        :param handler: handler for exit command when entering a command
+        :return: None
+        """
+        self._exit_command_handler = handler
+
+
+    def _print_command_group_description(self) -> None:
+        """
+        Private. Prints the description of the available commands
+        :return: None
+        """
+        for registered_router in self._registered_routers:
+            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_gen(
+                        command_handler.get_handled_command().get_trigger(),
+                        command_handler.get_handled_command().get_description()))
+            self._print_func('')
+
+
+    def _print_framed_text(self, text: str) -> None:
+        """
+        Private. Outputs text by framing it in a static or dynamic split strip
+        :param text: framed text
+        :return: None
+        """
+        if isinstance(self._dividing_line, StaticDividingLine):
+            self._print_func(self._dividing_line.get_full_static_line(self._override_system_messages))
+            self._print_func(text)
+            self._print_func(self._dividing_line.get_full_static_line(self._override_system_messages))
+
+        elif isinstance(self._dividing_line, DynamicDividingLine):
+            clear_text = re.sub(r'\u001b\[[0-9;]*m', '', text)
+            max_length_line = max([len(line) for line in clear_text.split('\n')])
+            max_length_line = max_length_line if 10 <= max_length_line <= 80 else 80 if max_length_line > 80 else 10
+
+            self._print_func(self._dividing_line.get_full_dynamic_line(max_length_line, self._override_system_messages))
+            print(text.strip('\n'))
+            self._print_func(self._dividing_line.get_full_dynamic_line(max_length_line, self._override_system_messages))
+
+
+    def _is_exit_command(self, command: InputCommand) -> bool:
+        """
+        Private. Checks if the given command is an exit command
+        :param command: command to check
+        :return: is it an exit command or not as bool
+        """
+        if self._ignore_command_register:
+            if command.get_trigger().lower() == self._exit_command.get_trigger().lower():
+                return True
+            elif command.get_trigger().lower() in [x.lower() for x in self._exit_command.get_aliases()]:
+                return True
+        else:
+            if command.get_trigger() == self._exit_command.get_trigger():
+                return True
+            elif command.get_trigger() in self._exit_command.get_aliases():
+                return True
+        return False
+
+
+    def _is_unknown_command(self, command: InputCommand) -> bool:
+        """
+        Private. Checks if the given command is an unknown command
+        :param command: command to check
+        :return: is it an unknown command or not as bool
+        """
+        input_command_trigger = command.get_trigger()
+        if self._ignore_command_register:
+            if input_command_trigger.lower() in self._all_registered_triggers_in_lower:
+                return False
+        else:
+            if input_command_trigger in self._all_registered_triggers_in_default_case:
+                return False
+
+        with redirect_stdout(io.StringIO()) as f:
+            self._unknown_command_handler(command)
+            res: str = f.getvalue()
+        self._print_framed_text(res)
+        return True
+
+
+    def _error_handler(self, error: BaseInputCommandException, raw_command: str) -> None:
+        """
+        Private. Handles parsing errors of the entered command
+        :param error: error being handled
+        :param raw_command: the raw input command
+        :return: None
+        """
+        match error:
+            case UnprocessedInputFlagException():
+                self._invalid_input_flags_handler(raw_command)
+            case RepeatedInputFlagsException():
+                self._repeated_input_flags_handler(raw_command)
+            case EmptyInputCommandException():
+                self._empty_input_command_handler()
+
+
+    def _validate_included_routers(self) -> None:
+        """
+        Private. Validates included routers
+        :return: None
+        """
+        for router in self._registered_routers:
+            if not router.get_command_handlers():
+                raise NoRegisteredHandlersException(router.get_name())
+
+
+    def _setup_system_router(self) -> None:
+        """
+        Private. Sets up system router
+        :return: None
+        """
+        system_router.set_title(self._system_router_title)
+
+        @system_router.command(self._exit_command)
+        def exit_command():
+            self._exit_command_handler()
+
+        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 _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())}")
+
+
+    def _pre_cycle_setup(self) -> None:
+        """
+        Private. Configures various aspects of the application before the start of the cycle
+        :return: None
+        """
+        self._setup_default_view()
+        self._setup_system_router()
+        self._validate_included_routers()
+
+        for router_entity in self._registered_routers:
+            self._all_registered_triggers_in_default_case.extend(router_entity.get_triggers())
+            self._all_registered_triggers_in_default_case.extend(router_entity.get_aliases())
+
+            self._all_registered_triggers_in_lower.extend([x.lower() for x in router_entity.get_triggers()])
+            self._all_registered_triggers_in_lower.extend([x.lower() for x in router_entity.get_aliases()])
+
+        self._autocompleter.initial_setup(self._all_registered_triggers_in_lower)
+
+        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')
+
+        if not self._repeat_command_groups_description:
+            self._print_command_group_description()
+
+
+
+class App(BaseApp):
+    def __init__(self,
+                 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: Command = Command('Q', 'Exit command'),
+                 system_router_title: str | None = 'System points:',
+                 ignore_command_register: bool = True,
+                 dividing_line: StaticDividingLine | DynamicDividingLine = StaticDividingLine(),
+                 repeat_command_groups: bool = True,
+                 override_system_messages: bool = False,
+                 autocompleter: AutoCompleter = AutoCompleter(),
+                 print_func: Callable[[str], None] = Console().print) -> None:
+        """
+        Public. The essence of the application itself.
+        Configures and manages all aspects of the behavior and presentation of the user interacting with the user
+        :param prompt: displayed before entering the command
+        :param initial_message: displayed at the start of the app
+        :param farewell_message: displayed at the end of the app
+        :param exit_command: the entity of the command that will be terminated when entered
+        :param system_router_title: system router title
+        :param ignore_command_register: whether to ignore the case of the entered commands
+        :param dividing_line: the entity of the dividing line
+        :param repeat_command_groups: whether to repeat the available commands and their description
+        :param override_system_messages: whether to redefine the default formatting of system messages
+        :param autocompleter: the entity of the autocompleter
+        :param print_func: system messages text output function
+        :return: None
+        """
+        super().__init__(prompt=prompt,
+                         initial_message=initial_message,
+                         farewell_message=farewell_message,
+                         exit_command=exit_command,
+                         system_router_title=system_router_title,
+                         ignore_command_register=ignore_command_register,
+                         dividing_line=dividing_line,
+                         repeat_command_groups=repeat_command_groups,
+                         override_system_messages=override_system_messages,
+                         autocompleter=autocompleter,
+                         print_func=print_func)
+
+
+    def run_polling(self) -> None:
+        """
+        Private. Starts the user input processing cycle
+        :return: None
+        """
+        self._pre_cycle_setup()
+        while True:
+            if self._repeat_command_groups_description:
+                self._print_command_group_description()
+
+            raw_command: str = Console().input(self._prompt)
+
+            try:
+                input_command: InputCommand = InputCommand.parse(raw_command=raw_command)
+            except BaseInputCommandException as error:
+                with redirect_stdout(io.StringIO()) as f:
+                    self._error_handler(error, raw_command)
+                    res: str = f.getvalue()
+                self._print_framed_text(res)
+                continue
+
+            if self._is_exit_command(input_command):
+                system_router.finds_appropriate_handler(input_command)
+                self._autocompleter.exit_setup()
+                return
+
+            if self._is_unknown_command(input_command):
+                continue
+
+            with redirect_stdout(io.StringIO()) as f:
+                for registered_router in self._registered_routers:
+                    registered_router.finds_appropriate_handler(input_command)
+                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:
+        """
+        Public. Registers the router in the application
+        :param router: registered router
+        :return: None
+        """
+        router.set_command_register_ignore(self._ignore_command_register)
+        self._registered_routers.add_registered_router(router)
+
+
+    def include_routers(self, *routers: Router) -> None:
+        """
+        Public. Registers the routers in the application
+        :param routers: registered routers
+        :return: None
+        """
+        for router in routers:
+            self.include_router(router)
+
+
+    def add_message_on_startup(self, message: str) -> None:
+        """
+        Public. Adds a message that will be displayed when the application is launched
+        :param message: the message being added
+        :return: None
+        """
+        self._messages_on_startup.append(message)
+

src/argenta/app/registered_routers/entity.py

@@ -0,0 +1,40 @@
+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) -> 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) -> None:
+        """
+        Private. Adds new registered routers
+        :param routers: registered routers
+        :return: None
+        """
+        self._registered_routers.extend(routers)
+
+    def __iter__(self):
+        return iter(self._registered_routers)
+
+    def __next__(self):
+        return next(iter(self._registered_routers))

src/argenta/command/exceptions.py

@@ -2,15 +2,24 @@ from argenta.command.flag.models import InputFlag, Flag
 
 
 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):
@@ -19,5 +28,8 @@ class RepeatedInputFlagsException(BaseInputCommandException):
 
 
 class EmptyInputCommandException(BaseInputCommandException):
+    """
+    Private. Raised when an empty input command is detected
+    """
     def __str__(self):
         return "Input Command is empty"

src/argenta/command/flag/defaults.py

@@ -4,18 +4,21 @@ import re
 
 
 @dataclass
-class PredeterminedFlags:
+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)
+    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)
+    SHORT_INFO = Flag(name='I', prefix='-', possible_values=False)
 
     ALL = Flag(name='all', possible_values=False)
-    SHORT_ALL = Flag(name='a', prefix='-', possible_values=False)
+    SHORT_ALL = Flag(name='A', 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}$'))
+    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}$'))
+    SHORT_PORT = Flag(name='P', prefix='-', possible_values=re.compile(r'^\d{1,5}$'))

src/argenta/command/flag/models.py

@@ -2,20 +2,38 @@ from typing import Literal, Pattern
 from abc import ABC, abstractmethod
 
 
-class BaseFlag:
+class BaseFlag(ABC):
     def __init__(self, name: str,
-                 prefix: Literal['-', '--', '---'] = '--'):
+                 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
 
 
@@ -24,13 +42,29 @@ 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
 
 
@@ -38,11 +72,23 @@ class InputFlag(BaseFlag):
 class Flag(BaseFlag):
     def __init__(self, name: str,
                  prefix: Literal['-', '--', '---'] = '--',
-                 possible_values: list[str] | Pattern[str] | False = True):
+                 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
@@ -69,22 +115,44 @@ class Flag(BaseFlag):
 
 
 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]):
+        """
+        Public. Adds a list of flags to the list of flags
+        :param flags: list of flags to add
+        :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):
@@ -100,6 +168,11 @@ class BaseFlags(ABC):
 
 class Flags(BaseFlags, ABC):
     def __init__(self, *flags: Flag):
+        """
+        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[Flag]:
@@ -121,6 +194,11 @@ class Flags(BaseFlags, ABC):
 
 class InputFlags(BaseFlags, ABC):
     def __init__(self, *flags: InputFlag):
+        """
+        Public. A model that combines the input flags of the input command
+        :param flags: all input flags
+        :return: None
+        """
         self._flags = flags if flags else []
 
     def get_flags(self) -> list[InputFlag]:

src/argenta/command/models.py

@@ -1,7 +1,7 @@
 from argenta.command.flag.models import Flag, InputFlag, Flags, InputFlags
 from argenta.command.exceptions import (UnprocessedInputFlagException,
-                                         RepeatedInputFlagsException,
-                                         EmptyInputCommandException)
+                                        RepeatedInputFlagsException,
+                                        EmptyInputCommandException)
 from typing import Generic, TypeVar, cast, Literal
 
 
@@ -9,10 +9,18 @@ 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
 
 
@@ -21,18 +29,38 @@ class Command(BaseCommand):
                  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._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) -> bool:
+        """
+        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):
@@ -49,6 +77,10 @@ class Command(BaseCommand):
         return False
 
     def get_description(self) -> str:
+        """
+        Private. Returns the description of the command
+        :return: the description of the command as str
+        """
         return self._description
 
 
@@ -56,18 +88,38 @@ class Command(BaseCommand):
 class InputCommand(BaseCommand, Generic[InputCommandType]):
     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):
+    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()
 

src/argenta/orchestrator/__init__.py

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

src/argenta/orchestrator/argparser/__init__.py

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

src/argenta/orchestrator/argparser/arguments/__init__.py

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

src/argenta/orchestrator/argparser/arguments/models.py

@@ -0,0 +1,55 @@
+from abc import ABC, abstractmethod
+from typing import Literal
+
+
+class BaseArgument(ABC):
+    """
+    Private. Base class for all arguments
+    """
+    @abstractmethod
+    def get_string_entity(self) -> str:
+        """
+        Public. Returns the string representation of the argument
+        :return: the string representation as a str
+        """
+        pass
+
+
+class PositionalArgument(BaseArgument):
+    def __init__(self, name: str):
+        """
+        Public. Required argument at startup
+        :param name: name of the argument, must not start with minus (-)
+        """
+        self.name = name
+
+    def get_string_entity(self):
+        return self.name
+
+
+class OptionalArgument(BaseArgument):
+    def __init__(self, name: str, prefix: Literal['-', '--', '---'] = '--'):
+        """
+        Public. Optional argument, must have the value
+        :param name: name of the argument
+        :param prefix: prefix of the argument
+        """
+        self.name = name
+        self.prefix = prefix
+
+    def get_string_entity(self):
+        return self.prefix + self.name
+
+
+class BooleanArgument(BaseArgument):
+    def __init__(self, name: str, prefix: Literal['-', '--', '---'] = '--'):
+        """
+        Public. Boolean argument, does not require a value
+        :param name: name of the argument
+        :param prefix: prefix of the argument
+        """
+        self.name = name
+        self.prefix = prefix
+
+    def get_string_entity(self):
+        return self.prefix + self.name

src/argenta/orchestrator/argparser/entity.py

@@ -0,0 +1,49 @@
+from argparse import ArgumentParser
+
+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:
+        """
+        Public. Cmd argument parser and configurator at startup
+        :param name: the name of the ArgParse instance
+        :param description: the description of the ArgParse instance
+        :param epilog: the epilog of the ArgParse instance
+        :param processed_args: registered and processed arguments
+        """
+        self.name = name
+        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
+
+    def set_args(self, *args: PositionalArgument | OptionalArgument | BooleanArgument) -> None:
+        """
+        Public. Sets the arguments to be processed
+        :param args: processed arguments
+        :return: None
+        """
+        self.args.extend(args)
+
+    def register_args(self) -> None:
+        """
+        Private. Registers initialized command line arguments
+        :return: None
+        """
+        if not self.args:
+            return
+        for arg in self.args:
+            if type(arg) is PositionalArgument:
+                self.entity.add_argument(arg.get_string_entity())
+            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')

src/argenta/orchestrator/entity.py

@@ -0,0 +1,36 @@
+from argparse import Namespace
+
+from argenta.app import App
+from argenta.orchestrator.argparser import ArgParser
+
+
+class Orchestrator:
+    def __init__(self, arg_parser: ArgParser = False):
+        """
+        Public. An orchestrator and configurator that defines the behavior of an integrated system, one level higher than the App
+        :param arg_parser: Cmd argument parser and configurator at startup
+        :return: None
+        """
+        self.arg_parser: ArgParser | False = arg_parser
+        if arg_parser:
+            self.arg_parser.register_args()
+
+    @staticmethod
+    def start_polling(app: App) -> None:
+        """
+        Public. Starting the user input processing cycle
+        :param app: a running application
+        :return: None
+        """
+        app.run_polling()
+
+    def get_input_args(self) -> Namespace | None:
+        """
+        Public. Returns the arguments parsed
+        :return: None
+        """
+        if self.arg_parser:
+            return self.arg_parser.entity.parse_args()
+        else:
+            return None
+        

src/argenta/router/__init__.py

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

src/argenta/router/command_handler/entity.py

@@ -0,0 +1,79 @@
+from typing import Callable
+
+from argenta.command import Command
+from argenta.command.flag import InputFlags
+
+
+
+class CommandHandler:
+    def __init__(self, handler: Callable[[], None] | Callable[[InputFlags], None], handled_command: Command):
+        """
+        Private. Entity of the model linking the handler and the command being processed
+        :param handler: the handler being called
+        :param handled_command: the command being processed
+        """
+        self._handler = handler
+        self._handled_command = handled_command
+
+    def handling(self, input_flags: InputFlags = None) -> None:
+        """
+        Private. Direct processing of an input command
+        :param input_flags: the flags of the input command
+        :return: None
+        """
+        if input_flags is not None:
+            self._handler(input_flags)
+        else:
+            self._handler()
+
+    def get_handler(self) -> Callable[[], None] | Callable[[InputFlags], None]:
+        """
+        Private. Returns the handler being called
+        :return: the handler being called as Callable[[], None] or Callable[[InputFlags], None]
+        """
+        return self._handler
+
+    def get_handled_command(self) -> Command:
+        """
+        Private. Returns the command being processed
+        :return: the command being processed as Command
+        """
+        return self._handled_command
+
+
+class CommandHandlers:
+    def __init__(self, command_handlers: list[CommandHandler] = None):
+        """
+        Private. The model that unites all CommandHandler of the routers
+        :param command_handlers: list of CommandHandlers for register
+        """
+        self.command_handlers = command_handlers if command_handlers else []
+
+    def get_command_handlers(self) -> list[CommandHandler]:
+        """
+        Private. Returns the list of CommandHandlers
+        :return: the list of CommandHandlers as list[CommandHandler]
+        """
+        return self.command_handlers
+
+    def add_command_handler(self, command_handler: CommandHandler) -> None:
+        """
+        Private. Adds a CommandHandler to the list of CommandHandlers
+        :param command_handler: CommandHandler to be added
+        :return: None
+        """
+        self.command_handlers.append(command_handler)
+
+    def add_command_handlers(self, *command_handlers: CommandHandler) -> None:
+        """
+        Private. Extend a many CommandHandler to the list of CommandHandlers
+        :param command_handlers: many CommandHandler to be added
+        :return: None
+        """
+        self.command_handlers.extend(command_handlers)
+
+    def __iter__(self):
+        return iter(self.command_handlers)
+
+    def __next__(self):
+        return next(iter(self.command_handlers))

src/argenta/router/defaults.py

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

src/argenta/router/entity.py

@@ -0,0 +1,204 @@
+from typing import Callable
+from inspect import getfullargspec
+from src.argenta.command import Command
+from src.argenta.command.models import InputCommand
+from src.argenta.router.command_handler.entity import CommandHandlers, CommandHandler
+from src.argenta.command.flag.models import Flag, Flags, InputFlags
+from src.argenta.router.exceptions import (RepeatedFlagNameException,
+                                           TooManyTransferredArgsException,
+                                           RequiredArgumentNotPassedException,
+                                           TriggerContainSpacesException)
+
+
+class Router:
+    def __init__(self,
+                 title: str = None):
+        """
+        Public. Directly configures and manages handlers
+        :param title: the title of the router, displayed when displaying the available commands
+        :return: None
+        """
+        self._title = title
+
+        self._command_handlers: CommandHandlers = CommandHandlers()
+        self._ignore_command_register: bool = False
+        self._not_valid_flag_handler: Callable[[Flag], None] = lambda flag: print(f"Undefined or incorrect input flag: {flag.get_string_entity()}{(' '+flag.get_value()) if flag.get_value() else ''}")
+
+
+    def command(self, command: Command) -> Callable:
+        """
+        Public. Registers handler
+        :param command: Registered command
+        :return: decorated handler as Callable[[Any], Any]
+        """
+        self._validate_command(command)
+
+        def command_decorator(func):
+            Router._validate_func_args(command, func)
+            self._command_handlers.add_command_handler(CommandHandler(func, command))
+
+            def wrapper(*args, **kwargs):
+                return func(*args, **kwargs)
+            return wrapper
+
+        return command_decorator
+
+
+    def set_invalid_input_flag_handler(self, func: Callable[[Flag], None]) -> None:
+        """
+        Public. Registers handler for invalid input flag
+        :param func: registered handler
+        :return: None
+        """
+        self._not_valid_flag_handler = func
+
+
+    def finds_appropriate_handler(self, input_command: InputCommand) -> None:
+        """
+        Private. Finds the appropriate handler for given input command and passes control to it
+        :param input_command: input command as InputCommand
+        :return: None
+        """
+        input_command_name: str = input_command.get_trigger()
+        input_command_flags: InputFlags = input_command.get_input_flags()
+
+        for command_handler in self._command_handlers:
+            handle_command = command_handler.get_handled_command()
+            if input_command_name.lower() == handle_command.get_trigger().lower():
+                self.process_input_command(input_command_flags, command_handler)
+            if input_command_name.lower() in handle_command.get_aliases():
+                self.process_input_command(input_command_flags, command_handler)
+
+
+    def process_input_command(self, input_command_flags: InputFlags, command_handler: CommandHandler) -> None:
+        """
+        Private. Processes input command with the appropriate handler
+        :param input_command_flags: input command flags as InputFlags
+        :param command_handler: command handler for input command as CommandHandler
+        :return: None
+        """
+        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, handled_command: Command, input_flags: InputFlags) -> bool:
+        """
+        Private. Validates flags of input command
+        :param handled_command: entity of the handled command
+        :param input_flags:
+        :return: is flags of input command valid as bool
+        """
+        for flag in input_flags:
+            is_valid: bool = handled_command.validate_input_flag(flag)
+            if not is_valid:
+                self._not_valid_flag_handler(flag)
+                return False
+        return True
+
+
+    @staticmethod
+    def _validate_command(command: Command) -> None:
+        """
+        Private. Validates the command registered in handler
+        :param command: validated command
+        :return: None if command is valid else raise exception
+        """
+        command_name: str = command.get_trigger()
+        if command_name.find(' ') != -1:
+            raise TriggerContainSpacesException()
+
+        flags: Flags = command.get_registered_flags()
+        if flags:
+            flags_name: list = [x.get_string_entity().lower() for x in flags]
+            if len(set(flags_name)) < len(flags_name):
+                raise RepeatedFlagNameException()
+
+
+    @staticmethod
+    def _validate_func_args(command: Command, func: Callable) -> None:
+        """
+        Private. Validates the arguments of the handler
+        :param command: registered command in handler
+        :param func: entity of the handler func
+        :return: None if func is valid else raise exception
+        """
+        registered_args = command.get_registered_flags()
+        transferred_args = getfullargspec(func).args
+        if registered_args.get_flags() and transferred_args:
+           if len(transferred_args) != 1:
+                raise TooManyTransferredArgsException()
+        elif registered_args.get_flags() and not transferred_args:
+            raise RequiredArgumentNotPassedException()
+        elif not registered_args.get_flags() and transferred_args:
+            raise TooManyTransferredArgsException()
+
+
+    def set_command_register_ignore(self, _: bool) -> None:
+        """
+        Private. Sets the router behavior on the input commands register
+        :param _: is command register ignore
+        :return: None
+        """
+        self._ignore_command_register = _
+
+
+    def get_triggers(self) -> list[str]:
+        """
+        Public. Gets registered triggers
+        :return: registered in router triggers as list[str]
+        """
+        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) -> list[str]:
+        """
+        Public. Gets registered aliases
+        :return: registered in router aliases as list[str]
+        """
+        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:
+        """
+        Private. Gets registered command handlers
+        :return: registered command handlers as CommandHandlers
+        """
+        return self._command_handlers
+
+
+    def get_title(self) -> str | None:
+        """
+        Public. Gets title of the router
+        :return: the title of the router as str or None
+        """
+        return self._title
+
+
+    def set_title(self, title: str) -> None:
+        """
+        Public. Sets the title of the router
+        :param title: title that will be setted
+        :return: None
+        """
+        self._title = title

src/argenta/router/exceptions.py

@@ -0,0 +1,30 @@
+class RepeatedFlagNameException(Exception):
+    """
+    Private. Raised when a repeated flag name is registered
+    """
+    def __str__(self):
+        return "Repeated registered flag names in register command"
+
+
+class TooManyTransferredArgsException(Exception):
+    """
+    Private. Raised when too many arguments are passed
+    """
+    def __str__(self):
+        return "Too many transferred arguments"
+
+
+class RequiredArgumentNotPassedException(Exception):
+    """
+    Private. Raised when a required argument is not passed
+    """
+    def __str__(self):
+        return "Required argument not passed"
+
+
+class TriggerContainSpacesException(Exception):
+    """
+    Private. Raised when there is a space in the trigger being registered
+    """
+    def __str__(self):
+        return "Command trigger cannot contain spaces"

tests/system_tests/test_system_handling_non_standard_behavior.py

@@ -8,7 +8,7 @@ from argenta.app import App
 from argenta.command import Command
 from argenta.router import Router
 from argenta.command.flag.models import Flags, InputFlags
-from argenta.command.flag.defaults import PredeterminedFlags
+from argenta.command.flag.defaults import PredefinedFlags
 
 
 
@@ -26,7 +26,7 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
                   print_func=print)
         app.include_router(router)
         app.set_unknown_command_handler(lambda command: print(f'Unknown command: {command.get_trigger()}'))
-        app.start_polling()
+        app.run_polling()
 
         output = mock_stdout.getvalue()
 
@@ -47,7 +47,7 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
                   print_func=print)
         app.include_router(router)
         app.set_unknown_command_handler(lambda command: print(f'Unknown command: {command.get_trigger()}'))
-        app.start_polling()
+        app.run_polling()
 
         output = mock_stdout.getvalue()
 
@@ -66,7 +66,7 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
         app = App(override_system_messages=True,
                   print_func=print)
         app.include_router(router)
-        app.start_polling()
+        app.run_polling()
 
         output = mock_stdout.getvalue()
 
@@ -85,7 +85,7 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
         app = App(override_system_messages=True,
                   print_func=print)
         app.include_router(router)
-        app.start_polling()
+        app.run_polling()
 
         output = mock_stdout.getvalue()
 
@@ -96,7 +96,7 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
     @patch("sys.stdout", new_callable=io.StringIO)
     def test_input_correct_command_with_one_correct_flag_an_one_incorrect_flag(self, mock_stdout: _io.StringIO, magick_mock: MagicMock):
         router = Router()
-        flags = Flags(PredeterminedFlags.HOST)
+        flags = Flags(PredefinedFlags.HOST)
 
         @router.command(Command('test', flags=flags))
         def test(args: InputFlags):
@@ -105,7 +105,7 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
         app = App(override_system_messages=True,
                   print_func=print)
         app.include_router(router)
-        app.start_polling()
+        app.run_polling()
 
         output = mock_stdout.getvalue()
 
@@ -125,7 +125,7 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
                   print_func=print)
         app.include_router(router)
         app.set_unknown_command_handler(lambda command: print(f'Unknown command: {command.get_trigger()}'))
-        app.start_polling()
+        app.run_polling()
 
         output = mock_stdout.getvalue()
 
@@ -149,7 +149,7 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
                   print_func=print)
         app.include_router(router)
         app.set_unknown_command_handler(lambda command: print(f'Unknown command: {command.get_trigger()}'))
-        app.start_polling()
+        app.run_polling()
 
         output = mock_stdout.getvalue()
 
@@ -169,7 +169,7 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
                   print_func=print)
         app.include_router(router)
         app.set_invalid_input_flags_handler(lambda command: print(f'Incorrect flag syntax: "{command}"'))
-        app.start_polling()
+        app.run_polling()
 
         output = mock_stdout.getvalue()
 
@@ -189,7 +189,7 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
                   print_func=print)
         app.include_router(router)
         app.set_empty_command_handler(lambda: print('Empty input command'))
-        app.start_polling()
+        app.run_polling()
 
         output = mock_stdout.getvalue()
 
@@ -201,7 +201,7 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
     def test_input_correct_command_with_repeated_flags(self, mock_stdout: _io.StringIO, magick_mock: MagicMock):
         router = Router()
 
-        @router.command(Command('test', flags=PredeterminedFlags.PORT))
+        @router.command(Command('test', flags=PredefinedFlags.PORT))
         def test(args: InputFlags):
             print('test command')
 
@@ -209,7 +209,7 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
                   print_func=print)
         app.include_router(router)
         app.set_repeated_input_flags_handler(lambda command: print(f'Repeated input flags: "{command}"'))
-        app.start_polling()
+        app.run_polling()
 
         output = mock_stdout.getvalue()
 

tests/system_tests/test_system_handling_normal_behavior.py

@@ -8,7 +8,7 @@ from argenta.app import App
 from argenta.command.models import Command
 from argenta.router import Router
 from argenta.command.flag.models import Flag, Flags, InputFlags
-from argenta.command.flag.defaults import PredeterminedFlags
+from argenta.command.flag.defaults import PredefinedFlags
 
 
 
@@ -25,7 +25,7 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
         app = App(override_system_messages=True,
                   print_func=print)
         app.include_router(router)
-        app.start_polling()
+        app.run_polling()
 
         output = mock_stdout.getvalue()
 
@@ -45,7 +45,7 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
                   override_system_messages=True,
                   print_func=print)
         app.include_router(router)
-        app.start_polling()
+        app.run_polling()
 
         output = mock_stdout.getvalue()
 
@@ -65,7 +65,7 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
         app = App(override_system_messages=True,
                   print_func=print)
         app.include_router(router)
-        app.start_polling()
+        app.run_polling()
 
         output = mock_stdout.getvalue()
 
@@ -84,38 +84,38 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
         app = App(override_system_messages=True,
                   print_func=print)
         app.include_router(router)
-        app.start_polling()
+        app.run_polling()
 
         output = mock_stdout.getvalue()
 
         self.assertIn('\nflag value for port flag : 22\n', output)
 
 
-    @patch("builtins.input", side_effect=["test -h", "q"])
+    @patch("builtins.input", side_effect=["test -H", "q"])
     @patch("sys.stdout", new_callable=io.StringIO)
     def test_input_correct_command_with_default_flag(self, mock_stdout: _io.StringIO, magick_mock: MagicMock):
         router = Router()
-        flag = PredeterminedFlags.SHORT_HELP
+        flag = PredefinedFlags.SHORT_HELP
 
         @router.command(Command('test', flags=flag))
         def test(args: InputFlags):
-            print(f'help for {args.get_flag('h').get_name()} flag')
+            print(f'help for {args.get_flag('H').get_name()} flag')
 
         app = App(override_system_messages=True,
                   print_func=print)
         app.include_router(router)
-        app.start_polling()
+        app.run_polling()
 
         output = mock_stdout.getvalue()
 
-        self.assertIn('\nhelp for h flag\n', output)
+        self.assertIn('\nhelp for H flag\n', output)
 
 
     @patch("builtins.input", side_effect=["test --info", "q"])
     @patch("sys.stdout", new_callable=io.StringIO)
     def test_input_correct_command_with_default_flag2(self, mock_stdout: _io.StringIO, magick_mock: MagicMock):
         router = Router()
-        flag = PredeterminedFlags.INFO
+        flag = PredefinedFlags.INFO
 
         @router.command(Command('test', flags=flag))
         def test(args: InputFlags):
@@ -125,7 +125,7 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
         app = App(override_system_messages=True,
                   print_func=print)
         app.include_router(router)
-        app.start_polling()
+        app.run_polling()
 
         output = mock_stdout.getvalue()
 
@@ -136,7 +136,7 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
     @patch("sys.stdout", new_callable=io.StringIO)
     def test_input_correct_command_with_default_flag3(self, mock_stdout: _io.StringIO, magick_mock: MagicMock):
         router = Router()
-        flag = PredeterminedFlags.HOST
+        flag = PredefinedFlags.HOST
 
         @router.command(Command('test', flags=flag))
         def test(args: InputFlags):
@@ -145,7 +145,7 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
         app = App(override_system_messages=True,
                   print_func=print)
         app.include_router(router)
-        app.start_polling()
+        app.run_polling()
 
         output = mock_stdout.getvalue()
 
@@ -156,7 +156,7 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
     @patch("sys.stdout", new_callable=io.StringIO)
     def test_input_correct_command_with_two_flags(self, mock_stdout: _io.StringIO, magick_mock: MagicMock):
         router = Router()
-        flags = Flags(PredeterminedFlags.HOST, PredeterminedFlags.PORT)
+        flags = Flags(PredefinedFlags.HOST, PredefinedFlags.PORT)
 
         @router.command(Command('test', flags=flags))
         def test(args: InputFlags):
@@ -165,7 +165,7 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
         app = App(override_system_messages=True,
                   print_func=print)
         app.include_router(router)
-        app.start_polling()
+        app.run_polling()
 
         output = mock_stdout.getvalue()
 
@@ -188,7 +188,7 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
         app = App(override_system_messages=True,
                   print_func=print)
         app.include_router(router)
-        app.start_polling()
+        app.run_polling()
 
         output = mock_stdout.getvalue()
 
@@ -215,7 +215,7 @@ class TestSystemHandlerNormalWork(unittest.TestCase):
         app = App(override_system_messages=True,
                   print_func=print)
         app.include_router(router)
-        app.start_polling()
+        app.run_polling()
 
         output = mock_stdout.getvalue()
 

tests/unit_tests/test_command.py

@@ -1,4 +1,5 @@
-from argenta.command.models import InputCommand
+from argenta.command.flag import Flag, InputFlag, Flags
+from argenta.command.models import InputCommand, Command
 from argenta.command.exceptions import (UnprocessedInputFlagException,
                                         RepeatedInputFlagsException,
                                         EmptyInputCommandException)
@@ -22,3 +23,11 @@ class TestInputCommand(unittest.TestCase):
         with self.assertRaises(EmptyInputCommandException):
             InputCommand.parse('')
 
+    def test_validate_correct_input_flag1(self):
+        command = Command('some', flags=Flag('test'))
+        self.assertEqual(command.validate_input_flag(InputFlag('test')), True)
+
+    def test_validate_correct_input_flag2(self):
+        command = Command('some', flags=Flags(Flag('test'), Flag('more')))
+        self.assertEqual(command.validate_input_flag(InputFlag('more')), True)
+

tests/unit_tests/test_dividing_line.py

@@ -6,11 +6,11 @@ import unittest
 class TestDividingLine(unittest.TestCase):
     def test_get_static_dividing_line_full_line(self):
         line = StaticDividingLine('-')
-        self.assertEqual(line.get_full_line().count('-'), 25)
+        self.assertEqual(line.get_full_static_line(True).count('-'), 25)
 
     def test_get_dynamic_dividing_line_full_line(self):
         line = DynamicDividingLine()
-        self.assertEqual(line.get_full_line(20).count('-'), 20)
+        self.assertEqual(line.get_full_dynamic_line(20, True).count('-'), 20)
 
     def test_get_dividing_line_unit_part(self):
         line = StaticDividingLine('')

tests/unit_tests/test_flag.py

@@ -1,4 +1,4 @@
-from argenta.command.flag.models import Flag, InputFlag
+from argenta.command.flag.models import Flag, InputFlag, InputFlags, Flags
 
 import unittest
 import re
@@ -68,6 +68,44 @@ class TestFlag(unittest.TestCase):
         flag = Flag(name='test', possible_values=True)
         self.assertEqual(flag.validate_input_flag_value('random value'), True)
 
+    def test_get_input_flag1(self):
+        flag = InputFlag(name='test')
+        input_flags = InputFlags(flag)
+        self.assertEqual(input_flags.get_flag('test'), flag)
+
+    def test_get_input_flag2(self):
+        flag = InputFlag(name='test')
+        flag2 = InputFlag(name='some')
+        input_flags = InputFlags(flag, flag2)
+        self.assertEqual(input_flags.get_flag('some'), flag2)
+
+    def test_get_undefined_input_flag(self):
+        flag = InputFlag(name='test')
+        flag2 = InputFlag(name='some')
+        input_flags = InputFlags(flag, flag2)
+        self.assertEqual(input_flags.get_flag('case'), None)
+
+    def test_get_flags(self):
+        flags = Flags()
+        list_of_flags = [
+            Flag('test1'),
+            Flag('test2'),
+            Flag('test3'),
+        ]
+        flags.add_flags(list_of_flags)
+        self.assertEqual(flags.get_flags(),
+                         list_of_flags)
+
+    def test_add_flag(self):
+        flags = Flags()
+        flags.add_flag(Flag('test'))
+        self.assertEqual(len(flags.get_flags()), 1)
+
+    def test_add_flags(self):
+        flags = Flags()
+        flags.add_flags([Flag('test'), Flag('test2')])
+        self.assertEqual(len(flags.get_flags()), 2)
+
 
 
 

tests/unit_tests/test_flagsgroup.py

@@ -1,26 +0,0 @@
-from argenta.command.flag.models import Flag, Flags
-
-import unittest
-
-
-class TestFlags(unittest.TestCase):
-    def test_get_flags(self):
-        flags = Flags()
-        list_of_flags = [
-            Flag('test1'),
-            Flag('test2'),
-            Flag('test3'),
-        ]
-        flags.add_flags(list_of_flags)
-        self.assertEqual(flags.get_flags(),
-                         list_of_flags)
-
-    def test_add_flag(self):
-        flags = Flags()
-        flags.add_flag(Flag('test'))
-        self.assertEqual(len(flags.get_flags()), 1)
-
-    def test_add_flags(self):
-        flags = Flags()
-        flags.add_flags([Flag('test'), Flag('test2')])
-        self.assertEqual(len(flags.get_flags()), 2)

tests/unit_tests/test_router.py

@@ -1,30 +1,138 @@
-from argenta.router import Router
-from argenta.command import Command
-from argenta.router.exceptions import TriggerCannotContainSpacesException
+from argenta.command.flag import InputFlags, InputFlag, Flag, Flags
+from src.argenta.router import Router
+from src.argenta.command import Command
+from src.argenta.router.exceptions import (TriggerContainSpacesException,
+                                           RepeatedFlagNameException,
+                                           TooManyTransferredArgsException,
+                                           RequiredArgumentNotPassedException)
 
 import unittest
+import re
 
 
 class TestRouter(unittest.TestCase):
-    def test_get_router_name(self):
-        self.assertEqual(Router(name='test name').get_name(), 'test name')
-
     def test_get_router_title(self):
         self.assertEqual(Router(title='test title').get_title(), 'test title')
 
     def test_register_command_with_spaces_in_trigger(self):
         router = Router()
-        with self.assertRaises(TriggerCannotContainSpacesException):
-            @router.command(Command(trigger='command with spaces'))
-            def test():
-                return 'correct result'
-
-
-
-
-
-
-
+        with self.assertRaises(TriggerContainSpacesException):
+            router._validate_command(Command(trigger='command with spaces'))
+
+    def test_register_command_with_repeated_flags(self):
+        router = Router()
+        with self.assertRaises(RepeatedFlagNameException):
+            router._validate_command(Command(trigger='command', flags=Flags(Flag('test'), Flag('test'))))
+
+    def test_validate_incorrect_input_flag1(self):
+        router = Router()
+        router.set_invalid_input_flag_handler(lambda flag: None)
+        self.assertEqual(router._validate_input_flags(Command('cmd'), InputFlags(InputFlag('ssh'))), False)
+
+    def test_validate_incorrect_input_flag2(self):
+        router = Router()
+        router.set_invalid_input_flag_handler(lambda flag: None)
+        self.assertEqual(router._validate_input_flags(Command('cmd'), InputFlags(InputFlag('ssh', value='some'))), False)
+
+    def test_validate_incorrect_input_flag3(self):
+        router = Router()
+        router.set_invalid_input_flag_handler(lambda flag: None)
+        command = Command('cmd', flags=Flag('port'))
+        input_flags = InputFlags(InputFlag('ssh', value='some2'))
+        self.assertEqual(router._validate_input_flags(command, input_flags), False)
+
+    def test_validate_incorrect_input_flag4(self):
+        router = Router()
+        router.set_invalid_input_flag_handler(lambda flag: None)
+        command = Command('cmd', flags=Flag('ssh', possible_values=False))
+        input_flags = InputFlags(InputFlag('ssh', value='some3'))
+        self.assertEqual(router._validate_input_flags(command, input_flags), False)
+
+    def test_validate_incorrect_input_flag5(self):
+        router = Router()
+        router.set_invalid_input_flag_handler(lambda flag: None)
+        command = Command('cmd', flags=Flag('ssh', possible_values=re.compile(r'some[1-5]$')))
+        input_flags = InputFlags(InputFlag('ssh', value='some40'))
+        self.assertEqual(router._validate_input_flags(command, input_flags), False)
+
+    def test_validate_incorrect_input_flag6(self):
+        router = Router()
+        router.set_invalid_input_flag_handler(lambda flag: None)
+        command = Command('cmd', flags=Flag('ssh', possible_values=['example']))
+        input_flags = InputFlags(InputFlag('ssh', value='example2'))
+        self.assertEqual(router._validate_input_flags(command, input_flags), False)
+
+    def test_validate_incorrect_input_flag7(self):
+        router = Router()
+        router.set_invalid_input_flag_handler(lambda flag: None)
+        command = Command('cmd', flags=Flag('ssh', possible_values=['example']))
+        input_flags = InputFlags(InputFlag('ssh'))
+        self.assertEqual(router._validate_input_flags(command, input_flags), False)
+
+    def test_validate_correct_input_flag1(self):
+        command = Command('cmd', flags=Flag('port'))
+        input_flags = InputFlags(InputFlag('port', value='some2'))
+        self.assertEqual(Router()._validate_input_flags(command, input_flags), True)
+
+    def test_validate_correct_input_flag2(self):
+        command = Command('cmd', flags=Flag('port', possible_values=['some2', 'some3']))
+        input_flags = InputFlags(InputFlag('port', value='some2'))
+        self.assertEqual(Router()._validate_input_flags(command, input_flags), True)
+
+    def test_validate_correct_input_flag3(self):
+        command = Command('cmd', flags=Flag('ssh', possible_values=re.compile(r'more[1-5]$')))
+        input_flags = InputFlags(InputFlag('ssh', value='more5'))
+        self.assertEqual(Router()._validate_input_flags(command, input_flags), True)
+
+    def test_validate_correct_input_flag4(self):
+        command = Command('cmd', flags=Flag('ssh', possible_values=False))
+        input_flags = InputFlags(InputFlag('ssh'))
+        self.assertEqual(Router()._validate_input_flags(command, input_flags), True)
+
+    def test_validate_incorrect_func_args1(self):
+        command = Command('cmd', flags=Flag('port'))
+        def handler():
+            pass
+        with self.assertRaises(RequiredArgumentNotPassedException):
+            Router()._validate_func_args(command, handler)
+
+    def test_validate_incorrect_func_args2(self):
+        command = Command('cmd', flags=Flag('port'))
+        def handler(args, kwargs):
+            pass
+        with self.assertRaises(TooManyTransferredArgsException):
+            Router()._validate_func_args(command, handler)
+
+    def test_validate_incorrect_func_args3(self):
+        command = Command('cmd')
+        def handler(args):
+            pass
+        with self.assertRaises(TooManyTransferredArgsException):
+            Router()._validate_func_args(command, handler)
+
+    def test_get_router_aliases(self):
+        router = Router()
+        @router.command(Command('some', aliases=['test', 'case']))
+        def handler():
+            pass
+        self.assertListEqual(router.get_aliases(), ['test', 'case'])
+
+    def test_get_router_aliases2(self):
+        router = Router()
+        @router.command(Command('some', aliases=['test', 'case']))
+        def handler():
+            pass
+        @router.command(Command('ext', aliases=['more', 'foo']))
+        def handler2():
+            pass
+        self.assertListEqual(router.get_aliases(), ['test', 'case', 'more', 'foo'])
+
+    def test_get_router_aliases3(self):
+        router = Router()
+        @router.command(Command('some'))
+        def handler():
+            pass
+        self.assertListEqual(router.get_aliases(), [])