osbot-utils 1.22.0__py3-none-any.whl → 1.24.0__py3-none-any.whl

osbot_utils/helpers/ssh/SSH.py

@@ -13,6 +13,8 @@ class SSH(Type_Safe):       # todo: add ip_address to global vars here, and when
         self.ssh_execute().setup()
         return self
 
+    def exec(self,command):
+        return self.ssh_execute().execute_command(command)
     @cache_on_self
     def scp(self):
         kwargs = self.ssh_execute().__locals__()        # get the current ssh config details

osbot_utils/testing/Temp_Env_Vars.py

@@ -0,0 +1,20 @@
+import os
+
+from osbot_utils.base_classes.Type_Safe import Type_Safe
+
+
+class Temp_Env_Vars(Type_Safe):
+    env_vars         : dict
+    original_env_vars: dict
+
+    def __enter__(self):
+        for key, value in self.env_vars.items():
+            self.original_env_vars[key] = os.environ.get(key)                   # Backup original environment variables and set new ones
+            os.environ[key] = value
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        for key in self.env_vars:                                               # Restore original environment variables
+            if self.original_env_vars[key] is None:
+                del os.environ[key]
+            else:
+                os.environ[key] = self.original_env_vars[key]

osbot_utils/testing/Temp_File.py

@@ -4,17 +4,23 @@ from osbot_utils.utils.Misc import random_filename
 
 
 class Temp_File:
-    def __init__(self, contents='...', extension='tmp',file_name=None, ):
+    def __init__(self, contents='...', extension='tmp',file_name=None, return_file_path=False, create_file=True):
         self.tmp_file            = file_name or random_filename(extension)
         self.tmp_folder          = None
         self.file_path           = None
         self.original_contents   = contents
+        self.return_file_path    = return_file_path
+        self.create_file         = create_file
 
     def __enter__(self):
         self.tmp_folder = Files.temp_folder(prefix='temp_folder_')
         self.file_path = Files.path_combine(self.tmp_folder, self.tmp_file)
-        file_create(self.file_path, self.original_contents)
-        return self
+        if self.create_file:
+            file_create(self.file_path, self.original_contents)
+        if self.return_file_path:
+            return self.file_path
+        else:
+            return self
 
     def __exit__(self, type, value, traceback):
         file_delete      (self.file_path)

osbot_utils/utils/Env.py

@@ -63,30 +63,32 @@ def env_unload_from_file(path):
                 if key in os.environ:  # Remove the environment variable if it exists
                     del os.environ[key]
 
+def find_dotenv_file(start_path=None, env_file_to_find='.env'):
+    directories = all_parent_folders(path=start_path, include_path=True)  # Define the possible directories to search for the .env file (which is this and all parent folders)
+    for directory in directories:                                         # Iterate through the directories and load the .env file if found
+        env_path = os.path.join(directory,env_file_to_find)               # Define the path to the .env file
+        if os.path.exists(env_path):                                      # If we found one
+            return env_path                                               # return the path to the .env file
+
 def in_github_action():
     return os.getenv('GITHUB_ACTIONS') == 'true'
 
 def in_python_debugger():
     if sys.gettrace() is not None:              # Check for a trace function
         return True
-
     pycharm_hosted           = os.getenv('PYCHARM_HOSTED') == '1'                     # Check for PyCharm specific environment variables and other potential indicators
     pydevd_load_values_async = os.getenv('PYDEVD_LOAD_VALUES_ASYNC') is not None
     if pycharm_hosted and pydevd_load_values_async:
         return True
-
     return False
 
-def load_dotenv(dotenv_path=None, override=False):
-    if dotenv_path:                                                 # If a specific dotenv path is provided, load from it
+def load_dotenv(dotenv_path=None, override=False):              # todo: add detection when we have already loaded the .env (so that we don't load it again)
+    if dotenv_path:                                             # If a specific dotenv path is provided, load from it
         env_load_from_file(dotenv_path, override)
     else:
-        directories = all_parent_folders(include_path=True)         # Define the possible directories to search for the .env file (which is this and all parent folders)
-        for directory in directories:                               # Iterate through the directories and load the .env file if found
-            env_path = os.path.join(directory, '.env')              # Define the path to the .env file
-            if os.path.exists(env_path):                            # If we found one
-                env_load_from_file(env_path, override)              # Process it
-                break                                               # Stop after loading the first .env file                                                     # Stop after loading the first .env file
+        env_file = find_dotenv_file()
+        if env_file:
+            env_load_from_file(env_file, override)              # Process it
 
 
 def not_in_github_action():

osbot_utils/utils/Files.py

@@ -315,8 +315,10 @@ class Files:
             return abspath(join(parent_path,sub_path))
 
     @staticmethod
-    def parent_folder(path):
+    def parent_folder(path, use_full_path=False):
         if path:
+            if use_full_path:
+                path = file_full_path(path)
             return os.path.dirname(path)
 
     @staticmethod
@@ -429,6 +431,8 @@ class Files:
         return path
 
 # todo: refactor the methods above into static methods (as bellow)
+def absolute_path(path):
+    return abspath(path)
 
 def all_parent_folders(path=None, include_path=False):
     if path is None:
@@ -498,6 +502,7 @@ file_create_gz                 = Files.write_gz
 file_exists                    = Files.exists
 file_extension                 = Files.file_extension
 file_extension_fix             = Files.file_extension_fix
+file_full_path                 = absolute_path
 file_lines                     = Files.lines
 file_lines_gz                  = Files.lines_gz
 file_md5                       = Files.contents_md5

osbot_utils/utils/Objects.py

@@ -211,7 +211,7 @@ def obj_base_classes_names(obj, show_module=False):
             names.append(base.__name__)
     return names
 
-def obj_data(target, name_width=30, value_width=100, show_private=False, show_internals=False, show_value_class=False, show_methods=False, only_show_methods=False):
+def obj_data(target, convert_value_to_str=True, name_width=30, value_width=100, show_private=False, show_internals=False, show_value_class=False, show_methods=False, only_show_methods=False):
     result = {}
     if show_internals:
         show_private = True                                     # show_private will skip all internals, so need to make sure it is True
@@ -226,11 +226,12 @@ def obj_data(target, name_width=30, value_width=100, show_private=False, show_in
             continue
         if only_show_methods:
             value = inspect.signature(value)
-        if value !=None and type(value) not in [bool, int, float]:
-            value       = str(value).encode('unicode_escape').decode("utf-8")
-            value       = str_unicode_escape(value)
-            value       = str_max_width(value, value_width)
-            name        = str_max_width(name, name_width)
+        if value is not None and type(value) not in [bool, int, float]:
+            if convert_value_to_str:
+                value       = str(value).encode('unicode_escape').decode("utf-8")
+                value       = str_unicode_escape(value)
+                value       = str_max_width(value, value_width)
+            name  = str_max_width(name, name_width)                                     # todo: look at the side effects of running this for all (at the moment if we do that we break the test_cache_on_self test)
         result[name] = value
     return result
 

osbot_utils/utils/Toml.py

@@ -1,5 +1,7 @@
 import sys
 
+from osbot_utils.utils.Files import file_create, file_contents
+
 if sys.version_info >= (3, 11):
     import tomllib
 else:
@@ -27,7 +29,19 @@ def dict_to_toml(data, indent_level=0):
 
     return toml_str
 
-def toml_to_dict(toml_string):
+def toml_dict_to_file(toml_file, data):
+    str_toml = dict_to_toml(data)
+    return file_create(toml_file, str_toml)
+
+def toml_dict_from_file(toml_file):
+    str_toml = file_contents(toml_file)
+    return toml_to_dict(str_toml)
+
+
+def toml_to_dict(str_toml):
     if tomllib is None:
         raise NotImplementedError("TOML parsing is not supported in Python versions earlier than 3.11")
-    return tomllib.loads(toml_string)
+    return tomllib.loads(str_toml)
+
+
+toml_file_load = toml_dict_from_file

osbot_utils/version

@@ -1 +1 @@
-v1.22.0
+v1.24.0

{osbot_utils-1.22.0.dist-info → osbot_utils-1.24.0.dist-info}/METADATA

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

@@ -217,7 +217,7 @@ osbot_utils/helpers/sqlite/tables/Sqlite__Table__Files.py,sha256=ZlhTqroHd9T8vqN
 osbot_utils/helpers/sqlite/tables/Sqlite__Table__Nodes.py,sha256=GT8h3wD4hGvEtqQuBs0sBbcu2ydktRHTi95PEL2ffHQ,1721
 osbot_utils/helpers/sqlite/tables/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 osbot_utils/helpers/ssh/SCP.py,sha256=9PgJbyWKfxJj00Ijaj7o6ffxPXuNoureb6JlHMPbHww,3330
-osbot_utils/helpers/ssh/SSH.py,sha256=YC3mwLjHxiCrt4t2s15xvAdFcz4yfQVMwqE8mByKmVU,1458
+osbot_utils/helpers/ssh/SSH.py,sha256=jyRZIL8rif1Fn76i0ZJWSkY0VyQuB1J2LAWIvu4jKpU,1545
 osbot_utils/helpers/ssh/SSH__Cache__Requests.py,sha256=Dqh4biVcuaXbQVvn3Tx-kSGBGHiF-2wVsgu96EhD6gU,3359
 osbot_utils/helpers/ssh/SSH__Execute.py,sha256=D5tQGbSPaNsrMvhTVT0sZIHpqF1rIYXYiaWzGExcwm4,6849
 osbot_utils/helpers/ssh/SSH__Health_Check.py,sha256=WDmBD6ejNcBeicXfjpsiNzH-WR3Jejx0re3WfwjSWyQ,2083
@@ -249,7 +249,8 @@ osbot_utils/testing/Profiler.py,sha256=4em6Lpp0ONRDoDDCZsc_CdAOi_QolKOp4eA7KHN96
 osbot_utils/testing/Pytest.py,sha256=R3qdsIXGcNQcu7iobz0RB8AhbbHhc6t757tZoSZRrxA,730
 osbot_utils/testing/Stderr.py,sha256=wi1gfjpsxnBK3aOl2jzCTWI-0En1HtPgEin97148_MQ,459
 osbot_utils/testing/Stdout.py,sha256=XQ9OlOW1aHXY1TiNu8O5b75RoDnoaX5RyMHml3OjlKw,459
-osbot_utils/testing/Temp_File.py,sha256=gL1BJ6aRNg2o4LeUJ4f3bxKc75iw1qp0WKP9T3rS_WU,1435
+osbot_utils/testing/Temp_Env_Vars.py,sha256=oFuaegBlaV0aySkPe1Nzf-mdIKN03oTUKNfKijGz__M,751
+osbot_utils/testing/Temp_File.py,sha256=yZBL9MmcNU4PCQ4xlF4rSss4GylKoX3T_AJF-BlQhdI,1693
 osbot_utils/testing/Temp_Folder.py,sha256=wZQhCi5Cy0dQQAXuu3_jArDz5T94Q_JX68GENU6nTMo,4793
 osbot_utils/testing/Temp_Sys_Path.py,sha256=gOMD-7dQYQlejoDYUqsrmuZQ9DLC07ymPZB3zYuNmG4,256
 osbot_utils/testing/Temp_Web_Server.py,sha256=0A-gZsd0_3wRj2YuBEOWyV2rhT6dcS2BlArngPXGTtk,3186
@@ -262,9 +263,9 @@ osbot_utils/utils/Assert.py,sha256=u9XLgYn91QvNWZGyPi29SjPJSXRHlm9andIn3NJEVog,1
 osbot_utils/utils/Call_Stack.py,sha256=MAq_0vMxnbeLfCe9qQz7GwJYaOuXpt3qtQwN6wiXsU0,6595
 osbot_utils/utils/Csv.py,sha256=oHLVpjRJqrLMz9lubMCNEoThXWju5rNTprcwHc1zq2c,1012
 osbot_utils/utils/Dev.py,sha256=HibpQutYy_iG8gGV8g1GztxNN4l29E4Bi7UZaVL6-L8,1203
-osbot_utils/utils/Env.py,sha256=_7SV5Jor7-GoMggYcwZflTO5D3eQKPvh73FXzC_fyGc,4858
+osbot_utils/utils/Env.py,sha256=CrvDcpY9NEuvyvG_QHcv1oSfw8BKXN6MqVEbPF_OqFU,5008
 osbot_utils/utils/Exceptions.py,sha256=KyOUHkXQ_6jDTq04Xm261dbEZuRidtsM4dgzNwSG8-8,389
-osbot_utils/utils/Files.py,sha256=HRMdDq1ZctDfCkIfuZGgQ3fG6O03qJEFEIkb8HTYzfU,19407
+osbot_utils/utils/Files.py,sha256=q4_JeNWZygM8T0_frpTGvZjtISC1ZyJTOr3bD9pCKUE,19599
 osbot_utils/utils/Functions.py,sha256=0E6alPJ0fJpBiJgFOWooCOi265wSRyxxXAJ5CELBnso,3498
 osbot_utils/utils/Http.py,sha256=Z8V149M2HDrKBoXkDD5EXgqTGx6vQoUqXugXK__wcuw,4572
 osbot_utils/utils/Int.py,sha256=PmlUdU4lSwf4gJdmTVdqclulkEp7KPCVUDO6AcISMF4,116
@@ -272,18 +273,18 @@ osbot_utils/utils/Json.py,sha256=UNaBazuH1R40fsHjpjuK8kmAANmUHoK9Q0PUeYmgPeY,625
 osbot_utils/utils/Json_Cache.py,sha256=mLPkkDZN-3ZVJiDvV1KBJXILtKkTZ4OepzOsDoBPhWg,2006
 osbot_utils/utils/Lists.py,sha256=CLEjgZwAixJAFlubWEKjnUUhUN85oqvR7UqExVW7rdY,5502
 osbot_utils/utils/Misc.py,sha256=ljscBemI5wOhfkl1BVpsqshacTOCKkOisV4er9xPCWM,16640
-osbot_utils/utils/Objects.py,sha256=SNtQ1nJnqihwTcmIf_Hg9P3V7fHjxcVHSzC7vKKI34Q,14419
+osbot_utils/utils/Objects.py,sha256=WFH3oeXR1CU03oyzXfcIlktcoXQuKw9cIJn8xTs02AE,14654
 osbot_utils/utils/Png.py,sha256=V1juGp6wkpPigMJ8HcxrPDIP4bSwu51oNkLI8YqP76Y,1172
 osbot_utils/utils/Process.py,sha256=lr3CTiEkN3EiBx3ZmzYmTKlQoPdkgZBRjPulMxG-zdo,2357
 osbot_utils/utils/Python_Logger.py,sha256=7IPB6gMw-G9HWdgyG_k6d7CE71P55-SAudKgDVxraMs,12756
 osbot_utils/utils/Status.py,sha256=Yq4s0TelXgn0i2QjCP9V8mP30GabXp_UL-jjM6Iwiw4,4305
 osbot_utils/utils/Str.py,sha256=kxdY8ROX4FdJtCaMTfOc8fK_xcDICprNkefHu2MMNU4,2585
-osbot_utils/utils/Toml.py,sha256=-bg9srF7ef31UCNFa0aL3CDeDKp14XeUVwRMQzMb_dI,1074
+osbot_utils/utils/Toml.py,sha256=dqiegndCJF7V1YT1Tc-b0-Bl6QWyL5q30urmQwMXfMQ,1402
 osbot_utils/utils/Version.py,sha256=Ww6ChwTxqp1QAcxOnztkTicShlcx6fbNsWX5xausHrg,422
 osbot_utils/utils/Zip.py,sha256=YFahdBguVK71mLdYy4m7mqVAQ5al-60QnTmYK-txCfY,6784
 osbot_utils/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-osbot_utils/version,sha256=z7NTPYmQ0L2Y8UsRZopbRpNKn5uryAcux3sKpD_TKh0,8
-osbot_utils-1.22.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-osbot_utils-1.22.0.dist-info/METADATA,sha256=iNHC9Qu30A7DwLcvMTVwBkWT_EHdzVUYP4XXooShCKI,1266
-osbot_utils-1.22.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-osbot_utils-1.22.0.dist-info/RECORD,,
+osbot_utils/version,sha256=ZD3YCx9CcqVfYvN3EZrH5YNt6_M4up_qb295gQk6gwg,8
+osbot_utils-1.24.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+osbot_utils-1.24.0.dist-info/METADATA,sha256=E-QECitRSsPhAR9aTUqtH7_7eM2y2PIG3ezGzStkr2Q,1266
+osbot_utils-1.24.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+osbot_utils-1.24.0.dist-info/RECORD,,