osbot-utils 1.35.0__py3-none-any.whl → 1.37.0__py3-none-any.whl

osbot_utils/context_managers/capture_duration.py

@@ -1,12 +1,13 @@
+from osbot_utils.base_classes.Type_Safe import Type_Safe
 from osbot_utils.utils.Misc import timestamp_utc_now
 
 
-class capture_duration():
-    def __init__(self):
-        self.duration        = None
-        self.start_timestamp = None
-        self.end_timestamp   = None
-        self.seconds         = None
+class capture_duration(Type_Safe):
+    action_name     : str
+    duration        : float
+    start_timestamp : int
+    end_timestamp   : int
+    seconds         : float
 
     def __enter__(self):
         self.start_timestamp = timestamp_utc_now()
@@ -23,7 +24,10 @@ class capture_duration():
 
     def print(self):
         print()
-        print(f'action took: {self.seconds} seconds')
+        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):
 

osbot_utils/helpers/trace/Trace_Call.py

@@ -1,5 +1,6 @@
 import linecache
 import sys
+import threading
 from functools import wraps
 
 from osbot_utils.base_classes.Kwargs_To_Self                import Kwargs_To_Self
@@ -8,6 +9,8 @@ from osbot_utils.helpers.trace.Trace_Call__Handler          import Trace_Call__H
 from osbot_utils.helpers.trace.Trace_Call__Print_Lines      import Trace_Call__Print_Lines
 from osbot_utils.helpers.trace.Trace_Call__Print_Traces     import Trace_Call__Print_Traces
 from osbot_utils.helpers.trace.Trace_Call__View_Model       import Trace_Call__View_Model
+from osbot_utils.testing.Stdout import Stdout
+from osbot_utils.utils.Str import ansi_to_text
 
 
 def trace_calls(title         = None , print_traces = True , show_locals    = False, source_code          = False ,
@@ -59,6 +62,7 @@ class Trace_Call(Kwargs_To_Self):
         self.config.trace_capture_contains                      = self.config.trace_capture_contains   or []          #      and None will be quite common since we can use [] on method's params
         self.config.print_max_string_length                     = self.config.print_max_string_length  or PRINT_MAX_STRING_LENGTH
         self.stack                                              = self.trace_call_handler.stack
+        self.trace_on_thread__data                              = {}
         #self.prev_trace_function                                = None                                                # Stores the previous trace function
 
 
@@ -94,6 +98,13 @@ class Trace_Call(Kwargs_To_Self):
         #self.print_lines()
         return view_model
 
+    def print_to_str(self):
+        with Stdout() as stdout:
+            self.print()
+        trace_data = ansi_to_text(stdout.value())
+        return trace_data
+
+
     def print_lines(self):
         print()
         view_model = self.view_data()
@@ -106,6 +117,27 @@ class Trace_Call(Kwargs_To_Self):
         self.started             = True                                                         # set this here so that it does show in the trace
         sys.settrace(self.trace_call_handler.trace_calls)                                       # Set the new trace function
 
+    def start__on_thread(self, root_node=None):
+        if sys.gettrace() is None:
+            current_thread    = threading.current_thread()
+            thread_sys_trace = sys.gettrace()
+            thread_name       = current_thread.name
+            thread_id         = current_thread.native_id
+            thread_nodes      = []
+            thread_data       = dict(thread_name      = thread_name     ,
+                                     thread_id        = thread_id       ,
+                                     thread_nodes     = thread_nodes    ,
+                                     thread_sys_trace = thread_sys_trace)
+            title = f"Thread: {thread_name} ({thread_id})"
+            thread_node__for_title = self.trace_call_handler.stack.add_node(title=title)         # Add node with name of Thread
+
+            if root_node:                                                                   # Add node with name of node
+                thread_node__for_root = self.trace_call_handler.stack.add_node(root_node)
+                thread_nodes.append(thread_node__for_root)
+            thread_nodes.append(thread_node__for_title)
+            sys.settrace(self.trace_call_handler.trace_calls)
+            self.trace_on_thread__data[thread_id] = thread_data
+
 
     def stop(self):
         if self.started:
@@ -113,6 +145,18 @@ class Trace_Call(Kwargs_To_Self):
             self.stack.empty_stack()
             self.started = False
 
+    def stop__on_thread(self):
+        current_thread = threading.current_thread()
+        thread_id      = current_thread.native_id
+        thread_data    = self.trace_on_thread__data.get(thread_id)
+        if thread_data:                                             # if there trace_call set up in the current thread
+            thread_sys_trace = thread_data.get('thread_sys_trace')
+            thread_nodes     = thread_data.get('thread_nodes')
+            for thread_node in thread_nodes:                        # remove extra nodes added during start__on_thread
+                self.trace_call_handler.stack.pop(thread_node)
+            sys.settrace(thread_sys_trace)                          # restore previous sys.trace value
+            del self.trace_on_thread__data[thread_id]
+
     def stats(self):
         return self.trace_call_handler.stats
 

osbot_utils/helpers/trace/Trace_Call__Config.py

@@ -33,6 +33,7 @@ class Trace_Call__Config(Kwargs_To_Self):
     trace_capture_contains     : list
     trace_enabled              : bool = True
     trace_ignore_start_with    : list
+    trace_ignore_contains      : list
     trace_show_internals       : bool
     trace_up_to_depth          : int
     with_duration_bigger_than  : float

osbot_utils/helpers/trace/Trace_Call__Handler.py

@@ -20,11 +20,19 @@ GLOBAL_FUNCTIONS_TO_IGNORE   = ['value_type_matches_obj_annotation_for_attr'
                                 '__default__value__'    ,
                                 '__setattr__'           ,
                                 '<module>']
-GLOBAL_MODULES_TO_IGNORE     = ['osbot_utils.helpers.trace.Trace_Call'             ,            # todo: map out and document why exactly these modules are ignore (and what is the side effect)
-                                'osbot_utils.helpers.CPrint'                       ,            #       also see if this should be done here or at the print/view stage
-                                'osbot_utils.helpers.Print_Table'      ,
-                                'osbot_utils.decorators.methods.cache_on_self'     ,
-                                'codecs']
+GLOBAL_MODULES_TO_IGNORE     = ['osbot_utils.helpers.trace.Trace_Call'               ,            # todo: map out and document why exactly these modules are ignore (and what is the side effect)
+                                'osbot_utils.helpers.trace.Trace_Call__Config'       ,
+                                'osbot_utils.helpers.trace.Trace_Call__View_Model'   ,
+                                'osbot_utils.helpers.trace.Trace_Call__Print_Traces' ,
+                                'osbot_utils.helpers.trace.Trace_Call__Stack'        ,
+                                'osbot_utils.base_classes.Type_Safe'                 ,
+                                'osbot_utils.helpers.CPrint'                         ,            #       also see if this should be done here or at the print/view stage
+                                'osbot_utils.helpers.Print_Table'                    ,
+                                'osbot_utils.decorators.methods.cache_on_self'       ,
+                                'codecs'                                             ]
+
+#GLOBAL_MODULES_TO_IGNORE = []
+#GLOBAL_FUNCTIONS_TO_IGNORE = []
 
 class Trace_Call__Handler(Kwargs_To_Self):
     config : Trace_Call__Config
@@ -171,6 +179,11 @@ class Trace_Call__Handler(Kwargs_To_Self):
                     if module.startswith(item) or func_name.startswith(item):
                         capture = False
                         break
+
+                for item in self.config.trace_ignore_contains:                                       # Check if the module should be ignored
+                    if item in module or item in func_name:
+                        capture = False
+                        break
         return capture
 
     def stack_json__parse_node(self, stack_node: Trace_Call__Stack_Node):

osbot_utils/testing/Stderr.py

@@ -2,17 +2,23 @@ import io
 from contextlib import redirect_stderr
 
 
-class Stderr:
+class Stderr:               # todo: refactor with Stdout whose code is 90% the same as this one. Add class to capture both at the same time
     def __init__(self):
         self.output          = io.StringIO()
         self.redirect_stderr = redirect_stderr(self.output)
 
     def __enter__(self):
-        self.redirect_stderr.__enter__()
+        self.start()
         return self
 
-    def __exit__(self, exc_type, exc_val, exc_tb):
-        self.redirect_stderr.__exit__(exc_type, exc_val, exc_tb)
+    def __exit__(self, *args, **kwargs):
+        self.stop(*args, **kwargs)
+
+    def start(self):
+        self.redirect_stderr.__enter__()
+
+    def stop(self, exc_type=None, exc_inst=None, exc_tb=None):
+        self.redirect_stderr.__exit__(exc_type, exc_inst, exc_tb)
 
     def value(self):
         return self.output.getvalue()

osbot_utils/testing/Stdout.py

@@ -8,11 +8,17 @@ class Stdout:
         self.redirect_stdout = redirect_stdout(self.output)
 
     def __enter__(self):
-        self.redirect_stdout.__enter__()
+        self.start()
         return self
 
-    def __exit__(self, exc_type, exc_val, exc_tb):
-        self.redirect_stdout.__exit__(exc_type, exc_val, exc_tb)
+    def __exit__(self, *args, **kwargs):
+        self.stop(*args, **kwargs)
+
+    def start(self):
+        self.redirect_stdout.__enter__()
+
+    def stop(self, exc_type=None, exc_inst=None, exc_tb=None):
+        self.redirect_stdout.__exit__(exc_type, exc_inst, exc_tb)
 
     def value(self):
         return self.output.getvalue()

osbot_utils/utils/Env.py

@@ -20,7 +20,9 @@ def env__pwd():
     return get_env('PWD', '')
 
 def env__old_pwd__remove(value):
-    return value.replace(env__old_pwd(), '')
+    if env__old_pwd() != '/':                           # can't replace with old pwd is just /
+        return value.replace(env__old_pwd(), '')
+    return value
 
 def env__terminal__is__xterm():
     return os.getenv('TERM') == 'xterm'
@@ -91,6 +93,9 @@ def find_dotenv_file(start_path=None, env_file_to_find='.env'):
 def in_github_action():
     return os.getenv('GITHUB_ACTIONS') == 'true'
 
+def in_pytest_with_coverage():
+    return os.getenv('COVERAGE_RUN') == 'true'
+
 def in_python_debugger():
     if sys.gettrace() is not None:              # Check for a trace function
         return True

osbot_utils/version

@@ -1 +1 @@
-v1.35.0
+v1.37.0

{osbot_utils-1.35.0.dist-info → osbot_utils-1.37.0.dist-info}/METADATA

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

@@ -6,7 +6,7 @@ osbot_utils/base_classes/Type_Safe.py,sha256=62eV2AnIAN-7VshhOpvWw0v_DZHJucLq10V
 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=l4l4UKC065Vi-zwyr4Ru_pVALsthCDQSXFR1mCl0DVQ,1187
+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
 osbot_utils/decorators/classes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -229,10 +229,10 @@ osbot_utils/helpers/ssh/SSH__Linux__Amazon.py,sha256=ZJFb7LFTvclAuhH5OoOtJ361NoX
 osbot_utils/helpers/ssh/SSH__Python.py,sha256=O2DAwkbXzwkis8lffoqIL2NPSfYcN44Mr8i9Ey2iMKk,2066
 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=nKds4xTyrF-6A3XMCxVOR37KDzB3nfCQLykrrEsqp2k,6424
-osbot_utils/helpers/trace/Trace_Call__Config.py,sha256=6nJplzrY1adz3WcwTIuwEhBCk1P0U0NbyWRzDyIox_Q,3250
+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__Graph.py,sha256=HCrXRKQI42DIQxxyFLcaosWiOcUyoITbeV17ICdXcXM,1156
-osbot_utils/helpers/trace/Trace_Call__Handler.py,sha256=3gEX-DykEFixfBmD0jBdMhnTujxhNbXkjOhqxNTc9ac,11563
+osbot_utils/helpers/trace/Trace_Call__Handler.py,sha256=hdgiawoC4K2DrMAHbz2706SfEcxPdX9kK0gjyWqjSzQ,12400
 osbot_utils/helpers/trace/Trace_Call__Print_Lines.py,sha256=cy7zLv0_JNxdOIQPfZk6J9bv6AkIW6O643w0ykClXbw,4820
 osbot_utils/helpers/trace/Trace_Call__Print_Traces.py,sha256=2LGeWMGP1uhSojGMmJmL3bH2B5LFIlfYEqEPNqoyKJw,8628
 osbot_utils/helpers/trace/Trace_Call__Stack.py,sha256=pIvZ2yP4tymOQraUR2N5R-qlmg5QijyLxt85zmMajUs,7462
@@ -250,8 +250,8 @@ osbot_utils/testing/Logging.py,sha256=rzO1cCwty1oTucbV1q6U2QBIF87oOcvZoAY_R8SQB8
 osbot_utils/testing/Patch_Print.py,sha256=RfY4HGIM06dF6JTKibnN1Uco8YL05xPWe1jS4MUiWV0,1566
 osbot_utils/testing/Profiler.py,sha256=4em6Lpp0ONRDoDDCZsc_CdAOi_QolKOp4eA7KHN96e4,3365
 osbot_utils/testing/Pytest.py,sha256=R3qdsIXGcNQcu7iobz0RB8AhbbHhc6t757tZoSZRrxA,730
-osbot_utils/testing/Stderr.py,sha256=wi1gfjpsxnBK3aOl2jzCTWI-0En1HtPgEin97148_MQ,459
-osbot_utils/testing/Stdout.py,sha256=XQ9OlOW1aHXY1TiNu8O5b75RoDnoaX5RyMHml3OjlKw,459
+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=oFuaegBlaV0aySkPe1Nzf-mdIKN03oTUKNfKijGz__M,751
 osbot_utils/testing/Temp_File.py,sha256=yZBL9MmcNU4PCQ4xlF4rSss4GylKoX3T_AJF-BlQhdI,1693
 osbot_utils/testing/Temp_Folder.py,sha256=Dbcohr2ciex6w-kB79R41Nuoa0pgpDbKtPGnlMmJ73k,5194
@@ -266,7 +266,7 @@ osbot_utils/utils/Assert.py,sha256=u9XLgYn91QvNWZGyPi29SjPJSXRHlm9andIn3NJEVog,1
 osbot_utils/utils/Call_Stack.py,sha256=MAq_0vMxnbeLfCe9qQz7GwJYaOuXpt3qtQwN6wiXsU0,6595
 osbot_utils/utils/Csv.py,sha256=oHLVpjRJqrLMz9lubMCNEoThXWju5rNTprcwHc1zq2c,1012
 osbot_utils/utils/Dev.py,sha256=HibpQutYy_iG8gGV8g1GztxNN4l29E4Bi7UZaVL6-L8,1203
-osbot_utils/utils/Env.py,sha256=243O6ENzaRjHXp8DIHUuv4Wfk-zHTE18KZr0cU8uWyo,5474
+osbot_utils/utils/Env.py,sha256=9r1xxCDszX1UUOu0dy3Kf_djaU3I39xgB_QdC80Szdo,5669
 osbot_utils/utils/Exceptions.py,sha256=KyOUHkXQ_6jDTq04Xm261dbEZuRidtsM4dgzNwSG8-8,389
 osbot_utils/utils/Files.py,sha256=7W0FmxPvxOapUchEVOKDgUx4JBRs9TCesu60uKkvrto,21765
 osbot_utils/utils/Functions.py,sha256=0E6alPJ0fJpBiJgFOWooCOi265wSRyxxXAJ5CELBnso,3498
@@ -287,8 +287,8 @@ osbot_utils/utils/Toml.py,sha256=dqiegndCJF7V1YT1Tc-b0-Bl6QWyL5q30urmQwMXfMQ,140
 osbot_utils/utils/Version.py,sha256=Ww6ChwTxqp1QAcxOnztkTicShlcx6fbNsWX5xausHrg,422
 osbot_utils/utils/Zip.py,sha256=riPLKkZJxQjVu8lCm19cOTx5uiLPm1HreB9_BzNXi30,12209
 osbot_utils/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-osbot_utils/version,sha256=g15kdH8ycbHrZuIBu1hKNt7B2bEznkpLT_dQR-2S77M,8
-osbot_utils-1.35.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-osbot_utils-1.35.0.dist-info/METADATA,sha256=eW9-c4dTVc2xI7Tf-sqOrYpQOJwHw6hMUAAGRLdbWkQ,1266
-osbot_utils-1.35.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-osbot_utils-1.35.0.dist-info/RECORD,,
+osbot_utils/version,sha256=2lsyLVdcS9K9UON7nV7FJNEMLVIqIhp0nDRL0qX80gE,8
+osbot_utils-1.37.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+osbot_utils-1.37.0.dist-info/METADATA,sha256=9xLglgYIN1kPnaGfr0hMSIVtvm7e_F9h9xEC-cttwAQ,1266
+osbot_utils-1.37.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+osbot_utils-1.37.0.dist-info/RECORD,,