invocation-tree 0.0.9__tar.gz → 0.0.10__tar.gz

{invocation_tree-0.0.9/invocation_tree.egg-info → invocation_tree-0.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: invocation_tree
-Version: 0.0.9
+Version: 0.0.10
 Summary: Generate an invocation tree of functions calls.
 Home-page: https://github.com/bterwijn/invocation_tree
 Author: Bas Terwijn
@@ -165,6 +165,9 @@ tree = invo_tree.blocking()
 print( tree(factorial, 4) ) # show invocation tree of calling factorial(4)
 ```
 ![factorial](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/factorial.gif)
+```
+24
+```
 
 This `permutations()` example shows the depth-first nature of recursive execution:
 
@@ -181,9 +184,12 @@ def permutations(elements, perm, n):
 
 tree = invo_tree.blocking()
 result = tree(permutations, ['L','R'], '', 2)
-print(result) # all permutations of going Left and Right of length 2
+print(result) # all permutations of going Left or Right of length 2
 ```
 ![permutations](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/permutations.gif)
+```
+['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:
@@ -386,7 +392,7 @@ def main():
 main()
 ```
 
-A generator is lazy, meaning that it will only produce its values if you request them via the Iterator Protocol. That means that if you print the iterable produced by a generator it will just print '<generator object ...>'. To print its values you can for example use `list()` that uses the Iterator Protocol to request its values and converts them to a `list`, but then you have used the generator so it no longer has values.
+A generator is lazy, meaning that it will only produce its values if you request them via the Iterator Protocol. That means that if you print the generator it will just print '<generator object ...>'. To print its values you can for example use `list()` that uses the Iterator Protocol to request its values and converts them to a `list` that can be printed. But then you have used the generator so it no longer has values.
 
 ```python
 def my_generator():
@@ -400,7 +406,7 @@ def main():
     print( list(my_gen) ) # printing uses up the generator
     print( list(my_gen) ) # no more values available
     print( list(my_generator()) ) # new generator
-    
+
 main()
 ```
 ```
@@ -410,7 +416,7 @@ main()
 [1, 2, 3]
 ```
 
-By using invocation_tree we can see how a the Iterator Protocol works on the generator.
+By using invocation_tree we can see how the Iterator Protocol works on the generator.
 
 ```python
 import invocation_tree as invo_tree
@@ -448,8 +454,8 @@ def main():
 
 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: 'range_iterator' # short name for range_iterator
+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) )
 ```
 ![generator_expression.gif](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/generator_expression.gif)
@@ -469,18 +475,24 @@ def subtract(pipeline):
 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 sum(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: 'range_iterator' # short name for range_iterator
+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) )
 ```
 ![generator_pipeline.gif](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/generator_pipeline.gif)
@@ -537,7 +549,7 @@ For convenience we provide these functions to set common configurations:
 - **invo_tree.debugger(filename)**, non-blocking for use in debugger tool (open <filename> 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
+- **invo_tree.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.9 → invocation_tree-0.0.10}/README.md

@@ -146,6 +146,9 @@ tree = invo_tree.blocking()
 print( tree(factorial, 4) ) # show invocation tree of calling factorial(4)
 ```
 ![factorial](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/factorial.gif)
+```
+24
+```
 
 This `permutations()` example shows the depth-first nature of recursive execution:
 
@@ -162,9 +165,12 @@ def permutations(elements, perm, n):
 
 tree = invo_tree.blocking()
 result = tree(permutations, ['L','R'], '', 2)
-print(result) # all permutations of going Left and Right of length 2
+print(result) # all permutations of going Left or Right of length 2
 ```
 ![permutations](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/permutations.gif)
+```
+['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:
@@ -367,7 +373,7 @@ def main():
 main()
 ```
 
-A generator is lazy, meaning that it will only produce its values if you request them via the Iterator Protocol. That means that if you print the iterable produced by a generator it will just print '<generator object ...>'. To print its values you can for example use `list()` that uses the Iterator Protocol to request its values and converts them to a `list`, but then you have used the generator so it no longer has values.
+A generator is lazy, meaning that it will only produce its values if you request them via the Iterator Protocol. That means that if you print the generator it will just print '<generator object ...>'. To print its values you can for example use `list()` that uses the Iterator Protocol to request its values and converts them to a `list` that can be printed. But then you have used the generator so it no longer has values.
 
 ```python
 def my_generator():
@@ -381,7 +387,7 @@ def main():
     print( list(my_gen) ) # printing uses up the generator
     print( list(my_gen) ) # no more values available
     print( list(my_generator()) ) # new generator
-    
+
 main()
 ```
 ```
@@ -391,7 +397,7 @@ main()
 [1, 2, 3]
 ```
 
-By using invocation_tree we can see how a the Iterator Protocol works on the generator.
+By using invocation_tree we can see how the Iterator Protocol works on the generator.
 
 ```python
 import invocation_tree as invo_tree
@@ -429,8 +435,8 @@ def main():
 
 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: 'range_iterator' # short name for range_iterator
+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) )
 ```
 ![generator_expression.gif](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/generator_expression.gif)
@@ -450,18 +456,24 @@ def subtract(pipeline):
 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 sum(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: 'range_iterator' # short name for range_iterator
+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) )
 ```
 ![generator_pipeline.gif](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/generator_pipeline.gif)
@@ -518,10 +530,10 @@ For convenience we provide these functions to set common configurations:
 - **invo_tree.debugger(filename)**, non-blocking for use in debugger tool (open <filename> 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
+- **invo_tree.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/).
 
 ## Memory_Graph Package ##
-The [invocation_tree](https://pypi.org/project/invocation-tree/) package visualizes function calls at different moments in time. If instead you want a detailed visualization of your data at the current time, check out the [memory_graph](https://pypi.org/project/memory-graph/) package.
+The [invocation_tree](https://pypi.org/project/invocation-tree/) package visualizes function calls at different moments in time. If instead you want a detailed visualization of your data at the current time, check out the [memory_graph](https://pypi.org/project/memory-graph/) package.

{invocation_tree-0.0.9 → invocation_tree-0.0.10}/images/generator_expression.py

@@ -6,6 +6,6 @@ def main():
 
 tree = invo_tree.gif('generator_expression.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
+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.9 → invocation_tree-0.0.10}/images/generator_pipeline.py

@@ -7,16 +7,22 @@ def subtract(pipeline):
 def multiply(pipeline):
     for a in pipeline:
         yield a * 6
+
+def my_sum(pipeline):
+    total = 0
+    for i in pipeline:
+        total += i
+    return total
         
 def main():
     pipeline = range(1,4)
     pipeline = subtract(pipeline)
     pipeline = (a + 9 for a in pipeline)
     pipeline = multiply(pipeline)
-    return sum(pipeline)
+    return my_sum(pipeline)
 
 tree = invo_tree.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
+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.9 → invocation_tree-0.0.10}/images/iterable.py

@@ -37,7 +37,7 @@ def main():
         print(i)
         
 tree = invo_tree.blocking() # gif('genexp.png')
-#tree.to_string[type(iter(range(0)))] = lambda ri: 'range_iterator' # short name for range_iterator
+#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))

{invocation_tree-0.0.9 → invocation_tree-0.0.10}/invocation_tree/__init__.py

@@ -7,7 +7,7 @@ import html
 import sys
 import difflib 
 
-__version__ = "0.0.9"
+__version__ = "0.0.10"
 __author__ = 'Bas Terwijn'
 
 def highlight_diff(str1, str2):

{invocation_tree-0.0.9 → invocation_tree-0.0.10/invocation_tree.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: invocation_tree
-Version: 0.0.9
+Version: 0.0.10
 Summary: Generate an invocation tree of functions calls.
 Home-page: https://github.com/bterwijn/invocation_tree
 Author: Bas Terwijn
@@ -165,6 +165,9 @@ tree = invo_tree.blocking()
 print( tree(factorial, 4) ) # show invocation tree of calling factorial(4)
 ```
 ![factorial](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/factorial.gif)
+```
+24
+```
 
 This `permutations()` example shows the depth-first nature of recursive execution:
 
@@ -181,9 +184,12 @@ def permutations(elements, perm, n):
 
 tree = invo_tree.blocking()
 result = tree(permutations, ['L','R'], '', 2)
-print(result) # all permutations of going Left and Right of length 2
+print(result) # all permutations of going Left or Right of length 2
 ```
 ![permutations](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/permutations.gif)
+```
+['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:
@@ -386,7 +392,7 @@ def main():
 main()
 ```
 
-A generator is lazy, meaning that it will only produce its values if you request them via the Iterator Protocol. That means that if you print the iterable produced by a generator it will just print '<generator object ...>'. To print its values you can for example use `list()` that uses the Iterator Protocol to request its values and converts them to a `list`, but then you have used the generator so it no longer has values.
+A generator is lazy, meaning that it will only produce its values if you request them via the Iterator Protocol. That means that if you print the generator it will just print '<generator object ...>'. To print its values you can for example use `list()` that uses the Iterator Protocol to request its values and converts them to a `list` that can be printed. But then you have used the generator so it no longer has values.
 
 ```python
 def my_generator():
@@ -400,7 +406,7 @@ def main():
     print( list(my_gen) ) # printing uses up the generator
     print( list(my_gen) ) # no more values available
     print( list(my_generator()) ) # new generator
-    
+
 main()
 ```
 ```
@@ -410,7 +416,7 @@ main()
 [1, 2, 3]
 ```
 
-By using invocation_tree we can see how a the Iterator Protocol works on the generator.
+By using invocation_tree we can see how the Iterator Protocol works on the generator.
 
 ```python
 import invocation_tree as invo_tree
@@ -448,8 +454,8 @@ def main():
 
 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: 'range_iterator' # short name for range_iterator
+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) )
 ```
 ![generator_expression.gif](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/generator_expression.gif)
@@ -469,18 +475,24 @@ def subtract(pipeline):
 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 sum(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: 'range_iterator' # short name for range_iterator
+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) )
 ```
 ![generator_pipeline.gif](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/generator_pipeline.gif)
@@ -537,7 +549,7 @@ For convenience we provide these functions to set common configurations:
 - **invo_tree.debugger(filename)**, non-blocking for use in debugger tool (open <filename> 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
+- **invo_tree.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.9 → invocation_tree-0.0.10}/invocation_tree.egg-info/SOURCES.txt

@@ -73,6 +73,8 @@ images/generator_pipeline22.png
 images/generator_pipeline23.png
 images/generator_pipeline24.png
 images/generator_pipeline25.png
+images/generator_pipeline26.png
+images/generator_pipeline27.png
 images/generator_pipeline3.png
 images/generator_pipeline4.png
 images/generator_pipeline5.png
@@ -108,6 +110,7 @@ images/out.txt
 images/permutations.gif
 images/permutations.py
 images/permutations.py~
+images/permutations0.png
 images/permutations1.png
 images/permutations10.png
 images/permutations11.png

{invocation_tree-0.0.9 → invocation_tree-0.0.10}/setup.py

@@ -11,7 +11,7 @@ long_description_from_readme = (this_directory / "README.md").read_text()
 
 setup(
     name = 'invocation_tree',
-    version = '0.0.9',
+    version = '0.0.10',
     description = 'Generate an invocation tree of functions calls.',
     long_description = long_description_from_readme,
     long_description_content_type = 'text/markdown',