osbot-utils 1.48.0__tar.gz → 1.50.0__tar.gz

{osbot_utils-1.48.0 → osbot_utils-1.50.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: osbot_utils
-Version: 1.48.0
+Version: 1.50.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.48.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.50.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.48.0 → osbot_utils-1.50.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.48.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.50.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.48.0 → osbot_utils-1.50.0}/osbot_utils/helpers/flows/Flow.py

@@ -1,3 +1,4 @@
+import asyncio
 import logging
 import typing
 
@@ -8,6 +9,7 @@ from osbot_utils.testing.Stdout         import Stdout
 from osbot_utils.utils.Misc             import random_id, lower
 from osbot_utils.utils.Python_Logger    import Python_Logger
 from osbot_utils.utils.Str              import ansis_to_texts
+from osbot_utils.utils.Threads import invoke_async, invoke_in_new_event_loop
 
 FLOW__RANDOM_ID__PREFIX    = 'flow_id__'
 FLOW__RANDOM_NAME__PREFIX  = 'flow_name__'
@@ -29,9 +31,6 @@ class Flow(Type_Safe):
     flow_return_value  : typing.Any
     logger             : Python_Logger
     cformat            : CFormat
-    #log_to_console     : bool    = False
-    #log_to_memory      : bool    = True
-    #print_logs         : bool    = False
     executed_tasks     : typing.List
 
 
@@ -61,7 +60,7 @@ class Flow(Type_Safe):
         self.debug(f"Executing flow run '{self.f__flow_id()}''")
         try:
             with Stdout() as stdout:
-                self.flow_return_value = self.flow_target(*self.flow_args, **self.flow_kwargs)           # todo, capture *args, **kwargs in logs
+                self.invoke_flow_target()
         except Exception as error:
             self.flow_error = error
             self.logger.error(self.cformat.red(f"Error executing flow: {error}"))
@@ -87,6 +86,13 @@ class Flow(Type_Safe):
     def info(self, message):
         self.logger.info(message)
 
+    def invoke_flow_target(self):
+        if asyncio.iscoroutinefunction(self.flow_target):
+            #self.flow_return_value = invoke_async(self.flow_target(*self.flow_args, **self.flow_kwargs))
+            self.flow_return_value = invoke_in_new_event_loop(self.flow_target(*self.flow_args, **self.flow_kwargs))
+        else:
+            self.flow_return_value = self.flow_target(*self.flow_args, **self.flow_kwargs)
+
     def log_captured_stdout(self, stdout):
         for line in stdout.value().splitlines():
             if line:

{osbot_utils-1.48.0 → osbot_utils-1.50.0}/osbot_utils/helpers/flows/Task.py

@@ -1,3 +1,4 @@
+import asyncio
 import inspect
 import typing
 
@@ -10,12 +11,13 @@ from osbot_utils.base_classes.Type_Safe     import Type_Safe
 from osbot_utils.helpers.flows.Flow         import Flow
 
 
-
 class Task(Type_Safe):
     data                : dict                          # dict available to the task to add and collect data
     task_id             : str                           # todo add a random Id value to this
     task_name           : str                           # make this the function mame
     cformat             : CFormat
+    resolved_args       : tuple
+    resolved_kwargs     : dict
     task_target         : callable                      # todo refactor this to to Task__Function class
     task_args           : tuple
     task_kwargs         : dict
@@ -24,7 +26,17 @@ class Task(Type_Safe):
     task_error          : Exception  = None
     raise_on_error      : bool       = True
 
-    def execute(self):
+    def execute__sync(self):
+        self.execute__before()
+        self.execute__task_target__sync()
+        return self.execute__after()
+
+    async def execute__async(self):
+        self.execute__before()
+        await self.execute__task_target__async()
+        return self.execute__after()
+
+    def execute__before(self):
         self.task_flow = self.find_flow()
         if self.task_flow is None:
             raise Exception("No Flow found for Task")
@@ -34,14 +46,30 @@ class Task(Type_Safe):
 
         self.task_flow.executed_tasks.append(self)
         self.task_flow.logger.debug(f"Executing task '{f_blue(self.task_name)}'")
+        dependency_manager = Dependency_Manager()
+        dependency_manager.add_dependency('this_task', self               )
+        dependency_manager.add_dependency('this_flow', self.task_flow     )
+        dependency_manager.add_dependency('task_data', self.data          )
+        dependency_manager.add_dependency('flow_data', self.task_flow.data)
+        self.resolved_args, self.resolved_kwargs = dependency_manager.resolve_dependencies(self.task_target, *self.task_args, **self.task_kwargs)
 
+    def execute__task_target__sync(self):
         try:
             with Stdout() as stdout:
-                self.invoke_task_target()
+                self.task_return_value =  self.task_target(*self.resolved_args, **self.resolved_kwargs)
         except Exception as error:
             self.task_error = error
+        self.task_flow.log_captured_stdout(stdout)
 
+    async def execute__task_target__async(self):
+        try:
+            with Stdout() as stdout:
+                self.task_return_value =  await self.task_target(*self.resolved_args, **self.resolved_kwargs)
+        except Exception as error:
+            self.task_error = error
         self.task_flow.log_captured_stdout(stdout)
+
+    def execute__after(self):
         self.print_task_return_value()
 
         if self.task_error:
@@ -52,14 +80,6 @@ class Task(Type_Safe):
         self.print_task_finished_message()
         return self.task_return_value
 
-    def invoke_task_target(self):
-        dependency_manager = Dependency_Manager()
-        dependency_manager.add_dependency('this_task', self               )
-        dependency_manager.add_dependency('this_flow', self.task_flow     )
-        dependency_manager.add_dependency('task_data', self.data          )
-        dependency_manager.add_dependency('flow_data', self.task_flow.data)
-        resolved_args, resolved_kwargs = dependency_manager.resolve_dependencies(self.task_target, *self.task_args, **self.task_kwargs)
-        self.task_return_value =  self.task_target(*resolved_args, **resolved_kwargs)
 
     def find_flow(self):
         stack = inspect.stack()

osbot_utils-1.50.0/osbot_utils/helpers/flows/decorators/task.py

@@ -0,0 +1,23 @@
+from functools import wraps
+import asyncio
+from osbot_utils.helpers.flows.Task import Task
+
+
+def task(**task_kwargs):
+    def decorator(function):
+        @wraps(function)
+        async def async_wrapper(*args, **kwargs):
+            with Task(task_target=function, task_args=args, task_kwargs=kwargs, **task_kwargs) as _:
+                return await _.execute__async()
+
+        @wraps(function)
+        def sync_wrapper(*args, **kwargs):
+            with Task(task_target=function, task_args=args, task_kwargs=kwargs, **task_kwargs) as _:
+                return _.execute__sync()
+
+        if asyncio.iscoroutinefunction(function):
+            return async_wrapper
+        else:
+            return sync_wrapper
+
+    return decorator

{osbot_utils-1.48.0 → osbot_utils-1.50.0}/osbot_utils/utils/Threads.py

@@ -42,5 +42,18 @@ def invoke_in_new_event_loop(target: typing.Coroutine):             # Runs a cor
         result = future.result()                                    # Wait for the result of the future
         return result                                               # Return the result from the coroutine
 
+# in the use cases when I tried to use this, it hanged
+# def invoke_in_current_loop(target: typing.Coroutine):
+#     try:
+#         current_loop = asyncio.get_running_loop()   # Get the current running loop, if any
+#     except RuntimeError:                            # There is no running event loop
+#         current_loop = None
+#
+#     if current_loop and current_loop.is_running():  # If there's an event loop currently running, we can use asyncio.run_coroutine_threadsafe to run it
+#         future = asyncio.run_coroutine_threadsafe(target, current_loop)
+#         return future.result()
+#     else:
+#         return asyncio.run(target)                  # If there's no event loop running, we create a new one and use run_until_complete
+
 async_invoke_in_new_loop = invoke_in_new_event_loop
 invoke_async             = invoke_async_function                    # todo: see if this is best use of this function name

osbot_utils-1.50.0/osbot_utils/version

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

{osbot_utils-1.48.0 → osbot_utils-1.50.0}/pyproject.toml

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

osbot_utils-1.48.0/osbot_utils/helpers/flows/decorators/task.py

@@ -1,11 +0,0 @@
-from functools                      import wraps
-from osbot_utils.helpers.flows.Task import Task
-
-def task(**task_kwargs):
-    def decorator(function):
-        @wraps(function)
-        def wrapper(*args, **kwargs):
-            with Task(task_target=function, task_args=args, task_kwargs=kwargs, **task_kwargs) as _:
-                return _.execute()
-        return wrapper
-    return decorator

osbot_utils-1.48.0/osbot_utils/version

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