Merge pull request #5726 from Textualize/keymap-key

normalize keys

Author: willmcgugan

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 - Fixed markup escaping edge cases https://github.com/Textualize/textual/pull/5697
 - Fixed incorrect auto height in Collapsible https://github.com/Textualize/textual/pull/5703
+- Fixed issue with keymaps and single-letter keys https://github.com/Textualize/textual/pull/5726
 
 ### Changed
 

src/textual/app.py

@@ -107,6 +107,7 @@
     REPLACED_KEYS,
     _character_to_key,
     _get_unicode_name_from_key,
+    _normalize_key_list,
     format_key,
 )
 from textual.messages import CallbackType, Prune
@@ -3697,6 +3698,13 @@ def action_help_quit(self) -> None:
                 )
                 return
 
+    @classmethod
+    def _normalize_keymap(cls, keymap: Keymap) -> Keymap:
+        """Normalizes the keys in a keymap, so they use long form, i.e. "question_mark" rather than "?"."""
+        return {
+            binding_id: _normalize_key_list(keys) for binding_id, keys in keymap.items()
+        }
+
     def set_keymap(self, keymap: Keymap) -> None:
         """Set the keymap, a mapping of binding IDs to key strings.
 
@@ -3709,7 +3717,8 @@ def set_keymap(self, keymap: Keymap) -> None:
         Args:
             keymap: A mapping of binding IDs to key strings.
         """
-        self._keymap = keymap
+
+        self._keymap = self._normalize_keymap(keymap)
         self.refresh_bindings()
 
     def update_keymap(self, keymap: Keymap) -> None:
@@ -3721,7 +3730,8 @@ def update_keymap(self, keymap: Keymap) -> None:
         Args:
             keymap: A mapping of binding IDs to key strings.
         """
-        self._keymap = {**self._keymap, **keymap}
+
+        self._keymap = {**self._keymap, **self._normalize_keymap(keymap)}
         self.refresh_bindings()
 
     def handle_bindings_clash(

src/textual/keys.py

@@ -354,3 +354,15 @@ def _character_to_key(character: str) -> str:
         key = character
     key = KEY_NAME_REPLACEMENTS.get(key, key)
     return key
+
+
+def _normalize_key_list(keys: str) -> str:
+    """Normalizes a comma separated list of keys.
+
+    Replaces single letter keys with full name.
+    """
+
+    keys_list = [key.strip() for key in keys.split(",")]
+    return ",".join(
+        _character_to_key(key) if len(key) == 1 else key for key in keys_list
+    )

tests/test_binding.py

@@ -127,3 +127,13 @@ def signal_bindings_updated(screen: Screen) -> None:
         app.set_keymap({"quit": "f1"})
         await pilot.pause()
         assert bindings_updated == [app.screen, app.screen]
+
+
+async def test_keymap_key() -> None:
+    app: App[None] = App()
+
+    async with app.run_test():
+        app.set_keymap({"foo": "?,space"})
+        assert app._keymap == {"foo": "question_mark,space"}
+        app.update_keymap({"bar": "$"})
+        assert app._keymap == {"bar": "dollar_sign", "foo": "question_mark,space"}