invocation-tree 0.0.6__tar.gz → 0.0.8__tar.gz

{invocation_tree-0.0.6/invocation_tree.egg-info → invocation_tree-0.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: invocation_tree
-Version: 0.0.6
+Version: 0.0.8
 Summary: Generate an invocation tree of functions calls.
 Home-page: https://github.com/bterwijn/invocation_tree
 Author: Bas Terwijn
@@ -29,7 +29,7 @@ The [invocation_tree](https://pypi.org/project/invocation-tree/) package is desi
 
 ```python
 import invocation_tree as invo_tree
-import math 
+from decimal import Decimal, ROUND_HALF_UP
 
 def main():
     students = {'Ann':[7.5, 8.0], 
@@ -42,9 +42,9 @@ def main():
 
 def compute_average(grades):
     average = sum(grades)/len(grades)
-    return my_round(average, 1)
+    return half_up_round(average, 1)
     
-def my_round(value, digits=0):
+def half_up_round(value, digits=0):
     """ High-precision half-up rounding of 'value' to a specified number of 'digits'. """
     return float(Decimal(str(value)).quantize(Decimal(f"1e-{digits}"),
                                               rounding=ROUND_HALF_UP))
@@ -72,7 +72,7 @@ For every function, the package displays its **local variables** and **return va
 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()
+    tree = invo_tree.blocking_each_change()
 ```
 
 # Debugger #
@@ -166,14 +166,13 @@ tree = invo_tree.Invocation_Tree()
 
 For convenience we provide these functions to set common configurations:
 
-- **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.blocking(filename)**, blocks on function call and return
+- **invo_tree.blocking_each_change(filename)**, blocks on each change of value
 - **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
+- **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
 
 # 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 ##

{invocation_tree-0.0.6 → invocation_tree-0.0.8}/README.md

@@ -10,7 +10,7 @@ The [invocation_tree](https://pypi.org/project/invocation-tree/) package is desi
 
 ```python
 import invocation_tree as invo_tree
-import math 
+from decimal import Decimal, ROUND_HALF_UP
 
 def main():
     students = {'Ann':[7.5, 8.0], 
@@ -23,9 +23,9 @@ def main():
 
 def compute_average(grades):
     average = sum(grades)/len(grades)
-    return my_round(average, 1)
+    return half_up_round(average, 1)
     
-def my_round(value, digits=0):
+def half_up_round(value, digits=0):
     """ High-precision half-up rounding of 'value' to a specified number of 'digits'. """
     return float(Decimal(str(value)).quantize(Decimal(f"1e-{digits}"),
                                               rounding=ROUND_HALF_UP))
@@ -53,7 +53,7 @@ For every function, the package displays its **local variables** and **return va
 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()
+    tree = invo_tree.blocking_each_change()
 ```
 
 # Debugger #
@@ -147,14 +147,13 @@ tree = invo_tree.Invocation_Tree()
 
 For convenience we provide these functions to set common configurations:
 
-- **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.blocking(filename)**, blocks on function call and return
+- **invo_tree.blocking_each_change(filename)**, blocks on each change of value
 - **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
+- **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
 
 # 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 ##

{invocation_tree-0.0.6 → invocation_tree-0.0.8}/images/students.py

@@ -12,9 +12,9 @@ def main():
 
 def compute_average(grades):
     average = sum(grades)/len(grades)
-    return my_round(average, 1)
+    return half_up_round(average, 1)
     
-def my_round(value, digits=0):
+def half_up_round(value, digits=0):
     """ High-precision half-up rounding of 'value' to a specified number of 'digits'. """
     return float(Decimal(str(value)).quantize(Decimal(f"1e-{digits}"),
                                               rounding=ROUND_HALF_UP))

{invocation_tree-0.0.6 → invocation_tree-0.0.8}/invocation_tree/__init__.py

@@ -7,7 +7,7 @@ import html
 import sys
 import difflib 
 
-__version__ = "0.0.6"
+__version__ = "0.0.8"
 __author__ = 'Bas Terwijn'
 
 def highlight_diff(str1, str2):
@@ -264,7 +264,7 @@ class Invocation_Tree:
 def blocking(filename='tree.pdf'):
     return Invocation_Tree(filename=filename)
 
-def blocking_each_line(filename='tree.pdf'):
+def blocking_each_change(filename='tree.pdf'):
     return Invocation_Tree(filename=filename, each_line=True)
 
 def debugger(filename='tree.pdf'):
@@ -273,5 +273,5 @@ def debugger(filename='tree.pdf'):
 def gif(filename='tree.png'):
     return Invocation_Tree(filename=filename, show=False, block=False, gifcount=0)
 
-def gif_each_line(filename='tree.png'):
+def gif_each_change(filename='tree.png'):
     return Invocation_Tree(filename=filename, show=False, block=False, gifcount=0, each_line=True)

{invocation_tree-0.0.6 → invocation_tree-0.0.8/invocation_tree.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: invocation_tree
-Version: 0.0.6
+Version: 0.0.8
 Summary: Generate an invocation tree of functions calls.
 Home-page: https://github.com/bterwijn/invocation_tree
 Author: Bas Terwijn
@@ -29,7 +29,7 @@ The [invocation_tree](https://pypi.org/project/invocation-tree/) package is desi
 
 ```python
 import invocation_tree as invo_tree
-import math 
+from decimal import Decimal, ROUND_HALF_UP
 
 def main():
     students = {'Ann':[7.5, 8.0], 
@@ -42,9 +42,9 @@ def main():
 
 def compute_average(grades):
     average = sum(grades)/len(grades)
-    return my_round(average, 1)
+    return half_up_round(average, 1)
     
-def my_round(value, digits=0):
+def half_up_round(value, digits=0):
     """ High-precision half-up rounding of 'value' to a specified number of 'digits'. """
     return float(Decimal(str(value)).quantize(Decimal(f"1e-{digits}"),
                                               rounding=ROUND_HALF_UP))
@@ -72,7 +72,7 @@ For every function, the package displays its **local variables** and **return va
 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()
+    tree = invo_tree.blocking_each_change()
 ```
 
 # Debugger #
@@ -166,14 +166,13 @@ tree = invo_tree.Invocation_Tree()
 
 For convenience we provide these functions to set common configurations:
 
-- **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.blocking(filename)**, blocks on function call and return
+- **invo_tree.blocking_each_change(filename)**, blocks on each change of value
 - **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
+- **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
 
 # 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 ##

{invocation_tree-0.0.6 → invocation_tree-0.0.8}/invocation_tree.egg-info/SOURCES.txt

@@ -9,7 +9,6 @@ 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
@@ -24,7 +23,6 @@ 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

{invocation_tree-0.0.6 → invocation_tree-0.0.8}/setup.py

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