osbot-utils 1.69.0__tar.gz → 1.71.0__tar.gz

{osbot_utils-1.69.0 → osbot_utils-1.71.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: osbot_utils
-Version: 1.69.0
+Version: 1.71.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.69.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.71.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.69.0 → osbot_utils-1.71.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-v1.69.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.71.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.69.0 → osbot_utils-1.71.0}/osbot_utils/base_classes/Type_Safe.py

@@ -54,22 +54,6 @@ immutable_types = (bool, int, float, complex, str, tuple, frozenset, bytes, None
 class Type_Safe:
 
     def __init__(self, **kwargs):
-        """
-        Initialize an instance of the derived class, strictly assigning provided keyword
-        arguments to corresponding instance attributes.
-
-        Parameters:
-            **kwargs: Variable length keyword arguments.
-
-        Raises:
-            Exception: If a key from kwargs does not correspond to any attribute
-                       pre-defined in the class, an exception is raised to prevent
-                       setting an undefined attribute.
-
-        """
-        # if 'disable_type_safety' in kwargs:                                 # special case
-        #     self.__type_safety__ = kwargs['disable_type_safety'] is False
-        #     del kwargs['disable_type_safety']
 
         for (key, value) in self.__cls_kwargs__().items():                  # assign all default values to self
             if value is not None:                                           # when the value is explicitly set to None on the class static vars, we can't check for type safety
@@ -264,28 +248,53 @@ class Type_Safe:
                 setattr(self, key, value)
         return self
 
+    def deserialize_dict__using_key_value_annotations(self, key, value):
+        key_class   = get_args(self.__annotations__[key])[0]
+        value_class = get_args(self.__annotations__[key])[1]
+        new_value   = {}
+        for dict_key, dict_value in value.items():
+            if issubclass(key_class, Type_Safe):
+                new__dict_key = key_class().deserialize_from_dict(dict_key)
+            else:
+                new__dict_key = key_class(dict_key)
 
+            if issubclass(value_class, Type_Safe):
+                new__dict_value = value_class().deserialize_from_dict(dict_value)
+            else:
+                new__dict_value = value_class(dict_value)
+            new_value[new__dict_key] = new__dict_value
+
+        return new_value
+
+    # todo: this needs refactoring, since the logic and code is getting quite complex (to be inside methods like this)
     def deserialize_from_dict(self, data):
+
         for key, value in data.items():
             if hasattr(self, key) and isinstance(getattr(self, key), Type_Safe):
-                getattr(self, key).deserialize_from_dict(value)                             # Recursive call for complex nested objects
+                getattr(self, key).deserialize_from_dict(value)                                             # if the attribute is a Type_Safe object, then also deserialize it
             else:
-                if hasattr(self, '__annotations__'):                                        # can only do type safety checks if the class does not have annotations
-                    if obj_is_attribute_annotation_of_type(self, key, EnumMeta):            # Handle the case when the value is an Enum
-                        enum_type = getattr(self, '__annotations__').get(key)
-                        if type(value) is not enum_type:                                    # If the value is not already of the target type
-                            value = enum_from_value(enum_type, value)                       # Try to resolve the value into the enum
-
-                    # todo: refactor these special cases into a separate method to class
-                    elif obj_is_attribute_annotation_of_type(self, key, Decimal):           # handle Decimals
-                        value = Decimal(value)
-                    elif obj_is_attribute_annotation_of_type(self, key, Random_Guid):       # handle Random_Guid
-                        value = Random_Guid(value)
-                    elif obj_is_attribute_annotation_of_type(self, key, Random_Guid_Short): # handle Random_Guid_Short
-                        value = Random_Guid_Short(value)
-                    elif obj_is_attribute_annotation_of_type(self, key, Timestamp_Now):     # handle Timestamp_Now
-                        value = Timestamp_Now(value)
-                setattr(self, key, value)                                                   # Direct assignment for primitive types and other structures
+                if hasattr(self, '__annotations__'):                                                        # can only do type safety checks if the class does not have annotations
+                    if hasattr(self, key) is False:                                                         # make sure we are now adding new attributes to the class
+                        raise ValueError(f"Attribute '{key}' not found in '{self.__class__.__name__}'")
+                    if 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(key, value)
+                    else:
+                        if value is not None:
+                            if obj_is_attribute_annotation_of_type(self, key, EnumMeta):            # Handle the case when the value is an Enum
+                                enum_type = getattr(self, '__annotations__').get(key)
+                                if type(value) is not enum_type:                                    # If the value is not already of the target type
+                                    value = enum_from_value(enum_type, value)                       # Try to resolve the value into the enum
+
+                            # todo: refactor these special cases into a separate method to class
+                            elif obj_is_attribute_annotation_of_type(self, key, Decimal):           # handle Decimals
+                                value = Decimal(value)
+                            elif obj_is_attribute_annotation_of_type(self, key, Random_Guid):       # handle Random_Guid
+                                value = Random_Guid(value)
+                            elif obj_is_attribute_annotation_of_type(self, key, Random_Guid_Short): # handle Random_Guid_Short
+                                value = Random_Guid_Short(value)
+                            elif obj_is_attribute_annotation_of_type(self, key, Timestamp_Now):     # handle Timestamp_Now
+                                value = Timestamp_Now(value)
+                    setattr(self, key, value)                                                   # Direct assignment for primitive types and other structures
 
         return self
 

osbot_utils-1.71.0/osbot_utils/helpers/Safe_Id.py

@@ -0,0 +1,9 @@
+from osbot_utils.utils.Str import safe_id
+
+class Safe_Id(str):
+    def __new__(cls, value):
+        sanitized_value = safe_id(value)
+        return str.__new__(cls, sanitized_value)
+
+    def __str__(self):
+        return self

{osbot_utils-1.69.0 → osbot_utils-1.71.0}/osbot_utils/helpers/Zip_Bytes.py

@@ -1,9 +1,9 @@
-from osbot_utils.base_classes.Type_Safe import Type_Safe
-from osbot_utils.utils.Dev import pprint
-from osbot_utils.utils.Files import files_list, file_create_from_bytes, temp_file, parent_folder, parent_folder_create
-from osbot_utils.utils.Misc import random_text
-from osbot_utils.utils.Regex import list__match_regex, list__match_regexes
-from osbot_utils.utils.Zip import zip_bytes_empty, zip_bytes__files, zip_bytes__add_file, zip_bytes__add_files, \
+from osbot_utils.base_classes.Type_Safe     import Type_Safe
+from osbot_utils.utils.Dev                  import pprint
+from osbot_utils.utils.Files                import files_list, file_create_from_bytes, temp_file, parent_folder, parent_folder_create
+from osbot_utils.utils.Misc                 import random_text
+from osbot_utils.utils.Regex                import list__match_regex, list__match_regexes
+from osbot_utils.utils.Zip                  import zip_bytes_empty, zip_bytes__files, zip_bytes__add_file, zip_bytes__add_files, \
     zip_bytes__replace_files, zip_bytes__replace_file, zip_bytes__file_list, zip_bytes__file, \
     zip_bytes__add_file__from_disk, zip_bytes__add_files__from_disk, zip_files, zip_file__files, zip_bytes__remove_files
 

{osbot_utils-1.69.0 → osbot_utils-1.71.0}/osbot_utils/utils/Objects.py

@@ -8,12 +8,13 @@ import typing
 from collections.abc                    import Mapping
 from typing                             import Union
 from types                              import SimpleNamespace
+from osbot_utils.helpers.Safe_Id        import Safe_Id
 from osbot_utils.helpers.Timestamp_Now  import Timestamp_Now
 from osbot_utils.helpers.Random_Guid    import Random_Guid
 from osbot_utils.utils.Misc             import list_set
 from osbot_utils.utils.Str              import str_unicode_escape, str_max_width
 
-TYPE_SAFE__CONVERT_VALUE__SUPPORTED_TYPES = [Random_Guid, Timestamp_Now]
+TYPE_SAFE__CONVERT_VALUE__SUPPORTED_TYPES = [Safe_Id, Random_Guid, Timestamp_Now]
 
 # Backport implementations of get_origin and get_args for Python 3.7
 if sys.version_info < (3, 8):
@@ -352,6 +353,8 @@ def obj_is_attribute_annotation_of_type(target, attr_name, expected_type):
         return True
     if expected_type is type(attribute_annotation):
         return True
+    if expected_type is get_origin(attribute_annotation):                               # handle genericAlias
+        return True
     return False
 
 def obj_is_type_union_compatible(var_type, compatible_types):

{osbot_utils-1.69.0 → osbot_utils-1.71.0}/osbot_utils/utils/Str.py

@@ -5,17 +5,18 @@ from osbot_utils.utils.Files    import safe_file_name
 
 # todo: refactor this this class all str related methods (mainly from the Misc class)
 
-ANSI_ESCAPE_PATTERN = re.compile(r'\x1b\[[0-9;]*m')
+REGEX__ANSI_ESCAPE_PATTERN = re.compile(r'\x1b\[[0-9;]*m')
+REGEX__SAFE_ID_REGEX       = re.compile(r'[^a-zA-Z0-9_-]')
 
 def ansi_text_visible_length(ansi_text):
     if type(ansi_text) is str:
-        ansi_escape = re.compile(ANSI_ESCAPE_PATTERN)           # This regex matches the escape sequences used for text formatting
+        ansi_escape = re.compile(REGEX__ANSI_ESCAPE_PATTERN)           # This regex matches the escape sequences used for text formatting
         visible_text = ansi_escape.sub('', ansi_text)       # Remove the escape sequences
         return len(visible_text)                                # Return the length of the remaining text
 
 def ansi_to_text(ansi_text: str):
     if type(ansi_text) is str:
-        return ANSI_ESCAPE_PATTERN.sub('', ansi_text)
+        return REGEX__ANSI_ESCAPE_PATTERN.sub('', ansi_text)
 
 def ansis_to_texts(ansis_texts: list):                          # todo: find a better name for this method :)
     if type(ansis_texts) is list:
@@ -33,6 +34,23 @@ def strip_quotes(value: str):                           # Remove surrounding quo
         return value[1:-1]
     return value
 
+def safe_id(value):
+    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:
+        raise ValueError(f"Invalid ID: The ID must not exceed 36 characters (was {len(value)}).")
+
+    sanitized_value = REGEX__SAFE_ID_REGEX.sub('_', value)
+
+    if set(sanitized_value) == {'_'}:
+        raise ValueError("Invalid ID: The sanitized ID must not consist entirely of underscores.")
+
+    return sanitized_value
+
 def str_dedent(value, strip=True):
     result = textwrap.dedent(value)
     if strip:
@@ -54,6 +72,9 @@ def str_max_width(target, value):
 def str_safe(value):
     return safe_file_name(value)
 
+def str_safe_id(value):
+    return safe_id(value)
+
 def str_starts_with(source, prefix):
     if source is None or prefix is None:
         return False

{osbot_utils-1.69.0 → osbot_utils-1.71.0}/osbot_utils/utils/Zip.py

@@ -4,10 +4,8 @@ import os
 import shutil
 import tarfile
 import zipfile
-from os.path import abspath
-
-from osbot_utils.utils.Misc import list_set
-
+from os.path                 import abspath
+from osbot_utils.utils.Misc  import list_set
 from osbot_utils.utils.Files import temp_folder, folder_files, temp_file, is_file, file_copy, file_move, file_exists, \
     file_contents_as_bytes
 

osbot_utils-1.71.0/osbot_utils/version

@@ -0,0 +1 @@
+v1.71.0

{osbot_utils-1.69.0 → osbot_utils-1.71.0}/pyproject.toml

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

osbot_utils-1.69.0/osbot_utils/version

@@ -1 +0,0 @@
-v1.69.0