osbot-utils 2.61.0__tar.gz → 2.63.0__tar.gz

{osbot_utils-2.61.0 → osbot_utils-2.63.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: osbot_utils
-Version: 2.61.0
+Version: 2.63.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.61.0-blue)
+![Current Release](https://img.shields.io/badge/release-v2.63.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.61.0 → osbot_utils-2.63.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.61.0-blue)
+![Current Release](https://img.shields.io/badge/release-v2.63.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.61.0 → osbot_utils-2.63.0}/osbot_utils/helpers/Obj_Id.py

@@ -1,4 +1,5 @@
 import random
+from osbot_utils.type_safe.Type_Safe__Primitive import Type_Safe__Primitive
 
 _hex_table = [f"{i:02x}" for i in range(256)]
 
@@ -14,7 +15,7 @@ def is_obj_id(value: str):
 def new_obj_id():
     return hex(random.getrandbits(32))[2:].zfill(8)  # slice off '0x' and pad
 
-class Obj_Id(str):
+class Obj_Id(Type_Safe__Primitive,str):
     def __new__(cls, value: str=None):
         if value:
             if is_obj_id(value):

{osbot_utils-2.61.0 → osbot_utils-2.63.0}/osbot_utils/helpers/Random_Guid.py

@@ -1,6 +1,6 @@
+from osbot_utils.type_safe.Type_Safe__Primitive import Type_Safe__Primitive
 
-
-class Random_Guid(str):
+class Random_Guid(Type_Safe__Primitive, str):
     def __new__(cls, value=None):
         from osbot_utils.utils.Misc import random_guid, is_guid
 
@@ -10,5 +10,5 @@ class Random_Guid(str):
             return str.__new__(cls, value)
         raise ValueError(f'in Random_Guid: value provided was not a Guid: {value}')
 
-    def __str__(self):
-        return self
+    # def __str__(self):
+    #     return self

osbot_utils-2.63.0/osbot_utils/helpers/Safe_Id.py

@@ -0,0 +1,18 @@
+from osbot_utils.type_safe.Type_Safe__Primitive import Type_Safe__Primitive
+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(Type_Safe__Primitive, str):
+    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)
+        return str.__new__(cls, sanitized_value)
+
+    # def __str__(self):
+    #     return self
+
+
+# note: here is the regex applied on safe_id:  REGEX__SAFE_ID_REGEX       = re.compile(r'[^a-zA-Z0-9_-]')

{osbot_utils-2.61.0 → osbot_utils-2.63.0}/osbot_utils/helpers/Timestamp_Now.py

@@ -1,5 +1,6 @@
+from osbot_utils.type_safe.Type_Safe__Primitive import Type_Safe__Primitive
 
-class Timestamp_Now(int):
+class Timestamp_Now(Type_Safe__Primitive, int):
     def __new__(cls, value=None):
         from osbot_utils.utils.Misc import timestamp_now
 

{osbot_utils-2.61.0 → osbot_utils-2.63.0}/osbot_utils/helpers/safe_float/Safe_Float.py

@@ -1,8 +1,10 @@
 import math
-from decimal import Decimal, ROUND_HALF_UP, InvalidOperation
-from typing import Optional, Union
+from decimal                                    import Decimal, ROUND_HALF_UP, InvalidOperation
+from typing                                     import Optional, Union
+from osbot_utils.type_safe.Type_Safe__Primitive import Type_Safe__Primitive
 
-class Safe_Float(float):                             # Base class for type-safe floats with validation rules
+
+class Safe_Float(Type_Safe__Primitive, float):                             # Base class for type-safe floats with validation rules
 
     min_value      : Optional[float] = None
     max_value      : Optional[float] = None

{osbot_utils-2.61.0 → osbot_utils-2.63.0}/osbot_utils/helpers/safe_int/Safe_Int.py

@@ -1,9 +1,9 @@
-from typing import Optional, Union
+from typing                                     import Optional, Union
+from osbot_utils.helpers.safe_float.Safe_Float  import Safe_Float
+from osbot_utils.type_safe.Type_Safe__Primitive import Type_Safe__Primitive
 
-from osbot_utils.helpers.safe_float.Safe_Float import Safe_Float
 
-
-class Safe_Int(int):            # Base class for type-safe integers with validation rules
+class Safe_Int(Type_Safe__Primitive, int):            # Base class for type-safe integers with validation rules
 
     min_value      : Optional[int] = None    # Minimum allowed value (inclusive)
     max_value      : Optional[int] = None    # Maximum allowed value (inclusive)

{osbot_utils-2.61.0 → osbot_utils-2.63.0}/osbot_utils/helpers/safe_str/Safe_Str.py

@@ -1,10 +1,11 @@
 import re
-from typing import Optional
+from typing                                     import Optional
+from osbot_utils.type_safe.Type_Safe__Primitive import Type_Safe__Primitive
 
 TYPE_SAFE__STR__REGEX__SAFE_STR = re.compile(r'[^a-zA-Z0-9]')    # Only allow alphanumerics and numbers
 TYPE_SAFE__STR__MAX_LENGTH      = 512
 
-class Safe_Str(str):
+class Safe_Str(Type_Safe__Primitive, str):
     max_length                : int           = TYPE_SAFE__STR__MAX_LENGTH
     regex                     : re.Pattern    = TYPE_SAFE__STR__REGEX__SAFE_STR
     replacement_char          : str           = '_'

{osbot_utils-2.61.0 → osbot_utils-2.63.0}/osbot_utils/type_safe/Type_Safe__Base.py

@@ -104,8 +104,25 @@ class Type_Safe__Base:
                 actual_type_name = type_str(type(item))
                 raise TypeError(f"Expected '{expected_type_name}', but got '{actual_type_name}'")
 
-    # def json(self):
-    #     pass
+    def try_convert(self, value, expected_type):    # Try to convert value to expected type using Type_Safe conversion logic.
+
+        if expected_type is Any:                                    # Handle Any type
+            return value
+
+        origin = type_safe_cache.get_origin(expected_type)          # Handle subscripted generics (like Callable, Union, etc.)
+        if origin is not None:
+            return value                                            # Can't convert generic types, let type check handle it
+
+        if isinstance(value, expected_type):        # If already correct type, return as-is
+            return value
+
+        if isinstance(expected_type, type) and type(value) in [str, int, float]:        # For types that are subclasses of built-ins (like Safe_Id extends str)
+            if issubclass(expected_type, type(value)):                                  # Only convert if the value's type is a base class of expected_type. e.g., str → Safe_Id (ok), but not int → str (not ok)
+                return expected_type(value)                                             # convert value to expected_type
+
+
+        # Return original if no conversion possible
+        return value
 
 # todo: see if we should/can move this to the Objects.py file
 def type_str(tp):

{osbot_utils-2.61.0 → osbot_utils-2.63.0}/osbot_utils/type_safe/Type_Safe__Dict.py

@@ -1,4 +1,5 @@
 from typing                                import Type
+from osbot_utils.type_safe.Type_Safe__List import Type_Safe__List
 from osbot_utils.type_safe.Type_Safe__Base import Type_Safe__Base
 
 class Type_Safe__Dict(Type_Safe__Base, dict):
@@ -8,15 +9,22 @@ class Type_Safe__Dict(Type_Safe__Base, dict):
         self.expected_key_type   = expected_key_type
         self.expected_value_type = expected_value_type
 
-    def __setitem__(self, key, value):                                  # Check type-safety before allowing assignment.
+    def __getitem__(self, key):
+        try:
+            return super().__getitem__(key)                                     # First try direct lookup
+        except KeyError:
+            converted_key = self.try_convert(key, self.expected_key_type)       # Try converting the key
+            return super().__getitem__(converted_key)                           # and compare again
+
+    def __setitem__(self, key, value):                                          # Check type-safety before allowing assignment.
+        key   = self.try_convert(key  , self.expected_key_type  )
+        value = self.try_convert(value, self.expected_value_type)
         self.is_instance_of_type(key  , self.expected_key_type)
         self.is_instance_of_type(value, self.expected_value_type)
         super().__setitem__(key, value)
 
-    # def __repr__(self):
-    #     key_type_name   = type_str(self.expected_key_type)
-    #     value_type_name = type_str(self.expected_value_type)
-    #     return f"dict[{key_type_name}, {value_type_name}] with {len(self)} entries"
+    def __enter__(self): return self
+    def __exit__ (self, type, value, traceback): pass
 
     def json(self):                                                                         # Convert the dictionary to a JSON-serializable format.
         from osbot_utils.type_safe.Type_Safe import Type_Safe                               # can only import this here to avoid circular imports
@@ -38,3 +46,9 @@ class Type_Safe__Dict(Type_Safe__Base, dict):
             else:                                                                           # Regular values can be used as-is
                 result[key] = value
         return result
+
+    def keys(self) -> Type_Safe__List:
+        return Type_Safe__List(self.expected_key_type, super().keys())
+
+    def values(self) -> Type_Safe__List:
+        return Type_Safe__List(self.expected_value_type, super().values())

{osbot_utils-2.61.0 → osbot_utils-2.63.0}/osbot_utils/type_safe/Type_Safe__List.py

@@ -1,6 +1,8 @@
-from osbot_utils.type_safe.Type_Safe__Base import Type_Safe__Base, type_str
+from typing                                 import Type
+from osbot_utils.type_safe.Type_Safe__Base  import Type_Safe__Base, type_str
 
 class Type_Safe__List(Type_Safe__Base, list):
+    expected_type : Type
 
     def __init__(self, expected_type, *args):
         super().__init__(*args)
@@ -10,6 +12,9 @@ class Type_Safe__List(Type_Safe__Base, list):
         expected_type_name = type_str(self.expected_type)
         return f"list[{expected_type_name}] with {len(self)} elements"
 
+    def __enter__(self): return self
+    def __exit__ (self, type, value, traceback): pass
+
     def append(self, item):
         from osbot_utils.type_safe.Type_Safe import Type_Safe
         if type(self.expected_type) is type and issubclass(self.expected_type, Type_Safe) and type(item) is dict:  # if self.expected_type is Type_Safe and we have a dict
@@ -18,7 +23,7 @@ class Type_Safe__List(Type_Safe__Base, list):
             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}")
+               raise TypeError(f"In Type_Safe__List: Invalid type for item: {e}") from None
         super().append(item)
 
 

{osbot_utils-2.61.0 → osbot_utils-2.63.0}/osbot_utils/type_safe/Type_Safe__Method.py

@@ -185,5 +185,5 @@ class Type_Safe__Method:
             base_type = expected_type
 
         if not isinstance(param_value, base_type):
-            raise ValueError(f"Parameter '{param_name}' expected type {expected_type}, but got {type(param_value)}")
+            raise ValueError(f"Parameter '{param_name}' expected type {expected_type}, but got {type(param_value)}") from None
         return True

osbot_utils-2.63.0/osbot_utils/type_safe/Type_Safe__Primitive.py

@@ -0,0 +1,64 @@
+class Type_Safe__Primitive:
+
+    __primitive_base__ = None                                                   # Cache the primitive base type at class level
+
+    def __init_subclass__(cls, **kwargs):
+        super().__init_subclass__(**kwargs)
+        for base in cls.__mro__:                                                # Find and cache the primitive base type when the class is created
+            if base in (str, int, float):                                       # for now, we only support str, int, float
+                cls.__primitive_base__ = base
+                break
+
+    def __add__(self, other):
+        """Override addition/concatenation to maintain type safety"""
+        if self.__primitive_base__ is str:                                      # For string concatenation
+            result = super().__add__(other)                                     # Perform the operation
+            return type(self)(result)                                           # Return instance of the safe type
+        else:                                                                   # For numeric types (int, float)
+            result = super().__add__(other)
+            try:
+                return type(self)(result)                                       # Try to create safe type
+            except (ValueError, TypeError):
+                return result                                                   # Fall back to primitive if constraints violated
+
+
+    def __eq__(self, other):
+        if type(self) is type(other):                                           # Same type → compare values
+            return super().__eq__(other)
+        if self.__primitive_base__ and type(other) is self.__primitive_base__:  # Compare with cached primitive base type
+            return super().__eq__(other)
+        return False                                                            # Different types → not equal
+
+    def __ne__(self, other):
+        return not self.__eq__(other)
+
+    def __hash__(self):                                                     # Include type in hash to maintain hash/eq contract , This works for str, int, float subclasses
+        return hash((type(self).__name__, super().__hash__()))
+
+    def __radd__(self, other):
+        """Reverse addition/concatenation for when safe type is on the right"""
+        if self.__primitive_base__ is str:
+            result = other + str(self)                                         # Perform string concatenation
+            return type(self)(result)                                          # Return instance of the safe type
+        else:
+            result = other + self.__primitive_base__(self)
+            try:
+                return type(self)(result)
+            except (ValueError, TypeError):
+                return result
+
+    def __str__(self):                                              # Return the primitive string representation"""
+        if self.__primitive_base__ is float:                        # Format the value using the primitive type's string formatting
+            return format(float(self), '')
+        elif self.__primitive_base__ is int:
+            return format(int(self), '')
+        elif self.__primitive_base__ is str:
+            return str.__str__(self)
+        return super().__str__()
+
+    def __repr__(self):                                             # Enhanced repr for debugging that shows type information
+        value_str = self.__str__()
+        if self.__primitive_base__ is str:
+            return f"{type(self).__name__}('{value_str}')"
+        else:
+            return f"{type(self).__name__}({value_str})"

{osbot_utils-2.61.0 → osbot_utils-2.63.0}/osbot_utils/type_safe/shared/Type_Safe__Raise_Exception.py

@@ -8,7 +8,7 @@ class Type_Safe__Raise_Exception:
         raise ValueError(exception_message)
 
     def immutable_type_error(self, var_name, var_type):
-        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}'"
+        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}' and the following subclasses (int, float, str)"
         raise ValueError(exception_message)
 
 type_safe_raise_exception = Type_Safe__Raise_Exception()

{osbot_utils-2.61.0 → osbot_utils-2.63.0}/osbot_utils/type_safe/shared/Type_Safe__Validation.py

@@ -4,6 +4,7 @@ import types
 import typing
 from enum                                                      import EnumMeta
 from typing                                                    import Any, Annotated, Optional, get_args, get_origin, ForwardRef, Type, Dict, _GenericAlias
+from osbot_utils.type_safe.Type_Safe__Primitive                import Type_Safe__Primitive
 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__Shared__Variables import IMMUTABLE_TYPES
@@ -33,6 +34,9 @@ class Type_Safe__Validation:
                 return True
         if target_type is typing.Any:
             return True
+        if isinstance(target_type, type) and issubclass(target_type,Type_Safe__Primitive):
+            if source_type in (int, float, str):
+                return True
         return False
 
     def are_types_magic_mock(self, source_type, target_type):
@@ -277,7 +281,7 @@ class Type_Safe__Validation:
                 actual_type = value
             else:
                 actual_type = type(value)
-            raise ValueError(f"Invalid type for attribute '{name}'. Expected '{expected_type}' but got '{actual_type}'")
+            raise ValueError(f"Invalid type for attribute '{name}'. Expected '{expected_type}' but got '{actual_type}'") from None
 
     # todo: see if need to add cache support to this method     (it looks like this method is not called very often)
     def validate_type_immutability(self, var_name: str, var_type: Any) -> None:                         # Validates that type is immutable or in supported format
@@ -285,7 +289,7 @@ class Type_Safe__Validation:
             if self.obj_is_type_union_compatible(var_type, IMMUTABLE_TYPES) is False:                        # if var_type is not something like Optional[Union[int, str]]
                 if var_type not in IMMUTABLE_TYPES or type(var_type) not in IMMUTABLE_TYPES:
                     if not isinstance(var_type, EnumMeta):
-                        if not issubclass(var_type, (int,str, float)):
+                        if not (isinstance(var_type, type) and issubclass(var_type, (int,str, float))):
                             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

{osbot_utils-2.61.0 → osbot_utils-2.63.0}/osbot_utils/type_safe/steps/Type_Safe__Step__Init.py

@@ -25,7 +25,7 @@ class Type_Safe__Step__Init:
                     setattr(__self, key, value)
             else:
                 raise ValueError(f"{__self.__class__.__name__} has no attribute '{key}' and cannot be assigned the value '{value}'. "
-                                 f"Use {__self.__class__.__name__}.__default_kwargs__() see what attributes are available")
+                                 f"Use {__self.__class__.__name__}.__default_kwargs__() see what attributes are available") from None
 
     def convert_value_to_type_safe_objects(self, __self, key, value):
         annotation = type_safe_annotations.obj_attribute_annotation(__self, key)

{osbot_utils-2.61.0 → osbot_utils-2.63.0}/osbot_utils/type_safe/steps/Type_Safe__Step__Set_Attr.py

@@ -1,4 +1,5 @@
 from typing                                                  import get_origin, Annotated, get_args
+from osbot_utils.type_safe.Type_Safe__Primitive              import Type_Safe__Primitive
 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__Validation      import type_safe_validation
@@ -9,7 +10,9 @@ class Type_Safe__Step__Set_Attr:
     def resolve_value(self, _self, annotations, name, value):
         if type(value) is dict:
             value = self.resolve_value__dict(_self, name, value)
-        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)
+        elif isinstance(annotations.get(name), type) and issubclass(annotations.get(name), Type_Safe__Primitive) and type(value) in (int, str, float):
+            return annotations.get(name)(value)
+        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 = self.resolve_value__int_str(_self, name, value)
         else:
             value = self.resolve_value__from_origin(value)

{osbot_utils-2.61.0 → osbot_utils-2.63.0}/osbot_utils/utils/Objects.py

@@ -272,7 +272,9 @@ def serialize_to_dict(obj):
     from enum    import Enum
     from typing  import List
 
-    if isinstance(obj, (str, int, float, bool, bytes, Decimal)) or obj is None:     # todo: add support for objects like datetime
+    if hasattr(obj, '__primitive_base__') and isinstance(obj, (str, int, float)):
+        return obj.__primitive_base__(obj)
+    elif isinstance(obj, (str, int, float, bool, bytes, Decimal)) or obj is None:     # todo: add support for objects like datetime
         return obj
     elif isinstance(obj, Enum):
         return obj.name

osbot_utils-2.63.0/osbot_utils/version

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

{osbot_utils-2.61.0 → osbot_utils-2.63.0}/pyproject.toml

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

osbot_utils-2.61.0/osbot_utils/helpers/Safe_Id.py

@@ -1,14 +0,0 @@
-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=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)
-        return str.__new__(cls, sanitized_value)
-
-    def __str__(self):
-        return self

osbot_utils-2.61.0/osbot_utils/version

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