memory-graph 0.3.7__tar.gz → 0.3.8__tar.gz

{memory_graph-0.3.7/memory_graph.egg-info → memory_graph-0.3.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: memory_graph
-Version: 0.3.7
+Version: 0.3.8
 Summary: Draws a graph of your data to analyze its structure.
 Home-page: https://github.com/bterwijn/memory_graph
 Author: Bas Terwijn
@@ -68,7 +68,7 @@ identical?: True
 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 #
-The [memory_graph](https://pypi.org/project/memory-graph/) package can graph many different data types.
+The [memory_graph](https://pypi.org/project/memory-graph/) package can graph many different data types, not limited to:
 
 ```python
 import memory_graph as mg
@@ -88,6 +88,7 @@ Instead of showing the graph you can also render it to an output file of your ch
 
 ```python
 mg.render(data, "my_graph.pdf")
+mg.render(data, "my_graph.svg")
 mg.render(data, "my_graph.png")
 mg.render(data, "my_graph.gv") # Graphviz DOT file
 ```
@@ -106,6 +107,8 @@ mg.render(data, "my_graph.gv") # Graphviz DOT file
 
 [Extensions](#extensions)
 
+[Introspection](#introspection)
+
 [Jupyter Notebook](#jupyter-notebook)
 
 [Troubleshooting](#troubleshooting)
@@ -337,8 +340,8 @@ To simplify debugging without a debugger tool, we offer these blocking alias fun
 
 | alias | purpose | function call |
 |:---|:---|:---|
-| `mg.l()` | graph **l**ocal variables | `mg.block(mg.show, locals())` |
-| `mg.s()` | graph the call **s**tack | `mg.block(mg.show, mg.get_call_stack())` |
+| `mg.l()` | graph **l**ocal variables and block | `mg.block(mg.show, locals())` |
+| `mg.s()` | graph the call **s**tack and block | `mg.block(mg.show, mg.get_call_stack())` |
 
 For example, executing this program:
 
@@ -564,9 +567,151 @@ mg.show(locals())
 ```
 ![extension_pandas.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/extension_pandas.png)
 
+## Introspection ##
+This section is likely to change. Sometimes the introspection fails or is not as desired. For example the `bintrees.avltree.Node` object doesn't show any attributes in the graph below:
+
+```python
+import memory_graph as mg
+import bintrees
+
+# Create an AVL tree
+tree = bintrees.AVLTree()
+tree.insert(10, "ten")
+tree.insert(5, "five")
+tree.insert(20, "twenty")
+tree.insert(15, "fifteen")
+
+mg.show(locals())
+```
+![extension_numpy.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/avltree_fail.png)
+
+
+### dir() ###
+A usefull start is to give it some color, show the list of all its attributes using `dir()`, and setting an empty Slicer to see the attribute list in full.
+
+```python
+import memory_graph as mg
+import bintrees
+
+# Create an AVL tree
+tree = bintrees.AVLTree()
+tree.insert(10, "ten")
+tree.insert(5, "five")
+tree.insert(20, "twenty")
+tree.insert(15, "fifteen")
+
+mg.config.type_to_color[bintrees.avltree.Node] = "sandybrown"
+mg.config.type_to_node[bintrees.avltree.Node] = lambda data: mg.node_linear.Node_Linear(data, 
+                                                dir(data))
+mg.config.type_to_slicer[bintrees.avltree.Node] = mg.slicer.Slicer()
+
+mg.show(locals())
+```
+![extension_numpy.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/avltree_dir.png)
+
+Next figure out what are the attributes you want to graph and choose a Node type, there are four options.
+
+### 1 Node_Base ###
+Node_base is a leaf node (with no children) and shows just a single value.
+```python
+import memory_graph as mg
+import bintrees
+
+# Create an AVL tree
+tree = bintrees.AVLTree()
+tree.insert(10, "ten")
+tree.insert(5, "five")
+tree.insert(20, "twenty")
+tree.insert(15, "fifteen")
+
+mg.config.type_to_color[bintrees.avltree.Node] = "sandybrown"
+mg.config.type_to_node[bintrees.avltree.Node] = lambda data: mg.node_base.Node_Base(f"key:{data.key} value:{data.value}")
+
+mg.show(locals())
+```
+![extension_numpy.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/avltree_base.png)
+
+### 2 Node_Linear ###
+Node_Linear shows all the values in a line like a list.
+```python
+import memory_graph as mg
+import bintrees
+
+# Create an AVL tree
+tree = bintrees.AVLTree()
+tree.insert(10, "ten")
+tree.insert(5, "five")
+tree.insert(20, "twenty")
+tree.insert(15, "fifteen")
+
+mg.config.type_to_color[bintrees.avltree.Node] = "sandybrown"
+mg.config.type_to_node[bintrees.avltree.Node] = lambda data: mg.node_linear.Node_Linear(data,
+                                                ['left:', data.left,
+                                                 'key:', data.key,
+                                                 'value:', data.value,
+                                                 'right:', data.right] )
+
+mg.show(locals())
+```
+![extension_numpy.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/avltree_linear.png)
+
+### 3 Node_Key_Value ###
+Node_Key_Value shows key-value pairs like a dictionary. Note the required `items()` call at the end.
+```python
+import memory_graph as mg
+import bintrees
+
+# Create an AVL tree
+tree = bintrees.AVLTree()
+tree.insert(10, "ten")
+tree.insert(5, "five")
+tree.insert(20, "twenty")
+tree.insert(15, "fifteen")
+
+mg.config.type_to_color[bintrees.avltree.Node] = "sandybrown"
+mg.config.type_to_node[bintrees.avltree.Node] = lambda data: mg.node_key_value.Node_Key_Value(data,
+                                                {'left': data.left,
+                                                 'key': data.key,
+                                                 'value': data.value,
+                                                 'right': data.right}.items() )
+
+mg.show(locals())
+```
+![extension_numpy.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/avltree_key_value.png)
+
+### 4 Node_Table ###
+Node_Table shows all the values as a table.
+```python
+import memory_graph as mg
+import bintrees
+
+# Create an AVL tree
+tree = bintrees.AVLTree()
+tree.insert(10, "ten")
+tree.insert(5, "five")
+tree.insert(20, "twenty")
+tree.insert(15, "fifteen")
+
+mg.config.type_to_color[bintrees.avltree.Node] = "sandybrown"
+mg.config.type_to_node[bintrees.avltree.Node] = lambda data: mg.node_table.Node_Table(data,
+                                                [[data.key, data.value],
+                                                 [data.left, data.right]] )
+
+
+mg.show(locals())
+```
+![extension_numpy.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/avltree_table.png)
+
+
 ## Jupyter Notebook ##
+In Jupyter Notebook `locals()` has additional variables that cause problems in the graph, use `mg.locals_jupyter()` to get the local variables with these problematic variables filtered out. Use `mg.get_call_stack_jupyter()` to get the whole call stack with these variables filtered out.
 
-In Jupyter Notebook `locals()` has additional variables that cause problems in the graph, use `mg.locals_jupyter()` to get the local variables with these problematic variables filtered out. Use `mg.get_call_stack_jupyter()` to get the whole call stack with these variables filtered out. 
+We can use `mg.show()` and `mg.render()` in a Jupyter Notebook, but alternatively we can also use `mg.create_graph()` to create a graph and the `display()` function to render it inline with for example:
+
+```python
+display( mg.create_graph(mg.locals_jupyter()) ) # display the local variables inline
+mg.block(display, mg.create_graph(mg.locals_jupyter()) ) # the same but blocked
+```
 
 See for example [jupyter_example.ipynb](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/jupyter_example.ipynb).
 ![jupyter_example.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/jupyter_example.png)

{memory_graph-0.3.7 → memory_graph-0.3.8}/README.md

@@ -49,7 +49,7 @@ identical?: True
 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 #
-The [memory_graph](https://pypi.org/project/memory-graph/) package can graph many different data types.
+The [memory_graph](https://pypi.org/project/memory-graph/) package can graph many different data types, not limited to:
 
 ```python
 import memory_graph as mg
@@ -69,6 +69,7 @@ Instead of showing the graph you can also render it to an output file of your ch
 
 ```python
 mg.render(data, "my_graph.pdf")
+mg.render(data, "my_graph.svg")
 mg.render(data, "my_graph.png")
 mg.render(data, "my_graph.gv") # Graphviz DOT file
 ```
@@ -87,6 +88,8 @@ mg.render(data, "my_graph.gv") # Graphviz DOT file
 
 [Extensions](#extensions)
 
+[Introspection](#introspection)
+
 [Jupyter Notebook](#jupyter-notebook)
 
 [Troubleshooting](#troubleshooting)
@@ -318,8 +321,8 @@ To simplify debugging without a debugger tool, we offer these blocking alias fun
 
 | alias | purpose | function call |
 |:---|:---|:---|
-| `mg.l()` | graph **l**ocal variables | `mg.block(mg.show, locals())` |
-| `mg.s()` | graph the call **s**tack | `mg.block(mg.show, mg.get_call_stack())` |
+| `mg.l()` | graph **l**ocal variables and block | `mg.block(mg.show, locals())` |
+| `mg.s()` | graph the call **s**tack and block | `mg.block(mg.show, mg.get_call_stack())` |
 
 For example, executing this program:
 
@@ -545,9 +548,151 @@ mg.show(locals())
 ```
 ![extension_pandas.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/extension_pandas.png)
 
+## Introspection ##
+This section is likely to change. Sometimes the introspection fails or is not as desired. For example the `bintrees.avltree.Node` object doesn't show any attributes in the graph below:
+
+```python
+import memory_graph as mg
+import bintrees
+
+# Create an AVL tree
+tree = bintrees.AVLTree()
+tree.insert(10, "ten")
+tree.insert(5, "five")
+tree.insert(20, "twenty")
+tree.insert(15, "fifteen")
+
+mg.show(locals())
+```
+![extension_numpy.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/avltree_fail.png)
+
+
+### dir() ###
+A usefull start is to give it some color, show the list of all its attributes using `dir()`, and setting an empty Slicer to see the attribute list in full.
+
+```python
+import memory_graph as mg
+import bintrees
+
+# Create an AVL tree
+tree = bintrees.AVLTree()
+tree.insert(10, "ten")
+tree.insert(5, "five")
+tree.insert(20, "twenty")
+tree.insert(15, "fifteen")
+
+mg.config.type_to_color[bintrees.avltree.Node] = "sandybrown"
+mg.config.type_to_node[bintrees.avltree.Node] = lambda data: mg.node_linear.Node_Linear(data, 
+                                                dir(data))
+mg.config.type_to_slicer[bintrees.avltree.Node] = mg.slicer.Slicer()
+
+mg.show(locals())
+```
+![extension_numpy.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/avltree_dir.png)
+
+Next figure out what are the attributes you want to graph and choose a Node type, there are four options.
+
+### 1 Node_Base ###
+Node_base is a leaf node (with no children) and shows just a single value.
+```python
+import memory_graph as mg
+import bintrees
+
+# Create an AVL tree
+tree = bintrees.AVLTree()
+tree.insert(10, "ten")
+tree.insert(5, "five")
+tree.insert(20, "twenty")
+tree.insert(15, "fifteen")
+
+mg.config.type_to_color[bintrees.avltree.Node] = "sandybrown"
+mg.config.type_to_node[bintrees.avltree.Node] = lambda data: mg.node_base.Node_Base(f"key:{data.key} value:{data.value}")
+
+mg.show(locals())
+```
+![extension_numpy.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/avltree_base.png)
+
+### 2 Node_Linear ###
+Node_Linear shows all the values in a line like a list.
+```python
+import memory_graph as mg
+import bintrees
+
+# Create an AVL tree
+tree = bintrees.AVLTree()
+tree.insert(10, "ten")
+tree.insert(5, "five")
+tree.insert(20, "twenty")
+tree.insert(15, "fifteen")
+
+mg.config.type_to_color[bintrees.avltree.Node] = "sandybrown"
+mg.config.type_to_node[bintrees.avltree.Node] = lambda data: mg.node_linear.Node_Linear(data,
+                                                ['left:', data.left,
+                                                 'key:', data.key,
+                                                 'value:', data.value,
+                                                 'right:', data.right] )
+
+mg.show(locals())
+```
+![extension_numpy.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/avltree_linear.png)
+
+### 3 Node_Key_Value ###
+Node_Key_Value shows key-value pairs like a dictionary. Note the required `items()` call at the end.
+```python
+import memory_graph as mg
+import bintrees
+
+# Create an AVL tree
+tree = bintrees.AVLTree()
+tree.insert(10, "ten")
+tree.insert(5, "five")
+tree.insert(20, "twenty")
+tree.insert(15, "fifteen")
+
+mg.config.type_to_color[bintrees.avltree.Node] = "sandybrown"
+mg.config.type_to_node[bintrees.avltree.Node] = lambda data: mg.node_key_value.Node_Key_Value(data,
+                                                {'left': data.left,
+                                                 'key': data.key,
+                                                 'value': data.value,
+                                                 'right': data.right}.items() )
+
+mg.show(locals())
+```
+![extension_numpy.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/avltree_key_value.png)
+
+### 4 Node_Table ###
+Node_Table shows all the values as a table.
+```python
+import memory_graph as mg
+import bintrees
+
+# Create an AVL tree
+tree = bintrees.AVLTree()
+tree.insert(10, "ten")
+tree.insert(5, "five")
+tree.insert(20, "twenty")
+tree.insert(15, "fifteen")
+
+mg.config.type_to_color[bintrees.avltree.Node] = "sandybrown"
+mg.config.type_to_node[bintrees.avltree.Node] = lambda data: mg.node_table.Node_Table(data,
+                                                [[data.key, data.value],
+                                                 [data.left, data.right]] )
+
+
+mg.show(locals())
+```
+![extension_numpy.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/avltree_table.png)
+
+
 ## Jupyter Notebook ##
+In Jupyter Notebook `locals()` has additional variables that cause problems in the graph, use `mg.locals_jupyter()` to get the local variables with these problematic variables filtered out. Use `mg.get_call_stack_jupyter()` to get the whole call stack with these variables filtered out.
 
-In Jupyter Notebook `locals()` has additional variables that cause problems in the graph, use `mg.locals_jupyter()` to get the local variables with these problematic variables filtered out. Use `mg.get_call_stack_jupyter()` to get the whole call stack with these variables filtered out. 
+We can use `mg.show()` and `mg.render()` in a Jupyter Notebook, but alternatively we can also use `mg.create_graph()` to create a graph and the `display()` function to render it inline with for example:
+
+```python
+display( mg.create_graph(mg.locals_jupyter()) ) # display the local variables inline
+mg.block(display, mg.create_graph(mg.locals_jupyter()) ) # the same but blocked
+```
 
 See for example [jupyter_example.ipynb](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/jupyter_example.ipynb).
 ![jupyter_example.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/jupyter_example.png)

memory_graph-0.3.8/TODO.txt

@@ -0,0 +1,9 @@
+
+mg.block(fun, print_loc=True), update docs, stack-overflow posts
+
+Jupyter Notebook inline render using display()
+
+webassembly inline render
+
+optional max introspect depth for each type/id
+https://discuss.python.org/t/request-for-feedback-memory-graph-a-python-visualization-tool-for-education/78347