v0.3.9

argenta/command/flag/__init__.py

@@ -0,0 +1,2 @@
+from .entity import Flag
+from .flags_group.entity import FlagsGroup

argenta/command/flag/defaults.py

@@ -0,0 +1,18 @@
+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}$'))

argenta/command/flag/entity.py

@@ -0,0 +1,49 @@
+from typing import Literal, Pattern
+
+
+class Flag:
+    def __init__(self, flag_name: str,
+                 flag_prefix: Literal['-', '--', '---'] = '--',
+                 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._flag_value = None
+
+    def get_string_entity(self):
+        string_entity: str = self._flag_prefix + self._flag_name
+        return string_entity
+
+    def get_flag_name(self):
+        return self._flag_name
+
+    def get_flag_prefix(self):
+        return self._flag_prefix
+
+    def get_value(self):
+        return self._flag_value
+
+    def set_value(self, value):
+        self._flag_value = value
+
+    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
+
+        elif isinstance(self.possible_flag_values, list):
+            if input_flag_value in self.possible_flag_values:
+                return True
+            else:
+                return False
+        else:
+            return True

argenta/command/flag/flags_group/__init__.py

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

argenta/command/flag/flags_group/entity.py

@@ -0,0 +1,35 @@
+from argenta.command.flag.entity import Flag
+
+
+class FlagsGroup:
+    def __init__(self, *flags: Flag):
+        self._flags: list[Flag] = [] if not flags else flags
+
+    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 unparse_to_dict(self):
+        result_dict: dict[str, dict] = {}
+        for flag in self._flags:
+            result_dict[flag.get_flag_name()] = {
+                'name': flag.get_flag_name(),
+                'string_entity': flag.get_string_entity(),
+                'prefix': flag.get_flag_prefix(),
+                'value': flag.get_value()
+            }
+        return result_dict
+
+    def __iter__(self):
+        return iter(self._flags)
+
+    def __next__(self):
+        return next(iter(self))
+
+    def __getitem__(self, item):
+        return self._flags[item]