keys: Add function to convert an urwid key into display format.

Generates a user-friendly version of Urwid's command keys.

Currently this applies capitalization of special keys
and custom mapping of PgUp/PgDn keys.

Tests added.

Co-authored-by: Parth Shah <[email protected]>

Author: 2 people

tests/config/test_keys.py

@@ -112,3 +112,30 @@ def test_updated_urwid_command_map() -> None:
             assert key in keys.keys_for_command(zt_cmd)
         except KeyError:
             pass
+
+
+@pytest.mark.parametrize(
+    "urwid_key, display_key",
+    [
+        ("a", "a"),
+        ("B", "B"),
+        (":", ":"),
+        ("enter", "Enter"),
+        ("meta c", "Meta c"),
+        ("ctrl D", "Ctrl D"),
+        ("page up", "PgUp"),
+        ("ctrl page up", "Ctrl PgUp"),
+    ],
+    ids=[
+        "lowercase_alphabet_key",
+        "uppercase_alphabet_key",
+        "symbol_key",
+        "special_key",
+        "lowercase_alphabet_key_with_modifier_key",
+        "uppercase_alphabet_key_with_modifier_key",
+        "mapped_key",
+        "mapped_key_with_modifier_key",
+    ],
+)
+def test_display_key_for_urwid_key(urwid_key: str, display_key: str) -> None:
+    assert keys.display_key_for_urwid_key(urwid_key) == display_key

zulipterminal/config/keys.py

@@ -460,6 +460,28 @@ def primary_key_for_command(command: str) -> str:
     return keys_for_command(command).pop(0)
 
 
+URWID_KEY_TO_DISPLAY_KEY_MAPPING = {
+    "page up": "PgUp",
+    "page down": "PgDn",
+}
+
+
+def display_key_for_urwid_key(urwid_key: str) -> str:
+    """
+    Returns a displayable user-centric format of the urwid key.
+    """
+    for urwid_map_key, display_map_key in URWID_KEY_TO_DISPLAY_KEY_MAPPING.items():
+        if urwid_map_key in urwid_key:
+            urwid_key = urwid_key.replace(urwid_map_key, display_map_key)
+    display_key = [
+        keyboard_key.capitalize()
+        if len(keyboard_key) > 1 and keyboard_key[0].islower()
+        else keyboard_key
+        for keyboard_key in urwid_key.split()
+    ]
+    return " ".join(display_key)
+
+
 def commands_for_random_tips() -> List[KeyBinding]:
     """
     Return list of commands which may be displayed as a random tip