osbot-utils 1.86.0__py3-none-any.whl → 1.88.0__py3-none-any.whl

osbot_utils/helpers/Guid.py

@@ -0,0 +1,18 @@
+import uuid
+
+from osbot_utils.utils.Misc import is_guid
+
+GUID__NAMESPACE = uuid.UUID('2cfec064-537a-4ff7-8fdc-2fc9e2606f3d')
+
+class Guid(str):
+    def __new__(cls, value: str):
+        if not isinstance(value, str):                                                  # Check if the value is a string
+            raise ValueError(f'in Guid: value provided was not a string: {value}')      # if not raise a ValueError
+        if is_guid(value):
+            guid = value
+        else:
+            guid = uuid.uuid5(GUID__NAMESPACE, value)                                       # Generate a UUID5 using the namespace and value
+        return super().__new__(cls, str(guid))                                          # Return a new instance of Guid initialized with the string version of the UUID
+
+    def __str__(self):
+        return self

osbot_utils/helpers/Random_Guid.py

@@ -11,4 +11,4 @@ class Random_Guid(str):
         raise ValueError(f'in Random_Guid: value provided was not a Guid: {value}')
 
     def __str__(self):
-        return self
+        return self

osbot_utils/helpers/Safe_Id.py

@@ -2,10 +2,10 @@ from osbot_utils.utils.Misc import random_id_short
 from osbot_utils.utils.Str  import safe_id
 
 class Safe_Id(str):
-    def __new__(cls, value=None):
+    def __new__(cls, value=None, max_length=36):
         if value is None:
             value = safe_id(random_id_short('safe-id'))
-        sanitized_value = safe_id(value)
+        sanitized_value = safe_id(value, max_length=max_length)
         return str.__new__(cls, sanitized_value)
 
     def __str__(self):

osbot_utils/helpers/Str_ASCII.py

@@ -0,0 +1,22 @@
+import re
+
+REGEX__ASCII_VALUE = re.compile(r'[^a-zA-Z0-9_\s!@#$%^&*()\[\]{}\-+=:;,.?]')
+
+class Str_ASCII(str):
+    """
+    A string subclass that ensures values only contain safe ASCII characters.
+    Replaces any unsafe characters with underscores.
+    """
+    def __new__(cls, value=None, max_length=None):
+        if value is None:
+            value = ""
+
+        if not isinstance(value, str):
+            value = str(value)
+
+        if max_length and len(value) > max_length:
+            raise ValueError(f"Value length exceeds maximum of {max_length} characters (was {len(value)})")
+
+        sanitized_value = REGEX__ASCII_VALUE.sub('_', value)
+
+        return super().__new__(cls, sanitized_value)

osbot_utils/utils/Misc.py

@@ -178,7 +178,6 @@ def is_guid(value):
     except Exception:
         return False
 
-
 def ignore_warning__unclosed_ssl():
     import warnings
     warnings.filterwarnings("ignore", category=ResourceWarning, message="unclosed.*<ssl.SSLSocket.*>")

osbot_utils/utils/Objects.py

@@ -109,11 +109,13 @@ def convert_dict_to_value_from_obj_annotation(target, attr_name, value):
 
 def convert_to_value_from_obj_annotation(target, attr_name, value):                             # todo: see the side effects of doing this for all ints and floats
 
-    from osbot_utils.helpers.Safe_Id        import Safe_Id
+    from osbot_utils.helpers.Guid           import Guid
     from osbot_utils.helpers.Timestamp_Now  import Timestamp_Now
     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
 
-    TYPE_SAFE__CONVERT_VALUE__SUPPORTED_TYPES = [Safe_Id, Random_Guid, Timestamp_Now]
+    TYPE_SAFE__CONVERT_VALUE__SUPPORTED_TYPES = [Guid, Random_Guid, Safe_Id, Str_ASCII, Timestamp_Now]
 
     if target is not None and attr_name is not None:
         if hasattr(target, '__annotations__'):
@@ -437,6 +439,7 @@ json_to_obj         = str_to_obj
 
 full_type_name      = class_full_name
 
+obj                 = dict_to_obj
 obj_list_set        = obj_keys
 obj_info            = print_object_members
 obj_methods         = print_object_methods

osbot_utils/utils/Str.py

@@ -34,14 +34,14 @@ def strip_quotes(value: str):                           # Remove surrounding quo
         return value[1:-1]
     return value
 
-def safe_id(value):
+def safe_id(value, max_length=36):
     if value is None or value == "":
         raise ValueError("Invalid ID: The ID must not be empty.")
 
     if not isinstance(value, str):
         value = str(value)
 
-    if len(value) > 36:
+    if len(value) > max_length:
         raise ValueError(f"Invalid ID: The ID must not exceed 36 characters (was {len(value)}).")
 
     sanitized_value = REGEX__SAFE_ID_REGEX.sub('_', value)

osbot_utils/version

@@ -1 +1 @@
-v1.86.0
+v1.88.0

{osbot_utils-1.86.0.dist-info → osbot_utils-1.88.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: osbot_utils
-Version: 1.86.0
+Version: 1.88.0
 Summary: OWASP Security Bot - Utils
 Home-page: https://github.com/owasp-sbot/OSBot-Utils
 License: MIT
@@ -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-v1.86.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.88.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-1.86.0.dist-info → osbot_utils-1.88.0.dist-info}/RECORD

@@ -61,15 +61,17 @@ osbot_utils/helpers/CFormat.py,sha256=1_XvqGwgU6qC97MbzcKF0o7s9mCXpU5Kq9Yf-1ixUw
 osbot_utils/helpers/CPrint.py,sha256=ztKPNmT8BGxeyPXSQKRs63PqqbgxKDz_BiZmzFMup9g,1413
 osbot_utils/helpers/Dependency_Manager.py,sha256=79YRYnVfchewq8iSMJ5dzwW2D5u8chWcIqYE-G9YrSo,1337
 osbot_utils/helpers/Dict_To_Attr.py,sha256=NdhXl5mJH7-NaBk213amzc5Nfy3tJgW-N_uYIRE4hoc,208
+osbot_utils/helpers/Guid.py,sha256=22oNPpugnzOkc7swHzw6_duc3PyzXQg5f5mnBXLC-Jw,832
 osbot_utils/helpers/Hashicorp_Secrets.py,sha256=zjXa_dQvfR9L1uoulWJ8nYYaDvznV6o_QPPS4zmb6mo,4235
 osbot_utils/helpers/Local_Cache.py,sha256=0JZZX3fFImcwtbBvxAQl-EbBegSNJRhRMYF6ovTH6zY,3141
 osbot_utils/helpers/Local_Caches.py,sha256=aQmi1HSM0TH6WQPedG2fbz4KCCJ3DQTU9d18rB1jR0M,1885
 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=GBh3lQ854c0_DICRJE8dDRNH81DiO8F6bxNu0YkzUrU,383
+osbot_utils/helpers/Random_Guid.py,sha256=COu9hcP51vzjk-ErECTFFaOWuOmW0eGJyMu8HXhaRXQ,382
 osbot_utils/helpers/Random_Guid_Short.py,sha256=YP_k5OLuYvXWGU2OEnQHk_OGViBQofTWKm3pUdQaJao,404
 osbot_utils/helpers/Random_Seed.py,sha256=14btja8LDN9cMGWaz4fCNcMRU_eyx49gas-_PQvHgy4,634
-osbot_utils/helpers/Safe_Id.py,sha256=JbpBWF57Inoq8MgSx1NUy_fjQdpXDjYEp00_MrS5yjs,364
+osbot_utils/helpers/Safe_Id.py,sha256=iwIrWXfSARyr6JkihNhh1soOdjeCGVf3wkXSkSP8zDw,402
+osbot_utils/helpers/Str_ASCII.py,sha256=PRqyu449XnKrLn6b9Miii1Hv-GO5OAa1UhhgvlRcC2M,704
 osbot_utils/helpers/Timestamp_Now.py,sha256=k3-SUGYx2jLTXvgZYeECqPRJhVxqWPmW7co1l6r12jk,438
 osbot_utils/helpers/Type_Registry.py,sha256=Ajk3SyMSKDi2g9SJYUtTgg7PZkAgydaHcpbGuEN3S94,311
 osbot_utils/helpers/Type_Safe_Method.py,sha256=8E88of__An9_ZhJKz6Kp22C1mb9WLED0jWNLOII3fJs,10489
@@ -300,21 +302,21 @@ osbot_utils/utils/Int.py,sha256=PmlUdU4lSwf4gJdmTVdqclulkEp7KPCVUDO6AcISMF4,116
 osbot_utils/utils/Json.py,sha256=0DZGlCU7Nqte5n0r7ctPXFybqA5MRfSrTz5zuK_6UFk,7095
 osbot_utils/utils/Json_Cache.py,sha256=mLPkkDZN-3ZVJiDvV1KBJXILtKkTZ4OepzOsDoBPhWg,2006
 osbot_utils/utils/Lists.py,sha256=tPz5x5s3sRO97WZ_nsxREBPC5cwaHrhgaYBhsrffTT8,5599
-osbot_utils/utils/Misc.py,sha256=VT-utruCLnZNER5-gYhoGjqe3t-H57SuXcShsJnUSaM,17364
-osbot_utils/utils/Objects.py,sha256=hanzmc1WR8i3I3btE4uAM0vWTGnnjwEKABbBXdqSeT8,19449
+osbot_utils/utils/Misc.py,sha256=H_xexJgiTxB3jDeDiW8efGQbO0Zuy8MM0iQ7qXC92JI,17363
+osbot_utils/utils/Objects.py,sha256=iuNNp_u9aOiHtAXwkSo-8FikXWcqZczaZqNwHKKQEcM,19617
 osbot_utils/utils/Png.py,sha256=V1juGp6wkpPigMJ8HcxrPDIP4bSwu51oNkLI8YqP76Y,1172
 osbot_utils/utils/Process.py,sha256=lr3CTiEkN3EiBx3ZmzYmTKlQoPdkgZBRjPulMxG-zdo,2357
 osbot_utils/utils/Python_Logger.py,sha256=tx8N6wRKL3RDHboDRKZn8SirSJdSAE9cACyJkxrThZ8,12792
 osbot_utils/utils/Regex.py,sha256=0ubgp8HKsS3PNe2H6XlzMIcUuV7jhga3VkQVDNOJWuA,866
 osbot_utils/utils/Status.py,sha256=Yq4s0TelXgn0i2QjCP9V8mP30GabXp_UL-jjM6Iwiw4,4305
-osbot_utils/utils/Str.py,sha256=pHcPE3xZ0aBz35aXIW2hdA5WN6vhRqsNT8A-7MNNIY0,3252
+osbot_utils/utils/Str.py,sha256=Y05F46m6s3_H7KoPdeasc1LRaU7R4YifIbsHNQYDEeg,3275
 osbot_utils/utils/Threads.py,sha256=lnh4doZWYUIoWBZRU_780QPeAIKGDh7INuqmU8Fzmdc,3042
 osbot_utils/utils/Toml.py,sha256=Rxl8gx7mni5CvBAK-Ai02EKw-GwtJdd3yeHT2kMloik,1667
 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=FICmlAgRudMlQWbhrWHgE2FJhfMxxoZDQKJx3Vb_bCg,8
-osbot_utils-1.86.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-osbot_utils-1.86.0.dist-info/METADATA,sha256=UzS_UAyqMxFY7sHUJaADcG-n2JX4ch7LJoSeiGKzGhA,1317
-osbot_utils-1.86.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-osbot_utils-1.86.0.dist-info/RECORD,,
+osbot_utils/version,sha256=D0MVxZOCQlRSLSl_5l6QLAIYIlH9b7vBFCZn_V3Z2WY,8
+osbot_utils-1.88.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+osbot_utils-1.88.0.dist-info/METADATA,sha256=KAjZ52Wxr8Kq06sTXHWU8RzvgSGltoSiT7BWLDPKTRg,1317
+osbot_utils-1.88.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+osbot_utils-1.88.0.dist-info/RECORD,,