osbot-utils 1.43.0__py3-none-any.whl → 1.45.0__py3-none-any.whl

osbot_utils/base_classes/Type_Safe.py

@@ -10,17 +10,17 @@ from decimal                                    import Decimal
 from enum                                       import Enum, EnumMeta
 from typing                                     import List
 from osbot_utils.base_classes.Type_Safe__List   import Type_Safe__List
-from osbot_utils.helpers.Random_Guid import Random_Guid
+from osbot_utils.helpers.Random_Guid            import Random_Guid
 from osbot_utils.utils.Dev                      import pprint
 from osbot_utils.utils.Json                     import json_parse
 from osbot_utils.utils.Misc                     import list_set
-from osbot_utils.utils.Objects import default_value, value_type_matches_obj_annotation_for_attr, \
+from osbot_utils.utils.Objects                  import default_value, value_type_matches_obj_annotation_for_attr, \
     raise_exception_on_obj_type_annotation_mismatch, obj_is_attribute_annotation_of_type, enum_from_value, \
     obj_is_type_union_compatible, value_type_matches_obj_annotation_for_union_attr, \
     convert_dict_to_value_from_obj_annotation
 
 # Backport implementations of get_origin and get_args for Python 3.7
-if sys.version_info < (3, 8):
+if sys.version_info < (3, 8):                                           # pragma: no cover
     def get_origin(tp):
         if isinstance(tp, typing._GenericAlias):
             return tp.__origin__
@@ -39,7 +39,7 @@ else:
 
 if sys.version_info >= (3, 10):
     NoneType = types.NoneType
-else:
+else:                                                           # pragma: no cover
     NoneType = type(None)
 
 immutable_types = (bool, int, float, complex, str, tuple, frozenset, bytes, NoneType, EnumMeta)

osbot_utils/context_managers/async_invoke.py

@@ -0,0 +1,27 @@
+import logging
+from contextlib import contextmanager
+import asyncio
+
+@contextmanager
+def async_invoke():
+    logger         = logging.getLogger('asyncio')
+    level_original = logger.level
+    logger.level   = logging.INFO                          # this will suppress the asyncio debug messages which where showing in tests
+    try:
+        original_loop = asyncio.get_event_loop()
+    except RuntimeError:
+        original_loop = None
+
+    loop = asyncio.new_event_loop()
+    asyncio.set_event_loop(loop)
+
+    try:
+        yield loop.run_until_complete
+    finally:
+        loop.close()
+        if original_loop is not None:
+            asyncio.set_event_loop(original_loop)
+        else:
+            asyncio.set_event_loop(None)
+
+        logger.level = level_original                           # restore the original log level

osbot_utils/context_managers/capture_duration.py

@@ -27,11 +27,4 @@ class capture_duration(Type_Safe):
         if self.action_name:
             print(f'action "{self.action_name}" took: {self.seconds} seconds')
         else:
-            print(f'action took: {self.seconds} seconds')
-
-class print_duration(capture_duration):
-
-    def __exit__(self, exc_type, exc_val, exc_tb):
-        result = super().__exit__(exc_type, exc_val, exc_tb)
-        self.print()
-        return result
+            print(f'action took: {self.seconds} seconds')

osbot_utils/context_managers/disable_root_loggers.py

@@ -1,9 +1,5 @@
 import logging
 
-from osbot_utils.utils.Dev import pprint
-from osbot_utils.utils.Misc import timestamp_utc_now
-
-
 class disable_root_loggers():
     def __init__(self):
         self.original_root_loggers  = []

osbot_utils/context_managers/print_duration.py

@@ -0,0 +1,9 @@
+from osbot_utils.context_managers.capture_duration import capture_duration
+
+
+class print_duration(capture_duration):
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        result = super().__exit__(exc_type, exc_val, exc_tb)
+        self.print()
+        return result

osbot_utils/decorators/lists/filter_list.py

@@ -3,9 +3,9 @@ from functools import wraps
 def filter_list(function):
     @wraps(function)
     def wrapper(*args, **kwargs):
-        only_show = kwargs.pop('only_show', None)                   # Directly extract and remove 'only_show' from kwargs if present
-        values    = function(*args, **kwargs)                       # Call the decorated function
-        if only_show:                                               # Filter the list of dictionaries to only include specified keys
+        only_show = kwargs.pop('only_show', None)                                               # Directly extract and remove 'only_show' from kwargs if present
+        values    = function(*args, **kwargs)                                                   # Call the decorated function
+        if only_show:                                                                           # Filter the list of dictionaries to only include specified keys
             return [{key: item[key] for key in only_show if key in item} for item in values]
         return values
 

osbot_utils/decorators/methods/capture_exception.py

@@ -1,6 +1,6 @@
 import traceback
-from functools import wraps
-from osbot_utils.utils.Dev import pprint
+from functools              import wraps
+from osbot_utils.utils.Dev  import pprint
 
 def capture_exception(func):
     @wraps(func)

osbot_utils/helpers/Dependency_Manager.py

@@ -0,0 +1,26 @@
+import inspect
+
+
+class Dependency_Manager:
+    def __init__(self):
+        self._dependencies = {}
+
+    def add_dependency(self, name: str, instance):                                          # Register a dependency by name.
+        self._dependencies[name] = instance
+
+    def get_dependency(self, name: str):                                                    # Retrieve a dependency by name.
+        return self._dependencies.get(name, None)
+
+    def resolve_dependencies(self, func, *args, **kwargs):                                  # Automatically inject dependencies based on function's parameters.
+        sig             = inspect.signature(func)                                           # Get the function's signature and parameters
+        bound_arguments = sig.bind_partial(*args, **kwargs)
+
+
+        for param_name, param in sig.parameters.items():                                    # Check parameters to see if we need to inject a dependency
+            if param_name not in bound_arguments.arguments:
+                if param_name in self._dependencies:                                        # Inject dependency if available
+                    bound_arguments.arguments[param_name] = self._dependencies[param_name]
+
+        return bound_arguments.args, bound_arguments.kwargs
+
+dependency_manager = Dependency_Manager()

osbot_utils/helpers/flows/Flow.py

@@ -1,9 +1,9 @@
 import logging
 import typing
-from functools import wraps
 
 from osbot_utils.base_classes.Type_Safe import Type_Safe
-from osbot_utils.helpers.CFormat import CFormat, f_dark_grey, f_magenta
+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
@@ -14,40 +14,32 @@ FLOW__RANDOM_NAME__PREFIX  = 'flow_name__'
 FLOW__LOGGING__LOG_FORMAT  = '%(asctime)s.%(msecs)03d | %(levelname)-8s | %(message)s'
 FLOW__LOGGING__DATE_FORMAT = '%H:%M:%S'
 
-def flow(**flow_kwargs):
-
-    def decorator(function):
-        @wraps(function)
-        def wrapper(*args, **kwargs):
-            with Flow(**flow_kwargs) as flow:
-                flow.set_flow_target(function)
-                flow.setup()
-                flow.create_flow()
-                flow.execute_flow(*args, **kwargs)
-                return flow.return_value
-
-        return wrapper
-    return decorator
 
 
 class Flow(Type_Safe):
     captured_exec_logs : list
+    data               : dict                   # dict available to the tasks to add and collect data
     flow_id            : str
     flow_name          : str
+    flow_config        : Flow__Config
     flow_target        : callable
+    flow_args          : tuple
+    flow_kwargs        : dict
+    flow_return_value  : typing.Any
     logger             : Python_Logger
     cformat            : CFormat
-    log_to_console     : bool    = False
-    log_to_memory      : bool    = True
-    print_logs         : bool    = False
-    return_value       : typing.Any
+    #log_to_console     : bool    = False
+    #log_to_memory      : bool    = True
+    #print_logs         : bool    = False
+    executed_tasks     : typing.List
+
 
 
     def config_logger(self):
         with self.logger as _:
             _.set_log_level(logging.DEBUG)
             _.set_log_format(log_format=FLOW__LOGGING__LOG_FORMAT, date_format=FLOW__LOGGING__DATE_FORMAT)
-            if self.log_to_console:
+            if self.flow_config.log_to_console:
                 _.add_console_logger()
 
 
@@ -58,23 +50,28 @@ class Flow(Type_Safe):
         self.set_flow_name()
         self.debug(f"Created flow run '{self.f__flow_id()}' for flow '{self.f__flow_name()}'")
 
-    def execute_flow(self, *args, **kwargs):
-        if self.log_to_memory:
+    def execute(self):
+        return self.execute_flow()
+
+    def execute_flow(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()}''")
         try:
             with Stdout() as stdout:
-                self.return_value = self.flow_target(*args, **kwargs)           # todo, capture *args, **kwargs in logs
+                self.flow_return_value = self.flow_target(*self.flow_args, **self.flow_kwargs)           # todo, capture *args, **kwargs in logs
         except Exception as error:
             self.logger.error(self.cformat.red(f"Error executing flow: {error}"))
-        self.log_captured_stdout(stdout)
-        self.debug(f"{f_dark_grey('return value')}: {self.return_value}")
-        self.debug(f"Finished flow run '{self.f__flow_id()}''")
 
-        if self.log_to_memory:
+        self.log_captured_stdout        (stdout)
+        self.print_flow_return_value    ()
+        self.print_flow_finished_message()
+
+        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
+            self.logger.remove_memory_logger()                                                          # todo: move to method that does post-execute tasks
+        return self
 
     def f__flow_id(self):
         return self.cformat.green(self.flow_id)
@@ -82,6 +79,9 @@ class Flow(Type_Safe):
     def f__flow_name(self):
         return self.cformat.blue(self.flow_name)
 
+    def captured_logs(self):
+        return ansis_to_texts(self.captured_exec_logs)
+
     def info(self, message):
         self.logger.info(message)
 
@@ -89,7 +89,7 @@ class Flow(Type_Safe):
         for line in stdout.value().splitlines():
             if line:
                 self.info(f_magenta(line))
-        if self.print_logs:
+        if self.flow_config.print_logs:
             print()
             print()
             self.print_log_messages()
@@ -103,12 +103,28 @@ class Flow(Type_Safe):
 
     def print_log_messages(self, use_colors=True):
         if use_colors:
-            for message in self.logger.memory_handler_messages():
-                print(message)
+            if self.captured_exec_logs:
+                for message in self.captured_exec_logs:
+                    print(message)
+            else:
+                for message in self.logger.memory_handler_messages():
+                    print(message)
         else:
             for message in self.log_messages():
                 print(message)
         return self
+
+    def print_flow_finished_message(self):
+        if self.flow_config.print_finished_message:
+            self.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)}")
+
+
+
     def random_flow_id(self):
         return lower(random_id(prefix=FLOW__RANDOM_ID__PREFIX))
 
@@ -116,8 +132,10 @@ class Flow(Type_Safe):
         return lower(random_id(prefix=FLOW__RANDOM_NAME__PREFIX))
 
 
-    def set_flow_target(self, target):
+    def set_flow_target(self, target, *args, **kwargs):
         self.flow_target = target
+        self.flow_args   = args
+        self.flow_kwargs = kwargs
         return self
 
     def set_flow_name(self, value=None):

osbot_utils/helpers/flows/Flow__Config.py

@@ -0,0 +1,11 @@
+from osbot_utils.base_classes.Type_Safe import Type_Safe
+
+
+class Flow__Config(Type_Safe):
+    add_task_to_self       : bool = True
+    log_to_console         : bool = False
+    log_to_memory          : bool = True
+    print_logs             : bool = False
+    print_none_return_value: bool = False
+    print_finished_message : bool = False
+

osbot_utils/helpers/flows/Task.py

@@ -1,12 +1,65 @@
 import inspect
+import typing
+
+from osbot_utils.helpers.Dependency_Manager import Dependency_Manager
+from osbot_utils.utils.Dev import pprint
+
+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
 
-from osbot_utils.base_classes.Type_Safe import Type_Safe
-from osbot_utils.helpers.flows.Flow import Flow
 
 
 class Task(Type_Safe):
-    task_id       : str
-    task_name     : str
+    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
+    task_target         : callable                      # todo refactor this to to Task__Function class
+    task_args           : tuple
+    task_kwargs         : dict
+    task_flow           : Flow
+    task_return_value   : typing.Any
+    task_error          : Exception  = None
+    raise_on_error      : bool       = True
+
+    def execute(self):
+        self.task_flow = self.find_flow()
+        if self.task_flow is None:
+            raise Exception("No Flow found for Task")
+
+        if not self.task_name and self.task_target:
+            self.task_name = self.task_target.__name__
+
+        self.task_flow.executed_tasks.append(self)
+        self.task_flow.logger.debug(f"Executing task '{f_blue(self.task_name)}'")
+
+        try:
+            with Stdout() as stdout:
+                self.invoke_task_target()
+        except Exception as error:
+            self.task_error = error
+
+        self.task_flow.log_captured_stdout(stdout)
+        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}"))
+            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()
+        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()
@@ -15,4 +68,16 @@ class Task(Type_Safe):
             if 'self' in frame.f_locals:
                 instance = frame.f_locals['self']
                 if type(instance) is Flow:
-                    return instance
+                    return instance
+
+    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)}'")
+
+    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)}")
+
+

osbot_utils/helpers/flows/decorators/flow.py

@@ -0,0 +1,18 @@
+from functools                      import wraps
+from typing import TypeVar, Callable, Any
+
+from osbot_utils.helpers.flows.Flow import Flow
+
+# todo: find way to make the casting below work for the users of this decorator
+
+def flow(**flow_kwargs):
+    def decorator(function) -> Flow:
+        @wraps(function)
+        def wrapper(*args: Any, **kwargs: Any) -> Flow:
+            with Flow(**flow_kwargs) as _:
+                _.set_flow_target(function, *args, **kwargs)
+                _.setup()
+                _.create_flow()
+                return _
+        return wrapper
+    return decorator

osbot_utils/helpers/flows/decorators/task.py

@@ -0,0 +1,11 @@
+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/helpers/html/Dict_To_Tags.py

@@ -1,10 +1,9 @@
 from osbot_utils.helpers.html.Dict_To_Html import HTML_SELF_CLOSING_TAGS
-from osbot_utils.helpers.html.Tag__Base import Tag__Base
-from osbot_utils.helpers.html.Tag__Body import Tag__Body
-from osbot_utils.helpers.html.Tag__Head import Tag__Head
-from osbot_utils.helpers.html.Tag__Html import Tag__Html
-from osbot_utils.helpers.html.Tag__Link import Tag__Link
-from osbot_utils.utils.Dev import pprint
+from osbot_utils.helpers.html.Tag__Base     import Tag__Base
+from osbot_utils.helpers.html.Tag__Body     import Tag__Body
+from osbot_utils.helpers.html.Tag__Head     import Tag__Head
+from osbot_utils.helpers.html.Tag__Html     import Tag__Html
+from osbot_utils.helpers.html.Tag__Link     import Tag__Link
 
 
 class Dict_To_Tags:

osbot_utils/helpers/pubsub/Event__Queue.py

@@ -1,26 +1,28 @@
 import time
-from enum import Enum
-from queue                                      import Queue, Empty
-from threading                                  import Thread
-from typing import Any
-
-from osbot_utils.helpers.pubsub.schemas.Schema__Event import Schema__Event
-from osbot_utils.helpers.pubsub.schemas.Schema__Event__Message import Schema__Event__Message
-from osbot_utils.utils                                import Misc
-from osbot_utils.base_classes.Kwargs_To_Self          import Kwargs_To_Self
-from osbot_utils.utils.Misc import random_text, wait_for, timestamp_utc_now, random_guid
-
-QUEUE_WAIT_TIMEOUT  = 1.0                           # todo: see if this value is a good one to use here
-
-class Event__Queue(Kwargs_To_Self):
-    events       : list
-    event_class  : type
-    log_events   : bool   = False
-    queue        : Queue
-    queue_name   : str    = random_text('event_queue')
-    queue_timeout: float  = QUEUE_WAIT_TIMEOUT
-    running      : bool
-    thread       : Thread = None
+from queue                                                      import Queue, Empty
+from threading                                                  import Thread
+from osbot_utils.base_classes.Type_Safe                         import Type_Safe
+from osbot_utils.helpers.pubsub.schemas.Schema__Event           import Schema__Event
+from osbot_utils.helpers.pubsub.schemas.Schema__Event__Message  import Schema__Event__Message
+from osbot_utils.utils.Misc                                     import random_text, timestamp_utc_now, random_guid
+
+TIMEOUT__THREAD_JOIN              = 1.0                             # todo: see if this value is a good one to use here
+TIMEOUT__QUEUE_GET                = 1.0
+TIMEOUT__WAIT_FOR_QUEUE_COMPLETED = 0.05                            # todo: see if this value is too aggressive (or if will be better to use a value like 0.1 or 0.5)
+
+
+class Event__Queue(Type_Safe):
+    events              : list
+    event_class         : type
+    events_added        : int
+    events_completed    : int
+    events_failed       : int
+    log_events          : bool   = False
+    queue               : Queue
+    queue_name          : str    = random_text('event_queue')
+    queue_get_timeout   : float  = TIMEOUT__QUEUE_GET
+    running             : bool
+    thread              : Thread = None
 
 
     def __init__(self, **kwargs):
@@ -49,6 +51,7 @@ class Event__Queue(Kwargs_To_Self):
                 event.timestamp = timestamp_utc_now()
             if not event.event_id:
                 event.event_id = random_guid()
+            self.events_added += 1
             self.queue.put(event)
             return True
         return False
@@ -72,18 +75,23 @@ class Event__Queue(Kwargs_To_Self):
         return self
 
     def stop(self):
-        self.running = False
+        self.running = False                                         # will make the event loop stop at the next self.queue_get_timeout
         return self
 
+    def queue_size(self):
+        return self.queue.qsize()
+
     def run_thread(self):
         while self.running:
             try:
-                event = self.queue.get(timeout=self.queue_timeout)
+                event = self.queue.get(timeout=self.queue_get_timeout)
                 if isinstance(event, self.event_class):
                     self.handle_event(event)
+                    self.events_completed += 1
             except Empty:
                 continue
             except Exception as e:                          # todo: add way to handle this (which are errors in the handle_event), may call an on_event_handler_exceptions method
+                self.events_failed += 1
                 continue
 
     def wait_micro_seconds(self, value=10):
@@ -92,4 +100,28 @@ class Event__Queue(Kwargs_To_Self):
 
     def wait_for_thread_ends(self):
         self.thread.join()
-        return self
+        return self
+
+    # todo see if there are valid use cases for wait_for_queue_empty , or the wait_for_queue_completed is the one that is always used
+    def wait_for_queue_empty(self, thread_join_timeout=TIMEOUT__THREAD_JOIN):             # this will start a new thread to wait for the main queue to be empty
+        def wait_until_queue_empty():
+            while self.running:
+                if self.queue.empty():
+                    break
+                time.sleep(0.01)
+
+        wait_thread = Thread(target=wait_until_queue_empty)
+        wait_thread.start()
+        wait_thread.join(timeout=thread_join_timeout)
+        return self.queue.empty()
+
+    def wait_for_queue_completed(self, thread_join_timeout=TIMEOUT__THREAD_JOIN):             # this will start a new thread to wait for the main queue to be empty
+        def wait_until_queue_completed():
+            while self.running:
+                if self.queue.empty() and self.events_added == self.events_completed :
+                    break
+                time.sleep(TIMEOUT__WAIT_FOR_QUEUE_COMPLETED)
+        wait_thread = Thread(target=wait_until_queue_completed)
+        wait_thread.start()
+        wait_thread.join(timeout=thread_join_timeout)
+        return self.queue.empty()

osbot_utils/helpers/pubsub/schemas/Schema__Event__Disconnect.py

@@ -1,7 +1,4 @@
-from osbot_utils.base_classes.Kwargs_To_Self import Kwargs_To_Self
 from osbot_utils.helpers.pubsub.schemas.Schema__Event import Schema__Event
-from osbot_utils.utils.Misc import random_guid
-
 
 class Schema__Event__Disconnect(Schema__Event):
     event_type : str  = 'disconnect'

osbot_utils/helpers/pubsub/schemas/Schema__Event__Execute_Method.py

@@ -0,0 +1,14 @@
+import types
+from osbot_utils.helpers.pubsub.schemas.Schema__Event import Schema__Event
+
+class Schema__Event__Execute_Method(Schema__Event):
+    event_type       : str                 = 'execute-method'
+    execution_result : object              = None
+    method_target    : types.MethodType
+    method_args      : list
+    method_kwargs    : dict
+
+
+    def execute(self):
+        self.execution_result = self.method_target(*self.method_args, **self.method_kwargs)
+        return self.execution_result

osbot_utils/helpers/trace/Trace_Call__Config.py

@@ -1,5 +1,4 @@
-from osbot_utils.utils.Dev import pprint
-
+from osbot_utils.utils.Dev                   import pprint
 from osbot_utils.base_classes.Kwargs_To_Self import Kwargs_To_Self
 
 PRINT_MAX_STRING_LENGTH    = 100
@@ -7,14 +6,12 @@ PRINT_PADDING__DURATION    = 100
 PRINT_PADDING_PARENT_INFO  = 60
 
 class Trace_Call__Config(Kwargs_To_Self):
-    title                      : str
     capture_locals             : bool = False
     capture_duration           : bool
     capture_extra_data         : bool
     capture_frame              : bool = True
     capture_frame_stats        : bool
     deep_copy_locals           : bool
-    trace_capture_lines        : bool
     ignore_start_with          : list
     print_padding_duration     : int = PRINT_PADDING__DURATION
     print_padding_parent_info  : int = PRINT_PADDING_PARENT_INFO
@@ -27,6 +24,7 @@ class Trace_Call__Config(Kwargs_To_Self):
     show_caller                : bool
     show_method_class          : bool = True
     show_source_code_path      : bool
+    title                      : str
     trace_capture_all          : bool
     trace_capture_source_code  : bool
     trace_capture_start_with   : list
@@ -34,6 +32,7 @@ class Trace_Call__Config(Kwargs_To_Self):
     trace_enabled              : bool = True
     trace_ignore_start_with    : list
     trace_ignore_contains      : list
+    trace_capture_lines        : bool
     trace_show_internals       : bool
     trace_up_to_depth          : int
     with_duration_bigger_than  : float

osbot_utils/utils/Call_Stack.py

@@ -185,3 +185,6 @@ def call_stack_frames_data(depth=None):
 def frames_in_threads():
     return sys._current_frames()
 
+
+def print_call_stack():
+    traceback.print_stack()

osbot_utils/utils/Threads.py

@@ -0,0 +1,27 @@
+import asyncio
+import logging
+import typing
+
+def invoke_async_function(target: typing.Coroutine):
+    """Run an asynchronous coroutine in a new event loop."""
+    logger         = logging.getLogger('asyncio')
+    level_original = logger.level
+    logger.level   = logging.INFO  # this will suppress the asyncio debug messages which where showing in tests
+    try:
+        original_loop = asyncio.get_event_loop()
+    except RuntimeError:
+        original_loop = None  # No event loop was set
+
+    loop = asyncio.new_event_loop()
+    asyncio.set_event_loop(loop)
+    try:
+        return loop.run_until_complete(target)
+    finally:
+        loop.close()
+        # Restore the original event loop
+        if original_loop is not None:
+            asyncio.set_event_loop(original_loop)
+        else:
+            asyncio.set_event_loop(None)
+
+        logger.level = level_original  # restore the original log level

osbot_utils/utils/Zip.py

@@ -6,6 +6,8 @@ import tarfile
 import zipfile
 from os.path import abspath
 
+from osbot_utils.utils.Misc import list_set
+
 from osbot_utils.utils.Files import temp_folder, folder_files, temp_file, is_file, file_copy, file_move, file_exists, \
     file_contents_as_bytes
 
@@ -99,6 +101,9 @@ def zip_bytes__files(zip_bytes):
 
     return files_dict                                       # Return the dictionary with file contents
 
+def zip_bytes__files_paths(zip_bytes):
+    return list_set(zip_bytes__files(zip_bytes))
+
 def zip_bytes__file_list(zip_bytes):
     zip_buffer_from_bytes = io.BytesIO(zip_bytes)
     with zipfile.ZipFile(zip_buffer_from_bytes, 'r') as zf:

osbot_utils/version

@@ -1 +1 @@
-v1.43.0
+v1.45.0

{osbot_utils-1.43.0.dist-info → osbot_utils-1.45.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: osbot_utils
-Version: 1.43.0
+Version: 1.45.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.43.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.45.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.43.0.dist-info → osbot_utils-1.45.0.dist-info}/RECORD

@@ -2,17 +2,19 @@ osbot_utils/__init__.py,sha256=DdJDmQc9zbQUlPVyTJOww6Ixrn9n4bD3ami5ItQfzJI,16
 osbot_utils/base_classes/Cache_Pickle.py,sha256=kPCwrgUbf_dEdxUz7vW1GuvIPwlNXxuRhb-H3AbSpII,5884
 osbot_utils/base_classes/Kwargs_To_Disk.py,sha256=HHoy05NC_w35WcT-OnSKoSIV_cLqaU9rdjH0_KNTM0E,1096
 osbot_utils/base_classes/Kwargs_To_Self.py,sha256=weFNsBfBNV9W_qBkN-IdBD4yYcJV_zgTxBRO-ZlcPS4,141
-osbot_utils/base_classes/Type_Safe.py,sha256=8uOxl1e12vf25MoBBW-hcbqfEpo1ih_Is_9BmlhV4-k,17739
+osbot_utils/base_classes/Type_Safe.py,sha256=xG3peP_hyuUYYi84zR6LhzmgoFYYLBbYwoIQb9XAmpQ,17905
 osbot_utils/base_classes/Type_Safe__List.py,sha256=-80C9OhsK6iDR2dAG8yNLAZV0qg5x3faqvSUigFCMJw,517
 osbot_utils/base_classes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 osbot_utils/context_managers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-osbot_utils/context_managers/capture_duration.py,sha256=sdWij3UJzDf1gDCogCO9RDg6Vijh1bZeeLSi3QmZeYs,1345
-osbot_utils/context_managers/disable_root_loggers.py,sha256=XDMbKATcRbmUQSMKaOhk68DANVdhbBvDxj15iXjIkw0,1056
+osbot_utils/context_managers/async_invoke.py,sha256=-ja3K8orLy8Of54CIYSK-zn443pOIDY2hnFBjVELrXc,829
+osbot_utils/context_managers/capture_duration.py,sha256=EhQUPHK_zjpm9dsnEhkJRrcd0fdngPgsM1QlNjquWwI,1147
+osbot_utils/context_managers/disable_root_loggers.py,sha256=0-zQk11TBqwhTHCN4vNhDApojtJ4oR0oMPRcwclcXZA,960
+osbot_utils/context_managers/print_duration.py,sha256=jleIYxmz-vbWbcZZPuTWMNavJgxYkATwrVk5H-2SHj4,272
 osbot_utils/decorators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 osbot_utils/decorators/classes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 osbot_utils/decorators/classes/singleton.py,sha256=ZBYw2W4Qmo0mlHQQqDJyScaXO6pmbftru9YBBdUowjY,332
 osbot_utils/decorators/lists/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-osbot_utils/decorators/lists/filter_list.py,sha256=DLqyjaCDVNP0Hpbl_lLLT-a_UL6rUjvwWosR5QEEuLk,610
+osbot_utils/decorators/lists/filter_list.py,sha256=ME-Ojknb60yn13LQNkY2ixqrkl6MfXUtxlnLis9qw3Y,694
 osbot_utils/decorators/lists/group_by.py,sha256=NUzc1l9SXezypfDuqxykFX4-kuD36m9w_nOsOGL70Ug,697
 osbot_utils/decorators/lists/index_by.py,sha256=BEbfd13l11zROhXAb0vkB_aZi9P2Zt4pExLpvHwuCtQ,850
 osbot_utils/decorators/methods/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -20,7 +22,7 @@ osbot_utils/decorators/methods/cache.py,sha256=IMmHBeR6qtaOfBNgZUeI1SVLoexQQy6vk
 osbot_utils/decorators/methods/cache_on_function.py,sha256=sDebxWjJnusb_w4R26OTYcmTF6CCeWrpesn-dgzEu8g,2694
 osbot_utils/decorators/methods/cache_on_self.py,sha256=bVSOBXcKVR-ITotq9sReUP1RY3TmnvROfl90564miJY,3681
 osbot_utils/decorators/methods/cache_on_tmp.py,sha256=8wLnRAUUkHobu6-B2Q8aAE8jLeIu3b-CQuMtXcnIN9w,3102
-osbot_utils/decorators/methods/capture_exception.py,sha256=mTfjqIS_qvZLhX6_NF_fkD_EnMLZRXkUHqUaiAbqZkU,1160
+osbot_utils/decorators/methods/capture_exception.py,sha256=r6d1TPibAVLL7B4I0oXtnHQwFFdLBZbDnytYWO6PxS4,1174
 osbot_utils/decorators/methods/capture_status.py,sha256=5xklG0usO3hGTjedhrmIucXtUjPd2pkuvA5jsty0a5E,659
 osbot_utils/decorators/methods/catch.py,sha256=d3_wiwI1GVhDJmFuIN1gxI2WFJtX1blx5wgjHfSdFu8,545
 osbot_utils/decorators/methods/context.py,sha256=oeHvVTAv6G2PTPkmzaez96hSDSYM4cLnKT_1KNbsIqM,291
@@ -56,6 +58,7 @@ osbot_utils/graphs/mgraph/MGraphs.py,sha256=W8GlTBQ-1nBb9Zj3nbZ3QetyaP1LlkhMBVOi
 osbot_utils/graphs/mgraph/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 osbot_utils/helpers/CFormat.py,sha256=1_XvqGwgU6qC97MbzcKF0o7s9mCXpU5Kq9Yf-1ixUwY,6808
 osbot_utils/helpers/CPrint.py,sha256=ztKPNmT8BGxeyPXSQKRs63PqqbgxKDz_BiZmzFMup9g,1413
+osbot_utils/helpers/Dependency_Manager.py,sha256=79YRYnVfchewq8iSMJ5dzwW2D5u8chWcIqYE-G9YrSo,1337
 osbot_utils/helpers/Dict_To_Attr.py,sha256=NdhXl5mJH7-NaBk213amzc5Nfy3tJgW-N_uYIRE4hoc,208
 osbot_utils/helpers/Hashicorp_Secrets.py,sha256=zjXa_dQvfR9L1uoulWJ8nYYaDvznV6o_QPPS4zmb6mo,4235
 osbot_utils/helpers/Local_Cache.py,sha256=0JZZX3fFImcwtbBvxAQl-EbBegSNJRhRMYF6ovTH6zY,3141
@@ -151,12 +154,16 @@ 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=3ZqIGPbAzxY_Zzua188LqWeLCnYrtxAs2wUj5rocPec,4929
-osbot_utils/helpers/flows/Task.py,sha256=Kzh_Zb0V5Fj6wo5Xd_kbGqUYNcZ88jUNorCZnaE8e24,491
+osbot_utils/helpers/flows/Flow.py,sha256=_93-0FpH_bq7j--6DvKW7n2YC6hU_tINx8YMvMX4_uM,5659
+osbot_utils/helpers/flows/Flow__Config.py,sha256=PE8hH8KXDHz1Ex93cPMuR9nkv8AoXzXQwVxleSDkU7k,341
+osbot_utils/helpers/flows/Task.py,sha256=edbvtd78kzz5ghKp-awyOWop2QYxqDB0-aupcz0sjVM,3530
 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=7H9NXR7416BCBC-2wgQz7KCA0_d8I0gZbxSyxcL4khQ,595
+osbot_utils/helpers/flows/decorators/task.py,sha256=2Eg8abx7ky8PVKVQijy6Oji60UKW31nXmtYftqBDB0k,394
 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=vYG-KPj409ijsWDUHmEY0JvrtH02bwa8hU-P7yZWTFA,3766
+osbot_utils/helpers/html/Dict_To_Tags.py,sha256=L8O8c0RPzP92EfeACk3pjXJfnlz-Rg38o2Gf9tS2UfM,3745
 osbot_utils/helpers/html/Html_To_Dict.py,sha256=6VvPp4RrXxRzPpCTn0HTa6Ywt_-4CBH4sj3aoPBZWIc,2623
 osbot_utils/helpers/html/Html_To_Tag.py,sha256=WDdXF0Q9siVwN0OIgZluCu-dXJa8bDrL9-6TidlKUeQ,498
 osbot_utils/helpers/html/Tag__Base.py,sha256=eAO4SdoKdHe9DRSzf9zpfBhDWDbvv-CGrxjekBHXm8k,3128
@@ -169,7 +176,7 @@ osbot_utils/helpers/html/Tag__Html.py,sha256=W_QFUF27vpR109g9rpca0zoQis1wkMjGuAt
 osbot_utils/helpers/html/Tag__Link.py,sha256=rQ-gZN8EkSv5x1S-smdjvFflwMQHACHQXiOdx0MFke8,437
 osbot_utils/helpers/html/Tag__Style.py,sha256=LPPlIN7GyMvfCUlbs2eXVMUr9jS0PX5M94A5Ig_jXIs,846
 osbot_utils/helpers/html/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-osbot_utils/helpers/pubsub/Event__Queue.py,sha256=51QO-3bnyrzYa7cMOk5rZP1Pwk1Wne_HtqeQ0oFMHl0,3187
+osbot_utils/helpers/pubsub/Event__Queue.py,sha256=H4Hhmj_G3GjTcPFj6y1nVFt64vCwGRVdgta0T0b_a4E,5041
 osbot_utils/helpers/pubsub/PubSub__Client.py,sha256=6K3l4H-Tc0DhktrxpYzLVur1uZ532pQsHWprLNRXFJE,2316
 osbot_utils/helpers/pubsub/PubSub__Room.py,sha256=3drJIAVSAzXB_0Q9dXxwhYWxNaEUaMiWiXLY9Mh02DM,481
 osbot_utils/helpers/pubsub/PubSub__Server.py,sha256=DjQ6PsNGmULdFodspdNktADcoIN3FbdvAitE52m89-w,3548
@@ -177,7 +184,8 @@ osbot_utils/helpers/pubsub/PubSub__Sqlite.py,sha256=3u1Gbpq22JDgDEexdyMzGvkQAHe9
 osbot_utils/helpers/pubsub/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 osbot_utils/helpers/pubsub/schemas/Schema__Event.py,sha256=si12mqRRROI3HYGvjQvzPZ_NGw3TpmVZxGhzuWq5cus,402
 osbot_utils/helpers/pubsub/schemas/Schema__Event__Connect.py,sha256=fgq0G3_zx3UFk5knsotmEXvP1YvZwOLBtT9gow1U-qM,269
-osbot_utils/helpers/pubsub/schemas/Schema__Event__Disconnect.py,sha256=HX52d5koQkbM_Cwb6-hM9-lN7HkYQQ_JGW0fb1s8S10,275
+osbot_utils/helpers/pubsub/schemas/Schema__Event__Disconnect.py,sha256=NUP-3skJyCRUqCDt2YSh5gQ0NIVMGL3huUnVp0hNQ-Q,160
+osbot_utils/helpers/pubsub/schemas/Schema__Event__Execute_Method.py,sha256=srVEFo0bKRhEslsdr8x3hqXVDzx9_pBxD4l2zxbsvIQ,502
 osbot_utils/helpers/pubsub/schemas/Schema__Event__Join_Room.py,sha256=OJmBuaA5AKN6HFfaQDlN2dWG8xWAmExr-k3DyzL1JWg,293
 osbot_utils/helpers/pubsub/schemas/Schema__Event__Leave_Room.py,sha256=cNugRz-k_Jmb3z5899CgvN4CeQZh0NF7FqMBfvoToSE,295
 osbot_utils/helpers/pubsub/schemas/Schema__Event__Message.py,sha256=rt8W-DGitmR-SvmunSG8kbTH_mubE2PKMh2cJ3eJOyo,244
@@ -231,7 +239,7 @@ osbot_utils/helpers/ssh/SSH__Python.py,sha256=O2DAwkbXzwkis8lffoqIL2NPSfYcN44Mr8
 osbot_utils/helpers/ssh/TestCase__SSH.py,sha256=MD8sq0_kI4f6pEmEO0cLq2mQOhIqbP45ZxFJNG44Jg4,1773
 osbot_utils/helpers/ssh/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 osbot_utils/helpers/trace/Trace_Call.py,sha256=SNaYju1KA6UKaCZcaDoPadvSahdl0vOX27unGl0-ZEM,8825
-osbot_utils/helpers/trace/Trace_Call__Config.py,sha256=bZyOIWs_4ufNVbpfiT8h_284JFHiFeBAJO15Q5ONaTg,3288
+osbot_utils/helpers/trace/Trace_Call__Config.py,sha256=qd6HpF1olvlQ9BU3-gvxRdnP0l7w7noCXpF561gkyUk,3305
 osbot_utils/helpers/trace/Trace_Call__Graph.py,sha256=HCrXRKQI42DIQxxyFLcaosWiOcUyoITbeV17ICdXcXM,1156
 osbot_utils/helpers/trace/Trace_Call__Handler.py,sha256=hdgiawoC4K2DrMAHbz2706SfEcxPdX9kK0gjyWqjSzQ,12400
 osbot_utils/helpers/trace/Trace_Call__Print_Lines.py,sha256=cy7zLv0_JNxdOIQPfZk6J9bv6AkIW6O643w0ykClXbw,4820
@@ -264,7 +272,7 @@ osbot_utils/testing/Unit_Test.py,sha256=MReR_wDGbbXFDPz7cmuGflcTxRB6TBnO9mYqRpSq
 osbot_utils/testing/Unzip_File.py,sha256=V5H97XO9rlvG5EYOSzAH4kTtAH1ohZ8R8ImvJh46ZNg,1177
 osbot_utils/testing/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 osbot_utils/utils/Assert.py,sha256=u9XLgYn91QvNWZGyPi29SjPJSXRHlm9andIn3NJEVog,1745
-osbot_utils/utils/Call_Stack.py,sha256=MAq_0vMxnbeLfCe9qQz7GwJYaOuXpt3qtQwN6wiXsU0,6595
+osbot_utils/utils/Call_Stack.py,sha256=awhWstC2mJCrOjNqNheTe2B7at-JFP6XG7VkMPpPNOE,6647
 osbot_utils/utils/Csv.py,sha256=oHLVpjRJqrLMz9lubMCNEoThXWju5rNTprcwHc1zq2c,1012
 osbot_utils/utils/Dev.py,sha256=HibpQutYy_iG8gGV8g1GztxNN4l29E4Bi7UZaVL6-L8,1203
 osbot_utils/utils/Env.py,sha256=XMwF5BrtpoPJdOraswAFPrcQ3tRTocjqvA8I61eOCJw,5741
@@ -284,12 +292,13 @@ osbot_utils/utils/Python_Logger.py,sha256=tx8N6wRKL3RDHboDRKZn8SirSJdSAE9cACyJkx
 osbot_utils/utils/Regex.py,sha256=0ubgp8HKsS3PNe2H6XlzMIcUuV7jhga3VkQVDNOJWuA,866
 osbot_utils/utils/Status.py,sha256=Yq4s0TelXgn0i2QjCP9V8mP30GabXp_UL-jjM6Iwiw4,4305
 osbot_utils/utils/Str.py,sha256=kxdY8ROX4FdJtCaMTfOc8fK_xcDICprNkefHu2MMNU4,2585
+osbot_utils/utils/Threads.py,sha256=fgFrZZXY2G9yJmfQcOv76GB_8MhCrvoUdcbkAhYxDBI,909
 osbot_utils/utils/Toml.py,sha256=dqiegndCJF7V1YT1Tc-b0-Bl6QWyL5q30urmQwMXfMQ,1402
 osbot_utils/utils/Version.py,sha256=Ww6ChwTxqp1QAcxOnztkTicShlcx6fbNsWX5xausHrg,422
-osbot_utils/utils/Zip.py,sha256=Gt4K7Q9LlYeRxOVv8aYpaBLKxrYriCAEUa_R6YWEbMg,13903
+osbot_utils/utils/Zip.py,sha256=G6Hk_hDcm9yvWzhTKzhT0R_6f0NBIAchHqMxGb3kfh4,14037
 osbot_utils/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-osbot_utils/version,sha256=fOAaMknsjZubrhlMwCGvu20rNnqh4_mOJhZtjkpg_Kc,8
-osbot_utils-1.43.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-osbot_utils-1.43.0.dist-info/METADATA,sha256=5H4eus-dFNyqQRkdoDLjMr6edaH7GNP71DyQr0102Es,1266
-osbot_utils-1.43.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-osbot_utils-1.43.0.dist-info/RECORD,,
+osbot_utils/version,sha256=8XvA-W5tRj_AQS8FtlMP3PtCMBpTiglUjp-DGhdTGZY,8
+osbot_utils-1.45.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+osbot_utils-1.45.0.dist-info/METADATA,sha256=CZxciwssi8uAl_O1N7wfuoPBMeg3x8e5G6qjieln_Ac,1266
+osbot_utils-1.45.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+osbot_utils-1.45.0.dist-info/RECORD,,