Merge pull request #25 from wwxiao09/Feature/update-dalpy-to-string-22

ChamiLamelas · web-flow · commit 6320095316e0 · 2022-04-08T11:58:48.000-04:00
Feature/update dalpy to string 22
diff --git a/docs/arrays.html b/docs/arrays.html
@@ -3,7 +3,7 @@
 <head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.9.2" />
+<meta name="generator" content="pdoc 0.10.0" />
 <title>dalpy.arrays API documentation</title>
 <meta name="description" content="Module that holds classes and functions related to 1 and 2 dimensional arrays …" />
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
@@ -225,7 +225,7 @@ <h4><code><a title="dalpy.arrays.Array2D" href="#dalpy.arrays.Array2D">Array2D</
 </nav>
 </main>
 <footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
 </html>
diff --git a/docs/factory_utils.html b/docs/factory_utils.html
@@ -3,7 +3,7 @@
 <head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.9.2" />
+<meta name="generator" content="pdoc 0.10.0" />
 <title>dalpy.factory_utils API documentation</title>
 <meta name="description" content="This module provides factory functions for creating and modifying DALPy objects …" />
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
@@ -121,7 +121,7 @@ <h1>Index</h1>
 </nav>
 </main>
 <footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
 </html>
diff --git a/docs/graphs.html b/docs/graphs.html
@@ -3,7 +3,7 @@
 <head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.9.2" />
+<meta name="generator" content="pdoc 0.10.0" />
 <title>dalpy.graphs API documentation</title>
 <meta name="description" content="This module holds classes related to graphs …" />
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
@@ -344,7 +344,7 @@ <h4><code><a title="dalpy.graphs.VertexAttributeError" href="#dalpy.graphs.Verte
 </nav>
 </main>
 <footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
 </html>
diff --git a/docs/hashing.html b/docs/hashing.html
@@ -3,7 +3,7 @@
 <head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.9.2" />
+<meta name="generator" content="pdoc 0.10.0" />
 <title>dalpy.hashing API documentation</title>
 <meta name="description" content="Module that holds classes related to hashing …" />
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
@@ -185,7 +185,7 @@ <h4><code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">Has
 </nav>
 </main>
 <footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
 </html>
diff --git a/docs/heaps.html b/docs/heaps.html
@@ -3,7 +3,7 @@
 <head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.9.2" />
+<meta name="generator" content="pdoc 0.10.0" />
 <title>dalpy.heaps API documentation</title>
 <meta name="description" content="This module holds classes and functions related to heaps and priority queues …" />
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
@@ -235,7 +235,7 @@ <h4><code><a title="dalpy.heaps.PriorityQueueUnderflowError" href="#dalpy.heaps.
 </nav>
 </main>
 <footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
 </html>
diff --git a/docs/index.html b/docs/index.html
@@ -3,7 +3,7 @@
 <head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.9.2" />
+<meta name="generator" content="pdoc 0.10.0" />
 <title>dalpy API documentation</title>
 <meta name="description" content="DALPy is a Python package for learning data structures and algorithms. It is based off of *Introduction to Algorithms*
 by Thomas H. Cormen, Charles E …" />
@@ -220,7 +220,7 @@ <h1>Index</h1>
 </nav>
 </main>
 <footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
 </html>
diff --git a/docs/linked_lists.html b/docs/linked_lists.html
@@ -3,7 +3,7 @@
 <head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.9.2" />
+<meta name="generator" content="pdoc 0.10.0" />
 <title>dalpy.linked_lists API documentation</title>
 <meta name="description" content="Module that holds classes related to linked lists …" />
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
@@ -126,7 +126,7 @@ <h4><code><a title="dalpy.linked_lists.SinglyLinkedListNode" href="#dalpy.linked
 </nav>
 </main>
 <footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
 </html>
diff --git a/docs/misc_utils.html b/docs/misc_utils.html
@@ -3,7 +3,7 @@
 <head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.9.2" />
+<meta name="generator" content="pdoc 0.10.0" />
 <title>dalpy.misc_utils API documentation</title>
 <meta name="description" content="This module provides miscellaneous utility functions and constants …" />
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
@@ -88,7 +88,7 @@ <h1>Index</h1>
 </nav>
 </main>
 <footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
 </html>
diff --git a/docs/queues.html b/docs/queues.html
@@ -3,7 +3,7 @@
 <head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.9.2" />
+<meta name="generator" content="pdoc 0.10.0" />
 <title>dalpy.queues API documentation</title>
 <meta name="description" content="This module holds classes related to FIFO queues …" />
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
@@ -176,7 +176,7 @@ <h4><code><a title="dalpy.queues.QueueUnderflowError" href="#dalpy.queues.QueueU
 </nav>
 </main>
 <footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
 </html>
diff --git a/docs/sets.html b/docs/sets.html
@@ -3,7 +3,7 @@
 <head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.9.2" />
+<meta name="generator" content="pdoc 0.10.0" />
 <title>dalpy.sets API documentation</title>
 <meta name="description" content="Module that holds classes related to sets …" />
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
@@ -171,7 +171,7 @@ <h4><code><a title="dalpy.sets.Set" href="#dalpy.sets.Set">Set</a></code></h4>
 </nav>
 </main>
 <footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
 </html>
diff --git a/docs/stacks.html b/docs/stacks.html
@@ -3,7 +3,7 @@
 <head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.9.2" />
+<meta name="generator" content="pdoc 0.10.0" />
 <title>dalpy.stacks API documentation</title>
 <meta name="description" content="This module holds classes related to LIFO stacks …" />
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
@@ -176,7 +176,7 @@ <h4><code><a title="dalpy.stacks.StackUnderflowError" href="#dalpy.stacks.StackU
 </nav>
 </main>
 <footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
 </html>
diff --git a/docs/test_utils.html b/docs/test_utils.html
@@ -3,7 +3,7 @@
 <head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.9.2" />
+<meta name="generator" content="pdoc 0.10.0" />
 <title>dalpy.test_utils API documentation</title>
 <meta name="description" content="This module provides utilities related to unit testing …" />
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
@@ -139,6 +139,9 @@ <h2 id="returns">Returns</h2>
 <code><a title="dalpy.queues.Queue" href="queues.html#dalpy.queues.Queue">Queue</a></code>, <code><a title="dalpy.stacks.Stack" href="stacks.html#dalpy.stacks.Stack">Stack</a></code>, <code><a title="dalpy.sets.Set" href="sets.html#dalpy.sets.Set">Set</a></code>,
 <code><a title="dalpy.linked_lists.SinglyLinkedListNode" href="linked_lists.html#dalpy.linked_lists.SinglyLinkedListNode">SinglyLinkedListNode</a></code>, <code><a title="dalpy.trees.BinaryTreeNode" href="trees.html#dalpy.trees.BinaryTreeNode">BinaryTreeNode</a></code>, <code><a title="dalpy.trees.NaryTreeNode" href="trees.html#dalpy.trees.NaryTreeNode">NaryTreeNode</a></code>,
 <code><a title="dalpy.graphs.Vertex" href="graphs.html#dalpy.graphs.Vertex">Vertex</a></code>, and <code><a title="dalpy.graphs.Graph" href="graphs.html#dalpy.graphs.Graph">Graph</a></code>.</p>
+<p>Calling dalpy_to_string on <code><a title="dalpy.trees.BinaryTreeNode" href="trees.html#dalpy.trees.BinaryTreeNode">BinaryTreeNode</a></code> or <code><a title="dalpy.trees.NaryTreeNode" href="trees.html#dalpy.trees.NaryTreeNode">NaryTreeNode</a></code> displays the entire
+tree rooted at that node prepended with <code>"BinaryTree"</code> and <code>"NaryTree"</code> respectively.
+This is done to clarify the nodes themselves are not holding the data listed after it.</p>
 <h2 id="returns">Returns</h2>
 <p>string representation of <code>obj</code>.</p>
 <h2 id="args">Args</h2>
@@ -290,7 +293,7 @@ <h4><code><a title="dalpy.test_utils.UnexpectedReturnWarning" href="#dalpy.test_
 </nav>
 </main>
 <footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
 </html>
diff --git a/docs/trees.html b/docs/trees.html
@@ -3,7 +3,7 @@
 <head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.9.2" />
+<meta name="generator" content="pdoc 0.10.0" />
 <title>dalpy.trees API documentation</title>
 <meta name="description" content="Module that holds classes and functions related to trees …" />
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
@@ -173,7 +173,7 @@ <h4><code><a title="dalpy.trees.NaryTreeNode" href="#dalpy.trees.NaryTreeNode">N
 </nav>
 </main>
 <footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
 </html>
diff --git a/src/dalpy/test_utils.py b/src/dalpy/test_utils.py
@@ -285,6 +285,10 @@ def dalpy_to_string(obj):
     `dalpy.linked_lists.SinglyLinkedListNode`, `dalpy.trees.BinaryTreeNode`, `dalpy.trees.NaryTreeNode`,
     `dalpy.graphs.Vertex`, and `dalpy.graphs.Graph`.
 
+    Calling dalpy_to_string on `dalpy.trees.BinaryTreeNode` or `dalpy.trees.NaryTreeNode` displays the entire 
+    tree rooted at that node prepended with `"BinaryTree"` and `"NaryTree"` respectively. 
+    This is done to clarify the nodes themselves are not holding the data listed after it.
+
     Returns:
         string representation of `obj`.
 
@@ -294,21 +298,21 @@ def dalpy_to_string(obj):
     if isinstance(obj, list):
         return "[" + ", ".join(dalpy_to_string(elem) for elem in obj) + "]"
     if isinstance(obj, Array):
-        return __array_to_string(obj)
+        return "Array" + __array_to_string(obj)
     if isinstance(obj, Array2D):
-        return __array2d_to_string(obj)
+        return "Array2D" + __array2d_to_string(obj)
     if isinstance(obj, Queue):
-        return __queue_to_string(obj)
+        return "Queue" + __queue_to_string(obj)
     if isinstance(obj, Stack):
-        return __stack_to_string(obj)
+        return "Stack" + __stack_to_string(obj)
     if isinstance(obj, Set):
-        return __set_to_string(obj)
+        return "Set" + __set_to_string(obj)
     if isinstance(obj, SinglyLinkedListNode):
         return __singly_linked_list_to_string(obj)
     if isinstance(obj, BinaryTreeNode):
-        return __binary_tree_to_string(obj)
+        return "BinaryTree" + __binary_tree_to_string(obj)
     if isinstance(obj, NaryTreeNode):
-        return __nary_tree_to_string(obj)
+        return "NaryTree" + __nary_tree_to_string(obj)
     if isinstance(obj, Vertex):
         return __vertex_to_string(obj)
     if isinstance(obj, Graph):
diff --git a/tests/test_utils_test.py b/tests/test_utils_test.py
@@ -1,7 +1,11 @@
 import unittest
 import warnings
 import math
-from dalpy.arrays import Array
+from dalpy.arrays import Array, Array2D
+from dalpy.queues import Queue
+from dalpy.stacks import Stack
+from dalpy.sets import Set
+from dalpy.linked_lists import SinglyLinkedListNode
 from dalpy.graphs import Graph, Vertex
 from dalpy.test_utils import dalpy_equals, dalpy_to_string, generic_test, build_and_run_watched_suite, UnexpectedReturnWarning
 from dalpy.factory_utils import make_array
@@ -83,7 +87,7 @@ def fnc_that_modifies_second(x, y):
         try:
             generic_test([a,b], c, fnc_that_modifies_second, enforce_no_mod=[False, True])
         except AssertionError as e:
-            assert "[[1, 4], [1, 3]]" in e.args[0], e.args[0]
+            assert "[Array[1, 4], Array[1, 3]]" in e.args[0], e.args[0]
             assert "2nd" in e.args[0], e.args[0]
     
     def test_multiple_larger(self):
@@ -157,13 +161,44 @@ class DALPyToStringTest(unittest.TestCase):
 
     def test_BTN(self):
         t = BinaryTreeNode(10)
-        expected = f'[{t.data}]'
-        self.assertEqual(dalpy_to_string(t), f'[{t.data}]')
+        expected = f'BinaryTree[{t.data}]'
+        self.assertEqual(dalpy_to_string(t), expected)
 
     def test_NTN(self):
         t = NaryTreeNode(10)
-        expected = f'[{t.data}]'
-        self.assertEqual(dalpy_to_string(t), f'[{t.data}]')
+        expected = f'NaryTree[{t.data}]'
+        self.assertEqual(dalpy_to_string(t), expected)
+
+    def test_Array(self):
+        a = Array(1)
+        a[0] = 1
+        expected = f'Array[1]'
+        self.assertEqual(dalpy_to_string(a), expected)
+
+    def test_Array2D(self):
+        a = Array2D(1,1)
+        a[0,0] = 1
+        expected = f'Array2D[[1]]'
+        self.assertEqual(dalpy_to_string(a), expected)
+
+    def test_Queue(self):
+        q = Queue()
+        q.enqueue(1)
+        expected = f'Queue[1]'
+        self.assertEqual(dalpy_to_string(q), expected)
+
+    def test_Stack(self):
+        s = Stack()
+        s.push(1)
+        expected = f'Stack[1]'
+        self.assertEqual(dalpy_to_string(s), expected)
+
+    def test_Set(self):
+        s = Set(1)
+        expected = 'Set{1}'
+        self.assertEqual(dalpy_to_string(s), expected)
+
+    
 
 if __name__ == '__main__':
-    build_and_run_watched_suite([WarningTest, GenericTesterTest, DALPyEqualsTest], show_tb=True)
+    build_and_run_watched_suite([WarningTest, GenericTesterTest, DALPyEqualsTest, DALPyToStringTest])
