invocation-tree 0.0.14__tar.gz → 0.0.16__tar.gz

{invocation_tree-0.0.14/invocation_tree.egg-info → invocation_tree-0.0.16}/PKG-INFO

@@ -1,21 +1,47 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: invocation_tree
-Version: 0.0.14
-Summary: Generate an invocation tree of functions calls.
-Home-page: https://github.com/bterwijn/invocation_tree
-Author: Bas Terwijn
-Author-email: bterwijn@gmail.com
-License: BSD 2-clause
+Version: 0.0.16
+Summary: Generates an invocation tree of functions calls.
+Author-email: Bas Terwijn <bterwijn@gmail.com>
+License: BSD 2-Clause License
+        
+        Copyright (c) 2017, pyexample
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        * Redistributions of source code must retain the above copyright notice, this
+          list of conditions and the following disclaimer.
+        
+        * Redistributions in binary form must reproduce the above copyright notice,
+          this list of conditions and the following disclaimer in the documentation
+          and/or other materials provided with the distribution.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+Project-URL: Homepage, https://github.com/bterwijn/invocation_tree
+Project-URL: Repository, https://github.com/bterwijn/invocation_tree.git
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Education
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Education
 Classifier: Topic :: Software Development :: Debuggers
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: graphviz
+Dynamic: license-file
 
 # Installation #
 Install (or upgrade) `invocation_tree` using pip:
@@ -168,6 +194,7 @@ print( tree(factorial, 4) ) # show invocation tree of calling factorial(4)
 24
 ```
 
+## Permutations ##
 This `permutations()` example shows the depth-first nature of recursive execution:
 
 ```python
@@ -244,7 +271,7 @@ For convenience we provide these functions to set common configurations:
 - **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/).
+- Adobe Acrobat Reader [doesn't refresh a PDF file](https://community.adobe.com/t5/acrobat-reader-discussions/reload-refresh-pdfs/td-p/9632292) 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 ([SumatraPDF](https://www.sumatrapdfreader.org/), [Okular](https://okular.kde.org/),  ...) and set it as the default PDF reader. Another solution is to `render()` the graph to a different output format and to open it manually.
 
 ## 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.14 → invocation_tree-0.0.16}/README.md

@@ -149,6 +149,7 @@ print( tree(factorial, 4) ) # show invocation tree of calling factorial(4)
 24
 ```
 
+## Permutations ##
 This `permutations()` example shows the depth-first nature of recursive execution:
 
 ```python
@@ -225,7 +226,7 @@ For convenience we provide these functions to set common configurations:
 - **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/).
+- Adobe Acrobat Reader [doesn't refresh a PDF file](https://community.adobe.com/t5/acrobat-reader-discussions/reload-refresh-pdfs/td-p/9632292) 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 ([SumatraPDF](https://www.sumatrapdfreader.org/), [Okular](https://okular.kde.org/),  ...) and set it as the default PDF reader. Another solution is to `render()` the graph to a different output format and to open it manually.
 
 ## 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.14 → invocation_tree-0.0.16}/images/create_gif.sh

@@ -5,7 +5,7 @@
 #   sudo apt install imagemagick
 
 name="$1"
-files=$(ls -v $name*.png)
+files=$(ls -v $name*.png | tr '\n' ' ')
 echo "creating gif with:"
 echo "$files"
 
@@ -15,5 +15,11 @@ echo "largest_size: $largest_size"
 echo "resizing images"
 mogrify -resize $largest_size -background white -gravity North -extent $largest_size $files
 echo "creating file: $name.gif"
-convert -delay 150 -loop 0 $files $name.gif
+convert -delay 150 -dither None -loop 0 $files $name.gif
+
+if [ "$2" = "-d" ]; then
+    echo "deleting: $files"
+    rm $files
+fi
+
 echo "done"

{invocation_tree-0.0.14 → invocation_tree-0.0.16}/images/create_images.sh

@@ -2,20 +2,20 @@
 rm -f compute*.png
 python compute.py
 rm -f compute0.png
-bash create_gif.sh compute
+bash create_gif.sh compute -d
 
 rm -f students*.png
 python students.py
 rm -f students0.png
-bash create_gif.sh students
+bash create_gif.sh students -d
 
 rm -f factorial*.png
 python factorial.py
 rm -f factorial0.png
-bash create_gif.sh factorial
+bash create_gif.sh factorial -d
 
 rm -f permutations*.png
 python permutations.py
 rm -f permutations0.png
-bash create_gif.sh permutations
+bash create_gif.sh permutations -d
 

{invocation_tree-0.0.14 → invocation_tree-0.0.16}/invocation_tree/__init__.py

@@ -7,7 +7,7 @@ import html
 import sys
 import difflib 
 
-__version__ = "0.0.14"
+__version__ = "0.0.16"
 __author__ = 'Bas Terwijn'
 
 def highlight_diff(str1, str2):
@@ -60,7 +60,8 @@ class Tree_Node:
 class Invocation_Tree:
 
     def __init__(self, 
-                 filename='tree.pdf', 
+                 filename='tree.pdf',
+                 render=True,
                  show=True, 
                  block=True, 
                  src_loc=True, 
@@ -78,6 +79,7 @@ class Invocation_Tree:
         # --- config
         self.filename = filename
         self.prev_filename = None
+        self.render = render
         self.show = show
         self.block = block
         self.src_loc = src_loc
@@ -104,6 +106,7 @@ class Invocation_Tree:
         self.node_id_to_table = {}
         self.edges = []
         self.is_highlighted = False
+        self.graph = None
         self.ignore_calls = {'Invocation_Tree.__exit__', 'Invocation_Tree.stop_trace'}
 
     def __repr__(self):
@@ -234,9 +237,10 @@ class Invocation_Tree:
     def output_graph(self, frame, event):
         if self.block or self.gifcount >= 0:
             self.is_highlighted = False
-            graph = self.create_graph()
+            self.graph = self.create_graph()
             if self.is_highlighted:
-                self.render_graph(graph)
+                if self.render:
+                    self.render_graph(self.graph)
                 if self.block:
                     if self.src_loc:
                         filename = frame.f_code.co_filename
@@ -244,8 +248,12 @@ class Invocation_Tree:
                         print(f'{event.capitalize()} at {filename}:{line_nr}', end='. ')
                     input('Press <Enter> to continue...')
         else:
-            graph = self.create_graph()
-            self.render_graph(graph)
+            self.graph = self.create_graph()
+            if self.render:
+                self.render_graph(self.graph)
+
+    def get_graph(self):
+        return self.graph
 
     def trace_calls(self, frame, event, arg):
         class_fun_name = get_class_function_name(frame)
@@ -273,6 +281,9 @@ def blocking_each_change(filename='tree.pdf'):
 def debugger(filename='tree.pdf'):
     return Invocation_Tree(filename=filename, show=False, block=False, each_line=True)
 
+def debugger_no_render(filename='tree.pdf'):
+    return Invocation_Tree(filename=filename, render=False, show=False, block=False, each_line=True)
+
 def gif(filename='tree.png'):
     return Invocation_Tree(filename=filename, show=False, block=False, gifcount=0)
 

{invocation_tree-0.0.14 → invocation_tree-0.0.16/invocation_tree.egg-info}/PKG-INFO

@@ -1,21 +1,47 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: invocation_tree
-Version: 0.0.14
-Summary: Generate an invocation tree of functions calls.
-Home-page: https://github.com/bterwijn/invocation_tree
-Author: Bas Terwijn
-Author-email: bterwijn@gmail.com
-License: BSD 2-clause
+Version: 0.0.16
+Summary: Generates an invocation tree of functions calls.
+Author-email: Bas Terwijn <bterwijn@gmail.com>
+License: BSD 2-Clause License
+        
+        Copyright (c) 2017, pyexample
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        * Redistributions of source code must retain the above copyright notice, this
+          list of conditions and the following disclaimer.
+        
+        * Redistributions in binary form must reproduce the above copyright notice,
+          this list of conditions and the following disclaimer in the documentation
+          and/or other materials provided with the distribution.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+Project-URL: Homepage, https://github.com/bterwijn/invocation_tree
+Project-URL: Repository, https://github.com/bterwijn/invocation_tree.git
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Education
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Education
 Classifier: Topic :: Software Development :: Debuggers
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: graphviz
+Dynamic: license-file
 
 # Installation #
 Install (or upgrade) `invocation_tree` using pip:
@@ -168,6 +194,7 @@ print( tree(factorial, 4) ) # show invocation tree of calling factorial(4)
 24
 ```
 
+## Permutations ##
 This `permutations()` example shows the depth-first nature of recursive execution:
 
 ```python
@@ -244,7 +271,7 @@ For convenience we provide these functions to set common configurations:
 - **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/).
+- Adobe Acrobat Reader [doesn't refresh a PDF file](https://community.adobe.com/t5/acrobat-reader-discussions/reload-refresh-pdfs/td-p/9632292) 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 ([SumatraPDF](https://www.sumatrapdfreader.org/), [Okular](https://okular.kde.org/),  ...) and set it as the default PDF reader. Another solution is to `render()` the graph to a different output format and to open it manually.
 
 ## 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.16/invocation_tree.egg-info/SOURCES.txt

@@ -0,0 +1,21 @@
+LICENSE.txt
+MANIFEST.in
+README.md
+pyproject.toml
+images/compute.gif
+images/compute.py
+images/create_gif.sh
+images/create_images.sh
+images/factorial.gif
+images/factorial.py
+images/permutations.gif
+images/permutations.py
+images/students.gif
+images/students.py
+images/vscode.png
+invocation_tree/__init__.py
+invocation_tree.egg-info/PKG-INFO
+invocation_tree.egg-info/SOURCES.txt
+invocation_tree.egg-info/dependency_links.txt
+invocation_tree.egg-info/requires.txt
+invocation_tree.egg-info/top_level.txt

invocation_tree-0.0.16/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "invocation_tree"
+version = "0.0.16"
+description = "Generates an invocation tree of functions calls."
+authors = [
+    {name = "Bas Terwijn", email = "bterwijn@gmail.com"}
+]
+#license = { text = "BSD-2-Clause" } # needed for python <=3.8
+license = { file = "LICENSE.txt" }
+readme = "README.md"
+requires-python = ">=3.7"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Education",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Topic :: Education",
+    "Topic :: Software Development :: Debuggers",
+]
+dependencies = [
+    "graphviz",
+]
+
+[project.urls]
+Homepage = "https://github.com/bterwijn/invocation_tree"
+Repository = "https://github.com/bterwijn/invocation_tree.git"
+
+[tool.setuptools]
+packages = ["invocation_tree"]

invocation_tree-0.0.14/images/#generator_function.py#

@@ -1,13 +0,0 @@
-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.14/images/compute.py~

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

invocation_tree-0.0.14/images/create_images.sh~

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

invocation_tree-0.0.14/images/eager_pipeline.py~

@@ -1,28 +0,0 @@
-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.14/images/factorial.py~

@@ -1,11 +0,0 @@
-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.14/images/generator_expression.py~

@@ -1,9 +0,0 @@
-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.14/images/generator_pipeline.py~

@@ -1,26 +0,0 @@
-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) )