expand trepan.lib.pp test

Author: rocky

test/unit/lib/test_lib_pp.py

@@ -1,18 +1,76 @@
 """Unit test for trepan.lib.pp"""
 
-from test.unit.cmdhelper import msg, msgs, reset_output
+from typing import List
 
-from trepan.lib.pp import pprint_simple_array
+from trepan.lib.pp import pp, pprint_simple_array
+
+errmsgs: List[str] = []
+
+
+def errmsg(msg_str: str):
+    """
+    error message collection routine for unit testing.
+    """
+    global errmsgs
+    errmsgs.append(msg_str)
+    return
+
+
+msgs: List[str] = []
+
+
+def msg(msg_str: str):
+    """
+    message collection routine for unit testing.
+    """
+    global msgs
+    msgs.append(msg_str)
+    return
+
+
+def reset_output():
+    """
+    Reset error messages and messages in advance of testing.
+    """
+    global errmsgs
+    errmsgs = []
+    global msgs
+    msgs = []
 
 
 def msg_nocr(msg_str: str):
     global msgs
-    msgs = [msg_str]
+    if len(msgs) > 0:
+        msgs[-1] += msg_str
+    else:
+        msgs = [msg_str]
+    return
+
+
+def test_lib_pp():
+    reset_output()
+    pp([i for i in range(8)], 50, msg_nocr, msg)
+    assert ["[0, 1, 2, 3, 4, 5, 6, 7]\n\n"] == msgs
+
+    reset_output()
+    x = [i for i in range(5)]
+    pp(x, 50, msg_nocr, msg, "x =")
+    assert ["x = [0, 1, 2, 3, 4]"] == msgs
+
+    reset_output()
+    x = [i for i in range(10)]
+    pp(x, 20, msg_nocr, msg, "x = ")
+    assert ["x = [0, 1, 2, 3, 4, 5,\n 6, 7, 8, 9]\n\n"] == msgs
     return
 
 
 def test_lib_pprint_simple_array():
     reset_output()
+
+    # We can't pprint these types, so return False.
+    for val in (5, {}, None, True):
+        assert pprint_simple_array(5, 53, msg_nocr, msg) is False
+
     pprint_simple_array(list(range(50)), 53, msg_nocr, msg)
     assert [
         "[ 0,  1,  2,  3,  4,  5,  6,  7,  8,  9, 10, 11,\n"

trepan/lib/pp.py

@@ -16,6 +16,8 @@
 #  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 import pprint
+from typing import Callable
+
 from columnize import columnize
 
 # Maximum length of strings
@@ -44,18 +46,21 @@ def truncate_length(obj, length=MAX_PP_COUNT):
 
 class SafePP(pprint.PrettyPrinter):
     def _format(self, obj, *args, **kwargs):
-        if isinstance(obj, str):
-            if len(obj) > MAX_PP_STRLEN:
-                obj = obj[:MAX_PP_STRLEN] + "..."
+        try:
+            if isinstance(obj, str):
+                if len(obj) > MAX_PP_STRLEN:
+                    obj = obj[:MAX_PP_STRLEN] + "..."
+                    pass
                 pass
+            elif hasattr(obj, "__len__") and len(obj) > MAX_PP_COUNT:
+                obj = truncate_length(obj)
+        except Exception:
             pass
-        elif hasattr(obj, "__len__") and len(obj) > MAX_PP_COUNT:
-            obj = truncate_length(obj)
 
         return pprint.PrettyPrinter._format(self, obj, *args, **kwargs)
 
 
-def pp(val, display_width, msg_nocr, msg, prefix=None):
+def pp(val, display_width, msg_nocr: Callable, msg: Callable, prefix=None):
     if prefix is not None:
         val_len = len(repr(val))
         if val_len + len(prefix) < display_width - 1:
@@ -77,7 +82,9 @@ def pp(val, display_width, msg_nocr, msg, prefix=None):
 
 # Actually... code like this should go in pformat.
 # Possibly some will go into columnize.
-def pprint_simple_array(val, displaywidth, msg_nocr, msg, lineprefix=""):
+def pprint_simple_array(
+    val, displaywidth, msg_nocr: Callable, msg: Callable, lineprefix=""
+) -> bool:
     """Try to pretty print a simple case where a list is not nested.
     Return True if we can do it and False if not."""
 
@@ -116,7 +123,7 @@ def msg_nocr(m):
     def msg(m):
         print(m)
 
-    pprint_simple_array(range(50), 50, msg_nocr, msg)
+    assert pprint_simple_array(range(50), 50, msg_nocr, msg) is False
     pp([i for i in range(10)], 50, msg_nocr, msg)
     pp(locals(), 50, msg_nocr, msg)
     x = [i for i in range(10)]