osbot-utils 2.12.0__py3-none-any.whl → 2.13.0__py3-none-any.whl

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/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/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__'):

osbot_utils/type_safe/steps/Type_Safe__Step__Class_Kwargs.py

@@ -1,4 +1,6 @@
 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
@@ -43,8 +45,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/version

@@ -1 +1 @@
-v2.12.0
+v2.13.0

{osbot_utils-2.12.0.dist-info → osbot_utils-2.13.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: osbot_utils
-Version: 2.12.0
+Version: 2.13.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.13.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.dist-info → osbot_utils-2.13.0.dist-info}/RECORD

@@ -40,6 +40,7 @@ osbot_utils/helpers/Guid.py,sha256=0Ay3TYYk2nPr-JRVRCMFxbr8OvoQomv5HjT7o5B7cos,8
 osbot_utils/helpers/Hashicorp_Secrets.py,sha256=e2fWWHK6bubpAm1sw5y8X5kh2Hk5d4JyZCnUovZip5A,4232
 osbot_utils/helpers/Local_Cache.py,sha256=0JZZX3fFImcwtbBvxAQl-EbBegSNJRhRMYF6ovTH6zY,3141
 osbot_utils/helpers/Local_Caches.py,sha256=aQmi1HSM0TH6WQPedG2fbz4KCCJ3DQTU9d18rB1jR0M,1885
+osbot_utils/helpers/Obj_Id.py,sha256=sdKlSmEUpie0kn9X4pnM0MjUr6sLu4WZLSNqsD8ynBg,926
 osbot_utils/helpers/Print_Table.py,sha256=LEXbyqGg_6WSraI4cob4bNNSu18ddqvALp1zGK7bPhs,19126
 osbot_utils/helpers/Python_Audit.py,sha256=shpZlluJwqJBAlad6xN01FkgC1TsQ48RLvR5ZjmrKa4,1539
 osbot_utils/helpers/Random_Guid.py,sha256=COu9hcP51vzjk-ErECTFFaOWuOmW0eGJyMu8HXhaRXQ,382
@@ -277,7 +278,7 @@ osbot_utils/testing/Temp_Zip_In_Memory.py,sha256=ibDIWt3K4CX558PbkLbX3InHyWYZcwQ
 osbot_utils/testing/Unit_Test.py,sha256=MReR_wDGbbXFDPz7cmuGflcTxRB6TBnO9mYqRpSq8Pk,1304
 osbot_utils/testing/Unzip_File.py,sha256=V5H97XO9rlvG5EYOSzAH4kTtAH1ohZ8R8ImvJh46ZNg,1177
 osbot_utils/testing/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-osbot_utils/testing/performance/Performance_Measure__Session.py,sha256=K0VHbA97IW_rvBrL2Fg_JuEXLTpPQUnoS2N8ftvwClI,7585
+osbot_utils/testing/performance/Performance_Measure__Session.py,sha256=_Nq9oVilWaFn-tjvakCw7ojYVzRas9XmQY66DJT1clk,9108
 osbot_utils/testing/performance/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 osbot_utils/testing/performance/models/Model__Performance_Measure__Measurement.py,sha256=xT_uKzbSYo9AGiJgNmCHSt3ApneNNyKh8vsMVN6IJQ0,1127
 osbot_utils/testing/performance/models/Model__Performance_Measure__Result.py,sha256=k9HJYNLmW6sjRVsfpduSxHFiVANc1zmYtO_Oz9azpW8,755
@@ -294,13 +295,13 @@ osbot_utils/type_safe/methods/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5N
 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
 osbot_utils/type_safe/shared/Type_Safe__Cache.py,sha256=G03pmpds9sTwU5z5pNLssD_GTvVSIR11nGYbkV5KaiY,7913
-osbot_utils/type_safe/shared/Type_Safe__Convert.py,sha256=UD8AJ7f_u9wtj_PsNQsbIN-7E93Y-FWMBwalL0GS5Dk,2945
+osbot_utils/type_safe/shared/Type_Safe__Convert.py,sha256=QtO6gEGjQ5EKJOE3bsy4EiVmUGmFbMnMHxZUJh18k2s,3015
 osbot_utils/type_safe/shared/Type_Safe__Not_Cached.py,sha256=25FAl6SOLxdStco_rm9tgOYLfuKyBWheGdl7vVa56UU,800
 osbot_utils/type_safe/shared/Type_Safe__Raise_Exception.py,sha256=pbru8k8CTQMNUfmFBndiJhg2KkqEYzFvJAPcNZHeHfQ,829
 osbot_utils/type_safe/shared/Type_Safe__Shared__Variables.py,sha256=SuZGl9LryQX6IpOE0I_lbzClT-h17UNylC__-M8ltTY,129
 osbot_utils/type_safe/shared/Type_Safe__Validation.py,sha256=h-PwDpJ6SX8y1b7VIXB0rCY3p2nJRpeNBAvJRO8xJQQ,15960
 osbot_utils/type_safe/shared/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-osbot_utils/type_safe/steps/Type_Safe__Step__Class_Kwargs.py,sha256=CkNG5Du371iLAOF6530mDDmB76_X5bnn491WmrJiU7s,6718
+osbot_utils/type_safe/steps/Type_Safe__Step__Class_Kwargs.py,sha256=bDA2hcOYsmcYwFDwNCvj5GTrLGqU78DhWtrrvDEQ2hE,6987
 osbot_utils/type_safe/steps/Type_Safe__Step__Default_Kwargs.py,sha256=tzKXDUc0HVP5QvCWsmcPuuZodNvQZ9FeMDNI2x00Ngw,1943
 osbot_utils/type_safe/steps/Type_Safe__Step__Default_Value.py,sha256=48-kGfkPZvhjBIEfFumigUIWWGxXe6skHgFtCCGa0LY,3987
 osbot_utils/type_safe/steps/Type_Safe__Step__From_Json.py,sha256=vVi98VZ4Xz82Lp10SIBxSgqWuF4FM3EzrbQORMg_WWc,9347
@@ -339,8 +340,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=MFXhWZL8_JkMlndph2KksILPI_Zq4suh5Uisl0yktF4,8
-osbot_utils-2.12.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-osbot_utils-2.12.0.dist-info/METADATA,sha256=4AFU-DvJp1afxjfz5Wc-xwumNpekJw5l6GKaJIXKf4c,1329
-osbot_utils-2.12.0.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-osbot_utils-2.12.0.dist-info/RECORD,,
+osbot_utils/version,sha256=YGrSykHz7B3et_Lt-lk1a1Wwox5GwG1-AyQ7FOE7dfw,8
+osbot_utils-2.13.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+osbot_utils-2.13.0.dist-info/METADATA,sha256=vcJ_Y_Ij0NGdMApJS1oNxQnUq-fnaheoTLJoE-U-Nes,1329
+osbot_utils-2.13.0.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+osbot_utils-2.13.0.dist-info/RECORD,,