memory-graph 0.2.0__tar.gz → 0.2.2__tar.gz

{memory_graph-0.2.0 → memory_graph-0.2.2}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: memory_graph
-Version: 0.2.0
-Summary: Draws a graph of your data to analyze the structure of its references.
+Version: 0.2.2
+Summary: Draws a graph of your data to analyze its structure.
 Home-page: https://github.com/bterwijn/memory_graph
 Author: Bas Terwijn
 Author-email: bterwijn@gmail.com
@@ -38,16 +38,16 @@ a = [4, 3, 2]
 b = a
 a.append(1) # changing 'a' changes 'b'
 
-# print the lists
+# print the 'a' and 'b' list
 print('a:', a)
 print('b:', b)
 
-# check if they share data
+# check if 'a' and 'b' share data
 print('ids:', id(a), id(b))
 print('identical?:', a is b)
 
-# show the lists in a graph
-memory_graph.show(locals()) 
+# show all local variables in a graph
+memory_graph.show( locals() )
 ```
 
 </td><td>
@@ -65,21 +65,26 @@ b: 4, 3, 2, 1
 ids: 126432214913216 126432214913216
 identical?: True
 ```
-A better way to understand what data is shared is to draw a graph of the data using this [memory_graph](https://pypi.org/project/memory-graph/) package.
+A better way to understand what data is shared is to draw a graph of the data using the [memory_graph](https://pypi.org/project/memory-graph/) package.
 
 # Memory Graph Packge #
-The [memory_graph](https://pypi.org/project/memory-graph/) package can show a graph with many different data types.
+The [memory_graph](https://pypi.org/project/memory-graph/) package can graph many different data types.
 
 ```python
 import memory_graph
 
-data = [ (1, 2), [3, 4], {5, 6}, {7:'seven', 8:'eight'} ]
+class MyClass:
+
+    def __init__(self, x, y):
+        self.x = x
+        self.y = y
+
+data = [ range(1, 2), (3, 4), {5, 6}, {7:'seven', 8:'eight'},  MyClass(9, 10) ]
 memory_graph.show(data, block=True)
 ```
-
 ![many_types.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/many_types.png)
 
-By using `block=True` the program blocks until the ENTER key is pressed so you can view the graph before continuing program execution (and possibly viewing later graphs). Instead of showing the graph you can also render it to an output file of our choosing (see [Graphviz Output Formats](https://graphviz.org/docs/outputs/)) using for example:
+By using `block=True` the program blocks until the ENTER key is pressed so you can view the graph before continuing program execution (and possibly viewing later graphs). Instead of showing the graph you can also render it to an output file of your choosing (see [Graphviz Output Formats](https://graphviz.org/docs/outputs/)) using for example:
 
 ```python
 memory_graph.render(data, "my_graph.pdf")
@@ -126,7 +131,7 @@ The [Python Data Model](https://docs.python.org/3/reference/datamodel.html) make
 In the code below variable `a` and `b` both reference the same `int` value 10. An `int` is an immutable type and therefore when we change variable `a` its value can **not** be mutated in place, and thus a copy is made and `a` and `b` reference a different value afterwards.
 ```python
 import memory_graph
-memory_graph.rewrite_to_node.reduce_reference_children.remove("int") # shows references to 'int'
+memory_graph.config.no_reference_types.pop(int, None) # show references to ints
 
 a = 10
 b = a
@@ -458,18 +463,18 @@ for i in range(n):
 ## 5. Configuration ##
 Different aspects of memory_graph can be configured. The default configuration is reset by importing 'memory_graph.config_default'.
 
+- ***memory_graph.config.max_number_nodes*** : int
+  - The maxium number of Nodes shown in the graph. When the graph gets too big set this to a smaller number. A `★` symbol indictes where the graph is cut short.
+
+- ***memory_graph.config.max_string_length*** : int
+  - The maximum length of strings shown in the graph. Longer strings will be truncated.
+
 - ***memory_graph.config.no_reference_types*** : dict
-  - Holds all types for which no seperate node it drawn but that are shown as elements in their parent Node. It maps each type to a function that determines how it is visualized.
+  - Holds all types for which no seperate node is drawn but that instead are shown as elements in their parent Node. It maps each type to a function that determines how it is visualized.
 
 - ***memory_graph.config.no_child_references_types*** : set
   - The set of key_value types that don't draw references to their direct childeren but have their children shown as elements of their node.
 
-- ***memory_graph.config.max_string_length*** : int
-  - The maximum length of strings shown in the graph.
-
-- ***memory_graph.config.max_number_nodes*** : int
-  - The maxium number of Nodes shows in the graph. When the graph gets to big set this to a small number to analyze the problem.
-
 - ***memory_graph.config.type_to_node*** : dict
   - Determines how a data types is converted to a Node (sub)class for visualization in the graph.
 
@@ -483,7 +488,7 @@ Different aspects of memory_graph can be configured. The default configuration i
   - Maps each type to a Slicer. A slicer determines how many elements of a data type are shown in the graph to prevent the graph from getting too big. 'Slicer()' does no slicing, 'Slicer(1,2,3)' shows just 1 element at the beginning, 2 in the middle, and 3 at the end.
 
 ### Temporary Configuration ###
-In addition to the global configuration, a temporary configuration can be set for a single `show()`, `render()`, or `d()` call to change the colors, orientation, and slicer. This example highlights a particular list element in red, gives it a horizontal orientattion, and overwrites the default slicer for lists:
+In addition to the global configuration, a temporary configuration can be set for a single `show()`, `render()`, or `d()` 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:
 
 ```python
 import memory_graph
@@ -501,7 +506,7 @@ memory_graph.show( locals(),
 ![highlight.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/highlight.png)
 
 ## 6. Extensions ##
-Different extension are available for types from Python packages. 
+Different extensions are available for types from other Python packages. 
 
 ### Numpy ###
 Numpy types `arrray` and `matrix` and `ndarray` can be graphed with the "memory_graph.extension_numpy" extension:

{memory_graph-0.2.0 → memory_graph-0.2.2}/README.md

@@ -19,16 +19,16 @@ a = [4, 3, 2]
 b = a
 a.append(1) # changing 'a' changes 'b'
 
-# print the lists
+# print the 'a' and 'b' list
 print('a:', a)
 print('b:', b)
 
-# check if they share data
+# check if 'a' and 'b' share data
 print('ids:', id(a), id(b))
 print('identical?:', a is b)
 
-# show the lists in a graph
-memory_graph.show(locals()) 
+# show all local variables in a graph
+memory_graph.show( locals() )
 ```
 
 </td><td>
@@ -46,21 +46,26 @@ b: 4, 3, 2, 1
 ids: 126432214913216 126432214913216
 identical?: True
 ```
-A better way to understand what data is shared is to draw a graph of the data using this [memory_graph](https://pypi.org/project/memory-graph/) package.
+A better way to understand what data is shared is to draw a graph of the data using the [memory_graph](https://pypi.org/project/memory-graph/) package.
 
 # Memory Graph Packge #
-The [memory_graph](https://pypi.org/project/memory-graph/) package can show a graph with many different data types.
+The [memory_graph](https://pypi.org/project/memory-graph/) package can graph many different data types.
 
 ```python
 import memory_graph
 
-data = [ (1, 2), [3, 4], {5, 6}, {7:'seven', 8:'eight'} ]
+class MyClass:
+
+    def __init__(self, x, y):
+        self.x = x
+        self.y = y
+
+data = [ range(1, 2), (3, 4), {5, 6}, {7:'seven', 8:'eight'},  MyClass(9, 10) ]
 memory_graph.show(data, block=True)
 ```
-
 ![many_types.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/many_types.png)
 
-By using `block=True` the program blocks until the ENTER key is pressed so you can view the graph before continuing program execution (and possibly viewing later graphs). Instead of showing the graph you can also render it to an output file of our choosing (see [Graphviz Output Formats](https://graphviz.org/docs/outputs/)) using for example:
+By using `block=True` the program blocks until the ENTER key is pressed so you can view the graph before continuing program execution (and possibly viewing later graphs). Instead of showing the graph you can also render it to an output file of your choosing (see [Graphviz Output Formats](https://graphviz.org/docs/outputs/)) using for example:
 
 ```python
 memory_graph.render(data, "my_graph.pdf")
@@ -107,7 +112,7 @@ The [Python Data Model](https://docs.python.org/3/reference/datamodel.html) make
 In the code below variable `a` and `b` both reference the same `int` value 10. An `int` is an immutable type and therefore when we change variable `a` its value can **not** be mutated in place, and thus a copy is made and `a` and `b` reference a different value afterwards.
 ```python
 import memory_graph
-memory_graph.rewrite_to_node.reduce_reference_children.remove("int") # shows references to 'int'
+memory_graph.config.no_reference_types.pop(int, None) # show references to ints
 
 a = 10
 b = a
@@ -439,18 +444,18 @@ for i in range(n):
 ## 5. Configuration ##
 Different aspects of memory_graph can be configured. The default configuration is reset by importing 'memory_graph.config_default'.
 
+- ***memory_graph.config.max_number_nodes*** : int
+  - The maxium number of Nodes shown in the graph. When the graph gets too big set this to a smaller number. A `★` symbol indictes where the graph is cut short.
+
+- ***memory_graph.config.max_string_length*** : int
+  - The maximum length of strings shown in the graph. Longer strings will be truncated.
+
 - ***memory_graph.config.no_reference_types*** : dict
-  - Holds all types for which no seperate node it drawn but that are shown as elements in their parent Node. It maps each type to a function that determines how it is visualized.
+  - Holds all types for which no seperate node is drawn but that instead are shown as elements in their parent Node. It maps each type to a function that determines how it is visualized.
 
 - ***memory_graph.config.no_child_references_types*** : set
   - The set of key_value types that don't draw references to their direct childeren but have their children shown as elements of their node.
 
-- ***memory_graph.config.max_string_length*** : int
-  - The maximum length of strings shown in the graph.
-
-- ***memory_graph.config.max_number_nodes*** : int
-  - The maxium number of Nodes shows in the graph. When the graph gets to big set this to a small number to analyze the problem.
-
 - ***memory_graph.config.type_to_node*** : dict
   - Determines how a data types is converted to a Node (sub)class for visualization in the graph.
 
@@ -464,7 +469,7 @@ Different aspects of memory_graph can be configured. The default configuration i
   - Maps each type to a Slicer. A slicer determines how many elements of a data type are shown in the graph to prevent the graph from getting too big. 'Slicer()' does no slicing, 'Slicer(1,2,3)' shows just 1 element at the beginning, 2 in the middle, and 3 at the end.
 
 ### Temporary Configuration ###
-In addition to the global configuration, a temporary configuration can be set for a single `show()`, `render()`, or `d()` call to change the colors, orientation, and slicer. This example highlights a particular list element in red, gives it a horizontal orientattion, and overwrites the default slicer for lists:
+In addition to the global configuration, a temporary configuration can be set for a single `show()`, `render()`, or `d()` 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:
 
 ```python
 import memory_graph
@@ -482,7 +487,7 @@ memory_graph.show( locals(),
 ![highlight.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/highlight.png)
 
 ## 6. Extensions ##
-Different extension are available for types from Python packages. 
+Different extensions are available for types from other Python packages. 
 
 ### Numpy ###
 Numpy types `arrray` and `matrix` and `ndarray` can be graphed with the "memory_graph.extension_numpy" extension:

{memory_graph-0.2.0 → memory_graph-0.2.2}/memory_graph/Memory_Visitor.py

@@ -6,7 +6,6 @@ import memory_graph.utils as utils
 import memory_graph.config as config
 import memory_graph.config_helpers as config_helpers
 
-
 def default_backtrack_callback(node):
     print('backtrack_callback:', node)
     #node.visit_with_depth(lambda child: print('-- child:', child))
@@ -49,12 +48,12 @@ class Memory_Visitor:
         data_type = type(data)
         if (parent_node != None and data_type in config.no_reference_types):
             return config.no_reference_types[data_type](data)
-        if len(self.data_ids) > config.max_number_nodes:
-            print(f"Memory_Visitor max_number_nodes ({config.max_number_nodes}) reached, stopping recursion.")
-            return None
         data_id = id(data)
         if data_id in self.data_ids:
             return self.data_ids[data_id]
+        elif len(self.data_ids) > config.max_number_nodes:
+            print(f"Memory_Visitor max_number_nodes ({config.max_number_nodes}) reached, stopping recursion.")
+            return "★"
         else:
             node = self.data_to_node(data)
             self.data_ids[data_id] = node

{memory_graph-0.2.0 → memory_graph-0.2.2}/memory_graph/__init__.py

@@ -6,7 +6,7 @@ import memory_graph.utils as utils
 import inspect
 import sys
 
-__version__ = "0.2.00"
+__version__ = "0.2.02"
 __author__ = 'Bas Terwijn'
 
 log_file=sys.stdout

{memory_graph-0.2.0 → memory_graph-0.2.2}/memory_graph/config.py

@@ -1,11 +1,11 @@
 """ Configuration file for the graph visualizer. The configuration values are set later by the 'config_default.py' file. """
 
+max_number_nodes = 0
+max_string_length = 0
+
 no_reference_types = {}
 no_child_references_types = set()
 
-max_string_length = 42
-max_number_nodes = 1000
-
 type_to_node = { }
 
 type_to_color = { }

{memory_graph-0.2.0 → memory_graph-0.2.2}/memory_graph/config_default.py

@@ -11,6 +11,12 @@ import memory_graph.utils as utils
 
 import types
 
+""" The maxium number of Nodes shown in the graph. When the graph gets too big set this to a smaller number to analyze the problem. A `★` symbol indictes where the gra[h is cut short.  """
+config.max_number_nodes = 1000
+
+""" The maximum length of strings shown in the graph. Longer strings will be truncated. """
+config.max_string_length = 42
+
 """ Types that by default will not have references pointing to them in the graph but instead will be visualized in the node of their parent. """
 config.no_reference_types = {
     type(None) : lambda d: "None",  # so None can be used to indicate no value
@@ -26,9 +32,6 @@ config.no_reference_types = {
 """ Types that will not have references pointing to their children in the graph but instead will have their children visualized in their node. """
 config.no_child_references_types = {dict, types.MappingProxyType}
 
-config.max_string_length = 42
-config.max_number_nodes = 1000
-
 """ Conversion from type to Node objects. """
 config.type_to_node = {
     str: lambda data: Node(data), # visit as whole string, don't iterate over characters

memory_graph-0.2.2/memory_graph/special_types.py

@@ -0,0 +1,4 @@
+
+class Red_X:
+    pass
+

{memory_graph-0.2.0 → memory_graph-0.2.2}/memory_graph/test.py

@@ -40,7 +40,7 @@ def test_empty_linear(fun):
     fun(data)
 
 def test_nested_list(fun):
-    data = utils.nested_list([2,3,4,5])
+    data = utils.nested_list([2,2,2,2,2,2,2])
     fun(data)
 
 def test_key_value(fun):

{memory_graph-0.2.0 → memory_graph-0.2.2}/memory_graph/test_memory_graph.py

@@ -11,4 +11,3 @@ if __name__ == '__main__':
         graph.get_graph().render(outfile=f'test_graph{test_fun_count}.png')
         test_fun_count += 1
     test.test_all(test_fun)
-

{memory_graph-0.2.0 → memory_graph-0.2.2}/memory_graph.egg-info/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: memory-graph
-Version: 0.2.0
-Summary: Draws a graph of your data to analyze the structure of its references.
+Version: 0.2.2
+Summary: Draws a graph of your data to analyze its structure.
 Home-page: https://github.com/bterwijn/memory_graph
 Author: Bas Terwijn
 Author-email: bterwijn@gmail.com
@@ -38,16 +38,16 @@ a = [4, 3, 2]
 b = a
 a.append(1) # changing 'a' changes 'b'
 
-# print the lists
+# print the 'a' and 'b' list
 print('a:', a)
 print('b:', b)
 
-# check if they share data
+# check if 'a' and 'b' share data
 print('ids:', id(a), id(b))
 print('identical?:', a is b)
 
-# show the lists in a graph
-memory_graph.show(locals()) 
+# show all local variables in a graph
+memory_graph.show( locals() )
 ```
 
 </td><td>
@@ -65,21 +65,26 @@ b: 4, 3, 2, 1
 ids: 126432214913216 126432214913216
 identical?: True
 ```
-A better way to understand what data is shared is to draw a graph of the data using this [memory_graph](https://pypi.org/project/memory-graph/) package.
+A better way to understand what data is shared is to draw a graph of the data using the [memory_graph](https://pypi.org/project/memory-graph/) package.
 
 # Memory Graph Packge #
-The [memory_graph](https://pypi.org/project/memory-graph/) package can show a graph with many different data types.
+The [memory_graph](https://pypi.org/project/memory-graph/) package can graph many different data types.
 
 ```python
 import memory_graph
 
-data = [ (1, 2), [3, 4], {5, 6}, {7:'seven', 8:'eight'} ]
+class MyClass:
+
+    def __init__(self, x, y):
+        self.x = x
+        self.y = y
+
+data = [ range(1, 2), (3, 4), {5, 6}, {7:'seven', 8:'eight'},  MyClass(9, 10) ]
 memory_graph.show(data, block=True)
 ```
-
 ![many_types.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/many_types.png)
 
-By using `block=True` the program blocks until the ENTER key is pressed so you can view the graph before continuing program execution (and possibly viewing later graphs). Instead of showing the graph you can also render it to an output file of our choosing (see [Graphviz Output Formats](https://graphviz.org/docs/outputs/)) using for example:
+By using `block=True` the program blocks until the ENTER key is pressed so you can view the graph before continuing program execution (and possibly viewing later graphs). Instead of showing the graph you can also render it to an output file of your choosing (see [Graphviz Output Formats](https://graphviz.org/docs/outputs/)) using for example:
 
 ```python
 memory_graph.render(data, "my_graph.pdf")
@@ -126,7 +131,7 @@ The [Python Data Model](https://docs.python.org/3/reference/datamodel.html) make
 In the code below variable `a` and `b` both reference the same `int` value 10. An `int` is an immutable type and therefore when we change variable `a` its value can **not** be mutated in place, and thus a copy is made and `a` and `b` reference a different value afterwards.
 ```python
 import memory_graph
-memory_graph.rewrite_to_node.reduce_reference_children.remove("int") # shows references to 'int'
+memory_graph.config.no_reference_types.pop(int, None) # show references to ints
 
 a = 10
 b = a
@@ -458,18 +463,18 @@ for i in range(n):
 ## 5. Configuration ##
 Different aspects of memory_graph can be configured. The default configuration is reset by importing 'memory_graph.config_default'.
 
+- ***memory_graph.config.max_number_nodes*** : int
+  - The maxium number of Nodes shown in the graph. When the graph gets too big set this to a smaller number. A `★` symbol indictes where the graph is cut short.
+
+- ***memory_graph.config.max_string_length*** : int
+  - The maximum length of strings shown in the graph. Longer strings will be truncated.
+
 - ***memory_graph.config.no_reference_types*** : dict
-  - Holds all types for which no seperate node it drawn but that are shown as elements in their parent Node. It maps each type to a function that determines how it is visualized.
+  - Holds all types for which no seperate node is drawn but that instead are shown as elements in their parent Node. It maps each type to a function that determines how it is visualized.
 
 - ***memory_graph.config.no_child_references_types*** : set
   - The set of key_value types that don't draw references to their direct childeren but have their children shown as elements of their node.
 
-- ***memory_graph.config.max_string_length*** : int
-  - The maximum length of strings shown in the graph.
-
-- ***memory_graph.config.max_number_nodes*** : int
-  - The maxium number of Nodes shows in the graph. When the graph gets to big set this to a small number to analyze the problem.
-
 - ***memory_graph.config.type_to_node*** : dict
   - Determines how a data types is converted to a Node (sub)class for visualization in the graph.
 
@@ -483,7 +488,7 @@ Different aspects of memory_graph can be configured. The default configuration i
   - Maps each type to a Slicer. A slicer determines how many elements of a data type are shown in the graph to prevent the graph from getting too big. 'Slicer()' does no slicing, 'Slicer(1,2,3)' shows just 1 element at the beginning, 2 in the middle, and 3 at the end.
 
 ### Temporary Configuration ###
-In addition to the global configuration, a temporary configuration can be set for a single `show()`, `render()`, or `d()` call to change the colors, orientation, and slicer. This example highlights a particular list element in red, gives it a horizontal orientattion, and overwrites the default slicer for lists:
+In addition to the global configuration, a temporary configuration can be set for a single `show()`, `render()`, or `d()` 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:
 
 ```python
 import memory_graph
@@ -501,7 +506,7 @@ memory_graph.show( locals(),
 ![highlight.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/highlight.png)
 
 ## 6. Extensions ##
-Different extension are available for types from Python packages. 
+Different extensions are available for types from other Python packages. 
 
 ### Numpy ###
 Numpy types `arrray` and `matrix` and `ndarray` can be graphed with the "memory_graph.extension_numpy" extension:

{memory_graph-0.2.0 → memory_graph-0.2.2}/memory_graph.egg-info/SOURCES.txt

@@ -18,6 +18,7 @@ memory_graph/config_default.py
 memory_graph/config_helpers.py
 memory_graph/extension_numpy.py
 memory_graph/extension_pandas.py
+memory_graph/special_types.py
 memory_graph/test.py
 memory_graph/test_memory_graph.py
 memory_graph/test_memory_visitor.py

{memory_graph-0.2.0 → memory_graph-0.2.2}/setup.py

@@ -7,8 +7,8 @@ long_description_from_readme = (this_directory / "README.md").read_text()
 
 setup(
     name = 'memory_graph',
-    version = '0.2.00',
-    description = 'Draws a graph of your data to analyze the structure of its references.',
+    version = '0.2.02',
+    description = 'Draws a graph of your data to analyze its structure.',
     long_description = long_description_from_readme,
     long_description_content_type = 'text/markdown',
     readme = 'README.md',