invocation-tree 0.0.4__tar.gz → 0.0.5__tar.gz

{invocation_tree-0.0.4/invocation_tree.egg-info → invocation_tree-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: invocation_tree
-Version: 0.0.4
+Version: 0.0.5
 Summary: Generate an invocation tree of functions calls.
 Home-page: https://github.com/bterwijn/invocation_tree
 Author: Bas Terwijn
@@ -48,9 +48,9 @@ def my_round(value, digits=0):
     shift = 10 ** digits
     return math.floor(value * shift + 0.5) / shift
 
-def passing_students(avg):
+def passing_students(averages):
     return [student 
-        for student, average in avg.items() 
+        for student, average in averages.items() 
         if average >= 5.5]
 
 if __name__ == '__main__':
@@ -59,7 +59,7 @@ if __name__ == '__main__':
 ```
 ![invocation tree](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/students.gif)
 
-Each node in the tree represents a function call, and node's color indicates its state:
+Each node in the tree represents a function call, and the node's color indicates its state:
 
  - White: The function is currently being executed (it is at the top of the call stack).
  - Green: The function is paused and will resume execution later (it is lower down on the call stack).
@@ -67,10 +67,10 @@ Each node in the tree represents a function call, and node's color indicates its
 
 For every function, the package displays its **local variables** and **return value**. Changes to these values over time are highlighted using bold text and gray shading to make them easy to track.
 
-The [invocation_tree](https://pypi.org/project/invocation-tree/) package visualizes function calls at different moments in time. If you want a more 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 you want a more detailed visualization of your data at the current time, check out the [memory_graph](https://pypi.org/project/memory-graph/) package.
 
 ## Blocking ##
-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) where a change of value occured, use instead:
+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_line()
@@ -98,7 +98,7 @@ def factorial(n):
     return n * factorial(n - 1)
 
 tree = invo_tree.blocking()
-tree(factorial, 4) # show invocation tree of calling factorial(4)
+print( tree(factorial, 4) ) # show invocation tree of calling factorial(4)
 ```
 ![factorial](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/factorial.gif)
 
@@ -121,7 +121,7 @@ print(result) # all permutations of going Left and Right of length 2
 ```
 ![permutations](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/permutations.gif)
 
-## Hide variables ##
+## 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:
 
 ```python
@@ -167,12 +167,21 @@ tree = invo_tree.Invocation_Tree()
 
 For convenience we provide these functions to set common configurations:
 
-- **invo_tree.blocking()**, for blocking on function call and return
-- **invo_tree.blocking_each_line()**, for blocking on each line of the program
-- **invo_tree.debugger()**, for use in debugger tool (open 'tree.pdf') manually
+- **invo_tree.blocking(filename)**, for blocking on function call and return
+- **invo_tree.blocking_each_line(filename)**, for blocking on each line of the program
+- **invo_tree.debugger(filename)**, for use in debugger tool (open <filename> manually)
 - **invo_tree.gif(filename)**, for generating many output files on function call and return for gif creation
 - **invo_tree.gif_each_line(filename)**, for generating many output files on each line for gif creation
 
 # 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/).
+
+## Author ##
+Bas Terwijn
+
+## Inspiration ##
+Inspired by [rcviz](https://github.com/carlsborg/rcviz).
+
+## Supported by ##
+<img src="https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/uva.png" alt="University of Amsterdam" width="600">

{invocation_tree-0.0.4 → invocation_tree-0.0.5}/README.md

@@ -29,9 +29,9 @@ def my_round(value, digits=0):
     shift = 10 ** digits
     return math.floor(value * shift + 0.5) / shift
 
-def passing_students(avg):
+def passing_students(averages):
     return [student 
-        for student, average in avg.items() 
+        for student, average in averages.items() 
         if average >= 5.5]
 
 if __name__ == '__main__':
@@ -40,7 +40,7 @@ if __name__ == '__main__':
 ```
 ![invocation tree](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/students.gif)
 
-Each node in the tree represents a function call, and node's color indicates its state:
+Each node in the tree represents a function call, and the node's color indicates its state:
 
  - White: The function is currently being executed (it is at the top of the call stack).
  - Green: The function is paused and will resume execution later (it is lower down on the call stack).
@@ -48,10 +48,10 @@ Each node in the tree represents a function call, and node's color indicates its
 
 For every function, the package displays its **local variables** and **return value**. Changes to these values over time are highlighted using bold text and gray shading to make them easy to track.
 
-The [invocation_tree](https://pypi.org/project/invocation-tree/) package visualizes function calls at different moments in time. If you want a more 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 you want a more detailed visualization of your data at the current time, check out the [memory_graph](https://pypi.org/project/memory-graph/) package.
 
 ## Blocking ##
-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) where a change of value occured, use instead:
+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_line()
@@ -79,7 +79,7 @@ def factorial(n):
     return n * factorial(n - 1)
 
 tree = invo_tree.blocking()
-tree(factorial, 4) # show invocation tree of calling factorial(4)
+print( tree(factorial, 4) ) # show invocation tree of calling factorial(4)
 ```
 ![factorial](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/factorial.gif)
 
@@ -102,7 +102,7 @@ print(result) # all permutations of going Left and Right of length 2
 ```
 ![permutations](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/permutations.gif)
 
-## Hide variables ##
+## 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:
 
 ```python
@@ -148,12 +148,21 @@ tree = invo_tree.Invocation_Tree()
 
 For convenience we provide these functions to set common configurations:
 
-- **invo_tree.blocking()**, for blocking on function call and return
-- **invo_tree.blocking_each_line()**, for blocking on each line of the program
-- **invo_tree.debugger()**, for use in debugger tool (open 'tree.pdf') manually
+- **invo_tree.blocking(filename)**, for blocking on function call and return
+- **invo_tree.blocking_each_line(filename)**, for blocking on each line of the program
+- **invo_tree.debugger(filename)**, for use in debugger tool (open <filename> manually)
 - **invo_tree.gif(filename)**, for generating many output files on function call and return for gif creation
 - **invo_tree.gif_each_line(filename)**, for generating many output files on each line for gif creation
 
 # 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/).
+
+## Author ##
+Bas Terwijn
+
+## Inspiration ##
+Inspired by [rcviz](https://github.com/carlsborg/rcviz).
+
+## Supported by ##
+<img src="https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/uva.png" alt="University of Amsterdam" width="600">

{invocation_tree-0.0.4 → invocation_tree-0.0.5}/invocation_tree/__init__.py

@@ -7,7 +7,7 @@ import html
 import sys
 import difflib 
 
-__version__ = "0.0.4"
+__version__ = "0.0.5"
 __author__ = 'Bas Terwijn'
 
 def highlight_diff(str1, str2):
@@ -261,13 +261,13 @@ class Invocation_Tree:
                 self.output_graph(frame, event)
         return self.trace_calls
 
-def blocking():
-    return Invocation_Tree()
+def blocking(filename='tree.pdf'):
+    return Invocation_Tree(filename=filename)
 
-def blocking_each_line():
-    return Invocation_Tree(each_line=True)
+def blocking_each_line(filename='tree.pdf'):
+    return Invocation_Tree(filename=filename, each_line=True)
 
-def debugger():
+def debugger(filename='tree.pdf'):
     return Invocation_Tree(show=False, block=False, each_line=True)
 
 def gif(filename='tree.png'):

{invocation_tree-0.0.4 → invocation_tree-0.0.5/invocation_tree.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: invocation_tree
-Version: 0.0.4
+Version: 0.0.5
 Summary: Generate an invocation tree of functions calls.
 Home-page: https://github.com/bterwijn/invocation_tree
 Author: Bas Terwijn
@@ -48,9 +48,9 @@ def my_round(value, digits=0):
     shift = 10 ** digits
     return math.floor(value * shift + 0.5) / shift
 
-def passing_students(avg):
+def passing_students(averages):
     return [student 
-        for student, average in avg.items() 
+        for student, average in averages.items() 
         if average >= 5.5]
 
 if __name__ == '__main__':
@@ -59,7 +59,7 @@ if __name__ == '__main__':
 ```
 ![invocation tree](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/students.gif)
 
-Each node in the tree represents a function call, and node's color indicates its state:
+Each node in the tree represents a function call, and the node's color indicates its state:
 
  - White: The function is currently being executed (it is at the top of the call stack).
  - Green: The function is paused and will resume execution later (it is lower down on the call stack).
@@ -67,10 +67,10 @@ Each node in the tree represents a function call, and node's color indicates its
 
 For every function, the package displays its **local variables** and **return value**. Changes to these values over time are highlighted using bold text and gray shading to make them easy to track.
 
-The [invocation_tree](https://pypi.org/project/invocation-tree/) package visualizes function calls at different moments in time. If you want a more 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 you want a more detailed visualization of your data at the current time, check out the [memory_graph](https://pypi.org/project/memory-graph/) package.
 
 ## Blocking ##
-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) where a change of value occured, use instead:
+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_line()
@@ -98,7 +98,7 @@ def factorial(n):
     return n * factorial(n - 1)
 
 tree = invo_tree.blocking()
-tree(factorial, 4) # show invocation tree of calling factorial(4)
+print( tree(factorial, 4) ) # show invocation tree of calling factorial(4)
 ```
 ![factorial](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/factorial.gif)
 
@@ -121,7 +121,7 @@ print(result) # all permutations of going Left and Right of length 2
 ```
 ![permutations](https://raw.githubusercontent.com/bterwijn/invocation_tree/main/images/permutations.gif)
 
-## Hide variables ##
+## 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:
 
 ```python
@@ -167,12 +167,21 @@ tree = invo_tree.Invocation_Tree()
 
 For convenience we provide these functions to set common configurations:
 
-- **invo_tree.blocking()**, for blocking on function call and return
-- **invo_tree.blocking_each_line()**, for blocking on each line of the program
-- **invo_tree.debugger()**, for use in debugger tool (open 'tree.pdf') manually
+- **invo_tree.blocking(filename)**, for blocking on function call and return
+- **invo_tree.blocking_each_line(filename)**, for blocking on each line of the program
+- **invo_tree.debugger(filename)**, for use in debugger tool (open <filename> manually)
 - **invo_tree.gif(filename)**, for generating many output files on function call and return for gif creation
 - **invo_tree.gif_each_line(filename)**, for generating many output files on each line for gif creation
 
 # 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/).
+
+## Author ##
+Bas Terwijn
+
+## Inspiration ##
+Inspired by [rcviz](https://github.com/carlsborg/rcviz).
+
+## Supported by ##
+<img src="https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/uva.png" alt="University of Amsterdam" width="600">

{invocation_tree-0.0.4 → invocation_tree-0.0.5}/invocation_tree.egg-info/SOURCES.txt

@@ -9,6 +9,7 @@ images/create_images.sh~
 images/factorial.gif
 images/factorial.py
 images/factorial.py~
+images/factorial0.png
 images/factorial1.png
 images/factorial2.png
 images/factorial3.png
@@ -23,6 +24,7 @@ images/invocation_tree0.pdf
 images/permutations.gif
 images/permutations.py
 images/permutations.py~
+images/permutations0.png
 images/permutations1.png
 images/permutations10.png
 images/permutations11.png
@@ -41,6 +43,7 @@ images/student.gif
 images/students.gif
 images/students.py
 images/students.py~
+images/students0.png
 images/students1.png
 images/students10.png
 images/students11.png

{invocation_tree-0.0.4 → invocation_tree-0.0.5}/setup.py

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