memory-graph 0.3.25__tar.gz → 0.3.27__tar.gz

{memory_graph-0.3.25/memory_graph.egg-info → memory_graph-0.3.27}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: memory_graph
-Version: 0.3.25
-Summary: Generate intuitive graphs of your Python data, great for debugging and understanding complex relationships.
+Version: 0.3.27
+Summary: Teaching tool and debugging aid in context of references, mutable data types, and shallow and deep copy.
 Home-page: https://github.com/bterwijn/memory_graph
 Author: Bas Terwijn
 Author-email: bterwijn@gmail.com
@@ -25,9 +25,9 @@ pip install --upgrade memory_graph
 Additionally [Graphviz](https://graphviz.org/download/) needs to be installed.
 
 # Videos #
-| [![Quick Intro](https://img.youtube.com/vi/8csmPga6Upw/0.jpg)](https://www.youtube.com/watch?v=8csmPga6Upw) | [![Mutability](https://img.youtube.com/vi/pvIJgHCaXhU/0.jpg)](https://www.youtube.com/watch?v=pvIJgHCaXhU) |
+| [![Quick Intro](https://img.youtube.com/vi/23_bHcr7hqo/0.jpg)](https://www.youtube.com/watch?v=23_bHcr7hqo) | [![Mutability](https://img.youtube.com/vi/pvIJgHCaXhU/0.jpg)](https://www.youtube.com/watch?v=pvIJgHCaXhU) |
 |:--:|:--:|
-| [Quick Intro](https://www.youtube.com/watch?v=8csmPga6Upw) | [Mutability](https://www.youtube.com/watch?v=pvIJgHCaXhU) |
+| [Quick Intro](https://www.youtube.com/watch?v=23_bHcr7hqo) | [Mutability](https://www.youtube.com/watch?v=pvIJgHCaXhU) |
 
 # Memory Graph #
 For program understanding and debugging, the [memory_graph](https://pypi.org/project/memory-graph/) package can visualize your data, supporting many different data types, including but not limited to:
@@ -46,7 +46,7 @@ mg.show(data)
 ```
 ![many_types.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/many_types.png)
 
-Instead of showing the graph on screen you can also render it to an output file of your choosing (see [Graphviz Output Formats](https://graphviz.org/docs/outputs/)) using for example:
+Instead of showing the graph on screen you can also render it to an output file (see [Graphviz Output Formats](https://graphviz.org/docs/outputs/)) using for example:
 
 ```python
 mg.render(data, "my_graph.pdf")
@@ -362,7 +362,7 @@ The ```mg.stack()``` doesn't work well in *watch* context in most debuggers beca
 | **Visual Studio Code** | `mg.stack_vscode()` |
 | **Pycharm** | `mg.stack_pycharm()` |
 
-![debug_vscode.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/debug_vscode.png)
+![vscode_copying.gif](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/vscode_copying.gif)
 
 ## Other Debuggers ##
 For other debuggers, invoke this function within the *watch* context. Then, in the "call_stack.txt" file, identify the slice of functions you wish to include in the call stack.
@@ -410,37 +410,37 @@ and pressing <Enter> a number of times, results in:
 # Data Structure Examples #
 Module memory_graph can be very useful in a course about data structures, some examples:
 
-## Doubly Linked List ##
+## Circular Doubly Linked List ##
 ```python
 import memory_graph as mg
 import random
 random.seed(0) # use same random numbers each run
 
 class Linked_List:
+    """ Circular doubly linked list """
 
-    def __init__(self, value=None, prev=None, next=None):
-        self.prev = prev
+    def __init__(self, value=None, 
+                 prev=None, next=None):
+        self.prev = prev if prev else self
         self.value = value
-        self.next = next
+        self.next = next if next else self
 
-    def add_front(self, value):
+    def add_back(self, value):
         if self.value == None:
             self.value = value 
-        elif self.next is None:
-            new_node = Linked_List(value)
-            self.prev = new_node
-            self.next = new_node
         else:
-            new_node = Linked_List(value, self.next)
-            self.next.next = new_node
-            self.next = new_node
+            new_node = Linked_List(value,
+                                   prev=self.prev,
+                                   next=self)
+            self.prev.next = new_node
+            self.prev = new_node
 
 linked_list = Linked_List()
 n = 100
 for i in range(n):
     value = random.randrange(n)
-    linked_list.add_front(value)
-	mg.show(locals())
+    linked_list.add_back(value)
+    mg.block(mg.show, locals()) # <--- draw locals
 ```
 ![linked_list.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/linked_list.png)
 
@@ -575,7 +575,7 @@ mg.render(locals(), 'not_node_types2.png')
 |:-----------------------------------------------------------:|:-------------------------------------------------------------:|
 | not_node_types1.png — simplified | not_node_types2.png — technically correct |
 
-Additionally, the simplification hides away the [reuse of small int values](https://docs.python.org/3/c-api/long.html#c.PyLong_FromLong) in the current CPython implementation, an optimization that might otherwise confuse beginner Python programmers. For instance, after executing `a[1]+=1; b[1]+=1` the `201` value is, maybe surprisingly, still shared between `a` and `b`, whereas executing `a[2]+=1; b[2]+=1` does not result in sharing the `301` value.
+Additionally, the simplification hides away the [reuse of small int values \[-5, 256\]](https://docs.python.org/3/c-api/long.html#c.PyLong_FromLong) in the current CPython implementation, an optimization that might otherwise confuse beginner Python programmers. For instance, after executing `a[1]+=1; b[1]+=1` the `201` value is, maybe surprisingly, still shared between `a` and `b`, whereas executing `a[2]+=1; b[2]+=1` does not result in sharing the `301` value.
 
 ## Temporary Configuration ##
 In addition to the global configuration, a temporary configuration can be set for a single `show()` or `render()` call to change the colors, orientation, and slicer. This example highlights a particular list element in red, gives it a horizontal orientation, and overwrites the default slicer for lists:

{memory_graph-0.3.25 → memory_graph-0.3.27}/README.md

@@ -6,9 +6,9 @@ pip install --upgrade memory_graph
 Additionally [Graphviz](https://graphviz.org/download/) needs to be installed.
 
 # Videos #
-| [![Quick Intro](https://img.youtube.com/vi/8csmPga6Upw/0.jpg)](https://www.youtube.com/watch?v=8csmPga6Upw) | [![Mutability](https://img.youtube.com/vi/pvIJgHCaXhU/0.jpg)](https://www.youtube.com/watch?v=pvIJgHCaXhU) |
+| [![Quick Intro](https://img.youtube.com/vi/23_bHcr7hqo/0.jpg)](https://www.youtube.com/watch?v=23_bHcr7hqo) | [![Mutability](https://img.youtube.com/vi/pvIJgHCaXhU/0.jpg)](https://www.youtube.com/watch?v=pvIJgHCaXhU) |
 |:--:|:--:|
-| [Quick Intro](https://www.youtube.com/watch?v=8csmPga6Upw) | [Mutability](https://www.youtube.com/watch?v=pvIJgHCaXhU) |
+| [Quick Intro](https://www.youtube.com/watch?v=23_bHcr7hqo) | [Mutability](https://www.youtube.com/watch?v=pvIJgHCaXhU) |
 
 # Memory Graph #
 For program understanding and debugging, the [memory_graph](https://pypi.org/project/memory-graph/) package can visualize your data, supporting many different data types, including but not limited to:
@@ -27,7 +27,7 @@ mg.show(data)
 ```
 ![many_types.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/many_types.png)
 
-Instead of showing the graph on screen you can also render it to an output file of your choosing (see [Graphviz Output Formats](https://graphviz.org/docs/outputs/)) using for example:
+Instead of showing the graph on screen you can also render it to an output file (see [Graphviz Output Formats](https://graphviz.org/docs/outputs/)) using for example:
 
 ```python
 mg.render(data, "my_graph.pdf")
@@ -343,7 +343,7 @@ The ```mg.stack()``` doesn't work well in *watch* context in most debuggers beca
 | **Visual Studio Code** | `mg.stack_vscode()` |
 | **Pycharm** | `mg.stack_pycharm()` |
 
-![debug_vscode.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/debug_vscode.png)
+![vscode_copying.gif](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/vscode_copying.gif)
 
 ## Other Debuggers ##
 For other debuggers, invoke this function within the *watch* context. Then, in the "call_stack.txt" file, identify the slice of functions you wish to include in the call stack.
@@ -391,37 +391,37 @@ and pressing <Enter> a number of times, results in:
 # Data Structure Examples #
 Module memory_graph can be very useful in a course about data structures, some examples:
 
-## Doubly Linked List ##
+## Circular Doubly Linked List ##
 ```python
 import memory_graph as mg
 import random
 random.seed(0) # use same random numbers each run
 
 class Linked_List:
+    """ Circular doubly linked list """
 
-    def __init__(self, value=None, prev=None, next=None):
-        self.prev = prev
+    def __init__(self, value=None, 
+                 prev=None, next=None):
+        self.prev = prev if prev else self
         self.value = value
-        self.next = next
+        self.next = next if next else self
 
-    def add_front(self, value):
+    def add_back(self, value):
         if self.value == None:
             self.value = value 
-        elif self.next is None:
-            new_node = Linked_List(value)
-            self.prev = new_node
-            self.next = new_node
         else:
-            new_node = Linked_List(value, self.next)
-            self.next.next = new_node
-            self.next = new_node
+            new_node = Linked_List(value,
+                                   prev=self.prev,
+                                   next=self)
+            self.prev.next = new_node
+            self.prev = new_node
 
 linked_list = Linked_List()
 n = 100
 for i in range(n):
     value = random.randrange(n)
-    linked_list.add_front(value)
-	mg.show(locals())
+    linked_list.add_back(value)
+    mg.block(mg.show, locals()) # <--- draw locals
 ```
 ![linked_list.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/linked_list.png)
 
@@ -556,7 +556,7 @@ mg.render(locals(), 'not_node_types2.png')
 |:-----------------------------------------------------------:|:-------------------------------------------------------------:|
 | not_node_types1.png — simplified | not_node_types2.png — technically correct |
 
-Additionally, the simplification hides away the [reuse of small int values](https://docs.python.org/3/c-api/long.html#c.PyLong_FromLong) in the current CPython implementation, an optimization that might otherwise confuse beginner Python programmers. For instance, after executing `a[1]+=1; b[1]+=1` the `201` value is, maybe surprisingly, still shared between `a` and `b`, whereas executing `a[2]+=1; b[2]+=1` does not result in sharing the `301` value.
+Additionally, the simplification hides away the [reuse of small int values \[-5, 256\]](https://docs.python.org/3/c-api/long.html#c.PyLong_FromLong) in the current CPython implementation, an optimization that might otherwise confuse beginner Python programmers. For instance, after executing `a[1]+=1; b[1]+=1` the `201` value is, maybe surprisingly, still shared between `a` and `b`, whereas executing `a[2]+=1; b[2]+=1` does not result in sharing the `301` value.
 
 ## Temporary Configuration ##
 In addition to the global configuration, a temporary configuration can be set for a single `show()` or `render()` call to change the colors, orientation, and slicer. This example highlights a particular list element in red, gives it a horizontal orientation, and overwrites the default slicer for lists:

memory_graph-0.3.27/images/cmp.sh

@@ -0,0 +1,3 @@
+xdg-open $1
+sleep 0.3
+xdg-open ../images_old/$1

memory_graph-0.3.27/images/cmp.sh~

@@ -0,0 +1 @@
+o $1 && sleep 0.3 && o ../images_old/$1

{memory_graph-0.3.25 → memory_graph-0.3.27}/images/linked_list.py

@@ -7,29 +7,29 @@ import random
 random.seed(0) # use same random numbers each run
 
 class Linked_List:
+    """ Circular doubly linked list """
 
-    def __init__(self, value=None, prev=None, next=None):
-        self.prev = prev
+    def __init__(self, value=None, 
+                 prev=None, next=None):
+        self.prev = prev if prev else self
         self.value = value
-        self.next = next
+        self.next = next if next else self
 
-    def add_front(self, value):
+    def add_back(self, value):
         if self.value == None:
             self.value = value 
-        elif self.next is None:
-            new_node = Linked_List(value)
-            self.prev = new_node
-            self.next = new_node
         else:
-            new_node = Linked_List(value, self.next)
-            self.next.next = new_node
-            self.next = new_node
+            new_node = Linked_List(value,
+                                   prev=self.prev,
+                                   next=self)
+            self.prev.next = new_node
+            self.prev = new_node
 
 linked_list = Linked_List()
 n = 100
 for i in range(n):
     value = random.randrange(n)
-    linked_list.add_front(value)
+    linked_list.add_back(value)
     if value == 33:
         mg.render(locals(), "linked_list.png")
         exit()

memory_graph-0.3.27/images/name_rebinding.py~

@@ -0,0 +1,7 @@
+import memory_graph as mg
+
+a = [4, 3, 2]
+b = a
+mg.render(locals(), 'mutable1.png')
+a += [1] # equivalent to:  a.append(1)
+mg.render(locals(), 'mutable2.png')

{memory_graph-0.3.25 → memory_graph-0.3.27}/memory_graph/__init__.py

@@ -10,11 +10,12 @@ import memory_graph.utils as utils
 
 import inspect
 import sys
+import itertools as it
 from memory_graph.call_stack import call_stack
 
 import graphviz
 
-__version__ = "0.3.25"
+__version__ = "0.3.27"
 __author__ = 'Bas Terwijn'
 render_filename = 'memory_graph.pdf'
 render_filename_count = 0
@@ -224,12 +225,13 @@ def get_call_stack(up_to_function="<module>",stack_index=0):
 
 def stack_after_up_to(after_function,up_to_function="<module>"):
     return get_call_stack_after_up_to(after_function, up_to_function)
-def get_call_stack_after_up_to(after_function,up_to_function="<module>"):
-    """ Gets the call stack after the function 'after_function' up to the function 'up_to_function'."""
-    frames = reversed(list(
+def get_call_stack_after_up_to(after_function,up_to_function="<module>", drop=0):
+    """ Gets the call stack after the function 'after_function' up to the function 'up_to_function'
+        and drop the first 'drop' stack frames. """
+    frames = reversed(list(it.islice(
             utils.take_up_to(lambda i: i.function == up_to_function,
             utils.take_after(lambda i: i.function == after_function, inspect.stack()))
-            ))
+            , 1, None)))
     return stack_frames_to_dict(frames)
 
 def stack_pdb(after_function="trace_dispatch",up_to_function="<module>"):
@@ -244,11 +246,11 @@ def get_call_stack_vscode(after_function="do_wait_suspend",up_to_function="<modu
     """ Get the call stack in a 'vscode' debugger session, filtering out the 'vscode' functions that polute the graph. """
     return get_call_stack_after_up_to(after_function,up_to_function)
 
-def stack_pycharm(after_function="trace_dispatch",up_to_function="<module>"):
+def stack_pycharm(after_function="do_wait_suspend",up_to_function="<module>"):
     return get_call_stack_pycharm(after_function, up_to_function)
-def get_call_stack_pycharm(after_function="trace_dispatch",up_to_function="<module>"):
-    """ Get the call stack in a 'pycharm' debugger session, filtering out the 'pycharm' functions that polute the graph. """
-    return get_call_stack_after_up_to(after_function,up_to_function)
+def get_call_stack_pycharm(after_function="do_wait_suspend",up_to_function="<module>"):
+    """ Get the call stack in a 'vscode' debugger session, filtering out the 'vscode' functions that polute the graph. """
+    return get_call_stack_after_up_to(after_function,up_to_function, 1)
 
 def save_call_stack(filename):
     """ Saves the call stack to 'filename' for inspection to see what functions need to be 

memory_graph-0.3.27/memory_graph/t.py

@@ -0,0 +1,6 @@
+import memory_graph as mg
+
+a= [0,10000,5]
+
+mg.render(a, 'value.svg')
+

{memory_graph-0.3.25 → memory_graph-0.3.27/memory_graph.egg-info}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: memory_graph
-Version: 0.3.25
-Summary: Generate intuitive graphs of your Python data, great for debugging and understanding complex relationships.
+Version: 0.3.27
+Summary: Teaching tool and debugging aid in context of references, mutable data types, and shallow and deep copy.
 Home-page: https://github.com/bterwijn/memory_graph
 Author: Bas Terwijn
 Author-email: bterwijn@gmail.com
@@ -25,9 +25,9 @@ pip install --upgrade memory_graph
 Additionally [Graphviz](https://graphviz.org/download/) needs to be installed.
 
 # Videos #
-| [![Quick Intro](https://img.youtube.com/vi/8csmPga6Upw/0.jpg)](https://www.youtube.com/watch?v=8csmPga6Upw) | [![Mutability](https://img.youtube.com/vi/pvIJgHCaXhU/0.jpg)](https://www.youtube.com/watch?v=pvIJgHCaXhU) |
+| [![Quick Intro](https://img.youtube.com/vi/23_bHcr7hqo/0.jpg)](https://www.youtube.com/watch?v=23_bHcr7hqo) | [![Mutability](https://img.youtube.com/vi/pvIJgHCaXhU/0.jpg)](https://www.youtube.com/watch?v=pvIJgHCaXhU) |
 |:--:|:--:|
-| [Quick Intro](https://www.youtube.com/watch?v=8csmPga6Upw) | [Mutability](https://www.youtube.com/watch?v=pvIJgHCaXhU) |
+| [Quick Intro](https://www.youtube.com/watch?v=23_bHcr7hqo) | [Mutability](https://www.youtube.com/watch?v=pvIJgHCaXhU) |
 
 # Memory Graph #
 For program understanding and debugging, the [memory_graph](https://pypi.org/project/memory-graph/) package can visualize your data, supporting many different data types, including but not limited to:
@@ -46,7 +46,7 @@ mg.show(data)
 ```
 ![many_types.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/many_types.png)
 
-Instead of showing the graph on screen you can also render it to an output file of your choosing (see [Graphviz Output Formats](https://graphviz.org/docs/outputs/)) using for example:
+Instead of showing the graph on screen you can also render it to an output file (see [Graphviz Output Formats](https://graphviz.org/docs/outputs/)) using for example:
 
 ```python
 mg.render(data, "my_graph.pdf")
@@ -362,7 +362,7 @@ The ```mg.stack()``` doesn't work well in *watch* context in most debuggers beca
 | **Visual Studio Code** | `mg.stack_vscode()` |
 | **Pycharm** | `mg.stack_pycharm()` |
 
-![debug_vscode.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/debug_vscode.png)
+![vscode_copying.gif](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/vscode_copying.gif)
 
 ## Other Debuggers ##
 For other debuggers, invoke this function within the *watch* context. Then, in the "call_stack.txt" file, identify the slice of functions you wish to include in the call stack.
@@ -410,37 +410,37 @@ and pressing <Enter> a number of times, results in:
 # Data Structure Examples #
 Module memory_graph can be very useful in a course about data structures, some examples:
 
-## Doubly Linked List ##
+## Circular Doubly Linked List ##
 ```python
 import memory_graph as mg
 import random
 random.seed(0) # use same random numbers each run
 
 class Linked_List:
+    """ Circular doubly linked list """
 
-    def __init__(self, value=None, prev=None, next=None):
-        self.prev = prev
+    def __init__(self, value=None, 
+                 prev=None, next=None):
+        self.prev = prev if prev else self
         self.value = value
-        self.next = next
+        self.next = next if next else self
 
-    def add_front(self, value):
+    def add_back(self, value):
         if self.value == None:
             self.value = value 
-        elif self.next is None:
-            new_node = Linked_List(value)
-            self.prev = new_node
-            self.next = new_node
         else:
-            new_node = Linked_List(value, self.next)
-            self.next.next = new_node
-            self.next = new_node
+            new_node = Linked_List(value,
+                                   prev=self.prev,
+                                   next=self)
+            self.prev.next = new_node
+            self.prev = new_node
 
 linked_list = Linked_List()
 n = 100
 for i in range(n):
     value = random.randrange(n)
-    linked_list.add_front(value)
-	mg.show(locals())
+    linked_list.add_back(value)
+    mg.block(mg.show, locals()) # <--- draw locals
 ```
 ![linked_list.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/linked_list.png)
 
@@ -575,7 +575,7 @@ mg.render(locals(), 'not_node_types2.png')
 |:-----------------------------------------------------------:|:-------------------------------------------------------------:|
 | not_node_types1.png — simplified | not_node_types2.png — technically correct |
 
-Additionally, the simplification hides away the [reuse of small int values](https://docs.python.org/3/c-api/long.html#c.PyLong_FromLong) in the current CPython implementation, an optimization that might otherwise confuse beginner Python programmers. For instance, after executing `a[1]+=1; b[1]+=1` the `201` value is, maybe surprisingly, still shared between `a` and `b`, whereas executing `a[2]+=1; b[2]+=1` does not result in sharing the `301` value.
+Additionally, the simplification hides away the [reuse of small int values \[-5, 256\]](https://docs.python.org/3/c-api/long.html#c.PyLong_FromLong) in the current CPython implementation, an optimization that might otherwise confuse beginner Python programmers. For instance, after executing `a[1]+=1; b[1]+=1` the `201` value is, maybe surprisingly, still shared between `a` and `b`, whereas executing `a[2]+=1; b[2]+=1` does not result in sharing the `301` value.
 
 ## Temporary Configuration ##
 In addition to the global configuration, a temporary configuration can be set for a single `show()` or `render()` call to change the colors, orientation, and slicer. This example highlights a particular list element in red, gives it a horizontal orientation, and overwrites the default slicer for lists: