Add a --debug option to the plugin runner

Author: ncoghlan

src/lmstudio/async_api.py

@@ -367,7 +367,7 @@ async def _notify_client_termination(self) -> int:
         for rx_queue in self._mux.all_queues():
             await rx_queue.put(None)
             num_clients += 1
-        self._logger.info(
+        self._logger.debug(
             f"Notified {num_clients} clients of websocket termination",
             num_clients=num_clients,
         )

src/lmstudio/plugin/_dev_runner.py

@@ -107,7 +107,9 @@ async def register_dev_plugin(self) -> AsyncGenerator[tuple[str, str], None]:
                 message: DevPluginRegistrationEndDict = {"type": "end"}
                 await channel.send_message(message)
 
-    async def run_plugin(self, *, allow_local_imports: bool = True) -> int:
+    async def run_plugin(
+        self, *, allow_local_imports: bool = True, debug: bool = False
+    ) -> int:
         if not allow_local_imports:
             raise ValueError("Local imports are always permitted for dev plugins")
         async with self.register_dev_plugin() as (client_id, client_key):
@@ -117,35 +119,40 @@ async def run_plugin(self, *, allow_local_imports: bool = True) -> int:
                     self._plugin_path,
                     client_id,
                     client_key,
+                    debug,
                 )
             )
             return result.returncode
 
 
-# TODO: support the same subprocess monitoring features as `lms dev`
+# TODO: support the same source code change monitoring features as `lms dev`
 def _run_plugin_in_child_process(
-    plugin_path: Path, client_id: str, client_key: str
+    plugin_path: Path, client_id: str, client_key: str, debug: bool = False
 ) -> subprocess.CompletedProcess[str]:
     env = os.environ.copy()
     env[ENV_CLIENT_ID] = client_id
     env[ENV_CLIENT_KEY] = client_key
     package_name = __spec__.parent
     assert package_name is not None
+    debug_option = ("--debug",) if debug else ()
     command: list[str] = [
         sys.executable,
         "-m",
         package_name,
+        *debug_option,
         os.fspath(plugin_path),
     ]
     return subprocess.run(command, text=True, env=env)
 
 
-async def run_plugin_async(plugin_dir: str | os.PathLike[str]) -> int:
+async def run_plugin_async(
+    plugin_dir: str | os.PathLike[str], *, debug: bool = False
+) -> int:
     """Asynchronously execute a plugin in development mode."""
     async with DevPluginClient(plugin_dir) as dev_client:
-        return await dev_client.run_plugin()
+        return await dev_client.run_plugin(debug=debug)
 
 
-def run_plugin(plugin_dir: str | os.PathLike[str]) -> int:
+def run_plugin(plugin_dir: str | os.PathLike[str], *, debug: bool = False) -> int:
     """Execute a plugin in development mode."""
-    return asyncio.run(run_plugin_async(plugin_dir))
+    return asyncio.run(run_plugin_async(plugin_dir, debug=debug))

src/lmstudio/plugin/cli.py

@@ -1,6 +1,7 @@
 """Command line interface implementation."""
 
 import argparse
+import logging
 import os.path
 import sys
 import warnings
@@ -24,6 +25,7 @@ def _parse_args(
         "plugin_path", metavar="PLUGIN_PATH", help="Directory name of plugin to run"
     )
     parser.add_argument("--dev", action="store_true", help="Run in development mode")
+    parser.add_argument("--debug", action="store_true", help="Enable debug logging")
     return parser, parser.parse_args(argv)
 
 
@@ -45,10 +47,8 @@ def main(argv: Sequence[str] | None = None) -> int:
     warnings.filterwarnings(
         "ignore", ".*the async API is not yet stable", FutureWarning
     )
-    # TODO: Accept options to configure the verbosity
-    import logging
-
-    logging.basicConfig(level=logging.DEBUG)
+    log_level = logging.DEBUG if args.debug else logging.INFO
+    logging.basicConfig(level=log_level)
     if not args.dev:
         try:
             runner.run_plugin(plugin_path, allow_local_imports=True)
@@ -57,7 +57,7 @@ def main(argv: Sequence[str] | None = None) -> int:
     else:
         # Retrieve args from API host, spawn plugin in subprocess
         try:
-            _dev_runner.run_plugin(plugin_path)
+            _dev_runner.run_plugin(plugin_path, debug=args.debug)
         except KeyboardInterrupt:
             pass  # Subprocess handles reporting the plugin termination
     return 0

src/lmstudio/sync_api.py

@@ -321,7 +321,7 @@ def _notify_client_termination(self) -> int:
         for rx_queue in self._mux.all_queues():
             rx_queue.put(None)
             num_clients += 1
-        self._logger.info(
+        self._logger.debug(
             f"Notified {num_clients} clients of websocket termination",
             num_clients=num_clients,
         )