osbot-utils 2.22.0__tar.gz → 2.24.0__tar.gz

{osbot_utils-2.22.0 → osbot_utils-2.24.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: osbot_utils
-Version: 2.22.0
+Version: 2.24.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.22.0-blue)
+![Current Release](https://img.shields.io/badge/release-v2.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-2.22.0 → osbot_utils-2.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-v2.22.0-blue)
+![Current Release](https://img.shields.io/badge/release-v2.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-2.22.0 → osbot_utils-2.24.0}/osbot_utils/helpers/flows/Flow.py

@@ -41,6 +41,7 @@ class Flow(Type_Safe):
     executed_tasks     : typing.List
     resolved_args      : tuple
     resolved_kwargs    : dict
+    setup_completed    : bool
 
     def add_flow_artifact(self, description=None, key=None, data=None, artifact_type=None):     # todo: figure out how to make this work since at the moment most are showing an unknown type
         event_data = Flow_Run__Event_Data()
@@ -64,6 +65,10 @@ class Flow(Type_Safe):
         flow_events.on__new_result(event_data)
         self.flow_data.add_result(key, description)
 
+    def check_setup(self):
+        if self.setup_completed is False:
+            raise ValueError("Error starting Flow, setup has not been called, use .setup(target, *args, **kwargs) to configure it")
+
     def config_logger(self):
         with self.logger as _:
             _.set_log_level(logging.DEBUG)
@@ -75,6 +80,7 @@ class Flow(Type_Safe):
         return self.execute_flow()
 
     def execute_flow(self, flow_run_params=None):                               # todo: see if it makes more sense to call this start_flow_run
+        self.check_setup()
         flow_events.on__flow__start(self.flow_event_data())
         self.log_debug(f"Created flow run '{self.f__flow_id()}' for flow '{self.f__flow_name()}'")
         self.set_flow_run_params(flow_run_params)
@@ -240,7 +246,13 @@ class Flow(Type_Safe):
             self.log_info(f"flow_run_params: {flow_run_params}")
             self.add_flow_artifact(description="Data received via FastAPI's request.json()", key='post-data', data=flow_run_params)
 
-    def setup(self, target, *args, **kwargs):
+    def main(self, *args, **kwargs):         # method to be overwritten by implementing classes
+        pass
+
+    def setup(self, target=None, *args, **kwargs):
+        if target is None:
+            target = self.main
+
         with self as _:
             _.cformat.auto_bold = True
             _.set_flow_target (target, *args, **kwargs)
@@ -250,6 +262,7 @@ class Flow(Type_Safe):
             _.flow_data.set_flow_id  (self.flow_id)
             _.flow_data.set_flow_name(self.flow_name)
             _.add_event_listener()
+            _.setup_completed = True
         return self
 
     def setup_flow_run(self):

{osbot_utils-2.22.0 → osbot_utils-2.24.0}/osbot_utils/helpers/flows/Task.py

@@ -103,7 +103,7 @@ class Task(Type_Safe):
         if self.task_error:
             self.log_error(f_red(f"Error executing '{self.task_name}' task: {self.task_error}"))
             if self.raise_on_error:
-                raise Exception(f"'{self.task_name}' failed and task raise_on_error was set to True. Stopping flow execution")
+                raise Exception(f"'{self.task_name}' failed and task raise_on_error was set to True. Stopping flow execution", self.task_error)
 
         self.print_task_finished_message()
 
@@ -116,7 +116,7 @@ class Task(Type_Safe):
         for frame_info in stack:
             frame = frame_info.frame
             for var_name, var_value in list(frame.f_locals.items()):                      # Check all local variables in the frame
-                if type(var_value) is Flow:
+                if isinstance(var_value, Flow):
                     return var_value
         return None
 

{osbot_utils-2.22.0 → osbot_utils-2.24.0}/osbot_utils/helpers/flows/decorators/task.py

@@ -1,5 +1,5 @@
-from functools import wraps
 import asyncio
+from functools                      import wraps
 from osbot_utils.helpers.flows.Task import Task
 
 

osbot_utils-2.24.0/osbot_utils/type_safe/shared/Type_Safe__Json_Compressor.py

@@ -0,0 +1,119 @@
+from typing                                                                 import Dict, Any, Type
+from osbot_utils.type_safe.Type_Safe__Base                                  import Type_Safe__Base
+from osbot_utils.type_safe.Type_Safe                                        import Type_Safe
+from osbot_utils.type_safe.shared.Type_Safe__Cache                          import type_safe_cache
+from osbot_utils.type_safe.shared.Type_Safe__Json_Compressor__Type_Registry import Type_Safe__Json_Compressor__Type_Registry
+from osbot_utils.utils.Objects                                              import class_full_name
+
+class Type_Safe__Json_Compressor(Type_Safe__Base):
+
+    def __init__(self):
+        self.type_registry = Type_Safe__Json_Compressor__Type_Registry()
+
+    def compress(self, data: dict) -> dict:
+        if not data:
+            return data
+
+        self.type_registry.clear()
+        compressed = self.compress_object(data)
+
+        if self.type_registry.registry:
+            return { "_type_registry": self.type_registry.reverse,
+                     **compressed                                 }
+        return compressed
+
+    def compress_object(self, obj: Any) -> Any:
+        if isinstance(obj, Type_Safe):
+            annotations = type_safe_cache.get_obj_annotations(obj)
+            return self.process_type_safe_object(obj, annotations)
+        elif isinstance(obj, dict):
+            return self.compress_dict(obj)
+        elif isinstance(obj, list):
+            return [self.compress_object(item) for item in obj]
+        elif isinstance(obj, tuple):
+            return tuple(self.compress_object(item) for item in obj)
+        elif isinstance(obj, set):
+            return {self.compress_object(item) for item in obj}
+        return obj
+
+    def process_type_safe_object(self, obj        : Type_Safe ,
+                                       annotations: Dict
+                                  ) -> Dict:
+        result = {}
+        for key, value in obj.__dict__.items():
+            if key.startswith('_'):                                            # Skip internal attributes
+                continue
+            if key in annotations:
+                annotation  = annotations[key]
+                result[key] = self.compress_annotated_value(value, annotation)
+            else:
+                result[key] = self.compress_object(value)
+        return result
+
+    def compress_annotated_value(self, value      : Any ,
+                                       annotation : Any
+                                  ) -> Any:
+        origin = type_safe_cache.get_origin(annotation)
+        if origin in (type, Type):                                            # Handle Type annotations
+            if value:
+                return self.type_registry.register_type(class_full_name(value))
+            return None
+        elif origin is dict:                                                  # Handle Dict annotations
+            return self.compress_dict(value)
+        elif origin in (list, tuple, set):                                    # Handle sequence annotations
+            return self.compress_sequence(value)
+        elif isinstance(value, Type_Safe):                                    # Handle nested Type_Safe objects
+            return self.compress_object(value)
+        return value
+
+    def compress_dict(self, data: Dict) -> Dict:
+        if not isinstance(data, dict):
+            return data
+
+        result = {}
+        for key, value in data.items():
+            compressed_key         = self.compress_object(key) if isinstance(key, Type_Safe) else key
+            compressed_value       = self.compress_object(value)
+            result[compressed_key] = compressed_value
+        return result
+
+    def compress_sequence(self, sequence: Any) -> Any:
+        if isinstance(sequence, (list, tuple, set)):
+            compressed = [self.compress_object(item) for item in sequence]
+            if isinstance(sequence, list):
+                return compressed
+            elif isinstance(sequence, tuple):
+                return tuple(compressed)
+            else:
+                return set(compressed)
+        return sequence
+
+    def decompress(self, data: dict) -> dict:
+        if not data or "_type_registry" not in data:
+            return data
+
+        registry = data.pop("_type_registry")
+        return self.expand_types(data.copy(), registry)
+
+    def expand_types(self, obj         : Any            ,
+                           type_lookup : Dict[str, str]
+                      ) -> Any:
+        if isinstance(obj, dict):
+            return {k: self.expand_value(v, type_lookup) for k, v in obj.items()}
+        elif isinstance(obj, list):
+            return [self.expand_types(item, type_lookup) for item in obj]
+        elif isinstance(obj, tuple):
+            return tuple(self.expand_types(item, type_lookup) for item in obj)
+        elif isinstance(obj, set):
+            return {self.expand_types(item, type_lookup) for item in obj}
+        return obj
+
+    def expand_value(self, value       : Any           ,
+                           type_lookup : Dict[str, str]
+                      ) -> Any:
+        if isinstance(value, str) and value.startswith('@'):
+            return type_lookup.get(value, value)
+        return self.expand_types(value, type_lookup)
+
+    def register_type(self, type_path: str) -> str:
+        return self.type_registry.register_type(type_path)

osbot_utils-2.24.0/osbot_utils/type_safe/shared/Type_Safe__Json_Compressor__Type_Registry.py

@@ -0,0 +1,39 @@
+from typing import Dict, Optional
+
+
+class Type_Safe__Json_Compressor__Type_Registry:
+
+    registry : Dict[str, str]
+    reverse  : Dict[str, str]
+
+    def __init__(self):
+        self.registry = {}
+        self.reverse = {}
+
+    def create_reference_name(self, type_path: str) -> str:
+        parts      = type_path.split('.')
+        class_name = parts[-1]
+        parts     = class_name.split('__')
+
+        if len(parts) > 1:
+            name_parts = []
+            for part in parts:
+                name_parts.append(part.lower())
+            return f"@{'_'.join(name_parts)}"
+
+        return f"@{class_name.lower()}"
+
+    def register_type(self, type_path: str)-> str:
+        if type_path not in self.registry:
+            ref                      = self.create_reference_name(type_path)
+            self.registry[type_path] = ref
+            self.reverse[ref]        = type_path
+            return ref
+        return self.registry[type_path]
+
+    def get_type(self, ref: str) -> Optional[str]:
+        return self.reverse.get(ref)
+
+    def clear(self):
+        self.registry.clear()
+        self.reverse.clear()

{osbot_utils-2.22.0 → osbot_utils-2.24.0}/osbot_utils/type_safe/steps/Type_Safe__Step__From_Json.py

@@ -137,7 +137,13 @@ class Type_Safe__Step__From_Json:
         new_value   = Type_Safe__Dict(expected_key_type=key_class, expected_value_type=value_class)
 
         for dict_key, dict_value in value.items():
-            if issubclass(key_class, Type_Safe):
+            key_origin = type_safe_cache.get_origin(key_class)
+            if key_origin is type:
+                expected_dict_type = get_args(key_class)[0]
+                if dict_key != expected_dict_type and not issubclass(dict_key,expected_dict_type):
+                    raise TypeError(f"Expected {expected_dict_type} class for key but got instance: {dict_key}")
+                new__dict_key = get_args(key_class)[0]
+            elif issubclass(key_class, Type_Safe):
                 new__dict_key = self.deserialize_from_dict(key_class(), dict_key)
             else:
                 new__dict_key = key_class(dict_key)

{osbot_utils-2.22.0 → osbot_utils-2.24.0}/osbot_utils/utils/Objects.py

@@ -273,7 +273,7 @@ def serialize_to_dict(obj):
     from enum    import Enum
     from typing  import List
 
-    if isinstance(obj, (str, int, float, bool, bytes, Decimal)) or obj is None:
+    if isinstance(obj, (str, int, float, bool, bytes, Decimal)) or obj is None:     # todo: add support for objects like datetime
         return obj
     elif isinstance(obj, Enum):
         return obj.name

osbot_utils-2.24.0/osbot_utils/version

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

{osbot_utils-2.22.0 → osbot_utils-2.24.0}/pyproject.toml

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

osbot_utils-2.22.0/osbot_utils/version

@@ -1 +0,0 @@
-v2.22.0