osbot-utils 1.92.0__tar.gz → 1.93.0__tar.gz

{osbot_utils-1.92.0 → osbot_utils-1.93.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: osbot_utils
-Version: 1.92.0
+Version: 1.93.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.92.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.93.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.92.0 → osbot_utils-1.93.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.92.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.93.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.92.0 → osbot_utils-1.93.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
@@ -95,8 +95,12 @@ class Type_Safe:
         if value is not None:
             if type(value) is dict:
                 value = convert_dict_to_value_from_obj_annotation(self, name, value)
-            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)
+            elif 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)
+            else:
+                origin = get_origin(value)
+                if origin is not None:
+                    value = origin
             check_1 = value_type_matches_obj_annotation_for_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
@@ -169,7 +173,7 @@ class Type_Safe:
                                 #todo: fix type safety bug that I believe is caused here
                                 if obj_is_type_union_compatible(var_type, IMMUTABLE_TYPES) is False:                # if var_type is not something like Optional[Union[int, str]]
                                     if type(var_type) not in IMMUTABLE_TYPES:
-                                        exception_message = f"variable '{var_name}' is defined as type '{var_type}' which is not supported by Kwargs_To_Self, with only the following immutable types being supported: '{IMMUTABLE_TYPES}'"
+                                        exception_message = f"variable '{var_name}' is defined as type '{var_type}' which is not supported by Type_Safe, with only the following immutable types being supported: '{IMMUTABLE_TYPES}'"
                                         raise ValueError(exception_message)
             if include_base_classes is False:
                 break
@@ -304,6 +308,19 @@ class Type_Safe:
                 setattr(self, key, value)
         return self
 
+    def deserialize_type__using_value(self, value):
+        if value:
+            try:
+                module_name, type_name = value.rsplit('.', 1)
+                if module_name == 'builtins' and type_name == 'NoneType':                       # Special case for NoneType (which serialises as builtins.* , but it actually in types.* )
+                    value = types.NoneType
+                else:
+                    module = __import__(module_name, fromlist=[type_name])
+                    value = getattr(module, type_name)
+            except (ValueError, ImportError, AttributeError) as e:
+                raise ValueError(f"Could not reconstruct type from '{value}': {str(e)}")
+        return value
+
     def deserialize_dict__using_key_value_annotations(self, key, value):
         from osbot_utils.base_classes.Type_Safe__Dict import Type_Safe__Dict
 
@@ -353,7 +370,9 @@ class Type_Safe:
                             raise ValueError(f"Attribute '{key}' not found in '{self.__class__.__name__}'")
                         else:
                             continue
-                    if obj_is_attribute_annotation_of_type(self, key, dict):                                # handle the case when the value is a dict
+                    if obj_attribute_annotation(self, key) == type:                                         # Handle type objects
+                        value = self.deserialize_type__using_value(value)
+                    elif 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)
                     elif obj_is_attribute_annotation_of_type(self, key, list):                              # handle the case when the value is a list
                         attribute_annotation = obj_attribute_annotation(self, key)                          # get the annotation for this variable
@@ -423,15 +442,17 @@ def serialize_to_dict(obj):
         return obj
     elif isinstance(obj, Enum):
         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):
         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()}
     elif hasattr(obj, "__dict__"):
-        data = {}                                           # todo: look at a more advanced version which saved the type of the object, for example with {'__type__': type(obj).__name__}
+        data = {}                                                                   # todo: look at a more advanced version which saved the type of the object, for example with {'__type__': type(obj).__name__}
         for key, value in obj.__dict__.items():
-            if key.startswith('__') is False:               # don't process internal variables (for example the ones set by @cache_on_self)
-                data[key] = serialize_to_dict(value)        # Recursive call for complex types
+            if key.startswith('__') is False:                                       # don't process internal variables (for example the ones set by @cache_on_self)
+                data[key] = serialize_to_dict(value)                                # Recursive call for complex types
         return data
     else:
         raise TypeError(f"Type {type(obj)} not serializable")

{osbot_utils-1.92.0 → osbot_utils-1.93.0}/osbot_utils/graphs/mermaid/Mermaid__Node.py

@@ -1,10 +1,6 @@
-from enum import Enum
-
-from osbot_utils.base_classes.Kwargs_To_Self import Kwargs_To_Self
-from osbot_utils.graphs.mermaid.configs.Mermaid__Node__Config import Mermaid__Node__Config
-from osbot_utils.graphs.mermaid.models.Mermaid__Node__Shape import Mermaid__Node__Shape
-from osbot_utils.graphs.mgraph.MGraph__Node import MGraph__Node
-from osbot_utils.utils.Str import safe_str
+from osbot_utils.graphs.mermaid.configs.Mermaid__Node__Config   import Mermaid__Node__Config
+from osbot_utils.graphs.mermaid.models.Mermaid__Node__Shape     import Mermaid__Node__Shape
+from osbot_utils.graphs.mgraph.MGraph__Node                     import MGraph__Node
 
 LINE_PADDING = '    '
 

{osbot_utils-1.92.0 → osbot_utils-1.93.0}/osbot_utils/graphs/mermaid/Mermaid__Renderer.py

@@ -1,7 +1,7 @@
 from typing import List
 
 from osbot_utils.base_classes.Kwargs_To_Self                        import Kwargs_To_Self
-from osbot_utils.graphs.mermaid.configs.Mermaid__Render__Config import Mermaid__Render__Config
+from osbot_utils.graphs.mermaid.configs.Mermaid__Render__Config     import Mermaid__Render__Config
 from osbot_utils.graphs.mermaid.models.Mermaid__Diagram_Direction   import Diagram__Direction
 from osbot_utils.graphs.mermaid.models.Mermaid__Diagram__Type       import Diagram__Type
 

{osbot_utils-1.92.0 → osbot_utils-1.93.0}/osbot_utils/helpers/Safe_Id.py

@@ -1,8 +1,10 @@
 from osbot_utils.utils.Misc import random_id_short
 from osbot_utils.utils.Str  import safe_id
 
+SAFE_ID__MAX_LENGTH = 512
+
 class Safe_Id(str):
-    def __new__(cls, value=None, max_length=36):
+    def __new__(cls, value=None, max_length=SAFE_ID__MAX_LENGTH):
         if value is None:
             value = safe_id(random_id_short('safe-id'))
         sanitized_value = safe_id(value, max_length=max_length)

{osbot_utils-1.92.0 → osbot_utils-1.93.0}/osbot_utils/utils/Json.py

@@ -193,6 +193,7 @@ json_save_file_gz            = Json.save_file_gz
 json_save_file_pretty_gz     = Json.save_file_pretty_gz
 json_save_tmp_file           = Json.json_save_tmp_file
 str_to_json                  = Json.loads
+str_from_json                = json_dumps
 
 load_file_json               = json_load_file
 load_file_json_gz            = json_load_file_gz

{osbot_utils-1.92.0 → osbot_utils-1.93.0}/osbot_utils/utils/Objects.py

@@ -359,8 +359,6 @@ def obj_attribute_annotation(target, attr_name):
 
 def obj_is_attribute_annotation_of_type(target, attr_name, expected_type):
     attribute_annotation = obj_attribute_annotation(target, attr_name)
-    #attribute_type       = type(attribute_annotation)
-    #return attribute_type is expected_type
     if expected_type is attribute_annotation:
         return True
     if expected_type is type(attribute_annotation):

{osbot_utils-1.92.0 → osbot_utils-1.93.0}/osbot_utils/utils/Str.py

@@ -42,7 +42,7 @@ def safe_id(value, max_length=36):
         value = str(value)
 
     if len(value) > max_length:
-        raise ValueError(f"Invalid ID: The ID must not exceed 36 characters (was {len(value)}).")
+        raise ValueError(f"Invalid ID: The ID must not exceed {max_length} characters (was {len(value)}).")
 
     sanitized_value = REGEX__SAFE_ID_REGEX.sub('_', value)
 

osbot_utils-1.93.0/osbot_utils/version

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

{osbot_utils-1.92.0 → osbot_utils-1.93.0}/pyproject.toml

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

osbot_utils-1.92.0/osbot_utils/version

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