osbot-utils 2.64.0__tar.gz → 2.66.0__tar.gz

{osbot_utils-2.64.0 → osbot_utils-2.66.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: osbot_utils
-Version: 2.64.0
+Version: 2.66.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.64.0-blue)
+![Current Release](https://img.shields.io/badge/release-v2.66.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.64.0 → osbot_utils-2.66.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.64.0-blue)
+![Current Release](https://img.shields.io/badge/release-v2.66.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.64.0 → osbot_utils-2.66.0}/osbot_utils/base_classes/Kwargs_To_Disk.py

@@ -20,7 +20,7 @@ class Kwargs_To_Disk:
         else:
             self._local_cache.set(key, value)
 
-    def _cache_create        (self): return self._local_cache.create         ()
+    def _cache_create        (self): return self._local_cache.create()
     def _cache_delete        (self): return self._local_cache.cache_delete   ()
     def _cache_data          (self): return self._local_cache.data           ()
     def _cache_exists        (self): return self._local_cache.cache_exists   ()

{osbot_utils-2.64.0 → osbot_utils-2.66.0}/osbot_utils/helpers/pubsub/PubSub__Sqlite.py

@@ -15,7 +15,7 @@ class PubSub__Sqlite(Sqlite__Database):
         with self.table_clients() as _:
             _.row_schema = TABLE_SCHEMA__PUB_SUB__CLIENTS
             if _.exists() is False:
-                _.create()                      # create if it doesn't exist
+                _.create()  # create if it doesn't exist
                 return True
         return False
 

{osbot_utils-2.64.0 → osbot_utils-2.66.0}/osbot_utils/helpers/safe_str/Safe_Str__Hash.py

@@ -1,6 +1,7 @@
 import re
+from typing                                 import Any
 from osbot_utils.helpers.safe_str.Safe_Str  import Safe_Str
-from osbot_utils.utils.Misc                 import str_md5
+from osbot_utils.utils.Misc                 import bytes_md5
 
 # Constants for hash validation
 SIZE__VALUE_HASH           = 10
@@ -14,5 +15,11 @@ class Safe_Str__Hash(Safe_Str):
     strict_validation         = True                                    # Enable strict validation - new attribute
     exact_length              = True                                    # Require exact length match - new attribute
 
-def safe_str_hash(value : str):
-    return str_md5(value)[0:SIZE__VALUE_HASH]
+def safe_str_hash(value: Any) -> Safe_Str__Hash:
+    if isinstance(value, str):
+        value = value.encode()
+    elif not isinstance(value, bytes):
+        raise ValueError('In safe_str_hash, value must be a string or bytes')
+
+    hash_value = bytes_md5(value)[0:SIZE__VALUE_HASH]
+    return Safe_Str__Hash(hash_value)

{osbot_utils-2.64.0 → osbot_utils-2.66.0}/osbot_utils/helpers/sqlite/cache/Sqlite__DB__Requests.py

@@ -26,7 +26,7 @@ class Sqlite__DB__Requests(Sqlite__DB__Local):
         with self.table_requests() as _:
             _.row_schema = self.table_schema                    # set the table_class
             if _.exists() is False:
-                _.create()                                          # create if it doesn't exist
+                _.create()  # create if it doesn't exist
                 _.index_create('request_hash')                      # add index to the request_hash field
                 return True
         return False

{osbot_utils-2.64.0 → osbot_utils-2.66.0}/osbot_utils/type_safe/Type_Safe__Method.py

@@ -10,12 +10,13 @@ class Type_Safe__Method:
         self.func         = func                                                          # Store original function
         self.sig          = inspect.signature(func)                                       # Get function signature
         self.annotations  = func.__annotations__                                          # Get function annotations
+        self.params       = list(self.sig.parameters.keys())
 
     def check_for_any_use(self):
         for param_name, type_hint in self.annotations.items():
             if type_hint is any:  # Detect incorrect usage of lowercase any
                 raise ValueError(f"Parameter '{param_name}' uses lowercase 'any' instead of 'Any' from typing module. "
-                              f"Please use 'from typing import Any' and annotate as '{param_name}: Any'")
+                                f"Please use 'from typing import Any' and annotate as '{param_name}: Any'")
 
     def handle_type_safety(self, args: tuple, kwargs: dict):                              # Main method to handle type safety
         self.check_for_any_use()
@@ -80,10 +81,6 @@ class Type_Safe__Method:
             self.validate_union_type(param_name, param_value, expected_type)             # Validate union
             return                                                                       # Exit early
 
-        # if self.try_basic_type_conversion(param_value, expected_type, param_name,        # Try basic type conversion
-        #                                 bound_args):                                     # Pass bound args
-        #    return                                                                       # Exit if conversion successful
-
         self.validate_direct_type(param_name, param_value, expected_type)                # Direct type validation
 
     def is_optional_type(self, type_hint: Any) -> bool:                                  # Check if type is Optional
@@ -108,9 +105,13 @@ class Type_Safe__Method:
         if not isinstance(param_value, list):                                         # Check if value is a list
             raise ValueError(f"Parameter '{param_name}' expected a list but got {type(param_value)}")  # Raise error if not list
 
-        item_type = get_args(expected_type)[0]                                        # Get list item type
-        for i, item in enumerate(param_value):                                        # Check each list item
-            if not isinstance(item, item_type):                                       # Validate item type
+        item_type = get_args(expected_type)[0]                                          # Get list item type
+        if get_origin(item_type) is not None:                                           # Handle the case when item_type is a subscripted type (which is not supported at the moment)
+            raise NotImplementedError(f"Validation for list items with subscripted type"
+                                      f" '{item_type}' is not yet supported "
+                                      f"in parameter '{param_name}'.")                  # todo: add support for checking for subscripted types
+        for i, item in enumerate(param_value):                                          # Check each list item
+            if not isinstance(item, item_type):                                         # Validate item type
                 raise ValueError(f"List item at index {i} expected type {item_type}, but got {type(item)}")  # Raise error for invalid item
 
     def validate_type_parameter(self, param_name: str, param_value: Any, expected_type: Any):           # Validate a Type[T] parameter
@@ -163,6 +164,7 @@ class Type_Safe__Method:
             is_optional = self.is_optional_type(expected_type)                            # Check if type is optional
             has_default = self.has_default_value(param_name)                              # Check if has default value
             self.validate_none_value(param_name, is_optional, has_default)                # Validate None value
+            return True
 
         origin = get_origin(expected_type)
 
@@ -174,11 +176,20 @@ class Type_Safe__Method:
                 if not isinstance(param_value, dict):
                     raise ValueError(f"Parameter '{param_name}' expected dict but got {type(param_value)}")
                 key_type, value_type = get_args(expected_type)
+                if value_type is Any:                                                                       # if value type is Any, we don't need to do any checks since they will all match
+                    return True
                 for k, v in param_value.items():
-                    if not isinstance(k, key_type):
-                        raise ValueError(f"Dict key '{k}' expected type {key_type}, but got {type(k)}")
-                    if not isinstance(v, value_type):
-                        raise ValueError(f"Dict value for key '{k}' expected type {value_type}, but got {type(v)}")
+                    if get_origin(key_type) is None:
+                        if not isinstance(k, key_type):
+                            raise ValueError(f"Dict key '{k}' expected type {key_type}, but got {type(k)}")
+                    else:
+                        raise NotImplementedError(f"Validation for subscripted key type '{key_type}' not yet supported in parameter '{param_name}'")
+
+                    if get_origin(value_type) is None:
+                        if not isinstance(v, value_type):
+                            raise ValueError(f"Dict value for key '{k}' expected type {value_type}, but got {type(v)}")
+                    elif value_type is not Any:
+                        raise NotImplementedError(f"Validation for subscripted value type '{value_type}' not yet supported in parameter '{param_name}'")
                 return True
             base_type = origin
         else:

osbot_utils-2.66.0/osbot_utils/type_safe/decorators/type_safe.py

@@ -0,0 +1,22 @@
+import functools                                                                           # For wrapping functions
+from osbot_utils.type_safe.Type_Safe__Method import Type_Safe__Method
+
+def type_safe(func):                                                                        # Main decorator function
+    type_checker = Type_Safe__Method(func)  # Create type checker instance
+
+    has_only_self    = len(type_checker.params) == 1 and type_checker.params[0] == 'self'   # Check if method has only 'self' parameter or no parameters
+    has_no_params    = len(type_checker.params) == 0
+    direct_execution = has_no_params or has_only_self                                       # these are major performance optimisation where this @type_safe had an overhead of 250x (even on methods with no params) to now having an over head of ~5x
+    if direct_execution:                                                                    # todo: review if we really need to do this, since although it is an optimisation, the idea of the type_safe attribute is to check when there are params
+        return func
+
+    @functools.wraps(func)                                                                 # Preserve function metadata
+    def wrapper(*args, **kwargs):                                                          # Wrapper function
+        if direct_execution:
+            return func(*args, **kwargs)
+        else:
+            bound_args   = type_checker.handle_type_safety(args, kwargs)                       # Validate type safety
+            return func(**bound_args.arguments)                                                # Call original function
+
+    return wrapper                                                                         # Return wrapped function
+

osbot_utils-2.66.0/osbot_utils/version

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

{osbot_utils-2.64.0 → osbot_utils-2.66.0}/pyproject.toml

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

osbot_utils-2.64.0/osbot_utils/type_safe/decorators/type_safe.py

@@ -1,12 +0,0 @@
-import functools                                                                           # For wrapping functions
-from osbot_utils.type_safe.Type_Safe__Method import Type_Safe__Method
-
-def type_safe(func):                                                                       # Main decorator function
-    @functools.wraps(func)                                                                 # Preserve function metadata
-    def wrapper(*args, **kwargs):                                                          # Wrapper function
-        type_checker = Type_Safe__Method(func)                                              # Create type checker instance
-        bound_args   = type_checker.handle_type_safety(args, kwargs)                       # Validate type safety
-        return func(**bound_args.arguments)                                                # Call original function
-
-    return wrapper                                                                         # Return wrapped function
-

osbot_utils-2.64.0/osbot_utils/version

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