osbot-utils 1.54.0__py3-none-any.whl → 1.55.0__py3-none-any.whl

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,12 +96,23 @@ 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):
+        if self.flow_config.logging_enabled:
+            self.logger.debug(message)
+
+    def log_error(self, message):
+        if self.flow_config.logging_enabled:
+            self.logger.error(message)
+
+    def log_info(self, message):
+        if self.flow_config.logging_enabled:
+            self.logger.info(message)
 
     def log_messages(self):
         return ansis_to_texts(self.log_messages_with_colors())
@@ -128,12 +135,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 +177,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/helpers/flows/Flow__Events.py

@@ -0,0 +1,32 @@
+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__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/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,12 @@ class Task(Type_Safe):
     task_error          : Exception  = None
     raise_on_error      : bool       = True
 
+    def log_debug(self, message):
+        self.task_flow.log_debug(message)
+
+    def log_error(self, message):
+        self.task_flow.log_error(message)
+
     def execute__sync(self):
         self.execute__before()
         self.execute__task_target__sync()
@@ -44,14 +51,18 @@ 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()
+
         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     )
         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)
+        flow_events.on__task__start(self)
 
     def execute__task_target__sync(self):
         try:
@@ -73,11 +84,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 +105,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/helpers/flows/{Flow__Config.py → 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/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/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_START : str = 'flow_start'
+    FLOW_STOP  : str = 'flow_stop'
+    TASK_START : str = 'task_start'
+    TASK_STOP  : str = 'task_stop'

osbot_utils/version

@@ -1 +1 @@
-v1.54.0
+v1.55.0

{osbot_utils-1.54.0.dist-info → osbot_utils-1.55.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: osbot_utils
-Version: 1.54.0
+Version: 1.55.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.55.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.dist-info → osbot_utils-1.55.0.dist-info}/RECORD

@@ -154,13 +154,17 @@ osbot_utils/helpers/cache_requests/Cache__Requests__Row.py,sha256=h-yc7NkpScbHww
 osbot_utils/helpers/cache_requests/Cache__Requests__Table.py,sha256=RgxAYhm-FIrXXteQRtD91pOLq8JXhSzxb51Jb6MTUdY,391
 osbot_utils/helpers/cache_requests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 osbot_utils/helpers/cache_requests/flows/flow__Cache__Requests.py,sha256=xgx_oExxkcvRwQN1UCobimECIMUKGoIX5oGdCmp8Nyw,243
-osbot_utils/helpers/flows/Flow.py,sha256=gGvbG2LQjzZ_Sf2wPneHmJco1pv9ejXes5Z0gmWQQxk,6541
-osbot_utils/helpers/flows/Flow__Config.py,sha256=PE8hH8KXDHz1Ex93cPMuR9nkv8AoXzXQwVxleSDkU7k,341
-osbot_utils/helpers/flows/Task.py,sha256=b-EKKM4ZEXQcNDOjWHLcxkC0orhIxCOYs7Ij2aCsE7Y,4265
+osbot_utils/helpers/flows/Flow.py,sha256=unjYDAsdGqWuEC6sODmcKCDZU8fHnH-CkbmANMGYpa0,6898
+osbot_utils/helpers/flows/Flow__Events.py,sha256=CS93ohhQ_P7sKr0R4vI2-72uiDQa0pIUEz5Lxam3kfA,1448
+osbot_utils/helpers/flows/Task.py,sha256=r0SthKYz919C6u-NG6Rt4zpE8yO5DdRFSPjGTnNeZbU,4690
 osbot_utils/helpers/flows/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 osbot_utils/helpers/flows/decorators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 osbot_utils/helpers/flows/decorators/flow.py,sha256=LUL7bHjZ_lC3QoTNh-KsDZHzjE2u4mU-5EpZnfsEGuc,738
 osbot_utils/helpers/flows/decorators/task.py,sha256=9bhQBPJU1dO-J4FAsFkmxqQMBNtay4FT_b1BdpHJ9sA,734
+osbot_utils/helpers/flows/models/Flow__Config.py,sha256=NLIfT0S8zxbig6Q1p9KeoyE2qRVWorHxk-JXCv9Yx-U,382
+osbot_utils/helpers/flows/models/Flow__Event.py,sha256=O2SNmDG8FTsQQqm5tWmbomQsC_usA7EqMQhTWIFl4KM,157
+osbot_utils/helpers/flows/models/Flow__Event_Type.py,sha256=dc5qwV0TfqgTfd10HzJnIZsnZrv4FPOC1EUCwKpI7AI,235
+osbot_utils/helpers/flows/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 osbot_utils/helpers/html/Dict_To_Css.py,sha256=u6B4Mx7PXr-gDrTrs1hgknnvsZVK4Fic5LqedKjo-lk,1097
 osbot_utils/helpers/html/Dict_To_Html.py,sha256=OlRSaDGOeseBNTxRB2ho5whqEacMXeAXWOfeVSEYqC4,3355
 osbot_utils/helpers/html/Dict_To_Tags.py,sha256=L8O8c0RPzP92EfeACk3pjXJfnlz-Rg38o2Gf9tS2UfM,3745
@@ -298,8 +302,8 @@ osbot_utils/utils/Toml.py,sha256=SD6IA4-mrtoBXcI0dIGKV9POMQNd6WYKvmDQq7GQ6ZQ,143
 osbot_utils/utils/Version.py,sha256=Ww6ChwTxqp1QAcxOnztkTicShlcx6fbNsWX5xausHrg,422
 osbot_utils/utils/Zip.py,sha256=G6Hk_hDcm9yvWzhTKzhT0R_6f0NBIAchHqMxGb3kfh4,14037
 osbot_utils/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-osbot_utils/version,sha256=hHjnHP5jok2-ZCxznWXApdBqJOijIybOEGxQ_V0SOkM,8
-osbot_utils-1.54.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-osbot_utils-1.54.0.dist-info/METADATA,sha256=EeBJ0nCvQtpsIHBmWWJbR73CCF3Ex6XCDu9QBRfGbAI,1266
-osbot_utils-1.54.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-osbot_utils-1.54.0.dist-info/RECORD,,
+osbot_utils/version,sha256=DaSzptqoG77WG2ht6TyXJYRLX-ouKuUV5NzkxiXP8yM,8
+osbot_utils-1.55.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+osbot_utils-1.55.0.dist-info/METADATA,sha256=uJ8iV358KsMOdWks77C17F6YAIX3nVJ7eO4DXN32iH8,1266
+osbot_utils-1.55.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+osbot_utils-1.55.0.dist-info/RECORD,,