argenta 0.4.5__py3-none-any.whl → 0.4.7__py3-none-any.whl

argenta/app/__init__.py

@@ -1,3 +1,3 @@
 __all__ = ["App"]
 
-from .entity import App
+from .models import App

argenta/app/defaults.py

@@ -0,0 +1,8 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class PredeterminedMessages:
+    USAGE = '[b dim]Usage[/b dim]: [i]<command> <[green]flags[/green]>[/i]'
+    HELP = '[b dim]Help[/b dim]: [i]<command>[/i] [b red]--help[/b red]'
+

argenta/app/exceptions.py

@@ -23,8 +23,3 @@ class NoRegisteredHandlersException(Exception):
         self.router_name = router_name
     def __str__(self):
         return f"No Registered Handlers Found For '{self.router_name}'"
-
-
-class IncorrectNumberOfHandlerArgsException(Exception):
-    def __str__(self):
-        return "Incorrect Input Flags Handler has incorrect number of arguments"

argenta/app/models.py

@@ -0,0 +1,209 @@
+from typing import Callable
+from rich.console import Console
+from art import text2art
+import re
+
+from argenta.command.models import Command, InputCommand
+from argenta.router import Router
+from argenta.router.defaults import system_router
+from argenta.command.exceptions import (UnprocessedInputFlagException,
+                                        RepeatedInputFlagsException,
+                                        EmptyInputCommandException,
+                                        BaseInputCommandException)
+from argenta.app.exceptions import (InvalidRouterInstanceException,
+                                    InvalidDescriptionMessagePatternException,
+                                    NoRegisteredRoutersException,
+                                    NoRegisteredHandlersException)
+from argenta.app.registered_routers.entity import RegisteredRouters
+
+
+
+class BaseApp:
+    def __init__(self,
+                 prompt: str = '[italic dim bold]What do you want to do?\n',
+                 initial_message: str = 'Argenta',
+                 farewell_message: str = 'See you',
+                 exit_command: str = 'Q',
+                 exit_command_description: str = 'Exit command',
+                 system_points_title: str = 'System points:',
+                 ignore_command_register: bool = True,
+                 line_separate: str = '-----',
+                 repeat_command_groups: bool = True,
+                 print_func: Callable[[str], None] = Console().print) -> None:
+        self._prompt = prompt
+        self._print_func = print_func
+        self._exit_command = exit_command
+        self._exit_command_description = exit_command_description
+        self._system_points_title = system_points_title
+        self._line_separate = line_separate
+        self._ignore_command_register = ignore_command_register
+        self._repeat_command_groups_description = repeat_command_groups
+
+        self.farewell_message = farewell_message
+        self.initial_message = initial_message
+
+        self._description_message_pattern: str = '[bold red][{command}][/bold red] [blue dim]*=*=*[/blue dim] [bold yellow italic]{description}'
+        self._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: {raw_command}')
+        self.repeated_input_flags_handler: Callable[[str], None] = lambda raw_command: print_func(f'[red bold]Repeated input flags: {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: {command.get_trigger()}")
+        self.exit_command_handler: Callable[[], None] = lambda: print_func(self.farewell_message)
+
+        self._setup_default_view(is_initial_message_default=initial_message == 'Argenta',
+                                 is_farewell_message_default=farewell_message == 'See you',
+                                 is_line_separate_default=line_separate == '-----')
+
+
+    def _setup_default_view(self, is_initial_message_default: bool,
+                            is_farewell_message_default: bool,
+                            is_line_separate_default: bool):
+        if is_initial_message_default:
+            self.initial_message = f'\n[bold red]{text2art('Argenta', font='tarty1')}\n\n'
+        if is_farewell_message_default:
+            self.farewell_message = (f'[bold red]\n{text2art('\nSee   you\n', font='chanky')}[/bold red]\n'
+                                     f'[red i]github.com/koloideal/Argenta[/red i] | '
+                                     f'[red bold i]made by kolo[/red bold i]\n')
+        if is_line_separate_default:
+            self._line_separate = f'\n[dim]{"-" * 50}\n'
+
+
+    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())
+
+
+    def _is_exit_command(self, command: InputCommand):
+        if command.get_trigger().lower() == self._exit_command.lower():
+            if self._ignore_command_register:
+                system_router.input_command_handler(command)
+                return True
+            elif command.get_trigger() == self._exit_command:
+                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()
+                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
+        self.unknown_command_handler(command)
+        return True
+
+
+    def _print_command_group_description(self):
+        for registered_router in self._registered_routers:
+            self._print_func(registered_router.get_title())
+            for command_handler in registered_router.get_command_handlers():
+                self._print_func(self._description_message_pattern.format(
+                        command=command_handler.get_handled_command().get_trigger(),
+                        description=command_handler.get_handled_command().get_description()))
+            self._print_func('')
+
+
+    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 App(BaseApp):
+    def start_polling(self) -> None:
+        self._setup_system_router()
+        self._validate_number_of_routers()
+        self._validate_included_routers()
+
+        self._print_func(self.initial_message)
+
+        for message in self._messages_on_startup:
+            self._print_func(message)
+
+        if not self._repeat_command_groups_description:
+            self._print_command_group_description()
+
+        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:
+                self._print_func(self._line_separate)
+                self._error_handler(error, raw_command)
+                self._print_func(self._line_separate)
+                continue
+
+            if self._is_exit_command(input_command):
+                return
+
+            self._print_func(self._line_separate)
+
+            if self._is_unknown_command(input_command):
+                self._print_func(self._line_separate)
+                continue
+
+            for registered_router in self._registered_routers:
+                registered_router.input_command_handler(input_command)
+
+            self._print_func(self._line_separate)
+            if not self._repeat_command_groups_description:
+                self._print_func(self._prompt)
+
+
+    def include_router(self, router: Router) -> None:
+        if not isinstance(router, Router):
+            raise InvalidRouterInstanceException()
+
+        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)
+
+
+    def set_description_message_pattern(self, pattern: str) -> None:
+        first_check = re.match(r'.*{command}.*', pattern)
+        second_check = re.match(r'.*{description}.*', pattern)
+
+        if bool(first_check) and bool(second_check):
+            self._description_message_pattern: str = pattern
+        else:
+            raise InvalidDescriptionMessagePatternException(pattern)
+
+
+    def _setup_system_router(self):
+        system_router.set_title(self._system_points_title)
+        @system_router.command(Command(self._exit_command, self._exit_command_description))
+        def exit_command():
+            self.exit_command_handler()
+
+        if system_router not in self._registered_routers.get_registered_routers():
+            self.include_router(system_router)
+
+

argenta/command/exceptions.py

@@ -1,12 +1,16 @@
 from argenta.command.flag.models import InputFlag, Flag
 
 
-class UnprocessedInputFlagException(Exception):
+class BaseInputCommandException(Exception):
+    pass
+
+
+class UnprocessedInputFlagException(BaseInputCommandException):
     def __str__(self):
         return "Unprocessed Input Flags"
 
 
-class RepeatedInputFlagsException(Exception):
+class RepeatedInputFlagsException(BaseInputCommandException):
     def __init__(self, flag: Flag | InputFlag):
         self.flag = flag
     def __str__(self):
@@ -14,6 +18,6 @@ class RepeatedInputFlagsException(Exception):
                 f"Duplicate flag was detected in the input: '{self.flag.get_string_entity()}'")
 
 
-class EmptyInputCommandException(Exception):
+class EmptyInputCommandException(BaseInputCommandException):
     def __str__(self):
-        return "Input Command is empty"
+        return "Input Command is empty"

argenta/command/flag/models.py

@@ -27,7 +27,7 @@ class InputFlag(BaseFlag):
         super().__init__(name, prefix)
         self._flag_value = value
 
-    def get_value(self):
+    def get_value(self) -> str | None:
         return self._flag_value
 
     def set_value(self, value):

argenta/command/models.py

@@ -83,7 +83,8 @@ class InputCommand(BaseCommand, Generic[InputCommandType]):
 
             if current_flag_name:
                 if not len(list_of_tokens) == k+1:
-                    if not list_of_tokens[k+1].startswith('-'): continue
+                    if not list_of_tokens[k+1].startswith('-'):
+                        continue
 
                 input_flag = InputFlag(name=current_flag_name[current_flag_name.rfind('-')+1:],
                                        prefix=cast(Literal['-', '--', '---'],

argenta/router/command_handler/entity.py

@@ -8,8 +8,8 @@ class CommandHandler:
         self.handler = handler
         self.handled_command = handled_command
 
-    def handling(self, input_flags: InputFlags):
-        if input_flags.get_flags():
+    def handling(self, input_flags: InputFlags = None):
+        if input_flags is not None:
             self.handler(input_flags)
         else:
             self.handler()

argenta/router/entity.py

@@ -22,7 +22,6 @@ class Router:
 
         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 ''}")
 
 
@@ -51,23 +50,20 @@ class Router:
     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():
-                if handle_command.get_registered_flags():
-                    if input_command_flags:
-                        for flag in input_command_flags:
-                            is_valid = handle_command.validate_input_flag(flag)
-                            if not is_valid:
-                                self._not_valid_flag_handler(flag)
-                                return
-                        command_handler.handling(input_command_flags)
-                        return
+                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({})
+                        command_handler.handling(input_command_flags)
                         return
                 else:
-                    if input_command_flags:
+                    if input_command_flags.get_flags():
                         self._not_valid_flag_handler(input_command_flags[0])
                         return
                     else:
@@ -75,6 +71,15 @@ class Router:
                         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()
@@ -119,11 +124,3 @@ class Router:
 
     def set_title(self, title: str):
         self._title = title
-
-
-    def get_all_commands(self) -> list[str]:
-        all_commands: list[str] = []
-        for command_handler in self._command_handlers:
-            all_commands.append(command_handler.get_handled_command().get_trigger())
-
-        return all_commands

{argenta-0.4.5.dist-info → argenta-0.4.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: argenta
-Version: 0.4.5
+Version: 0.4.7
 Summary: python library for creating custom shells
 License: MIT
 Author: kolo
@@ -11,6 +11,8 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: art (>=6.4,<7.0)
+Requires-Dist: rich (>=14.0.0,<15.0.0)
 Description-Content-Type: text/markdown
 
 # Argenta
@@ -20,6 +22,9 @@ Description-Content-Type: text/markdown
 ## Описание
 **Argenta** — Python library for creating custom shells
 
+![prewiev](https://github.com/koloideal/Argenta/blob/kolo/imgs/mock_app_preview_last.png?raw=True)  
+Пример внешнего вида TUI, написанного с помощью Argenta  
+
 ---
 
 # Установка
@@ -107,33 +112,29 @@ def handler_with_flags(flags: InputFlags):
 
 ### Конструктор
 ```python
-App(prompt: str = 'Enter a command',
-    initial_greeting: str = '\nHello, I am Argenta\n',
-    farewell_message: str = '\nGoodBye\n',
+App(prompt: str = 'What do you want to do?\n',
+    initial_message: str = 'Argenta',
+    farewell_message: str = 'See you',
     exit_command: str = 'Q',
     exit_command_description: str = 'Exit command',
     system_points_title: str = 'System points:',
-    ignore_exit_command_register: bool = True,
-    ignore_command_register: bool = False,
-    line_separate: str = '',
-    command_group_description_separate: str = '',
+    ignore_command_register: bool = True,
+    line_separate: str = '-----',
     repeat_command_groups: bool = True,
-    print_func: Callable[[str], None] = print)
+    print_func: Callable[[str], None] = Console().print)
 ```
 **Аргументы:**
 - **name : mean**
 - `prompt` (`str`): Сообщение перед вводом команды.
-- `initial_greeting` (`str`): Приветственное сообщение при запуске.
+- `initial_message` (`str`): Приветственное сообщение при запуске.
 - `farewell_message` (`str`): Сообщение при выходе.
 - `exit_command` (`str`): Команда выхода (по умолчанию `'Q'`).
 - `exit_command_description` (`str`): Описание команды выхода.
 - `system_points_title` (`str`): Заголовок перед списком системных команд.
-- `ignore_exit_command_register` (`bool`): Игнорировать регистр команды выхода.
 - `ignore_command_register` (`bool`): Игнорировать регистр всех команд.
 - `line_separate` (`str`): Разделительная строка между командами.
-- `command_group_description_separate` (`str`): Разделитель между группами команд.
 - `repeat_command_groups` (`bool`): Повторять описание команд перед вводом.
-- `print_func` (`Callable[[str], None]`): Функция вывода текста в терминал (по умолчанию `print`).
+- `print_func` (`Callable[[str], None]`): Функция вывода текста в терминал.
 
 ---
 
@@ -143,94 +144,83 @@ App(prompt: str = 'Enter a command',
 
 #### **.start_polling() -> `None`**  
 
-*method mean* **::** запускает цикл обработки ввода
+*method mean* **::** Запускает цикл обработки ввода
 
 ---
 
 #### **.include_router(router: Router) -> `None`**  
 
-*param* `router: Router` **::** регистрируемый роутер  
+*param* `router: Router` **::** Регистрируемый роутер  
 *required* **::** True
 
-*method mean* **::** регистрирует роутер в оболочке
+*method mean* **::** Регистрирует роутер в оболочке
 
 ---
 
-#### **.set_initial_message(message: str) -> `None`**  
+#### **.include_routers(\*routers: Router) -> `None`**  
 
-*param* `message: str` **::** устанавливаемое приветственное сообщение  
-*required* **::** True  
-*example* **::** `"Hello, I'm a example app"`
+*param* `routers: Router` **::** Неограниченное количество регистрируемых роутеров    
+*required* **::** True
 
-*method mean* **::** устанавливает сообщение, которое будет отображено при запуске программы
+*method mean* **::** Регистрирует роутер в оболочке
 
 ---
 
-#### **.set_farewell_message(message: str) -> `None`**  
+#### **.set_description_message_pattern(pattern: str) -> `None`**  
 
-*param* `message: str` **::** устанавливаемое сообщение при выходе  
+*param* `pattern: str` **::** Паттерн описания команды при её выводе в консоль  
 *required* **::** True  
-*example* **::** `"GoodBye !"`
+*example* **::** `"[{command}] *=*=* {description}"`
 
-*method mean* **::** устанавливает сообщение, которое будет отображено при выходе
+*method mean* **::** Устанавливает паттерн описания команд, который будет использован
+при выводе в консоль
 
 ---
 
-#### **.set_description_message_pattern(pattern: str) -> `None`**  
+#### **.add_message_on_startup(message: str) -> `None`**  
 
-*param* `pattern: str` **::** паттерн описания команды при её выводе в консоль  
+*param* `message: str` **::** Сообщение, которое будет выведено при запуске приложения 
 *required* **::** True  
-*example* **::** `"[{command}] *=*=* {description}"`
+*example* **::** `Message on startup`
 
-*method mean* **::** устанавливает паттерн описания команд, который будет использован
+*method mean* **::** Устанавливает паттерн описания команд, который будет использован
 при выводе в консоль
 
 ---
+
 <a name="custom_handler"></a>
-#### **.set_repeated_input_flags_handler(handler: Callable[[str], None]) -> `None`**  
+#### **.repeated_input_flags_handler: `Callable[[str], None])`**
 
-*param* `handler: Callable[[str], None]` **::** функция или лямбда функция, которой будет передано управление при
-вводе юзером повторяющихся флагов  
-*required* **::** True  
 *example* **::** `lambda raw_command: print_func(f'Repeated input flags: "{raw_command}"')`
 
-*method mean* **::** устанавливает функцию, которой будет передано управление при
+*attr mean* **::** Устанавливает функцию, которой будет передано управление при
 вводе юзером повторяющихся флагов
 
 ---
 
-#### **.set_invalid_input_flags_handler(self, handler: Callable[[str], None]) -> `None`**  
+#### **.invalid_input_flags_handler: `Callable[[str], None])`**  
 
-*param* `handler: Callable[[str], None]` **::** функция или лямбда функция, которой будет передано управление при
-вводе юзером команды с некорректным синтаксисом флагов
-*required* **::** True  
 *example* **::** `lambda raw_command: print_func(f'Incorrect flag syntax: "{raw_command}"')`
 
-*method mean* **::** устанавливает функцию, которой будет передано управление при
+*attr mean* **::** Устанавливает функцию, которой будет передано управление при
 вводе юзером команды с некорректным синтаксисом флагов
 
 ---
 
-#### **.set_unknown_command_handler(self, handler: Callable[[str], None]) -> `None`**  
+#### **.unknown_command_handler: `Callable[[str], None]`**  
 
-*param* `handler: Callable[[str], None]` **::** функция или лямбда функция, которой будет передано управление при
-вводе юзером неизвестной команды
-*required* **::** True  
 *example* **::** `lambda command: print_func(f"Unknown command: {command.get_string_entity()}")`
 
-*method mean* **::** устанавливает функцию, которой будет передано управление при
+*attr mean* **::** Устанавливает функцию, которой будет передано управление при
 вводе юзером неизвестной команды
 
 ---
 
-#### **.set_empty_command_handler(self, handler: Callable[[str], None]) -> `None`**  
+#### **.empty_command_handler: `Callable[[str], None])`**  
 
-*param* `handler: Callable[[str], None]` **::** функция или лямбда функция, которой будет передано управление при
-вводе юзером пустой команды  
-*required* **::** True  
 *example* **::** `lambda: print_func(f'Empty input command')`
 
-*method mean* **::** устанавливает функцию, которой будет передано управление при
+*attr mean* **::** Устанавливает функцию, которой будет передано управление при
 вводе юзером пустой команды
 
 ---
@@ -248,6 +238,9 @@ App(prompt: str = 'Enter a command',
 `RepeatedCommandInDifferentRoutersException`. Исключение вызывается только при наличии пересекающихся команд 
 у __<u>разных</u>__ роутеров
 
+- Наиболее частые сообщение при запуске предопределены и доступны для быстрого
+использования: `argenta.app.defaults.PredeterminedMessages`
+
 
 
 
@@ -256,9 +249,7 @@ App(prompt: str = 'Enter a command',
 - `InvalidRouterInstanceException` — Переданный объект в метод `App().include_router()` не является экземпляром класса `Router`.
 - `InvalidDescriptionMessagePatternException` — Неправильный формат паттерна описания команд.
 - `IncorrectNumberOfHandlerArgsException` — У обработчика нестандартного поведения зарегистрировано неверное количество аргументов(в большинстве случаев у него должен быть один аргумент).
-- `NoRegisteredRoutersException` — Отсутствуют зарегистрированные роутеры.
 - `NoRegisteredHandlersException` — У роутера нет ни одного обработчика команд.
-- `RepeatedCommandInDifferentRoutersException` — Одна и та же команда зарегистрирована в разных роутерах.
 
 ---
 
@@ -286,32 +277,27 @@ Router(title: str = 'Commands group title:',
 
 #### **command(command: Command)**  
 
-*param* `command: Command` **::** экземпляр класса `Command`, который определяет строковый триггер команды,
+*param* `command: Command` **::** Экземпляр класса `Command`, который определяет строковый триггер команды,
 допустимые флаги команды и другое  
 *required* **::** True  
 *example* **::** `Command(command='ssh', description='connect via ssh')`
 
-*method mean* **::** декоратор, который регистрирует функцию как обработчик команды
+*method mean* **::** Декоратор, который регистрирует функцию как обработчик команды
 
 ---
 
 #### **.get_name() -> `str`**  
 
-*method mean* **::** возвращает установленное название роутера
+*method mean* **::** Возвращает установленное название роутера
 
 ---
 
 #### **.get_title() -> `str`**  
 
-*method mean* **::** возвращает установленный заголовок группы команд данного роутера
+*method mean* **::** Возвращает установленный заголовок группы команд данного роутера
 
 ---
 
-#### **.get_all_commands() -> `list[str]`**  
-
-*method mean* **::** возвращает все зарегистрированные команды для данного роутера
-
----
 
 ### Исключения
 - `RepeatedFlagNameException` - Повторяющиеся зарегистрированные флаги в команде
@@ -342,19 +328,19 @@ Command(trigger: str,
 
 #### **.get_trigger() -> `str`**  
 
-*method mean* **::** возвращает строковый триггер экземпляра
+*method mean* **::** Возвращает строковый триггер экземпляра
 
 ---
 
 #### **.get_description() -> `str`**  
 
-*method mean* **::** возвращает описание команды
+*method mean* **::** Возвращает описание команды
 
 ---
 
 #### **.get_registered_flags() -> `Flags | None`**  
 
-*method mean* **::** возвращает зарегистрированные флаги экземпляра
+*method mean* **::** Возвращает зарегистрированные флаги экземпляра
 
 ---
 
@@ -376,18 +362,18 @@ Command(trigger: str,
 
 ### Конструктор
 ```python
-Flag(flag_name: str,
-     flag_prefix: typing.Literal['-', '--', '---'] = '-',
-     possible_flag_values: list[str] | typing.Pattern[str] | False = True)
+Flag(name: str,
+     prefix: typing.Literal['-', '--', '---'] = '-',
+     possible_values: list[str] | typing.Pattern[str] | False = True)
 ```
 
 ---
 
 **Аргументы:**
 - **name : mean**
-- `flag_name` (`str`): Имя флага
-- `flag_prefix` (`Literal['-', '--', '---']`): Префикс команды, допустимым значением является от одного до трёх минусов
-- `possible_flag_values` (`list[str] | Pattern[str] | bool`): Множество допустимых значений флага, может быть задано
+- `name` (`str`): Имя флага
+- `prefix` (`Literal['-', '--', '---']`): Префикс команды, допустимым значением является от одного до трёх минусов
+- `possible_values` (`list[str] | Pattern[str] | bool`): Множество допустимых значений флага, может быть задано
 списком с допустимыми значениями или регулярным выражением (рекомендуется `re.compile(r'example exspression')`), при значении
 аргумента `False` у введённого флага не может быть значения, иначе будет вызвано исключение и обработано соответствующим 
 еррор-хэндлером
@@ -400,19 +386,60 @@ Flag(flag_name: str,
 
 #### **.get_string_entity() -> `str`**  
 
-*method mean* **::** возвращает строковое представление флага(префикс + имя)
+*method mean* **::** Возвращает строковое представление флага(префикс + имя)
 
 ---
 
-#### **.get_flag_name() -> `str`**  
+#### **.get_name() -> `str`**  
 
-*method mean* **::** возвращает имя флага
+*method mean* **::** Возвращает имя флага
 
 ---
 
-#### **.get_flag_prefix() -> `str`**  
+#### **.get_prefix() -> `str`**  
+
+*method mean* **::** Возвращает префикс флага
+
+---
 
-*method mean* **::** возвращает префикс флага
+##  *class* :: `InputFlag` 
+Класс, экземпляры которого являются введёнными флагами команды, передаётся в хэндлер команды
+через `InputFlags`
+
+---
+
+### Примечания  
+
+- Наиболее часто используемые флаги предопределены и доступны для быстрого использования:
+`argenta.command.flag.defaults.PredeterminedFlags` 
+
+---
+
+
+### Конструктор
+```python
+InputFlag(name: str,
+         prefix: typing.Literal['-', '--', '---'] = '-',
+         value: str = None)
+```
+
+---
+
+**Аргументы:**
+- **name : mean**
+- `name` (`str`): Имя флага
+- `prefix` (`Literal['-', '--', '---']`): Префикс команды, допустимым значением является от одного до трёх минусов
+- `value` (`str`): Значение введённого флага, если оно есть
+
+---
+
+### ***methods***     
+
+---
+
+#### **.get_value() -> `str | None`**  
+
+*method mean* **::** Возвращает значение введённого флага
 
 ---
 
@@ -423,7 +450,7 @@ Flag(flag_name: str,
 
 ### Конструктор
 ```python
-Flags(*flagы: Flag)
+Flags(*flags: Flag)
 ```
 
 ---
@@ -440,7 +467,66 @@ Flags(*flagы: Flag)
 
 #### **.get_flags() -> `list[Flag]`**  
 
-*method mean* **::** возвращает зарегистрированные флаги
+*method mean* **::** Возвращает зарегистрированные флаги
+
+---
+
+#### **.add_flag(flag: Flag) -> `None`**  
+
+*method mean* **::** Добавляет флаг в группу
+
+---
+
+#### **.add_flags(flags: list[Flag]) -> `None`**  
+
+*method mean* **::** Добавляет флаги в группу
+
+---
+
+#### **.get_flag(name: str) -> `Flag | None`**  
+
+*param* `name: str` **::** Строковый триггер флага без префикса
+*required* **::** True  
+*example* **::** `'host'`
+
+*method mean* **::** Возвращает флаг по его триггеру или `None`, если флаг не найден
+
+---
+
+##  *class* :: `InputFlags` 
+Класс, объединяющий список введённых флагов в один объект, передаётся соответствующему хэндлеру
+в качестве аргумента
+
+### Конструктор
+```python
+InputFlags(*flags: Flag)
+```
+
+---
+
+**Аргументы:**
+- **name : mean**
+- `*flags` (`InputFlag`): Неограниченное количество передаваемых флагов
+
+---
+
+### ***methods***     
+
+---
+
+#### **.get_flags() -> `list[Flag]`**  
+
+*method mean* **::** Возвращает введённые флаги
+
+---
+
+#### **.get_flag(name: str) -> `InputFlag | None`**  
+
+*param* `name: str` **::** Строковый триггер флага без префикса
+*required* **::** True  
+*example* **::** `'host'`
+
+*method mean* **::** Возвращает введённый флаг по его триггеру или `None`, если флаг не найден
 
 ---
 

{argenta-0.4.5.dist-info → argenta-0.4.7.dist-info}/RECORD

@@ -1,24 +1,25 @@
 argenta/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-argenta/app/__init__.py,sha256=5BZcyJqfexO8t43j1LkWUB5BtGtZXpkR7170YvfeM30,46
-argenta/app/entity.py,sha256=3oo3eCiUockvTQVjGnkt17yEno8aRshohGTGEox87P4,11195
-argenta/app/exceptions.py,sha256=hItqsh76Fq6FfeanHqX8dvF00ERHXbQYjap5UODwg3o,1095
+argenta/app/__init__.py,sha256=Slm_0b1yaXeJ78zUpo_sDSEzYuTSj3_DhRU6wU8XU9Q,46
+argenta/app/defaults.py,sha256=7ej4G-4dieMlichfuQhw5XgabF15X-vAa8k02ZfkdUs,234
+argenta/app/exceptions.py,sha256=uCkb1VqEIZQuVDY0ZsfDc3yCbySwLpV5CdIT7iaGYRM,928
+argenta/app/models.py,sha256=IDC048SZP-jiw66x6ipz-lYOY7-CyD3mk-GHT8AyqCo,9338
 argenta/app/registered_routers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 argenta/app/registered_routers/entity.py,sha256=OQZyrF4eoCoDHzRJ22zZxhNEx-bOUDu7NZIFDfO-fuY,688
 argenta/command/__init__.py,sha256=Yx5Zl5Diwhjs8SZrsYEBNJscTMxWkLP0nqPvAJZtu30,52
-argenta/command/exceptions.py,sha256=J3kNY6CFoOxJXsZ23Bfl6f5uVUSiKZfwiGPBmlOwN5M,578
+argenta/command/exceptions.py,sha256=HOgddtXLDgk9Wx6c_GnzW3bMAMU5CuUnUyxjW3cVHRo,687
 argenta/command/flag/__init__.py,sha256=Ew-ZRFVY7sC_PMvavN0AEcsvdYGHkLAPOYMrReY3NC0,116
 argenta/command/flag/defaults.py,sha256=ktKmDT0rSSBoFUghTlEQ6OletoFxCiD37hRzO73mUUc,875
-argenta/command/flag/models.py,sha256=X1MFpAtnUX6mi1huycAtwAPXPeh9YFO-lH91TNyD3G4,3755
-argenta/command/models.py,sha256=ZVgJjS2uZbO2YaRYaXeT8a-IfO1IOiylWJXOMsx6fJw,4409
+argenta/command/flag/models.py,sha256=IY0FHyAFD9O1ZxSaq6NR9gSTkldoQGrKVoGrAbnmEuA,3769
+argenta/command/models.py,sha256=4MoO22EijeoMGmwYi88BSnBrip8fre2KpULGt8-NouY,4434
 argenta/router/__init__.py,sha256=uP58EfcmtK2NuMBQaspD_Gmq3LqgDXus4rfB6hp9Uig,52
 argenta/router/command_handler/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-argenta/router/command_handler/entity.py,sha256=-qV_Ysw6WcklW0WN5nAD8U3QLbqBNGT-WeMFHuhfrf4,639
+argenta/router/command_handler/entity.py,sha256=8sWhP89c0FavFBITJmH9c8wNn2ipW_6-_obzjkwXueU,646
 argenta/router/command_handlers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 argenta/router/command_handlers/entity.py,sha256=KgFKjAMUr_mOcn9xahTxMUKB6lIxXgqCuAsuc4TgP6E,747
 argenta/router/defaults.py,sha256=huftOg1HMjrT_R2SHHOL4eJ5uZHspNEYBSg-mCq9xhU,126
-argenta/router/entity.py,sha256=-88RWF2IEKBUwM7zfUiN0rrDjVpU94m4y5nuspld5ao,5073
+argenta/router/entity.py,sha256=afQn5jrDBrcd5QUzeBwRPfazOO6x0yYSXcmvHYhJpDw,4997
 argenta/router/exceptions.py,sha256=tdeaR8zDvnytgRYo_wQWKHt3if2brapgauIhhMIsTsA,678
-argenta-0.4.5.dist-info/LICENSE,sha256=zmqoGh2n5rReBv4s8wPxF_gZEZDgauJYSPMuPczgOiU,1082
-argenta-0.4.5.dist-info/METADATA,sha256=qI8PsEalTHJ7WYK4mB1Zer4n8rxafBMEO9rbp2qkcsg,18031
-argenta-0.4.5.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-argenta-0.4.5.dist-info/RECORD,,
+argenta-0.4.7.dist-info/LICENSE,sha256=zmqoGh2n5rReBv4s8wPxF_gZEZDgauJYSPMuPczgOiU,1082
+argenta-0.4.7.dist-info/METADATA,sha256=Yq80fNHrGnZheM_3OpCM-BTsPEL93ItT1Z8ikKAh0rs,19205
+argenta-0.4.7.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+argenta-0.4.7.dist-info/RECORD,,

argenta/app/entity.py

@@ -1,262 +0,0 @@
-from typing import Callable
-from inspect import getfullargspec
-import re
-
-from argenta.command.models import Command, InputCommand
-from argenta.router import Router
-from argenta.router.defaults import system_router
-from argenta.command.exceptions import (UnprocessedInputFlagException,
-                                  RepeatedInputFlagsException,
-                                  EmptyInputCommandException)
-from argenta.app.exceptions import (InvalidRouterInstanceException,
-                         InvalidDescriptionMessagePatternException,
-                         NoRegisteredRoutersException,
-                         NoRegisteredHandlersException,
-                         IncorrectNumberOfHandlerArgsException)
-from argenta.app.registered_routers.entity import RegisteredRouters
-
-
-class App:
-    def __init__(self,
-                 prompt: str = 'Enter a command',
-                 initial_message: str = '\nHello, I am Argenta\n',
-                 farewell_message: str = '\nGoodBye\n',
-                 invalid_input_flags_message: str = 'Invalid input flags',
-                 exit_command: str = 'Q',
-                 exit_command_description: str = 'Exit command',
-                 system_points_title: str = 'System points:',
-                 ignore_exit_command_register: bool = True,
-                 ignore_command_register: bool = False,
-                 line_separate: str = '',
-                 command_group_description_separate: str = '',
-                 repeat_command_groups: bool = True,
-                 messages_on_startup: list[str] = None,
-                 print_func: Callable[[str], None] = print) -> None:
-        self.prompt = prompt
-        self.print_func = print_func
-        self.exit_command = exit_command
-        self.exit_command_description = exit_command_description
-        self.system_points_title = system_points_title
-        self.ignore_exit_command_register = ignore_exit_command_register
-        self.farewell_message = farewell_message
-        self.initial_message = initial_message
-        self.invalid_input_flags_message = invalid_input_flags_message
-        self.line_separate = line_separate
-        self.command_group_description_separate = command_group_description_separate
-        self.ignore_command_register = ignore_command_register
-        self.repeat_command_groups = repeat_command_groups
-        self.messages_on_startup = messages_on_startup if messages_on_startup else []
-
-        self._description_message_pattern: str = '[{command}] *=*=* {description}'
-        self._registered_routers: RegisteredRouters = RegisteredRouters()
-        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 start_polling(self) -> None:
-        self._setup_system_router()
-        self._validate_number_of_routers()
-        self._validate_included_routers()
-
-        self.print_func(self.initial_message)
-
-        for message in self.messages_on_startup:
-            self.print_func(message)
-
-        if not self.repeat_command_groups:
-            self._print_command_group_description()
-            self.print_func(self.prompt)
-
-        while True:
-            if self.repeat_command_groups:
-                self._print_command_group_description()
-                self.print_func(self.prompt)
-
-            raw_command: str = input()
-
-            try:
-                input_command: InputCommand = InputCommand.parse(raw_command=raw_command)
-            except (UnprocessedInputFlagException,
-                    RepeatedInputFlagsException,
-                    EmptyInputCommandException) as error:
-                self.print_func(self.line_separate)
-                self._error_handler(error, raw_command)
-                self.print_func(self.line_separate)
-
-                if not self.repeat_command_groups:
-                    self.print_func(self.prompt)
-                continue
-
-            is_exit = self._is_exit_command(input_command)
-            if is_exit:
-                return
-
-            self.print_func(self.line_separate)
-            is_unknown_command: bool = self._check_is_command_unknown(input_command)
-
-            if is_unknown_command:
-                self.print_func(self.line_separate)
-                self.print_func(self.command_group_description_separate)
-                if not self.repeat_command_groups:
-                    self.print_func(self.prompt)
-                continue
-
-            for registered_router in self._registered_routers:
-                registered_router.input_command_handler(input_command)
-
-            self.print_func(self.line_separate)
-            self.print_func(self.command_group_description_separate)
-            if not self.repeat_command_groups:
-                self.print_func(self.prompt)
-
-
-    def set_initial_message(self, message: str) -> None:
-        self.initial_message: str = message
-
-
-    def set_farewell_message(self, message: str) -> None:
-        self.farewell_message: str = message
-
-
-    def set_description_message_pattern(self, pattern: str) -> None:
-        first_check = re.match(r'.*{command}.*', pattern)
-        second_check = re.match(r'.*{description}.*', pattern)
-
-        if bool(first_check) and bool(second_check):
-            self._description_message_pattern: str = pattern
-        else:
-            raise InvalidDescriptionMessagePatternException(pattern)
-
-
-    def set_invalid_input_flags_handler(self, handler: Callable[[str], None]) -> None:
-        args = getfullargspec(handler).args
-        if len(args) != 1:
-            raise IncorrectNumberOfHandlerArgsException()
-        else:
-            self._invalid_input_flags_handler = handler
-
-
-    def set_repeated_input_flags_handler(self, handler: Callable[[str], None]) -> None:
-        args = getfullargspec(handler).args
-        if len(args) != 1:
-            raise IncorrectNumberOfHandlerArgsException()
-        else:
-            self._repeated_input_flags_handler = handler
-
-
-    def set_unknown_command_handler(self, handler: Callable[[str], None]) -> None:
-        args = getfullargspec(handler).args
-        if len(args) != 1:
-            raise IncorrectNumberOfHandlerArgsException()
-        else:
-            self._unknown_command_handler = handler
-
-
-    def set_empty_command_handler(self, handler: Callable[[str], None]) -> None:
-        args = getfullargspec(handler).args
-        if len(args) != 1:
-            raise IncorrectNumberOfHandlerArgsException()
-        else:
-            self._empty_input_command_handler = handler
-
-
-    def set_exit_command_handler(self, handler: Callable[[], None]) -> None:
-        args = getfullargspec(handler).args
-        if len(args) != 0:
-            raise IncorrectNumberOfHandlerArgsException()
-        else:
-            self._exit_command_handler = handler
-
-
-    def add_message_on_startup(self, message: str) -> None:
-        self.messages_on_startup.append(message)
-
-
-    def include_router(self, router: Router) -> None:
-        if not isinstance(router, Router):
-            raise InvalidRouterInstanceException()
-
-        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 _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())
-
-
-    def _setup_system_router(self):
-        system_router.set_title(self.system_points_title)
-        @system_router.command(Command(self.exit_command, self.exit_command_description))
-        def exit_command():
-            self._exit_command_handler()
-        if system_router not in self._registered_routers.get_registered_routers():
-            self.include_router(system_router)
-
-
-    def _is_exit_command(self, command: InputCommand):
-        if command.get_trigger().lower() == self.exit_command.lower():
-            if self.ignore_exit_command_register:
-                system_router.input_command_handler(command)
-                return True
-            else:
-                if command.get_trigger() == self.exit_command:
-                    system_router.input_command_handler(command)
-                    return True
-        return False
-
-
-    def _check_is_command_unknown(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()
-                if handled_command_trigger.lower() == command.get_trigger().lower():
-                    if self.ignore_command_register:
-                        return False
-                    else:
-                        if handled_command_trigger == command.get_trigger():
-                            return False
-        self._unknown_command_handler(command)
-        return True
-
-
-    def _print_command_group_description(self):
-        for registered_router in self._registered_routers:
-            self.print_func(registered_router.get_title())
-            for command_handler in registered_router.get_command_handlers():
-                self.print_func(self._description_message_pattern.format(
-                        command=command_handler.get_handled_command().get_trigger(),
-                        description=command_handler.get_handled_command().get_description()
-                    )
-                )
-            self.print_func(self.command_group_description_separate)
-
-
-    def _error_handler(self,
-                       error: UnprocessedInputFlagException |
-                              RepeatedInputFlagsException |
-                              EmptyInputCommandException,
-                       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()
-
-