osbot-utils 2.64.0__py3-none-any.whl → 2.66.0__py3-none-any.whl

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/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/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/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/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/type_safe/decorators/type_safe.py

@@ -1,12 +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
+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
-        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
+        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/version

@@ -1 +1 @@
-v2.64.0
+v2.66.0

{osbot_utils-2.64.0.dist-info → osbot_utils-2.66.0.dist-info}/METADATA

@@ -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.dist-info → osbot_utils-2.66.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 osbot_utils/__init__.py,sha256=DdJDmQc9zbQUlPVyTJOww6Ixrn9n4bD3ami5ItQfzJI,16
 osbot_utils/base_classes/Cache_Pickle.py,sha256=kPCwrgUbf_dEdxUz7vW1GuvIPwlNXxuRhb-H3AbSpII,5884
-osbot_utils/base_classes/Kwargs_To_Disk.py,sha256=HHoy05NC_w35WcT-OnSKoSIV_cLqaU9rdjH0_KNTM0E,1096
+osbot_utils/base_classes/Kwargs_To_Disk.py,sha256=jrm_L3xgh7bfKmDyxCcUJ9-DLzZ6n6YZlmCtHqmd0aY,1087
 osbot_utils/base_classes/Kwargs_To_Self.py,sha256=3LRFpxdg9RBuUlIacF1Bwq014NXtJmB4U2dy9a69uY8,138
 osbot_utils/base_classes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 osbot_utils/context_managers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -234,7 +234,7 @@ osbot_utils/helpers/pubsub/Event__Queue.py,sha256=bCtIdVlAuG-jvFEnz14oNhgRScEUrd
 osbot_utils/helpers/pubsub/PubSub__Client.py,sha256=6K3l4H-Tc0DhktrxpYzLVur1uZ532pQsHWprLNRXFJE,2316
 osbot_utils/helpers/pubsub/PubSub__Room.py,sha256=3drJIAVSAzXB_0Q9dXxwhYWxNaEUaMiWiXLY9Mh02DM,481
 osbot_utils/helpers/pubsub/PubSub__Server.py,sha256=DjQ6PsNGmULdFodspdNktADcoIN3FbdvAitE52m89-w,3548
-osbot_utils/helpers/pubsub/PubSub__Sqlite.py,sha256=3u1Gbpq22JDgDEexdyMzGvkQAHe97l8_Kuhr_SHFAR8,868
+osbot_utils/helpers/pubsub/PubSub__Sqlite.py,sha256=BXDZEz0r7NO1PLt8Y7Wa6Yok0iKNp5bnegCMxm_2xMg,848
 osbot_utils/helpers/pubsub/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 osbot_utils/helpers/pubsub/schemas/Schema__Event.py,sha256=si12mqRRROI3HYGvjQvzPZ_NGw3TpmVZxGhzuWq5cus,402
 osbot_utils/helpers/pubsub/schemas/Schema__Event__Connect.py,sha256=fgq0G3_zx3UFk5knsotmEXvP1YvZwOLBtT9gow1U-qM,269
@@ -262,7 +262,7 @@ osbot_utils/helpers/safe_int/__init__.py,sha256=kMU2WMsdQmayBEZugxnJV_wRW3O90bc1
 osbot_utils/helpers/safe_str/Safe_Str.py,sha256=qR2RDh5cehP_wDDeV5TQahNBwmfcizPFyStALBKD5dw,3509
 osbot_utils/helpers/safe_str/Safe_Str__File__Name.py,sha256=ncjkQ2hAhw0a3UulrCuQsA9ytrFwg5CT1XRJIGChMpY,289
 osbot_utils/helpers/safe_str/Safe_Str__File__Path.py,sha256=K0yBcvH_Ncqiw7tMqjGqaNyWQh1Zs9qxZ-TR8nEIAow,550
-osbot_utils/helpers/safe_str/Safe_Str__Hash.py,sha256=Tb2QeVpVDNWpCJGHNFjZPCQ_ZTaI7Z5BDzi19LiO_cI,952
+osbot_utils/helpers/safe_str/Safe_Str__Hash.py,sha256=IpYdYwXey5WZWa6QfysmsiDP-4L-wP-_EKbkeXhFRH4,1252
 osbot_utils/helpers/safe_str/Safe_Str__Text.py,sha256=QxuWqF8hNYdOPDn3Yac86h_1ZaX-THbTBDakberiJcs,313
 osbot_utils/helpers/safe_str/Safe_Str__Text__Dangerous.py,sha256=6-fkXBuWgjz70eQicD07f38eEuKqNzJzaFFY6hozhNQ,388
 osbot_utils/helpers/safe_str/Safe_Str__Url.py,sha256=4l46AAe5Dy_P_W6d-_3pwtXuehG_Wczq1dC5sOOzg_g,549
@@ -288,7 +288,7 @@ osbot_utils/helpers/sqlite/cache/Sqlite__Cache__Requests.py,sha256=SC-NBsj-wsAcv
 osbot_utils/helpers/sqlite/cache/Sqlite__Cache__Requests__Patch.py,sha256=HB-LbZQ0VHi9cJm0647WJKUZIjesMppKQ3ZbTOsMgCI,2474
 osbot_utils/helpers/sqlite/cache/Sqlite__Cache__Requests__Sqlite.py,sha256=vaijPsoQU2_2uQEBa_ukeA6o-EhJkn2KmhKJ3_hse3o,779
 osbot_utils/helpers/sqlite/cache/Sqlite__Cache__Requests__Table.py,sha256=77uO-8WLmzBh5A4Y2VVclKlp2kn1aZ6iJVCtOr4zYFo,2830
-osbot_utils/helpers/sqlite/cache/Sqlite__DB__Requests.py,sha256=CWB-hTcgly2T_7HOZM5gUgfdsvgMus5nX2M_wpjVLZs,1643
+osbot_utils/helpers/sqlite/cache/Sqlite__DB__Requests.py,sha256=VWprEbbSWTy5VPBe0XVHdZ3yD9-Zlb-344-QfzDD_wA,1603
 osbot_utils/helpers/sqlite/cache/TestCase__Sqlite__Cache__Requests.py,sha256=TLUdQC6vsf5BcDP15CCeoYkipVG30bzqFcqEJpH4dWg,1645
 osbot_utils/helpers/sqlite/cache/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 osbot_utils/helpers/sqlite/domains/Sqlite__DB.py,sha256=xyXnt4-GLYqMEPBZrNPI0dZnkl61KwLEIuYjebO20Jc,1210
@@ -374,13 +374,13 @@ osbot_utils/type_safe/Type_Safe.py,sha256=LOWRGOGpnRU2iTRLP47vUoyalK0vjFrWlnaghB
 osbot_utils/type_safe/Type_Safe__Base.py,sha256=UTMipTL6mXoetAEUCI5hs8RqXp4NDYOvoAiYoFOt5jg,8807
 osbot_utils/type_safe/Type_Safe__Dict.py,sha256=QB200L5eNWT3FnUv8sm5kncj1wXJsJ9uRycNFl9xb6Y,3077
 osbot_utils/type_safe/Type_Safe__List.py,sha256=y_lp7Ai0HfQCqC8Bxn0g6_M9MP5lPOXy5Dhkuj2fJvQ,1891
-osbot_utils/type_safe/Type_Safe__Method.py,sha256=lHBCpW5nf2ikybm9oucvq6L67VXNO4qEvzGskJ1hGHs,15697
+osbot_utils/type_safe/Type_Safe__Method.py,sha256=cvFYoR42SPU4qQPG45CCHQw7i-sq7R6gHECcsncGGL4,16653
 osbot_utils/type_safe/Type_Safe__Primitive.py,sha256=CJ4LP2W5i9utSSzuiiJrwqvwdMv1DeQ6dIZICtYfLTY,3635
 osbot_utils/type_safe/Type_Safe__Set.py,sha256=j12fc8cbd9-s_a13ysaz723rNEW4Dt6hObCd0S-AjIg,1432
 osbot_utils/type_safe/Type_Safe__Tuple.py,sha256=Kx7C4YfHybRbMmVMcmV6yFLi4T48pb592vEZfjjyLxo,1710
 osbot_utils/type_safe/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 osbot_utils/type_safe/decorators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-osbot_utils/type_safe/decorators/type_safe.py,sha256=ERFfJuAIo5qLp03YEDu2zu5wxu65OhR7hOybwuTfLlc,1006
+osbot_utils/type_safe/decorators/type_safe.py,sha256=3jVwrO46s6xpS1Uc4gTrbWc2TnrHCfWJUZ8FIS8mwEo,1772
 osbot_utils/type_safe/methods/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 osbot_utils/type_safe/methods/type_safe_property.py,sha256=DcJkOIs6swJtkglsZVKLyFSczCGSJISOVwAmvjCOQvo,1425
 osbot_utils/type_safe/shared/Type_Safe__Annotations.py,sha256=nmVqCbhk4kUYrw_mdYqugxQlv4gM3NUUH89FYTHUg-c,1133
@@ -432,8 +432,8 @@ osbot_utils/utils/Toml.py,sha256=Rxl8gx7mni5CvBAK-Ai02EKw-GwtJdd3yeHT2kMloik,166
 osbot_utils/utils/Version.py,sha256=Ww6ChwTxqp1QAcxOnztkTicShlcx6fbNsWX5xausHrg,422
 osbot_utils/utils/Zip.py,sha256=pR6sKliUY0KZXmqNzKY2frfW-YVQEVbLKiyqQX_lc-8,14052
 osbot_utils/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-osbot_utils/version,sha256=Ik_Z1_68qStKaUrjNMdT-_2K34-svwqhzWn_iKWEiAM,8
-osbot_utils-2.64.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-osbot_utils-2.64.0.dist-info/METADATA,sha256=NVqO8V4OXl0l6YXdNQCbsspZ4wle5_jgH97qimTST9M,1329
-osbot_utils-2.64.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-osbot_utils-2.64.0.dist-info/RECORD,,
+osbot_utils/version,sha256=I-tXq-4G9hvb1JqQfc9x8xB8ZmzgFoAtCtq_ER_YmZE,8
+osbot_utils-2.66.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+osbot_utils-2.66.0.dist-info/METADATA,sha256=00ICakDJcjSd_dw6IXnHIY4Uvc3o_kVtbfV0Z25XN54,1329
+osbot_utils-2.66.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+osbot_utils-2.66.0.dist-info/RECORD,,