osbot-utils 2.15.0__tar.gz → 2.17.0__tar.gz

{osbot_utils-2.15.0 → osbot_utils-2.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: osbot_utils
-Version: 2.15.0
+Version: 2.17.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.15.0-blue)
+![Current Release](https://img.shields.io/badge/release-v2.17.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.15.0 → osbot_utils-2.17.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.15.0-blue)
+![Current Release](https://img.shields.io/badge/release-v2.17.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.15.0 → osbot_utils-2.17.0}/osbot_utils/type_safe/Type_Safe__Base.py

@@ -1,4 +1,5 @@
 from typing                                         import get_args, Union, Optional, Any, ForwardRef
+from osbot_utils.helpers.Obj_Id                     import Obj_Id
 from osbot_utils.type_safe.shared.Type_Safe__Cache  import type_safe_cache
 
 EXACT_TYPE_MATCH = (int, float, str, bytes, bool, complex)
@@ -63,6 +64,8 @@ class Type_Safe__Base:
             if len(args) != len(item):
                 raise TypeError(f"Expected tuple of length {len(args)}, but got {len(item)}")
             for idx, (elem, elem_type) in enumerate(zip(item, args)):
+                if elem_type is Obj_Id:                                     # todo: refactor this out, and figure out better way to handle this kind of de-serialisation
+                    elem = elem_type(elem)
                 try:
                     self.is_instance_of_type(elem, elem_type)
                 except TypeError as e:

osbot_utils-2.17.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.15.0 → osbot_utils-2.17.0}/osbot_utils/type_safe/shared/Type_Safe__Validation.py

@@ -246,7 +246,7 @@ class Type_Safe__Validation:
                         type_safe_raise_exception.immutable_type_error(var_name, var_type)
 
     def validate_variable_type(self, var_name, var_type, var_value):                                # Validate type compatibility
-        if var_type and not isinstance(var_value, var_type):
+        if type(var_type) is type and not isinstance(var_value, var_type):
             type_safe_raise_exception.type_mismatch_error(var_name, var_type, type(var_value))
 
 type_safe_validation = Type_Safe__Validation()

{osbot_utils-2.15.0 → osbot_utils-2.17.0}/osbot_utils/type_safe/steps/Type_Safe__Step__Default_Value.py

@@ -3,11 +3,12 @@ import sys
 import inspect
 import typing
 
-from osbot_utils.type_safe.Type_Safe__Set          import Type_Safe__Set
-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)
@@ -27,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:
@@ -73,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.15.0 → osbot_utils-2.17.0}/osbot_utils/type_safe/steps/Type_Safe__Step__From_Json.py

@@ -53,6 +53,9 @@ 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
@@ -99,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

{osbot_utils-2.15.0 → osbot_utils-2.17.0}/osbot_utils/utils/Json.py

@@ -170,7 +170,7 @@ json_file_create_gz          = Json.save_file_gz
 json_file_contents           = Json.load_file
 json_file_contents_gz        = Json.load_file_gz
 json_file_load               = Json.load_file
-json_file_safe               = Json.save_file
+json_file_save               = Json.save_file
 json_from_file               = Json.load_file
 json_load_file               = Json.load_file
 json_load_file_and_delete    = Json.load_file_and_delete
@@ -184,6 +184,7 @@ json_lines_loads             = Json.loads_json_lines
 json_parse                   = Json.loads
 json_lines_parse             = Json.loads_json_lines
 json_to_bytes                = json_dumps_to_bytes
+json_to_file                 = json_file_save
 json_to_str                  = json_dumps
 json_round_trip              = Json.round_trip
 json_save                    = Json.save_file

{osbot_utils-2.15.0 → osbot_utils-2.17.0}/osbot_utils/utils/Objects.py

@@ -279,7 +279,7 @@ 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]

osbot_utils-2.17.0/osbot_utils/version

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

{osbot_utils-2.15.0 → osbot_utils-2.17.0}/pyproject.toml

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

osbot_utils-2.15.0/osbot_utils/version

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