memory-graph 0.3.82__tar.gz → 0.3.83__tar.gz

{memory_graph-0.3.82 → memory_graph-0.3.83}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: memory_graph
-Version: 0.3.82
+Version: 0.3.83
 Summary: Teaching tool and debugging aid in context of references, mutable data types, and shallow and deep copy.
 Author-email: Bas Terwijn <bterwijn@gmail.com>
 License-Expression: BSD-2-Clause
@@ -366,7 +366,7 @@ a:[4, 3, 2, 1] b:(4, 3, 2) c:[4, 3, 2]
 ```
 This is because `b` is of immutable type 'tuple' so its value gets copied automatically when it is changed. And because the function is called with a copy of `c`, its original value is not changed by the function. The value of variable `a` is the only value of mutable type that is shared between the root stack frame **'0: \<module>'** and the **'1: add_one'** stack frame of the function call so only that variable is affected as a result of calling the function. The other changes remain confined to the local variables of the ```add_one()``` function.
 
-## Function Call That Changes 'int' Value ##
+## Function Call Changes 'int' Value ##
 Even though `int` is an immutable type, so an `int` value can not be changed by directly passing it to a function, we can still change it by wrapping it in a mutable container.
 
 ```python
@@ -767,7 +767,58 @@ A sliding puzzle solver as a challenging example showing how memory_graph deals
 
 # Control Flow #
 
-Some examples where we focus on the flow of control of Python code.
+Some examples where we focus on the flow of control and access to state in Python code.
+
+## Different Methods ##
+
+This example shows the difference between 'instance', 'class' and 'static' methods:
+
+```python
+class My_Class:
+
+    # class variables:
+    count = 0
+    unique_value = 0
+
+    def __init__(self):
+        print("__init__ called, initialize instance variables of object")
+        self.my_instance_variable = []  # create instance variable
+        My_Class.count += 1  # also change class variable
+
+    def my_instance_method(self):
+        print("my_instance_method called, access to instance variables via 'self'")
+        self.my_instance_variable.append(My_Class.unique_value)
+        My_Class.unique_value += 1  # also change class variable
+
+    @classmethod
+    def my_class_method(cls):
+        print("my_class_method called, access to class variables via 'cls', no instance variables")
+        print(f"{cls.count=}")
+
+    @staticmethod
+    def my_static_method():
+        print("my_static_method called, no 'self' or 'cls'")
+        print(f"{My_Class.count=}")  # but still access to class variables
+
+obj1 = My_Class()
+obj2 = My_Class()
+
+obj1.my_instance_method()
+obj1.my_class_method()
+obj1.my_static_method()
+
+for _ in range(2):
+    obj1.my_instance_method()
+    obj2.my_instance_method()
+
+print(f"{obj1.count=}")     # reading class variable if no instance variable found
+obj1.count = 100            # creating instance variable
+print(f"{obj1.count=}")     # now finding and reading instance variable
+print(f"{My_Class.count}")  # class variable still available via class name
+print(f"{obj2.count=}")     # obj2 still reads the class variable
+```
+
+Run it in the [Memory Graph Web Debugger](https://memory-graph.com/#codeurl=https://raw.githubusercontent.com/bterwijn/memory_graph/refs/heads/main/src/different_methods.py&play).
 
 ## Inheritance ##
 
@@ -1048,6 +1099,9 @@ Different aspects of memory_graph can be configured. The default configuration c
 
 ## Functions ##
 
+- **mg.layout(horizontal: bool = None)**
+  - Set graph layout to 'True' for horizontal, 'False' for vertical, or 'None' to toggle.
+
 - **mg.dark_mode(b: bool = None)**
   - Set dark mode to 'True' or 'False', or 'None' to toggle.
 
@@ -1301,6 +1355,8 @@ mg.show(locals())
 ```
 ![html_str_example.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/html_str_example.png)
 
+### Images
+
 Including the `<IMG>` tag that allows for showing local image files only, but that currently doesn't work in the Memory Graph Web Debugger, that uses 'Viz.js' for graph rendering, unfortunately.
 
 ```python

{memory_graph-0.3.82 → memory_graph-0.3.83}/README.md

@@ -346,7 +346,7 @@ a:[4, 3, 2, 1] b:(4, 3, 2) c:[4, 3, 2]
 ```
 This is because `b` is of immutable type 'tuple' so its value gets copied automatically when it is changed. And because the function is called with a copy of `c`, its original value is not changed by the function. The value of variable `a` is the only value of mutable type that is shared between the root stack frame **'0: \<module>'** and the **'1: add_one'** stack frame of the function call so only that variable is affected as a result of calling the function. The other changes remain confined to the local variables of the ```add_one()``` function.
 
-## Function Call That Changes 'int' Value ##
+## Function Call Changes 'int' Value ##
 Even though `int` is an immutable type, so an `int` value can not be changed by directly passing it to a function, we can still change it by wrapping it in a mutable container.
 
 ```python
@@ -747,7 +747,58 @@ A sliding puzzle solver as a challenging example showing how memory_graph deals
 
 # Control Flow #
 
-Some examples where we focus on the flow of control of Python code.
+Some examples where we focus on the flow of control and access to state in Python code.
+
+## Different Methods ##
+
+This example shows the difference between 'instance', 'class' and 'static' methods:
+
+```python
+class My_Class:
+
+    # class variables:
+    count = 0
+    unique_value = 0
+
+    def __init__(self):
+        print("__init__ called, initialize instance variables of object")
+        self.my_instance_variable = []  # create instance variable
+        My_Class.count += 1  # also change class variable
+
+    def my_instance_method(self):
+        print("my_instance_method called, access to instance variables via 'self'")
+        self.my_instance_variable.append(My_Class.unique_value)
+        My_Class.unique_value += 1  # also change class variable
+
+    @classmethod
+    def my_class_method(cls):
+        print("my_class_method called, access to class variables via 'cls', no instance variables")
+        print(f"{cls.count=}")
+
+    @staticmethod
+    def my_static_method():
+        print("my_static_method called, no 'self' or 'cls'")
+        print(f"{My_Class.count=}")  # but still access to class variables
+
+obj1 = My_Class()
+obj2 = My_Class()
+
+obj1.my_instance_method()
+obj1.my_class_method()
+obj1.my_static_method()
+
+for _ in range(2):
+    obj1.my_instance_method()
+    obj2.my_instance_method()
+
+print(f"{obj1.count=}")     # reading class variable if no instance variable found
+obj1.count = 100            # creating instance variable
+print(f"{obj1.count=}")     # now finding and reading instance variable
+print(f"{My_Class.count}")  # class variable still available via class name
+print(f"{obj2.count=}")     # obj2 still reads the class variable
+```
+
+Run it in the [Memory Graph Web Debugger](https://memory-graph.com/#codeurl=https://raw.githubusercontent.com/bterwijn/memory_graph/refs/heads/main/src/different_methods.py&play).
 
 ## Inheritance ##
 
@@ -1028,6 +1079,9 @@ Different aspects of memory_graph can be configured. The default configuration c
 
 ## Functions ##
 
+- **mg.layout(horizontal: bool = None)**
+  - Set graph layout to 'True' for horizontal, 'False' for vertical, or 'None' to toggle.
+
 - **mg.dark_mode(b: bool = None)**
   - Set dark mode to 'True' or 'False', or 'None' to toggle.
 
@@ -1281,6 +1335,8 @@ mg.show(locals())
 ```
 ![html_str_example.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/html_str_example.png)
 
+### Images
+
 Including the `<IMG>` tag that allows for showing local image files only, but that currently doesn't work in the Memory Graph Web Debugger, that uses 'Viz.js' for graph rendering, unfortunately.
 
 ```python

{memory_graph-0.3.82 → memory_graph-0.3.83}/memory_graph/__init__.py

@@ -2,7 +2,7 @@
 # Copyright (c) 2023, Bas Terwijn.
 # SPDX-License-Identifier: BSD-2-Clause
 
-__version__ = "0.3.82"
+__version__ = "0.3.83"
 __author__ = 'Bas Terwijn'
 
 import memory_graph.memory_to_nodes as memory_to_nodes
@@ -26,7 +26,7 @@ if not hasattr(builtins, "mg"):
     builtins.mg = mg
 
 # re-exports for shorter names
-from .config_default  import dark_mode, transparent_background, set_colors
+from .config_default  import layout, dark_mode, transparent_background, set_colors
 from .slicer          import Slicer
 from .node_leaf       import Node_Leaf
 from .node_linear     import Node_Linear

{memory_graph-0.3.82 → memory_graph-0.3.83}/memory_graph/config.py

@@ -29,6 +29,7 @@ type_to_string = { }
 
 type_to_node = { }
 
+horizontal = False
 color_mode_dark = False
 transparent_background = False
 foreground_color = None

{memory_graph-0.3.82 → memory_graph-0.3.83}/memory_graph/config_default.py

@@ -109,6 +109,12 @@ def dark_mode(dark = None):
         config.color_mode_dark = dark
     set_colors(config.color_mode_dark, config.transparent_background)
 
+def layout(horizontal = None):
+    if horizontal is None:
+        config.horizontal = not config.horizontal
+    else:
+        config.horizontal = horizontal
+
 def reset():
 
     set_colors(config.color_mode_dark, config.transparent_background)

{memory_graph-0.3.82 → memory_graph-0.3.83}/memory_graph/memory_to_nodes.py

@@ -268,5 +268,6 @@ def memory_to_nodes(data):
                                     graph_attr=graphviz_graph_attr,
                                     node_attr=graphviz_node_attr,
                                     edge_attr=graphviz_edge_attr)
+    graphviz_graph.attr(rankdir= "LR" if config.horizontal else "TB")
     build_graph(graphviz_graph, nodes, root_id, id_to_slices)
     return graphviz_graph

{memory_graph-0.3.82 → memory_graph-0.3.83}/memory_graph/node_key_value.py

@@ -58,6 +58,8 @@ class Node_Key_Value(Node_Base):
         if slices is None:
             return
         vertical = self.is_vertical(nodes, slices, id_to_slices)
+        if config.horizontal:
+            vertical = not vertical
         if vertical:
             self.fill_html_table_vertical(html_table, nodes, slices, id_to_slices)
         else:

{memory_graph-0.3.82 → memory_graph-0.3.83}/memory_graph/node_linear.py

@@ -49,7 +49,10 @@ class Node_Linear(Node_Base):
         """
         if slices is None:
             return
-        if self.is_vertical(nodes, slices, id_to_slices):
+        vertical = self.is_vertical(nodes, slices, id_to_slices)
+        if config.horizontal:
+            vertical = not vertical  # flip orientation if horizontal layout is set
+        if vertical:
             self.fill_html_table_vertical(html_table, nodes, slices, id_to_slices)
         else:
             self.fill_html_table_horizontal(html_table, nodes, slices, id_to_slices)

{memory_graph-0.3.82 → memory_graph-0.3.83}/memory_graph.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: memory_graph
-Version: 0.3.82
+Version: 0.3.83
 Summary: Teaching tool and debugging aid in context of references, mutable data types, and shallow and deep copy.
 Author-email: Bas Terwijn <bterwijn@gmail.com>
 License-Expression: BSD-2-Clause
@@ -366,7 +366,7 @@ a:[4, 3, 2, 1] b:(4, 3, 2) c:[4, 3, 2]
 ```
 This is because `b` is of immutable type 'tuple' so its value gets copied automatically when it is changed. And because the function is called with a copy of `c`, its original value is not changed by the function. The value of variable `a` is the only value of mutable type that is shared between the root stack frame **'0: \<module>'** and the **'1: add_one'** stack frame of the function call so only that variable is affected as a result of calling the function. The other changes remain confined to the local variables of the ```add_one()``` function.
 
-## Function Call That Changes 'int' Value ##
+## Function Call Changes 'int' Value ##
 Even though `int` is an immutable type, so an `int` value can not be changed by directly passing it to a function, we can still change it by wrapping it in a mutable container.
 
 ```python
@@ -767,7 +767,58 @@ A sliding puzzle solver as a challenging example showing how memory_graph deals
 
 # Control Flow #
 
-Some examples where we focus on the flow of control of Python code.
+Some examples where we focus on the flow of control and access to state in Python code.
+
+## Different Methods ##
+
+This example shows the difference between 'instance', 'class' and 'static' methods:
+
+```python
+class My_Class:
+
+    # class variables:
+    count = 0
+    unique_value = 0
+
+    def __init__(self):
+        print("__init__ called, initialize instance variables of object")
+        self.my_instance_variable = []  # create instance variable
+        My_Class.count += 1  # also change class variable
+
+    def my_instance_method(self):
+        print("my_instance_method called, access to instance variables via 'self'")
+        self.my_instance_variable.append(My_Class.unique_value)
+        My_Class.unique_value += 1  # also change class variable
+
+    @classmethod
+    def my_class_method(cls):
+        print("my_class_method called, access to class variables via 'cls', no instance variables")
+        print(f"{cls.count=}")
+
+    @staticmethod
+    def my_static_method():
+        print("my_static_method called, no 'self' or 'cls'")
+        print(f"{My_Class.count=}")  # but still access to class variables
+
+obj1 = My_Class()
+obj2 = My_Class()
+
+obj1.my_instance_method()
+obj1.my_class_method()
+obj1.my_static_method()
+
+for _ in range(2):
+    obj1.my_instance_method()
+    obj2.my_instance_method()
+
+print(f"{obj1.count=}")     # reading class variable if no instance variable found
+obj1.count = 100            # creating instance variable
+print(f"{obj1.count=}")     # now finding and reading instance variable
+print(f"{My_Class.count}")  # class variable still available via class name
+print(f"{obj2.count=}")     # obj2 still reads the class variable
+```
+
+Run it in the [Memory Graph Web Debugger](https://memory-graph.com/#codeurl=https://raw.githubusercontent.com/bterwijn/memory_graph/refs/heads/main/src/different_methods.py&play).
 
 ## Inheritance ##
 
@@ -1048,6 +1099,9 @@ Different aspects of memory_graph can be configured. The default configuration c
 
 ## Functions ##
 
+- **mg.layout(horizontal: bool = None)**
+  - Set graph layout to 'True' for horizontal, 'False' for vertical, or 'None' to toggle.
+
 - **mg.dark_mode(b: bool = None)**
   - Set dark mode to 'True' or 'False', or 'None' to toggle.
 
@@ -1301,6 +1355,8 @@ mg.show(locals())
 ```
 ![html_str_example.png](https://raw.githubusercontent.com/bterwijn/memory_graph/main/images/html_str_example.png)
 
+### Images
+
 Including the `<IMG>` tag that allows for showing local image files only, but that currently doesn't work in the Memory Graph Web Debugger, that uses 'Viz.js' for graph rendering, unfortunately.
 
 ```python

{memory_graph-0.3.82 → memory_graph-0.3.83}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "memory_graph"
-version = "0.3.82"
+version = "0.3.83"
 description = "Teaching tool and debugging aid in context of references, mutable data types, and shallow and deep copy."
 authors = [
     {name = "Bas Terwijn", email = "bterwijn@gmail.com"}