argenta 0.3.9__tar.gz → 0.4.1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: argenta
-Version: 0.3.9
+Version: 0.4.1
 Summary: python library for creating custom shells
 License: MIT
 Author: kolo
@@ -75,12 +75,11 @@ from argenta.command.flag import FlagsGroup, Flag
 
 router = Router()
 
-registered_flags = FlagsGroup([
+registered_flags = FlagsGroup(
     Flag(flag_name='host',
          flag_prefix='--',
          possible_flag_values=re.compile(r'^192.168.\d{1,3}.\d{1,3}$')),
-    Flag('port', '---', re.compile(r'^[0-9]{1,4}$'))
-])
+    Flag('port', '--', re.compile(r'^[0-9]{1,4}$')))
 
 
 @router.command(Command("hello"))
@@ -380,8 +379,7 @@ Command(trigger: str,
 ```python
 Flag(flag_name: str,
      flag_prefix: typing.Literal['-', '--', '---'] = '-',
-     ignore_flag_value_register: bool = False,
-     possible_flag_values: list[str] | typing.Pattern[str] = False)
+     possible_flag_values: list[str] | typing.Pattern[str] | False = True)
 ```
 
 ---
@@ -390,9 +388,10 @@ Flag(flag_name: str,
 - **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')`)
+- `possible_flag_values` (`list[str] | Pattern[str] | bool`): Множество допустимых значений флага, может быть задано
+списком с допустимыми значениями или регулярным выражением (рекомендуется `re.compile(r'example exspression')`), при значении
+аргумента `False` у введённого флага не может быть значения, иначе будет вызвано исключение и обработано соответствующим 
+еррор-хэндлером
 
 ---
 
@@ -425,14 +424,14 @@ Flag(flag_name: str,
 
 ### Конструктор
 ```python
-FlagsGroup(flags: list[Flag] = None)
+FlagsGroup(*flagы: Flag)
 ```
 
 ---
 
 **Аргументы:**
 - **name : mean**
-- `flags` (`list[Flag]`): Список флагов, которые будут объединены в одну группу
+- `*flags` (`Flag`): Неограниченное количество передаваемых флагов
 
 ---
 

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

@@ -60,12 +60,11 @@ from argenta.command.flag import FlagsGroup, Flag
 
 router = Router()
 
-registered_flags = FlagsGroup([
+registered_flags = FlagsGroup(
     Flag(flag_name='host',
          flag_prefix='--',
          possible_flag_values=re.compile(r'^192.168.\d{1,3}.\d{1,3}$')),
-    Flag('port', '---', re.compile(r'^[0-9]{1,4}$'))
-])
+    Flag('port', '--', re.compile(r'^[0-9]{1,4}$')))
 
 
 @router.command(Command("hello"))
@@ -365,8 +364,7 @@ Command(trigger: str,
 ```python
 Flag(flag_name: str,
      flag_prefix: typing.Literal['-', '--', '---'] = '-',
-     ignore_flag_value_register: bool = False,
-     possible_flag_values: list[str] | typing.Pattern[str] = False)
+     possible_flag_values: list[str] | typing.Pattern[str] | False = True)
 ```
 
 ---
@@ -375,9 +373,10 @@ Flag(flag_name: str,
 - **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')`)
+- `possible_flag_values` (`list[str] | Pattern[str] | bool`): Множество допустимых значений флага, может быть задано
+списком с допустимыми значениями или регулярным выражением (рекомендуется `re.compile(r'example exspression')`), при значении
+аргумента `False` у введённого флага не может быть значения, иначе будет вызвано исключение и обработано соответствующим 
+еррор-хэндлером
 
 ---
 
@@ -410,14 +409,14 @@ Flag(flag_name: str,
 
 ### Конструктор
 ```python
-FlagsGroup(flags: list[Flag] = None)
+FlagsGroup(*flagы: Flag)
 ```
 
 ---
 
 **Аргументы:**
 - **name : mean**
-- `flags` (`list[Flag]`): Список флагов, которые будут объединены в одну группу
+- `*flags` (`Flag`): Неограниченное количество передаваемых флагов
 
 ---
 

{argenta-0.3.9 → argenta-0.4.1}/argenta/app/entity.py

@@ -1,11 +1,11 @@
-from pprint import pprint
 from typing import Callable
 from inspect import getfullargspec
 import re
 
-from ..command.entity import Command
-from ..router.entity import Router
-from ..command.exceptions import (UnprocessedInputFlagException,
+from argenta.command import Command
+from argenta.router import Router
+from argenta.router.defaults import system_router
+from argenta.command.exceptions import (UnprocessedInputFlagException,
                                   RepeatedInputFlagsException,
                                   EmptyInputCommandException)
 from .exceptions import (InvalidRouterInstanceException,
@@ -30,6 +30,7 @@ class App:
                  line_separate: str = '',
                  command_group_description_separate: str = '',
                  repeat_command_groups: bool = True,
+                 messages_on_startup: list[str] = None,
                  print_func: Callable[[str], None] = print) -> None:
         self.prompt = prompt
         self.print_func = print_func
@@ -44,6 +45,7 @@ class App:
         self.command_group_description_separate = command_group_description_separate
         self.ignore_command_register = ignore_command_register
         self.repeat_command_groups = repeat_command_groups
+        self.messages_on_startup = messages_on_startup if messages_on_startup else []
 
         self._routers: list[Router] = []
         self._description_message_pattern: str = '[{command}] *=*=* {description}'
@@ -51,16 +53,21 @@ class App:
         self._invalid_input_flags_handler: Callable[[str], None] = lambda raw_command: print_func(f'Incorrect flag syntax: "{raw_command}"')
         self._repeated_input_flags_handler: Callable[[str], None] = lambda raw_command: print_func(f'Repeated input flags: "{raw_command}"')
         self._empty_input_command_handler: Callable[[], None] = lambda: print_func(f'Empty input command')
-        self._unknown_command_handler: Callable[[Command], None] = lambda command: print_func(f"Unknown command: {command.get_string_entity()}")
+        self._unknown_command_handler: Callable[[Command], None] = lambda command: print_func(f"Unknown command: {command.get_trigger()}")
+        self._exit_command_handler: Callable[[], None] = lambda: print_func(self.farewell_message)
 
 
     def start_polling(self) -> None:
+        self._setup_system_router()
         self._validate_number_of_routers()
         self._validate_included_routers()
         self._validate_all_router_commands()
 
         self.print_func(self.initial_message)
 
+        for message in self.messages_on_startup:
+            self.print_func(message)
+
         if not self.repeat_command_groups:
             self._print_command_group_description()
             self.print_func(self.prompt)
@@ -101,7 +108,9 @@ class App:
                     self.print_func(self.prompt)
                 continue
 
-            self._check_command_for_exit_command(input_command.get_trigger())
+            is_exit = self._is_exit_command(input_command)
+            if is_exit:
+                return
 
             self.print_func(self.line_separate)
             is_unknown_command: bool = self._check_is_command_unknown(input_command)
@@ -172,6 +181,18 @@ class App:
             self._empty_input_command_handler = handler
 
 
+    def set_exit_command_handler(self, handler: Callable[[], None]) -> None:
+        args = getfullargspec(handler).args
+        if len(args) != 0:
+            raise IncorrectNumberOfHandlerArgsException()
+        else:
+            self._exit_command_handler = handler
+
+
+    def add_message_on_startup(self, message: str) -> None:
+        self.messages_on_startup.append(message)
+
+
     def include_router(self, router: Router) -> None:
         if not isinstance(router, Router):
             raise InvalidRouterInstanceException()
@@ -213,15 +234,26 @@ class App:
                         raise RepeatedCommandInDifferentRoutersException()
 
 
-    def _check_command_for_exit_command(self, command: str):
-        if command.lower() == self.exit_command.lower():
+    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 [router['entity'] for router in self._registered_router_entities]:
+            self.include_router(system_router)
+
+
+    def _is_exit_command(self, command: Command):
+        if command.get_trigger().lower() == self.exit_command.lower():
             if self.ignore_exit_command_register:
-                self.print_func(self.farewell_message)
-                exit(0)
+                system_router.input_command_handler(command)
+                return True
             else:
-                if command == self.exit_command:
-                    self.print_func(self.farewell_message)
-                    exit(0)
+                if command.get_trigger() == self.exit_command:
+                    system_router.input_command_handler(command)
+                    return True
+        return False
 
 
     def _check_is_command_unknown(self, command: Command):
@@ -248,12 +280,3 @@ class App:
                     )
                 )
             self.print_func(self.command_group_description_separate)
-
-        self.print_func(self.system_points_title)
-        self.print_func(self._description_message_pattern.format(
-                command=self.exit_command,
-                description=self.exit_command_description
-            )
-        )
-        self.print_func(self.command_group_description_separate)
-

{argenta-0.3.9 → argenta-0.4.1}/argenta/command/entity.py

@@ -6,6 +6,7 @@ from .exceptions import (UnprocessedInputFlagException,
 
 from typing import Generic, TypeVar, cast, Literal
 
+
 CommandType = TypeVar('CommandType')
 
 
@@ -15,8 +16,7 @@ class Command(Generic[CommandType]):
                  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._registered_flags: FlagsGroup | None = flags if isinstance(flags, FlagsGroup) else FlagsGroup(flags) if isinstance(flags, Flag) else flags
         self._input_flags: FlagsGroup | None = None
 
 
@@ -56,7 +56,7 @@ class Command(Generic[CommandType]):
         return self._input_flags
 
     @staticmethod
-    def parse_input_command(raw_command: str) -> 'Command[CommandType]':
+    def parse_input_command(raw_command: str) -> CommandType:
         if not raw_command:
             raise EmptyInputCommandException()
         list_of_tokens = raw_command.split()

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

@@ -0,0 +1,21 @@
+from dataclasses import dataclass
+from argenta.command.flag import Flag
+import re
+
+
+@dataclass
+class DefaultFlags:
+    help_flag = Flag(flag_name='help', possible_flag_values=False)
+    short_help_flag = Flag(flag_name='h', flag_prefix='-', possible_flag_values=False)
+
+    info_flag = Flag(flag_name='info', possible_flag_values=False)
+    short_info_flag = Flag(flag_name='i', flag_prefix='-', possible_flag_values=False)
+
+    all_flag = Flag(flag_name='all', possible_flag_values=False)
+    short_all_flag = Flag(flag_name='a', flag_prefix='-', possible_flag_values=False)
+
+    host_flag = Flag(flag_name='host', possible_flag_values=re.compile(r'^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$'))
+    short_host_flag = Flag(flag_name='h', flag_prefix='-', possible_flag_values=re.compile(r'^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$'))
+
+    port_flag = Flag(flag_name='port', possible_flag_values=re.compile(r'^\d{1,5}$'))
+    short_port_flag = Flag(flag_name='p', flag_prefix='-', possible_flag_values=re.compile(r'^\d{1,5}$'))

{argenta-0.3.9 → argenta-0.4.1}/argenta/command/flag/flags_group/entity.py

@@ -1,4 +1,4 @@
-from argenta.command.flag.entity import Flag
+from argenta.command.flag import Flag
 
 
 class FlagsGroup:

argenta-0.4.1/argenta/router/defaults.py

@@ -0,0 +1,5 @@
+from argenta.router import Router
+
+
+system_router = Router(title='System points:',
+                       name='System')

{argenta-0.3.9 → argenta-0.4.1}/argenta/router/entity.py

@@ -23,7 +23,7 @@ class Router:
         self._command_entities: list[dict[str, Callable[[], None] | Command]] = []
         self._ignore_command_register: bool = False
 
-        self._not_valid_flag_handler: Callable[[Flag], None] = lambda flag: print(f"Undefined or incorrect input flag: '{flag.get_string_entity()} {flag.get_value()}'")
+        self._not_valid_flag_handler: Callable[[Flag], None] = lambda flag: print(f"Undefined or incorrect input flag: {flag.get_string_entity()}{(' '+flag.get_value()) if flag.get_value() else ''}")
 
 
     def command(self, command: Command) -> Callable[[Any],  Any]:
@@ -116,6 +116,10 @@ class Router:
         return self._title
 
 
+    def set_title(self, title: str):
+        self._title = title
+
+
     def get_all_commands(self) -> list[str]:
         all_commands: list[str] = []
         for command_entity in self._command_entities:

{argenta-0.3.9 → argenta-0.4.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "argenta"
-version = "0.3.9"
+version = "0.4.1"
 description = "python library for creating custom shells"
 authors = [
     {name = "kolo", email = "kolo.is.main@gmail.com"}

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

@@ -1,18 +0,0 @@
-from argenta.command.flag import Flag
-import re
-
-
-help_flag = Flag(flag_name='help', possible_flag_values=False)
-short_help_flag = Flag(flag_name='h', flag_prefix='-', possible_flag_values=False)
-
-info_flag = Flag(flag_name='info', possible_flag_values=False)
-short_info_flag = Flag(flag_name='i', flag_prefix='-', possible_flag_values=False)
-
-all_flag = Flag(flag_name='all', possible_flag_values=False)
-short_all_flag = Flag(flag_name='a', flag_prefix='-', possible_flag_values=False)
-
-host_flag = Flag(flag_name='host', possible_flag_values=re.compile(r'^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$'))
-short_host_flag = Flag(flag_name='h', flag_prefix='-', possible_flag_values=re.compile(r'^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$'))
-
-port_flag = Flag(flag_name='port', possible_flag_values=re.compile(r'^\d{1,5}$'))
-short_port_flag = Flag(flag_name='p', flag_prefix='-', possible_flag_values=re.compile(r'^\d{1,5}$'))