invocation-tree 0.0.1__tar.gz

invocation_tree-0.0.1/LICENSE.txt

@@ -0,0 +1,25 @@
+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.

invocation_tree-0.0.1/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include images/ *

invocation_tree-0.0.1/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.1
+Name: invocation_tree
+Version: 0.0.1
+Summary: Generate a call tree of functions.
+Home-page: https://github.com/bterwijn/invocation_tree
+Author: Bas Terwijn
+Author-email: bterwijn@gmail.com
+License: BSD 2-clause
+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
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: graphviz
+
+# Installation #
+Install (or upgrade) `invocation_tree` using pip:
+```
+pip install --upgrade invocation_tree
+```
+Additionally [Graphviz](https://graphviz.org/download/) needs to be installed.
+
+# Call Tree #

invocation_tree-0.0.1/README.md

@@ -0,0 +1,8 @@
+# Installation #
+Install (or upgrade) `invocation_tree` using pip:
+```
+pip install --upgrade invocation_tree
+```
+Additionally [Graphviz](https://graphviz.org/download/) needs to be installed.
+
+# Call Tree #

invocation_tree-0.0.1/images/permutation.py

@@ -0,0 +1,23 @@
+import invocation_tree
+
+def permutations(all_permutations, data, perm, n):
+    if n<=0:
+        print(perm)
+        all_permutations.append(perm.copy())
+    else:
+        for i in data:
+            perm.append(i)
+            permutations(all_permutations, data, perm, n-1)
+            perm.pop()
+
+invocation_tree = invocation_tree.Invocation_Tree(each_line=True)
+all_permutations = []
+
+invocation_tree.to_string[list] = lambda x : f'my_list:{x}'
+invocation_tree.to_string[id(all_permutations)] = lambda x : f'perms:{x}'
+invocation_tree.to_string['permutations.return'] = lambda x : f'return:{x}'
+invocation_tree.to_string['permutations.n'] = lambda x : f'{x} this is n'
+
+#invocation_tree(permutations, ['a','b','c'], [], 2)
+invocation_tree(permutations, all_permutations, ['a','b','c'], [], 2)
+print('all_permutations:', all_permutations)

invocation_tree-0.0.1/install.txt

@@ -0,0 +1,31 @@
+# just some notes about how to deal with Python modules and pip packages
+
+
+# ===== pip install
+pip install setuptools
+pip install wheel
+pip install twine
+
+
+# ===== (un)install current module
+pip uninstall invocation_tree
+pip install .
+pip install --upgrade .
+
+
+# ===== prepare packages for upload
+# - increase version number in: setup.py invocation_tree/__init__.py 
+# - update images:
+cd images; bash create_images.sh; cd ..
+# - git commit -am "version X.X.X" && git push
+rm -f ./dist/*
+python setup.py check
+python setup.py sdist
+python setup.py bdist_wheel --universal
+
+
+# ===== upload packages to pypi for 'pip install' purposes
+# - upload to test url:
+twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+# - upload to pypi for real:
+twine upload dist/*

invocation_tree-0.0.1/invocation_tree/__init__.py

@@ -0,0 +1,151 @@
+# This file is part of invocation_tree.
+# Copyright (c) 2023, Bas Terwijn.
+# SPDX-License-Identifier: BSD-2-Clause
+
+from graphviz import Digraph
+import html
+import sys
+import inspect
+
+__version__ = "0.0.1"
+__author__ = 'Bas Terwijn'
+
+class Tree_Node:
+
+    def __init__(self, node_id, frame, return_value):
+        self.node_id = node_id
+        self.frame = frame
+        self.return_value = return_value
+
+    def __repr__(self):
+        return f'node_id:{self.node_id} frame:{self.frame} return_value:{self.return_value}'
+
+class Invocation_Tree:
+
+    def __init__(self, output_filename='invocation_tree.pdf', block=True, src_location=True, max_string_len=100, indent='   ',
+                 color_paused = '#ccffcc', color_active = '#ffffff', color_returned = '#ffcccc', each_line=False, to_string=None):
+        # --- config
+        self.output_filename = output_filename
+        self.block = block
+        self.src_location = src_location
+        self.max_string_len = max_string_len
+        self.indent = indent
+        self.color_paused = color_paused
+        self.color_active = color_active
+        self.color_returned = color_returned
+        self.each_line = each_line
+        self.to_string = {}
+        if not to_string is None:
+            self.to_string = to_string
+        # --- core
+        self.stack = []
+        self.node_id = 0
+        self.node_id_to_table = {}
+        self.edges = []
+        
+    def print_stack(self):
+        for tree_node in self.stack:
+            print(tree_node)
+
+    def value_to_string(self, value, name):
+        if id(value) in self.to_string:
+            return self.to_string[id(value)](value)
+        elif name in self.to_string:
+            return self.to_string[name](value)
+        elif type(value) in self.to_string:
+            return self.to_string[type(value)](value)
+        else:
+            val_str = str(value)
+            if len(val_str) > self.max_string_len:
+                val_str = '...'+val_str[-self.max_string_len:]    
+            return html.escape(val_str)
+
+    def build_html_table(self, tree_node, active=False, returned=False):
+        function_name = tree_node.frame.f_code.co_name
+        local_vars = tree_node.frame.f_locals
+        return_value = tree_node.return_value
+        border = 1
+        color = self.color_paused
+        if active:
+            color = self.color_active
+            border = 3
+        if returned:
+            color = self.color_returned
+        table = f'<\n<TABLE BORDER="{str(border)}" CELLBORDER="0" CELLSPACING="1" BGCOLOR="{color}">\n  <TR>'
+        table += '<TD ALIGN="left">'+ self.value_to_string(function_name, 'function_'+function_name) +'</TD>'
+        table += '</TR>\n  <TR>'
+        new_line = True
+        for var,val in local_vars.items():
+            if not new_line:
+                table += '</TR>\n  <TR>'
+            table += '<TD ALIGN="left">'+  self.indent + self.value_to_string(var, function_name+'_'+var) + ': ' + \
+                                                         self.value_to_string(val, function_name+'.'+var) +'</TD>'
+            new_line = False
+        if returned:
+            if not new_line:
+                table += '</TR>\n  <TR>'
+            table += '<TD ALIGN="left">'+ 'return ' + self.value_to_string(return_value, function_name+'.'+'return') +'</TD>'
+            new_line = False
+        table += '</TR>\n</TABLE>>'
+        return table
+            
+    def update_node(self, tree_node, active=False, returned=False):
+        table = self.build_html_table(tree_node, active, returned)
+        self.node_id_to_table[str(tree_node.node_id)] = table
+        
+    def add_edge(self, tree_node1, tree_node2):
+        self.edges.append((str(tree_node1.node_id), str(tree_node2.node_id)))
+        
+    def render_graph(self, frame, event):
+        graphviz_graph_attr = {}
+        graphviz_node_attr = {'shape':'plaintext'}
+        graphviz_edge_attr = {}
+        graph = Digraph(comment="recursion_graph",
+                graph_attr=graphviz_graph_attr,
+                node_attr=graphviz_node_attr,
+                edge_attr=graphviz_edge_attr)
+        for nid, table in self.node_id_to_table.items():
+            graph.node(nid, label=table)
+        for nid1, nid2 in self.edges:
+            graph.edge(nid1, nid2)
+        graph.render(outfile=self.output_filename, cleanup=True)
+        if self.block:
+            if self.src_location:
+                filename = frame.f_code.co_filename
+                line_nr = frame.f_lineno
+                print(f'{event.capitalize()} at {filename}:{line_nr}', end='. ')
+            input('Press <Enter> to continue...')
+            
+    def trace_calls(self, frame, event, arg):
+        #print('========= event:',event)
+        if event == 'call':
+            self.stack.append(Tree_Node(self.node_id, frame, None))
+            self.node_id += 1
+            #self.print_stack()
+            if len(self.stack)>1:
+                self.update_node(self.stack[-2])
+                self.add_edge(self.stack[-2], self.stack[-1])
+            self.update_node(self.stack[-1], active=True)
+            self.render_graph(frame, event)
+        elif event == 'return':
+            self.stack[-1].return_value = arg
+            #self.print_stack()
+            self.update_node(self.stack[-1], returned=True)
+            if len(self.stack)>1:
+                self.update_node(self.stack[-2], active=True)
+            self.stack.pop()
+            self.render_graph(frame, event)
+        elif event == 'line' and self.each_line:
+            self.update_node(self.stack[-1], active=True)
+            self.render_graph(frame, event)
+        return self.trace_calls
+    
+    def __call__(self, fun, *args, **kwargs):
+        sys.settrace(self.trace_calls)
+        try:
+            result = fun(*args, **kwargs)
+        except Exception as e:
+            raise
+        finally:
+            sys.settrace(None)
+        return result

invocation_tree-0.0.1/invocation_tree.egg-info/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.1
+Name: invocation_tree
+Version: 0.0.1
+Summary: Generate a call tree of functions.
+Home-page: https://github.com/bterwijn/invocation_tree
+Author: Bas Terwijn
+Author-email: bterwijn@gmail.com
+License: BSD 2-clause
+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
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: graphviz
+
+# Installation #
+Install (or upgrade) `invocation_tree` using pip:
+```
+pip install --upgrade invocation_tree
+```
+Additionally [Graphviz](https://graphviz.org/download/) needs to be installed.
+
+# Call Tree #

invocation_tree-0.0.1/invocation_tree.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE.txt
+MANIFEST.in
+README.md
+install.txt
+setup.py
+images/invocation_tree.pdf
+images/permutation.py
+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.1/invocation_tree.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

invocation_tree-0.0.1/invocation_tree.egg-info/requires.txt

@@ -0,0 +1 @@
+graphviz

invocation_tree-0.0.1/invocation_tree.egg-info/top_level.txt

@@ -0,0 +1 @@
+invocation_tree

invocation_tree-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

invocation_tree-0.0.1/setup.py

@@ -0,0 +1,35 @@
+# This file is part of invocation_tree.
+# Copyright (c) 2023, Bas Terwijn.
+# SPDX-License-Identifier: BSD-2-Clause
+
+from setuptools import setup
+
+# read the contents of your README file
+from pathlib import Path
+this_directory = Path(__file__).parent
+long_description_from_readme = (this_directory / "README.md").read_text()
+
+setup(
+    name = 'invocation_tree',
+    version = '0.0.1',
+    description = 'Generate a call tree of functions.',
+    long_description = long_description_from_readme,
+    long_description_content_type = 'text/markdown',
+    readme = 'README.md',
+    url = 'https://github.com/bterwijn/invocation_tree',
+    author = 'Bas Terwijn',
+    author_email = 'bterwijn@gmail.com',
+    license = 'BSD 2-clause',
+    packages = ['invocation_tree'],
+    install_requires = ['graphviz'],
+
+    classifiers = [
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Education',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: BSD License',  
+        'Programming Language :: Python :: 3',
+        'Topic :: Education',
+        'Topic :: Software Development :: Debuggers',
+    ],
+)