invocation-tree 0.0.11__tar.gz → 0.0.12__tar.gz

{invocation_tree-0.0.11/invocation_tree.egg-info → invocation_tree-0.0.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: invocation_tree
-Version: 0.0.11
+Version: 0.0.12
 Summary: Generate an invocation tree of functions calls.
 Home-page: https://github.com/bterwijn/invocation_tree
 Author: Bas Terwijn
@@ -32,7 +32,7 @@ The [invocation_tree](https://pypi.org/project/invocation-tree/) package is desi
 ```
 
 ```python
-import invocation_tree as invo_tree
+import invocation_tree as ivt
 
 def main():
     a = 1
@@ -52,7 +52,7 @@ def add(a, b):
 def multiply(a, b):
     return a * b
 
-tree = invo_tree.blocking()
+tree = ivt.blocking()
 print( tree(main) ) # show invocation tree starting at main
 ```
 Running the program and pressing <Enter> a number of times results in:
@@ -96,7 +96,7 @@ ___
 In this more interesting example we compute which students pass a course by using list and dictionary comprehensions.
 
 ```python
-import invocation_tree as invo_tree
+import invocation_tree as ivt
 from decimal import Decimal, ROUND_HALF_UP
 
 def main():
@@ -123,7 +123,7 @@ def passing_students(averages):
         if average >= 5.5]
 
 if __name__ == '__main__':
-    tree = invo_tree.blocking()
+    tree = ivt.blocking()
     tree(main)
 ```
 ![students](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/students.gif)
@@ -135,14 +135,14 @@ if __name__ == '__main__':
 The program blocks execution at every function call and return statement, printing the current location in the source code. Press the <Enter> key to continue execution. To block at every line of the program (like in a debugger tool) and only where a change of value occured, use instead:
 
 ```python
-    tree = invo_tree.blocking_each_change()
+    tree = ivt.blocking_each_change()
 ```
 
 # Debugger #
 To visualize the invocation tree in a debugger tool, such as the integrated debugger in Visual Studio Code, use instead:
 
 ```python
-    tree = invo_tree.debugger()
+    tree = ivt.debugger()
 ```
 
 and open the 'tree.pdf' file manually.
@@ -152,14 +152,14 @@ and open the 'tree.pdf' file manually.
 An invocation tree is particularly helpful to better understand recursion. A simple `factorial()` example:
 
 ```python
-import invocation_tree as invo_tree
+import invocation_tree as ivt
 
 def factorial(n):
     if n <= 1:
         return 1
     return n * factorial(n - 1)
 
-tree = invo_tree.blocking()
+tree = ivt.blocking()
 print( tree(factorial, 4) ) # show invocation tree of calling factorial(4)
 ```
 ![factorial](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/factorial.gif)
@@ -170,7 +170,7 @@ print( tree(factorial, 4) ) # show invocation tree of calling factorial(4)
 This `permutations()` example shows the depth-first nature of recursive execution:
 
 ```python
-import invocation_tree as invo_tree
+import invocation_tree as ivt
 
 def permutations(elements, perm, n):
     if n==0:
@@ -180,7 +180,7 @@ def permutations(elements, perm, n):
         all_perms.extend(permutations(elements, perm + element, n-1))
     return all_perms
 
-tree = invo_tree.blocking()
+tree = ivt.blocking()
 result = tree(permutations, ['L','R'], '', 2)
 print(result) # all permutations of going Left or Right of length 2
 ```
@@ -193,7 +193,7 @@ print(result) # all permutations of going Left or Right of length 2
 In an educational context it can be useful to hide certian variables to avoid unnecessary complexity. This can for example be done with:
 
 ```python
-tree = invo_tree.blocking()
+tree = ivt.blocking()
 tree.hide.add('permutations.elements')
 tree.hide.add('permutations.element')
 tree.hide.add('permutations.all_perms')
@@ -203,7 +203,7 @@ tree.hide.add('permutations.all_perms')
 These invocation_tree configurations are available for an `Invocation_Tree` objects:
 
 ```python
-tree = invo_tree.Invocation_Tree()
+tree = ivt.Invocation_Tree()
 ```
 
 - **tree.filename** : str  
@@ -235,12 +235,12 @@ tree = invo_tree.Invocation_Tree()
 
 For convenience we provide these functions to set common configurations:
 
-- **invo_tree.blocking(filename)**, blocks on function call and return
-- **invo_tree.blocking_each_change(filename)**, blocks on each change of value
-- **invo_tree.debugger(filename)**, non-blocking for use in debugger tool (open &lt;filename&gt; manually)
-- **invo_tree.gif(filename)**, generates many output files on function call and return for gif creation
-- **invo_tree.gif_each_change(filename)**, generates many output files on each change of value for gif creation
-- **invo_tree.non_blocking(filename)**, non-blocking on each function call and return
+- **ivt.blocking(filename)**, blocks on function call and return
+- **ivt.blocking_each_change(filename)**, blocks on each change of value
+- **ivt.debugger(filename)**, non-blocking for use in debugger tool (open &lt;filename&gt; manually)
+- **ivt.gif(filename)**, generates many output files on function call and return for gif creation
+- **ivt.gif_each_change(filename)**, generates many output files on each change of value for gif creation
+- **ivt.non_blocking(filename)**, non-blocking on each function call and return
 
 # Troubleshooting #
 - Adobe Acrobat Reader [doesn't refresh a PDF file](https://superuser.com/questions/337011/windows-pdf-viewer-that-auto-refreshes-pdf-when-compiling-with-pdflatex) when it changes on disk and blocks updates which results in an `Could not open 'somefile.pdf' for writing : Permission denied` error. One solution is to install a PDF reader that does refresh ([Evince](https://www.fosshub.com/Evince.html), [Okular](https://okular.kde.org/), [SumatraPDF](https://www.sumatrapdfreader.org/), ...) and set it as the default PDF reader. Another solution is to save the tree to a different [Graphviz Output Format](https://graphviz.org/docs/outputs/).

{invocation_tree-0.0.11 → invocation_tree-0.0.12}/README.md

@@ -13,7 +13,7 @@ The [invocation_tree](https://pypi.org/project/invocation-tree/) package is desi
 ```
 
 ```python
-import invocation_tree as invo_tree
+import invocation_tree as ivt
 
 def main():
     a = 1
@@ -33,7 +33,7 @@ def add(a, b):
 def multiply(a, b):
     return a * b
 
-tree = invo_tree.blocking()
+tree = ivt.blocking()
 print( tree(main) ) # show invocation tree starting at main
 ```
 Running the program and pressing <Enter> a number of times results in:
@@ -77,7 +77,7 @@ ___
 In this more interesting example we compute which students pass a course by using list and dictionary comprehensions.
 
 ```python
-import invocation_tree as invo_tree
+import invocation_tree as ivt
 from decimal import Decimal, ROUND_HALF_UP
 
 def main():
@@ -104,7 +104,7 @@ def passing_students(averages):
         if average >= 5.5]
 
 if __name__ == '__main__':
-    tree = invo_tree.blocking()
+    tree = ivt.blocking()
     tree(main)
 ```
 ![students](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/students.gif)
@@ -116,14 +116,14 @@ if __name__ == '__main__':
 The program blocks execution at every function call and return statement, printing the current location in the source code. Press the <Enter> key to continue execution. To block at every line of the program (like in a debugger tool) and only where a change of value occured, use instead:
 
 ```python
-    tree = invo_tree.blocking_each_change()
+    tree = ivt.blocking_each_change()
 ```
 
 # Debugger #
 To visualize the invocation tree in a debugger tool, such as the integrated debugger in Visual Studio Code, use instead:
 
 ```python
-    tree = invo_tree.debugger()
+    tree = ivt.debugger()
 ```
 
 and open the 'tree.pdf' file manually.
@@ -133,14 +133,14 @@ and open the 'tree.pdf' file manually.
 An invocation tree is particularly helpful to better understand recursion. A simple `factorial()` example:
 
 ```python
-import invocation_tree as invo_tree
+import invocation_tree as ivt
 
 def factorial(n):
     if n <= 1:
         return 1
     return n * factorial(n - 1)
 
-tree = invo_tree.blocking()
+tree = ivt.blocking()
 print( tree(factorial, 4) ) # show invocation tree of calling factorial(4)
 ```
 ![factorial](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/factorial.gif)
@@ -151,7 +151,7 @@ print( tree(factorial, 4) ) # show invocation tree of calling factorial(4)
 This `permutations()` example shows the depth-first nature of recursive execution:
 
 ```python
-import invocation_tree as invo_tree
+import invocation_tree as ivt
 
 def permutations(elements, perm, n):
     if n==0:
@@ -161,7 +161,7 @@ def permutations(elements, perm, n):
         all_perms.extend(permutations(elements, perm + element, n-1))
     return all_perms
 
-tree = invo_tree.blocking()
+tree = ivt.blocking()
 result = tree(permutations, ['L','R'], '', 2)
 print(result) # all permutations of going Left or Right of length 2
 ```
@@ -174,7 +174,7 @@ print(result) # all permutations of going Left or Right of length 2
 In an educational context it can be useful to hide certian variables to avoid unnecessary complexity. This can for example be done with:
 
 ```python
-tree = invo_tree.blocking()
+tree = ivt.blocking()
 tree.hide.add('permutations.elements')
 tree.hide.add('permutations.element')
 tree.hide.add('permutations.all_perms')
@@ -184,7 +184,7 @@ tree.hide.add('permutations.all_perms')
 These invocation_tree configurations are available for an `Invocation_Tree` objects:
 
 ```python
-tree = invo_tree.Invocation_Tree()
+tree = ivt.Invocation_Tree()
 ```
 
 - **tree.filename** : str  
@@ -216,12 +216,12 @@ tree = invo_tree.Invocation_Tree()
 
 For convenience we provide these functions to set common configurations:
 
-- **invo_tree.blocking(filename)**, blocks on function call and return
-- **invo_tree.blocking_each_change(filename)**, blocks on each change of value
-- **invo_tree.debugger(filename)**, non-blocking for use in debugger tool (open &lt;filename&gt; manually)
-- **invo_tree.gif(filename)**, generates many output files on function call and return for gif creation
-- **invo_tree.gif_each_change(filename)**, generates many output files on each change of value for gif creation
-- **invo_tree.non_blocking(filename)**, non-blocking on each function call and return
+- **ivt.blocking(filename)**, blocks on function call and return
+- **ivt.blocking_each_change(filename)**, blocks on each change of value
+- **ivt.debugger(filename)**, non-blocking for use in debugger tool (open &lt;filename&gt; manually)
+- **ivt.gif(filename)**, generates many output files on function call and return for gif creation
+- **ivt.gif_each_change(filename)**, generates many output files on each change of value for gif creation
+- **ivt.non_blocking(filename)**, non-blocking on each function call and return
 
 # Troubleshooting #
 - Adobe Acrobat Reader [doesn't refresh a PDF file](https://superuser.com/questions/337011/windows-pdf-viewer-that-auto-refreshes-pdf-when-compiling-with-pdflatex) when it changes on disk and blocks updates which results in an `Could not open 'somefile.pdf' for writing : Permission denied` error. One solution is to install a PDF reader that does refresh ([Evince](https://www.fosshub.com/Evince.html), [Okular](https://okular.kde.org/), [SumatraPDF](https://www.sumatrapdfreader.org/), ...) and set it as the default PDF reader. Another solution is to save the tree to a different [Graphviz Output Format](https://graphviz.org/docs/outputs/).

invocation_tree-0.0.12/images/#generator_function.py#

@@ -0,0 +1,13 @@
+import invocation_tree as invo_tree
+
+def my_generator():
+    yield 1
+    yield 2
+    yield 3
+
+def main():
+    result = list(my_generator())
+    print('result:', result)
+
+tree = invo_tree.gif('generator_function.png')
+tree(main)

invocation_tree-0.0.12/images/compute.py

@@ -0,0 +1,22 @@
+import invocation_tree as ivt
+
+def main():
+    a = 1
+    a = expression(a)
+    return multiply(a, 6)
+    
+def expression(a):
+    a = subtract(a, 3)
+    return add(a, 9)
+    
+def subtract(a, b):
+    return a - b
+
+def add(a, b):
+    return a + b
+
+def multiply(a, b):
+    return a * b
+
+tree = ivt.gif('compute.png')
+print( tree(main) )

invocation_tree-0.0.11/images/compute.py → invocation_tree-0.0.12/images/compute.py~

@@ -1,13 +1,13 @@
 import invocation_tree as invo_tree
 
 def main():
-    a = 1
+    a = 10
     a = expression(a)
     return multiply(a, 6)
     
 def expression(a):
-    a = subtract(a, 3)
-    return add(a, 9)
+    a = subtract(a, 5)
+    return add(a, 2)
     
 def subtract(a, b):
     return a - b

invocation_tree-0.0.12/images/create_images.sh~

@@ -0,0 +1,4 @@
+
+python students.py
+rm students0.png
+bash create_gif.sh students

invocation_tree-0.0.12/images/eager_pipeline.py~

@@ -0,0 +1,28 @@
+import invocation_tree as invo_tree
+
+def subtract(pipeline):
+    for a in pipeline:
+        yield a - 3
+
+def multiply(pipeline):
+    for a in pipeline:
+        yield a * 6
+
+def my_sum(pipeline):
+    total = 0
+    for i in pipeline:
+        total += i
+    return total # return not yield, so not lazy
+        
+def main():
+    pipeline = range(1,4)
+    pipeline = subtract(pipeline)
+    pipeline = (a + 9 for a in pipeline)
+    pipeline = multiply(pipeline)
+    return my_sum(pipeline)
+
+tree = invo_tree.blocking()
+import types
+tree.to_string[types.GeneratorType]  = lambda x: 'generator' # short name for generators
+tree.to_string[type(iter(range(0)))] = lambda x: 'iterator'  # short name for iterator
+print( tree(main) )

{invocation_tree-0.0.11 → invocation_tree-0.0.12}/images/factorial.py

@@ -1,9 +1,9 @@
-import invocation_tree as invo_tree
+import invocation_tree as ivt
 
 def factorial(n):
     if n <= 1:
         return 1
     return n * factorial(n - 1)
 
-tree = invo_tree.gif('factorial.png')
+tree = ivt.gif('factorial.png')
 tree(factorial, 4)

invocation_tree-0.0.12/images/factorial.py~

@@ -0,0 +1,11 @@
+import invocation_tree
+
+def factorial(n):
+    if n <= 0:
+        return 1
+    return n * factorial(n - 1)
+
+invocation_tree = invocation_tree.Invocation_Tree()
+invocation_tree.block = False
+
+print( invocation_tree(factorial, 4) )

invocation_tree-0.0.12/images/generator_expression.py~

@@ -0,0 +1,9 @@
+import invocation_tree as invo_tree
+
+def main():
+    iterable_in = range(1,4)
+    iterable_out = (i*10 for i in iterable_in) # generator expression
+    print(list(iterable_out))
+
+tree = invo_tree.gif('generator_function.png')
+tree(main)

invocation_tree-0.0.12/images/generator_pipeline.py~

@@ -0,0 +1,26 @@
+import invocation_tree as invo_tree
+
+def subtract(pipeline):
+    for a in pipeline:
+        yield a - 7
+
+def add(pipeline):
+    for a in pipeline:
+        yield a + 2
+
+def multiply(pipeline):
+    for a in pipeline:
+        yield a * 6
+        
+def main():
+    pipeline = range(1,4)
+    pipeline = subtract(pipeline)
+    pipeline = (a+2 for a in pipeline)
+    pipeline = multiply(pipeline)
+    return list(pipeline)
+
+tree = invo_tree.blocking() # gif('generator_pipeline.png')
+import types
+tree.to_string[types.GeneratorType]  = lambda x: 'generator'      # short name for generators
+tree.to_string[type(iter(range(0)))] = lambda x: 'range_iterator' # short name for range_iterator
+print( tree(main) )

invocation_tree-0.0.12/images/iterable.py

@@ -0,0 +1,44 @@
+import invocation_tree as ivt
+
+class My_Iterator:
+
+    def __init__(self, my_iterable):
+        self.value = my_iterable.start
+        self.my_iterable = my_iterable
+
+    def __repr__(self):
+        return f'My_Iterator value:{self.value}'
+        
+    def __next__(self):
+        prev = self.value
+        self.value += self.my_iterable.step
+        if prev < self.my_iterable.stop:
+            return prev
+        raise StopIteration()
+
+class My_Iterable:
+
+    def __init__(self, stop, start=0, step=1):
+        self.stop = stop
+        self.step = step
+        self.start = start
+        print('self:',self)
+
+    def __repr__(self):
+        return f'My_Iterable start:{self.start} stop:{self.stop} step:{self.step}'
+
+    def __iter__(self):
+        return My_Iterator(self)
+
+    
+def main():
+    iterable = My_Iterable(start=1, stop=3)
+    for i in iterable:
+        print(i)
+        
+tree = ivt.blocking() # gif('genexp.png')
+#tree.to_string[type(iter(range(0)))] = lambda ri: 'iterator' # short name for iterator
+#tree.to_string[types.GeneratorType] = lambda gen: 'generator'      # short name for generators
+tree.cleanup = False
+print('sum:', tree(main))
+#print('sum:', main())