Version 0.03'

Author: sarangbishal

README.md

@@ -27,38 +27,30 @@ Let's draw the recursion tree for fibonacci number.
 Here is how the simple code looks like  
 ```python  
 def fib(n):  
-	if n <= 1: 
-		return n 
-	return fib(n - 1) + fib(n - 2)  print(fib(6))  
+    if n <= 1: 
+        return n 
+    return fib(n - 1) + fib(n - 2)  
+
+print(fib(6))  
 ```  
 
 Now we want to draw the recursion tree for this function. It is as simple as adding a decorator  
 ```python  
-# Author: Bishal Sarang
-
 # Import Visualiser class from module visualiser
 from visualiser.visualiser import Visualiser as vs
 
-
 # Add decorator
 # Decorator accepts arguments: ignore_args and show_argument_name
-@vs(ignore_args=['node_num'])
-def fib(n, node_num):
+@vs()
+def fib(n):
     if n <= 1:
         return n
-    # Increment node count
-    vs.node_count += 1
-    left = fib(n=n - 1, node_num=vs.node_count)
-    
-    # Increment node count
-    vs.node_count += 1
-    right = fib(n=n - 2, node_num=vs.node_count)
-    return left + right
+    return fib(n=n - 1) + fib(n=n - 2)
+
 
 def main():
     # Call function
-    print(fib(n=6, node_num=0))
-
+    print(fib(n=6))
     # Save recursion tree to a file
     vs.write_image("fibonacci.png")
 
@@ -67,10 +59,8 @@ if __name__ == "__main__":
     main()
 ```  
 Here are the changes required:  
-  
- - Change function signature from `fib(n)` to `fib(n, node_num)`  
- - Add decorator Visualiser which accepts arguments `ignore_args` and `show_argument_name`  
- - Before each function calls make sure to increment `node_count` argument of decorator class   
+ 
+ - Add decorator Visualiser which accepts optional arguments `ignore_args`, `show_argument_name`  and 'show_return_value'   
  - Change every function calls to pass as keyword arguments.  
  - Write the image  
 

examples/fibonacci.py

@@ -3,24 +3,18 @@
 # Import Visualiser class from module visualiser
 from visualiser.visualiser import Visualiser as vs
 
-
 # Add decorator
 # Decorator accepts arguments: ignore_args and show_argument_name
-@vs(ignore_args=['node_num'])
-def fib(n, node_num):
+@vs()
+def fib(n):
     if n <= 1:
         return n
-    vs.node_count += 1
-    left = fib(n=n - 1, node_num=vs.node_count)
+    return fib(n=n - 1) + fib(n=n - 2)
 
-    vs.node_count += 1
-    right = fib(n=n - 2, node_num=vs.node_count)
-    return left + right
 
 def main():
     # Call function
-    print(fib(n=6, node_num=0))
-
+    print(fib(n=6))
     # Save recursion tree to a file
     vs.write_image("fibonacci.png")
 

examples/make_sum.py

@@ -18,7 +18,7 @@
 
 
 @vs(ignore_args=['node_num'], show_argument_name=False, show_return_value=False)
-def f(sum, ans, node_num):
+def f(sum, ans):
     # If sum becoms 0 we have found the required list
     if sum == 0:
         print(ans)
@@ -27,16 +27,13 @@ def f(sum, ans, node_num):
     # Number that is included also can be included
     for elem in nums:
         if sum - elem >= 0:
-
-            # Increment vs.node_count before each function call
-            vs.node_count += 1
-            f(sum=sum - elem, ans=ans + [elem], node_num=vs.node_count)
+            f(sum=sum - elem, ans=ans + [elem])
 
 
 # We want to make the sum from list nums
 nums = [2, 3, 7]
 sum = 10
 
 # Call solve with sum and an empty list
-f(sum=sum, ans=[], node_num=0)
+f(sum=sum, ans=[])
 vs.write_image("make_sum.png")

examples/subset.py

@@ -12,21 +12,19 @@
 """
 
 subsets = []
-@vs(ignore_args=["node_num", "nums"], show_return_value=False, show_argument_name=False)
-def f(nums, i, current_subset, node_num):
+@vs(ignore_args=["nums"], show_return_value=False, show_argument_name=False)
+def f(nums, i, current_subset):
     # If no more elements left
     if i == 0:
         subsets.append(current_subset)
         return
     # Exclude Current element
-    vs.node_count += 1
-    f(nums=nums, i=i - 1, current_subset=current_subset, node_num=vs.node_count)
+    f(nums=nums, i=i - 1, current_subset=current_subset)
 
     # Include current element
-    vs.node_count += 1
-    f(nums=nums, i=i - 1, current_subset=current_subset + [nums[i - 1]], node_num=vs.node_count)
+    f(nums=nums, i=i - 1, current_subset=current_subset + [nums[i - 1]])
 
 if __name__ == "__main__":
     nums = [1, 2, 3]
-    f(nums=nums, i = len(nums), current_subset=[], node_num=0)
+    f(nums=nums, i = len(nums), current_subset=[])
     vs.write_image("subset.png")

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="recursion-visualiser", # Replace with your own username
-    version="0.0.2",
+    version="0.0.4",
     author="Bishal Sarangkoti",
     author_email="sarangbishal@gmail.com",
     description="A small python package to visualise recursive function on Python. It draws recursion tree",

visualiser/__init__.py

@@ -1,3 +1,3 @@
 
-# Version of the realpython-reader package
-__version__ = "0.0.2"
+# Version of the recursion-visualiser
+__version__ = "0.0.4"

visualiser/visualiser.py

@@ -7,13 +7,24 @@
 
 
 class Visualiser(object):
+    # Total number of nodes
     node_count = 0
     graph = pydot.Dot(graph_type="digraph")
+    # To track function call numbers
+    stack = []
 
-    def __init__(self, ignore_args, show_argument_name=True, show_return_value=True):
+    def __init__(self, ignore_args=None, show_argument_name=True, show_return_value=True):
+        #If enabled shows keyword arguments ordered by keys
         self.show_argument_name = show_argument_name
+        # If enables shows the return value at every nodes
         self.show_return_value = show_return_value
-        self.ignore_args = ignore_args
+
+        # Argument string that are to be ignored in diagram
+        if ignore_args is None:
+            self.ignore_args = ['node_num']
+        else:
+            self.ignore_args = ['node_num'] + ignore_args
+
 
     @classmethod
     def write_image(cls, filename="out.png"):
@@ -57,9 +68,16 @@ def extract_signature_label_arg_string(self, *args, **kwargs):
     def __call__(self, fn):
         @wraps(fn)
         def wrapper(*args, **kwargs):
+
+            # Increment total number of nodes when a call is made
+            self.node_count += 1
+
+            # Update kwargs by adding dummy keyword node_num which helps to uniquely identify each node
+            kwargs.update({'node_num': self.node_count})
             # Order all the keyword arguments
             kwargs = OrderedDict(sorted(kwargs.items()))
 
+
             """Details about current Function"""
             # Get signature and label arguments strings for current function
             current_function_argument_string, current_function_label_argument_string = self.extract_signature_label_arg_string(*args, **kwargs)
@@ -85,6 +103,11 @@ def wrapper(*args, **kwargs):
             # Extract only those locals that are in arguments
             caller_function_kwargs = {key: value for key, value in caller_function_locals.items() if key in caller_function_argument_names}
 
+            # If the nodes has parent node get node_num from parent node
+            if self.stack:
+                caller_function_kwargs.update({'node_num': self.stack[-1]})
+            caller_function_kwargs = OrderedDict(sorted(caller_function_kwargs.items()))
+
             caller_function_argument_string, caller_function_label_argument_string = self.extract_signature_label_arg_string(**caller_function_kwargs)
 
             # Caller Function
@@ -98,8 +121,16 @@ def wrapper(*args, **kwargs):
             if caller_function_name == '<module>':
                 print(f"Drawing for {current_function_signature}")
 
+            # Push node_count to stack
+            self.stack.append(self.node_count)
+            # Before actual function call delete keyword 'node_num' from kwargs
+            del kwargs['node_num']
+            # Return after function call
             result = fn(*args, **kwargs)
 
+            # Pop from tha stack after returning
+            self.stack.pop()
+
             # If show_return_value flag is set, display the result
             if self.show_return_value:
                 current_function_label += f" => {result}"
@@ -116,26 +147,4 @@ def wrapper(*args, **kwargs):
                 edge = pydot.Edge(parent_node, child_node)
                 self.graph.add_edge(edge)
             return result
-        return wrapper
-
-@Visualiser(ignore_args=["node_num"])
-def fib(n, node_num):
-    if n <= 1:
-        return n
-    Visualiser.node_count += 1
-    left = fib(n=n - 1, node_num=Visualiser.node_count)
-
-    Visualiser.node_count += 1
-    right = fib(n=n - 2, node_num=Visualiser.node_count)
-    return left + right
-
-def main():
-    # Call function
-    print(fib(n=6, node_num=0))
-
-    # Save recursion tree to a file
-    Visualiser.write_image("fibonacci.png")
-
-
-if __name__ == "__main__":
-    main()
+        return wrapper