osbot-utils 1.23.0__tar.gz → 1.24.0__tar.gz

{osbot_utils-1.23.0 → osbot_utils-1.24.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: osbot_utils
-Version: 1.23.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.23.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.23.0 → osbot_utils-1.24.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.23.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.24.0/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-1.23.0 → osbot_utils-1.24.0}/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-1.23.0 → osbot_utils-1.24.0}/osbot_utils/utils/Env.py

@@ -82,7 +82,7 @@ def in_python_debugger():
         return True
     return False
 
-def load_dotenv(dotenv_path=None, override=False):
+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:

{osbot_utils-1.23.0 → osbot_utils-1.24.0}/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-1.23.0 → osbot_utils-1.24.0}/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-1.24.0/osbot_utils/version

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

{osbot_utils-1.23.0 → osbot_utils-1.24.0}/pyproject.toml

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

osbot_utils-1.23.0/osbot_utils/version

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