osbot-utils 1.55.0__tar.gz → 1.57.0__tar.gz

{osbot_utils-1.55.0 → osbot_utils-1.57.0}/PKG-INFO

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

@@ -34,7 +34,20 @@ class Flow(Type_Safe):
     cformat            : CFormat
     executed_tasks     : typing.List
 
+    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 
+        result_data = dict(flow_run_id = self.flow_id,
+                           description = description    or 'description'                                                    ,
+                           key         = key            or 'an-artifact-key'                                                ,
+                           data        = data           or {"link": "https://www.google.com", "link_text": "link to Google"},       # test data to see if it worksw
+                           type        = artifact_type  or "link"                                                           )   # type clashed with built-in type
 
+        flow_events.on__new_artifact(self, result_data )
+
+    def add_flow_result(self, key, description):
+        result_data = dict(flow_run_id = self.flow_id,
+                           key         = key         ,
+                           description = description )
+        flow_events.on__new_result(self, result_data )
 
     def config_logger(self):
         with self.logger as _:
@@ -55,7 +68,7 @@ class Flow(Type_Safe):
         if self.flow_config.log_to_memory:
             self.logger.add_memory_logger()                                     # todo: move to method that does pre-execute tasks
 
-        self.log_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()
@@ -70,15 +83,11 @@ 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
+        if self.flow_return_value:
+            self.add_flow_result(key = 'flow-return-value', description=f'{self.flow_return_value}')
         flow_events.on__flow__stop(self)
         return self
 
-    def f__flow_id(self):
-        return self.cformat.green(self.flow_id)
-
-    def f__flow_name(self):
-        return self.cformat.blue(self.flow_name)
-
     def captured_logs(self):
         return ansis_to_texts(self.captured_exec_logs)
 
@@ -93,6 +102,13 @@ class Flow(Type_Safe):
         else:
             self.flow_return_value  = self.flow_target(*self.flow_args, **self.flow_kwargs)     # if the flow is sync, just execute the flow target
 
+    def f__flow_id(self):
+        return self.cformat.green(self.flow_id)
+
+    def f__flow_name(self):
+        return self.cformat.blue(self.flow_name)
+
+
     def log_captured_stdout(self, stdout):
         for line in stdout.value().splitlines():
             if line:
@@ -102,17 +118,29 @@ class Flow(Type_Safe):
             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_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):
+    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:
-            self.logger.info(message)
+            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())
@@ -135,7 +163,7 @@ class Flow(Type_Safe):
 
     def print_flow_finished_message(self):
         if self.flow_config.print_finished_message:
-            self.log_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:

{osbot_utils-1.55.0 → osbot_utils-1.57.0}/osbot_utils/helpers/flows/Flow__Events.py

@@ -1,3 +1,7 @@
+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
@@ -14,6 +18,23 @@ class Flow_Events(Type_Safe):
         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__new_artifact(self, flow, result_data):
+        flow_event = Flow__Event(event_type=Flow__Event_Type.NEW_ARTIFACT , event_source=flow, event_data=result_data)
+        self.raise_event(flow_event)
+
+    def on__new_result(self, flow, result_data):
+        flow_event = Flow__Event(event_type=Flow__Event_Type.NEW_RESULT , event_source=flow, event_data=result_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)

{osbot_utils-1.55.0 → osbot_utils-1.57.0}/osbot_utils/helpers/flows/Task.py

@@ -27,11 +27,14 @@ 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_flow.log_debug(message, self.task_id)
 
     def log_error(self, message):
-        self.task_flow.log_error(message)
+        self.task_flow.log_error(message, self.task_id)
 
     def execute__sync(self):
         self.execute__before()
@@ -54,6 +57,8 @@ class Task(Type_Safe):
         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.log_debug(f"Executing task '{f_blue(self.task_name)}'")
         dependency_manager = Dependency_Manager()
@@ -62,7 +67,7 @@ class Task(Type_Safe):
         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:

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

@@ -0,0 +1,10 @@
+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'
+    NEW_ARTIFACT: str = 'new_artifact'
+    NEW_RESULT  : str = 'new_result'
+    TASK_START  : str = 'task_start'
+    TASK_STOP   : str = 'task_stop'

osbot_utils-1.57.0/osbot_utils/version

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

{osbot_utils-1.55.0 → osbot_utils-1.57.0}/pyproject.toml

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

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

@@ -1,8 +0,0 @@
-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-1.55.0/osbot_utils/version

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