rename get_key to get_bindings_for_key

Author: willmcgugan

src/textual/binding.py

@@ -206,8 +206,8 @@ def bind(
                 )
             )
 
-    def get_key(self, key: str) -> list[Binding]:
-        """Get a binding if it exists.
+    def get_bindings_for_key(self, key: str) -> list[Binding]:
+        """Get a list of bindings for a given key.
 
         Args:
             key: Key to look up.
@@ -216,7 +216,7 @@ def get_key(self, key: str) -> list[Binding]:
             NoBinding: If the binding does not exist.
 
         Returns:
-            A binding object for the key,
+            A list of bindings associated with the key.
         """
         try:
             return self.keys[key]

tests/test_binding.py

@@ -27,16 +27,19 @@ def more_bindings():
 
 
 def test_bindings_get_key(bindings):
-    assert bindings.get_key("b") == [
+    assert bindings.get_bindings_for_key("b") == [
         Binding("b", action="action1", description="description1")
     ]
-    assert bindings.get_key("c") == [BINDING2]
+    assert bindings.get_bindings_for_key("c") == [BINDING2]
     with pytest.raises(NoBinding):
-        bindings.get_key("control+meta+alt+shift+super+hyper+t")
+        bindings.get_bindings_for_key("control+meta+alt+shift+super+hyper+t")
 
 
 def test_bindings_get_key_spaced_list(more_bindings):
-    assert more_bindings.get_key("d")[0].action == more_bindings.get_key("e")[0].action
+    assert (
+        more_bindings.get_bindings_for_key("d")[0].action
+        == more_bindings.get_bindings_for_key("e")[0].action
+    )
 
 
 def test_bindings_merge_simple(bindings):
@@ -69,7 +72,7 @@ def test_bad_binding_tuple():
 def test_binding_from_tuples():
     assert BindingsMap(
         ((BINDING2.key, BINDING2.action, BINDING2.description),)
-    ).get_key("c") == [BINDING2]
+    ).get_bindings_for_key("c") == [BINDING2]
 
 
 def test_shown():

tests/test_binding_inheritance.py

@@ -43,7 +43,7 @@ async def test_just_app_no_bindings() -> None:
             "ctrl+c",
             "ctrl+backslash",
         ]
-        assert pilot.app._bindings.get_key("ctrl+c")[0].priority is True
+        assert pilot.app._bindings.get_bindings_for_key("ctrl+c")[0].priority is True
 
 
 ##############################################################################
@@ -67,8 +67,8 @@ async def test_just_app_alpha_binding() -> None:
         assert sorted(pilot.app._bindings.keys.keys()) == sorted(
             ["ctrl+c", "ctrl+backslash", "a"]
         )
-        assert pilot.app._bindings.get_key("ctrl+c")[0].priority is True
-        assert pilot.app._bindings.get_key("a")[0].priority is True
+        assert pilot.app._bindings.get_bindings_for_key("ctrl+c")[0].priority is True
+        assert pilot.app._bindings.get_bindings_for_key("a")[0].priority is True
 
 
 ##############################################################################
@@ -91,8 +91,8 @@ async def test_just_app_low_priority_alpha_binding() -> None:
         assert sorted(pilot.app._bindings.keys.keys()) == sorted(
             ["ctrl+c", "ctrl+backslash", "a"]
         )
-        assert pilot.app._bindings.get_key("ctrl+c")[0].priority is True
-        assert pilot.app._bindings.get_key("a")[0].priority is False
+        assert pilot.app._bindings.get_bindings_for_key("ctrl+c")[0].priority is True
+        assert pilot.app._bindings.get_bindings_for_key("a")[0].priority is False
 
 
 ##############################################################################
@@ -121,7 +121,7 @@ def on_mount(self) -> None:
 async def test_app_screen_with_bindings() -> None:
     """Test a screen with a single key binding defined."""
     async with AppWithScreenThatHasABinding().run_test() as pilot:
-        assert pilot.app.screen._bindings.get_key("a")[0].priority is True
+        assert pilot.app.screen._bindings.get_bindings_for_key("a")[0].priority is True
 
 
 ##############################################################################
@@ -150,7 +150,7 @@ def on_mount(self) -> None:
 async def test_app_screen_with_low_bindings() -> None:
     """Test a screen with a single low-priority key binding defined."""
     async with AppWithScreenThatHasALowBinding().run_test() as pilot:
-        assert pilot.app.screen._bindings.get_key("a")[0].priority is False
+        assert pilot.app.screen._bindings.get_bindings_for_key("a")[0].priority is False
 
 
 ##############################################################################