osbot-utils 2.14.0__tar.gz → 2.16.0__tar.gz

{osbot_utils-2.14.0 → osbot_utils-2.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: osbot_utils
-Version: 2.14.0
+Version: 2.16.0
 Summary: OWASP Security Bot - Utils
 License: MIT
 Author: Dinis Cruz
@@ -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-v2.14.0-blue)
+![Current Release](https://img.shields.io/badge/release-v2.16.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-2.14.0 → osbot_utils-2.16.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-v2.14.0-blue)
+![Current Release](https://img.shields.io/badge/release-v2.16.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-2.14.0 → osbot_utils-2.16.0}/osbot_utils/helpers/xml/Xml__File__Load.py

@@ -1,7 +1,7 @@
 from io                                     import StringIO
 from typing                                 import List, Union, Dict
 from xml.etree.ElementTree                  import iterparse, Element, fromstring, ParseError
-from osbot_utils.type_safe.Type_Safe     import Type_Safe
+from osbot_utils.type_safe.Type_Safe        import Type_Safe
 from osbot_utils.helpers.xml.Xml__Attribute import Xml__Attribute
 from osbot_utils.helpers.xml.Xml__Element   import XML__Element
 from osbot_utils.helpers.xml.Xml__File      import Xml__File

{osbot_utils-2.14.0 → osbot_utils-2.16.0}/osbot_utils/type_safe/Type_Safe__Base.py

@@ -1,6 +1,5 @@
-from typing import get_args, Union, Optional, Any, ForwardRef
-
-from osbot_utils.type_safe.shared.Type_Safe__Cache import type_safe_cache
+from typing                                         import get_args, Union, Optional, Any, ForwardRef
+from osbot_utils.type_safe.shared.Type_Safe__Cache  import type_safe_cache
 
 EXACT_TYPE_MATCH = (int, float, str, bytes, bool, complex)
 

osbot_utils-2.16.0/osbot_utils/type_safe/Type_Safe__Set.py

@@ -0,0 +1,32 @@
+from osbot_utils.type_safe.Type_Safe__Base import Type_Safe__Base, type_str
+
+class Type_Safe__Set(Type_Safe__Base, set):
+    def __init__(self, expected_type, *args):
+        super().__init__(*args)
+        self.expected_type = expected_type
+
+    def __repr__(self):
+        expected_type_name = type_str(self.expected_type)
+        return f"set[{expected_type_name}] with {len(self)} elements"
+
+    def add(self, item):
+        try:
+            self.is_instance_of_type(item, self.expected_type)
+        except TypeError as e:
+            raise TypeError(f"In Type_Safe__Set: Invalid type for item: {e}")
+        super().add(item)
+
+    def json(self):
+        from osbot_utils.type_safe.Type_Safe import Type_Safe
+
+        result = []
+        for item in self:
+            if isinstance(item, Type_Safe):
+                result.append(item.json())
+            elif isinstance(item, (list, tuple, set)):
+                result.append([x.json() if isinstance(x, Type_Safe) else x for x in item])
+            elif isinstance(item, dict):
+                result.append({k: v.json() if isinstance(v, Type_Safe) else v for k, v in item.items()})
+            else:
+                result.append(item)
+        return result

osbot_utils-2.16.0/osbot_utils/type_safe/Type_Safe__Tuple.py

@@ -0,0 +1,41 @@
+from osbot_utils.type_safe.Type_Safe__Base import Type_Safe__Base, type_str
+
+class Type_Safe__Tuple(Type_Safe__Base, tuple):
+
+    def __new__(cls, expected_types, items=None):
+        items    = items or tuple()
+        instance = super().__new__(cls, items)
+        instance.expected_types = expected_types
+        return instance
+
+    def __init__(self, expected_types, items=None):             # todo: see if we should be assining expected_types to self here
+        if items:
+            self.validate_items(items)
+
+    def validate_items(self, items):
+        if len(items) != len(self.expected_types):
+            raise ValueError(f"Expected {len(self.expected_types)} elements, got {len(items)}")
+        for item, expected_type in zip(items, self.expected_types):
+            try:
+                self.is_instance_of_type(item, expected_type)
+            except TypeError as e:
+                raise TypeError(f"In Type_Safe__Tuple: Invalid type for item: {e}")
+
+    def __repr__(self):
+        types_str = ', '.join(type_str(t) for t in self.expected_types)
+        return f"tuple[{types_str}] with {len(self)} elements"
+
+    def json(self):
+        from osbot_utils.type_safe.Type_Safe import Type_Safe
+
+        result = []
+        for item in self:
+            if isinstance(item, Type_Safe):
+                result.append(item.json())
+            elif isinstance(item, (list, tuple)):
+                result.append([x.json() if isinstance(x, Type_Safe) else x for x in item])
+            elif isinstance(item, dict):
+                result.append({k: v.json() if isinstance(v, Type_Safe) else v for k, v in item.items()})
+            else:
+                result.append(item)
+        return result

{osbot_utils-2.14.0 → osbot_utils-2.16.0}/osbot_utils/type_safe/shared/Type_Safe__Validation.py

@@ -159,6 +159,9 @@ class Type_Safe__Validation:
         attr_type   = annotations.get(attr_name)
         if attr_type:
             origin_attr_type = get_origin(attr_type)                                    # to handle when type definition contains a generic
+            if origin_attr_type is set:
+                if type(value) is list:
+                    return True                                                         # if the attribute is a set and the value is a list, then they are compatible
             if origin_attr_type is type:                                                # Add handling for Type[T]
                 type_arg = get_args(attr_type)[0]                                       # Get T from Type[T]
                 if type_arg == value:
@@ -220,7 +223,7 @@ class Type_Safe__Validation:
                                    )                 -> None:                                           # Raises ValueError if invalid
 
         direct_type_match = type_safe_validation.check_if__type_matches__obj_annotation__for_attr(target, name, value)
-        union_type_match = type_safe_validation.check_if__type_matches__obj_annotation__for_union_and_annotated(target, name, value)
+        union_type_match  = type_safe_validation.check_if__type_matches__obj_annotation__for_union_and_annotated(target, name, value)
 
         is_invalid = (direct_type_match is False and union_type_match is None) or \
                     (direct_type_match is None and union_type_match is False) or \

{osbot_utils-2.14.0 → osbot_utils-2.16.0}/osbot_utils/type_safe/steps/Type_Safe__Step__Default_Value.py

@@ -3,10 +3,12 @@ import sys
 import inspect
 import typing
 
-from osbot_utils.type_safe.shared.Type_Safe__Cache import type_safe_cache
-from osbot_utils.utils.Objects                     import default_value
-from osbot_utils.type_safe.Type_Safe__List         import Type_Safe__List
-from osbot_utils.type_safe.Type_Safe__Dict         import Type_Safe__Dict
+from osbot_utils.type_safe.Type_Safe__Set           import Type_Safe__Set
+from osbot_utils.type_safe.Type_Safe__Tuple         import Type_Safe__Tuple
+from osbot_utils.type_safe.shared.Type_Safe__Cache  import type_safe_cache
+from osbot_utils.utils.Objects                      import default_value
+from osbot_utils.type_safe.Type_Safe__List          import Type_Safe__List
+from osbot_utils.type_safe.Type_Safe__Dict          import Type_Safe__Dict
 
 
 # Backport implementations of get_args for Python 3.7        # todo: refactor into separate class (focused on past python version compatibility)
@@ -26,6 +28,11 @@ class Type_Safe__Step__Default_Value:
     def default_value(self, _cls, var_type):
 
         origin = type_safe_cache.get_origin(var_type)            # todo: refactor this to use the get_origin method
+
+        if origin is tuple:
+            item_types = get_args(var_type)
+            return Type_Safe__Tuple(expected_types=item_types)
+
         if origin is type:                        # Special handling for Type[T]  # todo: reuse the get_origin value
             type_args = get_args(var_type)
             if type_args:
@@ -40,12 +47,17 @@ class Type_Safe__Step__Default_Value:
             return set()
 
         if origin is set:
-            return set()                                        # todo: add Type_Safe__Set
+            item_type = get_args(var_type)[0]
+            if isinstance(item_type, ForwardRef):
+                forward_name = item_type.__forward_arg__
+                if forward_name == _cls.__name__:
+                    item_type = _cls
+            return Type_Safe__Set(expected_type=item_type)
 
         if var_type is typing.Dict:
             return {}
 
-        if origin is dict:                        # e.g. Dict[key_type, value_type]
+        if origin is dict:                                       # e.g. Dict[key_type, value_type]
             key_type, value_type = get_args(var_type)
             if isinstance(key_type, ForwardRef):                # Handle forward references on key_type ---
                 forward_name = key_type.__forward_arg__
@@ -67,8 +79,9 @@ class Type_Safe__Step__Default_Value:
                 if forward_name == _cls.__name__:                #    if the forward reference is to the current class (simple name check)
                     item_type = _cls                             #       set the item_type to the current class
             return Type_Safe__List(expected_type=item_type)     #    and used it as expected_type in Type_Safe__List
-        else:
-            return default_value(var_type)                      # for all other cases call default_value, which will try to create a default instance
+
+
+        return default_value(var_type)                      # for all other cases call default_value, which will try to create a default instance
 
 
 type_safe_step_default_value = Type_Safe__Step__Default_Value()

{osbot_utils-2.14.0 → osbot_utils-2.16.0}/osbot_utils/type_safe/steps/Type_Safe__Step__From_Json.py

@@ -6,9 +6,10 @@ from osbot_utils.type_safe.Type_Safe                     import Type_Safe
 from osbot_utils.type_safe.Type_Safe__List               import Type_Safe__List
 from osbot_utils.helpers.Random_Guid                     import Random_Guid
 from osbot_utils.helpers.Random_Guid_Short               import Random_Guid_Short
+from osbot_utils.type_safe.Type_Safe__Set                import Type_Safe__Set
 from osbot_utils.type_safe.shared.Type_Safe__Annotations import type_safe_annotations
 from osbot_utils.type_safe.shared.Type_Safe__Cache       import type_safe_cache
-from osbot_utils.type_safe.shared.Type_Safe__Convert import type_safe_convert
+from osbot_utils.type_safe.shared.Type_Safe__Convert     import type_safe_convert
 from osbot_utils.utils.Objects                           import enum_from_value
 from osbot_utils.helpers.Safe_Id                         import Safe_Id
 from osbot_utils.helpers.Timestamp_Now                   import Timestamp_Now
@@ -52,8 +53,24 @@ class Type_Safe__Step__From_Json:
                         value = self.deserialize_type__using_value(value)
                     elif annotation_origin == type:                                         # Handle type objects inside ForwardRef
                         value = self.deserialize_type__using_value(value)
+                    if annotation_origin is tuple and isinstance(value, list):
+                        # item_types = get_args(annotation)   # todo: see if we should do type safety here
+                        value = tuple(value)
                     elif type_safe_annotations.obj_is_attribute_annotation_of_type(_self, key, dict):                                # handle the case when the value is a dict
                         value = self.deserialize_dict__using_key_value_annotations(_self, key, value)
+                    elif type_safe_annotations.obj_is_attribute_annotation_of_type(_self, key, set):                              # handle the case when the value is a list
+                        attribute_annotation = type_safe_annotations.obj_attribute_annotation(_self, key)                          # get the annotation for this variable
+                        attribute_annotation_args = get_args(attribute_annotation)
+                        if attribute_annotation_args:
+                            expected_type        = get_args(attribute_annotation)[0]                            # get the first arg (which is the type)
+                            type_safe_set        = Type_Safe__Set(expected_type)                               # create a new instance of Type_Safe__List
+                            for item in value:                                                                  # next we need to convert all items (to make sure they all match the type)
+                                if type(item) is dict:
+                                    new_item = expected_type(**item)                                                # create new object
+                                else:
+                                    new_item = expected_type(item)
+                                type_safe_set.add(new_item)                                                 # and add it to the new type_safe_list obejct
+                            value = type_safe_set                                                              # todo: refactor out this create list code, maybe to an deserialize_from_list method
                     elif type_safe_annotations.obj_is_attribute_annotation_of_type(_self, key, list):                              # handle the case when the value is a list
                         attribute_annotation = type_safe_annotations.obj_attribute_annotation(_self, key)                          # get the annotation for this variable
                         attribute_annotation_args = get_args(attribute_annotation)
@@ -85,6 +102,7 @@ class Type_Safe__Step__From_Json:
                                 value = Random_Guid_Short(value)
                             elif type_safe_annotations.obj_is_attribute_annotation_of_type(_self, key, Timestamp_Now):     # handle Timestamp_Now
                                 value = Timestamp_Now(value)
+
                     setattr(_self, key, value)                                                   # Direct assignment for primitive types and other structures
 
         return _self
@@ -123,7 +141,7 @@ class Type_Safe__Step__From_Json:
 
             if type(dict_value) == value_class:                                        # if the value is already the target, then just use it
                 new__dict_value = dict_value
-            elif issubclass(value_class, Type_Safe):
+            elif isinstance(value_class, type) and issubclass(value_class, Type_Safe):
                 if 'node_type' in dict_value:
                     value_class = type_safe_convert.get_class_from_class_name(dict_value['node_type'])
 

{osbot_utils-2.14.0 → osbot_utils-2.16.0}/osbot_utils/utils/Objects.py

@@ -279,7 +279,9 @@ def serialize_to_dict(obj):
         return obj.name
     elif isinstance(obj, type):
         return f"{obj.__module__}.{obj.__name__}"                                   # save the full type name
-    elif isinstance(obj, list) or isinstance(obj, List):
+    elif isinstance(obj, (list, tuple, List)):  # Added tuple here
+        return [serialize_to_dict(item) for item in obj]
+    elif isinstance(obj, set):
         return [serialize_to_dict(item) for item in obj]
     elif isinstance(obj, dict):
         return {key: serialize_to_dict(value) for key, value in obj.items()}

osbot_utils-2.16.0/osbot_utils/version

@@ -0,0 +1 @@
+v2.16.0

{osbot_utils-2.14.0 → osbot_utils-2.16.0}/pyproject.toml

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

osbot_utils-2.14.0/osbot_utils/version

@@ -1 +0,0 @@
-v2.14.0