argenta 0.4.7__tar.gz → 0.4.9__tar.gz

{argenta-0.4.7 → argenta-0.4.9}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.3
 Name: argenta
-Version: 0.4.7
-Summary: python library for creating custom shells
+Version: 0.4.9
+Summary: Python library for creating TUI
 License: MIT
 Author: kolo
 Author-email: kolo.is.main@gmail.com
@@ -20,7 +20,7 @@ Description-Content-Type: text/markdown
 ---
 
 ## Описание
-**Argenta** — Python library for creating custom shells
+**Argenta** — Python library for creating TUI
 
 ![prewiev](https://github.com/koloideal/Argenta/blob/kolo/imgs/mock_app_preview_last.png?raw=True)  
 Пример внешнего вида TUI, написанного с помощью Argenta  
@@ -119,8 +119,9 @@ App(prompt: str = 'What do you want to do?\n',
     exit_command_description: str = 'Exit command',
     system_points_title: str = 'System points:',
     ignore_command_register: bool = True,
-    line_separate: str = '-----',
+    dividing_line: StaticDividingLine | DynamicDividingLine = StaticDividingLine(),
     repeat_command_groups: bool = True,
+    full_override_system_messages: bool = False
     print_func: Callable[[str], None] = Console().print)
 ```
 **Аргументы:**
@@ -132,8 +133,9 @@ App(prompt: str = 'What do you want to do?\n',
 - `exit_command_description` (`str`): Описание команды выхода.
 - `system_points_title` (`str`): Заголовок перед списком системных команд.
 - `ignore_command_register` (`bool`): Игнорировать регистр всех команд.
-- `line_separate` (`str`): Разделительная строка между командами.
+- `dividing_line` (`StaticDividingLine | DynamicDividingLine`): Разделительная строка.
 - `repeat_command_groups` (`bool`): Повторять описание команд перед вводом.
+- `full_override_system_messages` (`bool`): Переопределить ли дефолтное оформление сообщений ([подробнее см.](#override_defaults))
 - `print_func` (`Callable[[str], None]`): Функция вывода текста в терминал.
 
 ---
@@ -241,6 +243,11 @@ App(prompt: str = 'What do you want to do?\n',
 - Наиболее частые сообщение при запуске предопределены и доступны для быстрого
 использования: `argenta.app.defaults.PredeterminedMessages`
 
+<a name="override_defaults"></a>
+- Если `override_system_messages`=`False`, то при переопределении таких атрибутов как `initial_message` и
+`farawell_message` будет использовано дефолтное оформление текста, в виде красного ascii арта, при значении
+`override_system_messages`=`True` системные сообщения будут отображены в точности какими были переданы
+
 
 
 
@@ -253,6 +260,36 @@ App(prompt: str = 'What do you want to do?\n',
 
 ---
 
+##  *class* :: `StaticDivideLine` 
+Класс, экземпляр которого представляет собой строковый разделитель фиксированной длины
+
+### Конструктор
+```python
+StaticDivideLine(unit_part: str = '-', 
+                 length: int = 25)
+```
+
+**Аргументы:**
+- **name : mean**
+- `unit_part` (`str`): Единичная часть строкового разделителя
+- `length` (`int`): Длина строкового разделителя
+
+---
+
+##  *class* :: `DinamicDivideLine` 
+Строковый разделитель динамической длины, которая определяется длиной обрамляемого вывода команды
+
+### Конструктор
+```python
+DinamicDivideLine(unit_part: str = '-')
+```
+
+**Аргументы:**
+- **name : mean**
+- `unit_part` (`str`): Единичная часть строкового разделителя
+
+---
+
 ##  *class* :: `Router` 
 Класс, который определяет и конфигурирует обработчики команд
 

{argenta-0.4.7 → argenta-0.4.9}/README.md

@@ -3,7 +3,7 @@
 ---
 
 ## Описание
-**Argenta** — Python library for creating custom shells
+**Argenta** — Python library for creating TUI
 
 ![prewiev](https://github.com/koloideal/Argenta/blob/kolo/imgs/mock_app_preview_last.png?raw=True)  
 Пример внешнего вида TUI, написанного с помощью Argenta  
@@ -102,8 +102,9 @@ App(prompt: str = 'What do you want to do?\n',
     exit_command_description: str = 'Exit command',
     system_points_title: str = 'System points:',
     ignore_command_register: bool = True,
-    line_separate: str = '-----',
+    dividing_line: StaticDividingLine | DynamicDividingLine = StaticDividingLine(),
     repeat_command_groups: bool = True,
+    full_override_system_messages: bool = False
     print_func: Callable[[str], None] = Console().print)
 ```
 **Аргументы:**
@@ -115,8 +116,9 @@ App(prompt: str = 'What do you want to do?\n',
 - `exit_command_description` (`str`): Описание команды выхода.
 - `system_points_title` (`str`): Заголовок перед списком системных команд.
 - `ignore_command_register` (`bool`): Игнорировать регистр всех команд.
-- `line_separate` (`str`): Разделительная строка между командами.
+- `dividing_line` (`StaticDividingLine | DynamicDividingLine`): Разделительная строка.
 - `repeat_command_groups` (`bool`): Повторять описание команд перед вводом.
+- `full_override_system_messages` (`bool`): Переопределить ли дефолтное оформление сообщений ([подробнее см.](#override_defaults))
 - `print_func` (`Callable[[str], None]`): Функция вывода текста в терминал.
 
 ---
@@ -224,6 +226,11 @@ App(prompt: str = 'What do you want to do?\n',
 - Наиболее частые сообщение при запуске предопределены и доступны для быстрого
 использования: `argenta.app.defaults.PredeterminedMessages`
 
+<a name="override_defaults"></a>
+- Если `override_system_messages`=`False`, то при переопределении таких атрибутов как `initial_message` и
+`farawell_message` будет использовано дефолтное оформление текста, в виде красного ascii арта, при значении
+`override_system_messages`=`True` системные сообщения будут отображены в точности какими были переданы
+
 
 
 
@@ -236,6 +243,36 @@ App(prompt: str = 'What do you want to do?\n',
 
 ---
 
+##  *class* :: `StaticDivideLine` 
+Класс, экземпляр которого представляет собой строковый разделитель фиксированной длины
+
+### Конструктор
+```python
+StaticDivideLine(unit_part: str = '-', 
+                 length: int = 25)
+```
+
+**Аргументы:**
+- **name : mean**
+- `unit_part` (`str`): Единичная часть строкового разделителя
+- `length` (`int`): Длина строкового разделителя
+
+---
+
+##  *class* :: `DinamicDivideLine` 
+Строковый разделитель динамической длины, которая определяется длиной обрамляемого вывода команды
+
+### Конструктор
+```python
+DinamicDivideLine(unit_part: str = '-')
+```
+
+**Аргументы:**
+- **name : mean**
+- `unit_part` (`str`): Единичная часть строкового разделителя
+
+---
+
 ##  *class* :: `Router` 
 Класс, который определяет и конфигурирует обработчики команд
 

argenta-0.4.9/argenta/app/dividing_line/__init__.py

@@ -0,0 +1,4 @@
+__all__ = ["StaticDividingLine", "DynamicDividingLine"]
+
+
+from argenta.app.dividing_line.models import StaticDividingLine, DynamicDividingLine

argenta-0.4.9/argenta/app/dividing_line/models.py

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

{argenta-0.4.7 → argenta-0.4.9}/argenta/app/models.py

@@ -1,11 +1,14 @@
 from typing import Callable
 from rich.console import Console
 from art import text2art
+from contextlib import redirect_stdout
+import io
 import re
 
 from argenta.command.models import Command, InputCommand
 from argenta.router import Router
 from argenta.router.defaults import system_router
+from argenta.app.dividing_line.models import StaticDividingLine, DynamicDividingLine
 from argenta.command.exceptions import (UnprocessedInputFlagException,
                                         RepeatedInputFlagsException,
                                         EmptyInputCommandException,
@@ -21,23 +24,25 @@ 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',
+                 initial_message: str = '\nArgenta\n',
+                 farewell_message: str = '\nSee you\n',
                  exit_command: str = 'Q',
                  exit_command_description: str = 'Exit command',
                  system_points_title: str = 'System points:',
                  ignore_command_register: bool = True,
-                 line_separate: str = '-----',
+                 dividing_line: StaticDividingLine | DynamicDividingLine = StaticDividingLine(),
                  repeat_command_groups: bool = True,
+                 full_override_system_messages: bool = False,
                  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._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.farewell_message = farewell_message
         self.initial_message = initial_message
@@ -52,22 +57,14 @@ class BaseApp:
         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 == '-----')
+        self._setup_default_view()
 
 
-    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 _setup_default_view(self):
+        if not self._full_override_system_messages:
+            self.initial_message = f'\n[bold red]{text2art(self.initial_message, font='tarty1')}\n\n'
+            self.farewell_message = (f'[bold red]\n{text2art(f'\n{self.farewell_message}\n', font='chanky')}[/bold red]\n'
+                                     f'[red i]github.com/koloideal/Argenta[/red i] | [red bold i]made by kolo[/red bold i]\n')
 
 
     def _validate_number_of_routers(self) -> None:
@@ -100,7 +97,15 @@ class BaseApp:
                     return False
                 elif handled_command_trigger == command.get_trigger():
                     return False
-        self.unknown_command_handler(command)
+        if isinstance(self._dividing_line, StaticDividingLine):
+            self._print_func(self._dividing_line.get_full_line())
+            self.unknown_command_handler(command)
+            self._print_func(self._dividing_line.get_full_line())
+        elif isinstance(self._dividing_line, DynamicDividingLine):
+            with redirect_stdout(io.StringIO()) as f:
+                self.unknown_command_handler(command)
+                res: str = f.getvalue()
+            self._print_framed_text_with_dynamic_line(res)
         return True
 
 
@@ -124,6 +129,15 @@ class BaseApp:
                 self.empty_input_command_handler()
 
 
+    def _print_framed_text_with_dynamic_line(self, text: str):
+        clear_text = re.sub(r'\u001b\[[0-9;]*m', '', text)
+        max_length_line = max([len(line) for line in clear_text.split('\n')])
+        max_length_line = max_length_line if 10 <= max_length_line <= 80 else 80 if max_length_line > 80 else 10
+        self._print_func(self._dividing_line.get_full_line(max_length_line))
+        print(text.strip('\n'))
+        self._print_func(self._dividing_line.get_full_line(max_length_line))
+
+
 
 class App(BaseApp):
     def start_polling(self) -> None:
@@ -148,24 +162,35 @@ class App(BaseApp):
             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)
+                if isinstance(self._dividing_line, StaticDividingLine):
+                    self._print_func(self._dividing_line.get_full_line())
+                    self._error_handler(error, raw_command)
+                    self._print_func(self._dividing_line.get_full_line())
+                elif isinstance(self._dividing_line, DynamicDividingLine):
+                    with redirect_stdout(io.StringIO()) as f:
+                        self._error_handler(error, raw_command)
+                        res: str = f.getvalue()
+                    self._print_framed_text_with_dynamic_line(res)
                 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)
+            if isinstance(self._dividing_line, StaticDividingLine):
+                self._print_func(self._dividing_line.get_full_line())
+                for registered_router in self._registered_routers:
+                    registered_router.input_command_handler(input_command)
+                self._print_func(self._dividing_line.get_full_line())
+            elif isinstance(self._dividing_line, DynamicDividingLine):
+                with redirect_stdout(io.StringIO()) as f:
+                    for registered_router in self._registered_routers:
+                        registered_router.input_command_handler(input_command)
+                    res: str = f.getvalue()
+                self._print_framed_text_with_dynamic_line(res)
 
-            self._print_func(self._line_separate)
             if not self._repeat_command_groups_description:
                 self._print_func(self._prompt)
 

{argenta-0.4.7 → argenta-0.4.9}/argenta/command/models.py

@@ -60,6 +60,7 @@ class InputCommand(BaseCommand, Generic[InputCommandType]):
     def get_input_flags(self) -> InputFlags:
         return self._input_flags
 
+
     @staticmethod
     def parse(raw_command: str) -> InputCommandType:
         if not raw_command:

argenta-0.4.9/argenta/router/__init__.py

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

{argenta-0.4.7 → argenta-0.4.9}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "argenta"
-version = "0.4.7"
-description = "python library for creating custom shells"
+version = "0.4.9"
+description = "Python library for creating TUI"
 authors = [
     {name = "kolo", email = "kolo.is.main@gmail.com"}
 ]

argenta-0.4.7/argenta/router/__init__.py

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