invocation-tree 0.0.21__tar.gz → 0.0.22__tar.gz

{invocation_tree-0.0.21/invocation_tree.egg-info → invocation_tree-0.0.22}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: invocation_tree
-Version: 0.0.21
+Version: 0.0.22
 Summary: Generates an invocation tree of functions calls.
 Author-email: Bas Terwijn <bterwijn@gmail.com>
 License: BSD 2-Clause License
@@ -217,14 +217,28 @@ print(result) # all permutations of going Left or Right of length 2
 ['LL', 'LR', 'RL', 'RR']
 ```
 
-## Hide Variables ##
-In an educational context it can be useful to hide certian variables to avoid unnecessary complexity. This can for example be done with:
+## Hidding ##
+It can be useful to hide certian variables or functions to avoid unnecessary complexity. This can for example be done with:
 
 ```python
 tree = ivt.blocking()
-tree.hide.add('permutations.elements')
-tree.hide.add('permutations.element')
-tree.hide.add('permutations.all_perms')
+tree.hide_vars.add('permutations.elements')
+tree.hide_vars.add('permutations.element')
+tree.hide_vars.add('permutations.all_perms')
+```
+
+Or hide certain function calls:
+
+```python
+tree = ivt.blocking()
+tree.hide_calls.add('namespace.functionname')
+```
+
+Or ignore certain function calls so that all it's children are hidden too:
+
+```python
+tree = ivt.blocking()
+tree.ignore_calls.add('namespace.functionname')
 ```
 
 # Configuration #

{invocation_tree-0.0.21 → invocation_tree-0.0.22}/README.md

@@ -172,14 +172,28 @@ print(result) # all permutations of going Left or Right of length 2
 ['LL', 'LR', 'RL', 'RR']
 ```
 
-## Hide Variables ##
-In an educational context it can be useful to hide certian variables to avoid unnecessary complexity. This can for example be done with:
+## Hidding ##
+It can be useful to hide certian variables or functions to avoid unnecessary complexity. This can for example be done with:
 
 ```python
 tree = ivt.blocking()
-tree.hide.add('permutations.elements')
-tree.hide.add('permutations.element')
-tree.hide.add('permutations.all_perms')
+tree.hide_vars.add('permutations.elements')
+tree.hide_vars.add('permutations.element')
+tree.hide_vars.add('permutations.all_perms')
+```
+
+Or hide certain function calls:
+
+```python
+tree = ivt.blocking()
+tree.hide_calls.add('namespace.functionname')
+```
+
+Or ignore certain function calls so that all it's children are hidden too:
+
+```python
+tree = ivt.blocking()
+tree.ignore_calls.add('namespace.functionname')
 ```
 
 # Configuration #

{invocation_tree-0.0.21 → invocation_tree-0.0.22}/invocation_tree/__init__.py

@@ -7,7 +7,7 @@ import html
 import sys
 import difflib 
 
-__version__ = "0.0.21"
+__version__ = "0.0.22"
 __author__ = 'Bas Terwijn'
 
 def highlight_diff(str1, str2):
@@ -73,7 +73,7 @@ class Invocation_Tree:
                  color_active = '#ffffff', 
                  color_returned = '#ffcccc', 
                  to_string=None, 
-                 hide=None,
+                 hide_vars=None,
                  cleanup=True,
                  quiet=True):
         # --- config
@@ -93,9 +93,9 @@ class Invocation_Tree:
         self.to_string = {}
         if not to_string is None:
             self.to_string = to_string
-        self.hide = set()
-        if not hide is None:
-            self.hide = hide
+        self.hide_vars = set()
+        if not hide_vars is None:
+            self.hide_vars = hide_vars
         self.cleanup = cleanup
         self.quiet = quiet
         # --- core
@@ -108,7 +108,9 @@ class Invocation_Tree:
         self.is_highlighted = False
         self.graph = None
         self.prev_global_tracer = None
-        self.ignore_calls = {'Invocation_Tree.__exit__', 'Invocation_Tree.stop_trace'}
+        self.hide_calls = {'Invocation_Tree.__exit__', 'Invocation_Tree.stop_trace'}
+        self.ignore_calls = set()
+        self.ignoring_call = None
 
     def __repr__(self):
         return f'Invocation_Tree(filename={repr(self.filename)}, show={self.show}, block={self.block}, each_line={self.each_line}, gifcount={self.gifcount})'
@@ -177,7 +179,7 @@ class Invocation_Tree:
         for var,val in local_vars.items():
             var_name = class_fun_name+'..'+var
             val_name = class_fun_name+'.'+var
-            if filter_variables(var,val) and not val_name in self.hide:
+            if filter_variables(var,val) and not val_name in self.hide_vars:
                 table += '</TR>\n  <TR>'
                 hightlighted_var = self.get_hightlighted_content(tree_node, var_name, var, use_old_content)
                 hightlighted_val = self.get_hightlighted_content(tree_node, val_name, val, use_old_content, use_repr=True)
@@ -185,7 +187,7 @@ class Invocation_Tree:
                 table += '<TD ALIGN="left">'+ hightlighted_content  +'</TD>'
         if is_returned:
             return_name = class_fun_name+'.return'
-            if not return_name in self.hide:
+            if not return_name in self.hide_vars:
                 table += '</TR>\n  <TR>'
                 hightlighted_content = self.get_hightlighted_content(tree_node, return_name, return_value, use_old_content, use_repr=True)
                 table += '<TD ALIGN="left">'+ 'return ' + hightlighted_content +'</TD>'
@@ -259,14 +261,24 @@ class Invocation_Tree:
 
     def trace(self, frame, event, arg):
         class_fun_name = get_class_function_name(frame)
-        if not class_fun_name in self.ignore_calls:
+        if not class_fun_name in self.hide_calls:
+            skip_return = False
+            if event == 'call':
+                if class_fun_name in self.ignore_calls:
+                    self.ignoring_call = class_fun_name
+            elif event == 'return':
+                if class_fun_name == self.ignoring_call:
+                    self.ignoring_call = None
+                    skip_return = True
+            if self.ignoring_call is not None:
+                return
             if event == 'call':
                 self.stack.append(Tree_Node(self.node_id, frame, None))
                 self.node_id += 1
                 if len(self.stack)>1:
                     self.add_edge(self.stack[-2], self.stack[-1])
                 self.output_graph(frame, event)
-            elif event == 'return':
+            elif event == 'return' and not skip_return:
                 self.stack[-1].return_value = arg
                 self.returned.append(self.stack.pop())
                 self.output_graph(frame, event)

{invocation_tree-0.0.21 → invocation_tree-0.0.22/invocation_tree.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: invocation_tree
-Version: 0.0.21
+Version: 0.0.22
 Summary: Generates an invocation tree of functions calls.
 Author-email: Bas Terwijn <bterwijn@gmail.com>
 License: BSD 2-Clause License
@@ -217,14 +217,28 @@ print(result) # all permutations of going Left or Right of length 2
 ['LL', 'LR', 'RL', 'RR']
 ```
 
-## Hide Variables ##
-In an educational context it can be useful to hide certian variables to avoid unnecessary complexity. This can for example be done with:
+## Hidding ##
+It can be useful to hide certian variables or functions to avoid unnecessary complexity. This can for example be done with:
 
 ```python
 tree = ivt.blocking()
-tree.hide.add('permutations.elements')
-tree.hide.add('permutations.element')
-tree.hide.add('permutations.all_perms')
+tree.hide_vars.add('permutations.elements')
+tree.hide_vars.add('permutations.element')
+tree.hide_vars.add('permutations.all_perms')
+```
+
+Or hide certain function calls:
+
+```python
+tree = ivt.blocking()
+tree.hide_calls.add('namespace.functionname')
+```
+
+Or ignore certain function calls so that all it's children are hidden too:
+
+```python
+tree = ivt.blocking()
+tree.ignore_calls.add('namespace.functionname')
 ```
 
 # Configuration #

{invocation_tree-0.0.21 → invocation_tree-0.0.22}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "invocation_tree"
-version = "0.0.21"
+version = "0.0.22"
 description = "Generates an invocation tree of functions calls."
 authors = [
     {name = "Bas Terwijn", email = "bterwijn@gmail.com"}