argenta 0.4.1__tar.gz → 0.4.6__tar.gz

{argenta-0.4.1 → argenta-0.4.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: argenta
-Version: 0.4.1
+Version: 0.4.6
 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](imgs/mock_app_preview_last.png)  
+Пример внешнего вида TUI, написанного с помощью Argenta  
+
 ---
 
 # Установка
@@ -71,14 +76,14 @@ if __name__ == '__main__':
 import re
 from argenta.router import Router
 from argenta.command import Command
-from argenta.command.flag import FlagsGroup, Flag
+from argenta.command.flag import Flags, Flag, InputFlags
 
 router = Router()
 
-registered_flags = FlagsGroup(
-    Flag(flag_name='host',
-         flag_prefix='--',
-         possible_flag_values=re.compile(r'^192.168.\d{1,3}.\d{1,3}$')),
+registered_flags = Flags(
+    Flag(name='host',
+         prefix='--',
+         possible_values=re.compile(r'^192.168.\d{1,3}.\d{1,3}$')),
     Flag('port', '--', re.compile(r'^[0-9]{1,4}$')))
 
 
@@ -90,10 +95,10 @@ def handler():
 @router.command(Command(trigger="ssh",
                         description='connect via ssh',
                         flags=registered_flags))
-def handler_with_flags(flags: dict):
+def handler_with_flags(flags: InputFlags):
     for flag in flags:
-        print(f'Flag name: {flag['name']}\n'
-              f'Flag value: {flag['value']}')
+        print(f'Flag name: {flag.get_name()}\n'
+              f'Flag value: {flag.get_value()}')
 ```
 
 ---
@@ -314,7 +319,6 @@ Router(title: str = 'Commands group title:',
 ---
 
 ### Исключения
-- `RepeatedCommandException` - Одна и та же команда зарегистрирована в одном роутере
 - `RepeatedFlagNameException` - Повторяющиеся зарегистрированные флаги в команде
 - `TooManyTransferredArgsException` - Слишком много зарегистрированных аргументов у обработчика команды
 - `RequiredArgumentNotPassedException` - Не зарегистрирован обязательный аргумент у обработчика команды(аргумент, через который будут переданы флаги введённой команды)
@@ -330,14 +334,14 @@ Router(title: str = 'Commands group title:',
 ```python
 Command(trigger: str,
         description: str = None,
-        flags: Flag | FlagsGroup = None)
+        flags: Flag | Flags = None)
 ```
 
 **Аргументы:**
 - **name : mean**
 - `trigger` (`str`): Строковый триггер
 - `description` (`str`): Описание команды, которое будет выведено в консоль при запуске оболочки
-- `flags` (`Flag | FlagsGroup`): Флаги, которые будут обработаны при их наличии во вводе юзера
+- `flags` (`Flag | Flags`): Флаги, которые будут обработаны при их наличии во вводе юзера
 
 ---
 
@@ -353,7 +357,7 @@ Command(trigger: str,
 
 ---
 
-#### **.get_registered_flags() -> `FlagsGroup | None`**  
+#### **.get_registered_flags() -> `Flags | None`**  
 
 *method mean* **::** возвращает зарегистрированные флаги экземпляра
 
@@ -417,14 +421,14 @@ Flag(flag_name: str,
 
 ---
 
-##  *class* :: `FlagsGroup` 
+##  *class* :: `Flags` 
 Класс, объединяющий список флагов в один объект, используется в качестве 
 передаваемого аргумента `flags` экземпляру класса `Command`, при регистрации
 хэндлера
 
 ### Конструктор
 ```python
-FlagsGroup(*flagы: Flag)
+Flags(*flagы: Flag)
 ```
 
 ---

{argenta-0.4.1 → argenta-0.4.6}/README.md

@@ -5,6 +5,9 @@
 ## Описание
 **Argenta** — Python library for creating custom shells
 
+![prewiev](imgs/mock_app_preview_last.png)  
+Пример внешнего вида TUI, написанного с помощью Argenta  
+
 ---
 
 # Установка
@@ -56,14 +59,14 @@ if __name__ == '__main__':
 import re
 from argenta.router import Router
 from argenta.command import Command
-from argenta.command.flag import FlagsGroup, Flag
+from argenta.command.flag import Flags, Flag, InputFlags
 
 router = Router()
 
-registered_flags = FlagsGroup(
-    Flag(flag_name='host',
-         flag_prefix='--',
-         possible_flag_values=re.compile(r'^192.168.\d{1,3}.\d{1,3}$')),
+registered_flags = Flags(
+    Flag(name='host',
+         prefix='--',
+         possible_values=re.compile(r'^192.168.\d{1,3}.\d{1,3}$')),
     Flag('port', '--', re.compile(r'^[0-9]{1,4}$')))
 
 
@@ -75,10 +78,10 @@ def handler():
 @router.command(Command(trigger="ssh",
                         description='connect via ssh',
                         flags=registered_flags))
-def handler_with_flags(flags: dict):
+def handler_with_flags(flags: InputFlags):
     for flag in flags:
-        print(f'Flag name: {flag['name']}\n'
-              f'Flag value: {flag['value']}')
+        print(f'Flag name: {flag.get_name()}\n'
+              f'Flag value: {flag.get_value()}')
 ```
 
 ---
@@ -299,7 +302,6 @@ Router(title: str = 'Commands group title:',
 ---
 
 ### Исключения
-- `RepeatedCommandException` - Одна и та же команда зарегистрирована в одном роутере
 - `RepeatedFlagNameException` - Повторяющиеся зарегистрированные флаги в команде
 - `TooManyTransferredArgsException` - Слишком много зарегистрированных аргументов у обработчика команды
 - `RequiredArgumentNotPassedException` - Не зарегистрирован обязательный аргумент у обработчика команды(аргумент, через который будут переданы флаги введённой команды)
@@ -315,14 +317,14 @@ Router(title: str = 'Commands group title:',
 ```python
 Command(trigger: str,
         description: str = None,
-        flags: Flag | FlagsGroup = None)
+        flags: Flag | Flags = None)
 ```
 
 **Аргументы:**
 - **name : mean**
 - `trigger` (`str`): Строковый триггер
 - `description` (`str`): Описание команды, которое будет выведено в консоль при запуске оболочки
-- `flags` (`Flag | FlagsGroup`): Флаги, которые будут обработаны при их наличии во вводе юзера
+- `flags` (`Flag | Flags`): Флаги, которые будут обработаны при их наличии во вводе юзера
 
 ---
 
@@ -338,7 +340,7 @@ Command(trigger: str,
 
 ---
 
-#### **.get_registered_flags() -> `FlagsGroup | None`**  
+#### **.get_registered_flags() -> `Flags | None`**  
 
 *method mean* **::** возвращает зарегистрированные флаги экземпляра
 
@@ -402,14 +404,14 @@ Flag(flag_name: str,
 
 ---
 
-##  *class* :: `FlagsGroup` 
+##  *class* :: `Flags` 
 Класс, объединяющий список флагов в один объект, используется в качестве 
 передаваемого аргумента `flags` экземпляру класса `Command`, при регистрации
 хэндлера
 
 ### Конструктор
 ```python
-FlagsGroup(*flagы: Flag)
+Flags(*flagы: Flag)
 ```
 
 ---

argenta-0.4.6/argenta/app/__init__.py

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

argenta-0.4.6/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-0.4.1 → argenta-0.4.6}/argenta/app/exceptions.py

@@ -23,13 +23,3 @@ class NoRegisteredHandlersException(Exception):
         self.router_name = router_name
     def __str__(self):
         return f"No Registered Handlers Found For '{self.router_name}'"
-
-
-class RepeatedCommandInDifferentRoutersException(Exception):
-    def __str__(self):
-        return "Commands in different handlers cannot be repeated"
-
-
-class IncorrectNumberOfHandlerArgsException(Exception):
-    def __str__(self):
-        return "Incorrect Input Flags Handler has incorrect number of arguments"

argenta-0.4.6/argenta/app/models.py

@@ -0,0 +1,214 @@
+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)
+
+                if not self._repeat_command_groups_description:
+                    self._print_func(self._prompt)
+                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)
+                if not self._repeat_command_groups_description:
+                    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)
+            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-0.4.6/argenta/app/registered_routers/entity.py

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

argenta-0.4.6/argenta/command/__init__.py

@@ -0,0 +1,3 @@
+__all__ = ["Command"]
+
+from .models import Command

argenta-0.4.6/argenta/command/exceptions.py

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

argenta-0.4.6/argenta/command/flag/__init__.py

@@ -0,0 +1,4 @@
+__all__ = ('InputFlags', 'InputFlag', 'Flag', 'Flags')
+
+
+from .models import InputFlags, InputFlag, Flags, Flag

argenta-0.4.6/argenta/command/flag/defaults.py

@@ -0,0 +1,21 @@
+from dataclasses import dataclass
+from argenta.command.flag.models import Flag
+import re
+
+
+@dataclass
+class PredeterminedFlags:
+    HELP = Flag(name='help', possible_values=False)
+    SHORT_HELP = Flag(name='h', prefix='-', possible_values=False)
+
+    INFO = Flag(name='info', possible_values=False)
+    SHORT_INFO = Flag(name='i', prefix='-', possible_values=False)
+
+    ALL = Flag(name='all', possible_values=False)
+    SHORT_ALL = Flag(name='a', prefix='-', possible_values=False)
+
+    HOST = Flag(name='host', possible_values=re.compile(r'^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$'))
+    SHORT_HOST = Flag(name='h', prefix='-', possible_values=re.compile(r'^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$'))
+
+    PORT = Flag(name='port', possible_values=re.compile(r'^\d{1,5}$'))
+    SHORT_PORT = Flag(name='p', prefix='-', possible_values=re.compile(r'^\d{1,5}$'))

argenta-0.4.6/argenta/command/flag/models.py

@@ -0,0 +1,140 @@
+from typing import Literal, Pattern
+from abc import ABC, abstractmethod
+
+
+class BaseFlag:
+    def __init__(self, name: str,
+                 prefix: Literal['-', '--', '---'] = '--'):
+        self._name = name
+        self._prefix = prefix
+
+    def get_string_entity(self):
+        string_entity: str = self._prefix + self._name
+        return string_entity
+
+    def get_name(self):
+        return self._name
+
+    def get_prefix(self):
+        return self._prefix
+
+
+
+class InputFlag(BaseFlag):
+    def __init__(self, name: str,
+                 prefix: Literal['-', '--', '---'] = '--',
+                 value: str = None):
+        super().__init__(name, prefix)
+        self._flag_value = value
+
+    def get_value(self):
+        return self._flag_value
+
+    def set_value(self, value):
+        self._flag_value = value
+
+
+
+class Flag(BaseFlag):
+    def __init__(self, name: str,
+                 prefix: Literal['-', '--', '---'] = '--',
+                 possible_values: list[str] | Pattern[str] | False = True):
+        super().__init__(name, prefix)
+        self.possible_values = possible_values
+
+    def validate_input_flag_value(self, input_flag_value: str | None):
+        if self.possible_values is False:
+            if input_flag_value is None:
+                return True
+            else:
+                return False
+        elif isinstance(self.possible_values, Pattern):
+            if isinstance(input_flag_value, str):
+                is_valid = bool(self.possible_values.match(input_flag_value))
+                if bool(is_valid):
+                    return True
+                else:
+                    return False
+            else:
+                return False
+
+        elif isinstance(self.possible_values, list):
+            if input_flag_value in self.possible_values:
+                return True
+            else:
+                return False
+        else:
+            return True
+
+
+
+class BaseFlags(ABC):
+    __slots__ = ('_flags',)
+
+    @abstractmethod
+    def get_flags(self):
+        pass
+
+    @abstractmethod
+    def add_flag(self, flag: Flag | InputFlag):
+        pass
+
+    @abstractmethod
+    def add_flags(self, flags: list[Flag] | list[InputFlag]):
+        pass
+
+    @abstractmethod
+    def get_flag(self, name: str):
+        pass
+
+    def __iter__(self):
+        return iter(self._flags)
+
+    def __next__(self):
+        return next(iter(self))
+
+    def __getitem__(self, item):
+        return self._flags[item]
+
+
+
+class Flags(BaseFlags, ABC):
+    def __init__(self, *flags: Flag):
+        self._flags = flags if flags else []
+
+    def get_flags(self) -> list[Flag]:
+        return self._flags
+
+    def add_flag(self, flag: Flag):
+        self._flags.append(flag)
+
+    def add_flags(self, flags: list[Flag]):
+        self._flags.extend(flags)
+
+    def get_flag(self, name: str) -> Flag | None:
+        if name in [flag.get_name() for flag in self._flags]:
+            return list(filter(lambda flag: flag.get_name() == name, self._flags))[0]
+        else:
+            return None
+
+
+
+class InputFlags(BaseFlags, ABC):
+    def __init__(self, *flags: InputFlag):
+        self._flags = flags if flags else []
+
+    def get_flags(self) -> list[InputFlag]:
+        return self._flags
+
+    def add_flag(self, flag: InputFlag):
+        self._flags.append(flag)
+
+    def add_flags(self, flags: list[InputFlag]):
+        self._flags.extend(flags)
+
+    def get_flag(self, name: str) -> InputFlag | None:
+        if name in [flag.get_name() for flag in self._flags]:
+            return list(filter(lambda flag: flag.get_name() == name, self._flags))[0]
+        else:
+            return None
+