ref: typehints, enum instead of raw string, abc and other (#1)

Full code coverage with annotations, fixing errors in various linters: ruff, wps, etc. Fixing errors in type checkers: ty, mypy, pyright. Formatting and bringing code to a consistent style, applying best practices in various aspects.

src/argenta/command/flag/models.py

@@ -1,57 +1,22 @@
 from enum import Enum
-from typing import Literal, Pattern
-
+from re import Pattern
+from typing import Literal, override
 
 
 class PossibleValues(Enum):
-    DISABLE: Literal[False] = False
-    ALL: Literal[True] = True
-
-    def __eq__(self, other: bool) -> bool:
-        return self.value == other
+    NEITHER = 'NEITHER'
+    ALL = 'ALL'
 
 
-class BaseFlag:
-    def __init__(self, name: str, prefix: Literal["-", "--", "---"] = "--") -> None:
-        """
-        Private. Base class for flags
-        :param name: the name of the flag
-        :param prefix: the prefix of the flag
-        :return: None
-        """
-        self._name = name
-        self._prefix = prefix
-
-    def get_string_entity(self) -> str:
-        """
-        Public. Returns a string representation of the flag
-        :return: string representation of the flag as str
-        """
-        string_entity: str = self._prefix + self._name
-        return string_entity
-
-    def get_name(self) -> str:
-        """
-        Public. Returns the name of the flag
-        :return: the name of the flag as str
-        """
-        return self._name
-
-    def get_prefix(self) -> str:
-        """
-        Public. Returns the prefix of the flag
-        :return: the prefix of the flag as str
-        """
-        return self._prefix
-
-    def __eq__(self, other) -> bool:
-        return self.get_string_entity() == other.get_string_entity()
+class ValidationStatus(Enum):
+    VALID = 'VALID'
+    INVALID = 'INVALID'
+    UNDEFINED = 'UNDEFINED'
 
 
-class Flag(BaseFlag):
+class Flag:
     def __init__(
-        self,
-        name: str,
+        self, name: str, *, 
         prefix: Literal["-", "--", "---"] = "--",
         possible_values: list[str] | Pattern[str] | PossibleValues = PossibleValues.ALL,
     ) -> None:
@@ -62,45 +27,58 @@ class Flag(BaseFlag):
         :param possible_values: The possible values of the flag, if False then the flag cannot have a value
         :return: None
         """
-        super().__init__(name, prefix)
-        self.possible_values = possible_values
+        self.name: str = name
+        self.prefix: Literal["-", "--", "---"] = prefix
+        self.possible_values: list[str] | Pattern[str] | PossibleValues = possible_values
 
-    def validate_input_flag_value(self, input_flag_value: str | None):
+    def validate_input_flag_value(self, input_flag_value: str | None) -> bool:
         """
         Private. Validates the input flag value
         :param input_flag_value: The input flag value to validate
         :return: whether the entered flag is valid as bool
         """
-        if self.possible_values == PossibleValues.DISABLE:
-            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
+        if self.possible_values == PossibleValues.NEITHER:
+            return input_flag_value is None
 
-        elif isinstance(self.possible_values, list):
-            if input_flag_value in self.possible_values:
-                return True
-            else:
-                return False
+        if isinstance(self.possible_values, Pattern):
+            return isinstance(input_flag_value, str) and bool(self.possible_values.match(input_flag_value))
+
+        if isinstance(self.possible_values, list):
+            return input_flag_value in self.possible_values
+
+        return True
+    
+    @property
+    def string_entity(self) -> str:
+        """
+        Public. Returns a string representation of the flag
+        :return: string representation of the flag as str
+        """
+        string_entity: str = self.prefix + self.name
+        return string_entity
+    
+    @override
+    def __str__(self) -> str:
+        return self.string_entity
+    
+    @override
+    def __repr__(self) -> str:
+        return f'Flag<name={self.name}, prefix={self.prefix}>'
+        
+    @override
+    def __eq__(self, other: object) -> bool: 
+        if isinstance(other, Flag):
+            return self.string_entity == other.string_entity
         else:
-            return True
+            raise NotImplementedError
 
 
-class InputFlag(BaseFlag):
+class InputFlag:
     def __init__(
-        self,
-        name: str,
-        prefix: Literal["-", "--", "---"] = "--",
-        value: str | None = None,
+        self, name: str, *,
+        prefix: Literal['-', '--', '---'] = '--',
+        input_value: str | None,
+        status: ValidationStatus | None
     ):
         """
         Public. The entity of the flag of the entered command
@@ -109,26 +87,33 @@ class InputFlag(BaseFlag):
         :param value: the value of the input flag
         :return: None
         """
-        super().__init__(name, prefix)
-        self._flag_value = value
+        self.name: str = name
+        self.prefix: Literal['-', '--', '---'] = prefix
+        self.input_value: str | None = input_value
+        self.status: ValidationStatus | None = status
+    
+    @property
+    def string_entity(self) -> str:
+        """
+        Public. Returns a string representation of the flag
+        :return: string representation of the flag as str
+        """
+        string_entity: str = self.prefix + self.name
+        return string_entity
 
-    def get_value(self) -> str | None:
-        """
-        Public. Returns the value of the flag
-        :return: the value of the flag as str
-        """
-        return self._flag_value
+    @override
+    def __str__(self) -> str:
+        return f'{self.string_entity} {self.input_value}'
+    
+    @override
+    def __repr__(self) -> str:
+        return f'InputFlag<name={self.name}, prefix={self.prefix}, value={self.input_value}, status={self.status}>'
 
-    def set_value(self, value):
-        """
-        Private. Sets the value of the flag
-        :param value: the fag value to set
-        :return: None
-        """
-        self._flag_value = value
-
-    def __eq__(self, other) -> bool:
-        return (
-            self.get_string_entity() == other.get_string_entity()
-            and self.get_value() == other.get_value()
-        )
+    @override
+    def __eq__(self, other: object) -> bool: 
+        if isinstance(other, InputFlag):
+            return (
+                self.name == other.name
+            )
+        else:
+            raise NotImplementedError