Add test and fix trepan.api

Author: rocky

test/unit/lib/test_lib_thread.py

@@ -3,6 +3,8 @@
 import sys
 import threading
 
+import pytest
+
 from trepan.lib.thred import (
     current_thread_name,
     find_debugged_frame,
@@ -21,8 +23,6 @@ def run(self):
         self.id_name_checker()
         return
 
-    pass
-
 
 def id_name_checker():
     """Helper for testing map_thread_names and id2thread"""
@@ -35,17 +35,17 @@ def id_name_checker():
 
 
 def test_current_thread_name():
-    assert "MainThread", current_thread_name()
-    return
+    """Test trepan.lib.thred.current_thread_name"""
+    assert "MainThread" == current_thread_name()
 
 
+@pytest.mark.skip(reason="Fix have an intermittent failure")
 def test_id2thread_name():
-    """Test ``map_thread_names`` and ``id2thread``. """
+    """Test ``map_thread_names`` and ``id2thread``."""
     thread_id = _thread.get_ident()
     assert "MainThread" == id2thread_name(thread_id)
     id_name_checker()
 
     background = BgThread(id_name_checker)
     background.start()
     background.join()  # Wait for the background task to finish
-    return

trepan/api.py

@@ -35,6 +35,7 @@
 # we see below. So for now, we'll live with the code duplication.
 
 import sys
+from typing import Callable, Optional
 
 from trepan.debugger import Trepan, debugger_obj
 from trepan.post_mortem import post_mortem_excepthook, uncaught_exception
@@ -48,11 +49,11 @@ def debugger_on_post_mortem():
 
 def run_eval(
     expression,
-    debug_opts=None,
-    start_opts=None,
-    globals_=None,
-    locals_=None,
-    tb_fn=None,
+    debug_opts: Optional[dict] = None,
+    start_opts: Optional[dict] = None,
+    globals_: Optional[dict] = None,
+    locals_: Optional[dict] = None,
+    tb_fn: Optional[Callable] = None,
 ):
     """Evaluate the expression (given as a string) under debugger
     control starting with the statement after the place that
@@ -79,7 +80,13 @@ def run_eval(
     return
 
 
-def run_call(func, *args, **kwds):
+def run_call(
+    func: Callable,
+    *args,
+    debug_opts: Optional[dict] = None,
+    start_opts: Optional[dict] = None,
+    **kwds,
+):
     """Call the function (a function or method object, not a string)
     with the given arguments starting with the statement after
     the place that this appears in your program.
@@ -88,7 +95,7 @@ def run_call(func, *args, **kwds):
     returned.  The debugger prompt appears as soon as the function is
     entered."""
 
-    dbg = Trepan()
+    dbg = Trepan(opts=debug_opts)
     try:
         return dbg.run_call(func, *args, **kwds)
     except Exception:
@@ -278,26 +285,41 @@ def stop(opts=None):
 if __name__ == "__main__":
     import tracer
 
-    def foo(n):
-        y = n
-        for i in range(n):
-            print(i)
-            pass
-        return y
+    def plus5(n: int) -> int:
+        return n + 5
 
+    from trepan.inout.stringarray import StringArrayInput, StringArrayOutput
     from trepan.lib.default import DEBUGGER_SETTINGS
 
     settings = dict(DEBUGGER_SETTINGS)
     settings.update({"trace": True, "printset": tracer.ALL_EVENTS})
-    debug_opts = {"step_ignore": -1, "settings": settings}
+    debugger_input = StringArrayInput()
+    debugger_output = StringArrayOutput()
+    debug_opts = {
+        "step_ignore": -1,
+        "settings": settings,
+        "input": debugger_input,
+        "output": debugger_output,
+    }
     print('Issuing: run_eval("1+2")')
-    print(run_eval("1+2", debug_opts=debug_opts))
-    print('Issuing: run_exec("x=1; y=2")')
-    run_exec("x=1; y=2", debug_opts=debug_opts)
-    print("Issuing: run_call(foo, debug_opts, None, 2)")
+    run_eval("1+2", debug_opts=debug_opts)
+    print(debugger_output.output)
+    # print('Issuing: run_exec("x=1; y=2")')
+    # run_exec("x=1; y=2", debug_opts=debug_opts)
+    debugger_input = StringArrayInput(["step", "list", "continue"])
+    debugger_output = StringArrayOutput()
+    debug_opts = {
+        "step_ignore": -1,
+        "settings": settings,
+        "input": debugger_input,
+        "output": debugger_output,
+    }
     if len(sys.argv) > 1:
-        print(f"Issuing interactive: run_call(foo, {debug_opts}, None, {sys.argv[1]})")
-        run_call(foo, debug_opts, int(sys.argv[1]))
+        print(
+            f"Issuing interactive: run_call(plus5, {int(sys.argv[1])}, debug_opts={debug_opts})"
+        )
+        run_call(plus5, int(sys.argv[1]), debug_opts=debug_opts)
     else:
-        run_call(foo, debug_opts, 2)
+        print(f"Issuing interactive: run_call(plus5, 2, debug_opts={debug_opts})")
+        run_call(plus5, 2, debug_opts=debug_opts)
     pass

trepan/debugger.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
-#   Copyright (C) 2008-2010, 2013-2015, 2018, 2023 Rocky Bernstein
-#   <rocky@gnu.org>
+#   Copyright (C) 2008-2010, 2013-2015, 2018, 2023-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
@@ -29,26 +29,23 @@
 user or client-side code for connecting to server'd debugged program.
 """
 
-# Our local modules
-
-# Common Python packages
 import sys
 import types
+from typing import Any, Callable
 
 import pyficache
 import tracefilter
 
 # External Egg packages
 import tracer
 
-import trepan
 import trepan.interfaces.user as Muser
 
 # Default settings used here
 import trepan.lib.default as Mdefault
 import trepan.lib.sighandler as Msig
-
 from trepan.exception import DebuggerQuit, DebuggerRestart
+from trepan.lib.core import TrepanCore
 from trepan.misc import option_set
 
 debugger_obj = None
@@ -138,7 +135,7 @@ def run_exec(self, cmd, start_opts=None, globals_=None, locals_=None):
             self.core.stop()
         return
 
-    def run_call(self, func, start_opts=None, *args, **kwds):
+    def run_call(self, func: Callable, *args, start_opts=None, **kwds):
         """Run debugger on function call: `func(*args, **kwds)'
 
         See also `run_eval' if what you want to run is an eval'able
@@ -221,7 +218,7 @@ def run_script(self, filename, start_opts=None, globals_=None, locals_=None):
         try:
             compiled = compile(open(self.mainpyfile).read(), self.mainpyfile, "exec")
         except SyntaxError:
-            self.intf[0].errmsg("Python can't compile %s" % self.mainpyfile)
+            self.intf[0].errmsg(f"Python can't compile {self.mainpyfile}")
             self.intf[0].errmsg(sys.exc_info()[1])
             retval = False
             pass
@@ -293,13 +290,15 @@ def __init__(self, opts=None):
         See also Debugger.start and Debugger.stop.
         """
 
-        import trepan.lib.core as Mcore
-
         self.mainpyfile = None
         self.thread = None
         self.eval_string = None
-        get_option = lambda key: option_set(opts, key, self.DEFAULT_INIT_OPTS)
-        completer = lambda text, state: self.complete(text, state)
+
+        def get_option(key: str) -> Any:
+            return option_set(opts, key, self.DEFAULT_INIT_OPTS)
+
+        def completer(text: str, state):
+            return self.complete(text, state)
 
         # set the instance variables that come directly from options.
         for opt in ("settings", "orig_sys_argv", "from_ipython"):
@@ -324,20 +323,19 @@ def __init__(self, opts=None):
             "debugger_name": "trepan3k",
         }
         # FIXME when I pass in opts=opts things break
-        interface = get_option("interface") or Muser.UserInterface(opts=interface_opts)
-        self.intf = [interface]
 
-        inp = get_option("input")
-        if inp:
-            self.intf[-1].input = inp
-            pass
+        inp = opts.get("input", None) if opts else None
+        interface = get_option("interface") or Muser.UserInterface(
+            inp=inp, opts=interface_opts
+        )
+        self.intf = [interface]
 
         out = get_option("output")
         if out:
             self.intf[-1].output = out
             pass
 
-        self.core = trepan.lib.core.TrepanCore(self, core_opts)
+        self.core = TrepanCore(self, core_opts)
         self.core.add_ignore(self.core.stop)
 
         # When set True, we'll also suspend our debug-hook tracing.