Key logger / Keybindings troubleshooter

[Spitfire1900]

💡
Emulate the Keyboard Shortcuts Troubleshooting feature from VSCode

Add a LOGGER, e.g.

• prompt_toolkit.bindings_resolver: logs attempted keybinding resolutions and matched resolutions.
• prompt_toolkit.call_handlerlogs handlers immediately before calling them.

This would listen for ENV vars, e.g. PTK_BINDINGS_RESOLVER_LOG and PTK_CALL_HANDLER_LOG for where to log the file, and optionally also PTK_LOGCONF, which would point to a valid logging.cnf file with advanced configuration.

Two PoC sample diffs

Resolver logger:

--- /home/kyle/.local/pipx/venvs/xonsh/lib/python3.12/site-packages/prompt_toolkit/key_binding/key_processor.py 2025-01-02 19:01:14.501034642 -0500
+++ key_processor.py    2025-01-02 19:01:03.405889959 -0500
@@ -126,7 +126,10 @@
         keys = tuple(k.key for k in key_presses)
 
         # Try match, with mode flag
-        return [b for b in self._bindings.get_bindings_for_keys(keys) if b.filter()]
+        match = [b for b in self._bindings.get_bindings_for_keys(keys) if b.filter()]
+        from prompt_toolkit.log import logger
+        logger.warning(f"KeyProcessor: matches={match}")
+        return match
 
     def _is_prefix_of_longer_match(self, key_presses: list[KeyPress]) -> bool:
         """

Call handler logger:

iff --git a/src/prompt_toolkit/key_binding/key_processor.py b/src/prompt_toolkit/key_binding/key_processor.py
index d9074a36..e68ac0d7 100644
--- a/src/prompt_toolkit/key_binding/key_processor.py
+++ b/src/prompt_toolkit/key_binding/key_processor.py
@@ -320,7 +320,7 @@ class KeyProcessor:
         from prompt_toolkit.buffer import EditReadOnlyBuffer
         from prompt_toolkit.log import logger
         try:
-            logger.debug("Calling handler %s, key_press=%s, loc=%s:%s", handler.handler.__qualname__, handler.keys, handler.handler.__code__.co_filename, handler.handler.__code__.co_firstlineno)
+            logger.warning("Calling handler %s, key_press=%s, loc=%s:%s", handler.handler.__qualname__, handler.keys, handler.handler.__code__.co_filename, handler.handler.__code__.co_firstlineno)
             handler.call(event)
             self._fix_vi_cursor_position(event)