osbot-utils 1.30.0__tar.gz → 1.32.0__tar.gz

{osbot_utils-1.30.0 → osbot_utils-1.32.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: osbot_utils
-Version: 1.30.0
+Version: 1.32.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.30.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.32.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.30.0 → osbot_utils-1.32.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.30.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.32.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.32.0/osbot_utils/base_classes/Kwargs_To_Self.py

@@ -0,0 +1,4 @@
+from osbot_utils.base_classes.Type_Safe import Type_Safe
+
+# todo: refactor all of Kwargs_To_Self to use Type_Safe
+Kwargs_To_Self = Type_Safe

osbot_utils-1.30.0/osbot_utils/base_classes/Kwargs_To_Self.py → osbot_utils-1.32.0/osbot_utils/base_classes/Type_Safe.py

@@ -13,9 +13,10 @@ from osbot_utils.base_classes.Type_Safe__List   import Type_Safe__List
 from osbot_utils.utils.Dev                      import pprint
 from osbot_utils.utils.Json                     import json_parse
 from osbot_utils.utils.Misc                     import list_set
-from osbot_utils.utils.Objects                  import default_value, value_type_matches_obj_annotation_for_attr, \
+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, \
-    obj_is_type_union_compatible, value_type_matches_obj_annotation_for_union_attr
+    obj_is_type_union_compatible, value_type_matches_obj_annotation_for_union_attr, \
+    convert_dict_to_value_from_obj_annotation
 
 # Backport implementations of get_origin and get_args for Python 3.7
 if sys.version_info < (3, 8):
@@ -47,7 +48,7 @@ immutable_types = (bool, int, float, complex, str, tuple, frozenset, bytes, None
 #      for example if we have an method like def add_node(self, title: str, call_index: int):
 #          throw an exception if the type of the value passed in is not the same as the one defined in the method
 
-class Kwargs_To_Self:
+class Type_Safe:
 
     def __init__(self, **kwargs):
         """
@@ -82,8 +83,8 @@ class Kwargs_To_Self:
                 if value is not None:                                   # prevent None values from overwriting existing values, which is quite common in default constructors
                     setattr(self, key, value)
             else:
-                raise Exception(f"{self.__class__.__name__} has no attribute '{key}' and cannot be assigned the value '{value}'. "
-                                f"Use {self.__class__.__name__}.__default_kwargs__() see what attributes are available")
+                raise ValueError(f"{self.__class__.__name__} has no attribute '{key}' and cannot be assigned the value '{value}'. "
+                                 f"Use {self.__class__.__name__}.__default_kwargs__() see what attributes are available")
 
     def __enter__(self): return self
     def __exit__(self, exc_type, exc_val, exc_tb): pass
@@ -92,23 +93,19 @@ class Kwargs_To_Self:
         if not hasattr(self, '__annotations__'):                    # can't do type safety checks if the class does not have annotations
             return super().__setattr__(name, value)
 
-            # if self.__type_safety__:
-        #     if self.__lock_attributes__:
-            # todo: this can't work on all, current hypothesis is that this will work for the values that are explicitly set
-            # if not hasattr(self, name):
-            #     raise AttributeError(f"'[Object Locked] Current object is locked (with __lock_attributes__=True) which prevents new attributes allocations (i.e. setattr calls). In this case  {type(self).__name__}' object has no attribute '{name}'") from None
-
         if value is not None:
+            if type(value) is dict:
+                value = convert_dict_to_value_from_obj_annotation(self, name, value)
             check_1 = value_type_matches_obj_annotation_for_attr      (self, name, value)
             check_2 = value_type_matches_obj_annotation_for_union_attr(self, name, value)
             if (check_1 is False and check_2 is None  or
                 check_1 is None  and check_2 is False or
                 check_1 is False and check_2 is False   ):          # fix for type safety assigment on Union vars
-                raise Exception(f"Invalid type for attribute '{name}'. Expected '{self.__annotations__.get(name)}' but got '{type(value)}'")
+                raise ValueError(f"Invalid type for attribute '{name}'. Expected '{self.__annotations__.get(name)}' but got '{type(value)}'")
         else:
             if hasattr(self, name) and self.__annotations__.get(name) :     # don't allow previously set variables to be set to None
                 if getattr(self, name) is not None:                         # unless it is already set to None
-                    raise Exception(f"Can't set None, to a variable that is already set. Invalid type for attribute '{name}'. Expected '{self.__annotations__.get(name)}' but got '{type(value)}'")
+                    raise ValueError(f"Can't set None, to a variable that is already set. Invalid type for attribute '{name}'. Expected '{self.__annotations__.get(name)}' but got '{type(value)}'")
 
         super().__setattr__(name, value)
 
@@ -145,13 +142,13 @@ class Kwargs_To_Self:
                         if var_value is not None:                                                                   # allow None assignments on ctor since that is a valid use case
                             if var_type and not isinstance(var_value, var_type):                                    # check type
                                 exception_message = f"variable '{var_name}' is defined as type '{var_type}' but has value '{var_value}' of type '{type(var_value)}'"
-                                raise Exception(exception_message)
+                                raise ValueError(exception_message)
                             if var_type not in immutable_types and var_name.startswith('__') is False:              # if var_type is not one of the immutable_types or is an __ internal
                                 #todo: fix type safety bug that I believe is caused here
                                 if obj_is_type_union_compatible(var_type, immutable_types) is False:                # if var_type is not something like Optional[Union[int, str]]
                                     if type(var_type) not in immutable_types:
                                         exception_message = f"variable '{var_name}' is defined as type '{var_type}' which is not supported by Kwargs_To_Self, with only the following immutable types being supported: '{immutable_types}'"
-                                        raise Exception(exception_message)
+                                        raise ValueError(exception_message)
             if include_base_classes is False:
                 break
         return kwargs
@@ -251,14 +248,14 @@ class Kwargs_To_Self:
             if value is not None:
                 if hasattr(self,'__annotations__'):  # can only do type safety checks if the class does not have annotations
                     if value_type_matches_obj_annotation_for_attr(self, key, value) is False:
-                        raise Exception(f"Invalid type for attribute '{key}'. Expected '{self.__annotations__.get(key)}' but got '{type(value)}'")
+                        raise ValueError(f"Invalid type for attribute '{key}'. Expected '{self.__annotations__.get(key)}' but got '{type(value)}'")
                 setattr(self, key, value)
         return self
 
 
     def deserialize_from_dict(self, data):
         for key, value in data.items():
-            if hasattr(self, key) and isinstance(getattr(self, key), Kwargs_To_Self):
+            if hasattr(self, key) and isinstance(getattr(self, key), Type_Safe):
                 getattr(self, key).deserialize_from_dict(value)                         # Recursive call for complex nested objects
             else:
                 if hasattr(self, '__annotations__'):  # can only do type safety checks if the class does not have annotations

{osbot_utils-1.30.0 → osbot_utils-1.32.0}/osbot_utils/testing/Catch.py

@@ -42,7 +42,7 @@ class Catch:
         if self.expected_error:
             self.assert_error_is(self.expected_error)
         if self.expect_exception and exception_type is None:
-            raise Exception(f'Expected exception: {self.expected_error} but no exception was raised')
+            raise ValueError(f'Expected exception: {self.expected_error} but no exception was raised')
         if self.catch_exception:
             return True     # returning true here will prevent the exception to be propagated (which is the objective of this class :) )
         return False

{osbot_utils-1.30.0 → osbot_utils-1.32.0}/osbot_utils/utils/Env.py

@@ -6,14 +6,28 @@ from osbot_utils.utils.Files    import all_parent_folders, file_exists
 from osbot_utils.utils.Misc     import list_set
 from osbot_utils.utils.Str      import strip_quotes
 
-def env__home_root():                           # todo: this should be refatored to be env__home__is__root
+
+def env__home():
+    return get_env('HOME', '')
+
+def env__home__is__root():
     return os.getenv('HOME') == '/root'
 
-def env__terminal_xterm():                      # todo: this should be refatored to be env__terminal__is__xterm
+def env__old_pwd():
+    return get_env('OLDPWD', '')
+
+def env__pwd():
+    return get_env('PWD', '')
+
+def env__old_pwd__remove(value):
+    return value.replace(env__old_pwd(), '')
+
+def env__terminal__is__xterm():
     return os.getenv('TERM') == 'xterm'
 
-def env__not_terminal_xterm():
-    return not env__terminal_xterm()
+def env__terminal__is_not__xterm():
+    return not env__terminal__is__xterm()
+
 
 def platform_darwin():
     return platform == 'darwin'
@@ -21,6 +35,10 @@ def platform_darwin():
 def env_value(var_name):
     return env_vars().get(var_name, None)
 
+def env_var_set(var_name):
+    value = os.getenv(var_name)
+    return value is not None and value != ''
+
 def env_vars_list():
     return list_set(env_vars())
 
@@ -109,6 +127,6 @@ def unload_dotenv(dotenv_path=None):
                 env_unload_from_file(env_path)                      # Process it
                 break                                               # Stop after unloading the first .env file
 
-
-env_load = load_dotenv
-get_env  = os.getenv
+is_env_var_set = env_var_set
+env_load       = load_dotenv
+get_env        = os.getenv

{osbot_utils-1.30.0 → osbot_utils-1.32.0}/osbot_utils/utils/Files.py

@@ -340,6 +340,8 @@ class Files:
     def parent_folder_combine(file, path):
         return Files.path_combine(os.path.dirname(file),path)
 
+
+
     @staticmethod
     def pickle_save_to_file(object_to_save, path=None):
         path = path or temp_file(extension=".pickle")
@@ -491,12 +493,26 @@ def folders_names_in_folder(target):
     folders = folders_in_folder(target)
     return folders_names(folders)
 
+def path_combine_safe(base_path, file_location, raise_exception=False):                                  # handle possible directory transversal attacks
+    full_path            = os.path.join(base_path, file_location)                                       # Combine and normalize paths
+    normalised_base_path = os.path.normpath(base_path)
+    normalised_full_path = os.path.normpath(full_path)
+
+    if os.path.commonpath([normalised_base_path, normalised_full_path]) == normalised_base_path:        # Check for directory traversal
+        return normalised_full_path
+    if raise_exception:
+        raise ValueError("Invalid file location: directory traversal attempt detected.")
+    return None
+
 def parent_folder_create(target):
     return folder_create(parent_folder(target))
 
 def parent_folder_exists(target):
     return folder_exists(parent_folder(target))
 
+def parent_folder_name(target):
+    return folder_name(parent_folder(target))
+
 def parent_folder_not_exists(target):
     return parent_folder_exists(target) is False
 

{osbot_utils-1.30.0 → osbot_utils-1.32.0}/osbot_utils/utils/Http.py

@@ -22,6 +22,13 @@ def current_host_online(url_to_use=URL_CHECK_HOST_ONLINE):
 def dns_ip_address(host):
     return socket.gethostbyname(host)
 
+def is_url_online(target):
+    try:
+        http_request(target, method='HEAD')
+        return True
+    except:
+        return False
+
 def is_port_open(host, port, timeout=0.5):
     return port_is_open(host=host, port=port, timeout=timeout)
 

{osbot_utils-1.30.0 → osbot_utils-1.32.0}/osbot_utils/utils/Objects.py

@@ -69,6 +69,9 @@ def base_classes(cls):
         target = type(cls)
     return type_base_classes(target)
 
+def base_classes_names(cls):
+    return [cls.__name__ for cls in base_classes(cls)]
+
 def class_functions_names(target):
     return list_set(class_functions(target))
 
@@ -89,6 +92,17 @@ def class_full_name(target):
         type_name   = type_target.__name__
         return f'{type_module}.{type_name}'
 
+def convert_dict_to_value_from_obj_annotation(target, attr_name, value):
+    if target is not None and attr_name is not None:
+        if hasattr(target, '__annotations__'):
+            obj_annotations  = target.__annotations__
+            if hasattr(obj_annotations,'get'):
+                attribute_annotation = obj_annotations.get(attr_name)
+                if 'Type_Safe' in base_classes_names(attribute_annotation):
+                    return attribute_annotation(**value)
+    return value
+
+
 def default_value(target : type):
     try:
         return target()                 #  try to create the object using the default constructor

osbot_utils-1.32.0/osbot_utils/version

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

{osbot_utils-1.30.0 → osbot_utils-1.32.0}/pyproject.toml

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

osbot_utils-1.30.0/osbot_utils/base_classes/Type_Safe.py

@@ -1,6 +0,0 @@
-from osbot_utils.base_classes.Kwargs_To_Self import Kwargs_To_Self
-
-# todo: refactor all of Kwargs_To_Self into this class (in a way to minimize the side effects, since
-#        Kwargs_To_Self is used in many places in the codebase)
-
-Type_Safe = Kwargs_To_Self

osbot_utils-1.30.0/osbot_utils/version

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