Version 1.0.0: Supports saving animation as gif

sarangbishal · sarangbishal · commit b3acd4edf144 · 2020-02-07T15:14:47.000+05:45
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,9 @@
 test*
 .idea
 .idea
-
+img
+out*
+*frames*
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
diff --git a/README.md b/README.md
@@ -36,6 +36,8 @@ 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
 
@@ -52,7 +54,7 @@ def main():
     # Call function
     print(fib(n=6))
     # Save recursion tree to a file
-    vs.write_image("fibonacci.png")
+    vs.make_animation("fibonacci.gif", delay=2)
 
 
 if __name__ == "__main__":
@@ -62,11 +64,16 @@ Here are the changes required:
  
  - 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  
+ - Make_animation
   
+ The output image are saved as "fibonacci.gif" and "fibonacci.png"
+ 
 Here is how the recursion tree looks like:  
-![enter image description here](https://github.com/sarangbishal/Recursion-Visualizer/blob/master/examples/fibonacci.png)  
+Animation:
+![enter image description here](https://github.com/sarangbishal/Recursion-Visualizer/blob/master/examples/fibonacci.gif)  
   
+![enter image description here](https://github.com/sarangbishal/Recursion-Visualizer/blob/master/examples/fibonacci.png)  
+
 ## 2. Make sum  
 This is taken from one of my answers on quora where I had to manually  draw recursion tree. Using Visualiser with very less changes I was able to draw the following tree. You can compare the tree [here](https://qr.ae/TltTCV)  
 ![enter image description here](https://github.com/sarangbishal/Recursion-Visualizer/blob/master/examples/make_sum.png)  
@@ -76,6 +83,7 @@ This is taken from one of my answers on quora where I had to manually  draw recu
 ## TODO:  
  - [x] Minimal working version  
  - [x] Upload package to pypi  
+ - [x] Support animation
  - [ ] Refactor  
  - [ ] Handle base cases  
  - [ ] Make more beautiful trees
diff --git a/examples/fibonacci.gif b/examples/fibonacci.gif
diff --git a/examples/fibonacci.py b/examples/fibonacci.py
@@ -16,7 +16,7 @@ def main():
     # Call function
     print(fib(n=6))
     # Save recursion tree to a file
-    vs.write_image("fibonacci.png")
+    vs.make_animation("fibonacci.gif", delay=2)
 
 
 if __name__ == "__main__":
diff --git a/examples/make_sum.gif b/examples/make_sum.gif
diff --git a/examples/make_sum.py b/examples/make_sum.py
@@ -36,4 +36,5 @@ def f(sum, ans):
 
 # Call solve with sum and an empty list
 f(sum=sum, ans=[])
-vs.write_image("make_sum.png")
+# Save recursion tree to a file
+vs.make_animation("make.gif", delay=2)
diff --git a/examples/missionaries.gif b/examples/missionaries.gif
diff --git a/examples/missionaries.py b/examples/missionaries.py
@@ -11,7 +11,7 @@ def is_valid(m, c):
 
 
 @vs(ignore_args=["node_num", "level"])
-def dfs(m, c, s, level, node_num):
+def dfs(m, c, s, level):
     if (m, c, s) == goal_state:
         return True
 
@@ -37,14 +37,14 @@ def dfs(m, c, s, level, node_num):
         if is_valid(next_m, next_c):
 
             if (next_m, next_c, next_side) not in visited:
-                vs.node_count += 1
-                solved = (solved or dfs(m=next_m, c=next_c, s=next_side, level=level + 1, node_num=vs.node_count))
+                solved = (solved or dfs(m=next_m, c=next_c, s=next_side, level=level + 1))
 
                 if solved:
                     return True
     return solved
 
 
-if (dfs(m=3, c=3, s=1, level=0, node_num=0)):
+if (dfs(m=3, c=3, s=1, level=0)):
     print("SOlution Found")
-    vs.write_image("missionaries.png")
+    # Save recursion tree to a file
+    vs.make_animation("missionaries.gif", delay=2)
diff --git a/examples/subset.gif b/examples/subset.gif
diff --git a/examples/subset.py b/examples/subset.py
@@ -27,4 +27,5 @@ def f(nums, i, current_subset):
 if __name__ == "__main__":
     nums = [1, 2, 3]
     f(nums=nums, i = len(nums), current_subset=[])
-    vs.write_image("subset.png")
+    # Save recursion tree to a file
+    vs.make_animation("subset.gif", delay=3)
diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,2 @@
+imageio==2.6.1
 pydot==1.4.1
-pyparsing==2.4.6
-six==1.14.0
diff --git a/setup.py b/setup.py
@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="recursion-visualiser", # Replace with your own username
-    version="0.0.3",
+    version="1.0.0",
     author="Bishal Sarangkoti",
     author_email="sarangbishal@gmail.com",
     description="A small python package to visualise recursive function on Python. It draws recursion tree",
@@ -18,6 +18,6 @@
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
     ],
-    install_requires=["pydot"],
+    install_requires=["pydot", "imageio"],
     python_requires='>=3.6',
 )
diff --git a/visualiser/__init__.py b/visualiser/__init__.py
@@ -1,3 +1,3 @@
 
 # Version of the recursion-visualiser
-__version__ = "0.0.3"
+__version__ = "1.0.0"
diff --git a/visualiser/visualiser.py b/visualiser/visualiser.py
@@ -1,17 +1,26 @@
 # Author: Bishal Sarang
-
 import sys
 from functools import wraps
 from collections import OrderedDict
 import pydot
+import imageio
+import glob
+import os
+import shutil
 
+# Dot Language for graph
+dot_str_start = "digraph G {\n"
+dot_str_body = ""
+dot_str_end = "}"
 
 class Visualiser(object):
     # Total number of nodes
     node_count = 0
     graph = pydot.Dot(graph_type="digraph")
     # To track function call numbers
     stack = []
+    edges = []
+    nodes = []
 
     def __init__(self, ignore_args=None, show_argument_name=True, show_return_value=True):
         #If enabled shows keyword arguments ordered by keys
@@ -26,6 +35,7 @@ def __init__(self, ignore_args=None, show_argument_name=True, show_return_value=
             self.ignore_args = ['node_num'] + ignore_args
 
 
+
     @classmethod
     def write_image(cls, filename="out.png"):
         try:
@@ -34,6 +44,68 @@ def write_image(cls, filename="out.png"):
         except Exception:
             print(f"Writing {filename} failed")
 
+    @classmethod
+    def make_frames(cls):
+        """
+        Make frame for each steps
+        """
+        # If frame directory doesn't exist
+        if not os.path.exists("frames"):
+            os.makedirs("frames")
+
+        Edges = cls.edges[::]
+        Nodes = cls.nodes[::]
+        print("Writing frames....")
+        for i in range(len(Edges)):
+            nodes = Nodes[::]
+            edges = Edges[::]
+
+            for j in range(0, i + 1):
+                nodes[j] += '];'
+
+            for j in range(i + 1, len(Edges)):
+                nodes[j] += ' , style=invis];'
+                edges[j] += ' [style=invis];'
+
+            dot_str_body = "\n".join(nodes) + "\n"
+            dot_str_body += "\n".join(edges)
+            dot_str = dot_str_start + dot_str_body + dot_str_end
+            g = pydot.graph_from_dot_data(dot_str)
+            g[0].write_png(f"frames/temp_{i}.png")
+
+    @classmethod
+    def write_gif(cls, name="out.gif", delay=3):
+        images = []
+        imgs = glob.glob("frames/*.png")
+        for filename in sorted(imgs, key=lambda fn: int(fn.split("_")[1].split(".")[0])):
+            images.append(imageio.imread(filename))
+        print("Writing gif...")
+        imageio.mimsave(name, images, duration=delay)
+        print(f"Saved gif {name} successfully")
+        # Delete temporary directory
+        shutil.rmtree("frames")
+
+    @classmethod
+    def make_animation(cls, filename="out.gif", delay=3):
+        print("Starting to make animation")
+        # Save final tree image as png
+        try:
+            cls.write_image(f"{filename.split('.')[0]}.png")
+        except:
+            print("Error saving image.")
+
+        # Make animation as gif
+        try:
+            cls.make_frames()
+        except:
+            print("Error writing frames")
+
+        try:
+            cls.write_gif(filename, delay=delay)
+        except:
+            print("Error saving gif.")
+
+
     def extract_signature_label_arg_string(self, *args, **kwargs):
         """
         Returns function signature arguments as string and function label arguments as string.
@@ -68,7 +140,7 @@ def extract_signature_label_arg_string(self, *args, **kwargs):
     def __call__(self, fn):
         @wraps(fn)
         def wrapper(*args, **kwargs):
-
+            global dot_str_body
             # Increment total number of nodes when a call is made
             self.node_count += 1
 
@@ -125,9 +197,14 @@ def wrapper(*args, **kwargs):
             self.stack.append(self.node_count)
             # Before actual function call delete keyword 'node_num' from kwargs
             del kwargs['node_num']
+
+            self.edges.append(f'"{caller_func_signature}" -> "{current_function_signature}"')
+            self.nodes.append(f'"{current_function_signature}" [label="{current_function_label}"')
+
             # Return after function call
             result = fn(*args, **kwargs)
 
+
             # Pop from tha stack after returning
             self.stack.pop()
 
@@ -140,11 +217,12 @@ def wrapper(*args, **kwargs):
 
             # If the function is called by another function
             if caller_function_name not in ['<module>', 'main']:
-                print(f"Called {current_function_label} by {caller_func_label}")
-
                 parent_node = pydot.Node(name=caller_func_signature, label=caller_func_label)
                 self.graph.add_node(parent_node)
                 edge = pydot.Edge(parent_node, child_node)
                 self.graph.add_edge(edge)
+
+
             return result
-        return wrapper
+        return wrapper
+
