osbot-utils 1.90.0__tar.gz → 1.91.0__tar.gz

{osbot_utils-1.90.0 → osbot_utils-1.91.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: osbot_utils
-Version: 1.90.0
+Version: 1.91.0
 Summary: OWASP Security Bot - Utils
 Home-page: https://github.com/owasp-sbot/OSBot-Utils
 License: MIT
@@ -23,7 +23,7 @@ Description-Content-Type: text/markdown
 
 Powerful Python util methods and classes that simplify common apis and tasks.
 
-![Current Release](https://img.shields.io/badge/release-v1.90.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.91.0-blue)
 [![codecov](https://codecov.io/gh/owasp-sbot/OSBot-Utils/graph/badge.svg?token=GNVW0COX1N)](https://codecov.io/gh/owasp-sbot/OSBot-Utils)
 
 

{osbot_utils-1.90.0 → osbot_utils-1.91.0}/README.md

@@ -2,7 +2,7 @@
 
 Powerful Python util methods and classes that simplify common apis and tasks.
 
-![Current Release](https://img.shields.io/badge/release-v1.90.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.91.0-blue)
 [![codecov](https://codecov.io/gh/owasp-sbot/OSBot-Utils/graph/badge.svg?token=GNVW0COX1N)](https://codecov.io/gh/owasp-sbot/OSBot-Utils)
 
 

{osbot_utils-1.90.0 → osbot_utils-1.91.0}/osbot_utils/base_classes/Type_Safe.py

@@ -3,7 +3,7 @@
 
 import sys
 import types
-from osbot_utils.utils.Objects                  import default_value         # todo: remove test mocking requirement for this to be here (instead of on the respective method)
+from osbot_utils.utils.Objects                          import default_value         # todo: remove test mocking requirement for this to be here (instead of on the respective method)
 
 # Backport implementations of get_origin and get_args for Python 3.7
 if sys.version_info < (3, 8):                                           # pragma: no cover
@@ -24,6 +24,7 @@ if sys.version_info < (3, 8):                                           # pragma
             return ()
 else:
     from typing import get_origin, get_args, ForwardRef
+    from osbot_utils.helpers.python_compatibility.python_3_8 import Annotated
 
 if sys.version_info >= (3, 10):
     NoneType = types.NoneType
@@ -44,7 +45,6 @@ class Type_Safe:
 
         for (key, value) in self.__cls_kwargs__().items():                  # assign all default values to self
             if value is not None:                                           # when the value is explicitly set to None on the class static vars, we can't check for type safety
-
                 raise_exception_on_obj_type_annotation_mismatch(self, key, value)
             if hasattr(self, key):
                 existing_value = getattr(self, key)
@@ -65,10 +65,11 @@ class Type_Safe:
     def __exit__(self, exc_type, exc_val, exc_tb): pass
 
     def __setattr__(self, name, value):
-        from osbot_utils.utils.Objects import convert_dict_to_value_from_obj_annotation
-        from osbot_utils.utils.Objects import convert_to_value_from_obj_annotation
-        from osbot_utils.utils.Objects import value_type_matches_obj_annotation_for_attr
-        from osbot_utils.utils.Objects import value_type_matches_obj_annotation_for_union_attr
+        from osbot_utils.utils.Objects                          import convert_dict_to_value_from_obj_annotation
+        from osbot_utils.utils.Objects                          import convert_to_value_from_obj_annotation
+        from osbot_utils.utils.Objects                          import value_type_matches_obj_annotation_for_attr
+        from osbot_utils.utils.Objects                          import value_type_matches_obj_annotation_for_union_and_annotated
+        from osbot_utils.helpers.type_safe.Type_Safe__Validator import Type_Safe__Validator
 
         if not hasattr(self, '__annotations__'):                    # can't do type safety checks if the class does not have annotations
             return super().__setattr__(name, value)
@@ -79,7 +80,7 @@ class Type_Safe:
             if type(value) in [int, str]:                                                   # for now only a small number of str and int classes are supported (until we understand the full implications of this)
                 value = convert_to_value_from_obj_annotation (self, name, value)
             check_1 = value_type_matches_obj_annotation_for_attr      (self, name, value)
-            check_2 = value_type_matches_obj_annotation_for_union_attr(self, name, value)
+            check_2 = value_type_matches_obj_annotation_for_union_and_annotated(self, name, value)
             if (check_1 is False and check_2 is None  or
                 check_1 is None  and check_2 is False or
                 check_1 is False and check_2 is False   ):          # fix for type safety assigment on Union vars
@@ -89,6 +90,16 @@ class Type_Safe:
                 if getattr(self, name) is not None:                         # unless it is already set to None
                     raise ValueError(f"Can't set None, to a variable that is already set. Invalid type for attribute '{name}'. Expected '{self.__annotations__.get(name)}' but got '{type(value)}'")
 
+        # todo: refactor this to separate method
+        if hasattr(self.__annotations__, 'get'):
+            annotation = self.__annotations__.get(name)
+            if annotation and get_origin(annotation) is Annotated:
+                annotation_args = get_args(annotation)
+                target_type = annotation_args[0]
+                for attribute in annotation_args[1:]:
+                    if isinstance(attribute, Type_Safe__Validator):
+                        attribute.validate(value=value, field_name=name, target_type=target_type)
+
         super().__setattr__(name, value)
 
     def __attr_names__(self):
@@ -131,6 +142,8 @@ class Type_Safe:
                     else:
                         var_value = getattr(base_cls, var_name)
                         if var_value is not None:                                                                   # allow None assignments on ctor since that is a valid use case
+                            if get_origin(var_type) is Annotated:
+                                continue
                             if var_type and not isinstance(var_value, var_type):                                    # check type
                                 exception_message = f"variable '{var_name}' is defined as type '{var_type}' but has value '{var_value}' of type '{type(var_value)}'"
                                 raise ValueError(exception_message)

{osbot_utils-1.90.0 → osbot_utils-1.91.0}/osbot_utils/graphs/mermaid/Mermaid.py

@@ -1,10 +1,10 @@
-from osbot_utils.graphs.mermaid.Mermaid__Renderer   import Mermaid__Renderer
-from osbot_utils.graphs.mermaid.Mermaid__Edge       import Mermaid__Edge
-from osbot_utils.graphs.mermaid.Mermaid__Graph      import Mermaid__Graph
-from osbot_utils.graphs.mermaid.models.Mermaid__Diagram_Direction import Diagram__Direction
-from osbot_utils.graphs.mermaid.models.Mermaid__Diagram__Type import Diagram__Type
-from osbot_utils.utils.Python_Logger            import Python_Logger
-from osbot_utils.base_classes.Kwargs_To_Self    import Kwargs_To_Self
+from osbot_utils.graphs.mermaid.Mermaid__Renderer                   import Mermaid__Renderer
+from osbot_utils.graphs.mermaid.Mermaid__Edge                       import Mermaid__Edge
+from osbot_utils.graphs.mermaid.Mermaid__Graph                      import Mermaid__Graph
+from osbot_utils.graphs.mermaid.models.Mermaid__Diagram_Direction   import Diagram__Direction
+from osbot_utils.graphs.mermaid.models.Mermaid__Diagram__Type       import Diagram__Type
+from osbot_utils.utils.Python_Logger                                import Python_Logger
+from osbot_utils.base_classes.Kwargs_To_Self                        import Kwargs_To_Self
 
 class Mermaid(Kwargs_To_Self):
     graph             : Mermaid__Graph

{osbot_utils-1.90.0 → osbot_utils-1.91.0}/osbot_utils/helpers/Zip_Bytes.py

@@ -2,10 +2,10 @@ from osbot_utils.base_classes.Type_Safe     import Type_Safe
 from osbot_utils.utils.Dev                  import pprint
 from osbot_utils.utils.Files                import files_list, file_create_from_bytes, temp_file, parent_folder, parent_folder_create
 from osbot_utils.utils.Misc                 import random_text
-from osbot_utils.utils.Regex                import list__match_regex, list__match_regexes
+from osbot_utils.utils.Regex                import list__match_regexes
 from osbot_utils.utils.Zip                  import zip_bytes_empty, zip_bytes__files, zip_bytes__add_file, zip_bytes__add_files, \
     zip_bytes__replace_files, zip_bytes__replace_file, zip_bytes__file_list, zip_bytes__file, \
-    zip_bytes__add_file__from_disk, zip_bytes__add_files__from_disk, zip_files, zip_file__files, zip_bytes__remove_files
+    zip_bytes__add_file__from_disk, zip_bytes__add_files__from_disk, zip_file__files, zip_bytes__remove_files
 
 
 class Zip_Bytes(Type_Safe):

osbot_utils-1.91.0/osbot_utils/helpers/python_compatibility/python_3_8.py

@@ -0,0 +1,8 @@
+import sys
+
+if sys.version_info < (3, 9):
+    class Annotated:
+        def __init__(self, *args) -> None:
+            pass
+else:
+    from typing import Annotated

{osbot_utils-1.90.0 → osbot_utils-1.91.0}/osbot_utils/helpers/trace/Trace_Call__Handler.py

@@ -8,28 +8,28 @@ from osbot_utils.helpers.trace.Trace_Call__Stack_Node   import Trace_Call__Stack
 from osbot_utils.helpers.trace.Trace_Call__Stats        import Trace_Call__Stats
 
 DEFAULT_ROOT_NODE_NODE_TITLE = 'Trace Session'
-GLOBAL_FUNCTIONS_TO_IGNORE   = ['value_type_matches_obj_annotation_for_attr'       ,            # these are type safety functions which introduce quite a lot of noise in the traces (and unless one is debugging type safety, they will not be needed)
-                                'value_type_matches_obj_annotation_for_union_attr' ,            # todo: map out and document why exactly these methods are ignore (and what is the side effect)
-                                'are_types_compatible_for_assigment'               ,
-                                'obj_attribute_annotation'                         ,
-                                'get_origin'                                       ,
-                                'getmro'                                           ,
-                                'default_value'                                    ,
-                                'raise_exception_on_obj_type_annotation_mismatch'  ,
-                                '__cls_kwargs__'        ,
-                                '__default__value__'    ,
-                                '__setattr__'           ,
+GLOBAL_FUNCTIONS_TO_IGNORE   = ['value_type_matches_obj_annotation_for_attr'                ,            # these are type safety functions which introduce quite a lot of noise in the traces (and unless one is debugging type safety, they will not be needed)
+                                'value_type_matches_obj_annotation_for_union_and_annotated' ,            # todo: map out and document why exactly these methods are ignore (and what is the side effect)
+                                'are_types_compatible_for_assigment'                        ,
+                                'obj_attribute_annotation'                                  ,
+                                'get_origin'                                                ,
+                                'getmro'                                                    ,
+                                'default_value'                                             ,
+                                'raise_exception_on_obj_type_annotation_mismatch'           ,
+                                '__cls_kwargs__'                                            ,
+                                '__default__value__'                                        ,
+                                '__setattr__'                                               ,
                                 '<module>']
-GLOBAL_MODULES_TO_IGNORE     = ['osbot_utils.helpers.trace.Trace_Call'               ,            # todo: map out and document why exactly these modules are ignore (and what is the side effect)
-                                'osbot_utils.helpers.trace.Trace_Call__Config'       ,
-                                'osbot_utils.helpers.trace.Trace_Call__View_Model'   ,
-                                'osbot_utils.helpers.trace.Trace_Call__Print_Traces' ,
-                                'osbot_utils.helpers.trace.Trace_Call__Stack'        ,
-                                'osbot_utils.base_classes.Type_Safe'                 ,
-                                'osbot_utils.helpers.CPrint'                         ,            #       also see if this should be done here or at the print/view stage
-                                'osbot_utils.helpers.Print_Table'                    ,
-                                'osbot_utils.decorators.methods.cache_on_self'       ,
-                                'codecs'                                             ]
+GLOBAL_MODULES_TO_IGNORE     = ['osbot_utils.helpers.trace.Trace_Call'                      ,            # todo: map out and document why exactly these modules are ignore (and what is the side effect)
+                                'osbot_utils.helpers.trace.Trace_Call__Config'              ,
+                                'osbot_utils.helpers.trace.Trace_Call__View_Model'          ,
+                                'osbot_utils.helpers.trace.Trace_Call__Print_Traces'        ,
+                                'osbot_utils.helpers.trace.Trace_Call__Stack'               ,
+                                'osbot_utils.base_classes.Type_Safe'                        ,
+                                'osbot_utils.helpers.CPrint'                                ,            #       also see if this should be done here or at the print/view stage
+                                'osbot_utils.helpers.Print_Table'                           ,
+                                'osbot_utils.decorators.methods.cache_on_self'              ,
+                                'codecs'                                                    ]
 
 #GLOBAL_MODULES_TO_IGNORE = []
 #GLOBAL_FUNCTIONS_TO_IGNORE = []

osbot_utils-1.91.0/osbot_utils/helpers/type_safe/Type_Safe__Validator.py

@@ -0,0 +1,14 @@
+from osbot_utils.helpers.python_compatibility.python_3_8 import Annotated
+from typing                                              import Any
+
+class Type_Safe__Validator:                                                                 # Base class for all Type_Safe validators.
+
+    def validate(self, value: Any, field_name: str, target_type: type) -> None:                                # Validate a value against this validator's rules.
+        if value and type(value) != target_type:
+            raise ValueError(f"{field_name} must be of type {target_type}, got {type(value)}")
+
+    def describe(self) -> str:                                                              # Return a human-readable description of this validator's rules.
+        pass
+
+
+Validate = Annotated

osbot_utils-1.91.0/osbot_utils/helpers/type_safe/validators/Validator__Max.py

@@ -0,0 +1,28 @@
+from typing                                             import Any
+from osbot_utils.helpers.type_safe.Type_Safe__Validator import Type_Safe__Validator
+
+
+class Validator__Max(Type_Safe__Validator):                             #    Validates that a numeric value is at most the specified maximum."""
+    max_value: float
+
+    def __init__(self, max_value):
+        self.max_value = max_value
+
+    def validate(self, value: Any, field_name: str, target_type: type) -> None:
+        super().validate(value=value, field_name=field_name, target_type=target_type)
+        if value is None:
+            return
+        compare_value = value if isinstance(value, (int, float)) else len(value)
+        if compare_value > self.max_value:
+            if not isinstance(value, (int, float)):
+                msg = f"{field_name} must be at most {self.max_value}, got {compare_value}"
+            elif isinstance(value, (list, tuple)):
+                msg = f"{field_name} must be at most {self.max_value}, got length {compare_value}"
+            else:
+                msg = f"{field_name} must be at most {self.max_value}, got size {compare_value}"
+            raise ValueError(msg)
+
+    def describe(self) -> str:
+        return f"maximum value: {self.max_value}"
+
+Max = Validator__Max

osbot_utils-1.91.0/osbot_utils/helpers/type_safe/validators/Validator__Min.py

@@ -0,0 +1,38 @@
+from typing                                             import Any
+from osbot_utils.helpers.type_safe.Type_Safe__Validator import Type_Safe__Validator
+
+class Validator__Min(Type_Safe__Validator):                     # Validates that a value is at least the specified minimum. Works with any type that supports the < operator (numbers, strings, lists, etc.)
+    min_value: Any
+
+    def __init__(self, min_value):
+        super().__init__()
+        self.min_value = min_value
+
+    def validate(self, value: Any, field_name: str, target_type: type) -> None:
+        super().validate(value=value, field_name=field_name, target_type=target_type)
+        if value is None:                                                               # can't compare if value has been set to None
+            return
+
+        try:
+            compare_value = value if isinstance(value, (int, float)) else len(value)
+
+            if compare_value < self.min_value:
+                if isinstance(value, (int, float)):
+                    msg = f"{field_name} must be at least {self.min_value}, got {compare_value}"
+                elif isinstance(value, str):
+                    msg = f"{field_name} must have length at least {self.min_value}, got length {compare_value}"
+                elif isinstance(value, (list, tuple)):
+                    msg = f"{field_name} must have length at least {self.min_value}, got length {compare_value}"
+                else:
+                    msg = f"{field_name} must have size at least {self.min_value}, got size {compare_value}"
+                raise ValueError(msg)
+        except TypeError:
+            raise ValueError(f"Cannot compare {field_name} of type {type(value)} with minimum value of type {type(self.min_value)}")
+
+    def describe(self) -> str:
+        if isinstance(self.min_value, (int, float)):
+            return f"minimum value: {self.min_value}"
+        else:
+            return f"minimum length: {len(self.min_value)}"
+
+Min = Validator__Min

osbot_utils-1.91.0/osbot_utils/helpers/type_safe/validators/Validator__One_Of.py

@@ -0,0 +1,18 @@
+from typing                                             import Any
+from osbot_utils.helpers.type_safe.Type_Safe__Validator import Type_Safe__Validator
+
+
+class Validator__One_Of(Type_Safe__Validator):                  # Validates that a value is one of a set of allowed values."""
+    allowed: list
+
+    def __init__(self, allowed):
+        self.allowed = allowed
+
+    def validate(self, value: Any, field_name: str, target_type:type) -> None:
+        if value not in self.allowed:
+            raise ValueError(f"{field_name} must be one of {self.allowed}, got {value}")
+
+    def describe(self) -> str:
+        return f"must be one of: {self.allowed}"
+
+One_Of = Validator__One_Of

osbot_utils-1.91.0/osbot_utils/helpers/type_safe/validators/Validator__Regex.py

@@ -0,0 +1,26 @@
+from typing                                             import Any
+from osbot_utils.helpers.type_safe.Type_Safe__Validator import Type_Safe__Validator
+
+class Validator__Regex(Type_Safe__Validator):            # Validates that a string matches the specified regex pattern.
+    pattern    : str
+    description: str
+
+    def __init__(self, pattern, description=None):
+        self.pattern     = pattern
+        self.description = description
+
+    def validate(self, value: Any, field_name: str, target_type:type) -> None:
+        import re
+        if value is None:
+            return
+        if not isinstance(value, str):
+            raise ValueError(f"{field_name} must be a string, got {type(value)}")
+        if not re.match(self.pattern, value):
+            raise ValueError(f"{field_name} must match pattern {self.pattern}")
+
+    def describe(self) -> str:
+        if self.description:
+            return self.description
+        return f"must match pattern: {self.pattern}"
+
+Regex = Validator__Regex

{osbot_utils-1.90.0 → osbot_utils-1.91.0}/osbot_utils/utils/Objects.py

@@ -23,7 +23,7 @@ if sys.version_info < (3, 8):
         else:
             return ()
 else:
-    from typing import get_origin, get_args
+    from typing import get_origin, get_args, List, Tuple, Dict
 
 
 def are_types_compatible_for_assigment(source_type, target_type):
@@ -343,11 +343,10 @@ def obj_values(target=None):
     return list(obj_dict(target).values())
 
 def raise_exception_on_obj_type_annotation_mismatch(target, attr_name, value):
-    # todo : check if this is is not causing the type safety issues
     if value_type_matches_obj_annotation_for_attr(target, attr_name, value) is False:               # handle case with normal types
-        if value_type_matches_obj_annotation_for_union_attr(target, attr_name, value) is True:      # handle union cases
+        if value_type_matches_obj_annotation_for_union_and_annotated(target, attr_name, value) is True:      # handle union cases
             return                                                                                  #     this is done like this because value_type_matches_obj_annotation_for_union_attr will return None when there is no Union objects
-        raise Exception(f"Invalid type for attribute '{attr_name}'. Expected '{target.__annotations__.get(attr_name)}' but got '{type(value)}'")
+        raise TypeError(f"Invalid type for attribute '{attr_name}'. Expected '{target.__annotations__.get(attr_name)}' but got '{type(value)}'")
 
 def obj_attribute_annotation(target, attr_name):
     if target is not None and attr_name is not None:
@@ -382,15 +381,52 @@ def obj_is_type_union_compatible(var_type, compatible_types):
         return True                                                         # If all args are compatible, return True
     return var_type in compatible_types or var_type is type(None)           # Check for direct compatibility or type(None) for non-Union types
 
-def value_type_matches_obj_annotation_for_union_attr(target, attr_name, value):
-    from typing import Union
+
+def value_type_matches_obj_annotation_for_union_and_annotated(target, attr_name, value):
+    from osbot_utils.helpers.python_compatibility.python_3_8 import Annotated
+    from typing                                              import Union, get_origin, get_args
+
     value_type           = type(value)
-    attribute_annotation = obj_attribute_annotation(target,attr_name)
+    attribute_annotation = obj_attribute_annotation(target, attr_name)
     origin               = get_origin(attribute_annotation)
-    if origin is Union:                                                     # For Union types, including Optionals
-        args = get_args(attribute_annotation)                               # Get the argument types
+
+    if origin is Union:                                                     # Handle Union types (including Optional)
+        args = get_args(attribute_annotation)
         return value_type in args
-    return None                                                             # if it is not an Union type just return None (to give an indication to the caller that the comparison was not made)
+
+    # todo: refactor the logic below to a separate method (and check for duplicate code with other get_origin usage)
+    if origin is Annotated:                                                # Handle Annotated types
+        args        = get_args(attribute_annotation)
+        base_type   = args[0]                                              # First argument is the base type
+        base_origin = get_origin(base_type)
+
+        if base_origin is None:                                            # Non-container types
+            return isinstance(value, base_type)
+
+        if base_origin in (list, List):                                    # Handle List types
+            if not isinstance(value, list):
+                return False
+            item_type = get_args(base_type)[0]
+            return all(isinstance(item, item_type) for item in value)
+
+        if base_origin in (tuple, Tuple):                                  # Handle Tuple types
+            if not isinstance(value, tuple):
+                return False
+            item_types = get_args(base_type)
+            return len(value) == len(item_types) and all(
+                isinstance(item, item_type)
+                for item, item_type in zip(value, item_types)
+            )
+
+        if base_origin in (dict, Dict):                                    # Handle Dict types
+            if not isinstance(value, dict):
+                return False
+            key_type, value_type = get_args(base_type)
+            return all(isinstance(k, key_type) and isinstance(v, value_type)
+                      for k, v in value.items())
+
+    # todo: add support for for other typing constructs
+    return None                                                             # if it is not a Union or Annotated types just return None (to give an indication to the caller that the comparison was not made)
 
 
 def pickle_save_to_bytes(target: object) -> bytes:

{osbot_utils-1.90.0 → osbot_utils-1.91.0}/osbot_utils/utils/Regex.py

@@ -1,7 +1,7 @@
 import re
-
 from osbot_utils.utils.Status import status_error
 
+# todo: review if we can delete this file (since we now have an Regex class in the validators)
 
 def list__match_regex(target, pattern):
     return list__match_regexes(target, [pattern])

osbot_utils-1.91.0/osbot_utils/version

@@ -0,0 +1 @@
+v1.91.0

{osbot_utils-1.90.0 → osbot_utils-1.91.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name        = "osbot_utils"
-version     = "v1.90.0"
+version     = "v1.91.0"
 description = "OWASP Security Bot - Utils"
 authors     = ["Dinis Cruz <dinis.cruz@owasp.org>"]
 license     = "MIT"

osbot_utils-1.90.0/osbot_utils/version

@@ -1 +0,0 @@
-v1.90.0