Merge branch 'main' into bug/1342/inherited-movement-keys

Author: davep

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## Unreleased
+
+### Fixed
+
+- Ensure only printable characters are used as key_display https://github.com/Textualize/textual/pull/1361
 
 ## [0.6.0] - 2022-12-11
 

docs/examples/widgets/footer.py

@@ -12,6 +12,7 @@ class FooterApp(App):
             description="Show help screen",
             key_display="?",
         ),
+        Binding(key="delete", action="delete", description="Delete the thing"),
         Binding(key="j", action="down", description="Scroll down", show=False),
     ]
 

examples/five_by_five.py

@@ -166,10 +166,10 @@ class Game(Screen):
         Binding("n", "new_game", "New Game"),
         Binding("question_mark", "push_screen('help')", "Help", key_display="?"),
         Binding("q", "quit", "Quit"),
-        Binding("up,w,k", "navigate(-1,0)", "Move Up", False),
-        Binding("down,s,j", "navigate(1,0)", "Move Down", False),
-        Binding("left,a,h", "navigate(0,-1)", "Move Left", False),
-        Binding("right,d,l", "navigate(0,1)", "Move Right", False),
+        Binding("up,w,k", "navigate(-1,0)", "Move Up", False, universal=True),
+        Binding("down,s,j", "navigate(1,0)", "Move Down", False, universal=True),
+        Binding("left,a,h", "navigate(0,-1)", "Move Left", False, universal=True),
+        Binding("right,d,l", "navigate(0,1)", "Move Right", False, universal=True),
         Binding("space", "move", "Toggle", False),
     ]
     """The bindings for the main game grid."""

src/textual/_typing.py

@@ -9,3 +9,5 @@
     from typing import Final, Literal, Protocol, TypedDict
 else:
     from typing_extensions import Final, Literal, Protocol, TypedDict
+
+__all__ = ["TypeAlias", "Final", "Literal", "Protocol", "TypedDict"]

src/textual/binding.py

@@ -93,7 +93,7 @@ def __rich_repr__(self) -> rich.repr.Result:
 
     @classmethod
     def merge(cls, bindings: Iterable[Bindings]) -> Bindings:
-        """Merge a bindings. Subsequence bound keys override initial keys.
+        """Merge a bindings. Subsequent bound keys override initial keys.
 
         Args:
             bindings (Iterable[Bindings]): A number of bindings.

src/textual/keys.py

@@ -245,9 +245,14 @@ def _get_key_display(key: str) -> str:
         return display_alias
 
     original_key = REPLACED_KEYS.get(key, key)
+    upper_original = original_key.upper().replace("_", " ")
     try:
-        unicode_character = unicodedata.lookup(original_key.upper().replace("_", " "))
+        unicode_character = unicodedata.lookup(upper_original)
     except KeyError:
-        return original_key.upper()
+        return upper_original
 
-    return unicode_character
+    # Check if printable. `delete` for example maps to a control sequence
+    # which we don't want to write to the terminal.
+    if unicode_character.isprintable():
+        return unicode_character
+    return upper_original