argenta 0.3.5__py3-none-any.whl → 0.3.6__py3-none-any.whl

argenta/app/__init__.py

@@ -1,3 +1 @@
 from .entity import App
-from .exceptions import (InvalidDescriptionMessagePatternException,
-                         InvalidRouterInstanceException)

argenta/app/entity.py

@@ -23,7 +23,7 @@ class App:
                  invalid_input_flags_message: str = 'Invalid input flags',
                  exit_command: str = 'Q',
                  exit_command_description: str = 'Exit command',
-                 exit_command_title: str = 'System points:',
+                 system_points_title: str = 'System points:',
                  ignore_exit_command_register: bool = True,
                  ignore_command_register: bool = False,
                  line_separate: str = '',
@@ -34,7 +34,7 @@ class App:
         self.print_func = print_func
         self.exit_command = exit_command
         self.exit_command_description = exit_command_description
-        self.exit_command_title = exit_command_title
+        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
@@ -100,7 +100,7 @@ class App:
                     self.print_func(self.prompt)
                 continue
 
-            self._check_command_for_exit_command(input_command.get_string_entity())
+            self._check_command_for_exit_command(input_command.get_trigger())
 
             self.print_func(self.line_separate)
             is_unknown_command: bool = self._check_is_command_unknown(input_command)
@@ -163,6 +163,14 @@ class App:
             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 include_router(self, router: Router) -> None:
         if not isinstance(router, Router):
             raise InvalidRouterInstanceException()
@@ -219,11 +227,11 @@ class App:
         registered_router_entities: list[dict[str, str | list[dict[str, Callable[[], None] | Command]] | Router]] = self._registered_router_entities
         for router_entity in registered_router_entities:
             for command_entity in router_entity['commands']:
-                if command_entity['command'].get_string_entity().lower() == command.get_string_entity().lower():
+                if command_entity['command'].get_trigger().lower() == command.get_trigger().lower():
                     if self.ignore_command_register:
                         return False
                     else:
-                        if command_entity['command'].get_string_entity() == command.get_string_entity():
+                        if command_entity['command'].get_trigger() == command.get_trigger():
                             return False
         self._unknown_command_handler(command)
         return True
@@ -234,13 +242,13 @@ class App:
             self.print_func(router_entity['title'])
             for command_entity in router_entity['commands']:
                 self.print_func(self._description_message_pattern.format(
-                        command=command_entity['command'].get_string_entity(),
+                        command=command_entity['command'].get_trigger(),
                         description=command_entity['command'].get_description()
                     )
                 )
             self.print_func(self.command_group_description_separate)
 
-        self.print_func(self.exit_command_title)
+        self.print_func(self.system_points_title)
         self.print_func(self._description_message_pattern.format(
                 command=self.exit_command,
                 description=self.exit_command_description

argenta/command/entity.py

@@ -1,9 +1,6 @@
 from .params.flag.entity import Flag
 from .params.flag.flags_group.entity import FlagsGroup
-from .exceptions import (InvalidCommandInstanceException,
-                         InvalidDescriptionInstanceException,
-                         InvalidFlagsInstanceException,
-                         UnprocessedInputFlagException,
+from .exceptions import (UnprocessedInputFlagException,
                          RepeatedInputFlagsException,
                          EmptyInputCommandException)
 
@@ -14,37 +11,28 @@ T = TypeVar('T')
 
 
 class Command(Generic[T]):
-    def __init__(self, command: str,
+    def __init__(self, trigger: str,
                  description: str = None,
-                 flags: Flag | FlagsGroup | None = None):
-        self._command = command
-        self._description = f'description for "{self._command}" command' if not description else description
+                 flags: Flag | FlagsGroup = None):
+        self._trigger = trigger
+        self._description = f'description for "{self._trigger}" command' if not description else description
         self._registered_flags: FlagsGroup | None = flags if isinstance(flags, FlagsGroup) else FlagsGroup([flags]) if isinstance(flags, Flag) else flags
 
         self._input_flags: FlagsGroup | None = None
 
 
-    def get_string_entity(self):
-        return self._command
+    def get_trigger(self) -> str:
+        return self._trigger
 
 
-    def get_description(self):
+    def get_description(self) -> str:
         return self._description
 
 
-    def get_registered_flags(self):
+    def get_registered_flags(self) -> FlagsGroup | None:
         return self._registered_flags
 
 
-    def validate_commands_params(self):
-        if not isinstance(self._command, str):
-            raise InvalidCommandInstanceException(self._command)
-        if not isinstance(self._description, str):
-            raise InvalidDescriptionInstanceException()
-        if not any([(isinstance(self._registered_flags, FlagsGroup)), not self._registered_flags]):
-            raise InvalidFlagsInstanceException
-
-
     def validate_input_flag(self, flag: Flag):
         registered_flags: FlagsGroup | None = self.get_registered_flags()
         if registered_flags:
@@ -62,7 +50,7 @@ class Command(Generic[T]):
         return False
 
 
-    def set_input_flags(self, input_flags: FlagsGroup):
+    def _set_input_flags(self, input_flags: FlagsGroup):
         self._input_flags = input_flags
 
     def get_input_flags(self) -> FlagsGroup:
@@ -93,9 +81,8 @@ class Command(Generic[T]):
                     current_flag_value = _
             if current_flag_name and current_flag_value:
                 flag_prefix_last_symbol_index = current_flag_name.rfind('-')
-                flag_prefix = current_flag_name[:flag_prefix_last_symbol_index]
-                flag_name = current_flag_name[flag_prefix_last_symbol_index:]
-
+                flag_prefix = current_flag_name[:flag_prefix_last_symbol_index+1]
+                flag_name = current_flag_name[flag_prefix_last_symbol_index+1:]
                 input_flag = Flag(flag_name=flag_name,
                                   flag_prefix=flag_prefix)
                 input_flag.set_value(current_flag_value)
@@ -111,10 +98,10 @@ class Command(Generic[T]):
         if any([current_flag_name, current_flag_value]):
             raise UnprocessedInputFlagException()
         if len(flags.get_flags()) == 0:
-            return Command(command=command)
+            return Command(trigger=command)
         else:
-            input_command = Command(command=command)
-            input_command.set_input_flags(flags)
+            input_command = Command(trigger=command)
+            input_command._set_input_flags(flags)
             return input_command
 
 

argenta/command/exceptions.py

@@ -1,21 +1,6 @@
 from .params.flag.entity import Flag
 
 
-class InvalidCommandInstanceException(Exception):
-    def __str__(self):
-        return "Invalid Command Instance"
-
-
-class InvalidDescriptionInstanceException(Exception):
-    def __str__(self):
-        return "Invalid Description Instance"
-
-
-class InvalidFlagsInstanceException(Exception):
-    def __str__(self):
-        return "Invalid Flags Instance"
-
-
 class UnprocessedInputFlagException(Exception):
     def __str__(self):
         return "Unprocessed Input Flags"

argenta/command/params/flag/entity.py

@@ -3,7 +3,7 @@ from typing import Literal, Pattern
 
 class Flag:
     def __init__(self, flag_name: str,
-                 flag_prefix: Literal['-', '--', '---'] = '-',
+                 flag_prefix: Literal['-', '--', '---'] = '--',
                  ignore_flag_value_register: bool = False,
                  possible_flag_values: list[str] | Pattern[str] = False):
         self._flag_name = flag_name
@@ -11,7 +11,7 @@ class Flag:
         self.possible_flag_values = possible_flag_values
         self.ignore_flag_value_register = ignore_flag_value_register
 
-        self._value = None
+        self._flag_value = None
 
     def get_string_entity(self):
         string_entity: str = self._flag_prefix + self._flag_name
@@ -24,10 +24,10 @@ class Flag:
         return self._flag_prefix
 
     def get_value(self):
-        return self._value
+        return self._flag_value
 
     def set_value(self, value):
-        self._value = value
+        self._flag_value = value
 
     def validate_input_flag_value(self, input_flag_value: str):
         if isinstance(self.possible_flag_values, Pattern):

argenta/command/params/flag/flags_group/entity.py

@@ -5,7 +5,7 @@ class FlagsGroup:
     def __init__(self, flags: list[Flag] = None):
         self._flags: list[Flag] = [] if not flags else flags
 
-    def get_flags(self):
+    def get_flags(self) -> list[Flag]:
         return self._flags
 
     def add_flag(self, flag: Flag):
@@ -14,6 +14,17 @@ class FlagsGroup:
     def add_flags(self, flags: list[Flag]):
         self._flags.extend(flags)
 
+    def unparse_to_dict(self):
+        result_dict: dict[str, dict] = {}
+        for flag in self._flags:
+            result_dict[flag.get_flag_name()] = {
+                'name': flag.get_flag_name(),
+                'string_entity': flag.get_string_entity(),
+                'prefix': flag.get_flag_prefix(),
+                'value': flag.get_value()
+            }
+        return result_dict
+
     def __iter__(self):
         return iter(self._flags)
 

argenta/router/__init__.py

@@ -1,2 +1 @@
-from .entity import Router
-from .exceptions import InvalidDescriptionInstanceException
+from .entity import Router

argenta/router/entity.py

@@ -4,7 +4,8 @@ from inspect import getfullargspec
 from ..command.entity import Command
 from ..command.params.flag.entity import Flag
 from ..command.params.flag.flags_group.entity import FlagsGroup
-from ..router.exceptions import (RepeatedCommandException, RepeatedFlagNameException,
+from ..router.exceptions import (RepeatedCommandException,
+                                 RepeatedFlagNameException,
                                  TooManyTransferredArgsException,
                                  RequiredArgumentNotPassedException,
                                  IncorrectNumberOfHandlerArgsException)
@@ -15,8 +16,8 @@ class Router:
                  title: str = 'Commands group title:',
                  name: str = 'subordinate'):
 
-        self.title = title
-        self.name = name
+        self._title = title
+        self._name = name
 
         self._command_entities: list[dict[str, Callable[[], None] | Command]] = []
         self._ignore_command_register: bool = False
@@ -25,7 +26,6 @@ class Router:
 
 
     def command(self, command: Command) -> Callable[[Any],  Any]:
-        command.validate_commands_params()
         self._validate_command(command)
 
         def command_decorator(func):
@@ -47,10 +47,10 @@ class Router:
 
 
     def input_command_handler(self, input_command: Command):
-        input_command_name: str = input_command.get_string_entity()
+        input_command_name: str = input_command.get_trigger()
         input_command_flags: FlagsGroup = input_command.get_input_flags()
         for command_entity in self._command_entities:
-            if input_command_name.lower() == command_entity['command'].get_string_entity().lower():
+            if input_command_name.lower() == command_entity['command'].get_trigger().lower():
                 if command_entity['command'].get_registered_flags():
                     if input_command_flags:
                         for flag in input_command_flags:
@@ -58,9 +58,9 @@ class Router:
                             if not is_valid:
                                 self._not_valid_flag_handler(flag)
                                 return
-                        return command_entity['handler_func'](input_command_flags)
+                        return command_entity['handler_func'](input_command_flags.unparse_to_dict())
                     else:
-                        return command_entity['handler_func'](FlagsGroup(None))
+                        return command_entity['handler_func']({})
                 else:
                     if input_command_flags:
                         self._not_valid_flag_handler(input_command_flags[0])
@@ -70,7 +70,7 @@ class Router:
 
 
     def _validate_command(self, command: Command):
-        command_name: str = command.get_string_entity()
+        command_name: str = command.get_trigger()
         if command_name in self.get_all_commands():
             raise RepeatedCommandException()
         if self._ignore_command_register:
@@ -106,16 +106,16 @@ class Router:
 
 
     def get_name(self) -> str:
-        return self.name
+        return self._name
 
 
     def get_title(self) -> str:
-        return self.title
+        return self._title
 
 
     def get_all_commands(self) -> list[str]:
         all_commands: list[str] = []
         for command_entity in self._command_entities:
-            all_commands.append(command_entity['command'].get_string_entity())
+            all_commands.append(command_entity['command'].get_trigger())
 
         return all_commands

argenta/router/exceptions.py

@@ -1,8 +1,3 @@
-class InvalidDescriptionInstanceException(Exception):
-    def __str__(self):
-        return "Invalid Description Instance"
-
-
 class RepeatedCommandException(Exception):
     def __str__(self):
         return "Commands in handler cannot be repeated"
@@ -23,11 +18,6 @@ class RequiredArgumentNotPassedException(Exception):
         return "Required argument not passed"
 
 
-class NotValidInputFlagHandlerHasBeenAlreadyCreatedException(Exception):
-    def __str__(self):
-        return "Invalid Input Flag Handler has already been created"
-
-
 class IncorrectNumberOfHandlerArgsException(Exception):
     def __str__(self):
-        return "Incorrect Input Flags Handler has incorrect number of arguments"
+        return "Handler has incorrect number of arguments"

argenta-0.3.6.dist-info/METADATA

@@ -0,0 +1,452 @@
+Metadata-Version: 2.3
+Name: argenta
+Version: 0.3.6
+Summary: python library for creating custom shells
+License: MIT
+Author: kolo
+Author-email: kolo.is.main@gmail.com
+Requires-Python: >=3.11
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Description-Content-Type: text/markdown
+
+# Argenta
+
+---
+
+## Описание
+**Argenta** — Python library for creating custom shells
+
+---
+
+# Установка
+```bash
+pip install argenta
+```
+or
+```bash
+poetry add argenta
+```
+
+---
+
+# Быстрый старт
+
+Пример простейшей оболочки с командой без флагов
+```python
+# routers.py
+from argenta.router import Router
+from argenta.command import Command
+
+
+router = Router()
+
+@router.command(Command("hello"))
+def handler():
+  print("Hello, world!")
+```
+
+```python
+# main.py
+from argenta.app import App
+from routers import router
+
+app: App = App()
+
+def main() -> None:
+    app.include_router(router)
+    app.start_polling()
+
+    
+if __name__ == '__main__':
+    main()
+```
+Пример оболочки с командой, у которой зарегистрированы флаги
+
+```python
+# routers.py
+import re
+from argenta.router import Router
+from argenta.command import Command
+from argenta.command.params.flag import FlagsGroup, Flag
+
+router = Router()
+
+list_of_flags = [
+    Flag(flag_name='host',
+         flag_prefix='--',
+         possible_flag_values=re.compile(r'^192.168.\d{1,3}.\d{1,3}$')),
+    Flag(flag_name='port',
+         flag_prefix='---',
+         possible_flag_values=re.compile(r'^[0-9]{1,4}$'))
+]
+
+
+@router.command(Command("hello"))
+def handler():
+    print("Hello, world!")
+
+
+@router.command(Command(trigger="ssh",
+                        description='connect via ssh',
+                        flags=FlagsGroup(list_of_flags)))
+def handler_with_flags(flags: dict):
+    for flag in flags:
+        print(f'Flag name: {flag['name']}\n
+              f'Flag value: {flag['value']}')
+```
+
+---
+
+# *classes* :
+
+---
+
+##  *class* :: `App` 
+Класс, определяющий поведение и состояние оболочки
+
+### Конструктор
+```python
+App(prompt: str = 'Enter a command',
+    initial_greeting: str = '\nHello, I am Argenta\n',
+    farewell_message: str = '\nGoodBye\n',
+    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,
+    print_func: Callable[[str], None] = print)
+```
+**Аргументы:**
+- **name : mean**
+- `prompt` (`str`): Сообщение перед вводом команды.
+- `initial_greeting` (`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`).
+
+---
+
+### ***methods***     
+
+---
+
+**App().**`start_polling() -> None`  
+
+*method mean* **::** запускает жизненный цикл приложения
+
+---
+
+**App().**`include_router(router: Router) -> None`  
+
+*param* `router: Router` **::** регистрируемый роутер
+
+*method mean* **::** регистрирует роутер в приложении
+
+---
+
+**App().**`set_initial_message(message: str) -> None`  
+
+*param* `message: str` **::** устанавливаемое приветственное сообщение  
+*example* **::** `"Hello, I'm a example app"`
+
+*method mean* **::** устанавливает сообщение, которое будет отображено при запуске программы
+
+---
+
+**App().**`set_farewell_message(message: str) -> None`  
+
+*param* `message: str` **::** устанавливаемое сообщение при выходе  
+*example* **::** `"GoodBye !"`
+
+*method mean* **::** устанавливает сообщение, которое будет отображено при выходе
+
+---
+
+**App().**`set_description_message_pattern(pattern: str) -> None`  
+
+*param* `pattern: str` **::** паттерн описания команды при её выводе в консоль  
+*example* **::** `"[{command}] *=*=* {description}"`
+
+*method mean* **::** устанавливает паттерн описания команд, который будет использован
+при выводе в консоль
+
+---
+
+**App().**`set_repeated_input_flags_handler(handler: Callable[[str], None]) -> None`  
+
+*param* `handler: Callable[[str], None]` **::** функция или лямбда функция, которой будет передано управление при
+вводе юзером повторяющихся флагов
+*example* **::** `lambda raw_command: print_func(f'Repeated input flags: "{raw_command}"')`
+
+*method mean* **::** устанавливает функцию, которой будет передано управление при
+вводе юзером повторяющихся флагов
+
+---
+
+**App().**`set_invalid_input_flags_handler(self, handler: Callable[[str], None]) -> None`  
+
+*param* `handler: Callable[[str], None]` **::** функция или лямбда функция, которой будет передано управление при
+вводе юзером команды с некорректным синтаксисом флагов
+*example* **::** `lambda raw_command: print_func(f'Incorrect flag syntax: "{raw_command}"')`
+
+*method mean* **::** устанавливает функцию, которой будет передано управление при
+вводе юзером команды с некорректным синтаксисом флагов
+
+---
+
+**App().**`set_unknown_command_handler(self, handler: Callable[[str], None]) -> None`  
+
+*param* `handler: Callable[[str], None]` **::** функция или лямбда функция, которой будет передано управление при
+вводе юзером неизвестной команды
+*example* **::** `lambda command: print_func(f"Unknown command: {command.get_string_entity()}")`
+
+*method mean* **::** устанавливает функцию, которой будет передано управление при
+вводе юзером неизвестной команды
+
+---
+
+**App().**`set_empty_command_handler(self, handler: Callable[[str], None]) -> None`  
+
+*param* `handler: Callable[[str], None]` **::** функция или лямбда функция, которой будет передано управление при
+вводе юзером пустой команды
+*example* **::** `lambda: print_func(f'Empty input command')`
+
+*method mean* **::** устанавливает функцию, которой будет передано управление при
+вводе юзером пустой команды
+
+---
+
+### Примечания  
+
+- В устанавливаемом паттерне сообщения описания команды необходимы быть два ключевых слова: 
+`command` и `description`, каждое из которых должно быть заключено в фигурные скобки, после обработки
+паттерна на места этих ключевых слов будут подставлены соответствующие значения команды, при отсутствии
+этих двух ключевых слов будет вызвано исключение `InvalidDescriptionMessagePatternException`
+
+- Команды приложения не должны повторяться, при значении атрибута `ignore_command_register` равным `True`
+допускается создание обработчиков для разных регистров одинаковых символов в команде, для примера `u` и `U`,
+при значении атрибута `ignore_command_register` класса `App` равным `False` тот же пример вызывает исключение 
+`RepeatedCommandInDifferentRoutersException`. Исключение вызывается только при наличии пересекающихся команд 
+у __<u>разных</u>__ роутеров
+
+
+
+
+### Исключения
+
+- `InvalidRouterInstanceException` — Переданный объект в метод `App().include_router()` не является экземпляром класса `Router`.
+- `InvalidDescriptionMessagePatternException` — Неправильный формат паттерна описания команд.
+- `IncorrectNumberOfHandlerArgsException` — У обработчика нестандартного поведения зарегистрировано неверное количество аргументов(в большинстве случаев у него должен быть один аргумент).
+- `NoRegisteredRoutersException` — Отсутствуют зарегистрированные роутеры.
+- `NoRegisteredHandlersException` — У роутера нет ни одного обработчика команд.
+- `RepeatedCommandInDifferentRoutersException` — Одна и та же команда зарегистрирована в разных роутерах.
+
+---
+
+##  *class* :: `Router` 
+Класс, который определяет и конфигурирует обработчики команд
+
+### Конструктор
+```python
+Router(title: str = 'Commands group title:',
+       name: str = 'subordinate')
+```
+
+
+
+**Аргументы:**
+- **name : mean**
+- `title` (`str`): Заголовок группы команд.
+- `name` (`str`): Персональное название роутера
+
+---
+
+### ***methods***     
+
+---
+
+**`@`Router().**`command(command: Command)`  
+
+*param* `command: Command` **::** экземпляр класса `Command`, который определяет строковый триггер команды,
+допустимые флаги команды и другое
+*example* **::** `Command(command='ssh', description='connect via ssh')`
+
+*method mean* **::** декоратор, который регистрирует функцию как обработчик команды
+
+---
+
+**Router().**`get_name() -> str`  
+
+*method mean* **::** возвращает установленное название роутера
+
+---
+
+**Router().**`get_title() -> str`  
+
+*method mean* **::** возвращает установленный заголовок группы команд данного роутера
+
+---
+
+**Router().**`get_all_commands() -> list[str]`  
+
+*method mean* **::** возвращает все зарегистрированные команды для данного роутера
+
+---
+
+### Исключения
+- `RepeatedCommandException` - Одна и та же команда зарегистрирована в одном роутере
+- `RepeatedFlagNameException` - Повторяющиеся зарегистрированные флаги в команде
+- `TooManyTransferredArgsException` - Слишком много зарегистрированных аргументов у обработчика команды
+- `RequiredArgumentNotPassedException` - Не зарегистрирован обязательный аргумент у обработчика команды(аргумент, через который будут переданы флаги введённой команды)
+- `IncorrectNumberOfHandlerArgsException` - У обработчика нестандартного поведения зарегистрировано неверное количество аргументов(в большинстве случаев у него должен быть один аргумент)
+
+---
+
+##  *class* :: `Command` 
+Класс, экземпляр которого определяет строковый триггер хэндлера и конфигурирует его атрибуты
+
+### Конструктор
+```python
+Command(trigger: str,
+        description: str = None,
+        flags: Flag | FlagsGroup = None)
+```
+
+**Аргументы:**
+- **name : mean**
+- `trigger` (`str`): Строковый триггер
+- `description` (`str`): Описание команды, которое будет выведено в консоль при запуске оболочки
+- `flags` (`Flag | FlagsGroup`): Флаги, которые будут обработаны при их наличии во вводе юзера
+
+---
+
+**Command().**`get_trigger() -> str`  
+
+*method mean* **::** возвращает строковый триггер экземпляра
+
+---
+
+**Command().**`get_description() -> str`  
+
+*method mean* **::** возвращает описание команды
+
+---
+
+**Command().**`get_registered_flags() -> FlagsGroup | None`  
+
+*method mean* **::** возвращает зарегистрированные флаги экземпляра
+
+---
+
+### Исключения 
+- `UnprocessedInputFlagException` - Некорректный синтаксис ввода команды
+- `RepeatedInputFlagsException` - Повторяющиеся флаги во введённой команде
+- `EmptyInputCommandException` - Введённая команда является пустой(не содержит символов)  
+
+**Примечание**
+Все вышеуказанные исключения класса `Command` вызываются в рантайме запущенным экземпляром класса
+`App`, а также по дефолту обрабатываются, при желании можно задать пользовательские
+обработчики для этих исключений ([подробнее см.](#methods-))
+
+---
+
+##  *class* :: `Flag` 
+Класс, экземпляры которого в большинстве случаев должны передаваться при создании
+экземпляра класса `Command` для регистрации допустимого флага при вводе юзером команды
+
+### Конструктор
+```python
+Flag(flag_name: str,
+     flag_prefix: Literal['-', '--', '---'] = '-',
+     ignore_flag_value_register: bool = False,
+     possible_flag_values: list[str] | Pattern[str] = False)
+```
+
+---
+
+**Аргументы:**
+- **name : mean**
+- `flag_name` (`str`): Имя флага
+- `flag_prefix` (`Literal['-', '--', '---']`): Префикс команды, допустимым значением является от одного до трёх минусов
+- `ignore_flag_value_register` (`bool`): Будет ли игнорироваться регистр значения введённого флага 
+- `possible_flag_values` (`list[str] | Pattern[str]`): Множество допустимых значений флага, может быть задано 
+списком с допустимыми значениями или регулярным выражением (рекомендуется `re.compile(r'example exspression')`)
+
+---
+
+### ***methods***     
+
+---
+
+**Flag().**`get_sring_entity() -> str`  
+
+*method mean* **::** возвращает строковое представление флага(префикс + имя)
+
+---
+
+**Flag().**`get_flag_name() -> str`  
+
+*method mean* **::** возвращает имя флага
+
+---
+
+**Flag().**`get_flag_prefix() -> str`  
+
+*method mean* **::** возвращает префикс флага
+
+---
+
+##  *class* :: `FlagsGroup` 
+Класс, объединяющий список флагов в один объект, используется в качестве 
+передаваемого аргумента `flags` экземпляру класса `Command`, при регистрации
+хэндлера
+
+### Конструктор
+```python
+FlagsGroup(flags: list[Flag] = None)
+```
+
+---
+
+**Аргументы:**
+- **name : mean**
+- `flags` (`list[Flag]`): Список флагов, которые будут объединены в одну группу
+
+---
+
+### ***methods***     
+
+---
+
+**FlagsGroup().**`get_flags() -> list[Flag]`  
+
+*method mean* **::** возвращает зарегистрированные флаги
+
+---
+
+# Тесты
+
+Запуск тестов:
+
+```bash
+python -m unittest discover
+```
+or
+```bash
+python -m unittest discover -v
+```
+

argenta-0.3.6.dist-info/RECORD

@@ -0,0 +1,19 @@
+argenta/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+argenta/app/__init__.py,sha256=NoKJpO5inI4bEtptNj7BZtNpGQidCNoFSw2-JoK6P98,25
+argenta/app/entity.py,sha256=f1UV8g92ZhyXeeTHvZYKNqPw0xCRUljYgXDg1qsaZa4,11508
+argenta/app/exceptions.py,sha256=ruI_MwJQtBLrnWxJbKlSRE50c5FjnZ9qXJma34kPZhk,1253
+argenta/command/__init__.py,sha256=yRSj5CtLjxwjKiokUGdSmuBZPOF_qheRyG0NW1pv7vo,27
+argenta/command/entity.py,sha256=tssojZMXUdI7o5LKxf9a07LT1VOyMk2gwL_zCj2Bljg,4230
+argenta/command/exceptions.py,sha256=ZCDnAmEvJRoOMpX02778YEQg3QCtDczRzu_fdkqKxus,547
+argenta/command/params/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+argenta/command/params/flag/__init__.py,sha256=y6rJLdag5qxONg1CzcP7gi6rCeix9UsG1AVANX3fnJs,68
+argenta/command/params/flag/entity.py,sha256=wqCLVCDUqvuPVQQyz2mOeslH6Xha0nwiKUqD1CCBpns,1737
+argenta/command/params/flag/flags_group/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+argenta/command/params/flag/flags_group/entity.py,sha256=qcVbRkfWblR53a1N0C8tpZ8UOH5aNlQmkyxRfCrrwMo,1011
+argenta/router/__init__.py,sha256=vIU2o3JJ7misRm9mUzUQw5HdverdMDfvHNzkWuYFRBY,26
+argenta/router/entity.py,sha256=P-1rmXgzuo548uGUKzsVrQBvgDGTXlEBtokx-eEbJY8,4936
+argenta/router/exceptions.py,sha256=dW3FIdHA_tZYt1-IEts7IY46KLBaKulfdW_ALKpvAic,657
+argenta-0.3.6.dist-info/LICENSE,sha256=zmqoGh2n5rReBv4s8wPxF_gZEZDgauJYSPMuPczgOiU,1082
+argenta-0.3.6.dist-info/METADATA,sha256=ZkHeDKFXdUqwoChdAdNv2UEwx6SQyhvkZT5HBz91WEo,17805
+argenta-0.3.6.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+argenta-0.3.6.dist-info/RECORD,,

argenta-0.3.5.dist-info/METADATA

@@ -1,289 +0,0 @@
-Metadata-Version: 2.3
-Name: argenta
-Version: 0.3.5
-Summary: python library for creating custom shells
-License: MIT
-Author: kolo
-Author-email: kolo.is.main@gmail.com
-Requires-Python: >=3.11
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Description-Content-Type: text/markdown
-
-# Argenta
-
----
-
-## Описание
-**Argenta** — это библиотека для создания CLI-приложений на Python. Она предоставляет удобные инструменты для маршрутизации команд и обработки пользовательского ввода.
-
----
-
-# Установка
-```bash
-pip install argenta
-```
-or
-```bash
-poetry add argenta
-```
-
----
-
-# Быстрый старт
-Пример базового CLI-приложения с Argenta:
-```python
-#routers.py
-from argenta.router import Router
-
-router = Router()
-
-@router.command("hello")
-def hello():
-    print("Hello, world!")
-
-@router.unknown_command
-def unlnown_command(command):
-    print(f'Command "{command}" undefined')
-```
-```python
-#main.py
-from argenta.app import App
-from routers import router
-
-app: App = App()
-
-def main() -> None:
-    app.include_router(router)
-    app.start_polling()
-
-    
-if __name__ == '__main__':
-    main()
-```
-
----
-
-# Техническая документация
-
----
-
-## declared *classes* :
-
----
-
-###  *class* :: `App` 
-Класс, определяющий поведение и состояние приложения
-
-#### Конструктор
-```python
-App(prompt: str = 'Enter a command',
-    initial_greeting: str = '\nHello, I am Argenta\n',
-    farewell_message: str = '\nGoodBye\n',
-    exit_command: str = 'Q',
-    exit_command_description: str = 'Exit command',
-    exit_command_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,
-    print_func: Callable[[str], None] = print)
-```
-**Аргументы:**
-- **name : mean**
-- `prompt` (`str`): Сообщение перед вводом команды.
-- `initial_greeting` (`str`): Приветственное сообщение при запуске.
-- `farewell_message` (`str`): Сообщение при выходе.
-- `exit_command` (`str`): Команда выхода (по умолчанию `'Q'`).
-- `exit_command_description` (`str`): Описание команды выхода.
-- `exit_command_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`).
-
----
-
-#### **declared *methods***     
-
----
-
-**App().**`start_polling() -> None`  
-
-*method mean* **::** запускает жизненный цикл приложения
-
----
-
-**App().**`include_router(router: Router, is_main: bool = False) -> None`  
-
-*param* `router: Router` **::** регистрируемый роутер  
-
-*param* `is_main: bool` **::** будет ли являться регистрируемый роутер главным  
-*example* **::** `True` или `False` 
-
-*method mean* **::** регистрирует роутер в приложении
-
----
-
-**App().**`set_initial_message(message: str) -> None`  
-
-*param* `message: str` **::** устанавливаемое приветственное сообщение  
-*example* **::** `"Hello, I'm a cli example app"`
-
-*method mean* **::** устанавливает сообщение, которое будет отображено при запуске программы
-
----
-
-**App().**`set_farewell_message(message: str) -> None`  
-
-*param* `message: str` **::** устанавливаемое сообщение при выходе  
-*example* **::** `"GoodBye !"`
-
-*method mean* **::** устанавливает сообщение, которое будет отображено при выходе
-
----
-
-**App().**`set_description_message_pattern(pattern: str) -> None`  
-
-*param* `pattern: str` **::** паттерн описания команды при её выводе в консоль  
-*example* **::** `"[{command}] *=*=* {description}"`
-
-*method mean* **::** устанавливает приветственное сообщение
-
----
-
-**App().**`get_main_router() -> Router`  
-
-*method mean* **::** возвращает `Router()`, который является главным в приложении
-
----
-
-**App().**`get_all_app_commands() -> list[str]`  
-
-*method mean* **::** возвращает список команд всех зарегистрированных роутеров, сохраняя их регистр
-
----
-
-#### Примечания  
-
--  Среди зарегистрированных в приложении роутеров должен быть один главный, является ли роутер главным
-определяется значением аргумента `is_main` равным `True`, в методе `App().include_router()`, который по умолчанию равен
-`False`, если в приложении зарегистрирован лишь один роутер, то он неявно устанавливается главным, если
-зарегистрировано больше одного роутера, то требуется явное указание главного. При регистрации более одного
-главного роутера вызывается исключение `OnlyOneMainRouterIsAllowedException`. При регистрации более одного
-роутера и отсутствии указания главного вызывается исключение `MissingMainRouterException`  
-
-- В устанавливаемом паттерне сообщения описания команды необходимы быть два ключевых слова: 
-`command` и `description`, каждое из которых должно быть заключено в фигурные скобки, после обработки
-паттерна на места этих ключевых слов будут подставлены соответствующие значения команды, при отсутствии
-этих двух ключевых слов будет вызвано исключение `InvalidDescriptionMessagePatternException`
-
-- Команды приложения не должны повторяться, при значении атрибута `ignore_command_register` равным `True`
-допускается создание обработчиков для разных регистров одинаковых символов в команде, для примера `u` и `U`,
-при значении атрибута `ignore_command_register` класса `App` равным `False` тот же пример вызывает исключение 
-`RepeatedCommandInDifferentRoutersException`. Исключение вызывается только при наличии пересекающихся команд 
-у __<u>разных</u>__ роутеров
-
-- У главного обработчика должен быть зарегистрирован обработчик неизвестных команд:  
-```python
-router = Router()
-
-@router.unknown_command
-def unknown_command(command):
-    print(f'Command "{command}" undefined')
-```
-При отсутствии обработчика неизвестных команд у главного роутера будет вызвано исключение
-`MissingHandlerForUnknownCommandsException`. При регистрации обработчика неизвестных команд у
-__<u>не</u>__ главного роутера будет вызвано исключение `HandlerForUnknownCommandsOnNonMainRouterException`
-
-
-
-
-#### Исключения
-
-- `InvalidRouterInstanceException` — Переданный объект в метод `App().include_router()` не является экземпляром класса `Router`.
-- `InvalidDescriptionMessagePatternException` — Неправильный формат паттерна описания команд.
-- `OnlyOneMainRouterIsAllowedException` — Регистрация более одного главного роутера.
-  - `MissingMainRouterException` — Отсутствует главный роутер.    
-- `MissingHandlerForUnknownCommandsException` — В основном роутере отсутствует обработчик неизвестных команд.
-- `HandlerForUnknownCommandsOnNonMainRouterException` — Обработчик неизвестных команд определён не у основного роутера.
-- `NoRegisteredRoutersException` — Отсутствуют зарегистрированные роутеры.
-- `NoRegisteredHandlersException` — У роутера нет ни одного обработчика команд.
-- `RepeatedCommandInDifferentRoutersException` — Одна и та же команда зарегистрирована в разных роутерах.
-
----
-
-###  *class* :: `Router` 
-Класс, который определяет и конфигурирует обработчики команд
-
-#### Конструктор
-```python
-Router(title: str = 'Commands group title:',
-       name: str = 'subordinate')
-```
-
-**Аргументы:**
-- **name : mean**
-- `title` (`str`): Заголовок группы команд.
-- `name` (`str`): Персональное название роутера
-
-
-
-#### **declared *methods***     
-
----
-
-**`@`Router().**`command(command: str, description: str = None)`  
-
-*param* `command: str` **::** строковый триггер, который будет выполнять указанные действия  
-*example* **::** `U` / `update` / `ExaMPLE` 
-
-*param* `description: str` **::** описание команды, которое будет выведено в консоль  
-*example* **::** `description for update command` или `example description` 
-
-*method mean* **::** декоратор регистрирует функцию как обработчик команды
-
----
-
-**`@`Router().**`unknown_command`   
-
-*method mean* **::** декоратор регистрирует функцию как обработчик неизвестных команд
-
----
-
-**Router().**`get_name() -> str`  
-
-*method mean* **::** возвращает установленное название роутера
-
----
-
-**Router().**`get_title() -> str`  
-
-*method mean* **::** возвращает установленный заголовок группы команд данного роутера
-
----
-
-**Router().**`get_router_info() -> dict`  
-
-*method mean* **::** возвращает информацию о роутере
-
----
-
-**Router().**`get_all_commands() -> list[str]`  
-
-*method mean* **::** возвращает все зарегистрированные команды для данного роутера
-
----
-
-#### Исключения 
-- `InvalidCommandInstanceException` - Переданный объект для регистрации команды не является строкой
-- `InvalidDescriptionInstanceException` - Переданный объект для регистрации описания команды не является строкой
-- `UnknownCommandHandlerHasAlreadyBeenCreatedException` - Обработчик неизвестных команд уже создан
-- `RepeatedCommandException` - Одна и та же команда зарегистрирована в одном роутере
-

argenta-0.3.5.dist-info/RECORD

@@ -1,19 +0,0 @@
-argenta/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-argenta/app/__init__.py,sha256=yOt8-2lholVRUtLPwAXuemh115q1unP1PKLBR_7cd4E,152
-argenta/app/entity.py,sha256=Vrg7C1EifCJK-96jlLOQ0Jd3EBgGhsotNrYimEkg72k,11250
-argenta/app/exceptions.py,sha256=ruI_MwJQtBLrnWxJbKlSRE50c5FjnZ9qXJma34kPZhk,1253
-argenta/command/__init__.py,sha256=yRSj5CtLjxwjKiokUGdSmuBZPOF_qheRyG0NW1pv7vo,27
-argenta/command/entity.py,sha256=nphBNvvXbl_4m6csWttXhU2DmNNCwjGCsGcBDV0u05s,4801
-argenta/command/exceptions.py,sha256=jo-jtGHtvwsblElioo5AVHrAmmYBa2xldPHwRKFeFiI,917
-argenta/command/params/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-argenta/command/params/flag/__init__.py,sha256=y6rJLdag5qxONg1CzcP7gi6rCeix9UsG1AVANX3fnJs,68
-argenta/command/params/flag/entity.py,sha256=cBGUiA9h9ytcQDGp5HVMM4EOcx7jveYmhY6V_1CsOO4,1721
-argenta/command/params/flag/flags_group/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-argenta/command/params/flag/flags_group/entity.py,sha256=vicuhXVyf9szr7mt1jokfjBCnaCac_HE8GUM_PJqMMM,591
-argenta/router/__init__.py,sha256=ZedowNgGR9OphLSg9fXp6-uvjyf23rbq-rEtuHScAIM,87
-argenta/router/entity.py,sha256=QcAwmwah1Noe5Zkf_gJoXiJ5YJeEwuUfRhyjOvCZlgg,4962
-argenta/router/exceptions.py,sha256=l9rD_ySeWLYBDPv7R8XYMBWpAE2QOKjYAcZPcTjfUMI,981
-argenta-0.3.5.dist-info/LICENSE,sha256=zmqoGh2n5rReBv4s8wPxF_gZEZDgauJYSPMuPczgOiU,1082
-argenta-0.3.5.dist-info/METADATA,sha256=jBTRzYbdrYYQJ1I5rENFgyAC7CDTUHalj5QqN56_XX4,12638
-argenta-0.3.5.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-argenta-0.3.5.dist-info/RECORD,,