osbot-utils 1.42.0__py3-none-any.whl → 1.44.0__py3-none-any.whl

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/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/testing/Temp_Env_Vars.py

@@ -1,6 +1,6 @@
 import os
-
 from osbot_utils.base_classes.Type_Safe import Type_Safe
+from osbot_utils.utils.Env              import del_env, set_env
 
 
 class Temp_Env_Vars(Type_Safe):
@@ -16,12 +16,12 @@ class Temp_Env_Vars(Type_Safe):
     def set_vars(self):
         for key, value in self.env_vars.items():
             self.original_env_vars[key] = os.environ.get(key)                   # Backup original environment variables and set new ones
-            os.environ[key] = value
+            set_env(key, value)
         return self
 
     def restore_vars(self):
         for key in self.env_vars:                                               # Restore original environment variables
             if self.original_env_vars[key] is None:
-                del os.environ[key]
+                del_env(key)
             else:
-                os.environ[key] = self.original_env_vars[key]
+                set_env(key, self.original_env_vars[key])

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/version

@@ -1 +1 @@
-v1.42.0
+v1.44.0

{osbot_utils-1.42.0.dist-info → osbot_utils-1.44.0.dist-info}/METADATA

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

@@ -6,6 +6,7 @@ osbot_utils/base_classes/Type_Safe.py,sha256=8uOxl1e12vf25MoBBW-hcbqfEpo1ih_Is_9
 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/async_invoke.py,sha256=-ja3K8orLy8Of54CIYSK-zn443pOIDY2hnFBjVELrXc,829
 osbot_utils/context_managers/capture_duration.py,sha256=sdWij3UJzDf1gDCogCO9RDg6Vijh1bZeeLSi3QmZeYs,1345
 osbot_utils/context_managers/disable_root_loggers.py,sha256=XDMbKATcRbmUQSMKaOhk68DANVdhbBvDxj15iXjIkw0,1056
 osbot_utils/decorators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -169,7 +170,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 +178,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 +233,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
@@ -253,7 +255,7 @@ osbot_utils/testing/Profiler.py,sha256=4em6Lpp0ONRDoDDCZsc_CdAOi_QolKOp4eA7KHN96
 osbot_utils/testing/Pytest.py,sha256=R3qdsIXGcNQcu7iobz0RB8AhbbHhc6t757tZoSZRrxA,730
 osbot_utils/testing/Stderr.py,sha256=ynf0Wle9NvgneLChzAxFBQ0QlE5sbri_fzJ8bEJMNkc,718
 osbot_utils/testing/Stdout.py,sha256=Gmxd_dOplXlucdSbOhYhka9sWP-Hmqb7ZuLs_JjtW7Y,592
-osbot_utils/testing/Temp_Env_Vars.py,sha256=CE_lk54QcibkQVtIj2DrQPS3k2LgQZUctU5b-WwWvbo,884
+osbot_utils/testing/Temp_Env_Vars.py,sha256=mQsc_ogtx2TA_20Y5zPusUZGvk_EZv4PMZjAXElbtFw,933
 osbot_utils/testing/Temp_File.py,sha256=yZBL9MmcNU4PCQ4xlF4rSss4GylKoX3T_AJF-BlQhdI,1693
 osbot_utils/testing/Temp_Folder.py,sha256=Dbcohr2ciex6w-kB79R41Nuoa0pgpDbKtPGnlMmJ73k,5194
 osbot_utils/testing/Temp_Sys_Path.py,sha256=gOMD-7dQYQlejoDYUqsrmuZQ9DLC07ymPZB3zYuNmG4,256
@@ -284,12 +286,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/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-osbot_utils/version,sha256=XEDmF2gY0SXKEjwvdngDk1U0o2yRWMAxnldMBdQDSOM,8
-osbot_utils-1.42.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-osbot_utils-1.42.0.dist-info/METADATA,sha256=A5I-YaoHJocPTRXNoGBep9eP3FhVTSndWFE9TcAGCLE,1266
-osbot_utils-1.42.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-osbot_utils-1.42.0.dist-info/RECORD,,
+osbot_utils/version,sha256=kYAcIo_a_mU0Bi3gNZH2ByIptBxKn1unKhuICxW0kUo,8
+osbot_utils-1.44.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+osbot_utils-1.44.0.dist-info/METADATA,sha256=BFGhr7opMQ7FIyJgQT_bpYO6vYmXIfSEz_VeBLLpRMc,1266
+osbot_utils-1.44.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+osbot_utils-1.44.0.dist-info/RECORD,,