osbot-utils 1.75.0__tar.gz → 1.77.0__tar.gz

{osbot_utils-1.75.0 → osbot_utils-1.77.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: osbot_utils
-Version: 1.75.0
+Version: 1.77.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.75.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.77.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.75.0 → osbot_utils-1.77.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.75.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.77.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.77.0/osbot_utils/base_classes/Type_Safe__List.py

@@ -0,0 +1,133 @@
+from typing import get_origin, get_args, Union, Optional, Any, ForwardRef
+
+EXACT_TYPE_MATCH = (int, float, str, bytes, bool, complex)
+
+class Type_Safe__List(list):
+
+    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"list[{expected_type_name}] with {len(self)} elements"
+
+    def append(self, item):
+        try:
+            self.is_instance_of_type(item, self.expected_type)
+        except TypeError as e:
+            raise TypeError(f"In Type_Safe__List: Invalid type for item: {e}")
+        super().append(item)
+
+    def is_instance_of_type(self, item, expected_type):
+        if expected_type is Any:
+            return True
+        if isinstance(expected_type, ForwardRef):               # todo: add support for ForwardRef
+            return True
+        origin = get_origin(expected_type)
+        args   = get_args(expected_type)
+        if origin is None:
+            if expected_type in EXACT_TYPE_MATCH:
+                if type(item) is expected_type:
+                    return True
+                else:
+                    expected_type_name = type_str(expected_type)
+                    actual_type_name = type_str(type(item))
+                    raise TypeError(f"Expected '{expected_type_name}', but got '{actual_type_name}'")
+            else:
+                if isinstance(item, expected_type):                                 # Non-parameterized type
+                    return True
+                else:
+                    expected_type_name = type_str(expected_type)
+                    actual_type_name   = type_str(type(item))
+                    raise TypeError(f"Expected '{expected_type_name}', but got '{actual_type_name}'")
+
+        elif origin is list and args:                                                    # Expected type is List[...]
+            (item_type,) = args
+            if not isinstance(item, list):
+                expected_type_name = type_str(expected_type)
+                actual_type_name   = type_str(type(item))
+                raise TypeError(f"Expected '{expected_type_name}', but got '{actual_type_name}'")
+            for idx, elem in enumerate(item):
+                try:
+                    self.is_instance_of_type(elem, item_type)
+                except TypeError as e:
+                    raise TypeError(f"In list at index {idx}: {e}")
+            return True
+        elif origin is dict and args:                                                    # Expected type is Dict[...]
+            key_type, value_type = args
+            if not isinstance(item, dict):
+                expected_type_name = type_str(expected_type)
+                actual_type_name   = type_str(type(item))
+                raise TypeError(f"Expected '{expected_type_name}', but got '{actual_type_name}'")
+            for k, v in item.items():
+                try:
+                    self.is_instance_of_type(k, key_type)
+                except TypeError as e:
+                    raise TypeError(f"In dict key '{k}': {e}")
+                try:
+                    self.is_instance_of_type(v, value_type)
+                except TypeError as e:
+                    raise TypeError(f"In dict value for key '{k}': {e}")
+            return True
+        elif origin is tuple:
+            if not isinstance(item, tuple):
+                expected_type_name = type_str(expected_type)
+                actual_type_name = type_str(type(item))
+                raise TypeError(f"Expected '{expected_type_name}', but got '{actual_type_name}'")
+            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)):
+                try:
+                    self.is_instance_of_type(elem, elem_type)
+                except TypeError as e:
+                    raise TypeError(f"In tuple at index {idx}: {e}")
+            return True
+        elif origin is Union or expected_type is Optional:                                                   # Expected type is Union[...]
+            for arg in args:
+                try:
+                    self.is_instance_of_type(item, arg)
+                    return True
+                except TypeError:
+                    continue
+            expected_type_name = type_str(expected_type)
+            actual_type_name   = type_str(type(item))
+            raise TypeError(f"Expected '{expected_type_name}', but got '{actual_type_name}'")
+        else:
+            if isinstance(item, origin):
+                return True
+            else:
+                expected_type_name = type_str(expected_type)
+                actual_type_name = type_str(type(item))
+                raise TypeError(f"Expected '{expected_type_name}', but got '{actual_type_name}'")
+
+# todo: see if we should/can move this to the Objects.py file
+def type_str(tp):
+    origin = get_origin(tp)
+    if origin is None:
+        if hasattr(tp, '__name__'):
+            return tp.__name__
+        else:
+            return str(tp)
+    else:
+        args = get_args(tp)
+        args_str = ', '.join(type_str(arg) for arg in args)
+        return f"{origin.__name__}[{args_str}]"
+
+def get_object_type_str(obj):
+    if isinstance(obj, dict):
+        if not obj:
+            return "Dict[Empty]"
+        key_types      = set(type(k).__name__ for k in obj.keys())
+        value_types    = set(type(v).__name__ for v in obj.values())
+        key_type_str   = ', '.join(sorted(key_types))
+        value_type_str = ', '.join(sorted(value_types))
+        return f"Dict[{key_type_str}, {value_type_str}]"
+    elif isinstance(obj, list):
+        if not obj:
+            return "List[Empty]"
+        elem_types = set(type(e).__name__ for e in obj)
+        elem_type_str = ', '.join(sorted(elem_types))
+        return f"List[{elem_type_str}]"
+    else:
+        return type(obj).__name__

{osbot_utils-1.75.0 → osbot_utils-1.77.0}/osbot_utils/decorators/methods/cache_on_self.py

@@ -1,8 +1,7 @@
 import inspect
-from functools import wraps
-
+from functools              import wraps
 from osbot_utils.utils.Misc import str_md5
-from typing import Any, Callable, TypeVar
+from typing                 import Any, Callable, TypeVar
 
 
 CACHE_ON_SELF_KEY_PREFIX = '__cache_on_self__'

{osbot_utils-1.75.0 → osbot_utils-1.77.0}/osbot_utils/utils/Objects.py

@@ -394,6 +394,12 @@ def value_type_matches_obj_annotation_for_attr(target, attr_name, value):
             attr_type        = obj_annotations.get(attr_name)
             if attr_type:
                 origin_attr_type = get_origin(attr_type)                # to handle when type definion contains an generic
+                if origin_attr_type is typing.Union:
+                    args = get_args(attr_type)
+                    if len(args)==2 and args[1] is type(None):          # todo: find a better way to do this, since this is handling an edge case when origin_attr_type is Optional (whcih is an shorthand for Union[X, None] )
+                        attr_type = args[0]
+                        origin_attr_type = get_origin(attr_type)
+
                 if origin_attr_type:
                     attr_type = origin_attr_type
                 value_type = type(value)

osbot_utils-1.77.0/osbot_utils/version

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

{osbot_utils-1.75.0 → osbot_utils-1.77.0}/pyproject.toml

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

osbot_utils-1.75.0/osbot_utils/base_classes/Type_Safe__List.py

@@ -1,14 +0,0 @@
-class Type_Safe__List(list):
-
-    def __init__(self, expected_type, *args):
-        super().__init__(*args)
-        self.expected_type = expected_type
-
-    def __repr__(self):
-        return f"list[{self.expected_type.__name__}] with {len(self)} elements"
-
-    def append(self, item):
-        if not isinstance(item, self.expected_type):
-            raise TypeError(f"In Type_Safe__List: Invalid type for item: Expected '{self.expected_type.__name__}', but got '{type(item).__name__}'")
-        super().append(item)
-

osbot_utils-1.75.0/osbot_utils/version

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