osbot-utils 2.68.0__py3-none-any.whl → 2.70.0__py3-none-any.whl

osbot_utils/helpers/llms/builders/LLM_Request__Builder.py

@@ -1,5 +1,6 @@
 from typing                                                                 import Dict, Any, Type
 from osbot_utils.helpers.llms.actions.Type_Safe__Schema_For__LLMs           import Type_Safe__Schema_For__LLMs
+from osbot_utils.helpers.llms.schemas.Safe_Str__LLM__Model_Name             import Safe_Str__LLM__Model_Name
 from osbot_utils.helpers.llms.schemas.Schema__LLM_Request                   import Schema__LLM_Request
 from osbot_utils.helpers.llms.schemas.Schema__LLM_Request__Data             import Schema__LLM_Request__Data
 from osbot_utils.helpers.llms.schemas.Schema__LLM_Request__Function_Call    import Schema__LLM_Request__Function_Call
@@ -40,14 +41,14 @@ class LLM_Request__Builder(Type_Safe):
         self.llm_request_data.function_call = function_call
         return self
 
-    def set__model              (self, model   : Safe_Str__Text): self.llm_request_data.model    = model   ; return self
-    def set__platform           (self, platform: Safe_Str__Text): self.llm_request_data.platform = platform; return self
-    def set__provider           (self, provider: Safe_Str__Text): self.llm_request_data.provider = provider; return self
-    def set__model__gpt_4o      (self                          ): return self.set__model('gpt-4o'      )
-    def set__model__gpt_4o_mini (self                          ): return self.set__model('gpt-4o-mini' )
-    def set__model__gpt_4_1     (self                          ): return self.set__model('gpt-4.1'     )
-    def set__model__gpt_4_1_mini(self                          ): return self.set__model('gpt-4.1-mini')
-    def set__model__gpt_4_1_nano(self                          ): return self.set__model('gpt-4.1-nano')
+    def set__model              (self, model   : Safe_Str__LLM__Model_Name): self.llm_request_data.model    = model   ; return self
+    def set__platform           (self, platform: Safe_Str__Text           ): self.llm_request_data.platform = platform; return self
+    def set__provider           (self, provider: Safe_Str__Text           ): self.llm_request_data.provider = provider; return self
+    def set__model__gpt_4o      (self                                     ): return self.set__model('gpt-4o'      )
+    def set__model__gpt_4o_mini (self                                     ): return self.set__model('gpt-4o-mini' )
+    def set__model__gpt_4_1     (self                                     ): return self.set__model('gpt-4.1'     )
+    def set__model__gpt_4_1_mini(self                                     ): return self.set__model('gpt-4.1-mini')
+    def set__model__gpt_4_1_nano(self                                     ): return self.set__model('gpt-4.1-nano')
 
 
     @type_safe

osbot_utils/helpers/llms/schemas/Safe_Str__LLM__Model_Name.py

@@ -0,0 +1,10 @@
+import re
+
+from osbot_utils.helpers.safe_str.Safe_Str import Safe_Str
+
+TYPE_SAFE_STR__LLM__MODEL_NAME__MAX_LENGTH = 256
+TYPE_SAFE_STR__LLM__MODEL_NAME__REGEX      =  r'[^a-zA-Z0-9/_\-.:]'
+
+class Safe_Str__LLM__Model_Name(Safe_Str):
+    regex      = re.compile(TYPE_SAFE_STR__LLM__MODEL_NAME__REGEX)
+    max_length = TYPE_SAFE_STR__LLM__MODEL_NAME__MAX_LENGTH

osbot_utils/helpers/llms/schemas/Schema__LLM_Request__Data.py

@@ -1,11 +1,12 @@
 from typing                                                                 import List, Optional
+from osbot_utils.helpers.llms.schemas.Safe_Str__LLM__Model_Name             import Safe_Str__LLM__Model_Name
 from osbot_utils.helpers.llms.schemas.Schema__LLM_Request__Function_Call    import Schema__LLM_Request__Function_Call
 from osbot_utils.helpers.llms.schemas.Schema__LLM_Request__Message__Content import Schema__LLM_Request__Message__Content
 from osbot_utils.helpers.safe_str.Safe_Str__Text                            import Safe_Str__Text
 from osbot_utils.type_safe.Type_Safe                                        import Type_Safe
 
 class Schema__LLM_Request__Data(Type_Safe):                                         # Schema for LLM API request data
-    model         : Safe_Str__Text                                                  # LLM model identifier
+    model         : Safe_Str__LLM__Model_Name                                       # LLM model identifier
     platform      : Safe_Str__Text
     provider      : Safe_Str__Text
     messages      : List    [Schema__LLM_Request__Message__Content]                 # Message content entries

osbot_utils/helpers/safe_str/Safe_Str__File__Name.py

@@ -1,8 +1,10 @@
 import re
 from osbot_utils.helpers.safe_str.Safe_Str import Safe_Str
 
+TYPE_SAFE_STR__FILE__NAME__REGEX = re.compile(r'[^a-zA-Z0-9_\-. ]')
+
 class Safe_Str__File__Name(Safe_Str):
-    regex                      = re.compile(r'[^a-zA-Z0-9_\-. ]')
+    regex                      = TYPE_SAFE_STR__FILE__NAME__REGEX
     allow_empty                = False
     trim_whitespace            = True
     allow_all_replacement_char = False

osbot_utils/type_safe/Type_Safe__Primitive.py

@@ -29,6 +29,12 @@ class Type_Safe__Primitive:
             return super().__eq__(other)
         return False                                                            # Different types → not equal
 
+    def __enter__(self):                                                        # support context manager
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        return
+
     def __ne__(self, other):
         return not self.__eq__(other)
 

osbot_utils/utils/Files.py

@@ -1,5 +1,8 @@
 import os
-from typing import Union
+from typing import Union, List
+
+from osbot_utils.helpers.safe_str.Safe_Str__File__Path import Safe_Str__File__Path
+
 
 class Files:
     @staticmethod
@@ -72,16 +75,25 @@ class Files:
         return glob.glob(path_pattern, recursive=recursive)
 
     @staticmethod
-    def files(path, pattern= '*', only_files=True):
+    def files(path, pattern= '*', only_files=True, include_path=True) -> List[Safe_Str__File__Path]:
+
         from pathlib import Path
 
-        result = []
+        result   = []
         for file in Path(path).rglob(pattern):
             if only_files and is_not_file(file):
                 continue
-            result.append(str(file))                                  # todo: see if there is a better way to do this conversion to string
+            file_path = file.as_posix()
+            if include_path is False:
+                file_path = str(file.relative_to(path))
+            result.append(Safe_Str__File__Path(file_path))
+
         return sorted(result)
 
+    @staticmethod
+    def files__virtual_paths(path, pattern='*', only_files=True):
+        return Files.files(path, pattern=pattern, only_files=only_files, include_path=False)
+
     @staticmethod
     def files_names(files : list, check_if_exists=True):
         result = []
@@ -628,6 +640,7 @@ filter_parent_folder           = Files.filter_parent_folder
 files_find                     = Files.find
 files_recursive                = Files.files_recursive
 files_list                     = Files.files
+files_list__virtual_paths      = Files.files__virtual_paths
 files_names                    = Files.files_names
 
 find_files                     = Files.files

osbot_utils/utils/Zip.py

@@ -79,6 +79,8 @@ def zip_bytes__add_files(zip_bytes, files_to_add):
                 file_contents = file_contents.encode('utf-8')
             elif not isinstance(file_contents, bytes):
                 continue
+            if file_path.startswith(('/', '\\')):                                       # Strip leading slash or backslash to make the path relative
+                file_path = file_path.lstrip('/\\')
             zf.writestr(file_path, file_contents)
 
     return zip_buffer.getvalue()
@@ -135,7 +137,7 @@ def zip_bytes__replace_files(zip_bytes, files_to_replace):
 def zip_bytes__unzip(zip_bytes, target_folder=None):
     target_folder = target_folder or temp_folder()              # Use the provided target folder or create a temporary one
     zip_buffer = io.BytesIO(zip_bytes)                          # Create a BytesIO buffer from the zip bytes
-    with zipfile.ZipFile(zip_buffer, 'r') as zf:          # Open the zip file from the buffer
+    with zipfile.ZipFile(zip_buffer, 'r') as zf:                # Open the zip file from the buffer
         zf.extractall(target_folder)                            # Extract all files to the target folder
     return target_folder                                        # Return the path of the target folder
 
@@ -200,16 +202,18 @@ def zip_folder_to_file (root_dir, target_file):
     zip_file = zip_folder(root_dir)
     return file_move(zip_file, target_file)
 
-def zip_folder_to_bytes(root_dir):      # todo add unit test
+def zip_folder_to_bytes(root_dir, files_to_ignore:list=None):      # todo add unit test
     zip_buffer = io.BytesIO()                                                   # Create a BytesIO buffer to hold the zipped file
     with zipfile.ZipFile(zip_buffer, 'w', zipfile.ZIP_DEFLATED) as zf:          # Create a ZipFile object with the buffer as the target
         for foldername, subfolders, filenames in os.walk(root_dir):             # Walk the root_dir and add all files and folders to the zip file
             for filename in filenames:
+                if files_to_ignore and filename in files_to_ignore:
+                    continue
                 absolute_path = os.path.join(foldername, filename)              # Create the complete filepath
                 arcname = os.path.relpath(absolute_path, root_dir)              # Define the arcname, which is the name inside the zip file
                 zf.write(absolute_path, arcname)                                # Add the file to the zip file
     zip_buffer.seek(0)                                                          # Reset buffer position
-    return zip_buffer
+    return zip_buffer.getvalue()
 
 def zip_files(base_folder, file_pattern="*.*", target_file=None):
     base_folder = abspath(base_folder)

osbot_utils/version

@@ -1 +1 @@
-v2.68.0
+v2.70.0

{osbot_utils-2.68.0.dist-info → osbot_utils-2.70.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: osbot_utils
-Version: 2.68.0
+Version: 2.70.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.68.0-blue)
+![Current Release](https://img.shields.io/badge/release-v2.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-2.68.0.dist-info → osbot_utils-2.70.0.dist-info}/RECORD

@@ -208,7 +208,7 @@ osbot_utils/helpers/llms/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZ
 osbot_utils/helpers/llms/actions/LLM_Request__Execute.py,sha256=IsC5gzQXG__j5M2dSWVCmV77Kf133pKbZRvbiQyeihU,2453
 osbot_utils/helpers/llms/actions/Type_Safe__Schema_For__LLMs.py,sha256=em9RoSZqSSo6BQBZvEKH8Qv8f8f8oubNpy0LIDsak-E,12024
 osbot_utils/helpers/llms/actions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-osbot_utils/helpers/llms/builders/LLM_Request__Builder.py,sha256=2Zp4Ka4q2XcZNUuR47kP7iyhfLsY2A_rxOME3i6olgE,3811
+osbot_utils/helpers/llms/builders/LLM_Request__Builder.py,sha256=d9TnJmA1KbEypvCdgFXWcg684n-TGIrumxigsTOMECE,4008
 osbot_utils/helpers/llms/builders/LLM_Request__Builder__Open_AI.py,sha256=JwyPDeBUQd70Ltm801y5qvS883IIC7TcfG04D3LWdGI,3430
 osbot_utils/helpers/llms/builders/LLM_Request__Factory.py,sha256=bpFXVTKpalBL7ZONjaHU5c0-2Rwzzd2vgdD1FpYxfGw,6291
 osbot_utils/helpers/llms/builders/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -222,9 +222,10 @@ osbot_utils/helpers/llms/cache/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5
 osbot_utils/helpers/llms/platforms/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 osbot_utils/helpers/llms/platforms/open_ai/API__LLM__Open_AI.py,sha256=Yyy2ZnIS6CfxXepP9pZNsOYx02d-5EnK1IFeFf8myyk,2148
 osbot_utils/helpers/llms/platforms/open_ai/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+osbot_utils/helpers/llms/schemas/Safe_Str__LLM__Model_Name.py,sha256=AKLfBv65ELl6XvSsLKMVS-y9LefSVNf8GNrEWKVd_TY,358
 osbot_utils/helpers/llms/schemas/Schema__LLM_Cache__Index.py,sha256=12dUUSFhWRZvqEkNivqajqMPApPWhfSI7jWnHyBuxNw,717
 osbot_utils/helpers/llms/schemas/Schema__LLM_Request.py,sha256=UUiqZQ5mj16SPdlzef7_j3myLaKKCZdAUjsWUJnK1Ag,378
-osbot_utils/helpers/llms/schemas/Schema__LLM_Request__Data.py,sha256=EpII6ZMkWACkoHYn-TNowppbIskyoaCovefPA5Q5qtA,1380
+osbot_utils/helpers/llms/schemas/Schema__LLM_Request__Data.py,sha256=oLrvmngkDVX2KB2gVR1DwvJQcxWMbBxomjs_IBFQtzc,1489
 osbot_utils/helpers/llms/schemas/Schema__LLM_Request__Function_Call.py,sha256=VJgWi4aK-DJmuJvfY2qZUZuLkrLlmu5lgyzxZrrp3hM,440
 osbot_utils/helpers/llms/schemas/Schema__LLM_Request__Message__Content.py,sha256=nl-16yz4G_72ViACKE9CvGStrKxw2Gm_JcaU8wVcJXI,521
 osbot_utils/helpers/llms/schemas/Schema__LLM_Request__Message__Role.py,sha256=T99w0cRrDPXQqPT-Nw7_14tMr4vKpUlhw74UJZL6w6w,168
@@ -261,7 +262,7 @@ osbot_utils/helpers/safe_int/Safe_UInt__Percentage.py,sha256=Ck-jiu6NK57Y3ruAjIJ
 osbot_utils/helpers/safe_int/Safe_UInt__Port.py,sha256=uISrh8VKXiEQULQ1POU9YK8Di6z_vr0HWjCTpjA0YaY,482
 osbot_utils/helpers/safe_int/__init__.py,sha256=kMU2WMsdQmayBEZugxnJV_wRW3O90bc118sx6iIm_mQ,310
 osbot_utils/helpers/safe_str/Safe_Str.py,sha256=qR2RDh5cehP_wDDeV5TQahNBwmfcizPFyStALBKD5dw,3509
-osbot_utils/helpers/safe_str/Safe_Str__File__Name.py,sha256=ncjkQ2hAhw0a3UulrCuQsA9ytrFwg5CT1XRJIGChMpY,289
+osbot_utils/helpers/safe_str/Safe_Str__File__Name.py,sha256=9Evl4P45GCyyR2ywze29GzmqWhyTCcgI-o2CItMsOHo,358
 osbot_utils/helpers/safe_str/Safe_Str__File__Path.py,sha256=K0yBcvH_Ncqiw7tMqjGqaNyWQh1Zs9qxZ-TR8nEIAow,550
 osbot_utils/helpers/safe_str/Safe_Str__Hash.py,sha256=IpYdYwXey5WZWa6QfysmsiDP-4L-wP-_EKbkeXhFRH4,1252
 osbot_utils/helpers/safe_str/Safe_Str__Text.py,sha256=QxuWqF8hNYdOPDn3Yac86h_1ZaX-THbTBDakberiJcs,313
@@ -376,7 +377,7 @@ osbot_utils/type_safe/Type_Safe__Base.py,sha256=UTMipTL6mXoetAEUCI5hs8RqXp4NDYOv
 osbot_utils/type_safe/Type_Safe__Dict.py,sha256=QB200L5eNWT3FnUv8sm5kncj1wXJsJ9uRycNFl9xb6Y,3077
 osbot_utils/type_safe/Type_Safe__List.py,sha256=y_lp7Ai0HfQCqC8Bxn0g6_M9MP5lPOXy5Dhkuj2fJvQ,1891
 osbot_utils/type_safe/Type_Safe__Method.py,sha256=K100jAq1wmskuXcTd_9vt-XodSKJkDowJselmnDFCN8,16643
-osbot_utils/type_safe/Type_Safe__Primitive.py,sha256=CJ4LP2W5i9utSSzuiiJrwqvwdMv1DeQ6dIZICtYfLTY,3635
+osbot_utils/type_safe/Type_Safe__Primitive.py,sha256=-GBUcuFBBBKrVRSf7cmjPRbAxo7vnL4tOvr9ktmbVj4,3829
 osbot_utils/type_safe/Type_Safe__Set.py,sha256=j12fc8cbd9-s_a13ysaz723rNEW4Dt6hObCd0S-AjIg,1432
 osbot_utils/type_safe/Type_Safe__Tuple.py,sha256=Kx7C4YfHybRbMmVMcmV6yFLi4T48pb592vEZfjjyLxo,1710
 osbot_utils/type_safe/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -413,7 +414,7 @@ osbot_utils/utils/Csv.py,sha256=oHLVpjRJqrLMz9lubMCNEoThXWju5rNTprcwHc1zq2c,1012
 osbot_utils/utils/Dev.py,sha256=eaQ87ZcMRRcxgzA-f7OO8HjjWhbE6L_edwvXiwFZvIQ,1291
 osbot_utils/utils/Env.py,sha256=rBksAy6k-J5oAJp-S_JedVlcj1b2VK8V3zsQbacopMc,6076
 osbot_utils/utils/Exceptions.py,sha256=KyOUHkXQ_6jDTq04Xm261dbEZuRidtsM4dgzNwSG8-8,389
-osbot_utils/utils/Files.py,sha256=YwfXMeU1jfDzYvZJGy0bWHvvduTuTnftBNlAnpsXDzw,23013
+osbot_utils/utils/Files.py,sha256=Zg8TV8RpKv3ytnZvvT17DWeEJCisSkO8zzyP_Twhcww,23449
 osbot_utils/utils/Functions.py,sha256=VoTrAbCHt6hulz6hVz3co8w2xoOS8wE04wyHc5_cC1c,3671
 osbot_utils/utils/Http.py,sha256=pLDwq0Jd4Zmpps0gEzXTbeycSFRXMN8W-DprNpYq9A0,8189
 osbot_utils/utils/Int.py,sha256=PmlUdU4lSwf4gJdmTVdqclulkEp7KPCVUDO6AcISMF4,116
@@ -431,10 +432,10 @@ osbot_utils/utils/Str.py,sha256=KQVfh0o3BxJKVm24yhAhgIGH5QYfzpP1G-siVv2zQws,3301
 osbot_utils/utils/Threads.py,sha256=YI1T382AtJpHVsa-BK7SycmEYhnkqHIiYyK_5HSmUtw,4329
 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/Zip.py,sha256=mG42lgTY0tnm14T3P1-DSAIZKkTiYoO3odZ1aOUdc1I,14394
 osbot_utils/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-osbot_utils/version,sha256=tz0YZbPbxI1MZny2uz5JYHas4qH1U1J4ERBX9mZthgM,8
-osbot_utils-2.68.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-osbot_utils-2.68.0.dist-info/METADATA,sha256=PmGNC4TeAdIIv85WIzFoLzG2qgxZJF8qjytG1mVYNIY,1329
-osbot_utils-2.68.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-osbot_utils-2.68.0.dist-info/RECORD,,
+osbot_utils/version,sha256=0cHMv8cBSyT1AgEUuKq6G2WmqYGDEd5ktNMn-AhcMBI,8
+osbot_utils-2.70.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+osbot_utils-2.70.0.dist-info/METADATA,sha256=-9hKyVUnDUX9X8z-OuMG0sETWVC4RPkILyfo93EC5fQ,1329
+osbot_utils-2.70.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+osbot_utils-2.70.0.dist-info/RECORD,,