refactor debugger

Author: d-biehl

.vscode/launch.json

@@ -34,10 +34,10 @@
 			}
 		},
 		{
-			"name": "Python: robotcode.debug_adapter.launcher",
+			"name": "Python: robotcode.debugger",
 			"type": "python",
 			"request": "launch",
-			"module": "robotcode.debug_adapter.launcher",
+			"module": "robotcode.debugger",
 			"justMyCode": false,
 			"args": [
 				"--debug-asyncio",
@@ -50,10 +50,10 @@
 			]
 		},
 		{
-			"name": "Python: robotcode.debug_adapter tcp",
+			"name": "Python: robotcode.debugger.launcher tcp",
 			"type": "python",
 			"request": "launch",
-			"module": "robotcode.debug_adapter",
+			"module": "robotcode.debugger.launcher",
 			"justMyCode": false,
 			"args": [
 				"--mode",
@@ -64,10 +64,10 @@
 			]
 		},
 		{
-			"name": "Python: robotcode.debug_adapter stdio",
+			"name": "Python: robotcode.debugger.launcher stdio",
 			"type": "python",
 			"request": "launch",
-			"module": "robotcode.debug_adapter",
+			"module": "robotcode.debugger.launcher",
 			"justMyCode": false,
 			"args": [
 				"--mode",

README.md

@@ -7,7 +7,7 @@ RobotFramework Language Server and client for Visual Studio Code.
 
 * Python 3.9 or above
 * Robotframework 4.0 and above
-* VSCode version 1.58 and above
+* VSCode version 1.59 and above
 
 ## Installation
 

log.ini

@@ -1,5 +1,5 @@
 [loggers]
-keys: root,server,language_server,language_server_parts,jsonrpc2,jsonrpc2_message,robotframework,debug_adapter, debug_adapter_launcher, asyncio
+keys: root,server,language_server,language_server_parts,jsonrpc2,jsonrpc2_message,robotframework,debugger, debugger_launcher, asyncio
 #keys: root
 
 [formatters]
@@ -73,15 +73,15 @@ handlers:
 qualname: robotcode.jsonrpc2.protocol.JsonRPCProtocol.message
 #propagate: 0
 
-[logger_debug_adapter]
+[logger_debugger]
 level: TRACE
 handlers: 
-qualname: robotcode.debug_adapter
+qualname: robotcode.debugger
 
-[logger_debug_adapter_launcher]
+[logger_debugger_launcher]
 level: TRACE
 handlers: 
-qualname: robotcode.debug_adapter.launcher
+qualname: robotcode.debugger.launcher
 
 [logger_asyncio]
 level: TRACE

robotcode/debug_adapter/launcher/__init__.py

@@ -16,7 +16,7 @@
 if __name__ == "__main__" and __package__ is None or __package__ == "":
 
     file = Path(__file__).resolve()
-    parent, top = file.parent, file.parents[3]
+    parent, top = file.parent, file.parents[2]
 
     if str(top) not in sys.path:
         sys.path.append(str(top))
@@ -26,10 +26,10 @@
     except ValueError:  # Already removed
         pass
 
-    __package__ = "robotcode.debug_adapter.launcher"
+    __package__ = "robotcode.debugger"
 
-from ..._version import __version__
-from ...utils.logging import LoggingDescriptor
+from .._version import __version__
+from ..utils.logging import LoggingDescriptor
 
 TRACE = logging.DEBUG - 6
 logging.addLevelName(TRACE, "TRACE")
@@ -42,15 +42,15 @@
 except ImportError:
     _logger.debug("typing_extensions not found, add our external path to sys.path")
     file = Path(__file__).resolve()
-    external_path = Path(file.parents[2], "external", "typing_extensions")
+    external_path = Path(file.parents[1], "external", "typing_extensions")
     sys.path.append(str(external_path))
 
 try:
     __import__("pydantic")
 except ImportError:
     _logger.debug("pydantic library not found, add our external path to sys.path")
     file = Path(__file__).resolve()
-    external_path = Path(file.parents[2], "external", "pydantic")
+    external_path = Path(file.parents[1], "external", "pydantic")
     sys.path.append(str(external_path))
 
 if TYPE_CHECKING:
@@ -86,7 +86,7 @@ async def wait() -> None:
 
 @_logger.call
 def run_server(port: int, loop: asyncio.AbstractEventLoop) -> None:
-    from ...jsonrpc2.server import TcpParams
+    from ..jsonrpc2.server import TcpParams
     from .server import LaucherServer
 
     asyncio.set_event_loop(loop)
@@ -124,9 +124,9 @@ async def run_robot(
 ) -> Any:
     import robot
 
-    from ...utils.debugpy import enable_debugpy, wait_for_debugpy_connected
-    from ...utils.net import check_free_port
-    from ..types import Event
+    from ..utils.debugpy import enable_debugpy, wait_for_debugpy_connected
+    from ..utils.net import check_free_port
+    from .types import Event
     from .debugger import Debugger
 
     @_logger.call
@@ -171,22 +171,23 @@ async def start_debugpy_async() -> None:
 
         await asyncio.wrap_future(asyncio.run_coroutine_threadsafe(server.protocol.initialized(), loop=loop))
 
-        try:
-            await asyncio.wrap_future(
-                asyncio.run_coroutine_threadsafe(
-                    server.protocol.wait_for_configuration_done(configuration_done_timeout), loop=loop
+        if wait_for_client:
+            try:
+                await asyncio.wrap_future(
+                    asyncio.run_coroutine_threadsafe(
+                        server.protocol.wait_for_configuration_done(configuration_done_timeout), loop=loop
+                    )
                 )
-            )
-        except (asyncio.CancelledError, SystemExit, KeyboardInterrupt):
-            pass
-        except asyncio.TimeoutError:
-            raise ConnectionError("Timeout to get configuration from client.")
+            except (asyncio.CancelledError, SystemExit, KeyboardInterrupt):
+                pass
+            except asyncio.TimeoutError:
+                raise ConnectionError("Timeout to get configuration from client.")
 
         await start_debugpy_async()
 
         args = [
             "--listener",
-            f"robotcode.debug_adapter.launcher.listeners.ListenerV2:no_debug={repr(no_debug)}",
+            f"robotcode.debugger.listeners.ListenerV2:no_debug={repr(no_debug)}",
             *args,
         ]
 
@@ -267,7 +268,7 @@ def get_log_handler(logfile: str) -> logging.FileHandler:
 
 def main() -> None:
     parser = argparse.ArgumentParser(
-        description="RobotCode Debug Adapter Launcher",
+        description="RobotCode Debugger",
         prog=__package__,
         formatter_class=argparse.ArgumentDefaultsHelpFormatter,
         usage=f"{__package__} [arguments]... -- [<robot arguments>]...",
@@ -294,7 +295,7 @@ def main() -> None:
     )
     parser.add_argument("--log", action="store_true", help="enable logging")
     parser.add_argument(
-        "--log-debug-adapter-launcher", action="store_true", help="show debug adapter launcher messages"
+        "--log-debugger", action="store_true", help="show debugger log messages"
     )
     parser.add_argument("-n", "--no-debug", action="store_true", help="disable debugging")
     parser.add_argument("--debug-asyncio", action="store_true", help="enable async io debugging messages")
@@ -382,9 +383,9 @@ def main() -> None:
         if not args.log_asyncio:
             logging.getLogger("asyncio").propagate = False
 
-        if not args.log_debug_adapter_launcher:
-            logging.getLogger("robotcode.debug_adapter").propagate = False
-            logging.getLogger("robotcode.debug_adapter").disabled = True
+        if not args.log_debugger:
+            logging.getLogger("robotcode.debugger").propagate = False
+            logging.getLogger("robotcode.debugger").disabled = True
 
     _logger.info(f"starting {__package__} version={__version__}")
     _logger.debug(f"args={args}")

robotcode/debug_adapter/__init__.py renamed to robotcode/debugger/__init__.py

@@ -20,9 +20,9 @@
     Union,
 )
 
-from ...utils.event import event
-from ...utils.logging import LoggingDescriptor
-from ..types import (
+from ..utils.event import event
+from ..utils.logging import LoggingDescriptor
+from .types import (
     Breakpoint,
     ContinuedEvent,
     ContinuedEventBody,

robotcode/debug_adapter/launcher/__main__.py renamed to robotcode/debugger/__main__.py

@@ -14,7 +14,7 @@
 if __name__ == "__main__" and __package__ is None or __package__ == "":
 
     file = Path(__file__).resolve()
-    parent, top = file.parent, file.parents[2]
+    parent, top = file.parent, file.parents[3]
 
     if str(top) not in sys.path:
         sys.path.append(str(top))
@@ -24,11 +24,11 @@
     except ValueError:  # Already removed
         pass
 
-    __package__ = "robotcode.debug_adapter"
+    __package__ = "robotcode.debugger.launcher"
 
-from .._version import __version__
-from ..utils.debugpy import start_debugpy
-from ..utils.logging import LoggingDescriptor
+from ..._version import __version__
+from ...utils.debugpy import start_debugpy
+from ...utils.logging import LoggingDescriptor
 
 TRACE = logging.DEBUG - 6
 logging.addLevelName(TRACE, "TRACE")
@@ -41,15 +41,15 @@
 except ImportError:
     _logger.debug("typing_extensions not found, add our external path to sys.path")
     file = Path(__file__).resolve()
-    external_path = Path(file.parents[1], "external", "typing_extensions")
+    external_path = Path(file.parents[2], "external", "typing_extensions")
     sys.path.append(str(external_path))
 
 try:
     __import__("pydantic")
 except ImportError:
     _logger.debug("pydantic library not found, add our external path to sys.path")
     file = Path(__file__).resolve()
-    external_path = Path(file.parents[1], "external", "pydantic")
+    external_path = Path(file.parents[2], "external", "pydantic")
     sys.path.append(str(external_path))
 
 
@@ -70,7 +70,7 @@ def get_log_handler(logfile: str) -> logging.FileHandler:
 
 
 def run_server(mode: str, port: int) -> None:
-    from ..jsonrpc2.server import JsonRpcServerMode, TcpParams
+    from ...jsonrpc2.server import JsonRpcServerMode, TcpParams
     from .server import DebugAdapterServer
 
     with DebugAdapterServer(JsonRpcServerMode(mode), tcp_params=TcpParams("127.0.0.1", port)) as server:
@@ -84,7 +84,7 @@ def run_server(mode: str, port: int) -> None:
 
 def main() -> None:
     parser = argparse.ArgumentParser(
-        description="RobotCode Debug Adapter",
+        description="RobotCode Debugger Launcher",
         prog=__package__,
         formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
@@ -99,7 +99,7 @@ def main() -> None:
     )
     parser.add_argument("-p", "--port", default=6611, help="server listen port (tcp)", type=int)
     parser.add_argument("--log", action="store_true", help="enable logging")
-    parser.add_argument("--log-debug-adapter", action="store_true", help="show debug adapter messages")
+    parser.add_argument("--log-debugger-launcher", action="store_true", help="show debugger launcher log messages")
     parser.add_argument("--debug-asyncio", action="store_true", help="enable async io debugging messages")
     parser.add_argument("--log-asyncio", action="store_true", help="show asyncio log messages")
     parser.add_argument("--log-colored", action="store_true", help="colored output for logs")
@@ -162,10 +162,10 @@ def main() -> None:
         if not args.log_asyncio:
             logging.getLogger("asyncio").propagate = False
 
-        if not args.log_debug_adapter:
-            logging.getLogger("robotcode.debug_adapter").propagate = False
+        if not args.log_debugger_launcher:
+            logging.getLogger("robotcode.debugger.launcher").propagate = False
 
-    _logger.info(f"starting debug adapter server version={__version__}")
+    _logger.info(f"starting debugger launcher server version={__version__}")
     _logger.debug(f"args={args}")
     if args.debugpy:
         start_debugpy(args.debugpy_port, args.debugpy_wait_for_client)