memory-graph 0.3.16__tar.gz → 0.3.18__tar.gz

{memory_graph-0.3.16/memory_graph.egg-info → memory_graph-0.3.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: memory_graph
-Version: 0.3.16
+Version: 0.3.18
 Summary: Generate intuitive graphs of your Python data, great for debugging and understanding complex relationships.
 Home-page: https://github.com/bterwijn/memory_graph
 Author: Bas Terwijn
@@ -211,13 +211,14 @@ class My_Class:
         self.digits = [1, 2]
         self.letters = ['x', 'y']
 
-    def copy(self): # custom copy method copies the digits but shares the letters
+    def custom_copy(self): 
+	    """ Copies 'digits' but shares 'letters'. """
         c = copy.copy(self)
         c.digits = copy.copy(self.digits)
         return c
 
 a = My_Class()
-b = a.copy()
+b = a.custom_copy()
 
 mg.show(locals())
 ```
@@ -430,7 +431,7 @@ class LinkedList:
             new_node.next = self.head
             self.head.prev = new_node
             self.head = new_node
-        mg.block(mg.show, locals()) # <--- draw graph
+        mg.block(mg.show, locals()) # <--- draw locals
 
 linked_list = LinkedList()
 n = 100
@@ -446,42 +447,33 @@ import memory_graph as mg
 import random
 random.seed(0) # use same random numbers each run
 
-class Node:
-
-    def __init__(self, value):
-        self.smaller = None
-        self.value = value
-        self.larger = None
-
 class BinTree:
 
-    def __init__(self):
-        self.root = None
+    def __init__(self, value=None, smaller=None, larger=None):
+        self.smaller = smaller
+        self.value = value
+        self.larger = larger
 
-    def add_recursive(self, new_value, node):
-        if new_value < node.value:
-            if node.smaller is None:
-                node.smaller = Node(new_value)
+    def add(self, value):
+        if self.value is None:
+            self.value = value
+        elif value < self.value:
+            if self.smaller is None:
+                self.smaller = BinTree(value)
             else:
-                self.add_recursive(new_value, node.smaller)
+                self.smaller.add(value)
         else:
-            if node.larger is None:
-                node.larger = Node(new_value)
+            if self.larger is None:
+                self.larger = BinTree(value)
             else:
-                self.add_recursive(new_value, node.larger)
-        mg.block(mg.show, locals()) # <--- draw graph
-
-    def add(self, value):
-        if self.root is None:
-            self.root = Node(value)
-        else:
-            self.add_recursive(value, self.root)
+                self.larger.add(value)
+        mg.block(mg.show, mg.stack()) # <--- draw stack
 
 tree = BinTree()
 n = 100
 for i in range(n):
-    new_value = random.randrange(n)
-    tree.add(new_value)
+    value = random.randrange(n)
+    tree.add(value)
 ```
 ![bin_tree.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/bin_tree.png)
 
@@ -502,7 +494,7 @@ class HashSet:
             self.buckets[index] = []
         bucket = self.buckets[index]
         bucket.append(value)
-        mg.block(mg.show, locals()) # <--- draw graph
+        mg.block(mg.show, locals()) # <--- draw locals
 
     def contains(self, value):
         index = hash(value) % len(self.buckets)
@@ -793,7 +785,7 @@ We can also run memory_graph in the browser: <a href="https://bterwijn.github.io
 
 ## 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 `render()` the graph to a different output format and to open it manually.
+- 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 ([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.
 
 - When graph edges overlap it can be hard to distinguish them. Using an interactive graphviz viewer, such as [xdot](https://github.com/jrfonseca/xdot.py), on a '*.gv' DOT output file will help.
 

{memory_graph-0.3.16 → memory_graph-0.3.18}/README.md

@@ -192,13 +192,14 @@ class My_Class:
         self.digits = [1, 2]
         self.letters = ['x', 'y']
 
-    def copy(self): # custom copy method copies the digits but shares the letters
+    def custom_copy(self): 
+	    """ Copies 'digits' but shares 'letters'. """
         c = copy.copy(self)
         c.digits = copy.copy(self.digits)
         return c
 
 a = My_Class()
-b = a.copy()
+b = a.custom_copy()
 
 mg.show(locals())
 ```
@@ -411,7 +412,7 @@ class LinkedList:
             new_node.next = self.head
             self.head.prev = new_node
             self.head = new_node
-        mg.block(mg.show, locals()) # <--- draw graph
+        mg.block(mg.show, locals()) # <--- draw locals
 
 linked_list = LinkedList()
 n = 100
@@ -427,42 +428,33 @@ import memory_graph as mg
 import random
 random.seed(0) # use same random numbers each run
 
-class Node:
-
-    def __init__(self, value):
-        self.smaller = None
-        self.value = value
-        self.larger = None
-
 class BinTree:
 
-    def __init__(self):
-        self.root = None
+    def __init__(self, value=None, smaller=None, larger=None):
+        self.smaller = smaller
+        self.value = value
+        self.larger = larger
 
-    def add_recursive(self, new_value, node):
-        if new_value < node.value:
-            if node.smaller is None:
-                node.smaller = Node(new_value)
+    def add(self, value):
+        if self.value is None:
+            self.value = value
+        elif value < self.value:
+            if self.smaller is None:
+                self.smaller = BinTree(value)
             else:
-                self.add_recursive(new_value, node.smaller)
+                self.smaller.add(value)
         else:
-            if node.larger is None:
-                node.larger = Node(new_value)
+            if self.larger is None:
+                self.larger = BinTree(value)
             else:
-                self.add_recursive(new_value, node.larger)
-        mg.block(mg.show, locals()) # <--- draw graph
-
-    def add(self, value):
-        if self.root is None:
-            self.root = Node(value)
-        else:
-            self.add_recursive(value, self.root)
+                self.larger.add(value)
+        mg.block(mg.show, mg.stack()) # <--- draw stack
 
 tree = BinTree()
 n = 100
 for i in range(n):
-    new_value = random.randrange(n)
-    tree.add(new_value)
+    value = random.randrange(n)
+    tree.add(value)
 ```
 ![bin_tree.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/bin_tree.png)
 
@@ -483,7 +475,7 @@ class HashSet:
             self.buckets[index] = []
         bucket = self.buckets[index]
         bucket.append(value)
-        mg.block(mg.show, locals()) # <--- draw graph
+        mg.block(mg.show, locals()) # <--- draw locals
 
     def contains(self, value):
         index = hash(value) % len(self.buckets)
@@ -774,7 +766,7 @@ We can also run memory_graph in the browser: <a href="https://bterwijn.github.io
 
 ## 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 `render()` the graph to a different output format and to open it manually.
+- 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 ([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.
 
 - When graph edges overlap it can be hard to distinguish them. Using an interactive graphviz viewer, such as [xdot](https://github.com/jrfonseca/xdot.py), on a '*.gv' DOT output file will help.
 

memory_graph-0.3.18/images/bin_tree.py

@@ -0,0 +1,38 @@
+# This file is part of memory_graph.
+# Copyright (c) 2023, Bas Terwijn.
+# SPDX-License-Identifier: BSD-2-Clause
+
+import memory_graph as mg
+import random
+random.seed(0) # use same random numbers each run
+
+class BinTree:
+
+    def __init__(self, value=None, smaller=None, larger=None):
+        self.smaller = smaller
+        self.value = value
+        self.larger = larger
+
+    def add(self, value):
+        if self.value is None:
+            self.value = value
+        elif value < self.value:
+            if self.smaller is None:
+                self.smaller = BinTree(value)
+            else:
+                self.smaller.add(value)
+        else:
+            if self.larger is None:
+                self.larger = BinTree(value)
+            else:
+                self.larger.add(value)
+        if value == 51:
+            mg.render(mg.stack(), f"bin_tree.png")
+            exit(0)
+
+tree = BinTree()
+n = 100
+for i in range(n):
+    value = random.randrange(n)
+    tree.add(value)
+

memory_graph-0.3.18/images/bin_tree2.py

@@ -0,0 +1,31 @@
+import memory_graph as mg
+import random
+random.seed(0) # use same random numbers each run
+
+class BinTree:
+
+    def __init__(self, value=None, smaller=None, larger=None):
+        self.smaller = smaller
+        self.value = value
+        self.larger = larger
+
+    def add(self, value):
+        if self.value is None:
+            self.value = value
+        elif value < self.value:
+            if self.smaller is None:
+                self.smaller = BinTree(value)
+            else:
+                self.smaller.add(value)
+        else:
+            if self.larger is None:
+                self.larger = BinTree(value)
+            else:
+                self.larger.add(value)
+        mg.block(mg.show, mg.stack())
+
+tree = BinTree()
+n = 100
+for i in range(n):
+    value = random.randrange(n)
+    tree.add(value)

memory_graph-0.3.18/images/bin_tree2.py~

@@ -0,0 +1,31 @@
+import memory_graph as mg
+import random
+random.seed(0) # use same random numbers each run
+
+class BinTree:
+
+    def __init__(self, value=None, smaller=None, larger=None):
+        self.smaller = smaller
+        self.value = value
+        self.larger = larger
+
+    def add(self, value):
+        if self.value is None:
+            self.value = value
+        elif value < self.value:
+            if self.smaller is None:
+                self.smaller = BinTree(value)
+            else:
+                self.smaller.add(value)
+        else:
+            if self.larger is None:
+                self.larger = BinTree(value)
+            else:
+                self.larger.add(value)
+	mg.block(mg.render, mg.stack(), f"bin_tree.png")
+
+tree = BinTree()
+n = 100
+for i in range(n):
+    value = random.randrange(n)
+    tree.add(value)

{memory_graph-0.3.16 → memory_graph-0.3.18}/images/copy_method.py

@@ -11,12 +11,13 @@ class My_Class:
         self.digits = [1, 2]
         self.letters = ['x', 'y']
 
-    def copy(self): # custom copy method copies the digits but shares the letters
+    def custom_copy(self):
+        """ Copies 'digits' but shares 'letters'. """
         c = copy.copy(self)
         c.digits = copy.copy(self.digits)
         return c
 
 a = My_Class()
-b = a.copy()
+b = a.custom_copy()
 
 mg.render(locals(), 'copy_method.png')

{memory_graph-0.3.16 → memory_graph-0.3.18}/memory_graph/__init__.py

@@ -10,10 +10,11 @@ import memory_graph.utils as utils
 
 import inspect
 import sys
+from memory_graph.call_stack import call_stack
 
 import graphviz
 
-__version__ = "0.3.16"
+__version__ = "0.3.18"
 __author__ = 'Bas Terwijn'
 render_filename = 'memory_graph.pdf'
 last_show_filename = None
@@ -173,14 +174,24 @@ def get_locals_from_call_stack(stack_index=0):
     frameInfo = inspect.stack()[1+stack_index] # get frameInfo of calling frame
     return frameInfo.frame.f_locals
 
+def get_function_name(frameInfo):
+    frame = frameInfo.frame
+    func_name = frame.f_code.co_name
+    if 'self' in frame.f_locals:  # instance method
+        return f"{frame.f_locals['self'].__class__.__name__}.{func_name}"
+    elif 'cls' in frame.f_locals:  # class method
+        return f"{frame.f_locals['cls'].__name__}.{func_name}"
+    else:  # forget about static method, too complex
+        return func_name  # just the function
+
 def stack_frames_to_dict(frames):
     """ Returns a dictionary representing the data on the call stack. 
     Each key is the stack level and function name, each value is the locals of the frame at that level. 
     """
     def to_dict(value): #  fix by TerenceTux for Python 3.13
         return {k: v for k, v in value.items()}
-    return {f"{level}: {frameInfo.function}" : to_dict(frameInfo.frame.f_locals)
-            for level, frameInfo in enumerate(frames)}
+    return call_stack({f"{level}: {get_function_name(frameInfo)}" : to_dict(frameInfo.frame.f_locals)
+            for level, frameInfo in enumerate(frames)})
 
 def stack(up_to_function="<module>",stack_index=0):
     return get_call_stack(up_to_function, 1+stack_index)

memory_graph-0.3.18/memory_graph/call_stack.py

@@ -0,0 +1,9 @@
+# This file is part of memory_graph.
+# Copyright (c) 2023, Bas Terwijn.
+# SPDX-License-Identifier: BSD-2-Clause
+
+class call_stack(dict):
+    """Inherits from dict to give the call stack it own name and color. """
+    
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)

{memory_graph-0.3.16 → memory_graph-0.3.18}/memory_graph/config_default.py

@@ -8,6 +8,7 @@ from memory_graph.node_linear    import Node_Linear
 from memory_graph.node_key_value import Node_Key_Value
 from memory_graph.node_table     import Node_Table
 
+from memory_graph.call_stack import call_stack
 from memory_graph.slicer import Slicer
 
 import memory_graph.config as config
@@ -39,8 +40,11 @@ config.no_child_references_types = {dict, types.MappingProxyType}
 """ Conversion from type to Node_Base objects. """
 config.type_to_node = {
     str: lambda data: Node_Base(data), # visit as whole string, don't iterate over characters
+    call_stack: lambda data: Node_Key_Value(data, data.items()),
     types.FunctionType: lambda data: Node_Base(data.__qualname__),
     types.MethodType: lambda data: Node_Base(data.__qualname__),
+    classmethod: lambda data: Node_Base(data.__qualname__),
+    staticmethod: lambda data: Node_Base(data.__qualname__),
     range: lambda data: Node_Key_Value(data, {'start':data.start, 'stop':data.stop, 'step':data.step}.items()),
     dict: lambda data: (
         Node_Key_Value(data, utils.filter_dict(data.items()) )
@@ -67,10 +71,11 @@ config.type_to_color = {
     bytearray : "khaki2",
     # ================= key_value
     Node_Key_Value : "seagreen1", # for classes
-    type: "seagreen2",            # where class variables are stored
+    call_stack : 'khaki',
+    type: "seagreen3",            # where class variables are stored
     dict : "dodgerblue1",
     types.MappingProxyType : "dodgerblue2", # not used
-    range : "cornsilk",
+    range : "cornsilk2",
 }
 
 """ Types that will be visualized in vertical orientation if 'True', or horizontal orientation 

{memory_graph-0.3.16 → memory_graph-0.3.18/memory_graph.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: memory_graph
-Version: 0.3.16
+Version: 0.3.18
 Summary: Generate intuitive graphs of your Python data, great for debugging and understanding complex relationships.
 Home-page: https://github.com/bterwijn/memory_graph
 Author: Bas Terwijn
@@ -211,13 +211,14 @@ class My_Class:
         self.digits = [1, 2]
         self.letters = ['x', 'y']
 
-    def copy(self): # custom copy method copies the digits but shares the letters
+    def custom_copy(self): 
+	    """ Copies 'digits' but shares 'letters'. """
         c = copy.copy(self)
         c.digits = copy.copy(self.digits)
         return c
 
 a = My_Class()
-b = a.copy()
+b = a.custom_copy()
 
 mg.show(locals())
 ```
@@ -430,7 +431,7 @@ class LinkedList:
             new_node.next = self.head
             self.head.prev = new_node
             self.head = new_node
-        mg.block(mg.show, locals()) # <--- draw graph
+        mg.block(mg.show, locals()) # <--- draw locals
 
 linked_list = LinkedList()
 n = 100
@@ -446,42 +447,33 @@ import memory_graph as mg
 import random
 random.seed(0) # use same random numbers each run
 
-class Node:
-
-    def __init__(self, value):
-        self.smaller = None
-        self.value = value
-        self.larger = None
-
 class BinTree:
 
-    def __init__(self):
-        self.root = None
+    def __init__(self, value=None, smaller=None, larger=None):
+        self.smaller = smaller
+        self.value = value
+        self.larger = larger
 
-    def add_recursive(self, new_value, node):
-        if new_value < node.value:
-            if node.smaller is None:
-                node.smaller = Node(new_value)
+    def add(self, value):
+        if self.value is None:
+            self.value = value
+        elif value < self.value:
+            if self.smaller is None:
+                self.smaller = BinTree(value)
             else:
-                self.add_recursive(new_value, node.smaller)
+                self.smaller.add(value)
         else:
-            if node.larger is None:
-                node.larger = Node(new_value)
+            if self.larger is None:
+                self.larger = BinTree(value)
             else:
-                self.add_recursive(new_value, node.larger)
-        mg.block(mg.show, locals()) # <--- draw graph
-
-    def add(self, value):
-        if self.root is None:
-            self.root = Node(value)
-        else:
-            self.add_recursive(value, self.root)
+                self.larger.add(value)
+        mg.block(mg.show, mg.stack()) # <--- draw stack
 
 tree = BinTree()
 n = 100
 for i in range(n):
-    new_value = random.randrange(n)
-    tree.add(new_value)
+    value = random.randrange(n)
+    tree.add(value)
 ```
 ![bin_tree.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/bin_tree.png)
 
@@ -502,7 +494,7 @@ class HashSet:
             self.buckets[index] = []
         bucket = self.buckets[index]
         bucket.append(value)
-        mg.block(mg.show, locals()) # <--- draw graph
+        mg.block(mg.show, locals()) # <--- draw locals
 
     def contains(self, value):
         index = hash(value) % len(self.buckets)
@@ -793,7 +785,7 @@ We can also run memory_graph in the browser: <a href="https://bterwijn.github.io
 
 ## 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 `render()` the graph to a different output format and to open it manually.
+- 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 ([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.
 
 - When graph edges overlap it can be hard to distinguish them. Using an interactive graphviz viewer, such as [xdot](https://github.com/jrfonseca/xdot.py), on a '*.gv' DOT output file will help.