Renaming App.search to App.search_commands

Author: darrenburns

examples/theme_sandbox.py

@@ -302,7 +302,7 @@ def action_invalid_theme(self) -> None:
         self.theme = "not-a-theme"
 
     def action_widget_search(self) -> None:
-        self.search(
+        self.search_commands(
             [
                 (
                     widget.__class__.__name__,

src/textual/app.py

@@ -1662,7 +1662,7 @@ def deliver_screenshot(
             name="screenshot",
         )
 
-    def search(
+    def search_commands(
         self,
         commands: Sequence[CommandListItem],
         placeholder: str = "Search for commands…",
@@ -1671,6 +1671,7 @@ def search(
 
         Args:
             commands: A list of SimpleCommand instances.
+            placeholder: Placeholder text for the search field.
 
         Returns:
             AwaitMount: An awaitable that resolves when the commands are shown.

tests/snapshot_tests/__snapshots__/test_snapshots/test_app_search_commands_opens_and_displays_search_list.svg

@@ -2511,8 +2511,8 @@ def on_mount(self) -> None:
     assert snap_compare(ThemeApp())
 
 
-def test_app_search_opens_and_displays_search_list(snap_compare):
-    """Test the App.search method for displaying a list of commands."""
+def test_app_search_commands_opens_and_displays_search_list(snap_compare):
+    """Test the App.search_commands method for displaying a list of commands."""
 
     class SearchApp(App[None]):
         def compose(self) -> ComposeResult:
@@ -2523,7 +2523,7 @@ def callback():
                 """Dummy no-op callback."""
 
             commands = [("foo", callback), ("bar", callback), ("baz", callback)]
-            await self.search(commands)
+            await self.search_commands(commands)
 
     async def run_before(pilot: Pilot) -> None:
         await pilot.press("b")

tests/snapshot_tests/test_snapshots.py

@@ -195,7 +195,7 @@ def callback():
         SimpleCommand("Another Command", callback, "Another test command"),
     ]
     async with app.run_test() as pilot:
-        await app.search(commands)
+        await app.search_commands(commands)
         await pilot.press("enter", "enter")
         assert called
 
@@ -216,7 +216,7 @@ def callback():
         ("Another Command", callback),
     ]
     async with app.run_test() as pilot:
-        await app.search(commands)
+        await app.search_commands(commands)
         await pilot.press("enter", "enter")
         assert called
 
@@ -225,5 +225,5 @@ async def test_search_with_empty_list():
     """Test search with an empty command list doesn't crash."""
     app = App[None]()
     async with app.run_test() as pilot:
-        await app.search([])
+        await app.search_commands([])
         await pilot.press("escape")