osbot-utils 1.54.0__tar.gz → 1.56.0__tar.gz

{osbot_utils-1.54.0 → osbot_utils-1.56.0}/PKG-INFO

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

@@ -2,14 +2,15 @@ import asyncio
 import logging
 import typing
 
-from osbot_utils.base_classes.Type_Safe import Type_Safe
-from osbot_utils.helpers.CFormat import CFormat, f_dark_grey, f_magenta, f_bold
-from osbot_utils.helpers.flows.Flow__Config import Flow__Config
-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
+from osbot_utils.base_classes.Type_Safe             import Type_Safe
+from osbot_utils.helpers.CFormat                    import CFormat, f_dark_grey, f_magenta, f_bold
+from osbot_utils.helpers.flows.models.Flow__Config  import Flow__Config
+from osbot_utils.helpers.flows.Flow__Events         import flow_events
+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_in_new_event_loop
 
 FLOW__RANDOM_ID__PREFIX    = 'flow_id__'
 FLOW__RANDOM_NAME__PREFIX  = 'flow_name__'
@@ -42,28 +43,25 @@ class Flow(Type_Safe):
             if self.flow_config.log_to_console:
                 _.add_console_logger()
 
-
-    def debug(self, message):
-        self.logger.debug(message)
-
     def create_flow(self):
         self.set_flow_name()
-        self.debug(f"Created flow run '{self.f__flow_id()}' for flow '{self.f__flow_name()}'")
+        self.log_debug(f"Created flow run '{self.f__flow_id()}' for flow '{self.f__flow_name()}'")
 
     def execute(self):
         return self.execute_flow()
 
     def execute_flow(self):
+        flow_events.on__flow__start(self)
         if self.flow_config.log_to_memory:
             self.logger.add_memory_logger()                                     # todo: move to method that does pre-execute tasks
 
-        self.debug(f"Executing flow run '{self.f__flow_id()}''")
+        self.log_debug(f"Executing flow run '{self.f__flow_id()}'")
         try:
             with Stdout() as stdout:
                 self.invoke_flow_target()
         except Exception as error:
             self.flow_error = error
-            self.logger.error(self.cformat.red(f"Error executing flow: {error}"))
+            self.log_error(self.cformat.red(f"Error executing flow: {error}"))
 
         self.log_captured_stdout        (stdout)
         self.print_flow_return_value    ()
@@ -72,6 +70,7 @@ class Flow(Type_Safe):
         if self.flow_config.log_to_memory:
             self.captured_exec_logs = self.log_messages_with_colors()
             self.logger.remove_memory_logger()                                                          # todo: move to method that does post-execute tasks
+        flow_events.on__flow__stop(self)
         return self
 
     def f__flow_id(self):
@@ -83,9 +82,6 @@ class Flow(Type_Safe):
     def captured_logs(self):
         return ansis_to_texts(self.captured_exec_logs)
 
-    def info(self, message):
-        self.logger.info(message)
-
 
     async def invoke_flow_target__thread(self, flow):                               # this is a REALLY important method which is used to pin the flow object to the call stack
         return await flow.flow_target(*flow.flow_args, **flow.flow_kwargs)          #   which is then used by the Task.find_flow method to find it
@@ -100,13 +96,36 @@ class Flow(Type_Safe):
     def log_captured_stdout(self, stdout):
         for line in stdout.value().splitlines():
             if line:
-                self.info(f_magenta(line))
+                self.log_info(f_magenta(line))
         if self.flow_config.print_logs:
             print()
             print()
             self.print_log_messages()
 
 
+    def log_debug(self, message, task_run_id=None):
+        self.logger_add_message(log_level=logging.DEBUG, message=message, task_run_id=task_run_id)
+
+    def log_error(self, message, task_run_id=None):
+        self.logger_add_message(log_level=logging.ERROR, message=message, task_run_id=task_run_id)
+
+    def log_info(self, message, task_run_id=None):
+        self.logger_add_message(log_level=logging.INFO, message=message, task_run_id=task_run_id)
+
+    def logger_add_message(self, log_level, message, task_run_id=None):
+        if self.flow_config.logging_enabled:
+            kwargs = dict(log_level   = log_level   ,
+                          message     = message     ,
+                          flow_run_id = self.flow_id,
+                          task_run_id = task_run_id )
+            flow_events.on__flow_run__message(self, **kwargs)
+            if log_level == logging.DEBUG:
+                self.logger.debug(message)
+            elif log_level == logging.ERROR:
+                self.logger.error(message)
+            else:
+                self.logger.info(message)
+
     def log_messages(self):
         return ansis_to_texts(self.log_messages_with_colors())
 
@@ -128,12 +147,12 @@ class Flow(Type_Safe):
 
     def print_flow_finished_message(self):
         if self.flow_config.print_finished_message:
-            self.debug(f"Finished flow run '{self.f__flow_id()}''")
+            self.log_debug(f"Finished flow run '{self.f__flow_id()}'")
 
     def print_flow_return_value(self):
         if self.flow_config.print_none_return_value is False and self.flow_return_value is None:
             return
-        self.debug(f"{f_dark_grey('Flow return value')}: {f_bold(self.flow_return_value)}")
+        self.log_debug(f"{f_dark_grey('Flow return value')}: {f_bold(self.flow_return_value)}")
 
 
 
@@ -170,6 +189,3 @@ class Flow(Type_Safe):
         with self as _:
             if not _.flow_id:
                 _.flow_id = self.random_flow_id()
-            #if not _.flow_name:
-            #    _.flow_name = self.flow_target.__name__
-                #self.random_flow_name()

osbot_utils-1.56.0/osbot_utils/helpers/flows/Flow__Events.py

@@ -0,0 +1,45 @@
+from osbot_utils.utils.Str import ansis_to_texts, ansi_to_text
+
+from osbot_utils.utils.Dev import pprint
+
+from osbot_utils.base_classes.Type_Safe                 import Type_Safe
+from osbot_utils.helpers.flows.models.Flow__Event       import Flow__Event
+from osbot_utils.helpers.flows.models.Flow__Event_Type  import Flow__Event_Type
+
+
+class Flow_Events(Type_Safe):
+    event_listeners : list
+
+    def on__flow__start(self, flow):
+        flow_event = Flow__Event(event_type=Flow__Event_Type.FLOW_START, event_source=flow)
+        self.raise_event(flow_event)
+
+    def on__flow__stop(self, flow):                                                         # todo: see of flow_ended or flow_completed are better names
+        flow_event = Flow__Event(event_type=Flow__Event_Type.FLOW_STOP , event_source=flow)
+        self.raise_event(flow_event)
+
+    def on__flow_run__message(self, flow, log_level, flow_run_id, task_run_id, message):
+        event_data = dict(flow_run_id  = flow_run_id           ,
+                          log_level    = log_level             ,
+                          message      = message               ,
+                          message_text = ansi_to_text(message) ,
+                          task_run_id = task_run_id            )
+        flow_event = Flow__Event(event_type=Flow__Event_Type.FLOW_MESSAGE, event_source=flow, event_data=event_data)
+        self.raise_event(flow_event)
+
+    def on__task__start(self, task):
+        flow_event = Flow__Event(event_type=Flow__Event_Type.TASK_START, event_source=task)
+        self.raise_event(flow_event)
+
+    def on__task__stop(self, task):                                                         # todo: see of flow_ended or flow_completed are better names
+        flow_event = Flow__Event(event_type=Flow__Event_Type.TASK_STOP , event_source=task)
+        self.raise_event(flow_event)
+
+    def raise_event(self, flow_event):
+        for listener in self.event_listeners:
+            try:
+                listener(flow_event)
+            except Exception as error:
+                print(f"Error in listener: {error}")
+
+flow_events = Flow_Events()

{osbot_utils-1.54.0 → osbot_utils-1.56.0}/osbot_utils/helpers/flows/Task.py

@@ -2,18 +2,19 @@ import asyncio
 import inspect
 import typing
 
+from osbot_utils.utils.Misc                 import random_id, lower
 from osbot_utils.helpers.Dependency_Manager import Dependency_Manager
-from osbot_utils.utils.Dev import pprint
-
+from osbot_utils.helpers.flows.Flow__Events import flow_events
 from osbot_utils.testing.Stdout             import Stdout
 from osbot_utils.helpers.CFormat            import CFormat, f_dark_grey, f_red, f_blue, f_bold
 from osbot_utils.base_classes.Type_Safe     import Type_Safe
 from osbot_utils.helpers.flows.Flow         import Flow
 
+TASK__RANDOM_ID__PREFIX    = 'task_id__'
 
 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_id             : str
     task_name           : str                           # make this the function mame
     cformat             : CFormat
     resolved_args       : tuple
@@ -26,6 +27,15 @@ class Task(Type_Safe):
     task_error          : Exception  = None
     raise_on_error      : bool       = True
 
+    def log_info(self, message):
+        self.task_flow.log_info(message, self.task_id)
+
+    def log_debug(self, message):
+        self.task_flow.log_debug(message, self.task_id)
+
+    def log_error(self, message):
+        self.task_flow.log_error(message, self.task_id)
+
     def execute__sync(self):
         self.execute__before()
         self.execute__task_target__sync()
@@ -44,8 +54,13 @@ class Task(Type_Safe):
         if not self.task_name and self.task_target:
             self.task_name = self.task_target.__name__
 
+        if not self.task_id:
+            self.task_id = self.random_task_id()
+
+        flow_events.on__task__start(self)
+
         self.task_flow.executed_tasks.append(self)
-        self.task_flow.logger.debug(f"Executing task '{f_blue(self.task_name)}'")
+        self.log_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     )
@@ -53,6 +68,7 @@ class Task(Type_Safe):
         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:
@@ -73,11 +89,13 @@ class Task(Type_Safe):
         self.print_task_return_value()
 
         if self.task_error:
-            self.task_flow.logger.error(f_red(f"Error executing '{self.task_name}' task: {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")
 
         self.print_task_finished_message()
+
+        flow_events.on__task__stop(self)
         return self.task_return_value
 
 
@@ -92,12 +110,14 @@ class Task(Type_Safe):
 
     def print_task_finished_message(self):
         if self.task_flow.flow_config.print_finished_message:
-            self.task_flow.logger.debug(f"Finished task '{f_blue(self.task_name)}'")
+            self.log_debug(f"Finished task '{f_blue(self.task_name)}'")
 
     def print_task_return_value(self):
         flow_config = self.task_flow.flow_config
         if flow_config.print_none_return_value is False and self.task_return_value is None:
             return
-        self.task_flow.logger.debug(f"{f_dark_grey('Task return value')}: {f_bold(self.task_return_value)}")
+        self.log_debug(f"{f_dark_grey('Task return value')}: {f_bold(self.task_return_value)}")
 
 
+    def random_task_id(self):
+        return lower(random_id(prefix=TASK__RANDOM_ID__PREFIX))

{osbot_utils-1.54.0/osbot_utils/helpers/flows → osbot_utils-1.56.0/osbot_utils/helpers/flows/models}/Flow__Config.py

@@ -5,6 +5,7 @@ class Flow__Config(Type_Safe):
     add_task_to_self       : bool = True
     log_to_console         : bool = False
     log_to_memory          : bool = True
+    logging_enabled        : bool = True
     print_logs             : bool = False
     print_none_return_value: bool = False
     print_finished_message : bool = False

osbot_utils-1.56.0/osbot_utils/helpers/flows/models/Flow__Event.py

@@ -0,0 +1,6 @@
+from osbot_utils.base_classes.Type_Safe import Type_Safe
+
+class Flow__Event(Type_Safe):
+    event_type  : str
+    event_source: object
+    event_data  : dict

osbot_utils-1.56.0/osbot_utils/helpers/flows/models/Flow__Event_Type.py

@@ -0,0 +1,8 @@
+from osbot_utils.base_classes.Type_Safe import Type_Safe
+
+class Flow__Event_Type(Type_Safe):
+    FLOW_MESSAGE: str = 'flow_message'
+    FLOW_START  : str = 'flow_start'
+    FLOW_STOP   : str = 'flow_stop'
+    TASK_START  : str = 'task_start'
+    TASK_STOP   : str = 'task_stop'

osbot_utils-1.56.0/osbot_utils/version

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

{osbot_utils-1.54.0 → osbot_utils-1.56.0}/pyproject.toml

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

osbot_utils-1.54.0/osbot_utils/version

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