argenta 0.3.8__tar.gz → 0.4.0__tar.gz

{argenta-0.3.8 → argenta-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: argenta
-Version: 0.3.8
+Version: 0.4.0
 Summary: python library for creating custom shells
 License: MIT
 Author: kolo
@@ -71,16 +71,15 @@ if __name__ == '__main__':
 import re
 from argenta.router import Router
 from argenta.command import Command
-from argenta.command.params.flag import FlagsGroup, Flag
+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.8 → argenta-0.4.0}/README.md

@@ -56,16 +56,15 @@ if __name__ == '__main__':
 import re
 from argenta.router import Router
 from argenta.command import Command
-from argenta.command.params.flag import FlagsGroup, Flag
+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.8 → argenta-0.4.0}/argenta/app/entity.py

@@ -50,7 +50,7 @@ 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()}")
 
 
     def start_polling(self) -> None:
@@ -100,7 +100,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.get_trigger())
+            if is_exit:
+                return
 
             self.print_func(self.line_separate)
             is_unknown_command: bool = self._check_is_command_unknown(input_command)
@@ -212,15 +214,16 @@ class App:
                         raise RepeatedCommandInDifferentRoutersException()
 
 
-    def _check_command_for_exit_command(self, command: str):
+    def _is_exit_command(self, command: str):
         if command.lower() == self.exit_command.lower():
             if self.ignore_exit_command_register:
                 self.print_func(self.farewell_message)
-                exit(0)
+                return True
             else:
                 if command == self.exit_command:
                     self.print_func(self.farewell_message)
-                    exit(0)
+                    return True
+        return False
 
 
     def _check_is_command_unknown(self, command: Command):

{argenta-0.3.8 → argenta-0.4.0}/argenta/command/entity.py

@@ -1,23 +1,22 @@
-from .params.flag.entity import Flag
-from .params.flag.flags_group.entity import FlagsGroup
+from argenta.command.flag.entity import Flag
+from argenta.command.flag.flags_group import FlagsGroup
 from .exceptions import (UnprocessedInputFlagException,
                          RepeatedInputFlagsException,
                          EmptyInputCommandException)
 
-from typing import Generic, TypeVar
+from typing import Generic, TypeVar, cast, Literal
 
 
-T = TypeVar('T')
+CommandType = TypeVar('CommandType')
 
 
-class Command(Generic[T]):
+class Command(Generic[CommandType]):
     def __init__(self, trigger: str,
                  description: str = None,
                  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
 
 
@@ -57,7 +56,7 @@ class Command(Generic[T]):
         return self._input_flags
 
     @staticmethod
-    def parse_input_command(raw_command: str) -> 'Command[T]':
+    def parse_input_command(raw_command: str) -> CommandType:
         if not raw_command:
             raise EmptyInputCommandException()
         list_of_tokens = raw_command.split()
@@ -67,7 +66,7 @@ class Command(Generic[T]):
         flags: FlagsGroup = FlagsGroup()
         current_flag_name = None
         current_flag_value = None
-        for _ in list_of_tokens:
+        for k, _ in enumerate(list_of_tokens):
             if _.startswith('-'):
                 flag_prefix_last_symbol_index = _.rfind('-')
                 if current_flag_name or len(_) < 2 or len(_[:flag_prefix_last_symbol_index]) > 3:
@@ -79,12 +78,15 @@ class Command(Generic[T]):
                     raise UnprocessedInputFlagException()
                 else:
                     current_flag_value = _
-            if current_flag_name and current_flag_value:
+            if current_flag_name:
+                if not len(list_of_tokens) == k+1:
+                    if not list_of_tokens[k+1].startswith('-'):
+                        continue
                 flag_prefix_last_symbol_index = current_flag_name.rfind('-')
                 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)
+                                  flag_prefix=cast(Literal['-', '--', '---'], flag_prefix))
                 input_flag.set_value(current_flag_value)
 
                 all_flags = [x.get_string_entity() for x in flags.get_flags()]

{argenta-0.3.8 → argenta-0.4.0}/argenta/command/exceptions.py

@@ -1,4 +1,4 @@
-from .params.flag.entity import Flag
+from argenta.command.flag.entity import Flag
 
 
 class UnprocessedInputFlagException(Exception):

argenta-0.4.0/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.8/argenta/command/params → argenta-0.4.0/argenta/command}/flag/entity.py

@@ -4,12 +4,10 @@ from typing import Literal, Pattern
 class Flag:
     def __init__(self, flag_name: str,
                  flag_prefix: Literal['-', '--', '---'] = '--',
-                 ignore_flag_value_register: bool = False,
-                 possible_flag_values: list[str] | Pattern[str] = False):
+                 possible_flag_values: list[str] | Pattern[str] | False = True):
         self._flag_name = flag_name
         self._flag_prefix = flag_prefix
         self.possible_flag_values = possible_flag_values
-        self.ignore_flag_value_register = ignore_flag_value_register
 
         self._flag_value = None
 
@@ -29,23 +27,23 @@ class Flag:
     def set_value(self, value):
         self._flag_value = value
 
-    def validate_input_flag_value(self, input_flag_value: str):
-        if isinstance(self.possible_flag_values, Pattern):
+    def validate_input_flag_value(self, input_flag_value: str | None):
+        if self.possible_flag_values is False:
+            if input_flag_value is None:
+                return True
+            else:
+                return False
+        elif isinstance(self.possible_flag_values, Pattern):
             is_valid = bool(self.possible_flag_values.match(input_flag_value))
             if bool(is_valid):
                 return True
             else:
                 return False
 
-        if isinstance(self.possible_flag_values, list):
-            if self.ignore_flag_value_register:
-                if input_flag_value.lower() in [x.lower() for x in self.possible_flag_values]:
-                    return True
-                else:
-                    return False
+        elif isinstance(self.possible_flag_values, list):
+            if input_flag_value in self.possible_flag_values:
+                return True
             else:
-                if input_flag_value in self.possible_flag_values:
-                    return True
-                else:
-                    return False
-        return True
+                return False
+        else:
+            return True

argenta-0.4.0/argenta/command/flag/flags_group/__init__.py

@@ -0,0 +1 @@
+from .entity import FlagsGroup

{argenta-0.3.8/argenta/command/params → argenta-0.4.0/argenta/command}/flag/flags_group/entity.py

@@ -1,8 +1,8 @@
-from argenta.command.params.flag.entity import Flag
+from argenta.command.flag import Flag
 
 
 class FlagsGroup:
-    def __init__(self, flags: list[Flag] = None):
+    def __init__(self, *flags: Flag):
         self._flags: list[Flag] = [] if not flags else flags
 
     def get_flags(self) -> list[Flag]:

{argenta-0.3.8 → argenta-0.4.0}/argenta/router/entity.py

@@ -2,8 +2,8 @@ from typing import Callable, Any
 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 argenta.command.flag.entity import Flag
+from argenta.command.flag.flags_group import FlagsGroup
 from ..router.exceptions import (RepeatedCommandException,
                                  RepeatedFlagNameException,
                                  TooManyTransferredArgsException,
@@ -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]:

{argenta-0.3.8 → argenta-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "argenta"
-version = "0.3.8"
+version = "0.4.0"
 description = "python library for creating custom shells"
 authors = [
     {name = "kolo", email = "kolo.is.main@gmail.com"}
@@ -33,4 +33,5 @@ numpy = "^2.2.2"
 word2number = "^1.1"
 numexpr = "^2.10.2"
 requests = "^2.32.3"
+pyreadline3 = "^3.5.4"