osbot-utils 2.12.0__tar.gz → 2.14.0__tar.gz

{osbot_utils-2.12.0 → osbot_utils-2.14.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: osbot_utils
-Version: 2.12.0
+Version: 2.14.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.12.0-blue)
+![Current Release](https://img.shields.io/badge/release-v2.14.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.12.0 → osbot_utils-2.14.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.12.0-blue)
+![Current Release](https://img.shields.io/badge/release-v2.14.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.14.0/osbot_utils/helpers/Obj_Id.py

@@ -0,0 +1,29 @@
+import random
+
+_hex_table = [f"{i:02x}" for i in range(256)]
+
+def is_obj_id(value: str):
+    var_type = type(value)
+    if var_type is Obj_Id:
+        return True
+    if var_type is str:
+        if len(value) == 8:         # todo: add efficient check if we only have hex values
+            return True
+    return False
+
+def new_obj_id():
+    return hex(random.getrandbits(32))[2:].zfill(8)  # slice off '0x' and pad
+
+class Obj_Id(str):
+    def __new__(cls, value: str=None):
+        if value:
+            if is_obj_id(value):
+                obj_id = value
+            else:
+                raise ValueError(f'in Obj_Id: value provided was not a valid Obj_Id: {value}')
+        else:
+            obj_id = new_obj_id()
+        return super().__new__(cls, obj_id)                                          # Return a new instance of Guid initialized with the string version of the UUID
+
+    def __str__(self):
+        return self

{osbot_utils-2.12.0 → osbot_utils-2.14.0}/osbot_utils/testing/performance/Performance_Measure__Session.py

@@ -11,6 +11,7 @@ MEASURE__INVOCATION__LOOPS = [1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, 233, 377,
 class Performance_Measure__Session(Type_Safe):
     result        : Model__Performance_Measure__Result = None                                          # Current measurement result
     assert_enabled: bool = True
+    padding       : int  = 30
 
     def calculate_raw_score(self, times: List[int]) -> int:                                     # Calculate raw performance score
         if len(times) < 3:                                                                      # Need at least 3 values for stability
@@ -89,11 +90,11 @@ class Performance_Measure__Session(Type_Safe):
         print(f"Median  : {measurement.median_time:,}ns")
         print(f"StdDev  : {measurement.stddev_time:,.2f}ns")
 
-    def print(self, padding=12 ):                                                # Print measurement results
+    def print(self):                                                # Print measurement results
         if not self.result:
             print("No measurements taken yet")
             return
-        print(f"{self.result.name:{padding}} | score: {self.result.final_score:7,d} ns  | raw: {self.result.raw_score:7,d} ns")          # Print name and normalized score
+        print(f"{self.result.name:{self.padding}} | score: {self.result.final_score:7,d} ns  | raw: {self.result.raw_score:7,d} ns")          # Print name and normalized score
 
         return self
 
@@ -105,4 +106,23 @@ class Performance_Measure__Session(Type_Safe):
             new_expected_time   = last_expected_time * 5                                    # using last_expected_time * 5 as the upper limit (since these tests are significantly slowed in GitHUb Actions)
             assert last_expected_time <=  self.result.final_score <= new_expected_time, f"Performance changed for {self.result.name}: expected {last_expected_time} < {self.result.final_score:,d}ns, expected {new_expected_time}"
         else:
-            assert self.result.final_score in expected_time,  f"Performance changed for {self.result.name}: got {self.result.final_score:,d}ns, expected {expected_time}"
+            assert self.result.final_score in expected_time,  f"Performance changed for {self.result.name}: got {self.result.final_score:,d}ns, expected {expected_time}"
+
+    def assert_time(self, *expected_time: int):                                              # Assert that the final score matches the expected normalized time"""
+        if self.assert_enabled is False:
+            return
+        if in_github_action():
+            last_expected_time = expected_time[-1] + 100                                    # +100 in case it is 0
+            new_expected_time   = last_expected_time * 5                                    # using last_expected_time * 5 as the upper limit (since these tests are significantly slowed in GitHUb Actions)
+            assert last_expected_time <=  self.result.final_score <= new_expected_time, f"Performance changed for {self.result.name}: expected {last_expected_time} < {self.result.final_score:,d}ns, expected {new_expected_time}"
+        else:
+            assert self.result.final_score in expected_time,  f"Performance changed for {self.result.name}: got {self.result.final_score:,d}ns, expected {expected_time}"
+
+    def assert_time__less_than(self, max_time: int):                                              # Assert that the final score matches the expected normalized time"""
+        if self.assert_enabled is False:
+            return
+        if in_github_action():
+            max_time   = max_time * 5               # adjust for GitHub's slowness
+
+        assert self.result.final_score <= max_time,  f"Performance changed for {self.result.name}: got {self.result.final_score:,d}ns, expected less than {max_time}ns"
+

{osbot_utils-2.12.0 → osbot_utils-2.14.0}/osbot_utils/type_safe/shared/Type_Safe__Convert.py

@@ -20,8 +20,9 @@ class Type_Safe__Convert:
         from osbot_utils.helpers.Random_Guid    import Random_Guid
         from osbot_utils.helpers.Safe_Id        import Safe_Id
         from osbot_utils.helpers.Str_ASCII      import Str_ASCII
+        from osbot_utils.helpers.Obj_Id         import Obj_Id
 
-        TYPE_SAFE__CONVERT_VALUE__SUPPORTED_TYPES = [Guid, Random_Guid, Safe_Id, Str_ASCII, Timestamp_Now]
+        TYPE_SAFE__CONVERT_VALUE__SUPPORTED_TYPES = [Guid, Random_Guid, Safe_Id, Str_ASCII, Timestamp_Now, Obj_Id]
 
         if target is not None and attr_name is not None:
             if hasattr(target, '__annotations__'):
@@ -31,16 +32,17 @@ class Type_Safe__Convert:
                     if attribute_annotation:
                         origin = type_safe_cache.get_origin(attribute_annotation)                               # Add handling for Type[T] annotations
                         if origin is type and isinstance(value, str):
-                            try:                                                                # Convert string path to actual type
-                                if len(value.rsplit('.', 1)) > 1:
-                                    module_name, class_name = value.rsplit('.', 1)
-                                    module = __import__(module_name, fromlist=[class_name])
-                                    return getattr(module, class_name)
-                            except (ValueError, ImportError, AttributeError) as e:
-                                raise ValueError(f"Could not convert '{value}' to type: {str(e)}")
-
+                            return self.get_class_from_class_name(value)
                         if attribute_annotation in TYPE_SAFE__CONVERT_VALUE__SUPPORTED_TYPES:          # for now hard-coding this to just these types until we understand the side effects
                             return attribute_annotation(value)
         return value
 
+    def get_class_from_class_name(self, value):
+        try:                                                                # Convert string path to actual type
+            if len(value.rsplit('.', 1)) > 1:
+                module_name, class_name = value.rsplit('.', 1)
+                module = __import__(module_name, fromlist=[class_name])
+                return getattr(module, class_name)
+        except (ValueError, ImportError, AttributeError) as e:
+            raise ValueError(f"Could not convert '{value}' to type: {str(e)}")
 type_safe_convert = Type_Safe__Convert()

{osbot_utils-2.12.0 → osbot_utils-2.14.0}/osbot_utils/type_safe/shared/Type_Safe__Validation.py

@@ -228,7 +228,10 @@ class Type_Safe__Validation:
 
         if is_invalid:
             expected_type = annotations.get(name)
-            actual_type = type(value)
+            if type(value) is type:
+                actual_type = value
+            else:
+                actual_type = type(value)
             raise ValueError(f"Invalid type for attribute '{name}'. Expected '{expected_type}' but got '{actual_type}'")
 
     # todo: see if need to add cache support to this method     (it looks like this method is not called very often)

{osbot_utils-2.12.0 → osbot_utils-2.14.0}/osbot_utils/type_safe/steps/Type_Safe__Step__Class_Kwargs.py

@@ -1,9 +1,10 @@
-from typing                                                          import Dict, Any, Type
-from osbot_utils.helpers.Random_Guid                                 import Random_Guid
-from osbot_utils.type_safe.shared.Type_Safe__Cache                   import Type_Safe__Cache, type_safe_cache
-from osbot_utils.type_safe.shared.Type_Safe__Shared__Variables       import IMMUTABLE_TYPES
-from osbot_utils.type_safe.shared.Type_Safe__Validation              import type_safe_validation
-from osbot_utils.type_safe.steps.Type_Safe__Step__Default_Value      import type_safe_step_default_value
+from typing                                                      import Dict, Any, Type
+from osbot_utils.helpers.Obj_Id                                  import Obj_Id
+from osbot_utils.helpers.Random_Guid                             import Random_Guid
+from osbot_utils.type_safe.shared.Type_Safe__Cache               import Type_Safe__Cache, type_safe_cache
+from osbot_utils.type_safe.shared.Type_Safe__Shared__Variables   import IMMUTABLE_TYPES
+from osbot_utils.type_safe.shared.Type_Safe__Validation          import type_safe_validation
+from osbot_utils.type_safe.steps.Type_Safe__Step__Default_Value  import type_safe_step_default_value
 
 
 
@@ -43,8 +44,10 @@ class Type_Safe__Step__Class_Kwargs:
         match      = all(isinstance(value, IMMUTABLE_TYPES) for value in kwargs.values())
 
         if match:                                                                       # check for special cases that we can't cache (like Random_Guid)
-            if Random_Guid in list(dict(annotations).values()):                         # todo: need to add the other special cases (like Timestamp_Now)
-
+            annotations_types = list(dict(annotations).values())
+            if Random_Guid in annotations_types:                         # todo: need to add the other special cases (like Timestamp_Now)
+                return False
+            if Obj_Id in annotations_types:                             # we can't cache Obj_id, since this would give us the same ID everutime
                 return False
         return match
 

{osbot_utils-2.12.0 → osbot_utils-2.14.0}/osbot_utils/type_safe/steps/Type_Safe__Step__From_Json.py

@@ -8,6 +8,7 @@ from osbot_utils.helpers.Random_Guid                     import Random_Guid
 from osbot_utils.helpers.Random_Guid_Short               import Random_Guid_Short
 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__Convert import type_safe_convert
 from osbot_utils.utils.Objects                           import enum_from_value
 from osbot_utils.helpers.Safe_Id                         import Safe_Id
 from osbot_utils.helpers.Timestamp_Now                   import Timestamp_Now
@@ -43,7 +44,13 @@ class Type_Safe__Step__From_Json:
                             raise ValueError(f"Attribute '{key}' not found in '{_self.__class__.__name__}'")
                         else:
                             continue
-                    if type_safe_annotations.obj_attribute_annotation(_self, key) == type:                                         # Handle type objects
+                    annotation        = type_safe_annotations.obj_attribute_annotation(_self, key)
+                    annotation_origin = type_safe_cache.get_origin(annotation)
+
+
+                    if annotation == type:                                                  # Handle type objects
+                        value = self.deserialize_type__using_value(value)
+                    elif annotation_origin == type:                                         # Handle type objects inside ForwardRef
                         value = self.deserialize_type__using_value(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)
@@ -117,6 +124,9 @@ class Type_Safe__Step__From_Json:
             if type(dict_value) == value_class:                                        # if the value is already the target, then just use it
                 new__dict_value = dict_value
             elif issubclass(value_class, Type_Safe):
+                if 'node_type' in dict_value:
+                    value_class = type_safe_convert.get_class_from_class_name(dict_value['node_type'])
+
                 new__dict_value = self.deserialize_from_dict(value_class(), dict_value)
             elif value_class is Any:
                 new__dict_value = dict_value

osbot_utils-2.14.0/osbot_utils/version

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

{osbot_utils-2.12.0 → osbot_utils-2.14.0}/pyproject.toml

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

osbot_utils-2.12.0/osbot_utils/version

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