argenta 0.5.0a0__tar.gz → 0.5.0b2__tar.gz

{argenta-0.5.0a0 → argenta-0.5.0b2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: argenta
-Version: 0.5.0a0
+Version: 0.5.0b2
 Summary: Python library for creating TUI
 License: MIT
 Author: kolo
@@ -22,7 +22,7 @@ Description-Content-Type: text/markdown
 ## Описание
 **Argenta** — Python library for creating TUI
 
-![prewiev](https://github.com/koloideal/Argenta/blob/kolo/imgs/mock_app_preview_last.png?raw=True)  
+![preview](https://github.com/koloideal/Argenta/blob/kolo/imgs/mock_app_preview_last.png?raw=True)  
 Пример внешнего вида TUI, написанного с помощью Argenta  
 
 ---
@@ -112,16 +112,16 @@ def handler_with_flags(flags: InputFlags):
 
 ### Конструктор
 ```python
-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:',
+App(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,
-    full_override_system_messages: bool = False
+    override_system_messages: bool = False,
+    autocompleter: AutoCompleter = AutoCompleter(),
     print_func: Callable[[str], None] = Console().print)
 ```
 **Аргументы:**
@@ -129,13 +129,13 @@ App(prompt: str = 'What do you want to do?\n',
 - `prompt` (`str`): Сообщение перед вводом команды.
 - `initial_message` (`str`): Приветственное сообщение при запуске.
 - `farewell_message` (`str`): Сообщение при выходе.
-- `exit_command` (`str`): Команда выхода (по умолчанию `'Q'`).
-- `exit_command_description` (`str`): Описание команды выхода.
+- `exit_command` (`Command`): Сущность команды, которая будет отвечать за завершение работы.
 - `system_points_title` (`str`): Заголовок перед списком системных команд.
 - `ignore_command_register` (`bool`): Игнорировать регистр всех команд.
 - `dividing_line` (`StaticDividingLine | DynamicDividingLine`): Разделительная строка.
 - `repeat_command_groups` (`bool`): Повторять описание команд перед вводом.
-- `full_override_system_messages` (`bool`): Переопределить ли дефолтное оформление сообщений ([подробнее см.](#override_defaults))
+- `override_system_messages` (`bool`): Переопределить ли дефолтное оформление сообщений ([подробнее см.](#override_defaults))
+- `autocompleter` (`AutoCompleter`): Сущность автодополнителя ввода.
 - `print_func` (`Callable[[str], None]`): Функция вывода текста в терминал.
 
 ---
@@ -260,6 +260,26 @@ App(prompt: str = 'What do you want to do?\n',
 
 ---
 
+##  *class* :: `AutoCompleter` 
+Класс, экземпляр которого представляет собой автодополнитель ввода
+
+### Конструктор
+```python
+AutoCompleter(history_filename: str = False, 
+              autocomplete_button: str = 'tab')
+```
+
+**Аргументы:**
+- **name : mean**
+- `history_filename` (`str` | `False`): Путь к файлу, который будет являться или является 
+историй пользовательского ввода, в последующем эти команды будут автодополняться, файл
+может не существовать при инициализации, тогда он будет создан, при значении аргумента `False`
+история пользовательского ввода будет существовать только в пределах сессии и не сохраняться в файл
+- `autocomplete_button` (`str`): Строковое обозначение кнопки на клавиатуре, которая будет
+использоваться для автодополнения при вводе, по умолчанию `tab`
+
+---
+
 ##  *class* :: `StaticDivideLine` 
 Класс, экземпляр которого представляет собой строковый разделитель фиксированной длины
 
@@ -295,7 +315,7 @@ DinamicDivideLine(unit_part: str = '-')
 
 ### Конструктор
 ```python
-Router(title: str = 'Commands group title:',
+Router(title: str | None = None,
        name: str = 'Default')
 ```
 

{argenta-0.5.0a0 → argenta-0.5.0b2}/README.md

@@ -5,7 +5,7 @@
 ## Описание
 **Argenta** — Python library for creating TUI
 
-![prewiev](https://github.com/koloideal/Argenta/blob/kolo/imgs/mock_app_preview_last.png?raw=True)  
+![preview](https://github.com/koloideal/Argenta/blob/kolo/imgs/mock_app_preview_last.png?raw=True)  
 Пример внешнего вида TUI, написанного с помощью Argenta  
 
 ---
@@ -95,16 +95,16 @@ def handler_with_flags(flags: InputFlags):
 
 ### Конструктор
 ```python
-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:',
+App(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,
-    full_override_system_messages: bool = False
+    override_system_messages: bool = False,
+    autocompleter: AutoCompleter = AutoCompleter(),
     print_func: Callable[[str], None] = Console().print)
 ```
 **Аргументы:**
@@ -112,13 +112,13 @@ App(prompt: str = 'What do you want to do?\n',
 - `prompt` (`str`): Сообщение перед вводом команды.
 - `initial_message` (`str`): Приветственное сообщение при запуске.
 - `farewell_message` (`str`): Сообщение при выходе.
-- `exit_command` (`str`): Команда выхода (по умолчанию `'Q'`).
-- `exit_command_description` (`str`): Описание команды выхода.
+- `exit_command` (`Command`): Сущность команды, которая будет отвечать за завершение работы.
 - `system_points_title` (`str`): Заголовок перед списком системных команд.
 - `ignore_command_register` (`bool`): Игнорировать регистр всех команд.
 - `dividing_line` (`StaticDividingLine | DynamicDividingLine`): Разделительная строка.
 - `repeat_command_groups` (`bool`): Повторять описание команд перед вводом.
-- `full_override_system_messages` (`bool`): Переопределить ли дефолтное оформление сообщений ([подробнее см.](#override_defaults))
+- `override_system_messages` (`bool`): Переопределить ли дефолтное оформление сообщений ([подробнее см.](#override_defaults))
+- `autocompleter` (`AutoCompleter`): Сущность автодополнителя ввода.
 - `print_func` (`Callable[[str], None]`): Функция вывода текста в терминал.
 
 ---
@@ -243,6 +243,26 @@ App(prompt: str = 'What do you want to do?\n',
 
 ---
 
+##  *class* :: `AutoCompleter` 
+Класс, экземпляр которого представляет собой автодополнитель ввода
+
+### Конструктор
+```python
+AutoCompleter(history_filename: str = False, 
+              autocomplete_button: str = 'tab')
+```
+
+**Аргументы:**
+- **name : mean**
+- `history_filename` (`str` | `False`): Путь к файлу, который будет являться или является 
+историй пользовательского ввода, в последующем эти команды будут автодополняться, файл
+может не существовать при инициализации, тогда он будет создан, при значении аргумента `False`
+история пользовательского ввода будет существовать только в пределах сессии и не сохраняться в файл
+- `autocomplete_button` (`str`): Строковое обозначение кнопки на клавиатуре, которая будет
+использоваться для автодополнения при вводе, по умолчанию `tab`
+
+---
+
 ##  *class* :: `StaticDivideLine` 
 Класс, экземпляр которого представляет собой строковый разделитель фиксированной длины
 
@@ -278,7 +298,7 @@ DinamicDivideLine(unit_part: str = '-')
 
 ### Конструктор
 ```python
-Router(title: str = 'Commands group title:',
+Router(title: str | None = None,
        name: str = 'Default')
 ```
 

{argenta-0.5.0a0 → argenta-0.5.0b2}/argenta/app/autocompleter/entity.py

@@ -1,5 +1,4 @@
 import os
-
 import readline
 
 

{argenta-0.5.0a0 → argenta-0.5.0b2}/argenta/app/exceptions.py

@@ -1,8 +1,3 @@
-class InvalidRouterInstanceException(Exception):
-    def __str__(self):
-        return "Invalid Router Instance"
-
-
 class NoRegisteredRoutersException(Exception):
     def __str__(self):
         return "No Registered Router Found"

{argenta-0.5.0a0 → argenta-0.5.0b2}/argenta/app/models.py

@@ -15,8 +15,7 @@ from argenta.command.exceptions import (UnprocessedInputFlagException,
                                         RepeatedInputFlagsException,
                                         EmptyInputCommandException,
                                         BaseInputCommandException)
-from argenta.app.exceptions import (InvalidRouterInstanceException,
-                                    NoRegisteredRoutersException,
+from argenta.app.exceptions import (NoRegisteredRoutersException,
                                     NoRegisteredHandlersException)
 from argenta.app.registered_routers.entity import RegisteredRouters
 
@@ -32,7 +31,7 @@ class AppInit:
                  ignore_command_register: bool = True,
                  dividing_line: StaticDividingLine | DynamicDividingLine = StaticDividingLine(),
                  repeat_command_groups: bool = True,
-                 full_override_system_messages: bool = False,
+                 override_system_messages: bool = False,
                  autocompleter: AutoCompleter = AutoCompleter(),
                  print_func: Callable[[str], None] = Console().print) -> None:
         self._prompt = prompt
@@ -42,7 +41,7 @@ class AppInit:
         self._dividing_line = dividing_line
         self._ignore_command_register = ignore_command_register
         self._repeat_command_groups_description = repeat_command_groups
-        self._full_override_system_messages = full_override_system_messages
+        self._override_system_messages = override_system_messages
         self._autocompleter = autocompleter
 
         self._farewell_message = farewell_message
@@ -53,10 +52,10 @@ class AppInit:
         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._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: {command.get_trigger()}")
+        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)
 
 
@@ -112,7 +111,7 @@ class AppNonStandardHandlers(AppPrinters):
             if self._ignore_command_register:
                 system_router.input_command_handler(command)
                 return True
-            elif command.get_trigger() == self._exit_command:
+            elif command.get_trigger() == self._exit_command.get_trigger():
                 system_router.input_command_handler(command)
                 return True
         return False
@@ -128,7 +127,7 @@ class AppNonStandardHandlers(AppPrinters):
                 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:
+                    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
@@ -179,7 +178,7 @@ class AppSetups(AppValidators, AppPrinters):
             self._registered_routers.add_registered_router(system_router)
 
     def _setup_default_view(self):
-        if not self._full_override_system_messages:
+        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'
@@ -201,6 +200,7 @@ class AppSetups(AppValidators, AppPrinters):
 
         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()
@@ -253,9 +253,6 @@ class App(AppSetters, AppNonStandardHandlers, AppSetups):
 
 
     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)
 

{argenta-0.5.0a0 → argenta-0.5.0b2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "argenta"
-version = "0.5.0-alpha"
+version = "0.5.0-beta2"
 description = "Python library for creating TUI"
 authors = [
     {name = "kolo", email = "kolo.is.main@gmail.com"}