osbot-utils 1.70.0__tar.gz → 1.73.1__tar.gz

{osbot_utils-1.70.0 → osbot_utils-1.73.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: osbot_utils
-Version: 1.70.0
+Version: 1.73.1
 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.70.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.73.1-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.70.0 → osbot_utils-1.73.1}/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.70.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.73.1-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.70.0 → osbot_utils-1.73.1}/osbot_utils/base_classes/Type_Safe.py

@@ -12,6 +12,7 @@ from typing                                     import List
 from osbot_utils.base_classes.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.helpers.Safe_Id                import Safe_Id
 from osbot_utils.helpers.Timestamp_Now          import Timestamp_Now
 from osbot_utils.utils.Dev                      import pprint
 from osbot_utils.utils.Json                     import json_parse, json_to_bytes, json_to_gz
@@ -248,28 +249,63 @@ class Type_Safe:
                 setattr(self, key, value)
         return self
 
+    def deserialize_dict__using_key_value_annotations(self, key, value):
+        dict_annotations_tuple =  get_args(self.__annotations__[key])
+        if not dict_annotations_tuple:                                      # happens when the value is a dict/Dict with no annotations
+            return value
+        if not type(value) is dict:
+            return value
+        #key_class   = get_args(self.__annotations__[key])[0]
+        #value_class = get_args(self.__annotations__[key])[1]
+        key_class   = dict_annotations_tuple[0]
+        value_class = dict_annotations_tuple[1]
+        new_value   = {}
+
+        for dict_key, dict_value in value.items():
+            if issubclass(key_class, Type_Safe):
+                new__dict_key = key_class().deserialize_from_dict(dict_key)
+            else:
+                new__dict_key = key_class(dict_key)
+
+            if issubclass(value_class, Type_Safe):
+                new__dict_value = value_class().deserialize_from_dict(dict_value)
+            else:
+                new__dict_value = value_class(dict_value)
+            new_value[new__dict_key] = new__dict_value
 
+        return new_value
+
+    # todo: this needs refactoring, since the logic and code is getting quite complex (to be inside methods like this)
     def deserialize_from_dict(self, data):
+
         for key, value in data.items():
             if hasattr(self, key) and isinstance(getattr(self, key), Type_Safe):
-                getattr(self, key).deserialize_from_dict(value)                             # Recursive call for complex nested objects
+                getattr(self, key).deserialize_from_dict(value)                                             # if the attribute is a Type_Safe object, then also deserialize it
             else:
-                if hasattr(self, '__annotations__'):                                        # can only do type safety checks if the class does not have annotations
-                    if obj_is_attribute_annotation_of_type(self, key, EnumMeta):            # Handle the case when the value is an Enum
-                        enum_type = getattr(self, '__annotations__').get(key)
-                        if type(value) is not enum_type:                                    # If the value is not already of the target type
-                            value = enum_from_value(enum_type, value)                       # Try to resolve the value into the enum
-
-                    # todo: refactor these special cases into a separate method to class
-                    elif obj_is_attribute_annotation_of_type(self, key, Decimal):           # handle Decimals
-                        value = Decimal(value)
-                    elif obj_is_attribute_annotation_of_type(self, key, Random_Guid):       # handle Random_Guid
-                        value = Random_Guid(value)
-                    elif obj_is_attribute_annotation_of_type(self, key, Random_Guid_Short): # handle Random_Guid_Short
-                        value = Random_Guid_Short(value)
-                    elif 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
+                if hasattr(self, '__annotations__'):                                                        # can only do type safety checks if the class does not have annotations
+                    if hasattr(self, key) is False:                                                         # make sure we are now adding new attributes to the class
+                        raise ValueError(f"Attribute '{key}' not found in '{self.__class__.__name__}'")
+                    if 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(key, value)
+                    else:
+                        if value is not None:
+                            if obj_is_attribute_annotation_of_type(self, key, EnumMeta):            # Handle the case when the value is an Enum
+                                enum_type = getattr(self, '__annotations__').get(key)
+                                if type(value) is not enum_type:                                    # If the value is not already of the target type
+                                    value = enum_from_value(enum_type, value)                       # Try to resolve the value into the enum
+
+                            # todo: refactor these special cases into a separate method to class
+                            elif obj_is_attribute_annotation_of_type(self, key, Decimal):           # handle Decimals
+                                value = Decimal(value)
+                            elif obj_is_attribute_annotation_of_type(self, key, Safe_Id):           # handle Safe_Id
+                                value = Safe_Id(value)
+                            elif obj_is_attribute_annotation_of_type(self, key, Random_Guid):       # handle Random_Guid
+                                value = Random_Guid(value)
+                            elif obj_is_attribute_annotation_of_type(self, key, Random_Guid_Short): # handle Random_Guid_Short
+                                value = Random_Guid_Short(value)
+                            elif 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
 

osbot_utils-1.73.1/osbot_utils/helpers/Safe_Id.py

@@ -0,0 +1,12 @@
+from osbot_utils.utils.Misc import random_id_short
+from osbot_utils.utils.Str  import safe_id
+
+class Safe_Id(str):
+    def __new__(cls, value=None):
+        if value is None:
+            value = safe_id(random_id_short('safe-id'))
+        sanitized_value = safe_id(value)
+        return str.__new__(cls, sanitized_value)
+
+    def __str__(self):
+        return self

{osbot_utils-1.70.0 → osbot_utils-1.73.1}/osbot_utils/utils/Misc.py

@@ -379,6 +379,9 @@ def random_string(length:int=8, prefix:str='', postfix:str=''):
     value   = '_' + ''.join(random.choices(string.ascii_uppercase, k=length)).lower()
     return f"{prefix}{value}{postfix}"
 
+def random_string_short(prefix:str = None):
+    return random_id(prefix=prefix, length=6).lower()
+
 def random_string_and_numbers(length:int=6,prefix:str=''):
     return prefix + ''.join(random.choices(string.ascii_uppercase + string.digits, k=length))
 
@@ -508,6 +511,7 @@ str_lines           = split_lines
 str_remove          = remove
 
 random_id           = random_string
+random_id_short     = random_string_short
 random_int          = random_number
 random_guid         = random_uuid
 random_guid_short   = random_uuid_short

{osbot_utils-1.70.0 → osbot_utils-1.73.1}/osbot_utils/utils/Objects.py

@@ -8,12 +8,13 @@ import typing
 from collections.abc                    import Mapping
 from typing                             import Union
 from types                              import SimpleNamespace
+from osbot_utils.helpers.Safe_Id        import Safe_Id
 from osbot_utils.helpers.Timestamp_Now  import Timestamp_Now
 from osbot_utils.helpers.Random_Guid    import Random_Guid
 from osbot_utils.utils.Misc             import list_set
 from osbot_utils.utils.Str              import str_unicode_escape, str_max_width
 
-TYPE_SAFE__CONVERT_VALUE__SUPPORTED_TYPES = [Random_Guid, Timestamp_Now]
+TYPE_SAFE__CONVERT_VALUE__SUPPORTED_TYPES = [Safe_Id, Random_Guid, Timestamp_Now]
 
 # Backport implementations of get_origin and get_args for Python 3.7
 if sys.version_info < (3, 8):
@@ -352,6 +353,8 @@ def obj_is_attribute_annotation_of_type(target, attr_name, expected_type):
         return True
     if expected_type is type(attribute_annotation):
         return True
+    if expected_type is get_origin(attribute_annotation):                               # handle genericAlias
+        return True
     return False
 
 def obj_is_type_union_compatible(var_type, compatible_types):

osbot_utils-1.73.1/osbot_utils/version

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

{osbot_utils-1.70.0 → osbot_utils-1.73.1}/pyproject.toml

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

osbot_utils-1.70.0/osbot_utils/helpers/Safe_Id.py

@@ -1,9 +0,0 @@
-from osbot_utils.utils.Str import safe_id
-
-class Safe_Id(str):
-    def __new__(cls, value):
-        sanitized_value = safe_id(value)
-        return str.__new__(cls, sanitized_value)
-
-    def __str__(self):
-        return self

osbot_utils-1.70.0/osbot_utils/version

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