convert unit test test_misc.py to pytest

Author: rocky

setup.cfg

@@ -76,3 +76,6 @@ per-file-ignores =
 enabled = true
 live_mode = true
 exclude = ["trepan/version.py", "tests/*"]
+
+[mypy]
+exclude = ["trepan/version.py", "tests/*"]

test/unit/test-misc.py

@@ -0,0 +1,30 @@
+"""Unit test for trepan.misc"""
+
+from trepan.misc import bool2YN, option_set, wrapped_lines
+
+
+def test_bool2YN():
+    for arg, expect in ((True, "Y"), (False, "N"), (None, "N")):
+        assert bool2YN(arg) == expect
+
+
+def test_option_set():
+    """Test trepan.misc.option_set()"""
+    TEST_OPTS = {"a": True, "b": 5, "c": None}
+
+    def get_option(key):
+        return option_set(opts, key, TEST_OPTS)
+
+    opts = {"d": 6, "a": False}
+    for opt, expect in [("a", False), ("b", 5), ("c", None), ("d", 6)]:
+        assert expect == get_option(opt)
+    opts = None
+    for opt, expect in [("a", True), ("b", 5), ("c", None), ("d", None)]:
+        assert expect == get_option(opt)
+    pass
+
+
+def test_wrapped_msg():
+    """Test trepan.misc.wrapped_lines()"""
+    assert "hi there" == wrapped_lines("hi", "there", 80)
+    assert "hi\n\tthere" == wrapped_lines("hi", "there", 5)

test/unit/test_misc.py

@@ -154,15 +154,15 @@ def format_stack_entry(
     else:
         is_module = False
         try:
-            parms = inspect.formatargvalues(args, varargs, varkw, local_vars)
+            params = inspect.formatargvalues(args, varargs, varkw, local_vars)
         except Exception:
             pass
         else:
             maxargstrsize = dbg_obj.settings["maxargstrsize"]
-            if len(parms) >= maxargstrsize:
-                parms = f"{parms[0:maxargstrsize]}...)"
+            if len(params) >= maxargstrsize:
+                params = f"{params[0:maxargstrsize]}...)"
                 pass
-            s += parms
+            s += params
         pass
 
     # Note: ddd can't handle wrapped stack entries (yet).

trepan/lib/stack.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
-#   Copyright (C) 2008-2010, 2013-2015, 2020-2021 Rocky Bernstein <rocky@gnu.org>
+#   Copyright (C) 2008-2010, 2013-2015, 2020-2021, 2024
+#   Rocky Bernstein <rocky@gnu.org>
 #
 #   This program is free software: you can redistribute it and/or modify
 #   it under the terms of the GNU General Public License as published by
@@ -14,25 +15,43 @@
 #   You should have received a copy of the GNU General Public License
 #   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+import os
+from glob import glob
+from typing import Any
+
 
-def option_set(options, value, default_options):
+def option_set(options: dict, value, default_options) -> Any:
+    """
+    If ``value`` is found in ``options``, return that, otherwise return the value
+    from ``defaulit_options``.
+    """
+    # Yes, there is probably some fancy dictionary merge operation, that will do this,
+    # as a one-shot but this code is simple and clear.
     if not options or value not in options:
         return default_options.get(value)
     else:
         return options.get(value)
     return None  # Not reached
 
 
-def bool2YN(b) -> bool:
+def bool2YN(b: bool) -> str:
+    """
+    Turn a bool into the string "Y" or "N".
+    """
     return "Y" if b else "N"
 
 
-def wrapped_lines(msg_part1, msg_part2, width):
+def wrapped_lines(msg_part1: str, msg_part2: str, width: int) -> str:
+    """
+    if ``msg_part1`` concatenated with ``msg_part2`` is larger than
+    ``width`` then concatenate the strings with a new line and tab inserted
+    between the strings. Otherwise, just concatenate with a space between the
+    two strings.
+    """
     if len(msg_part1) + len(msg_part2) + 1 > width:
         return msg_part1 + "\n\t" + msg_part2
     else:
         return msg_part1 + " " + msg_part2
-    return  # Not reached
 
 
 def pretty_modfunc_name(s) -> str:
@@ -44,10 +63,6 @@ def pretty_modfunc_name(s) -> str:
         return str(s) + "()"
 
 
-import os
-from glob import glob
-
-
 def pyfiles(callername, level=2):
     "All python files caller's dir without the path and trailing .py"
     d = os.path.dirname(callername)
@@ -61,7 +76,10 @@ def pyfiles(callername, level=2):
 # Demo it
 if __name__ == "__main__":
     TEST_OPTS = {"a": True, "b": 5, "c": None}
-    get_option = lambda key: option_set(opts, key, TEST_OPTS)
+
+    def get_option(key):
+        return option_set(opts, key, TEST_OPTS)
+
     opts = {"d": 6, "a": False}
     for opt in ["a", "b", "c", "d"]:
         print(opt, get_option(opt))