osbot-utils 1.68.0__tar.gz → 1.70.0__tar.gz

{osbot_utils-1.68.0 → osbot_utils-1.70.0}/PKG-INFO

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

@@ -14,7 +14,7 @@ from osbot_utils.helpers.Random_Guid            import Random_Guid
 from osbot_utils.helpers.Random_Guid_Short      import Random_Guid_Short
 from osbot_utils.helpers.Timestamp_Now          import Timestamp_Now
 from osbot_utils.utils.Dev                      import pprint
-from osbot_utils.utils.Json                     import json_parse
+from osbot_utils.utils.Json                     import json_parse, json_to_bytes, json_to_gz
 from osbot_utils.utils.Misc                     import list_set
 from osbot_utils.utils.Objects                  import default_value, value_type_matches_obj_annotation_for_attr, \
     raise_exception_on_obj_type_annotation_mismatch, obj_is_attribute_annotation_of_type, enum_from_value, \
@@ -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
@@ -230,9 +214,16 @@ class Type_Safe:
     # global methods added to any class that base classes this
     # todo: see if there should be a prefix on these methods, to make it easier to spot them
     #       of if these are actually that useful that they should be added like this
+    def bytes(self):
+        return json_to_bytes(self.json())
+
+    def bytes_gz(self):
+        return json_to_gz(self.json())
+
     def json(self):
         return self.serialize_to_dict()
 
+
     def merge_with(self, target):
         original_attrs = {k: v for k, v in self.__dict__.items() if k not in target.__dict__}       # Store the original attributes of self that should be retained.
         self.__dict__ = target.__dict__                                                             # Set the target's __dict__ to self, now self and target share the same __dict__.

osbot_utils-1.70.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.68.0 → osbot_utils-1.70.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.68.0 → osbot_utils-1.70.0}/osbot_utils/utils/Json.py

@@ -5,6 +5,8 @@ from osbot_utils.utils.Misc  import str_lines, str_md5, str_sha256
 from osbot_utils.utils.Files import file_create_gz, file_create, load_file_gz, file_contents, file_lines, file_lines_gz
 from osbot_utils.utils.Zip   import str_to_gz, gz_to_str
 
+def bytes_to_json_loads(data):
+    return json.loads(data.decode())
 
 def json_dumps(python_object, indent=4, pretty=True, sort_keys=False, default=str, raise_exception=False):
     if python_object:
@@ -135,6 +137,7 @@ class Json:
     def json_save_tmp_file(python_object, pretty=True):
         return Json.save_file(python_object=python_object, pretty=pretty, path=None)
 
+bytes_to_json                = bytes_to_json_loads
 file_create_json             = Json.save_file_pretty
 file_contents_json           = Json.load_file
 
@@ -158,6 +161,7 @@ json_md5                     = Json.md5
 json_lines_loads             = Json.loads_json_lines
 json_parse                   = Json.loads
 json_lines_parse             = Json.loads_json_lines
+json_to_bytes                = json_dumps_to_bytes
 json_to_str                  = json_dumps
 json_round_trip              = Json.round_trip
 json_save                    = Json.save_file

{osbot_utils-1.68.0 → osbot_utils-1.70.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.68.0 → osbot_utils-1.70.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.70.0/osbot_utils/version

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

{osbot_utils-1.68.0 → osbot_utils-1.70.0}/pyproject.toml

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

osbot_utils-1.68.0/osbot_utils/version

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